com.google.eclipse.protobuf.ui/src/com/google/eclipse/protobuf/ui/builder/protoc/output/ProtocMarkerFactory.java

/*
 * Copyright (c) 2011 Google Inc.
 *
 * All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse
 * Public License v1.0 which accompanies this distribution, and is available at
 *
 * http://www.eclipse.org/legal/epl-v10.html
 */
package com.google.eclipse.protobuf.ui.builder.protoc.output;

import static com.google.eclipse.protobuf.ui.validation.ProtobufResourceUIValidatorExtension.EDITOR_CHECK;
import static org.eclipse.core.resources.IMarker.*;
import static org.eclipse.core.resources.IResource.DEPTH_INFINITE;

import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.CoreException;

/**
 * Factory of <code>{@link IMarker}</code>s derived from errors reported by protoc.
 *
 * @author alruiz@google.com (Alex Ruiz)
 */
public class ProtocMarkerFactory {
  private static final String PROTOC_CHECK = "com.google.eclipse.protobuf.ui.protocMarker";

  private final IFile protoFile;
  private final IMarker[] markers;

  public ProtocMarkerFactory(IFile protoFile) throws CoreException {
    this.protoFile = protoFile;
    protoFile.deleteMarkers(PROTOC_CHECK, true, DEPTH_INFINITE);
    markers = protoFile.findMarkers(EDITOR_CHECK, true, DEPTH_INFINITE);
  }

  /**
   * Creates a new editor marker if the given file name matches the one in this factory.
   * @param fileName the name of the proto file, obtained from protoc output.
   * @param lineNumber the line number where to create the editor marker.
   * @param message the message for the editor marker.
   * @throws CoreException if something goes wrong.
   */
  public void createErrorIfNecessary(String fileName, int lineNumber, String message) throws CoreException {
    String location = protoFile.getLocation().toOSString();
    if (!location.endsWith(fileName) || containsMarker(message, lineNumber)) {
      return;
    }
    IMarker marker = protoFile.createMarker(PROTOC_CHECK);
    marker.setAttribute(SEVERITY, SEVERITY_ERROR);
    marker.setAttribute(MESSAGE, message);
    marker.setAttribute(LINE_NUMBER, lineNumber);
  }

  private boolean containsMarker(String description, int lineNumber) throws CoreException {
    for (IMarker marker : markers) {
      String markerMessage = (String) marker.getAttribute(MESSAGE);
      if (markerMessage.equalsIgnoreCase(description) && marker.getAttribute(LINE_NUMBER).equals(lineNumber)) {
        return true;
      }
    }
    return false;
  }
}