Merge pull request #198 from phatmann/core-parse

Using CoreParse to parse NSS file

.gitignore

@@ -1 +1,2 @@
-.DS_Store
+.DS_Store
+Pods

Demo/Podfile

@@ -0,0 +1,4 @@
+target "NUIDemo" do
+pod 'CoreParse', :git => 'https://github.com/phatmann/CoreParse.git', :branch => 'pod'
+end
+

Demo/Podfile.lock

@@ -0,0 +1,15 @@
+PODS:
+  - CoreParse (1.1)
+
+DEPENDENCIES:
+  - CoreParse (from `https://github.com/phatmann/CoreParse.git`, branch `pod`)
+
+EXTERNAL SOURCES:
+  CoreParse:
+    :branch: pod
+    :git: https://github.com/phatmann/CoreParse.git
+
+SPEC CHECKSUMS:
+  CoreParse: c8da33c94916683f2448e3cbc51ced058aa68c45
+
+COCOAPODS: 0.29.0

NUI.podspec

@@ -13,4 +13,6 @@ Pod::Spec.new do |s|
   s.resources    = "NUI/Resources/*.png", "NUI/**/*.nss"
   s.requires_arc = true
   s.frameworks   = [ "UIKit", "CoreGraphics","QuartzCore", "CoreImage" ]
+
+  s.dependency 'CoreParse'
 end

NUI/Core/NUIStyleParser.m

@@ -6,10 +6,13 @@
 //  Copyright (c) 2012 Tom Benner. All rights reserved.
 //
 
-// N.B.: This would ideally be implemented with something like a lexical analyzer generator, but
-// they all seem to have licenses that wouldn't be suitable for use in the App Store.
-
 #import "NUIStyleParser.h"
+#import "CoreParse.h"
+#import "CPTokeniser.h"
+#import "NUITokeniserDelegate.h"
+#import "NUIParserDelegate.h"
+#import "NUIStyleSheet.h"
+#import "NUIRuleSet.h"
 
 @implementation NUIStyleParser
 
@@ -18,120 +21,111 @@ - (NSMutableDictionary*)getStylesFromFile:(NSString*)fileName
     NSString* path = [[NSBundle mainBundle] pathForResource:fileName ofType:@"nss"];
     NSAssert1(path != nil, @"File \"%@\" does not exist", fileName);
     NSString* content = [NSString stringWithContentsOfFile:path encoding:NSUTF8StringEncoding error:nil];
-    return [self consolidateRuleSets:[self getRuleSets:content] withTopLevelDeclarations:[self getTopLevelDeclarations:content]];
+    NUIStyleSheet *styleSheet = [self parse:content];
+    return [self consolidateRuleSets:styleSheet];
 }
 
 - (NSMutableDictionary*)getStylesFromPath:(NSString*)path
 {
     NSString* content = [NSString stringWithContentsOfFile:path encoding:NSUTF8StringEncoding error:nil];
-    return [self consolidateRuleSets:[self getRuleSets:content] withTopLevelDeclarations:[self getTopLevelDeclarations:content]];
-}
-
-- (NSMutableDictionary*)getTopLevelDeclarations:(NSString*)content
-{
-    NSString *topLevelContent = [self getTopLevelContent:content];
-    return [self getDeclarations:topLevelContent];
-}
-
-- (NSMutableArray*)getRuleSets:(NSString*)content
-{
-    NSString *pattern = @"(\\w[\\w\\s,]+)\\s*\\{([^\\}]+)\\}";
-    NSArray *matches = [self getMatches:content withPattern:pattern];
-
-    NSMutableArray *ruleSets = [[NSMutableArray alloc] init];
-    for (NSTextCheckingResult *match in matches) {
-        NSRange range1 = [match rangeAtIndex:1];
-        NSRange range2 = [match rangeAtIndex:2];
-        NSString *classExpression = [content substringWithRange:range1];
-        NSString *declarationsContent = [content substringWithRange:range2];
-        NSMutableDictionary *declarations = [self getDeclarations:declarationsContent];
-        NSDictionary *ruleSet = [NSDictionary dictionaryWithObjectsAndKeys:
-                                 classExpression, @"classExpression",
-                                 declarations, @"declarations",
-                                 nil];
-        [ruleSets addObject:ruleSet];
-    }
-    return ruleSets;
-}
-
-- (NSString*)getTopLevelContent:(NSString*)content
-{
-    NSString *startOrClose = @"(?:^|\\})";
-    NSString *rules = @"(.*?)";
-    NSString *endOrOpen = @"(?:$|\\w[\\w\\s,]+\\{[^\\}]+)";
-    NSString *pattern = [NSString stringWithFormat:@"%@%@%@", startOrClose, rules, endOrOpen];
-    NSArray *matches = [self getMatches:content withPattern:pattern];
-
-    NSMutableArray *lineGroups = [[NSMutableArray alloc] init];
-    for (NSTextCheckingResult *match in matches) {
-        NSRange range = [match rangeAtIndex:1];
-        [lineGroups addObject:[content substringWithRange:range]];
-    }
-    return [lineGroups componentsJoinedByString:@"\n"];
+    NUIStyleSheet *styleSheet = [self parse:content];
+    return [self consolidateRuleSets:styleSheet];
 }
 
-- (NSMutableDictionary*)getDeclarations:(NSString*)content
-{
-    NSString *pattern = @"([^\\s]+):[\\s]*([^;]+);";
-    NSArray *matches = [self getMatches:content withPattern:pattern];
-
-    NSMutableDictionary *declarations = [[NSMutableDictionary alloc] init];
-    for (NSTextCheckingResult *match in matches) {
-        NSRange range1 = [match rangeAtIndex:1];
-        NSRange range2 = [match rangeAtIndex:2];
-        NSString *property = [content substringWithRange:range1];
-        NSString *value = [content substringWithRange:range2];
-        [declarations setValue:value forKey:property];
-    }
-    return declarations;
-}
-
-- (NSMutableDictionary*)consolidateRuleSets:(NSMutableArray*)ruleSets withTopLevelDeclarations:(NSMutableDictionary*)topLevelDeclarations
+- (NSMutableDictionary*)consolidateRuleSets:(NUIStyleSheet *)styleSheet
 {
     NSMutableDictionary *consolidatedRuleSets = [[NSMutableDictionary alloc] init];
-    for (NSMutableDictionary *ruleSet in ruleSets) {
-        NSString *classExpression = [ruleSet objectForKey:@"classExpression"];
-        NSArray *classes = [self getClassesFromClassExpression:classExpression];
-        for (NSString *class in classes) {
-            if ([consolidatedRuleSets objectForKey:class] == nil) {
-                [consolidatedRuleSets setValue:[[NSMutableDictionary alloc] init] forKey:class];
+    for (NUIRuleSet *ruleSet in styleSheet.ruleSets) {
+        for (NSString *selector in ruleSet.selectors) {
+            if (consolidatedRuleSets[selector] == nil) {
+                consolidatedRuleSets[selector] = [[NSMutableDictionary alloc] init];
             }
-            [self mergeRuleSetIntoConsolidatedRuleSet:ruleSet consolidatedRuleSet:[consolidatedRuleSets objectForKey:class] topLevelDeclarations:topLevelDeclarations];
+            [self mergeRuleSetIntoConsolidatedRuleSet:ruleSet consolidatedRuleSet:consolidatedRuleSets[selector] definitions:styleSheet.definitions];
         }
     }
     return consolidatedRuleSets;
 }
 
-- (NSMutableDictionary*)mergeRuleSetIntoConsolidatedRuleSet:(NSMutableDictionary*)ruleSet consolidatedRuleSet:(NSMutableDictionary*)consolidatedRuleSet topLevelDeclarations:(NSMutableDictionary*)topLevelDeclarations
+- (NSMutableDictionary*)mergeRuleSetIntoConsolidatedRuleSet:(NUIRuleSet*)ruleSet consolidatedRuleSet:(NSMutableDictionary*)consolidatedRuleSet definitions:(NSDictionary*)definitions
 {
-    NSMutableDictionary *declarations = [ruleSet objectForKey:@"declarations"];
-    for (NSString *property in declarations) {
-        NSString *value = [declarations objectForKey:property];
+    for (NSString *property in ruleSet.declarations) {
+        NSString *value = ruleSet.declarations[property];
         if ([value hasPrefix:@"@"]) {
-            value = [topLevelDeclarations objectForKey:value];
+            NSString *variable = value;
+            value = definitions[variable];
+
+            if (!value) {
+                [NSException raise:@"Undefined variable" format:@"Variable %@ is not defined", variable];
+            }
         }
-        [consolidatedRuleSet setValue:value forKey:property];
+        consolidatedRuleSet[property] = value;
     }
     return consolidatedRuleSet;
 }
 
-- (NSArray*)getClassesFromClassExpression:(NSString*)classExpression
+- (NUIStyleSheet *)parse:(NSString *)styles
 {
-    NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:@",[\\s]*" options:0 error:nil];
-    NSString *modifiedClassExpression = [regex stringByReplacingMatchesInString:classExpression options:0 range:NSMakeRange(0, [classExpression length]) withTemplate:@", "];
-    NSArray *separatedClasses = [modifiedClassExpression componentsSeparatedByString:@", "];
-    NSMutableArray *classes = [[NSMutableArray alloc] init];
-    for (NSString *class in separatedClasses) {
-        [classes addObject:[class stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
+    CPTokeniser *tokeniser = [[CPTokeniser alloc] init];
+
+    [tokeniser addTokenRecogniser:[CPWhiteSpaceRecogniser whiteSpaceRecogniser]];
+    [tokeniser addTokenRecogniser:[CPQuotedRecogniser quotedRecogniserWithStartQuote:@"/*"
+                                                                            endQuote:@"*/"
+                                                                                name:@"Comment"]];
+
+    NSCharacterSet *idCharacters = [NSCharacterSet characterSetWithCharactersInString:
+                                    @"abcdefghijklmnopqrstuvwxyz"
+                                    @"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+                                    @"0123456789"
+                                    @"-_\\."];
+    NSCharacterSet *initialIdCharacters = [NSCharacterSet characterSetWithCharactersInString:
+                                           @"abcdefghijklmnopqrstuvwxyz"
+                                           @"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+                                           @"0123456789"
+                                           @"#@-_\\."];
+    [tokeniser addTokenRecogniser:[CPIdentifierRecogniser identifierRecogniserWithInitialCharacters:initialIdCharacters identifierCharacters:idCharacters]];
+
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@":"]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@"{"]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@"}"]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@"("]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@")"]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@","]];
+    [tokeniser addTokenRecogniser:[CPKeywordRecogniser recogniserForKeyword:@";"]];
+
+    NUITokeniserDelegate *tokenizerDelegate = [[NUITokeniserDelegate alloc] init];
+    tokeniser.delegate = tokenizerDelegate;
+
+    NSString *expressionGrammar =
+       @"NUIStyleSheet            ::= definitions@<NUIDefinition>* ruleSets@<NUIRuleSet>*;\n"
+        "NUIRuleSet               ::= selectors@<NUISelectorSet> '{' declarations@<NUIDeclaration>* '}';\n"
+        "NUISelectorSet           ::= firstSelector@<NUISelector> otherSelectors@<NUIDelimitedSelector>*;\n"
+        "NUISelector              ::= name@'Identifier';\n"
+        "NUIDelimitedSelector     ::= ',' selector@<NUISelector>;\n"
+        "NUIDeclaration           ::= property@'Identifier' ':' value@<NUIValue> ';';\n"
+        "NUIDefinition            ::= variable@'Variable' ':' value@<NUIValue> ';';\n"
+        "NUIValue                 ::= <NUIAny>+;\n"
+        "NUIAny                   ::= 'Identifier' | 'Variable' | '(' | ')' | ',';\n"
+        ;
+
+    NSError *err = nil;
+    CPGrammar *grammar = [CPGrammar grammarWithStart:@"NUIStyleSheet"
+                                      backusNaurForm:expressionGrammar
+                                               error:&err];
+    if (!grammar) {
+        NSLog(@"Error creating grammar:%@", err);
+        return nil;
     }
-    return classes;
-}
-
-- (NSArray*)getMatches:(NSString*)content withPattern:(NSString*)pattern
-{
-    NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:pattern options:NSRegularExpressionDotMatchesLineSeparators error:nil];
-    NSArray *matches = [regex matchesInString:content options:0 range:NSMakeRange(0, [content length])];
-    return matches;
+
+    CPParser *parser = [CPLALR1Parser parserWithGrammar:grammar];
+
+    if (!parser)
+        return nil;
+
+    NUIParserDelegate *parserDelegate = [[NUIParserDelegate alloc] init];
+    parser.delegate = parserDelegate;
+
+    CPTokenStream *tokenStream = [tokeniser tokenise:styles];
+    return [parser parse:tokenStream];
 }
 
 @end

NUI/Core/Parser/NUIDeclaration.h

@@ -0,0 +1,16 @@
+//
+//  NUIDeclaration.h
+//  NUI
+//
+//  Created by Tony Mann on 1/14/14.
+//  Copyright (c) 2014 Tom Benner. All rights reserved.
+//
+
+#import "CoreParse.h"
+
+@interface NUIDeclaration : NSObject<CPParseResult>
+
+@property (strong) NSString *property;
+@property (strong) NSString *value;
+
+@end

NUI/Core/Parser/NUIDeclaration.m

@@ -0,0 +1,31 @@
+//
+//  Declaration.m
+//  ParseTest
+//
+//  Created by Tony Mann on 1/14/14.
+//  Copyright (c) 2014 Tom Benner. All rights reserved.
+//
+
+#import "NUIDeclaration.h"
+
+@implementation NUIDeclaration
+
+- (id)initWithSyntaxTree:(CPSyntaxTree *)syntaxTree
+{
+    self = [self init];
+
+    if (nil != self)
+    {
+        self.property = [[syntaxTree valueForTag:@"property"] identifier];
+        self.value    = [syntaxTree valueForTag:@"value"];
+    }
+
+    return self;
+}
+
+- (NSString *) description
+{
+    return [NSString stringWithFormat:@"<NUIDeclaration: %@ = %@>", self.property, self.value];
+}
+
+@end

NUI/Core/Parser/NUIDefinition.h

@@ -0,0 +1,16 @@
+//
+//  Definition.h
+//  ParseTest
+//
+//  Created by Tony Mann on 1/14/14.
+//  Copyright (c) 2014 Tom Benner. All rights reserved.
+//
+
+#import "CoreParse.h"
+
+@interface NUIDefinition : NSObject<CPParseResult>
+
+@property (strong) NSString *variable;
+@property (strong) NSString *value;
+
+@end

NUI/Core/Parser/NUIDefinition.m

@@ -0,0 +1,32 @@
+//
+//  Definition.m
+//  ParseTest
+//
+//  Created by Tony Mann on 1/14/14.
+//  Copyright (c) 2014 Tom Benner. All rights reserved.
+//
+
+#import "NUIDefinition.h"
+#import "NUIVariableToken.h"
+
+@implementation NUIDefinition
+
+- (id)initWithSyntaxTree:(CPSyntaxTree *)syntaxTree
+{
+    self = [self init];
+
+    if (nil != self)
+    {
+        self.variable = [[syntaxTree valueForTag:@"variable"] variable];
+        self.value    = [syntaxTree valueForTag:@"value"];
+    }
+
+    return self;
+}
+
+- (NSString *) description
+{
+    return [NSString stringWithFormat:@"<NUIDefinition: %@ = %@>", self.variable, self.value];
+}
+
+@end

NUI/Core/Parser/NUIParserDelegate.h

@@ -0,0 +1,13 @@
+//
+//  NUIParserDelegate.h
+//  ParseTest
+//
+//  Created by Tony Mann on 1/14/14.
+//  Copyright (c) 2014 Tom Benner. All rights reserved.
+//
+
+#import "CoreParse.h"
+
+@interface NUIParserDelegate : NSObject <CPParserDelegate>
+
+@end