parser fixes, var resolving fixes

wallaby.pouch · wallaby.pouch · commit 9bfd27a1c052 · 2010-07-28T17:36:29.000Z
git-svn-id: http://bashsupport.googlecode.com/svn/trunk@111 91dd7c56-102c-11df-9f54-17e475596acb
diff --git a/bashsupport/BashSupport.iml b/bashsupport/BashSupport.iml
@@ -30,7 +30,6 @@
         <SOURCES />
       </library>
     </orderEntry>
-    <orderEntry type="library" name="GroupLayout" level="project" />
   </component>
 </module>
 
diff --git a/bashsupport/BashSupport.ipr b/bashsupport/BashSupport.ipr
@@ -724,7 +724,7 @@
       <module fileurl="file://$PROJECT_DIR$/../PluginErrorReporting/PluginErrorReporting.iml" filepath="$PROJECT_DIR$/../PluginErrorReporting/PluginErrorReporting.iml" />
     </modules>
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_5" assert-keyword="true" jdk-15="true" project-jdk-name="IDEA IU-95.311" project-jdk-type="IDEA JDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_5" assert-keyword="true" jdk-15="true" project-jdk-name="IDEA IU-95.429" project-jdk-type="IDEA JDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
   <component name="ResourceManagerContainer">
diff --git a/bashsupport/BashSupport.iws b/bashsupport/BashSupport.iws
diff --git a/bashsupport/Changelog.txt b/bashsupport/Changelog.txt
@@ -1,3 +1,8 @@
+2010-07-28:
+ - Fixed parsing of single $ characters, e.g. "$a$"
+ - Improved parsing of for loops
+ - Fixed resolving of global variables
+
 2010-07-23:
  - Fixed exception which occured while adding a REPL console
  
diff --git a/bashsupport/TODO.txt b/bashsupport/TODO.txt
@@ -125,7 +125,7 @@ Bugs (indentation marks fixed bugs):
 - Support tilde expansion
 - Support for Ctrl+J
 - export a[1]=1 is invalid, "declare a[1]=2" is valid though
-- no variable auto completion in here docs
+    - no variable auto completion in here docs
 - Bash v4: Inspection in v3 mode to warn about the ambiguous redirect &| if run on v4
 - Bash v4: declare keyword changes
 - Bash v4: read keyword changes
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/lexer/_BashLexer.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/lexer/_BashLexer.java
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/ParameterExpansionParsing.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/ParameterExpansionParsing.java
@@ -41,10 +41,6 @@ public boolean isValid(BashPsiBuilder builder) {
         return builder.getTokenType() == LEFT_CURLY;
     }
 
-    private boolean isValid(IElementType token) {
-        throw new IllegalStateException("Can't check with single element");
-    }
-
     public boolean parse(BashPsiBuilder builder) {
         PsiBuilder.Marker marker = builder.mark();
 
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/misc/WordParsing.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/misc/WordParsing.java
@@ -23,9 +23,11 @@
 import com.ansorgit.plugins.bash.lang.parser.Parsing;
 import com.ansorgit.plugins.bash.lang.parser.ParsingTool;
 import com.ansorgit.plugins.bash.lang.parser.util.ParserUtil;
+import com.ansorgit.plugins.bash.lang.psi.util.BashPsiUtils;
 import com.intellij.lang.PsiBuilder;
 import com.intellij.psi.tree.IElementType;
 import com.intellij.psi.tree.TokenSet;
+import com.intellij.util.ArrayUtil;
 
 /**
  * Parsing of tokens which can be understood as word tokens, e.g. WORD, variables, subshell commands, etc.
@@ -36,6 +38,8 @@
  * @author Joachim Ansorg
  */
 public class WordParsing implements ParsingTool {
+    private static final TokenSet singleDollarFollowups = TokenSet.create(STRING_END, WHITESPACE, LINE_FEED);
+
     /**
      * Checks whether the next tokens might belong to a word token.
      * The upcoming tokens are not remapped.
@@ -49,14 +53,31 @@ public boolean isWordToken(final BashPsiBuilder builder) {
 
     public boolean isWordToken(final BashPsiBuilder builder, final boolean enableRemapping) {
         final IElementType tokenType = builder.getTokenType(false, enableRemapping);
-        return isComposedString(tokenType)
+        boolean isWord = isComposedString(tokenType)
                 || Parsing.braceExpansionParsing.isValid(builder)
                 || BashTokenTypes.stringLiterals.contains(tokenType)
                 || Parsing.var.isValid(builder)
                 || Parsing.shellCommand.backtickParser.isValid(builder)
                 || Parsing.shellCommand.conditionalParser.isValid(builder)
                 || Parsing.processSubstitutionParsing.isValid(builder)
                 || tokenType == LEFT_CURLY;
+
+        if (isWord) {
+            return true;
+        }
+
+        if (tokenType == DOLLAR) {
+            PsiBuilder.Marker marker = builder.mark();
+            try {
+                builder.advanceLexer();
+                IElementType next = builder.getTokenType();
+                return singleDollarFollowups.contains(next);
+            } finally {
+                marker.rollbackTo();
+            }
+        }
+
+        return false;
     }
 
     public static boolean isComposedString(IElementType tokenType) {
@@ -126,6 +147,9 @@ public boolean parseWord(BashPsiBuilder builder, boolean enableRemapping, TokenS
                 //parsing token stream which is not a expansion but has curly brackets
                 builder.advanceLexer();
                 processedTokens++;
+            } else if (nextToken == DOLLAR) {
+                builder.advanceLexer();
+                processedTokens++;
             } else { //either whitespace or unknown token
                 break;
             }
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/shellCommand/BacktickParsingFunction.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/shellCommand/BacktickParsingFunction.java
@@ -43,10 +43,6 @@ public boolean isValid(BashPsiBuilder builder) {
         return !builder.getBackquoteData().isInBackquote() && builder.getTokenType() == BashTokenTypes.BACKQUOTE;
     }
 
-    private boolean isValid(IElementType token) {
-        throw new IllegalStateException("isValid(token) not supported");
-    }
-
     public boolean parse(BashPsiBuilder builder) {
         /*
           backquote: '`' compound_list '`'
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/shellCommand/ForLoopParsingFunction.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/parser/shellCommand/ForLoopParsingFunction.java
@@ -81,19 +81,24 @@ private boolean parseForLoop(BashPsiBuilder builder) {
             //mark the word as var
             ParserUtil.markTokenAndAdvance(builder, VAR_DEF_ELEMENT);
         } else {
-            ParserUtil.error(forLoop, "parser.shell.for.expectedWord");
+            forLoop.drop();
+            ParserUtil.error(builder, "parser.shell.for.expectedWord");
             return false;
         }
 
         builder.eatOptionalNewlines();
 
         //now either do, a block {} or IN
-        final IElementType afterLoopValue = ParserUtil.getTokenAndAdvance(builder);
-        if (afterLoopValue == ShellCommandParsing.DO_KEYWORD || afterLoopValue == ShellCommandParsing.LEFT_CURLY || afterLoopValue == ShellCommandParsing.SEMI) {
-            if (afterLoopValue == ShellCommandParsing.SEMI) {
-                builder.eatOptionalNewlines();
-            }
-        } else if (afterLoopValue == ShellCommandParsing.IN_KEYWORD) {
+        final IElementType afterLoopValue = builder.getTokenType();
+        if (afterLoopValue == SEMI) {
+            builder.advanceLexer();
+            builder.eatOptionalNewlines();
+        }
+        /*else if (afterLoopValue == ShellCommandParsing.DO_KEYWORD || afterLoopValue == ShellCommandParsing.LEFT_CURLY) {
+            
+        }*/ else if (afterLoopValue == ShellCommandParsing.IN_KEYWORD) {
+            builder.advanceLexer();
+            
             //already after "in"
 
             //parse the optional word list
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/impl/vars/BashVarDefImpl.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/impl/vars/BashVarDefImpl.java
@@ -36,6 +36,8 @@
 import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.*;
 import com.intellij.psi.scope.PsiScopeProcessor;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.search.SearchScope;
 import com.intellij.psi.tree.TokenSet;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.IncorrectOperationException;
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/impl/vars/BashVarUtils.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/impl/vars/BashVarUtils.java
@@ -18,8 +18,10 @@
 
 package com.ansorgit.plugins.bash.lang.psi.impl.vars;
 
+import com.ansorgit.plugins.bash.lang.psi.api.function.BashFunctionDef;
 import com.ansorgit.plugins.bash.lang.psi.api.vars.BashVar;
 import com.ansorgit.plugins.bash.lang.psi.api.vars.BashVarDef;
+import com.ansorgit.plugins.bash.lang.psi.util.BashPsiUtils;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.util.PsiTreeUtil;
 
@@ -52,6 +54,19 @@ public static boolean isInDefinedScope(PsiElement childCandidate, BashVarDef var
             if (childCandidateDef != null && childCandidateDef.isFunctionScopeLocal()) {
                 return isInDefinedScope(childCandidateDef, variableDefinition);
             }
+
+            //variableDefinition may be otherwise valid but may be defined after the variable, i.e. it's invalid
+            if (variableDefinition.getTextOffset() > var.getTextOffset()) {
+                //it's an invalid reference if both variables are global and the definition is after
+                //the variable usage
+                
+                BashFunctionDef varScope = BashPsiUtils.findBroadestVarDefFunctionDefScope(var);
+                BashFunctionDef varDefScope = BashPsiUtils.findBroadestVarDefFunctionDefScope(variableDefinition);
+
+                if (varScope == null && varDefScope == null) {
+                    return false;
+                }
+            }
         }
 
         //none is a local variable
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/util/BashIdentifierUtil.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/util/BashIdentifierUtil.java
@@ -21,15 +21,15 @@
 import org.apache.commons.lang.StringUtils;
 
 /**
- * Created by IntelliJ IDEA.
  * User: jansorg
  * Date: Feb 8, 2010
  * Time: 9:55:14 PM
- * To change this template use File | Settings | File Templates.
  */
 public class BashIdentifierUtil {
     public static boolean isValidIdentifier(String name) {
         return StringUtils.stripToNull(name) != null && !name.contains(" ");
+    }
 
+    private BashIdentifierUtil() {
     }
 }
diff --git a/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/util/BashPsiUtils.java b/bashsupport/src/com/ansorgit/plugins/bash/lang/psi/util/BashPsiUtils.java
@@ -41,24 +41,6 @@
  * Time: 21:45:47
  */
 public class BashPsiUtils {
-    /**
-     * Returns the depth in the tree this element has.
-     *
-     * @param element The element to lookup
-     * @return The depth, 0 if it's at the top level
-     */
-    public static int nestingLevel(PsiElement element) {
-        int depth = 0;
-
-        PsiElement current = element.getContext();
-        while (current != null) {
-            depth++;
-            current = current.getContext();
-        }
-
-        return depth;
-    }
-
     /**
      * Returns the depth in blocks this element has in the tree.
      *
@@ -77,30 +59,6 @@ public static int blockNestingLevel(PsiElement element) {
         return depth;
     }
 
-    /**
-     * Returns the element after the given element. It may either be the next sibling or the
-     * next logical element after the given element (i.e. the element after the parent context).
-     * If it's the last element of the file null is retunred.
-     *
-     * @param element The element to check
-     * @return Next element or null
-     */
-    @Nullable
-    public static PsiElement elementAfter(PsiElement element) {
-        ASTNode node = element.getNode();
-        ASTNode next = node != null ? node.getTreeNext() : null;
-        return next != null ? next.getPsi() : null;
-        /*if (element == null) return null;
-
-        PsiElement next = element.getNextSibling();
-        if (next != null) {
-            return next;
-        }
-
-        //check parent
-        return elementAfter(element.getContext());*/
-    }
-
     /**
      * Returns the broadest scope of the variable definition.
      *
@@ -170,16 +128,22 @@ private static boolean isValidContainer(PsiElement element) {
     public static boolean processChildDeclarations(PsiElement parentContainer, PsiScopeProcessor processor, ResolveState resolveState, PsiElement lastParent, PsiElement place) {
         boolean hasResult = false;
 
+        if (parentContainer.equals(lastParent)) {
+            return true;
+        }
+
         if (!processor.execute(parentContainer, resolveState)) {
             return false;
         }
 
+        PsiElement lastChild = parentContainer;
         PsiElement child = parentContainer.getFirstChild();
         while (child != null) {
             if (!child.equals(lastParent)) {
-                hasResult |= !child.processDeclarations(processor, resolveState, lastParent, place);
+                hasResult |= !child.processDeclarations(processor, resolveState, lastChild, place);
             }
 
+            lastChild = child;
             child = child.getNextSibling();
         }
 
@@ -204,29 +168,9 @@ public static int getElementEndLineNumber(PsiElement element) {
         return 0;
     }
 
-    @Nullable
-    public static BashPsiElement getCoveringRPsiElement(@NotNull final PsiElement psiElement) {
-        PsiElement current = psiElement;
-        while (current != null) {
-            if (current instanceof BashPsiElement) {
-                return (BashPsiElement) current;
-            }
-            current = current.getParent();
-        }
-        return null;
-    }
-
-    public static TextRange createRange(PsiElement node) {
-        return TextRange.from(node.getTextOffset(), node.getTextLength());
-    }
-
     public static IElementType nodeType(PsiElement element) {
         ASTNode node = element.getNode();
-        if (node == null) {
-            return null;
-        }
-
-        return node.getElementType();
+        return node == null ? null : node.getElementType();
     }
 
     public static PsiElement findNextSibling(PsiElement start, IElementType ignoreType) {
diff --git a/bashsupport/test/com/ansorgit/plugins/bash/lang/lexer/BashLexerTest.java b/bashsupport/test/com/ansorgit/plugins/bash/lang/lexer/BashLexerTest.java
@@ -45,6 +45,9 @@ public void testSimpleDefTokenization() {
     public void testVariables() {
         testTokenization("$abc", VARIABLE);
 
+        testTokenization("$a$", VARIABLE, DOLLAR);
+        testTokenization("$", DOLLAR);
+
         testTokenization("$(echo)", DOLLAR, LEFT_PAREN, INTERNAL_COMMAND, RIGHT_PAREN);
         testTokenization("${echo}", DOLLAR, LEFT_CURLY, WORD, RIGHT_CURLY);
         testTokenization("${#echo}", DOLLAR, LEFT_CURLY, PARAM_EXPANSION_OP, WORD, RIGHT_CURLY);
@@ -179,6 +182,7 @@ public void testStrings() {
         testTokenization("a b \"a b \\\"\" \"a\" b",
                 WORD, WHITESPACE, WORD, WHITESPACE, STRING_BEGIN, WORD, WORD, STRING_END, WHITESPACE,
                 STRING_BEGIN, WORD, STRING_END, WHITESPACE, WORD);
+        testTokenization("\"a$\"", STRING_BEGIN, WORD, DOLLAR, STRING_END);
 
         testTokenization("\"$(\"hey there\")\"", STRING_BEGIN, DOLLAR, LEFT_PAREN, WORD, RIGHT_PAREN, STRING_END);
         //        testTokenization("\"$(\"hey there\\\"\")\" \\\" \"$(\"hey there\")\" a",
diff --git a/bashsupport/test/com/ansorgit/plugins/bash/lang/parser/IntegrationTest.java b/bashsupport/test/com/ansorgit/plugins/bash/lang/parser/IntegrationTest.java
@@ -392,13 +392,13 @@ public void testAppendAssignment() {
     @Test
     public void testArithmeticForLoopVarError() {
         //for (( a *2 < 4; 3 >= a; a = a*2 )) ; do hey $a; done;
-        //$a is here written as VAR, WORD which is an invalid combination
+        //$a is here written as DOLLAR, WORD which is an invalid combination
         //this has to be detected as an error
         mockTestError(fileParsingTest,
                 FOR_KEYWORD, EXPR_ARITH, WORD, ARITH_MULT, NUMBER, ARITH_LT, NUMBER, SEMI,
                 NUMBER, ARITH_GE, WORD, SEMI,
                 WORD, EQ, WORD, ARITH_MULT, NUMBER, _EXPR_ARITH,
-                DO_KEYWORD, WORD, DOLLAR, WORD, SEMI, DONE_KEYWORD, SEMI);
+                DO_KEYWORD, WORD, WHITESPACE, DOLLAR, WORD, SEMI, DONE_KEYWORD, SEMI);
     }
 
     @Test
@@ -629,4 +629,10 @@ public void testProcessSubstitution() {
         //echo <(echo a) $var
         mockTest(fileParsingTest, WORD, LESS_THAN, LEFT_PAREN, WORD, WORD, RIGHT_PAREN, VARIABLE);
     }
+
+    @Test
+    public void testVariableDollar() throws Exception {
+        //$a$
+        mockTest(fileParsingTest, VARIABLE, DOLLAR);
+    }
 }
diff --git a/bashsupport/test/com/ansorgit/plugins/bash/lang/parser/shellCommand/ForLoopParsingFunctionTest.java b/bashsupport/test/com/ansorgit/plugins/bash/lang/parser/shellCommand/ForLoopParsingFunctionTest.java
@@ -57,5 +57,8 @@ public void testForLoopCompoundBlock() {
         // done
         mockTest(forLoop, FOR_KEYWORD, WORD, IN_KEYWORD, INTEGER_LITERAL, SEMI, DO_KEYWORD, LEFT_CURLY, LINE_FEED,
                 WORD, WHITESPACE, WORD, LINE_FEED, RIGHT_CURLY, SEMI, LINE_FEED, DONE_KEYWORD);
+
+        //for A do echo $A; done
+        mockTest(forLoop, FOR_KEYWORD, WORD, DO_KEYWORD, WHITESPACE, WORD, VARIABLE, SEMI, DONE_KEYWORD);
     }
 }
diff --git a/bashsupport/test/com/ansorgit/plugins/bash/lang/psi/resolve/VarResolveTestCase.java b/bashsupport/test/com/ansorgit/plugins/bash/lang/psi/resolve/VarResolveTestCase.java
diff --git a/bashsupport/testData/psi/resolve/var/BasicResolveUnknownGlobalVariable.bash b/bashsupport/testData/psi/resolve/var/BasicResolveUnknownGlobalVariable.bash

Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,6 @@ public boolean isValid(BashPsiBuilder builder) {`
`41`	`41`	`return builder.getTokenType() == LEFT_CURLY;`
`42`	`42`	`}`
`43`	`43`
`44`		`- private boolean isValid(IElementType token) {`
`45`		`- throw new IllegalStateException("Can't check with single element");`
`46`		`- }`
`47`		`-`
`48`	`44`	`public boolean parse(BashPsiBuilder builder) {`
`49`	`45`	`PsiBuilder.Marker marker = builder.mark();`
`50`	`46`