001    /*
002     $Id: VerifierCodeVisitor.java,v 1.13 2005/05/27 10:13:09 russel Exp $
003    
004     Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
005    
006     Redistribution and use of this software and associated documentation
007     ("Software"), with or without modification, are permitted provided
008     that the following conditions are met:
009    
010     1. Redistributions of source code must retain copyright
011        statements and notices.  Redistributions must also contain a
012        copy of this document.
013    
014     2. Redistributions in binary form must reproduce the
015        above copyright notice, this list of conditions and the
016        following disclaimer in the documentation and/or other
017        materials provided with the distribution.
018    
019     3. The name "groovy" must not be used to endorse or promote
020        products derived from this Software without prior written
021        permission of The Codehaus.  For written permission,
022        please contact info@codehaus.org.
023    
024     4. Products derived from this Software may not be called "groovy"
025        nor may "groovy" appear in their names without prior written
026        permission of The Codehaus. "groovy" is a registered
027        trademark of The Codehaus.
028    
029     5. Due credit should be given to The Codehaus -
030        http://groovy.codehaus.org/
031    
032     THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
033     ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
034     NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
035     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
036     THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
037     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
038     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
039     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
040     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
041     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
042     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
043     OF THE POSSIBILITY OF SUCH DAMAGE.
044    
045     */
046    package org.codehaus.groovy.classgen;
047    
048    import org.codehaus.groovy.ast.ASTNode;
049    import org.codehaus.groovy.ast.CodeVisitorSupport;
050    import org.codehaus.groovy.ast.stmt.ForStatement;
051    import org.codehaus.groovy.ast.expr.BinaryExpression;
052    import org.codehaus.groovy.ast.expr.MethodCallExpression;
053    import org.codehaus.groovy.ast.expr.PropertyExpression;
054    import org.codehaus.groovy.ast.expr.FieldExpression;
055    import org.codehaus.groovy.ast.expr.VariableExpression;
056    import org.codehaus.groovy.syntax.RuntimeParserException;
057    import org.objectweb.asm.Opcodes;
058    
059    /**
060     * Verifies the method code
061     * 
062     * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
063     * @version $Revision: 1.13 $
064     */
065    public class VerifierCodeVisitor extends CodeVisitorSupport implements Opcodes {
066    
067        private Verifier verifier;
068    
069        VerifierCodeVisitor(Verifier verifier) {
070            this.verifier = verifier;
071        }
072    
073        public void visitMethodCallExpression(MethodCallExpression call) {
074            assertValidIdentifier(call.getMethod(), "method name", call);
075            super.visitMethodCallExpression(call);
076        }
077    
078        public void visitForLoop(ForStatement expression) {
079            assertValidIdentifier(expression.getVariable(), "for loop variable name", expression);
080            super.visitForLoop(expression);
081        }
082    
083        public void visitPropertyExpression(PropertyExpression expression) {
084            // assertValidIdentifier(expression.getProperty(), "property name", expression);  // This has been commented out to fix the issue Groovy-843
085            super.visitPropertyExpression(expression);
086        }
087    
088        public void visitFieldExpression(FieldExpression expression) {
089            assertValidIdentifier(expression.getFieldName(), "field name", expression);
090            super.visitFieldExpression(expression);
091        }
092    
093        public void visitVariableExpression(VariableExpression expression) {
094            assertValidIdentifier(expression.getVariable(), "variable name", expression);
095            super.visitVariableExpression(expression);
096        }
097    
098        public void visitBinaryExpression(BinaryExpression expression) {
099            /*
100            if (verifier.getClassNode().isScript() && expression.getOperation().getType() == Token.EQUAL) {
101                // lets turn variable assignments into property assignments
102                Expression left = expression.getLeftExpression();
103                if (left instanceof VariableExpression) {
104                    VariableExpression varExp = (VariableExpression) left;
105    
106                    //System.out.println("Converting variable expression: " + varExp.getVariable());
107    
108                    PropertyExpression propExp =
109                        new PropertyExpression(VariableExpression.THIS_EXPRESSION, varExp.getVariable());
110                    expression.setLeftExpression(propExp);
111                }
112            }
113            */
114            super.visitBinaryExpression(expression);
115        }
116    
117        public static void assertValidIdentifier(String name, String message, ASTNode node) {
118            int size = name.length();
119            if (size <= 0) {
120                throw new RuntimeParserException("Invalid " + message + ". Identifier must not be empty", node);
121            }
122            char firstCh = name.charAt(0);
123            if (!Character.isJavaIdentifierStart(firstCh) || firstCh == '$') {
124                throw new RuntimeParserException("Invalid " + message + ". Must start with a letter but was: " + name, node);
125            }
126    
127            for (int i = 1; i < size; i++) {
128                char ch = name.charAt(i);
129                if (!Character.isJavaIdentifierPart(ch)) {
130                    throw new RuntimeParserException("Invalid " + message + ". Invalid character at position: " + (i + 1) + " of value:  " + ch + " in name: " + name, node);
131                }
132            }
133        }
134    }