completed descriptions for all functions starting with b
[phpeclipse.git] / net.sourceforge.phpeclipse / src / test / PHPParserSuperclass.java
index 1dee6aa..ed690b0 100644 (file)
@@ -1,17 +1,18 @@
 package test;
 
+import java.text.MessageFormat;
+import java.util.Hashtable;
+
+import net.sourceforge.phpdt.internal.compiler.parser.PHPOutlineInfo;
+import net.sourceforge.phpdt.internal.ui.util.StringUtil;
+import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import net.sourceforge.phpeclipse.actions.PHPStartApacheAction;
+
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.ui.texteditor.MarkerUtilities;
-import net.sourceforge.phpeclipse.PHPeclipsePlugin;
-import net.sourceforge.phpeclipse.actions.PHPStartApacheAction;
-import net.sourceforge.phpdt.internal.compiler.parser.PHPOutlineInfo;
-import net.sourceforge.phpdt.internal.compiler.parser.Parser;
-
-import java.text.MessageFormat;
-import java.util.Hashtable;
 
 /**
  * The superclass for our PHP parsers.
@@ -24,6 +25,7 @@ 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> )
@@ -32,17 +34,15 @@ public abstract class PHPParserSuperclass {
    */
   public static void phpExternalParse(final IFile file) {
     //IFile file = (IFile) resource;
-  //  final IPath path = file.getFullPath();
+    //  final IPath path = file.getFullPath();
     final IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
     final String filename = file.getLocation().toString();
 
     final String[] arguments = { filename };
-    final MessageFormat form =
-      new MessageFormat(store.getString(PHPeclipsePlugin.EXTERNAL_PARSER_PREF));
+    final MessageFormat form = new MessageFormat(store.getString(PHPeclipsePlugin.EXTERNAL_PARSER_PREF));
     final String command = form.format(arguments);
 
-    final 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
@@ -53,9 +53,10 @@ public abstract class PHPParserSuperclass {
 
   /**
    * 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(final String output, final 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);
 
@@ -77,16 +78,14 @@ public abstract class PHPParserSuperclass {
     }
   }
 
-  private static void scanLine(final String output, final IFile file, final int indx, final 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; never used
+    //  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) {
+    if (current.indexOf(PARSE_WARNING_STRING) != -1 || current.indexOf(PARSE_ERROR_STRING) != -1) {
       final int onLine = current.indexOf("on line <b>");
       if (onLine != -1) {
         lineNumberBuffer.delete(0, lineNumberBuffer.length());
@@ -101,17 +100,15 @@ public abstract class PHPParserSuperclass {
 
         final Hashtable attributes = new Hashtable();
 
-        current = current.replaceAll("\n", "");
-        current = current.replaceAll("<b>", "");
-        current = current.replaceAll("</b>", "");
+        current = StringUtil.replaceAll(current, "\n", "");
+        current = StringUtil.replaceAll(current, "<b>", "");
+        current = StringUtil.replaceAll(current, "</b>", "");
         MarkerUtilities.setMessage(attributes, current);
 
         if (current.indexOf(PARSE_ERROR_STRING) != -1)
           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));
+          attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_WARNING));
         else
           attributes.put(IMarker.SEVERITY, new Integer(IMarker.SEVERITY_INFO));
         MarkerUtilities.setLineNumber(attributes, lineNumber);
@@ -148,28 +145,32 @@ public abstract class PHPParserSuperclass {
    * @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#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)
+  public static void setMarker(
+    final IFile file,
+    final String message,
+    final int charStart,
+    final int charEnd,
+    final int errorLevel)
     throws CoreException {
     if (file != null) {
       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);
@@ -186,31 +187,33 @@ public abstract class PHPParserSuperclass {
    *        {@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)
+  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 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.SEVERITY_INFO));
+          markerKind = IMarker.TASK;
+          break;
       }
-      attributes.put(IMarker.LOCATION,location);
+      attributes.put(IMarker.LOCATION, location);
       MarkerUtilities.setLineNumber(attributes, line);
-      MarkerUtilities.createMarker(file, attributes, IMarker.PROBLEM);
+      MarkerUtilities.createMarker(file, attributes, markerKind);
     }
   }
+
   /**
    * This will set a marker.
    * @param file the file that generated the marker
@@ -222,28 +225,32 @@ public abstract class PHPParserSuperclass {
    * @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)
+  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 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;
       }
-      attributes.put(IMarker.LOCATION,location);
+      attributes.put(IMarker.LOCATION, location);
       MarkerUtilities.setCharStart(attributes, charStart);
       MarkerUtilities.setCharEnd(attributes, charEnd);
       MarkerUtilities.createMarker(file, attributes, IMarker.PROBLEM);