php formatter based on the JDT java formatter (very early version)
[phpeclipse.git] / net.sourceforge.phpeclipse / src / test / PHPParser.jj
index 861d2c6..34ee7b7 100644 (file)
@@ -48,7 +48,7 @@ import net.sourceforge.phpdt.internal.compiler.parser.PHPReqIncDeclaration;
  * You can test the parser with the PHPParserTestCase2.java
  * @author Matthieu Casanova
  */
-public class PHPParser extends PHPParserSuperclass {
+public final class PHPParser extends PHPParserSuperclass {
 
   private static IFile fileToParse;
 
@@ -64,18 +64,18 @@ public class PHPParser extends PHPParserSuperclass {
   public PHPParser() {
   }
 
-  public void setFileToParse(IFile fileToParse) {
+  public final void setFileToParse(final IFile fileToParse) {
     this.fileToParse = fileToParse;
   }
 
-  public PHPParser(IFile fileToParse) {
+  public PHPParser(final IFile fileToParse) {
     this(new StringReader(""));
     this.fileToParse = fileToParse;
   }
 
-  public void phpParserTester(String strEval) throws CoreException, ParseException {
+  public static final void phpParserTester(final String strEval) throws CoreException, ParseException {
     PHPParserTokenManager.SwitchTo(PHPParserTokenManager.PHPPARSING);
-    StringReader stream = new StringReader(strEval);
+    final StringReader stream = new StringReader(strEval);
     if (jj_input_stream == null) {
       jj_input_stream = new SimpleCharStream(stream, 1, 1);
     }
@@ -83,8 +83,8 @@ public class PHPParser extends PHPParserSuperclass {
     phpTest();
   }
 
-  public void htmlParserTester(String strEval) throws CoreException, ParseException {
-    StringReader stream = new StringReader(strEval);
+  public static final void htmlParserTester(final String strEval) throws CoreException, ParseException {
+    final StringReader stream = new StringReader(strEval);
     if (jj_input_stream == null) {
       jj_input_stream = new SimpleCharStream(stream, 1, 1);
     }
@@ -92,10 +92,10 @@ public class PHPParser extends PHPParserSuperclass {
     phpFile();
   }
 
-  public PHPOutlineInfo parseInfo(Object parent, String s) {
+  public final PHPOutlineInfo parseInfo(final Object parent, final String s) {
     outlineInfo = new PHPOutlineInfo(parent);
     currentSegment = outlineInfo.getDeclarations();
-    StringReader stream = new StringReader(s);
+    final StringReader stream = new StringReader(s);
     if (jj_input_stream == null) {
       jj_input_stream = new SimpleCharStream(stream, 1, 1);
     }
@@ -124,10 +124,16 @@ public class PHPParser extends PHPParserSuperclass {
 
   /**
    * Create marker for the parse error
+   * @param e the ParseException
    */
-  private static void setMarker(ParseException e) {
+  private static void setMarker(final ParseException e) {
     try {
-      setMarker(fileToParse, errorMessage, jj_input_stream.tokenBegin,jj_input_stream.tokenBegin+e.currentToken.image.length(), errorLevel);
+      setMarker(fileToParse,
+                errorMessage,
+                jj_input_stream.tokenBegin,
+                jj_input_stream.tokenBegin + e.currentToken.image.length(),
+                errorLevel,
+                "Line " + e.currentToken.beginLine);
     } catch (CoreException e2) {
       PHPeclipsePlugin.log(e2);
     }
@@ -136,12 +142,12 @@ public class PHPParser extends PHPParserSuperclass {
   /**
    * Create markers according to the external parser output
    */
-  private static void createMarkers(String output, IFile file) throws CoreException {
+  private 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)
@@ -158,7 +164,10 @@ public class PHPParser extends 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;
     StringBuffer lineNumberBuffer = new StringBuffer(10);
     char ch;
@@ -196,8 +205,12 @@ public class PHPParser extends PHPParserSuperclass {
     }
   }
 
-  public void parse(String s) throws CoreException {
-    ReInit(new StringReader(s));
+  public final void parse(final String s) throws CoreException {
+    final StringReader stream = new StringReader(s);
+    if (jj_input_stream == null) {
+      jj_input_stream = new SimpleCharStream(stream, 1, 1);
+    }
+    ReInit(stream);
     try {
       parse();
     } catch (ParseException e) {
@@ -209,15 +222,15 @@ public class PHPParser extends PHPParserSuperclass {
    * Call the php parse command ( php -l -f &lt;filename&gt; )
    * and create markers according to the external parser output
    */
-  public static void phpExternalParse(IFile file) {
-    IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
-    String filename = file.getLocation().toString();
+  public static void phpExternalParse(final IFile file) {
+    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
@@ -227,7 +240,7 @@ public class PHPParser extends PHPParserSuperclass {
     }
   }
 
-  public void parse() throws ParseException {
+  public static final void parse() throws ParseException {
          phpFile();
   }
 }
@@ -236,7 +249,9 @@ PARSER_END(PHPParser)
 
 <DEFAULT> TOKEN :
 {
-  <PHPSTART : "<?php" | "<?"> : PHPPARSING
+  <PHPSTARTSHORT : "<?"> : PHPPARSING
+| <PHPSTARTLONG : "<?php"> : PHPPARSING
+| <PHPECHOSTART : "<?=">      : PHPPARSING
 }
 
 <PHPPARSING> TOKEN :
@@ -263,7 +278,7 @@ PARSER_END(PHPParser)
 
 /* COMMENTS */
 
-<PHPPARSING> MORE :
+<PHPPARSING> SPECIAL_TOKEN :
 {
   "//" : IN_SINGLE_LINE_COMMENT
 |
@@ -272,10 +287,14 @@ PARSER_END(PHPParser)
   "/*" : IN_MULTI_LINE_COMMENT
 }
 
-<IN_SINGLE_LINE_COMMENT>
-SPECIAL_TOKEN :
+<IN_SINGLE_LINE_COMMENT> SPECIAL_TOKEN :
+{
+  <SINGLE_LINE_COMMENT: "\n" | "\r" | "\r\n" > : PHPPARSING
+}
+
+<IN_SINGLE_LINE_COMMENT> SPECIAL_TOKEN :
 {
-  <SINGLE_LINE_COMMENT: "\n" | "\r" | "\r\n" | "?>" > : PHPPARSING
+  <SINGLE_LINE_COMMENT_PHPEND : "?>" > : DEFAULT
 }
 
 <IN_FORMAL_COMMENT>
@@ -306,68 +325,72 @@ MORE :
 | <ELSEIF   : "elseif">
 | <ELSE     : "else">
 | <ARRAY    : "array">
+| <BREAK    : "break">
 }
 
 /* LANGUAGE CONSTRUCT */
 <PHPPARSING> TOKEN :
 {
-  <PRINT : "print">
-| <ECHO : "echo">
-| <INCLUDE : "include">
-| <REQUIRE : "require">
-| <INCLUDE_ONCE : "include_once">
-| <REQUIRE_ONCE : "require_once">
-| <GLOBAL : "global">
-| <STATIC : "static">
-| <CLASSACCESS: "->">
-| <STATICCLASSACCESS: "::">
-| <ARRAYASSIGN: "=>">
+  <PRINT              : "print">
+| <ECHO               : "echo">
+| <INCLUDE            : "include">
+| <REQUIRE            : "require">
+| <INCLUDE_ONCE       : "include_once">
+| <REQUIRE_ONCE       : "require_once">
+| <GLOBAL             : "global">
+| <STATIC             : "static">
+| <CLASSACCESS        : "->">
+| <STATICCLASSACCESS  : "::">
+| <ARRAYASSIGN        : "=>">
 }
 
 /* RESERVED WORDS AND LITERALS */
 
 <PHPPARSING> TOKEN :
 {
-  < BREAK: "break" >
-| < CASE: "case" >
-| < CONST: "const" >
-| < CONTINUE: "continue" >
-| < _DEFAULT: "default" >
-| < DO: "do" >
-| < EXTENDS: "extends" >
-| < FALSE: "false" >
-| < FOR: "for" >
-| < GOTO: "goto" >
-| < NEW: "new" >
-| < NULL: "null" >
-| < RETURN: "return" >
-| < SUPER: "super" >
-| < SWITCH: "switch" >
-| < THIS: "this" >
-| < TRUE: "true" >
-| < WHILE: "while" >
-| < ENDWHILE : "endwhile" >
+  <CASE     : "case">
+| <CONST    : "const">
+| <CONTINUE : "continue">
+| <_DEFAULT : "default">
+| <DO       : "do">
+| <EXTENDS  : "extends">
+| <FOR      : "for">
+| <GOTO     : "goto">
+| <NEW      : "new">
+| <NULL     : "null">
+| <RETURN   : "return">
+| <SUPER    : "super">
+| <SWITCH   : "switch">
+| <THIS     : "this">
+| <TRUE     : "true">
+| <FALSE    : "false">
+| <WHILE    : "while">
+| <ENDWHILE : "endwhile">
+| <ENDIF    : "endif">
+| <ENDFOR   : "endfor">
+| <FOREACH  : "foreach">
+| <AS       : "as" >
 }
 
 /* TYPES */
 
 <PHPPARSING> TOKEN :
 {
-  <STRING : "string">
-| <OBJECT : "object">
-| <BOOL : "bool">
+  <STRING  : "string">
+| <OBJECT  : "object">
+| <BOOL    : "bool">
 | <BOOLEAN : "boolean">
-| <REAL : "real">
-| <DOUBLE : "double">
-| <FLOAT : "float">
-| <INT : "int">
+| <REAL    : "real">
+| <DOUBLE  : "double">
+| <FLOAT   : "float">
+| <INT     : "int">
 | <INTEGER : "integer">
 }
 
 <PHPPARSING> TOKEN :
 {
-  < _ORL : "OR" >
-| < _ANDL: "AND">
+  <_ORL  : "OR">
+| <_ANDL : "AND">
 }
 
 /* LITERALS */
@@ -441,7 +464,7 @@ MORE :
   >
 |
   < #SPECIAL:
-    "_"
+    "_" | ["\u007f"-"\u00ff"]
   >
 }
 
@@ -449,74 +472,79 @@ MORE :
 
 <PHPPARSING> TOKEN :
 {
-  < LPAREN: "(" >
-| < RPAREN: ")" >
-| < LBRACE: "{" >
-| < RBRACE: "}" >
-| < LBRACKET: "[" >
-| < RBRACKET: "]" >
-| < SEMICOLON: ";" >
-| < COMMA: "," >
-| < DOT: "." >
+  <LPAREN    : "(">
+| <RPAREN    : ")">
+| <LBRACE    : "{">
+| <RBRACE    : "}">
+| <LBRACKET  : "[">
+| <RBRACKET  : "]">
+| <SEMICOLON : ";">
+| <COMMA     : ",">
+| <DOT       : ".">
 }
 
-/* OPERATORS */
 
+/* COMPARATOR */
 <PHPPARSING> TOKEN :
 {
-  <AT     : "@">
-| <DOLLAR : "$">
-| <ASSIGN: "=" >
-| <GT: ">" >
-| <LT: "<" >
-| <BANG: "!" >
-| <HOOK: "?" >
-| <COLON: ":" >
-| <EQ: "==" >
-| <LE: "<=" >
-| <GE: ">=" >
-| <NE: "!=" >
-| <SC_OR: "||" >
-| <SC_AND: "&&" >
-| <INCR: "++" >
-| <DECR: "--" >
-| <PLUS: "+" >
-| <MINUS: "-" >
-| <STAR: "*" >
-| <SLASH: "/" >
-| <BIT_AND: "&" >
-| <BIT_OR: "|" >
-| <XOR: "^" >
-| <REM: "%" >
-| <LSHIFT: "<<" >
-| <RSIGNEDSHIFT: ">>" >
-| <RUNSIGNEDSHIFT: ">>>" >
-| <PLUSASSIGN: "+=" >
-| <MINUSASSIGN: "-=" >
-| <STARASSIGN: "*=" >
-| <SLASHASSIGN: "/=" >
-| <ANDASSIGN: "&=" >
-| <ORASSIGN: "|=" >
-| <XORASSIGN: "^=" >
-| <DOTASSIGN: ".=" >
-| <REMASSIGN: "%=" >
-| <LSHIFTASSIGN: "<<=" >
-| <RSIGNEDSHIFTASSIGN: ">>=" >
-| <RUNSIGNEDSHIFTASSIGN: ">>>=" >
+  <GT                 : ">">
+| <LT                 : "<">
+| <EQ                 : "==">
+| <LE                 : "<=">
+| <GE                 : ">=">
+| <NE                 : "!=">
+| <DIF                : "<>">
+| <BANGDOUBLEEQUAL    : "!==">
+| <TRIPLEEQUAL        : "===">
 }
 
+/* ASSIGNATION */
 <PHPPARSING> TOKEN :
 {
-  < DOLLAR_ID: <DOLLAR> <IDENTIFIER>  >
+  <ASSIGN             : "=">
+| <PLUSASSIGN         : "+=">
+| <MINUSASSIGN        : "-=">
+| <STARASSIGN         : "*=">
+| <SLASHASSIGN        : "/=">
+| <ANDASSIGN          : "&=">
+| <ORASSIGN           : "|=">
+| <XORASSIGN          : "^=">
+| <DOTASSIGN          : ".=">
+| <REMASSIGN          : "%=">
+| <TILDEEQUAL         : "~=">
 }
 
-/*****************************************
- * THE JAVA LANGUAGE GRAMMAR STARTS HERE *
- *****************************************/
+/* OPERATORS */
+<PHPPARSING> TOKEN :
+{
+  <AT                 : "@">
+| <DOLLAR             : "$">
+| <BANG               : "!">
+| <HOOK               : "?">
+| <COLON              : ":">
+| <SC_OR              : "||">
+| <SC_AND             : "&&">
+| <INCR               : "++">
+| <DECR               : "--">
+| <PLUS               : "+">
+| <MINUS              : "-">
+| <STAR               : "*">
+| <SLASH              : "/">
+| <BIT_AND            : "&">
+| <BIT_OR             : "|">
+| <XOR                : "^">
+| <REM                : "%">
+| <LSHIFT             : "<<">
+| <RSIGNEDSHIFT       : ">>">
+| <RUNSIGNEDSHIFT     : ">>>">
+| <LSHIFTASSIGN       : "<<=">
+| <RSIGNEDSHIFTASSIGN : ">>=">
+}
 
-/*
- * Program structuring syntax follows.
- */
+<PHPPARSING> TOKEN :
+{
+  < DOLLAR_ID: <DOLLAR> <IDENTIFIER>  >
+}
 
 void phpTest() :
 {}
@@ -528,8 +556,43 @@ void phpTest() :
 void phpFile() :
 {}
 {
-  (<PHPSTART> Php() <PHPEND>)*
-  <EOF>
+  try {
+    (PhpBlock())*
+    <EOF>
+  } catch (TokenMgrError e) {
+    errorMessage = e.getMessage();
+    errorLevel   = ERROR;
+    throw generateParseException();
+  }
+}
+
+void PhpBlock() :
+{
+  final int start = jj_input_stream.bufpos;
+}
+{
+  <PHPECHOSTART> Expression() [ <SEMICOLON> ] <PHPEND>
+|
+  [ <PHPSTARTLONG>
+  | <PHPSTARTSHORT>
+  {try {
+    setMarker(fileToParse,
+              "You should use '<?php' instead of '<?' it will avoid some problems with XML",
+              start,
+              jj_input_stream.bufpos,
+              INFO,
+              "Line " + token.beginLine);
+  } catch (CoreException e) {
+    PHPeclipsePlugin.log(e);
+  }}
+  ]Php()
+  try {
+    <PHPEND>
+  } catch (ParseException e) {
+    errorMessage = "'?>' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 void Php() :
@@ -540,20 +603,24 @@ void Php() :
 
 void ClassDeclaration() :
 {
-  PHPClassDeclaration classDeclaration;
-  Token className;
-  int pos = jj_input_stream.bufpos;
+  final PHPClassDeclaration classDeclaration;
+  final Token className;
+  final int pos = jj_input_stream.bufpos;
 }
 {
   <CLASS> className = <IDENTIFIER> [ <EXTENDS> <IDENTIFIER> ]
   {
-    classDeclaration = new PHPClassDeclaration(currentSegment,className.image,pos);
-    currentSegment.add(classDeclaration);
-    currentSegment = classDeclaration;
+    if (currentSegment != null) {
+      classDeclaration = new PHPClassDeclaration(currentSegment,className.image,pos);
+      currentSegment.add(classDeclaration);
+      currentSegment = classDeclaration;
+    }
   }
   ClassBody()
   {
-    currentSegment = (PHPSegmentWithChildren) currentSegment.getParent();
+    if (currentSegment != null) {
+      currentSegment = (PHPSegmentWithChildren) currentSegment.getParent();
+    }
   }
 }
 
@@ -591,10 +658,18 @@ void FieldDeclaration() :
 }
 {
   <VAR> variableDeclaration = VariableDeclarator()
-  {currentSegment.add(variableDeclaration);}
+  {
+    if (currentSegment != null) {
+      currentSegment.add(variableDeclaration);
+    }
+  }
   ( <COMMA>
-    variableDeclaration = VariableDeclarator()
-    {currentSegment.add(variableDeclaration);}
+      variableDeclaration = VariableDeclarator()
+      {
+      if (currentSegment != null) {
+        currentSegment.add(variableDeclaration);
+      }
+      }
   )*
   try {
     <SEMICOLON>
@@ -607,9 +682,9 @@ void FieldDeclaration() :
 
 PHPVarDeclaration VariableDeclarator() :
 {
-  String varName;
+  final String varName;
   String varValue = null;
-  int pos = jj_input_stream.bufpos;
+  final int pos = jj_input_stream.bufpos;
 }
 {
   varName = VariableDeclaratorId()
@@ -617,24 +692,20 @@ PHPVarDeclaration VariableDeclarator() :
     <ASSIGN>
     try {
       varValue = VariableInitializer()
+      {return new PHPVarDeclaration(currentSegment,varName,pos,varValue);}
     } catch (ParseException e) {
       errorMessage = "Literal expression expected in variable initializer";
       errorLevel   = ERROR;
       throw e;
     }
   ]
-  {
-    if (varValue == null) {
-      return new PHPVarDeclaration(currentSegment,varName,pos);
-    }
-    return new PHPVarDeclaration(currentSegment,varName,pos,varValue);
-  }
+  {return new PHPVarDeclaration(currentSegment,varName,pos);}
 }
 
 String VariableDeclaratorId() :
 {
   String expr;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   try {
@@ -654,7 +725,7 @@ String VariableDeclaratorId() :
 String Variable():
 {
   String expr = null;
-  Token token;
+  final Token token;
 }
 {
   token = <DOLLAR_ID> [<LBRACE> expr = Expression() <RBRACE>]
@@ -672,7 +743,7 @@ String Variable():
 String VariableName():
 {
 String expr = null;
-Token token;
+final Token token;
 }
 {
   <LBRACE> expr = Expression() <RBRACE>
@@ -700,20 +771,30 @@ Token token;
 
 String VariableInitializer() :
 {
-  String expr;
+  final String expr;
+  final Token token;
 }
 {
   expr = Literal()
   {return expr;}
 |
+  <MINUS> (token = <INTEGER_LITERAL> | token = <FLOATING_POINT_LITERAL>)
+  {return "-" + token.image;}
+|
+  <PLUS> (token = <INTEGER_LITERAL> | token = <FLOATING_POINT_LITERAL>)
+  {return "+" + token.image;}
+|
   expr = ArrayDeclarator()
   {return expr;}
+|
+  token = <IDENTIFIER>
+  {return token.image;}
 }
 
 String ArrayVariable() :
 {
 String expr;
-StringBuffer buff = new StringBuffer();
+final StringBuffer buff = new StringBuffer();
 }
 {
   expr = Expression()
@@ -725,8 +806,8 @@ StringBuffer buff = new StringBuffer();
 
 String ArrayInitializer() :
 {
-String expr = null;
-StringBuffer buff = new StringBuffer("(");
+String expr;
+final StringBuffer buff = new StringBuffer("(");
 }
 {
   <LPAREN> [ expr = ArrayVariable()
@@ -743,26 +824,30 @@ StringBuffer buff = new StringBuffer("(");
 
 void MethodDeclaration() :
 {
-  PHPFunctionDeclaration functionDeclaration;
+  final PHPFunctionDeclaration functionDeclaration;
 }
 {
   <FUNCTION> functionDeclaration = MethodDeclarator()
   {
-    currentSegment.add(functionDeclaration);
-    currentSegment = functionDeclaration;
+    if (currentSegment != null) {
+      currentSegment.add(functionDeclaration);
+      currentSegment = functionDeclaration;
+    }
   }
   Block()
   {
-    currentSegment = (PHPSegmentWithChildren) currentSegment.getParent();
+    if (currentSegment != null) {
+      currentSegment = (PHPSegmentWithChildren) currentSegment.getParent();
+    }
   }
 }
 
 PHPFunctionDeclaration MethodDeclarator() :
 {
-  Token identifier;
-  StringBuffer methodDeclaration = new StringBuffer();
-  String formalParameters;
-  int pos = jj_input_stream.bufpos;
+  final Token identifier;
+  final StringBuffer methodDeclaration = new StringBuffer();
+  final String formalParameters;
+  final int pos = jj_input_stream.bufpos;
 }
 {
   [ <BIT_AND> {methodDeclaration.append("&");} ]
@@ -810,8 +895,8 @@ String FormalParameters() :
 
 String FormalParameter() :
 {
-  PHPVarDeclaration variableDeclaration;
-  StringBuffer buff = new StringBuffer();
+  final PHPVarDeclaration variableDeclaration;
+  final StringBuffer buff = new StringBuffer();
 }
 {
   [<BIT_AND> {buff.append("&");}] variableDeclaration = VariableDeclarator()
@@ -847,13 +932,16 @@ String Type() :
 |
   <INTEGER>
   {return "integer";}
+|
+  <OBJECT>
+  {return "object";}
 }
 
 String Expression() :
 {
-  String expr;
-  String assignOperator = null;
-  String expr2 = null;
+  final String expr;
+  final String assignOperator;
+  final String expr2;
 }
 {
   expr = PrintExpression()
@@ -864,19 +952,14 @@ String Expression() :
     assignOperator = AssignmentOperator()
     try {
       expr2 = Expression()
+      {return expr + assignOperator + expr2;}
     } catch (ParseException e) {
       errorMessage = "expression expected";
       errorLevel   = ERROR;
-      throw generateParseException();
+      throw e;
     }
   ]
-  {
-    if (expr2 == null) {
-      return expr;
-    } else {
-      return expr + assignOperator + expr2;
-    }
-  }
+  {return expr;}
 }
 
 String AssignmentOperator() :
@@ -898,8 +981,6 @@ String AssignmentOperator() :
 {return "<<=";}
 | <RSIGNEDSHIFTASSIGN>
 {return ">>=";}
-| <RUNSIGNEDSHIFTASSIGN>
-{return ">>>=";}
 | <ANDASSIGN>
 {return "&=";}
 | <XORASSIGN>
@@ -908,11 +989,13 @@ String AssignmentOperator() :
 {return "|=";}
 | <DOTASSIGN>
 {return ".=";}
+| <TILDEEQUAL>
+{return "~=";}
 }
 
 String ConditionalExpression() :
 {
-  String expr;
+  final String expr;
   String expr2 = null;
   String expr3 = null;
 }
@@ -931,19 +1014,16 @@ String ConditionalOrExpression() :
 {
   String expr;
   Token operator;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = ConditionalAndExpression()
-  {
-    buff.append(expr);
-  }
+  {buff.append(expr);}
   (
-    (operator = <SC_OR> | operator = <_ORL>) expr2 = ConditionalAndExpression()
+    (operator = <SC_OR> | operator = <_ORL>) expr = ConditionalAndExpression()
     {
       buff.append(operator.image);
-      buff.append(expr2);
+      buff.append(expr);
     }
   )*
   {
@@ -955,77 +1035,55 @@ String ConditionalAndExpression() :
 {
   String expr;
   Token operator;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = ConcatExpression()
-  {
-    buff.append(expr);
-  }
+  {buff.append(expr);}
   (
-  (operator = <SC_AND> | operator = <_ANDL>) expr2 = ConcatExpression()
+  (operator = <SC_AND> | operator = <_ANDL>) expr = ConcatExpression()
     {
       buff.append(operator.image);
-      buff.append(expr2);
+      buff.append(expr);
     }
   )*
-  {
-    return buff.toString();
-  }
+  {return buff.toString();}
 }
 
 String ConcatExpression() :
 {
   String expr;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = InclusiveOrExpression()
-  {
-    buff.append(expr);
-  }
+  {buff.append(expr);}
   (
-  <DOT> expr2 = InclusiveOrExpression()
-  {
-    buff.append(".");
-    buff.append(expr2);
-  }
+  <DOT> expr = InclusiveOrExpression()
+  {buff.append(".").append(expr);}
   )*
-  {
-    return buff.toString();
-  }
+  {return buff.toString();}
 }
 
 String InclusiveOrExpression() :
 {
   String expr;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = ExclusiveOrExpression()
-  {
-    buff.append(expr);
-  }
+  {buff.append(expr);}
   (
-  <BIT_OR> expr2 = ExclusiveOrExpression()
-  {
-    buff.append("|");
-    buff.append(expr2);
-  }
+  <BIT_OR> expr = ExclusiveOrExpression()
+  {buff.append("|").append(expr);}
   )*
-  {
-    return buff.toString();
-  }
+  {return buff.toString();}
 }
 
 String ExclusiveOrExpression() :
 {
   String expr;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = AndExpression()
@@ -1033,10 +1091,10 @@ String ExclusiveOrExpression() :
     buff.append(expr);
   }
   (
-    <XOR> expr2 = AndExpression()
+    <XOR> expr = AndExpression()
   {
     buff.append("^");
-    buff.append(expr2);
+    buff.append(expr);
   }
   )*
   {
@@ -1047,8 +1105,7 @@ String ExclusiveOrExpression() :
 String AndExpression() :
 {
   String expr;
-  String expr2 = null;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = EqualityExpression()
@@ -1056,32 +1113,34 @@ String AndExpression() :
     buff.append(expr);
   }
   (
-    <BIT_AND> expr2 = EqualityExpression()
+    <BIT_AND> expr = EqualityExpression()
   {
-    buff.append("&");
-    buff.append(expr2);
+    buff.append("&").append(expr);
   }
   )*
-  {
-    return buff.toString();
-  }
+  {return buff.toString();}
 }
 
 String EqualityExpression() :
 {
   String expr;
   Token operator;
-  String expr2;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = RelationalExpression()
   {buff.append(expr);}
   (
-  ( operator = <EQ> | operator = <NE> ) expr2 = RelationalExpression()
+  (   operator = <EQ>
+    | operator = <DIF>
+    | operator = <NE>
+    | operator = <BANGDOUBLEEQUAL>
+    | operator = <TRIPLEEQUAL>
+  )
+  expr = RelationalExpression()
   {
     buff.append(operator.image);
-    buff.append(expr2);
+    buff.append(expr);
   }
   )*
   {return buff.toString();}
@@ -1091,18 +1150,14 @@ String RelationalExpression() :
 {
   String expr;
   Token operator;
-  String expr2;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = ShiftExpression()
   {buff.append(expr);}
   (
-  ( operator = <LT> | operator = <GT> | operator = <LE> | operator = <GE> ) expr2 = ShiftExpression()
-  {
-    buff.append(operator.image);
-    buff.append(expr2);
-  }
+  ( operator = <LT> | operator = <GT> | operator = <LE> | operator = <GE> ) expr = ShiftExpression()
+  {buff.append(operator.image).append(expr);}
   )*
   {return buff.toString();}
 }
@@ -1111,17 +1166,16 @@ String ShiftExpression() :
 {
   String expr;
   Token operator;
-  String expr2;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = AdditiveExpression()
   {buff.append(expr);}
   (
-  (operator = <LSHIFT> | operator = <RSIGNEDSHIFT> | operator = <RUNSIGNEDSHIFT> ) expr2 = AdditiveExpression()
+  (operator = <LSHIFT> | operator = <RSIGNEDSHIFT> | operator = <RUNSIGNEDSHIFT> ) expr = AdditiveExpression()
   {
     buff.append(operator.image);
-    buff.append(expr2);
+    buff.append(expr);
   }
   )*
   {return buff.toString();}
@@ -1131,17 +1185,16 @@ String AdditiveExpression() :
 {
   String expr;
   Token operator;
-  String expr2;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   expr = MultiplicativeExpression()
   {buff.append(expr);}
   (
-   ( operator = <PLUS> | operator = <MINUS> ) expr2 = MultiplicativeExpression()
+   ( operator = <PLUS> | operator = <MINUS> ) expr = MultiplicativeExpression()
   {
     buff.append(operator.image);
-    buff.append(expr2);
+    buff.append(expr);
   }
    )*
   {return buff.toString();}
@@ -1149,31 +1202,50 @@ String AdditiveExpression() :
 
 String MultiplicativeExpression() :
 {
-  String expr, expr2;
+  String expr;
   Token operator;
   final StringBuffer buff = new StringBuffer();}
 {
   expr = UnaryExpression()
   {buff.append(expr);}
   (
-  ( operator = <STAR> | operator = <SLASH> | operator = <REM> ) expr2 = UnaryExpression()
+  ( operator = <STAR> | operator = <SLASH> | operator = <REM> ) expr = UnaryExpression()
   {
     buff.append(operator.image);
-    buff.append(expr2);
+    buff.append(expr);
   }
   )*
   {return buff.toString();}
 }
 
+/**
+ * An unary expression starting with @, & or nothing
+ */
 String UnaryExpression() :
 {
-  String expr;
-  Token token;
+  final String expr;
+  final Token token;
+  final StringBuffer buff = new StringBuffer();
 }
 {
-  <AT> expr = UnaryExpression()
-  {return "@" + expr;}
+  token = <BIT_AND> expr = UnaryExpressionNoPrefix()
+  {
+    if (token == null) {
+      return expr;
+    }
+    return token.image + expr;
+  }
 |
+  (<AT> {buff.append("@");})* expr = UnaryExpressionNoPrefix()
+  {return buff.append(expr).toString();}
+}
+
+String UnaryExpressionNoPrefix() :
+{
+  final String expr;
+  final Token token;
+}
+{
   ( token = <PLUS> | token = <MINUS> ) expr = UnaryExpression()
   {
     return token.image + expr;
@@ -1189,9 +1261,10 @@ String UnaryExpression() :
   {return expr;}
 }
 
+
 String PreIncrementExpression() :
 {
-String expr;
+final String expr;
 }
 {
   <INCR> expr = PrimaryExpression()
@@ -1200,7 +1273,7 @@ String expr;
 
 String PreDecrementExpression() :
 {
-String expr;
+final String expr;
 }
 {
   <DECR> expr = PrimaryExpression()
@@ -1209,7 +1282,7 @@ String expr;
 
 String UnaryExpressionNotPlusMinus() :
 {
-  String expr;
+  final String expr;
 }
 {
   <BANG> expr = UnaryExpression()
@@ -1231,8 +1304,7 @@ String UnaryExpressionNotPlusMinus() :
 
 String CastExpression() :
 {
-String type;
-String expr;
+final String type, expr;
 }
 {
   <LPAREN> type = Type() <RPAREN> expr = UnaryExpression()
@@ -1241,7 +1313,7 @@ String expr;
 
 String PostfixExpression() :
 {
-  String expr;
+  final String expr;
   Token operator = null;
 }
 {
@@ -1256,7 +1328,7 @@ String PostfixExpression() :
 
 String PrimaryExpression() :
 {
-  Token identifier;
+  final Token identifier;
   String expr;
   final StringBuffer buff = new StringBuffer();
 }
@@ -1280,7 +1352,7 @@ String PrimaryExpression() :
 
 String ArrayDeclarator() :
 {
-  String expr;
+  final String expr;
 }
 {
   <ARRAY> expr = ArrayInitializer()
@@ -1289,19 +1361,16 @@ String ArrayDeclarator() :
 
 String PrimaryPrefix() :
 {
-  String expr;
-  Token token = null;
+  final String expr;
+  final Token token;
 }
 {
   token = <IDENTIFIER>
   {return token.image;}
 |
-  [token = <BIT_AND>] <NEW> expr = ClassIdentifier()
+  <NEW> expr = ClassIdentifier()
   {
-    if (token == null) {
-      return "new " + expr;
-    }
-    return "new &" + expr;
+    return "new " + expr;
   }
 |  
   expr = VariableDeclaratorId()
@@ -1310,8 +1379,8 @@ String PrimaryPrefix() :
 
 String ClassIdentifier():
 {
-  String expr;
-  Token token;
+  final String expr;
+  final Token token;
 }
 {
   token = <IDENTIFIER>
@@ -1323,7 +1392,7 @@ String ClassIdentifier():
 
 String PrimarySuffix() :
 {
-  String expr;
+  final String expr;
 }
 {
   expr = Arguments()
@@ -1347,7 +1416,7 @@ String VariableSuffix() :
   } catch (ParseException e) {
     errorMessage = "']' expected";
     errorLevel   = ERROR;
-    throw generateParseException();
+    throw e;
   }
   {
     if(expr == null) {
@@ -1359,8 +1428,8 @@ String VariableSuffix() :
 
 String Literal() :
 {
-  String expr;
-  Token token;
+  final String expr;
+  final Token token;
 }
 {
   token = <INTEGER_LITERAL>
@@ -1369,14 +1438,8 @@ String Literal() :
   token = <FLOATING_POINT_LITERAL>
   {return token.image;}
 |
-  try {
-    token = <STRING_LITERAL>
+  token = <STRING_LITERAL>
   {return token.image;}
-  } catch (TokenMgrError e) {
-    errorMessage = "unterminated string";
-    errorLevel   = ERROR;
-    throw generateParseException();
-  }
 |
   expr = BooleanLiteral()
   {return expr;}
@@ -1426,7 +1489,7 @@ String expr = null;
 String ArgumentList() :
 {
 String expr;
-StringBuffer buff = new StringBuffer();
+final StringBuffer buff = new StringBuffer();
 }
 {
   expr = Expression()
@@ -1440,7 +1503,7 @@ StringBuffer buff = new StringBuffer();
         throw e;
       }
     {
-      buff.append(",").append("expr");
+      buff.append(",").append(expr);
     }
    )*
    {return buff.toString();}
@@ -1456,7 +1519,7 @@ void Statement() :
   LOOKAHEAD(2)
   Expression()
   try {
-    (<SEMICOLON> | "?>")
+    (<SEMICOLON> | <PHPEND>)
   } catch (ParseException e) {
     errorMessage = "';' expected";
     errorLevel   = ERROR;
@@ -1489,6 +1552,8 @@ void Statement() :
 |
   ForStatement()
 |
+  ForeachStatement()
+|
   BreakStatement()
 |
   ContinueStatement()
@@ -1506,13 +1571,17 @@ void Statement() :
 
 void IncludeStatement() :
 {
-  String expr;
-  int pos = jj_input_stream.bufpos;
+  final String expr;
+  final int pos = jj_input_stream.bufpos;
 }
 {
   <REQUIRE>
   expr = Expression()
-  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require",pos,expr));}
+  {
+    if (currentSegment != null) {
+      currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require",pos,expr));
+    }
+  }
   try {
     (<SEMICOLON> | "?>")
   } catch (ParseException e) {
@@ -1523,7 +1592,11 @@ void IncludeStatement() :
 |
   <REQUIRE_ONCE>
   expr = Expression()
-  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require_once",pos,expr));}
+  {
+    if (currentSegment != null) {
+      currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require_once",pos,expr));
+    }
+  }
   try {
     (<SEMICOLON> | "?>")
   } catch (ParseException e) {
@@ -1534,7 +1607,11 @@ void IncludeStatement() :
 |
   <INCLUDE>
   expr = Expression()
-  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include",pos,expr));}
+  {
+    if (currentSegment != null) {
+      currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include",pos,expr));
+    }
+  }
   try {
     (<SEMICOLON> | "?>")
   } catch (ParseException e) {
@@ -1545,7 +1622,11 @@ void IncludeStatement() :
 |
   <INCLUDE_ONCE>
   expr = Expression()
-  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include_once",pos,expr));}
+  {
+    if (currentSegment != null) {
+      currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include_once",pos,expr));
+    }
+  }
   try {
     (<SEMICOLON> | "?>")
   } catch (ParseException e) {
@@ -1557,8 +1638,8 @@ void IncludeStatement() :
 
 String PrintExpression() :
 {
-  StringBuffer buff = new StringBuffer("print ");
-  String expr;
+  final StringBuffer buff = new StringBuffer("print ");
+  final String expr;
 }
 {
   <PRINT> expr = Expression()
@@ -1640,7 +1721,13 @@ void BlockStatement() :
 void LocalVariableDeclaration() :
 {}
 {
-  VariableDeclarator() ( <COMMA> VariableDeclarator() )*
+  LocalVariableDeclarator() ( <COMMA> LocalVariableDeclarator() )*
+}
+
+void LocalVariableDeclarator() :
+{}
+{
+  VariableDeclaratorId() [ <ASSIGN> Expression() ]
 }
 
 void EmptyStatement() :
@@ -1683,17 +1770,15 @@ void SwitchLabel() :
 }
 
 void IfStatement() :
-/*
- * The disambiguating algorithm of JavaCC automatically binds dangling
- * else's to the innermost if statement.  The LOOKAHEAD specification
- * is to tell JavaCC that we know what we are doing.
- */
-{}
 {
-  <IF> Condition("if") Statement() ( LOOKAHEAD(1) ElseIfStatement() )* [ LOOKAHEAD(1) <ELSE> Statement() ]
+  final Token token;
+  final int pos = jj_input_stream.bufpos;
+}
+{
+  token = <IF> Condition("if") IfStatement0(pos,pos+token.image.length())
 }
 
-void Condition(String keyword) :
+void Condition(final String keyword) :
 {}
 {
   try {
@@ -1713,6 +1798,52 @@ void Condition(String keyword) :
   }
 }
 
+void IfStatement0(final int start,final int end) :
+{
+}
+{
+  <COLON> (Statement())* (ElseIfStatementColon())* [ElseStatementColon()]
+
+  {try {
+  setMarker(fileToParse,
+            "Ugly syntax detected, you should if () {...} instead of if (): ... endif;",
+            start,
+            end,
+            INFO,
+            "Line " + token.beginLine);
+  } catch (CoreException e) {
+    PHPeclipsePlugin.log(e);
+  }}
+  try {
+    <ENDIF>
+  } catch (ParseException e) {
+    errorMessage = "'endif' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  try {
+    <SEMICOLON>
+  } catch (ParseException e) {
+    errorMessage = "';' expected 'endif' keyword";
+    errorLevel   = ERROR;
+    throw e;
+  }
+|
+  Statement() ( LOOKAHEAD(1) ElseIfStatement() )* [ LOOKAHEAD(1) <ELSE> Statement() ]
+}
+
+void ElseIfStatementColon() :
+{}
+{
+  <ELSEIF> Condition("elseif") <COLON> (Statement())*
+}
+
+void ElseStatementColon() :
+{}
+{
+  <ELSE> <COLON> (Statement())*
+}
+
 void ElseIfStatement() :
 {}
 {
@@ -1720,19 +1851,39 @@ void ElseIfStatement() :
 }
 
 void WhileStatement() :
-{}
 {
-  <WHILE> Condition("while") WhileStatement0()
+  final Token token;
+  final int pos = jj_input_stream.bufpos;
+}
+{
+  token = <WHILE> Condition("while") WhileStatement0(pos,pos + token.image.length())
 }
 
-void WhileStatement0() :
+void WhileStatement0(final int start, final int end) :
 {}
 {
-  <COLON> (Statement())* <ENDWHILE>
+  <COLON> (Statement())*
+  {try {
+  setMarker(fileToParse,
+            "Ugly syntax detected, you should while () {...} instead of while (): ... endwhile;",
+            start,
+            end,
+            INFO,
+            "Line " + token.beginLine);
+  } catch (CoreException e) {
+    PHPeclipsePlugin.log(e);
+  }}
+  try {
+    <ENDWHILE>
+  } catch (ParseException e) {
+    errorMessage = "'endwhile' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
   try {
     (<SEMICOLON> | "?>")
   } catch (ParseException e) {
-    errorMessage = "';' expected";
+    errorMessage = "';' expected after 'endwhile' keyword";
     errorLevel   = ERROR;
     throw e;
   }
@@ -1753,10 +1904,103 @@ void DoStatement() :
   }
 }
 
-void ForStatement() :
+void ForeachStatement() :
 {}
 {
-  <FOR> <LPAREN> [ ForInit() ] <SEMICOLON> [ Expression() ] <SEMICOLON> [ ForUpdate() ] <RPAREN> Statement()
+  <FOREACH>
+    try {
+    <LPAREN>
+  } catch (ParseException e) {
+    errorMessage = "'(' expected after 'foreach' keyword";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  try {
+    Variable()
+  } catch (ParseException e) {
+    errorMessage = "variable expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  [ VariableSuffix() ]
+  try {
+    <AS>
+  } catch (ParseException e) {
+    errorMessage = "'as' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  try {
+    Variable()
+  } catch (ParseException e) {
+    errorMessage = "variable expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  [ <ARRAYASSIGN> Expression() ]
+  try {
+    <RPAREN>
+  } catch (ParseException e) {
+    errorMessage = "')' expected after 'foreach' keyword";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  try {
+    Statement()
+  } catch (ParseException e) {
+    if (errorMessage != null) throw e;
+    errorMessage = "statement expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+}
+
+void ForStatement() :
+{
+final Token token;
+final int pos = jj_input_stream.bufpos;
+}
+{
+  token = <FOR>
+  try {
+    <LPAREN>
+  } catch (ParseException e) {
+    errorMessage = "'(' expected after 'for' keyword";
+    errorLevel   = ERROR;
+    throw e;
+  }
+     [ ForInit() ] <SEMICOLON> [ Expression() ] <SEMICOLON> [ ForUpdate() ] <RPAREN>
+    (
+      Statement()
+    |
+      <COLON> (Statement())*
+      {
+        try {
+        setMarker(fileToParse,
+                  "Ugly syntax detected, you should for () {...} instead of for (): ... endfor;",
+                  pos,
+                  pos+token.image.length(),
+                  INFO,
+                  "Line " + token.beginLine);
+        } catch (CoreException e) {
+          PHPeclipsePlugin.log(e);
+        }
+      }
+      try {
+        <ENDFOR>
+      } catch (ParseException e) {
+        errorMessage = "'endfor' expected";
+        errorLevel   = ERROR;
+        throw e;
+      }
+      try {
+        <SEMICOLON>
+      } catch (ParseException e) {
+        errorMessage = "';' expected 'endfor' keyword";
+        errorLevel   = ERROR;
+        throw e;
+      }
+    )
 }
 
 void ForInit() :