View Javadoc

1   /*
2    $Id: VerifierCodeVisitor.java,v 1.15 2005/09/12 19:51:24 blackdrag Exp $
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 org.codehaus.groovy.ast.ASTNode;
49  import org.codehaus.groovy.ast.CodeVisitorSupport;
50  import org.codehaus.groovy.ast.stmt.ForStatement;
51  import org.codehaus.groovy.ast.expr.BinaryExpression;
52  import org.codehaus.groovy.ast.expr.MethodCallExpression;
53  import org.codehaus.groovy.ast.expr.PropertyExpression;
54  import org.codehaus.groovy.ast.expr.FieldExpression;
55  import org.codehaus.groovy.ast.expr.VariableExpression;
56  import org.codehaus.groovy.syntax.RuntimeParserException;
57  import org.objectweb.asm.Opcodes;
58  
59  /***
60   * Verifies the method code
61   * 
62   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
63   * @version $Revision: 1.15 $
64   */
65  public class VerifierCodeVisitor extends CodeVisitorSupport implements Opcodes {
66  
67      private Verifier verifier;
68  
69      VerifierCodeVisitor(Verifier verifier) {
70          this.verifier = verifier;
71      }
72  
73      public void visitMethodCallExpression(MethodCallExpression call) {
74          super.visitMethodCallExpression(call);
75      }
76  
77      public void visitForLoop(ForStatement expression) {
78          assertValidIdentifier(expression.getVariable(), "for loop variable name", expression);
79          super.visitForLoop(expression);
80      }
81  
82      public void visitPropertyExpression(PropertyExpression expression) {
83          // assertValidIdentifier(expression.getProperty(), "property name", expression);  // This has been commented out to fix the issue Groovy-843
84          super.visitPropertyExpression(expression);
85      }
86  
87      public void visitFieldExpression(FieldExpression expression) {
88          assertValidIdentifier(expression.getFieldName(), "field name", expression);
89          super.visitFieldExpression(expression);
90      }
91  
92      public void visitVariableExpression(VariableExpression expression) {
93          assertValidIdentifier(expression.getName(), "variable name", expression);
94          super.visitVariableExpression(expression);
95      }
96  
97      public void visitBinaryExpression(BinaryExpression expression) {
98          /*
99          if (verifier.getClassNode().isScript() && expression.getOperation().getType() == Token.EQUAL) {
100             // lets turn variable assignments into property assignments
101             Expression left = expression.getLeftExpression();
102             if (left instanceof VariableExpression) {
103                 VariableExpression varExp = (VariableExpression) left;
104 
105                 //System.out.println("Converting variable expression: " + varExp.getVariable());
106 
107                 PropertyExpression propExp =
108                     new PropertyExpression(VariableExpression.THIS_EXPRESSION, varExp.getVariable());
109                 expression.setLeftExpression(propExp);
110             }
111         }
112         */
113         super.visitBinaryExpression(expression);
114     }
115 
116     public static void assertValidIdentifier(String name, String message, ASTNode node) {
117         int size = name.length();
118         if (size <= 0) {
119             throw new RuntimeParserException("Invalid " + message + ". Identifier must not be empty", node);
120         }
121         char firstCh = name.charAt(0);
122         if (!Character.isJavaIdentifierStart(firstCh) || firstCh == '$') {
123             throw new RuntimeParserException("Invalid " + message + ". Must start with a letter but was: " + name, node);
124         }
125 
126         for (int i = 1; i < size; i++) {
127             char ch = name.charAt(i);
128             if (!Character.isJavaIdentifierPart(ch)) {
129                 throw new RuntimeParserException("Invalid " + message + ". Invalid character at position: " + (i + 1) + " of value:  " + ch + " in name: " + name, node);
130             }
131         }
132     }
133 }