1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLRTokenRewriteStream.h 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// ANTLR 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Created by Alan Condit on 6/19/10. 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// [The "BSD licence"] 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Copyright (c) 2010 Alan Condit 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// All rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Redistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// modification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// are met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 1. Redistributions of source code must retain the above copyright 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 2. Redistributions in binary form must reproduce the above copyright 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// notice, this list of conditions and the following disclaimer in the 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// documentation and/or other materials provided with the distribution. 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3. The name of the author may not be used to endorse or promote products 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// derived from this software without specific prior written permission. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import <Cocoa/Cocoa.h> 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRCommonTokenStream.h" 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRLinkBase.h" 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRHashMap.h" 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRMapElement.h" 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#import "ANTLRTokenSource.h" 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Define the rewrite operation hierarchy 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRRewriteOperation : ANTLRCommonTokenStream 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** What index into rewrites List are we? */ 44324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger instructionIndex; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Token buffer index. */ 46324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSInteger index; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNSString *text; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getInstructionIndex, setter=setInstructionIndex:) NSInteger instructionIndex; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getIndex, setter=setIndex:) NSInteger index; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getText, setter=setText:) NSString *text; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRRewriteOperation *) newANTLRRewriteOperation:(NSInteger)index Text:(NSString *)text; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithIndex:(NSInteger)anIndex Text:(NSString *)theText; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Execute the rewrite operation by possibly adding to the buffer. 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return the index of the next token to operate on. 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) execute:(NSString *)buf; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) indexOf:(char)aChar inString:(NSString *)aString; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRInsertBeforeOp : ANTLRRewriteOperation { 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRInsertBeforeOp *) newANTLRInsertBeforeOp:(NSInteger)anIndex Text:(NSString *)theText; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithIndex:(NSInteger)anIndex Text:(NSString *)theText; 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** I'm going to try replacing range from x..y with (y-x)+1 ReplaceOp 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * instructions. 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRReplaceOp : ANTLRRewriteOperation { 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NSInteger lastIndex; 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (getter=getLastIndex, setter=setLastIndex:) NSInteger lastIndex; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRReplaceOp *) newANTLRReplaceOp:(NSInteger)from ToIndex:(NSInteger)to Text:(NSString*)theText; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithIndex:(NSInteger)from ToIndex:(NSInteger)to Text:(NSString *)theText; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger) execute:(NSString *)buf; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRDeleteOp : ANTLRReplaceOp { 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRDeleteOp *) newANTLRDeleteOp:(NSInteger)from ToIndex:(NSInteger)to; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) initWithIndex:(NSInteger)from ToIndex:(NSInteger)to; 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@interface ANTLRTokenRewriteStream : ANTLRCommonTokenStream { 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** You may have multiple, named streams of rewrite operations. 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I'm calling these things "programs." 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Maps String (name) -> rewrite (List) 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 108324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverANTLRHashMap *programs; 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** Map String (program name) -> Integer index */ 111324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverANTLRHashMap *lastRewriteTokenIndexes; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getPrograms, setter=setPrograms:) ANTLRHashMap *programs; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@property (retain, getter=getLastRewriteTokenIndexes, setter=setLastRewriteTokenIndexes:) ANTLRHashMap *lastRewriteTokenIndexes; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTokenRewriteStream *)newANTLRTokenRewriteStream; 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTokenRewriteStream *)newANTLRTokenRewriteStream:(id<ANTLRTokenSource>) aTokenSource; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver+ (ANTLRTokenRewriteStream *)newANTLRTokenRewriteStream:(id<ANTLRTokenSource>) aTokenSource Channel:(NSInteger)aChannel; 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id) init; 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id)initWithTokenSource:(id<ANTLRTokenSource>)aTokenSource; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (id)initWithTokenSource:(id<ANTLRTokenSource>)aTokenSource Channel:(NSInteger)aChannel; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *)getPrograms; 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)setPrograms:(ANTLRHashMap *)aProgList; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rollback:(NSInteger)instructionIndex; 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) rollback:(NSString *)programName Index:(NSInteger)anInstructionIndex; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) deleteProgram; 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) deleteProgram:(NSString *)programName; 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertAfterToken:(id<ANTLRToken>)t Text:(NSString *)theText; 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertAfterIndex:(NSInteger)anIndex Text:(NSString *)theText; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertAfterProgNam:(NSString *)programName Index:(NSInteger)anIndex Text:(NSString *)theText; 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertBeforeToken:(id<ANTLRToken>)t Text:(NSString *)theText; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertBeforeIndex:(NSInteger)anIndex Text:(NSString *)theText; 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) insertBeforeProgName:(NSString *)programName Index:(NSInteger)index Text:(NSString *)theText; 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceFromIndex:(NSInteger)anIndex Text:(NSString *)theText; 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceFromIndex:(NSInteger)from ToIndex:(NSInteger)to Text:(NSString *)theText; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceFromToken:(id<ANTLRToken>)indexT Text:(NSString *)theText; 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceFromToken:(id<ANTLRToken>)from ToToken:(id<ANTLRToken>)to Text:(NSString *)theText; 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceProgNam:(NSString *)programName Token:(id<ANTLRToken>)from Token:(id<ANTLRToken>)to Text:(NSString *)theText; 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) replaceProgNam:(NSString *)programName FromIndex:(NSInteger)from ToIndex:(NSInteger)to Text:(NSString *)theText; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) delete:(NSInteger)anIndex; 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) delete:(NSInteger)from ToIndex:(NSInteger)to; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) deleteToken:(id<ANTLRToken>)indexT; 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) deleteFromToken:(id<ANTLRToken>)from ToToken:(id<ANTLRToken>)to; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) delete:(NSString *)programName FromToken:(id<ANTLRToken>)from ToToken:(id<ANTLRToken>)to; 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void) delete:(NSString *)programName FromIndex:(NSInteger)from ToIndex:(NSInteger)to; 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getLastRewriteTokenIndex; 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSInteger)getLastRewriteTokenIndex:(NSString *)programName; 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (void)setLastRewriteTokenIndex:(NSString *)programName Index:(NSInteger)anInt; 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *) getProgram:(NSString *)name; 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *) initializeProgram:(NSString *)name; 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toOriginalString; 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toOriginalString:(NSInteger)start End:(NSInteger)end; 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString; 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString:(NSString *)programName; 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toStringFromStart:(NSInteger)start ToEnd:(NSInteger)end; 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)toString:(NSString *)programName FromStart:(NSInteger)start ToEnd:(NSInteger)end; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *)reduceToSingleOperationPerIndex:(ANTLRHashMap *)rewrites; 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *)getKindOfOps:(ANTLRHashMap *)rewrites KindOfClass:(Class)kind; 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (ANTLRHashMap *)getKindOfOps:(ANTLRHashMap *)rewrites KindOfClass:(Class)kind Index:(NSInteger)before; 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSString *)catOpText:(id)a PrevText:(id)b; 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableString *)toDebugString; 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver- (NSMutableString *)toDebugStringFromStart:(NSInteger)start ToEnd:(NSInteger)end; 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@end 171