Tidy up console/query controller.

1 files changed, 91 insertions, 589 deletions

diff --git a/Source/SPQueryController.m b/Source/SPQueryController.m
index 08678f83..46c9da3d 100644
--- a/Source/SPQueryController.m
+++ b/Source/SPQueryController.m
@@ -26,18 +26,11 @@
 #import "SPQueryController.h"
 #import "SPConsoleMessage.h"
 #import "SPCustomQuery.h"
+#import "SPQueryControllerInitializer.h"
 
 #import "pthread.h"
 
-#define MESSAGE_TRUNCATE_CHARACTER_LENGTH 256
-
-#ifndef SP_REFACTOR
-// Table view column identifier constants
-static NSString *SPTableViewDateColumnID       = @"messageDate";
-static NSString *SPTableViewConnectionColumnID = @"messageConnection";
-#endif
-
-@interface SPQueryController (PrivateAPI)
+@interface SPQueryController ()
 
 - (void)_updateFilterState;
 - (BOOL)_messageMatchesCurrentFilters:(NSString *)message;
@@ -51,9 +44,7 @@ static SPQueryController *sharedQueryController = nil;
 @implementation SPQueryController
 
 #ifndef SP_REFACTOR
-
 @synthesize consoleFont;
-
 #endif
 
 /**
@@ -75,8 +66,9 @@ static SPQueryController *sharedQueryController = nil;
 	@synchronized(self) {
 		return [[self sharedQueryController] retain];
 	}
+	
 #ifdef SP_REFACTOR
-	return nil;  // only here to stop clang's "can reach end of non-void function"
+	return nil;  // only here to stop clang's 'can reach end of non-void function'
 #endif
 }
 
@@ -111,41 +103,11 @@ static SPQueryController *sharedQueryController = nil;
 		pthread_mutex_init(&consoleLock, NULL);
 #endif
 
-		NSError *readError = nil;
-		NSString *convError = nil;
-		NSPropertyListFormat format;
-		NSDictionary *completionPlist;
-		NSData *completionTokensData = [NSData dataWithContentsOfFile:[NSBundle pathForResource:@"CompletionTokens.plist" ofType:nil inDirectory:[[NSBundle mainBundle] bundlePath]]
-			options:NSMappedRead error:&readError];
-
-
-		completionPlist = [NSDictionary dictionaryWithDictionary:[NSPropertyListSerialization propertyListFromData:completionTokensData
-				mutabilityOption:NSPropertyListMutableContainersAndLeaves format:&format errorDescription:&convError]];
-
-		if(completionPlist == nil || readError != nil || convError != nil) {
-			NSLog(@"Error while reading “CompletionTokens.plist”:\n%@\n%@", [readError localizedDescription], convError);
-			NSBeep();
-		} else {
-			if([completionPlist objectForKey:@"core_keywords"]) {
-				completionKeywordList = [[NSArray arrayWithArray:[completionPlist objectForKey:@"core_keywords"]] retain];
-			} else {
-				NSLog(@"No “core_keywords” array found.");
-				NSBeep();
-			}
-			if([completionPlist objectForKey:@"core_builtin_functions"]) {
-				completionFunctionList = [[NSArray arrayWithArray:[completionPlist objectForKey:@"core_builtin_functions"]] retain];
-			} else {
-				NSLog(@"No “core_builtin_functions” array found.");
-				NSBeep();
-			}
-			if([completionPlist objectForKey:@"function_argument_snippets"]) {
-				functionArgumentSnippets = [[NSDictionary dictionaryWithDictionary:[completionPlist objectForKey:@"function_argument_snippets"]] retain];
-			} else {
-				NSLog(@"No “function_argument_snippets” dictionary found.");
-				NSBeep();
-			}
+		NSError *error = [self loadCompletionLists];
+		
+		if (error) {
+			NSLog(@"Error loading completion tokens data: %@", [error localizedDescription]); 
 		}
-
 	}
 
 	return self;
@@ -165,48 +127,6 @@ static SPQueryController *sharedQueryController = nil;
 
 - (void)release { }
 
-/**
- * Set the window's auto save name and initialise display
- */
-- (void)awakeFromNib
-{
-#ifndef SP_REFACTOR /* init ivars */
-	prefs = [NSUserDefaults standardUserDefaults];
-
-	[self setWindowFrameAutosaveName:@"QueryConsole"];
-
-	// Show/hide table columns
-	[[consoleTableView tableColumnWithIdentifier:SPTableViewDateColumnID] setHidden:![prefs boolForKey:SPConsoleShowTimestamps]];
-	[[consoleTableView tableColumnWithIdentifier:SPTableViewConnectionColumnID] setHidden:![prefs boolForKey:SPConsoleShowConnections]];
-	
-	showSelectStatementsAreDisabled = ![prefs boolForKey:SPConsoleShowSelectsAndShows];
-	showHelpStatementsAreDisabled = ![prefs boolForKey:SPConsoleShowHelps];
-
-	[self _updateFilterState];
-
-	[loggingDisabledTextField setStringValue:([prefs boolForKey:SPConsoleEnableLogging]) ? @"" : NSLocalizedString(@"Query logging is currently disabled", @"query logging disabled label")];
-
-	// Setup data formatter
-	dateFormatter = [[NSDateFormatter alloc] init];
-
-	[dateFormatter setFormatterBehavior:NSDateFormatterBehavior10_4];
-
-	[dateFormatter setDateStyle:NSDateFormatterNoStyle];
-	[dateFormatter setTimeStyle:NSDateFormatterMediumStyle];
-
-	// Set the process table view's vertical gridlines if required
-	[consoleTableView setGridStyleMask:([prefs boolForKey:SPDisplayTableViewVerticalGridlines]) ? NSTableViewSolidVerticalGridLineMask : NSTableViewGridNone];
-
-	// Set the strutcture and index view's font
-	BOOL useMonospacedFont = [prefs boolForKey:SPUseMonospacedFonts];
-
-	for (NSTableColumn *column in [consoleTableView tableColumns])
-	{
-		[[column dataCell] setFont:(useMonospacedFont) ? [NSFont fontWithName:SPDefaultMonospacedFontName size:[NSFont smallSystemFontSize]] : [NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
-	}
-#endif
-}
-
 #pragma mark -
 #pragma mark QueryConsoleController
 
@@ -288,7 +208,7 @@ static SPQueryController *sharedQueryController = nil;
 
 	[panel setAccessoryView:saveLogView];
 
-	[panel beginSheetForDirectory:nil file:NSLocalizedString(@"ConsoleLog",@"Console : Save as : Initial filename") modalForWindow:[self window] modalDelegate:self didEndSelector:@selector(savePanelDidEnd:returnCode:contextInfo:) contextInfo:NULL];
+	[panel beginSheetForDirectory:nil file:NSLocalizedString(@"ConsoleLog", @"Console : Save as : Initial filename") modalForWindow:[self window] modalDelegate:self didEndSelector:@selector(savePanelDidEnd:returnCode:contextInfo:) contextInfo:NULL];
 #endif
 }
 
@@ -383,65 +303,6 @@ static SPQueryController *sharedQueryController = nil;
 }
 
 #pragma mark -
-#pragma mark Tableview delegate methods
-
-/**
- * Table view delegate method. Returns the number of rows in the table veiw.
- */
-- (NSInteger)numberOfRowsInTableView:(NSTableView *)tableView
-{
-#ifndef SP_REFACTOR
-	return [messagesVisibleSet count];
-#else
-	return 0;
-#endif
-}
-
-/**
- * Table view delegate method. Returns the specific object for the request column and row.
- */
-- (id)tableView:(NSTableView *)tableView objectValueForTableColumn:(NSTableColumn *)tableColumn row:(NSInteger)row
-{
-#ifndef SP_REFACTOR
-	NSString *returnValue = nil;
-
-	id object = [[messagesVisibleSet objectAtIndex:row] valueForKey:[tableColumn identifier]];
-
-	if ([[tableColumn identifier] isEqualToString:SPTableViewDateColumnID]) {
-
-		returnValue = [dateFormatter stringFromDate:(NSDate *)object];
-	}
-	else {
-		if ([(NSString *)object length] > MESSAGE_TRUNCATE_CHARACTER_LENGTH) {
-			object = [NSString stringWithFormat:@"%@...", [object substringToIndex:MESSAGE_TRUNCATE_CHARACTER_LENGTH]];
-		}
-
-		returnValue = object;
-	}
-
-	NSMutableDictionary *stringAtributes = nil;
-
-	if (consoleFont) {
-		stringAtributes = [NSMutableDictionary dictionaryWithObject:consoleFont forKey:NSFontAttributeName];
-	}
-
-	// If this is an error message give it a red colour
-	if ([(SPConsoleMessage *)[messagesVisibleSet objectAtIndex:row] isError]) {
-		if (stringAtributes) {
-			[stringAtributes setObject:[NSColor redColor] forKey:NSForegroundColorAttributeName];
-		}
-		else {
-			stringAtributes = [NSMutableDictionary dictionaryWithObject:[NSColor redColor] forKey:NSForegroundColorAttributeName];
-		}
-	}
-
-	return [[[NSAttributedString alloc] initWithString:returnValue attributes:stringAtributes] autorelease];
-#else
-	return nil;
-#endif
-}
-
-#pragma mark -
 #pragma mark Other
 
 /**
@@ -450,13 +311,12 @@ static SPQueryController *sharedQueryController = nil;
 - (void)controlTextDidChange:(NSNotification *)notification
 {
 #ifndef SP_REFACTOR
-	id object = [notification object];
-
-	if ([object isEqualTo:consoleSearchField]) {
+	if ([[notification object] isEqualTo:consoleSearchField]) {
 
 		// Store the state of the text filter and the current filter string for later quick reference
-		[activeFilterString setString:[[object stringValue] lowercaseString]];
-		filterIsActive = [activeFilterString length]?YES:NO;
+		[activeFilterString setString:[[[notification object] stringValue] lowercaseString]];
+		
+		filterIsActive = [activeFilterString length] > 0;
 
 		[self _updateFilterState];
 	}
@@ -471,7 +331,7 @@ static SPQueryController *sharedQueryController = nil;
 #ifndef SP_REFACTOR
 	// Show/hide logging disabled label
 	if ([keyPath isEqualToString:SPConsoleEnableLogging]) {
-		[loggingDisabledTextField setStringValue:([[change objectForKey:NSKeyValueChangeNewKey] boolValue]) ? @"" : @"Query logging is currently disabled"];
+		[loggingDisabledTextField setStringValue:([[change objectForKey:NSKeyValueChangeNewKey] boolValue]) ? @"" : NSLocalizedString(@"Query logging is currently disabled", @"query logging currently disabled label")];
 	}
 	// Display table veiew vertical gridlines preference changed
 	else if ([keyPath isEqualToString:SPDisplayTableViewVerticalGridlines]) {
@@ -511,7 +371,7 @@ static SPQueryController *sharedQueryController = nil;
 	return [[self window] validateMenuItem:menuItem];
 }
 
-- (BOOL) allowConsoleUpdate
+- (BOOL)allowConsoleUpdate
 {
 #ifndef SP_REFACTOR
 	return allowConsoleUpdate;
@@ -520,10 +380,11 @@ static SPQueryController *sharedQueryController = nil;
 #endif
 }
 
-- (void) setAllowConsoleUpdate:(BOOL)allowUpdate
+- (void)setAllowConsoleUpdate:(BOOL)allowUpdate
 {
 #ifndef SP_REFACTOR
 	allowConsoleUpdate = allowUpdate;
+	
 	if (allowUpdate && [[self window] isVisible]) [self updateEntries];
 #endif
 }
@@ -544,459 +405,73 @@ static SPQueryController *sharedQueryController = nil;
  */
 - (NSString *)windowFrameAutosaveName
 {
-	return @"QueryConsole";
-}
-
-#pragma mark -
-#pragma mark Completion List Controller
-
-/**
- * Return an array of all pre-defined SQL functions for completion.
- */
-- (NSArray*)functionList
-{
-	if(completionFunctionList != nil && [completionFunctionList count])
-		return completionFunctionList;
-	return [NSArray array];
-}
-
-/**
- * Return an array of all pre-defined SQL keywords for completion.
- */
-- (NSArray*)keywordList
-{
-	if(completionKeywordList != nil && [completionKeywordList count])
-		return completionKeywordList;
-	return [NSArray array];
+	return SPQueryConsoleWindowAutoSaveName;
 }
 
 /**
- * Return the parameter list as snippet of the passed SQL functions for completion.
- *
- * @param func The name of the function whose parameter list is asked for
- */
-- (NSString*)argumentSnippetForFunction:(NSString*)func
-{
-	if(functionArgumentSnippets && [functionArgumentSnippets objectForKey:[func uppercaseString]])
-		return [functionArgumentSnippets objectForKey:[func uppercaseString]];
-	return @"";
-}
-
-#pragma mark -
-#pragma mark DocumentsController
-
-- (NSURL *)registerDocumentWithFileURL:(NSURL *)fileURL andContextInfo:(NSMutableDictionary *)contextInfo
-{
-#ifndef SP_REFACTOR
-	// Register a new untiled document and return its URL
-	if(fileURL == nil) {
-		NSURL *new = [NSURL URLWithString:[[NSString stringWithFormat:NSLocalizedString(@"Untitled %ld",@"Title of a new Sequel Pro Document"), (unsigned long)untitledDocumentCounter] stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]];
-		untitledDocumentCounter++;
-
-		if(![favoritesContainer objectForKey:[new absoluteString]]) {
-			NSMutableArray *arr = [[NSMutableArray alloc] init];
-			[favoritesContainer setObject:arr forKey:[new absoluteString]];
-			[arr release];
-		}
-
-		// Set the global history coming from the Prefs as default if available
-		if(![historyContainer objectForKey:[new absoluteString]]) {
-			if([prefs objectForKey:SPQueryHistory]) {
-				NSMutableArray *arr = [[NSMutableArray alloc] init];
-				[arr addObjectsFromArray:[prefs objectForKey:SPQueryHistory]];
-				[historyContainer setObject:arr forKey:[new absoluteString]];
-				[arr release];
-			} else {
-				NSMutableArray *arr = [[NSMutableArray alloc] init];
-				[historyContainer setObject:[NSMutableArray array] forKey:[new absoluteString]];
-				[arr release];
-			}
-		}
-
-		// Set the doc-based content filters
-		if(![contentFilterContainer objectForKey:[new absoluteString]]) {
-			[contentFilterContainer setObject:[NSMutableDictionary dictionary] forKey:[new absoluteString]];
-		}
-
-		return new;
-
-	}
-
-	// Register a spf file to manage all query favorites and query history items
-	// file path based (incl. Untitled docs) in a dictionary whereby the key represents the file URL as string.
-	if(![favoritesContainer objectForKey:[fileURL absoluteString]]) {
-		if(contextInfo != nil && [contextInfo objectForKey:SPQueryFavorites] && [[contextInfo objectForKey:SPQueryFavorites] count]) {
-			NSMutableArray *arr = [[NSMutableArray alloc] init];
-			[arr addObjectsFromArray:[contextInfo objectForKey:SPQueryFavorites]];
-			[favoritesContainer setObject:arr forKey:[fileURL absoluteString]];
-			[arr release];
-		} else {
-			NSMutableArray *arr = [[NSMutableArray alloc] init];
-			[favoritesContainer setObject:arr forKey:[fileURL absoluteString]];
-			[arr release];
-		}
-	}
-
-	if(![historyContainer objectForKey:[fileURL absoluteString]]) {
-		if(contextInfo != nil && [contextInfo objectForKey:SPQueryHistory] && [[contextInfo objectForKey:SPQueryHistory] count]) {
-			NSMutableArray *arr = [[NSMutableArray alloc] init];
-			[arr addObjectsFromArray:[contextInfo objectForKey:SPQueryHistory]];
-			[historyContainer setObject:arr forKey:[fileURL absoluteString]];
-			[arr release];
-		} else {
-			NSMutableArray *arr = [[NSMutableArray alloc] init];
-			[historyContainer setObject:arr forKey:[fileURL absoluteString]];
-			[arr release];
-		}
-	}
-
-	if(![contentFilterContainer objectForKey:[fileURL absoluteString]]) {
-		if(contextInfo != nil && [contextInfo objectForKey:SPContentFilters]) {
-			[contentFilterContainer setObject:[contextInfo objectForKey:SPContentFilters] forKey:[fileURL absoluteString]];
-		} else {
-			NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
-			[contentFilterContainer setObject:dict forKey:[fileURL absoluteString]];
-			[dict release];
-		}
-	}
-
-	return fileURL;
-#else
-	return nil;
-#endif
-}
-
-- (void)removeRegisteredDocumentWithFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	// Check for multiple instance of the same document.
-	// Remove it if only one instance was registerd.
-	NSArray *allDocs = [[NSApp delegate] orderedDocuments];
-	NSMutableArray *allURLs = [NSMutableArray array];
-	for(id doc in allDocs) {
-		if (![doc fileURL]) continue;
-		if([allURLs containsObject:[doc fileURL]])
-			return;
-		else
-			[allURLs addObject:[doc fileURL]];
-	}
-
-	if([favoritesContainer objectForKey:[fileURL absoluteString]])
-		[favoritesContainer removeObjectForKey:[fileURL absoluteString]];
-	if([historyContainer objectForKey:[fileURL absoluteString]])
-		[historyContainer removeObjectForKey:[fileURL absoluteString]];
-	if([contentFilterContainer objectForKey:[fileURL absoluteString]])
-		[contentFilterContainer removeObjectForKey:[fileURL absoluteString]];
-#endif
-}
-
-- (void)replaceContentFilterByArray:(NSArray *)contentFilterArray ofType:(NSString *)filterType forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([contentFilterContainer objectForKey:[fileURL absoluteString]]) {
-		NSMutableDictionary *c = [[NSMutableDictionary alloc] init];
-		[c setDictionary:[contentFilterContainer objectForKey:[fileURL absoluteString]]];
-		[c setObject:contentFilterArray forKey:filterType];
-		[contentFilterContainer setObject:c forKey:[fileURL absoluteString]];
-		[c release];
-	}
-#endif
-}
-
-- (void)replaceFavoritesByArray:(NSArray *)favoritesArray forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([favoritesContainer objectForKey:[fileURL absoluteString]])
-		[favoritesContainer setObject:favoritesArray forKey:[fileURL absoluteString]];
-#endif
-}
-
-- (void)replaceHistoryByArray:(NSArray *)historyArray forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([historyContainer objectForKey:[fileURL absoluteString]])
-		[historyContainer setObject:historyArray forKey:[fileURL absoluteString]];
-
-	// Inform all opened documents to update the history list
-	for(id doc in [[NSApp delegate] orderedDocuments])
-		if([[doc valueForKeyPath:@"customQueryInstance"] respondsToSelector:@selector(historyItemsHaveBeenUpdated:)])
-				[[doc valueForKeyPath:@"customQueryInstance"] performSelectorOnMainThread:@selector(historyItemsHaveBeenUpdated:) withObject:self waitUntilDone:NO];
-
-	// User did choose to clear the global history list
-	if(![fileURL isFileURL] && ![historyArray count])
-		[prefs setObject:historyArray forKey:SPQueryHistory];
-#endif
-}
-
-- (void)addFavorite:(NSDictionary *)favorite forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([favoritesContainer objectForKey:[fileURL absoluteString]])
-		[[favoritesContainer objectForKey:[fileURL absoluteString]] addObject:favorite];
-#endif
-}
-
-- (void)addHistory:(NSString *)history forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	NSUInteger maxHistoryItems = [[prefs objectForKey:SPCustomQueryMaxHistoryItems] integerValue];
-
-	// Save each history item due to its document source
-	if([historyContainer objectForKey:[fileURL absoluteString]]) {
-
-		// Remove all duplicates by using a NSPopUpButton
-		NSPopUpButton *uniquifier = [[NSPopUpButton alloc] initWithFrame:NSMakeRect(0,0,0,0) pullsDown:YES];
-		[uniquifier addItemsWithTitles:[historyContainer objectForKey:[fileURL absoluteString]]];
-		[uniquifier insertItemWithTitle:history atIndex:0];
-
-		while ( (NSUInteger)[uniquifier numberOfItems] > maxHistoryItems )
-			[uniquifier removeItemAtIndex:[uniquifier numberOfItems]-1];
-
-		[self replaceHistoryByArray:[uniquifier itemTitles] forFileURL:fileURL];
-		[uniquifier release];
-	}
-
-	// Save history items coming from each Untitled document in the global Preferences successively
-	// regardingless of the source document.
-	if(![fileURL isFileURL]) {
-
-		// Remove all duplicates by using a NSPopUpButton
-		NSPopUpButton *uniquifier = [[NSPopUpButton alloc] initWithFrame:NSMakeRect(0,0,0,0) pullsDown:YES];
-		[uniquifier addItemsWithTitles:[prefs objectForKey:SPQueryHistory]];
-		[uniquifier insertItemWithTitle:history atIndex:0];
-
-		while ( (NSUInteger)[uniquifier numberOfItems] > maxHistoryItems )
-			[uniquifier removeItemAtIndex:[uniquifier numberOfItems]-1];
-
-		[prefs setObject:[uniquifier itemTitles] forKey:SPQueryHistory];
-		[uniquifier release];
-	}
-#endif
-}
-
-- (NSMutableArray *)favoritesForFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([favoritesContainer objectForKey:[fileURL absoluteString]])
-		return [favoritesContainer objectForKey:[fileURL absoluteString]];
-#endif
-
-	return [NSMutableArray array];
-}
-
-- (NSMutableArray *)historyForFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([historyContainer objectForKey:[fileURL absoluteString]])
-		return [historyContainer objectForKey:[fileURL absoluteString]];
-#endif
-
-	return [NSMutableArray array];
-}
-
-- (NSArray *)historyMenuItemsForFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([historyContainer objectForKey:[fileURL absoluteString]]) {
-		NSMutableArray *returnArray = [NSMutableArray arrayWithCapacity:[[historyContainer objectForKey:[fileURL absoluteString]] count]];
-		NSMenuItem *historyMenuItem;
-		for(NSString* history in [historyContainer objectForKey:[fileURL absoluteString]]) {
-			historyMenuItem = [[[NSMenuItem alloc] initWithTitle:([history length] > 64) ? [NSString stringWithFormat:@"%@…", [history substringToIndex:63]] : history
-			 											action:NULL
-												keyEquivalent:@""] autorelease];
-			[historyMenuItem setToolTip:([history length] > 256) ? [NSString stringWithFormat:@"%@…", [history substringToIndex:255]] : history];
-			[returnArray addObject:historyMenuItem];
-		}
-
-		return returnArray;
-	}
-#endif
-
-	return [NSArray array];
-}
-
-/**
- * Return the number of history items for the passed file URL
- *
- * @param fileURL The NSURL of the current active SPDatabaseDocument
- *
- */
-- (NSUInteger)numberOfHistoryItemsForFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([historyContainer objectForKey:[fileURL absoluteString]])
-		return [[historyContainer objectForKey:[fileURL absoluteString]] count];
-	else
-#endif
-		return 0;
-}
-
-/**
- * Return a mutable dictionary of all content filters for the passed file URL.
- * If no content filters were found it returns an empty mutable dictionary.
- *
- * @param fileURL The NSURL of the current active SPDatabaseDocument
- *
- */
-- (NSMutableDictionary *)contentFilterForFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	if([contentFilterContainer objectForKey:[fileURL absoluteString]])
-		return [contentFilterContainer objectForKey:[fileURL absoluteString]];
-#endif
-
-	return [NSMutableDictionary dictionary];
-}
-
-- (NSArray *)queryFavoritesForFileURL:(NSURL *)fileURL andTabTrigger:(NSString *)tabTrigger includeGlobals:(BOOL)includeGlobals
-{
-	if(![tabTrigger length]) return [NSArray array];
-
-	NSMutableArray *result = [[NSMutableArray alloc] init];
-	for(id fav in [self favoritesForFileURL:fileURL]) {
-		if([fav objectForKey:@"tabtrigger"] && [[fav objectForKey:@"tabtrigger"] isEqualToString:tabTrigger])
-			[result addObject:fav];
-	}
-
-#ifndef SP_REFACTOR
-	if(includeGlobals && [prefs objectForKey:SPQueryFavorites]) {
-		for(id fav in [prefs objectForKey:SPQueryFavorites]) {
-			if([fav objectForKey:@"tabtrigger"] && [[fav objectForKey:@"tabtrigger"] isEqualToString:tabTrigger]) {
-				[result addObject:fav];
-				break;
-			}
-		}
-	}
-#endif
-
-	return [result autorelease];
-}
-
-/**
- * Remove a Query Favorite the passed file URL
- *
- * @param index The index of the to be removed favorite
- *
- * @param fileURL The NSURL of the current active SPDatabaseDocument
- *
- */
-- (void)removeFavoriteAtIndex:(NSUInteger)index forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	[[favoritesContainer objectForKey:[fileURL absoluteString]] removeObjectAtIndex:index];
-#endif
-}
-
-- (void)insertFavorite:(NSDictionary *)favorite atIndex:(NSUInteger)index forFileURL:(NSURL *)fileURL
-{
-#ifndef SP_REFACTOR
-	[[favoritesContainer objectForKey:[fileURL absoluteString]] insertObject:favorite atIndex:index];
-#endif
-}
-
-#pragma mark -
-
-/**
- * Dealloc.
- */
-- (void)dealloc
-{
-#ifndef SP_REFACTOR
-	messagesVisibleSet = nil;
-#endif
-	[NSObject cancelPreviousPerformRequestsWithTarget:self];
-
-#ifndef SP_REFACTOR
-	[dateFormatter release], dateFormatter = nil;
-
-	[messagesFullSet release], messagesFullSet = nil;
-	[messagesFilteredSet release], messagesFilteredSet = nil;
-	[activeFilterString release], activeFilterString = nil;
-
-	[favoritesContainer release], favoritesContainer = nil;
-	[historyContainer release], historyContainer = nil;
-	[contentFilterContainer release], contentFilterContainer = nil;
-#endif
-
-	if(completionKeywordList) [completionKeywordList release];
-	if(completionFunctionList) [completionFunctionList release];
-	if(functionArgumentSnippets) [functionArgumentSnippets release];
-	
-#ifndef SP_REFACTOR
-	pthread_mutex_destroy(&consoleLock);
-#endif
-	
-	[super dealloc];
-}
-
-@end
-
-@implementation SPQueryController (PrivateAPI)
-
-/**
  * Updates the filtered result set based on any filter string and whether or not
  * all SELECT nd SHOW statements should be shown within the console.
  */
 - (void)_updateFilterState
 {
 #ifndef SP_REFACTOR
-
 	// Display start progress spinner
 	[progressIndicator setHidden:NO];
 	[progressIndicator startAnimation:self];
-
+	
 	// Don't allow clearing the console while filtering its content
 	[saveConsoleButton setEnabled:NO];
 	[clearConsoleButton setEnabled:NO];
-
+	
 	[messagesFilteredSet removeAllObjects];
-
+	
 	// If filtering is disabled and all show/selects are shown, empty the filtered
 	// result set and set the full set to visible.
 	if (!filterIsActive && !showSelectStatementsAreDisabled && !showHelpStatementsAreDisabled) {
 		messagesVisibleSet = messagesFullSet;
-
+		
 		[consoleTableView reloadData];
 		[consoleTableView scrollRowToVisible:([messagesVisibleSet count] - 1)];
-
+		
 		[saveConsoleButton setEnabled:YES];
 		[clearConsoleButton setEnabled:YES];
-
+		
 		[saveConsoleButton setTitle:NSLocalizedString(@"Save As...", @"save as button title")];
-
+		
 		// Hide progress spinner
 		[progressIndicator setHidden:YES];
 		[progressIndicator stopAnimation:self];
+		
 		return;
 	}
-
+	
 	// Cache frequently used selector, avoiding dynamic binding overhead
 	IMP messageMatchesFilters = [self methodForSelector:@selector(_messageMatchesCurrentFilters:)];
-
+	
 	// Loop through all the messages in the full set to determine which should be
 	// added to the filtered set.
 	for (SPConsoleMessage *message in messagesFullSet) {
-
+		
 		// Add a reference to the message to the filtered set if filters are active and the
 		// current message matches them
 		if ((messageMatchesFilters)(self, @selector(_messageMatchesCurrentFilters:), [message message])) {
 			[messagesFilteredSet addObject:message];
 		}
 	}
-
+	
 	// Ensure that the filtered set is marked as the currently visible set.
 	messagesVisibleSet = messagesFilteredSet;
-
+	
 	[consoleTableView reloadData];
 	[consoleTableView scrollRowToVisible:([messagesVisibleSet count] - 1)];
-
+	
 	if ([messagesVisibleSet count] > 0) {
 		[saveConsoleButton setEnabled:YES];
 		[clearConsoleButton setEnabled:YES];
 	}
-
+	
 	[saveConsoleButton setTitle:NSLocalizedString(@"Save View As...", @"save view as button title")];
-
+	
 	// Hide progress spinner
 	[progressIndicator setHidden:YES];
 	[progressIndicator stopAnimation:self];
@@ -1010,32 +485,27 @@ static SPQueryController *sharedQueryController = nil;
 - (BOOL)_messageMatchesCurrentFilters:(NSString *)message
 {
 	BOOL messageMatchesCurrentFilters = YES;
-
+	
 #ifndef SP_REFACTOR
 	// Check whether to hide the message based on the current filter text, if any
-	if (filterIsActive
-		&& [message rangeOfString:activeFilterString options:NSCaseInsensitiveSearch].location == NSNotFound)
-	{
+	if (filterIsActive && [message rangeOfString:activeFilterString options:NSCaseInsensitiveSearch].location == NSNotFound) {
 		messageMatchesCurrentFilters = NO;
 	}
-
+	
 	// If hiding SELECTs and SHOWs is toggled to on, check whether the message is a SELECT or SHOW
-	if (messageMatchesCurrentFilters
-		&& showSelectStatementsAreDisabled
-		&& ([[message uppercaseString] hasPrefix:@"SELECT"] || [[message uppercaseString] hasPrefix:@"SHOW"]))
+	if (messageMatchesCurrentFilters && 
+		showSelectStatementsAreDisabled && 
+		([[message uppercaseString] hasPrefix:@"SELECT"] || [[message uppercaseString] hasPrefix:@"SHOW"]))
 	{
 		messageMatchesCurrentFilters = NO;
 	}
-
+	
 	// If hiding HELP is toggled to on, check whether the message is a HELP
-	if (messageMatchesCurrentFilters
-		&& showHelpStatementsAreDisabled
-		&& ([[message uppercaseString] hasPrefix:@"HELP"]))
-	{
+	if (messageMatchesCurrentFilters && showHelpStatementsAreDisabled && ([[message uppercaseString] hasPrefix:@"HELP"])) {
 		messageMatchesCurrentFilters = NO;
 	}
 #endif
-
+	
 	return messageMatchesCurrentFilters;
 }
 
@@ -1046,30 +516,29 @@ static SPQueryController *sharedQueryController = nil;
 - (NSString *)_getConsoleStringWithTimeStamps:(BOOL)timeStamps connections:(BOOL)connections
 {
 	NSMutableString *consoleString = [NSMutableString string];
-
+	
 #ifndef SP_REFACTOR
 	for (SPConsoleMessage *message in messagesVisibleSet)
 	{
 		// As we are going to save the messages as an SQL file we need to comment
 		// the timestamps and connections if included.
 		if (timeStamps || connections) [consoleString appendString:@"/* "];
-
+		
 		// If the timestamp column is not hidden we need to include them in the copy
 		if (timeStamps)
 			[consoleString appendFormat:@"%@ ", [dateFormatter stringFromDate:[message messageDate]]];
-
+		
 		// If the connection column is not hidden we need to include them in the copy
 		if (connections)
 			[consoleString appendFormat:@"%@ ", [message messageConnection]];
-
+		
 		// Close the comment
 		if (timeStamps || connections) [consoleString appendString:@"*/ "];
-
+		
 		[consoleString appendFormat:@"%@\n", [message message]];
-
 	}
 #endif
-
+	
 	return consoleString;
 }
 
@@ -1080,20 +549,18 @@ static SPQueryController *sharedQueryController = nil;
 {
 #ifndef SP_REFACTOR
 	NSString *messageTemp = [[message stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] stringByReplacingOccurrencesOfString:@"\n" withString:@" "];
-
+	
 	// Only append a semi-colon (;) if the supplied message is not an error
-	if (!error) {
-		messageTemp = [messageTemp stringByAppendingString:@";"];
-	}
-
+	if (!error) messageTemp = [messageTemp stringByAppendingString:@";"];
+	
 	SPConsoleMessage *consoleMessage = [SPConsoleMessage consoleMessageWithMessage:messageTemp date:[NSDate date] connection:connection];
-
+	
 	[consoleMessage setIsError:error];
-
+	
 	pthread_mutex_lock(&consoleLock);
 	
 	[messagesFullSet addObject:consoleMessage];
-
+	
 	// If filtering is active, determine whether to add a reference to the filtered set
 	if ((showSelectStatementsAreDisabled || showHelpStatementsAreDisabled || filterIsActive)
 		&& [self _messageMatchesCurrentFilters:[consoleMessage message]])
@@ -1102,7 +569,7 @@ static SPQueryController *sharedQueryController = nil;
 		[saveConsoleButton setEnabled:YES];
 		[clearConsoleButton setEnabled:YES];
 	}
-
+	
 	// Reload the table and scroll to the new message if it's visible (for speed)
 	if (allowConsoleUpdate && [[self window] isVisible]) {
 		[consoleTableView noteNumberOfRowsChanged];
@@ -1114,4 +581,39 @@ static SPQueryController *sharedQueryController = nil;
 #endif
 }
 
+#pragma mark -
+
+/**
+ * Dealloc.
+ */
+- (void)dealloc
+{
+#ifndef SP_REFACTOR
+	messagesVisibleSet = nil;
+#endif
+	[NSObject cancelPreviousPerformRequestsWithTarget:self];
+
+#ifndef SP_REFACTOR
+	[dateFormatter release], dateFormatter = nil;
+
+	[messagesFullSet release], messagesFullSet = nil;
+	[messagesFilteredSet release], messagesFilteredSet = nil;
+	[activeFilterString release], activeFilterString = nil;
+
+	[favoritesContainer release], favoritesContainer = nil;
+	[historyContainer release], historyContainer = nil;
+	[contentFilterContainer release], contentFilterContainer = nil;
+#endif
+
+	if (completionKeywordList) [completionKeywordList release], completionKeywordList = nil;
+	if (completionFunctionList) [completionFunctionList release], completionFunctionList = nil; 
+	if (functionArgumentSnippets) [functionArgumentSnippets release], functionArgumentSnippets = nil;
+	
+#ifndef SP_REFACTOR
+	pthread_mutex_destroy(&consoleLock);
+#endif
+	
+	[super dealloc];
+}
+
 @end