View Javadoc

1   /*
2    $Id: VerifierCodeVisitor.java 4032 2006-08-30 07:18:49Z mguillem $
3   
4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6    Redistribution and use of this software and associated documentation
7    ("Software"), with or without modification, are permitted provided
8    that the following conditions are met:
9   
10   1. Redistributions of source code must retain copyright
11      statements and notices.  Redistributions must also contain a
12      copy of this document.
13  
14   2. Redistributions in binary form must reproduce the
15      above copyright notice, this list of conditions and the
16      following disclaimer in the documentation and/or other
17      materials provided with the distribution.
18  
19   3. The name "groovy" must not be used to endorse or promote
20      products derived from this Software without prior written
21      permission of The Codehaus.  For written permission,
22      please contact info@codehaus.org.
23  
24   4. Products derived from this Software may not be called "groovy"
25      nor may "groovy" appear in their names without prior written
26      permission of The Codehaus. "groovy" is a registered
27      trademark of The Codehaus.
28  
29   5. Due credit should be given to The Codehaus -
30      http://groovy.codehaus.org/
31  
32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43   OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45   */
46  package org.codehaus.groovy.classgen;
47  
48  import java.util.Iterator;
49  import java.util.List;
50  
51  import org.codehaus.groovy.ast.ASTNode;
52  import org.codehaus.groovy.ast.CodeVisitorSupport;
53  import org.codehaus.groovy.ast.stmt.ForStatement;
54  import org.codehaus.groovy.ast.expr.BinaryExpression;
55  import org.codehaus.groovy.ast.expr.Expression;
56  import org.codehaus.groovy.ast.expr.ListExpression;
57  import org.codehaus.groovy.ast.expr.MapEntryExpression;
58  import org.codehaus.groovy.ast.expr.MethodCallExpression;
59  import org.codehaus.groovy.ast.expr.PropertyExpression;
60  import org.codehaus.groovy.ast.expr.FieldExpression;
61  import org.codehaus.groovy.ast.expr.VariableExpression;
62  import org.codehaus.groovy.syntax.RuntimeParserException;
63  import org.objectweb.asm.Opcodes;
64  
65  /***
66   * Verifies the method code
67   * 
68   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
69   * @version $Revision: 4032 $
70   */
71  public class VerifierCodeVisitor extends CodeVisitorSupport implements Opcodes {
72  
73      private Verifier verifier;
74  
75      VerifierCodeVisitor(Verifier verifier) {
76          this.verifier = verifier;
77      }
78  
79      public void visitMethodCallExpression(MethodCallExpression call) {
80          super.visitMethodCallExpression(call);
81      }
82  
83      public void visitForLoop(ForStatement expression) {
84          assertValidIdentifier(expression.getVariable().getName(), "for loop variable name", expression);
85          super.visitForLoop(expression);
86      }
87  
88      public void visitPropertyExpression(PropertyExpression expression) {
89          // assertValidIdentifier(expression.getProperty(), "property name", expression);  // This has been commented out to fix the issue Groovy-843
90          super.visitPropertyExpression(expression);
91      }
92  
93      public void visitFieldExpression(FieldExpression expression) {
94          assertValidIdentifier(expression.getFieldName(), "field name", expression);
95          super.visitFieldExpression(expression);
96      }
97  
98      public void visitVariableExpression(VariableExpression expression) {
99          assertValidIdentifier(expression.getName(), "variable name", expression);
100         super.visitVariableExpression(expression);
101     }
102 
103     public void visitBinaryExpression(BinaryExpression expression) {
104         /*
105         if (verifier.getClassNode().isScript() && expression.getOperation().getType() == Token.EQUAL) {
106             // lets turn variable assignments into property assignments
107             Expression left = expression.getLeftExpression();
108             if (left instanceof VariableExpression) {
109                 VariableExpression varExp = (VariableExpression) left;
110 
111                 //System.out.println("Converting variable expression: " + varExp.getVariable());
112 
113                 PropertyExpression propExp =
114                     new PropertyExpression(VariableExpression.THIS_EXPRESSION, varExp.getVariable());
115                 expression.setLeftExpression(propExp);
116             }
117         }
118         */
119         super.visitBinaryExpression(expression);
120     }
121 
122     public static void assertValidIdentifier(String name, String message, ASTNode node) {
123         int size = name.length();
124         if (size <= 0) {
125             throw new RuntimeParserException("Invalid " + message + ". Identifier must not be empty", node);
126         }
127         char firstCh = name.charAt(0);
128         if (!Character.isJavaIdentifierStart(firstCh) || firstCh == '$') {
129             throw new RuntimeParserException("Invalid " + message + ". Must start with a letter but was: " + name, node);
130         }
131 
132         for (int i = 1; i < size; i++) {
133             char ch = name.charAt(i);
134             if (!Character.isJavaIdentifierPart(ch)) {
135                 throw new RuntimeParserException("Invalid " + message + ". Invalid character at position: " + (i + 1) + " of value:  " + ch + " in name: " + name, node);
136             }
137         }
138     }
139     
140     public void visitListExpression(ListExpression expression) {
141         List expressions = expression.getExpressions();
142         for (Iterator iter = expressions.iterator(); iter.hasNext();) {
143             Object element = iter.next();
144             if (element instanceof MapEntryExpression) {
145                 throw new RuntimeParserException ("no map entry allowed at this place",(Expression) element);
146             }
147         }
148         super.visitListExpression(expression);
149     }
150 }