Ticket #108: modifier-sections.patch

Source/CobraParser.cobra

@@ -100 +100 @@
     var _lowercaseLetters = 'abcdefghijklmnopqrstuvwxyz'
     var _uppercaseLetters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
-    var _isNamesStack as Stack<of String>?
+    var _modifierNamesStack as Stack<of String>?
         """ Stack for recording modifier for items in modifier sections (e.g.shared). """
 
     var _boxStack as Stack<of Box>?
@@ -231 +231 @@
         tokVerbosity = _verbosity - 4  # in order words, tokenizer does not spew unless our verbosity is 5 or greater
         if tokVerbosity < 0, tokVerbosity = 0
 
-        _isNamesStack = Stack<of String>()  # for `shared` for example
+        _modifierNamesStack = Stack<of String>()  # for `shared` for example
         _leftStack = Stack<of Expr>()
         _opStackStack = Stack<of Stack<of String>>()
         .newOpStack
@@ -697 +697 @@
                 .throwError('Cannot nest a type underneath a [parentBox.englishName]')  # TODO: needs a test case
 
         _boxStack.push(theClass)
-#       .isNamesStack = Stack<of String>()
+#       .modifierNamesStack = Stack<of String>()
         .bodiedBoxMemberDecls(theClass)
         _boxStack.pop
 
@@ -780 +780 @@
 
     def _isDeclNamesNoEOL(hasIsNames as out bool) as List<of String>
         """ Parse for possible stream of isNames without terminating EOL. """
-        names = List<of String>(_isNamesStack)
+        names = List<of String>(_modifierNamesStack)
         hasIsNames = false
         if .optional('IS') is nil
             return names
         hasIsNames = true
+        return _commaSepDeclNames(names)
+
+    def _commaSepDeclNames(names as List<of String>) as List<of String>
+        """
+        Grab one or a comma separated sequence of declNames/isNames.
+        Verify that the modifier names are valid and internally consistant
+        Returns
+            A string list of the modifierNames/isNames
+        """
         while true
             what = .grab.text
             if what in .validIsNames
@@ -801 +810 @@
                 if .peek.text in .validIsNames
                     .throwError(.peek, 'Multiple access modifiers should be separated by commas such as "[what], [.peek.text]".')
                 break
-        # TODO: error on virtual and shared
+        # error on virtual and shared
+        if 'virtual' in names and 'shared' in names
+            .recordError(.last, 'Cannot specify both "virtual" and "shared".')
         # to-do: move these to _bindInt
         # error on non virtual and override
         if 'nonvirtual' in names and 'override' in names
             .recordError(.last, 'Cannot specify both "nonvirtual" and "override".')
-        # to-do: cannot specify 'new' and 'override'
+        # Cannot specify 'new' and 'override'
+        if 'new' in names and 'override' in names
+            .recordError(.last, 'Cannot specify both "new" and "override".')
         # error if 2 or more of 'public', 'protected', 'private', 'internal'
         accessModifierCount = 0
         for vam in _validAccessModifiers
@@ -819 +832 @@
     var _validAccessModifiers = ['public', 'protected', 'private', 'internal']
 
     get validIsNames as List<of String>
+        """
+        All the valid isNames/DeclNames or modifiers.
+        Some of these are specific to clauses - i.e partial on Types/Class..., readonly on vars
+        """
         if _validIsNames is nil
             _validIsNames = [
                 'fake', 'extern', 'shared', 'virtual', 'nonvirtual', 'override', 'new',
@@ -897 +914 @@
 
         # TODO when supporting nested classes, look at the _boxStack and set a back pointer here
         _boxStack.push(theMixin)
-#       .isNamesStack = Stack<of String>()
+#       .modifierNamesStack = Stack<of String>()
         .bodiedBoxMemberDecls(theMixin)
         _boxStack.pop
 
@@ -936 +953 @@
         theInterface = Interface(wordToken, idToken, name, .makeList<of IType>(genericParams), typeSpecs.isNames, typeSpecs.attributes, typeSpecs.inheritsProxies, docString)
 
         _boxStack.push(theInterface)
-#       .isNamesStack = Stack<of String>()
+#       .modifierNamesStack = Stack<of String>()
         .bodiedBoxMemberDecls(theInterface)  # TODO: this shouldn't be bodiedBoxMemberDecls, right?
         _boxStack.pop
 
@@ -974 +991 @@
                 .throwError('Cannot nest a type underneath a [parentBox.englishName]')  # TODO: needs a test case
 
         _boxStack.push(theStruct)
-#       .isNamesStack = Stack<of String>()
+#       .modifierNamesStack = Stack<of String>()
         .bodiedBoxMemberDecls(theStruct)
         _boxStack.pop
 
@@ -988 +1005 @@
         handlerType = .typeId
         # ahem, duplicated from .boxVarDecl
         docString = '' to ?
-        isNames = List<of String>(_isNamesStack)
+        isNames = List<of String>(_modifierNamesStack)
         if .peek.which=='IS'
             isNames = .isDeclNames
             attribs = .hasAttribs
@@ -1219 +1236 @@
             breakLoop = false  # cannot use 'break' to stop a 'while' loop in a branch statement. CC?
             while not breakLoop
                 _isTraceOn = true
-                branch .peek.which
+                nextWhich = .peek.which 
+                if .peek.text in .validIsNames # shared, protected, etc - lower case not tokenNames
+                    .bodiedBoxMemberDeclNames(box)
+                    continue
+                branch nextWhich
                     on 'PASS'
                         .classPass
                         breakLoop = true
@@ -1232 +1253 @@
                     on 'VAR', .addDecl(box, .boxFieldDecl(true))
                     on 'CONST', .addDecl(box, .boxFieldDecl(false))
                     on 'INVARIANT', .declareInvariant
-                    on 'EOL', .endOfLine
+                    on 'EOL',  .endOfLine
                     on 'ENUM', .addDecl(box, .enumDecl)
-                    on 'EVENT', .addDecl(box, .eventDecl)
-                    on 'SIG', .addDecl(box, .declareMethodSig)
-                    on 'SHARED', .bodiedBoxMemberDeclsShared(box)
-                    on 'TEST', .testSection(box)
+                    on 'EVENT',.addDecl(box, .eventDecl)
+                    on 'SIG',  .addDecl(box, .declareMethodSig)
+                    on 'TEST',   .testSection(box)
                     on 'CLASS',  .addDecl(box, .classDecl)  # nested types
                     on 'STRUCT', .addDecl(box, .structDecl) # nested types
                     else
-                        branch .peek.text
+                        branch .peek.text 
                             on 'ensure', sugg = 'invariant'
                             on 'void', sugg = 'def'
                             else, sugg = ''
-                        if sugg <> ''
-                            sugg = ' Instead of "[.peek.text]", try "[sugg]".'
+                        if sugg <> '', sugg = ' Instead of "[.peek.text]", try "[sugg]".'
                         .throwError('Got [.peek] when expecting class, def, enum, get, invariant, pro, set, shared, sig, struct, test or var.[sugg]')
             .dedent
 
@@ -1258 +1277 @@
                 # TODO: Give another error with the line number of the other definition (and then change message above)
             box.addDecl(member)
 
-    def bodiedBoxMemberDeclsShared(box as Box)
-        .expect('SHARED')
+    def bodiedBoxMemberDeclNames(box as Box)
+        """ Section for block of common decl/modifier isnames."""
+        declModifierNames = _commaSepDeclNames(List<of String>())
+        if 'fake' in declModifierNames or 'partial' in declModifierNames
+            .recordError(.last, 'Cannot have "fake" or "partial" in a modifier block.')
+
+        for modName in declModifierNames
+            _modifierNamesStack.push(modName)
         .indent
-        _isNamesStack.push('shared')
         try
             .bodiedBoxMemberDecls(box)
         finally
-            _isNamesStack.pop
-
+            for modName in declModifierNames
+                _modifierNamesStack.pop
+                
     def classPass
         if .curBox.declsInOrder.count
             _warning('Encountered "pass" in a class that already has declared members.')  # TODO: change to an error
@@ -1299 +1324 @@
             if type is nil
                 type = .typeProvider.defaultType
         docString = '' to ?
-        isNames = List<of String>(_isNamesStack)
+        isNames = List<of String>(_modifierNamesStack)
         if .peek.which=='IS'
             isNames = .isDeclNames
             attribs = .hasAttribs
@@ -1370 +1395 @@
         params = _methodParams(opener)
         returnType = _methodReturnType
 
-        isNames = List<of String>(_isNamesStack)
+        isNames = List<of String>(_modifierNamesStack)
         attribs = AttributeList()
         implementsType = nil to ITypeProxy?
 
@@ -1551 +1576 @@
         if not .optional('INDENT')
             # with no indent there can be no additional specs like attributes, contracts or body
             if not hasIsNames
-                isNames = List<of String>(_isNamesStack)
+                isNames = List<of String>(_modifierNamesStack)
             attribs = AttributeList()
             docString = '' to ?
         else
@@ -1625 +1650 @@
             if not isAbstract and curBox.canHaveStatements
                 .throwError('Missing body for property.')
             if not hasIsNames
-                isNames = List<of String>(_isNamesStack)
+                isNames = List<of String>(_modifierNamesStack)
             attribs = AttributeList()
             docString = ''
         if params.count
@@ -1693 +1718 @@
             docString = .docString
             .dedent
         else
-            if not hasIsNames, isNames = List<of String>(_isNamesStack)
+            if not hasIsNames, isNames = List<of String>(_modifierNamesStack)
             attribs = AttributeList()
             docString = ''
         varDef = _genVarDef(declVarType, token, name, varName, initExpr)
@@ -1706 +1731 @@
         possibleVarDef = .curBox.declForName(varName)
         if not possibleVarDef
             if initExpr or declVarType
-                varDef = BoxVar(token, token, .curBox, varName, declVarType, List<of String>(_isNamesStack), initExpr, nil, 'Automatic backing var for property "[name]".')
+                varDef = BoxVar(token, token, .curBox, varName, declVarType, List<of String>(_modifierNamesStack), initExpr, nil, 'Automatic backing var for property "[name]".')
                 .curBox.addDecl(varDef)
                 return varDef
             if not varName.startsWith('_') or varName.startsWith('__')
@@ -1782 +1807 @@
             if not isAbstract and curBox.canHaveStatements
                 .throwError('Missing body for property.')
             if not hasIsNames
-                isNames = List<of String>(_isNamesStack)
+                isNames = List<of String>(_modifierNamesStack)
             attribs = AttributeList()
             docString = ''
         if params.count

Tests/120-classes/450-isnames/502-bad-combo-new-override.cobra

@@ +1 @@
+class Test
+    def xyzzy is new, override #.error. Cannot specify both
+        pass
+        
+    def xyzzy is override, new #.error. Cannot specify both
+        pass
+        
+    def main is shared
+        Test().xyzzy    

Tests/120-classes/450-isnames/100-isnames.cobra

@@ +1 @@
+class Base
+    def foo is shared
+        pass
+
+    def bar is shared
+        .foo
+            
+class Derived inherits Base
+    def main is shared
+        .bar
+        .foo

Tests/120-classes/450-isnames/500-bad-combo-shared-virtual.cobra

@@ +1 @@
+class Test
+    def xyzzy is virtual, shared #.error. Cannot specify both
+        pass
+    
+    def xyzzy is shared, virtual #.error. Cannot specify both
+        pass
+        
+    def main is shared
+        Test().xyzzy    

Tests/120-classes/450-isnames/200-modifier-section.cobra

@@ +1 @@
+class Base
+    shared
+        def foo
+            pass
+
+        def bar
+            .foo
+            
+class Derived inherits Base
+    def main is shared
+        .bar
+        .foo

Tests/120-classes/450-isnames/202-modifier-section.cobra

@@ +1 @@
+class Base
+    private
+        def foo
+            pass
+
+    shared
+        def bar
+            .foo #.error. cannot access instance member "foo"
+            
+class Derived inherits Base
+    def main is shared
+        .bar
+        .foo  # .error. Cannot access private "foo"
+

Tests/120-classes/450-isnames/204-modifier-section.cobra

@@ +1 @@
+class Base
+    private, shared
+        def foo
+            pass
+
+    shared
+        def bar
+            .foo
+            
+class Derived inherits Base
+    def main is shared
+        .bar
+        .foo  # .error. Cannot access private "foo"
+

Tests/120-classes/450-isnames/206-modifier-section.cobra

@@ +1 @@
+class Base is abstract
+    private, shared
+        def foo
+            pass
+
+    shared
+        def bar
+            .foo
+        
+    abstract, protected
+        def brazil
+
+class Derived inherits Base
+    
+    def brazil is override, protected
+        pass
+
+    def main is shared
+        .bar
+        
+        d = Derived()
+        d.brazil

Tests/120-classes/450-isnames/504-bad-combo-access-modifiers.cobra

@@ +1 @@
+class Test
+    def xyzzy is private, protected #.error. Can only specify one of
+        pass
+    
+    def xyzzy1 is private, public #.error. Can only specify one of
+        pass
+    
+    def xyzzy2 is protected, public #.error. Can only specify one of
+        pass
+        
+    def xyzzy3 is protected, private #.error. Can only specify one of
+        pass
+        
+    def xyzzy4 is public, internal #.error. Can only specify one of
+        pass
+        
+    def xyzzy5 is private, internal #.error. Can only specify one of
+        pass
+        
+    def xyzzy6 is protected, internal #.error. Can only specify one of
+        pass
+        
+    def xyzzyAll is internal, protected, private #.error. Can only specify one of
+        pass
+    def xyzzyAll is private, protected, public, internal #.error. Can only specify one of
+        pass
+        
+        
+    def main is shared
+        Test().xyzzy