Moved macro name regex fully into scanner class. The aggregator should not know about the inner workings of the scanner.

Author: odrobnik

Core/Source/DTLocalizableStringAggregator.m

@@ -22,7 +22,6 @@ - (void)addEntryToTables:(DTLocalizableStringEntry *)entry;
 @implementation DTLocalizableStringAggregator
 {
     NSDictionary *_validMacros;
-    NSRegularExpression *_validMacrosRegex;
     NSMutableDictionary *_stringTables;
 
     NSOperationQueue *_processingQueue;
@@ -109,30 +108,13 @@ - (NSDictionary *)validMacros
     return _validMacros;
 }
 
-- (NSRegularExpression *)validMacrosRegex
-{
-    if (!_validMacrosRegex) 
-    {
-        NSDictionary *validMacros = [self validMacros];
-        
-        NSString *innerPatternPart = [[validMacros allKeys] componentsJoinedByString:@"|"];
-        NSString *pattern = [NSString stringWithFormat:@"\\b(%@)\\b", innerPatternPart];
-        _validMacrosRegex = [NSRegularExpression regularExpressionWithPattern:pattern options:0 error:NULL];
-    }
-    
-    return _validMacrosRegex;
-}
-
-
 #define QUOTE @"\""
 
 - (void)beginProcessingFile:(NSURL *)fileURL
 {
-    
     NSDictionary *validMacros = [self validMacros];
-    NSRegularExpression *validMacrosRegex = [self validMacrosRegex];
 
-    DTLocalizableStringScanner *scanner = [[DTLocalizableStringScanner alloc] initWithContentsOfURL:fileURL encoding:_inputEncoding validMacros:validMacros validMacroRegex:validMacrosRegex];
+    DTLocalizableStringScanner *scanner = [[DTLocalizableStringScanner alloc] initWithContentsOfURL:fileURL encoding:_inputEncoding validMacros:validMacros];
 
     [scanner setEntryFoundCallback:^(DTLocalizableStringEntry *entry) 
     {

Core/Source/DTLocalizableStringScanner.h

@@ -14,7 +14,7 @@ typedef void(^DTLocalizableStringEntryFoundCallback)(DTLocalizableStringEntry *)
 
 @interface DTLocalizableStringScanner : NSOperation
 
-- (id)initWithContentsOfURL:(NSURL *)url encoding:(NSStringEncoding)encoding validMacros:(NSDictionary *)validMacros validMacroRegex:(NSRegularExpression *)validMacroRegex;
+- (id)initWithContentsOfURL:(NSURL *)url encoding:(NSStringEncoding)encoding validMacros:(NSDictionary *)validMacros;
 
 @property (nonatomic, copy) DTLocalizableStringEntryFoundCallback entryFoundCallback;
 

Core/Source/DTLocalizableStringScanner.m

@@ -30,8 +30,7 @@ @implementation DTLocalizableStringScanner
 
 @synthesize entryFoundCallback=_entryFoundCallback;
 
-- (id)initWithContentsOfURL:(NSURL *)url encoding:(NSStringEncoding)encoding validMacros:(NSDictionary *)validMacros validMacroRegex:(NSRegularExpression *)validMacroRegex
-
+- (id)initWithContentsOfURL:(NSURL *)url encoding:(NSStringEncoding)encoding validMacros:(NSDictionary *)validMacros
 {
     self = [super init];
 
@@ -50,9 +49,13 @@ - (id)initWithContentsOfURL:(NSURL *)url encoding:(NSStringEncoding)encoding val
         _currentIndex = 0;
 
         _url = [url copy]; // to have a reference later
+        
         _validMacros = validMacros;
-        _validMacroRegex = validMacroRegex;
-
+        
+        // build regex to find macro words
+        NSString *innerPatternPart = [[validMacros allKeys] componentsJoinedByString:@"|"];
+        NSString *pattern = [NSString stringWithFormat:@"\\b(%@)\\b", innerPatternPart];
+        _validMacroRegex = [NSRegularExpression regularExpressionWithPattern:pattern options:0 error:NULL];
     }
 
     return self;
@@ -70,10 +73,13 @@ - (void)main
 {
     @autoreleasepool 
     {
-        [_validMacroRegex enumerateMatchesInString:_charactersAsString options:0 range:NSMakeRange(0, [_charactersAsString length]) usingBlock:^(NSTextCheckingResult *match, NSMatchingFlags flags, BOOL *stop){
-            NSRange matchRange = [match range];
-            [self _processMacroAtRange:matchRange]; 
-        }];
+        [_validMacroRegex enumerateMatchesInString:_charactersAsString 
+                                           options:0 range:NSMakeRange(0, [_charactersAsString length]) 
+                                        usingBlock:^(NSTextCheckingResult *match, NSMatchingFlags flags, BOOL *stop) 
+         {
+             NSRange matchRange = [match range];
+             [self _processMacroAtRange:matchRange]; 
+         }];
     }
 }
 
@@ -192,85 +198,87 @@ - (NSString *)_scanParameter
 - (BOOL)_processMacroAtRange:(NSRange)range
 {
     NSString *macroName = [_charactersAsString substringWithRange:range];
-
+    
     _currentIndex = range.location + range.length;
-
-        NSMutableArray *parameters = [[NSMutableArray alloc] initWithCapacity:10];
-        
-
-        // skip any whitespace between here and the (
-        [self _scanWhitespace];
+    
+    NSMutableArray *parameters = [[NSMutableArray alloc] initWithCapacity:10];
+    
+    
+    // skip any whitespace between here and the (
+    [self _scanWhitespace];
+    
+    if (_characters[_currentIndex] == '(') 
+    {
+        // read the opening parenthesis
+        _currentIndex++;
 
-        if (_characters[_currentIndex] == '(') 
+        while (_currentIndex < _stringLength) 
         {
-            // read the opening parenthesis
-            _currentIndex++;
+            // skip any leading whitespace
+            [self _scanWhitespace];
+            
+            // scan a parameter
+            NSString *parameter = [self _scanParameter];
 
-            while (_currentIndex < _stringLength) 
+            if (parameter) 
             {
-                // skip any leading whitespace
-                [self _scanWhitespace];
+                // we found one!
+                // single slash unicode sequences need to be decoded on reading
+                [parameters addObject:[parameter stringByDecodingUnicodeSequences]];
 
-                // scan a parameter
-                NSString *parameter = [self _scanParameter];
+                // skip any trailing whitespace
+                [self _scanWhitespace];
 
-                if (parameter) 
+                if (_characters[_currentIndex] == ',') 
+                {
+                    // consume the comma, but loop again
+                    _currentIndex++;
+                } 
+                else if (_characters[_currentIndex] == ')') 
                 {
-                    // we found one!
-					// single slash unicode sequences need to be decoded on reading
-                    [parameters addObject:[parameter stringByDecodingUnicodeSequences]];
-                    
-                    // skip any trailing whitespace
-                    [self _scanWhitespace];
-                    
-                    if (_characters[_currentIndex] == ',') 
-                    {
-                        // consume the comma, but loop again
-                        _currentIndex++;
-                    } 
-                    else if (_characters[_currentIndex] == ')') 
-                    {
-                        // comsume the closing paren and break
-                        _currentIndex++;
-                        break;
-                    } 
-                    else 
-                    {
-                        // some other character = not syntactically valid = exit
-                        return NO;
-                    }
+                    // comsume the closing paren and break
+                    _currentIndex++;
+                    break;
                 } 
                 else 
                 {
-                    // we were unable to scan a valid parameter
-                    // therefore something must be wrong and we should exit
+                    // some other character = not syntactically valid = exit
                     return NO;
                 }
+            } 
+            else 
+            {
+                // we were unable to scan a valid parameter
+                // therefore something must be wrong and we should exit
+                return NO;
             }
         }
+    }
+    
+    NSArray *expectedParameters = [_validMacros objectForKey:macroName];
+    if ([expectedParameters count] == [parameters count]) 
+    {
+        // hooray, we successfully scanned!
 
-        NSArray *expectedParameters = [_validMacros objectForKey:macroName];
-        if ([expectedParameters count] == [parameters count]) 
+        DTLocalizableStringEntry *entry = [[DTLocalizableStringEntry alloc] init];
+        for (NSUInteger i = 0; i < [parameters count]; ++i) 
         {
-            // hooray, we successfully scanned!
-            
-            DTLocalizableStringEntry *entry = [[DTLocalizableStringEntry alloc] init];
-            for (NSUInteger i = 0; i < [parameters count]; ++i) 
-            {
-                NSString *property = [expectedParameters objectAtIndex:i];
-                NSString *value = [parameters objectAtIndex:i];
-                [entry setValue:value forKey:property];
-            }
-            
-            if (_entryFoundCallback)
-            {
-                _entryFoundCallback(entry);
-            }
-            
-            return YES;
-        } else {
-            NSLog(@"mismaatch");
+            NSString *property = [expectedParameters objectAtIndex:i];
+            NSString *value = [parameters objectAtIndex:i];
+            [entry setValue:value forKey:property];
+        }
+        
+        if (_entryFoundCallback)
+        {
+            _entryFoundCallback(entry);
         }
+        
+        return YES;
+    } 
+    else 
+    {
+        NSLog(@"mismatch of parameters for %@ macro", macroName);
+    }
 
     return NO;
 }