X-Git-Url: http://git.phpeclipse.com

diff --git a/net.sourceforge.phpeclipse/src/test/PHPParserSuperclass.java b/net.sourceforge.phpeclipse/src/test/PHPParserSuperclass.java
index bdf9f88..c1bf446 100644
--- a/net.sourceforge.phpeclipse/src/test/PHPParserSuperclass.java
+++ b/net.sourceforge.phpeclipse/src/test/PHPParserSuperclass.java
@@ -2,7 +2,6 @@ package test;
 
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IMarker;
-import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.ui.texteditor.MarkerUtilities;
@@ -25,24 +24,26 @@ public abstract class PHPParserSuperclass {
   public static final int ERROR = 2;
   public static final int WARNING = 1;
   public static final int INFO = 0;
+  public static final int TASK = 3;
 
   /**
    * Call the php parse command ( php -l -f <filename> )
-   * and create markers according to the external parser output
+   * and create markers according to the external parser output.
+   * @param file the file that will be parsed
    */
-  public static void phpExternalParse(IFile file) {
+  public static void phpExternalParse(final IFile file) {
     //IFile file = (IFile) resource;
-    IPath path = file.getFullPath();
-    IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
-    String filename = file.getLocation().toString();
+    //  final IPath path = file.getFullPath();
+    final IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
+    final String filename = file.getLocation().toString();
 
-    String[] arguments = { filename };
-    MessageFormat form =
-      new MessageFormat(store.getString(PHPeclipsePlugin.EXTERNAL_PARSER_PREF));
-    String command = form.format(arguments);
+    final String[] arguments = {filename};
+    final MessageFormat form =
+        new MessageFormat(store.getString(PHPeclipsePlugin.EXTERNAL_PARSER_PREF));
+    final String command = form.format(arguments);
 
-    String parserResult =
-      PHPStartApacheAction.getParserOutput(command, "External parser: ");
+    final String parserResult =
+        PHPStartApacheAction.getParserOutput(command, "External parser: ");
 
     try {
       // parse the buffer to find the errors and warnings
@@ -52,15 +53,17 @@ public abstract class PHPParserSuperclass {
   }
 
   /**
-   * Create markers according to the external parser output
+   * Create markers according to the external parser output.
+   * @param output the external parser output
+   * @param file the file that was parsed.
    */
-  private static void createMarkers(String output, IFile file)
-    throws CoreException {
+  protected static void createMarkers(final String output, final IFile file)
+      throws CoreException {
     // delete all markers
     file.deleteMarkers(IMarker.PROBLEM, false, 0);
 
     int indx = 0;
-    int brIndx = 0;
+    int brIndx;
     boolean flag = true;
     while ((brIndx = output.indexOf("<br />", indx)) != -1) {
       // newer php error output (tested with 4.2.3)
@@ -77,17 +80,17 @@ public abstract class PHPParserSuperclass {
     }
   }
 
-  private static void scanLine(String output, IFile file, int indx, int brIndx)
-    throws CoreException {
+  private static void scanLine(final String output, final IFile file, final int indx, final int brIndx)
+      throws CoreException {
     String current;
-    String outLineNumberString;
-    StringBuffer lineNumberBuffer = new StringBuffer(10);
+    //  String outLineNumberString; never used
+    final StringBuffer lineNumberBuffer = new StringBuffer(10);
     char ch;
     current = output.substring(indx, brIndx);
 
     if (current.indexOf(PARSE_WARNING_STRING) != -1
-      || current.indexOf(PARSE_ERROR_STRING) != -1) {
-      int onLine = current.indexOf("on line <b>");
+        || current.indexOf(PARSE_ERROR_STRING) != -1) {
+      final int onLine = current.indexOf("on line <b>");
       if (onLine != -1) {
         lineNumberBuffer.delete(0, lineNumberBuffer.length());
         for (int i = onLine; i < current.length(); i++) {
@@ -97,9 +100,9 @@ public abstract class PHPParserSuperclass {
           }
         }
 
-        int lineNumber = Integer.parseInt(lineNumberBuffer.toString());
+        final int lineNumber = Integer.parseInt(lineNumberBuffer.toString());
 
-        Hashtable attributes = new Hashtable();
+        final Hashtable attributes = new Hashtable();
 
         current = current.replaceAll("\n", "");
         current = current.replaceAll("<b>", "");
@@ -110,8 +113,8 @@ public abstract class PHPParserSuperclass {
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_ERROR));
         else if (current.indexOf(PARSE_WARNING_STRING) != -1)
           attributes.put(
-            IMarker.SEVERITY,
-            new Integer(IMarker.SEVERITY_WARNING));
+              IMarker.SEVERITY,
+              new Integer(IMarker.SEVERITY_WARNING));
         else
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
         MarkerUtilities.setLineNumber(attributes, lineNumber);
@@ -120,36 +123,144 @@ public abstract class PHPParserSuperclass {
     }
   }
 
+  /**
+   * This will parse the file and generate the outline info
+   * @param parent the parent object
+   * @param s the string that should be parsed
+   * @return the outline info
+   */
   public abstract PHPOutlineInfo parseInfo(Object parent, String s);
 
+  /**
+   * This will change the file to parse.
+   * @param fileToParse the file that should be parsed
+   */
   public abstract void setFileToParse(IFile fileToParse);
 
+  /**
+   * This will parse the given string
+   * @param s the string to parse
+   * @throws CoreException an exception that can be launched
+   */
   public abstract void parse(String s) throws CoreException;
 
-  public static void setMarker(
-    IFile file,
-    String message,
-    int charStart,
-    int charEnd,
-    int errorLevel)
-    throws CoreException {
+  /**
+   * This will set a marker.
+   * @param file the file that generated the marker
+   * @param message the message
+   * @param charStart the starting character
+   * @param charEnd the end character
+   * @param errorLevel the error level ({@link PHPParserSuperclass#ERROR},
+   *        {@link PHPParserSuperclass#INFO},{@link PHPParserSuperclass#WARNING}),{@link PHPParserSuperclass#TASK})
+   * @throws CoreException an exception throwed by the MarkerUtilities
+   */
+  public static void setMarker(final IFile file,
+                               final String message,
+                               final int charStart,
+                               final int charEnd,
+                               final int errorLevel)
+      throws CoreException {
     if (file != null) {
-      Hashtable attributes = new Hashtable();
+      final Hashtable attributes = new Hashtable();
       MarkerUtilities.setMessage(attributes, message);
       switch (errorLevel) {
-        case Parser.ERROR :
+        case ERROR:
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_ERROR));
           break;
-        case Parser.WARNING :
+        case WARNING:
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_WARNING));
           break;
-        case Parser.INFO :
+        case INFO:
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
           break;
+        case TASK:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.TASK));
+          break;
+      }
+      MarkerUtilities.setCharStart(attributes, charStart);
+      MarkerUtilities.setCharEnd(attributes, charEnd);
+      MarkerUtilities.createMarker(file, attributes, IMarker.PROBLEM);
+    }
+  }
+
+  /**
+   * This will set a marker.
+   * @param file the file that generated the marker
+   * @param message the message
+   * @param line the line number
+   * @param errorLevel the error level ({@link PHPParserSuperclass#ERROR},
+   *        {@link PHPParserSuperclass#INFO},{@link PHPParserSuperclass#WARNING})
+   * @throws CoreException an exception throwed by the MarkerUtilities
+   */
+  public static void setMarker(final IFile file,
+                               final String message,
+                               final int line,
+                               final int errorLevel,
+                               final String location)
+      throws CoreException {
+    if (file != null) {
+      String markerKind = IMarker.PROBLEM;
+      final Hashtable attributes = new Hashtable();
+      MarkerUtilities.setMessage(attributes, message);
+      switch (errorLevel) {
+        case ERROR:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_ERROR));
+          break;
+        case WARNING:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_WARNING));
+          break;
+        case INFO:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
+          break;
+        case TASK:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
+          markerKind = IMarker.TASK;
+          break;
+      }
+      attributes.put(IMarker.LOCATION, location);
+      MarkerUtilities.setLineNumber(attributes, line);
+      MarkerUtilities.createMarker(file, attributes, markerKind);
+    }
+  }
+
+  /**
+   * This will set a marker.
+   * @param file the file that generated the marker
+   * @param message the message
+   * @param charStart the starting character
+   * @param charEnd the end character
+   * @param errorLevel the error level ({@link PHPParserSuperclass#ERROR},
+   *        {@link PHPParserSuperclass#INFO},{@link PHPParserSuperclass#WARNING})
+   * @param location the location of the error
+   * @throws CoreException an exception throwed by the MarkerUtilities
+   */
+  public static void setMarker(final IFile file,
+                               final String message,
+                               final int charStart,
+                               final int charEnd,
+                               final int errorLevel,
+                               final String location)
+      throws CoreException {
+    if (file != null) {
+      final Hashtable attributes = new Hashtable();
+      MarkerUtilities.setMessage(attributes, message);
+      switch (errorLevel) {
+        case ERROR:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_ERROR));
+          break;
+        case WARNING:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_WARNING));
+          break;
+        case INFO:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
+          break;
+        case TASK:
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.TASK));
+          break;
       }
+      attributes.put(IMarker.LOCATION, location);
       MarkerUtilities.setCharStart(attributes, charStart);
       MarkerUtilities.setCharEnd(attributes, charEnd);
-      // setLineNumber(attributes, lineNumber);
       MarkerUtilities.createMarker(file, attributes, IMarker.PROBLEM);
     }
   }