IFNaturalHighlighter.m

//
//  IFNaturalHighlighter.m
//  Inform
//
//  Created by Andrew Hunter on 18/11/2004.
//  Copyright 2004 Andrew Hunter. All rights reserved.
//

#import "IFNaturalHighlighter.h"
#import "IFProjectPane.h"
#import "IFPreferences.h"

@implementation IFNaturalHighlighter

// = Initialisation =

- (id) init {
	self = [super init];
	
	if (self) {
		inform6Highlighter = [[IFInform6Highlighter alloc] init];
	}
	
	return self;
}

- (void) dealloc {
	[activeStorage release];
	[inform6Highlighter release];
	
	[super dealloc];
}

// = Notifying of the highlighter currently in use =

- (void) setSyntaxStorage: (IFSyntaxStorage*) storage {
	[activeStorage release];
	activeStorage = [storage retain];
	
	[inform6Highlighter setSyntaxStorage: storage];
}

// = The highlighter itself =

- (IFSyntaxState) stateForCharacter: (unichar) chr
						 afterState: (IFSyntaxState) lastState {
	switch ([activeStorage highlighterMode]) {
		case IFNaturalModeStandard:
			// Natural Inform mode
			switch (lastState) {
				case IFNaturalStateMaybeInform6:
					if (chr == '-') {
						// Switch to Inform 6 mode
						[activeStorage pushState];
						[activeStorage setHighlighterMode: IFNaturalModeInform6];
						
						if ([activeStorage preceededByKeyword: @"Include"
													   offset: 1]) {
							// Is top-level Inform 6
							return IFSyntaxStateDefault;
						} else {
							// Is as if preceeded by '[T;'
							IFSyntaxState newState =  [inform6Highlighter stateForCharacter: '['
																				 afterState: IFSyntaxStateDefault];
							newState = [inform6Highlighter stateForCharacter: 'T'
																  afterState: newState];
							newState = [inform6Highlighter stateForCharacter: ';'
																  afterState: newState];
							return newState;
						}
					}
				case IFNaturalStateBlankLine:
					if (chr == ' ' || chr == '\n' || chr == '\t' || chr == '\r')
						return IFNaturalStateBlankLine;
					// ObRAIF: here is why fall-through cases are a *good* thing
					// (Of course, first time I tried this, I got these conditions the wrong way round... Mmm, bug)
				case IFNaturalStateSpace:
					if (chr == '"')
						return IFNaturalStateQuote;
				case IFNaturalStateText:
					// Just plain ole text
					if (chr == '[') {
						[activeStorage pushState];
						return IFNaturalStateComment;
					}
					if (chr == '\n' || chr == '\r')
						return IFNaturalStateBlankLine;
						
					if (chr == '(')
						return IFNaturalStateMaybeInform6;
					if (chr == ' ' || chr == '\t' || chr == '.' || chr == ')' || chr == '}' || chr == ';'
						|| chr == ':' || chr == ',' || chr == '?' || chr == '!' || chr == '{')
						return IFNaturalStateSpace;
					return IFNaturalStateText;
					
				case IFNaturalStateTitle:
					// The title
					if (chr == '\n' || chr == '\r')
						return IFNaturalStateBlankLine;

					if (chr == '"')
						return IFNaturalStateTitleQuote;

					return IFNaturalStateTitle;

					
				case IFNaturalStateComment:
					if (chr == '[') {
						[activeStorage pushState];
						return IFNaturalStateComment;
					}
					if (chr == ']') {
						return [activeStorage popState];
					}
					return IFNaturalStateComment;
				
				case IFNaturalStateSubstitution:
					if (chr == ']')
						return IFNaturalStateQuote;
				case IFNaturalStateQuote:
					if (chr == '"')
						return IFNaturalStateText;
					if (chr == '[')
						return IFNaturalStateSubstitution;
					return lastState;

				case IFNaturalStateTitleQuote:
					if (chr == '"')
						return IFNaturalStateTitle;
					return lastState;
					
				case IFNaturalStateHeading:
					if (chr == '\n' || chr == '\r')
						return IFNaturalStateBlankLine;
					return IFNaturalStateHeading;
					
				default:
					// Unknown state
					return IFNaturalStateText;
			}
			break;
			
		// Various Inform 6 modes
		case IFNaturalModeInform6MightEnd:
			if (chr == ')') {
				// Switch back to standard mode
				[activeStorage popState];
				return IFNaturalStateText;
			}
			
			// Switch back to Inform 6 mode
			[activeStorage setHighlighterMode: IFNaturalModeInform6];
			
		case IFNaturalModeInform6:
			if (chr == '-') {
				// Next character might break us out of Inform 6 mode
				[activeStorage setHighlighterMode: IFNaturalModeInform6MightEnd];
			}
			
			// Run the Inform 6 highlighter
			return [inform6Highlighter stateForCharacter: chr
											  afterState: lastState];
	}

	return IFNaturalStateText;
}

- (IFSyntaxStyle) styleForCharacter: (unichar) chr
						  nextState: (IFSyntaxState) nextState
						  lastState: (IFSyntaxState) lastState {
	switch ([activeStorage highlighterMode]) {
		// Natural Inform styles
		case IFNaturalModeStandard:
			// Some states override the next state
			if (lastState == IFNaturalStateComment)			return IFSyntaxComment;
			if (lastState == IFNaturalStateQuote && nextState != IFNaturalStateTitleQuote)
				return IFSyntaxGameText;
			if (lastState == IFNaturalStateTitleQuote)		return IFSyntaxTitle;
			if (lastState == IFNaturalStateHeading)			return IFSyntaxHeading;
			if (lastState == IFNaturalStateSubstitution)	return IFSyntaxSubstitution;
			
			switch (nextState) {
				case IFNaturalStateText:
				case IFNaturalStateBlankLine:
					if (nextState == IFNaturalStateComment) return IFSyntaxComment;
					if (nextState == IFNaturalStateQuote) return IFSyntaxGameText;
					return IFSyntaxNaturalInform;
					
				case IFNaturalStateTitle:
					return IFSyntaxNaturalInform;
					
				case IFNaturalStateTitleQuote:
					return IFSyntaxTitle;
					
				case IFNaturalStateSubstitution:
					return IFSyntaxSubstitution;
					
				case IFNaturalStateQuote:
					return IFSyntaxGameText;
					
				case IFNaturalStateComment:
					return IFSyntaxComment;
					
				case IFNaturalStateHeading:
					return IFSyntaxHeading;
				
				default:
					return IFSyntaxNone;
			}
			break;
			
		// Inform 6 styles
		case IFNaturalModeInform6MightEnd:
		case IFNaturalModeInform6:
			return [inform6Highlighter styleForCharacter: chr
											   nextState: nextState
											   lastState: lastState] + 0x20;
			break;
	}

	return IFSyntaxNone;
}

static BOOL IsInform6Style(IFSyntaxStyle style) {
	if (style >= 0x20 && style <= 0x40)
		return YES;
	else
		return NO;
}

- (void) rehintLine: (NSString*) line
			 styles: (IFSyntaxStyle*) styles
	   initialState: (IFSyntaxState) initialState {
	NSString* thisLine = [line lowercaseString];
	
	// This line might be a header line
	BOOL isHeader = NO;
	
	if (initialState == IFNaturalStateBlankLine && !IsInform6Style(styles[0])) {
		if ([thisLine hasPrefix: @"volume "]) isHeader = YES;
		if ([thisLine hasPrefix: @"book "]) isHeader = YES;
		if ([thisLine hasPrefix: @"part "]) isHeader = YES;
		if ([thisLine hasPrefix: @"chapter "]) isHeader = YES;
		if ([thisLine hasPrefix: @"section "]) isHeader = YES;
	}
	
	if (isHeader) {
		int x;
		for (x=0; x<[line length]; x++) {
			styles[x] = IFSyntaxHeading;
		}
	}
	
	// This line might have some Inform 6 highlighting to do
	int x;
	for (x=0; x<[line length]; x++) {
		if (IsInform6Style(styles[x])) {
			// Found an Inform 6 region
			NSRange thisRegion;
			
			thisRegion.location = x;
			thisRegion.length = 0;
			
			// Convert to standard style, work out how long the region is
			for (;x<[line length] && IsInform6Style(styles[x]);x++) {
				thisRegion.length++;
				styles[x] -= 0x20;
			}
			
			// Get the Inform 6 highlighter to rehint this section
			[inform6Highlighter rehintLine: [line substringWithRange: thisRegion] 
									styles: styles+thisRegion.location 
							  initialState: IFSyntaxStateDefault];
		}
	}
}

// = Styles =

- (NSDictionary*) attributesForStyle: (IFSyntaxStyle) style {
	return [IFProjectPane attributeForStyle: style];
}

- (float) tabStopWidth {
	return [[IFPreferences sharedPreferences] tabWidth];
	//return 56.0;
}

@end