misc changes
[phpeclipse.git] / net.sourceforge.phpeclipse / src / test / PHPParser.jj
index a6bce7c..861d2c6 100644 (file)
@@ -38,6 +38,8 @@ import net.sourceforge.phpdt.internal.compiler.parser.PHPOutlineInfo;
 import net.sourceforge.phpdt.internal.compiler.parser.PHPSegmentWithChildren;
 import net.sourceforge.phpdt.internal.compiler.parser.PHPFunctionDeclaration;
 import net.sourceforge.phpdt.internal.compiler.parser.PHPClassDeclaration;
+import net.sourceforge.phpdt.internal.compiler.parser.PHPVarDeclaration;
+import net.sourceforge.phpdt.internal.compiler.parser.PHPReqIncDeclaration;
 
 /**
  * A new php parser.
@@ -55,9 +57,6 @@ public class PHPParser extends PHPParserSuperclass {
 
   private static final String PARSE_ERROR_STRING = "Parse error"; //$NON-NLS-1$
   private static final String PARSE_WARNING_STRING = "Warning"; //$NON-NLS-1$
-  public static final int ERROR = 2;
-  public static final int WARNING = 1;
-  public static final int INFO = 0;
   PHPOutlineInfo outlineInfo;
   private static int errorLevel = ERROR;
   private static String errorMessage;
@@ -104,45 +103,33 @@ public class PHPParser extends PHPParserSuperclass {
     try {
       parse();
     } catch (ParseException e) {
-      if (errorMessage == null) {
-        PHPeclipsePlugin.log(e);
-      } else {
-        setMarker(errorMessage, e.currentToken.beginLine, errorLevel);
-        errorMessage = null;
-      }
+      processParseException(e);
     }
     return outlineInfo;
   }
 
-
   /**
-   * Create marker for the parse error
+   * This method will process the parse exception.
+   * If the error message is null, the parse exception wasn't catched and a trace is written in the log
+   * @param e the ParseException
    */
-  private static void setMarker(String message, int lineNumber, int errorLevel) {
-    try {
-      setMarker(fileToParse, message, lineNumber, errorLevel);
-    } catch (CoreException e) {
+  private static void processParseException(final ParseException e) {
+    if (errorMessage == null) {
       PHPeclipsePlugin.log(e);
+      errorMessage = "this exception wasn't handled by the parser please tell us how to reproduce it";
     }
+    setMarker(e);
+    errorMessage = null;
   }
 
-  public static void setMarker(IFile file, String message, int lineNumber, int errorLevel) throws CoreException {
-    if (file != null) {
-      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;
-      }
-      MarkerUtilities.setLineNumber(attributes, lineNumber);
-      MarkerUtilities.createMarker(file, attributes, IMarker.PROBLEM);
+  /**
+   * Create marker for the parse error
+   */
+  private static void setMarker(ParseException e) {
+    try {
+      setMarker(fileToParse, errorMessage, jj_input_stream.tokenBegin,jj_input_stream.tokenBegin+e.currentToken.image.length(), errorLevel);
+    } catch (CoreException e2) {
+      PHPeclipsePlugin.log(e2);
     }
   }
 
@@ -214,12 +201,7 @@ public class PHPParser extends PHPParserSuperclass {
     try {
       parse();
     } catch (ParseException e) {
-      if (errorMessage == null) {
-        PHPeclipsePlugin.log(e);
-      } else {
-        setMarker(errorMessage, e.currentToken.beginLine, errorLevel);
-        errorMessage = null;
-      }
+      processParseException(e);
     }
   }
 
@@ -416,20 +398,30 @@ MORE :
   < STRING_LITERAL: (<STRING_1> | <STRING_2> | <STRING_3>)>
 |    < STRING_1:
       "\""
-      (   (~["\""])
-        | "\\\""
+      (
+        ~["\""]
+        |
+        "\\\""
       )*
       "\""
     >
 |    < STRING_2:
       "'"
-      (   (~["'"]))*
+      (
+      ~["'"]
+       |
+       "\\'"
+      )*
 
       "'"
     >
 |   < STRING_3:
       "`"
-      (   (~["`"]))*
+      (
+        ~["`"]
+      |
+        "\\`"
+      )*
       "`"
     >
 }
@@ -474,43 +466,43 @@ MORE :
 {
   <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: ">>>=" >
+| <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: ">>>=" >
 }
 
 <PHPPARSING> TOKEN :
@@ -568,7 +560,21 @@ void ClassDeclaration() :
 void ClassBody() :
 {}
 {
-  <LBRACE> ( ClassBodyDeclaration() )* <RBRACE>
+  try {
+    <LBRACE>
+  } catch (ParseException e) {
+    errorMessage = "'{' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  ( ClassBodyDeclaration() )*
+  try {
+    <RBRACE>
+  } catch (ParseException e) {
+    errorMessage = "'var', 'function' or '}' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 void ClassBodyDeclaration() :
@@ -580,23 +586,49 @@ void ClassBodyDeclaration() :
 }
 
 void FieldDeclaration() :
-{}
 {
-  <VAR> VariableDeclarator() ( <COMMA> VariableDeclarator() )* <SEMICOLON>
+  PHPVarDeclaration variableDeclaration;
+}
+{
+  <VAR> variableDeclaration = VariableDeclarator()
+  {currentSegment.add(variableDeclaration);}
+  ( <COMMA>
+    variableDeclaration = VariableDeclarator()
+    {currentSegment.add(variableDeclaration);}
+  )*
+  try {
+    <SEMICOLON>
+  } catch (ParseException e) {
+    errorMessage = "';' expected after variable declaration";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
-String VariableDeclarator() :
+PHPVarDeclaration VariableDeclarator() :
 {
-  String expr;
-  StringBuffer buff = new StringBuffer();
+  String varName;
+  String varValue = null;
+  int pos = jj_input_stream.bufpos;
 }
 {
-  expr = VariableDeclaratorId()
-  {buff.append(expr);}
-  [ <ASSIGN> expr = VariableInitializer()
-    {buff.append("=").append(expr);}
+  varName = VariableDeclaratorId()
+  [
+    <ASSIGN>
+    try {
+      varValue = VariableInitializer()
+    } catch (ParseException e) {
+      errorMessage = "Literal expression expected in variable initializer";
+      errorLevel   = ERROR;
+      throw e;
+    }
   ]
-  {return buff.toString();}
+  {
+    if (varValue == null) {
+      return new PHPVarDeclaration(currentSegment,varName,pos);
+    }
+    return new PHPVarDeclaration(currentSegment,varName,pos,varValue);
+  }
 }
 
 String VariableDeclaratorId() :
@@ -605,12 +637,18 @@ String VariableDeclaratorId() :
   StringBuffer buff = new StringBuffer();
 }
 {
-  expr = Variable()
-  {buff.append(expr);}
-  ( LOOKAHEAD(2) expr = VariableSuffix()
-  {buff.append(expr);}
-  )*
-  {return buff.toString();}
+  try {
+    expr = Variable()
+    {buff.append(expr);}
+    ( LOOKAHEAD(2) expr = VariableSuffix()
+    {buff.append(expr);}
+    )*
+    {return buff.toString();}
+  } catch (ParseException e) {
+    errorMessage = "'$' expected for variable identifier";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 String Variable():
@@ -646,9 +684,18 @@ Token token;
       return token.image;
     }
     return token + "{" + expr + "}";
-  }|
+  }
+|
   <DOLLAR> expr = VariableName()
   {return "$" + expr;}
+|
+  token = <DOLLAR_ID> [expr = VariableName()]
+  {
+  if (expr == null) {
+    return token.image;
+  }
+  return token.image + expr;
+  }
 }
 
 String VariableInitializer() :
@@ -656,7 +703,10 @@ String VariableInitializer() :
   String expr;
 }
 {
-  expr = Expression()
+  expr = Literal()
+  {return expr;}
+|
+  expr = ArrayDeclarator()
   {return expr;}
 }
 
@@ -701,7 +751,7 @@ void MethodDeclaration() :
     currentSegment.add(functionDeclaration);
     currentSegment = functionDeclaration;
   }
-  ( Block() | <SEMICOLON> )
+  Block()
   {
     currentSegment = (PHPSegmentWithChildren) currentSegment.getParent();
   }
@@ -715,10 +765,12 @@ PHPFunctionDeclaration MethodDeclarator() :
   int pos = jj_input_stream.bufpos;
 }
 {
-  [ <BIT_AND> {methodDeclaration.append("&");}]
-  identifier = <IDENTIFIER> formalParameters = FormalParameters()
+  [ <BIT_AND> {methodDeclaration.append("&");} ]
+  identifier = <IDENTIFIER>
+  {methodDeclaration.append(identifier);}
+    formalParameters = FormalParameters()
   {
-    methodDeclaration.append(identifier).append(formalParameters);
+    methodDeclaration.append(formalParameters);
     return new PHPFunctionDeclaration(currentSegment,methodDeclaration.toString(),pos);
   }
 }
@@ -726,13 +778,30 @@ PHPFunctionDeclaration MethodDeclarator() :
 String FormalParameters() :
 {
   String expr;
-  StringBuffer buff = new StringBuffer("(");
+  final StringBuffer buff = new StringBuffer("(");
 }
 {
-  <LPAREN> [ expr = FormalParameter() {buff.append(expr);}
-            ( <COMMA> expr = FormalParameter()
-            {buff.append(",").append(expr);}
-            )* ] <RPAREN>
+  try {
+  <LPAREN>
+  } catch (ParseException e) {
+    errorMessage = "Formal parameter expected after function identifier";
+    errorLevel   = ERROR;
+    jj_consume_token(token.kind);
+  }
+            [ expr = FormalParameter()
+              {buff.append(expr);}
+            (
+                <COMMA> expr = FormalParameter()
+                {buff.append(",").append(expr);}
+            )*
+            ]
+  try {
+    <RPAREN>
+  } catch (ParseException e) {
+    errorMessage = "')' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
  {
   buff.append(")");
   return buff.toString();
@@ -741,13 +810,13 @@ String FormalParameters() :
 
 String FormalParameter() :
 {
-  String expr;
+  PHPVarDeclaration variableDeclaration;
   StringBuffer buff = new StringBuffer();
 }
 {
-  [<BIT_AND> {buff.append("&");}] expr = VariableDeclarator()
+  [<BIT_AND> {buff.append("&");}] variableDeclaration = VariableDeclarator()
   {
-    buff.append(expr);
+    buff.append(variableDeclaration.toString());
     return buff.toString();
   }
 }
@@ -793,7 +862,13 @@ String Expression() :
   expr = ConditionalExpression()
   [
     assignOperator = AssignmentOperator()
-    expr2 = Expression()
+    try {
+      expr2 = Expression()
+    } catch (ParseException e) {
+      errorMessage = "expression expected";
+      errorLevel   = ERROR;
+      throw generateParseException();
+    }
   ]
   {
     if (expr2 == null) {
@@ -805,9 +880,7 @@ String Expression() :
 }
 
 String AssignmentOperator() :
-{
-  Token assignOperator;
-}
+{}
 {
   <ASSIGN>
 {return "=";}
@@ -1076,10 +1149,9 @@ String AdditiveExpression() :
 
 String MultiplicativeExpression() :
 {
-  String expr;
+  String expr, expr2;
   Token operator;
-  String expr2;
-  StringBuffer buff = new StringBuffer();}
+  final StringBuffer buff = new StringBuffer();}
 {
   expr = UnaryExpression()
   {buff.append(expr);}
@@ -1096,16 +1168,15 @@ String MultiplicativeExpression() :
 String UnaryExpression() :
 {
   String expr;
-  StringBuffer buff = new StringBuffer();
+  Token token;
 }
 {
   <AT> expr = UnaryExpression()
   {return "@" + expr;}
 |
-  ( <PLUS> {buff.append("+");}| <MINUS> {buff.append("-");}) expr = UnaryExpression()
+  ( token = <PLUS> | token = <MINUS> ) expr = UnaryExpression()
   {
-    buff.append(expr);
-    return buff.toString();
+    return token.image + expr;
   }
 |
   expr = PreIncrementExpression()
@@ -1115,7 +1186,7 @@ String UnaryExpression() :
   {return expr;}
 |
   expr = UnaryExpressionNotPlusMinus()
-  {return buff.toString();}
+  {return expr;}
 }
 
 String PreIncrementExpression() :
@@ -1187,7 +1258,7 @@ String PrimaryExpression() :
 {
   Token identifier;
   String expr;
-  StringBuffer buff = new StringBuffer();
+  final StringBuffer buff = new StringBuffer();
 }
 {
   LOOKAHEAD(2)
@@ -1199,14 +1270,19 @@ String PrimaryExpression() :
   )*
   {return buff.toString();}
 |
-  expr = PrimaryPrefix()
-  {buff.append(expr);}
-  (
-  expr = PrimarySuffix()
-  {buff.append(expr);}
-  )*
+  expr = PrimaryPrefix()  {buff.append(expr);}
+  ( expr = PrimarySuffix()  {buff.append(expr);} )*
   {return buff.toString();}
 |
+  expr = ArrayDeclarator()
+  {return "array" + expr;}
+}
+
+String ArrayDeclarator() :
+{
+  String expr;
+}
+{
   <ARRAY> expr = ArrayInitializer()
   {return "array" + expr;}
 }
@@ -1225,7 +1301,7 @@ String PrimaryPrefix() :
     if (token == null) {
       return "new " + expr;
     }
-    return "new " + expr;
+    return "new &" + expr;
   }
 |  
   expr = VariableDeclaratorId()
@@ -1265,7 +1341,14 @@ String VariableSuffix() :
   <CLASSACCESS> expr = VariableName()
   {return "->" + expr;}
 | 
-  <LBRACKET> [ expr = Expression() ] <RBRACKET>
+  <LBRACKET> [ expr = Expression() ]
+  try {
+    <RBRACKET>
+  } catch (ParseException e) {
+    errorMessage = "']' expected";
+    errorLevel   = ERROR;
+    throw generateParseException();
+  }
   {
     if(expr == null) {
       return "[]";
@@ -1371,7 +1454,14 @@ void Statement() :
 {}
 {
   LOOKAHEAD(2)
-  Expression()  (<SEMICOLON> | "?>")
+  Expression()
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 |
   LOOKAHEAD(2)
   LabeledStatement()
@@ -1407,7 +1497,7 @@ void Statement() :
 |
   EchoStatement()
 |
-  IncludeStatement()
+  [<AT>] IncludeStatement()
 |
   StaticStatement()
 |
@@ -1415,15 +1505,54 @@ void Statement() :
 }
 
 void IncludeStatement() :
-{}
 {
-  <REQUIRE> Expression() (<SEMICOLON> | "?>")
+  String expr;
+  int pos = jj_input_stream.bufpos;
+}
+{
+  <REQUIRE>
+  expr = Expression()
+  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require",pos,expr));}
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 |
-  <REQUIRE_ONCE> Expression() (<SEMICOLON> | "?>")
+  <REQUIRE_ONCE>
+  expr = Expression()
+  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "require_once",pos,expr));}
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 |
-  <INCLUDE> Expression() (<SEMICOLON> | "?>")
+  <INCLUDE>
+  expr = Expression()
+  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include",pos,expr));}
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 |
-  <INCLUDE_ONCE> Expression() (<SEMICOLON> | "?>")
+  <INCLUDE_ONCE>
+  expr = Expression()
+  {currentSegment.add(new PHPReqIncDeclaration(currentSegment, "include_once",pos,expr));}
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 String PrintExpression() :
@@ -1455,13 +1584,27 @@ void EchoStatement() :
 void GlobalStatement() :
 {}
 {
-  <GLOBAL> VariableDeclaratorId() (<COMMA> VariableDeclaratorId())* (<SEMICOLON> | "?>")
+  <GLOBAL> VariableDeclaratorId() (<COMMA> VariableDeclaratorId())*
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 void StaticStatement() :
 {}
 {
-  <STATIC> VariableDeclarator() (<COMMA> VariableDeclarator())* (<SEMICOLON> | "?>")
+  <STATIC> VariableDeclarator() (<COMMA> VariableDeclarator())*
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 void LabeledStatement() :
@@ -1473,7 +1616,15 @@ void LabeledStatement() :
 void Block() :
 {}
 {
-  <LBRACE> ( BlockStatement() )* <RBRACE>
+  try {
+    <LBRACE>
+  } catch (ParseException e) {
+    errorMessage = "'{' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
+  ( BlockStatement() )*
+  <RBRACE>
 }
 
 void BlockStatement() :
@@ -1499,11 +1650,6 @@ void EmptyStatement() :
 }
 
 void StatementExpression() :
-/*
- * The last expansion of this production accepts more than the legal
- * Java expansions for StatementExpression.  This expansion does not
- * use PostfixExpression for performance reasons.
- */
 {}
 {
   PreIncrementExpression()
@@ -1582,7 +1728,14 @@ void WhileStatement() :
 void WhileStatement0() :
 {}
 {
-  <COLON> (Statement())* <ENDWHILE> (<SEMICOLON> | "?>")
+  <COLON> (Statement())* <ENDWHILE>
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 |
   Statement()
 }
@@ -1590,7 +1743,14 @@ void WhileStatement0() :
 void DoStatement() :
 {}
 {
-  <DO> Statement() <WHILE> Condition("while") (<SEMICOLON> | "?>")
+  <DO> Statement() <WHILE> Condition("while")
+  try {
+    (<SEMICOLON> | "?>")
+  } catch (ParseException e) {
+    errorMessage = "';' expected";
+    errorLevel   = ERROR;
+    throw e;
+  }
 }
 
 void ForStatement() :