The R Project SVN R-packages

/*

 *  R.app : a Cocoa front end to: "R A Computer Language for Statistical Data Analysis"

 *  

 *  R.app Copyright notes:

 *                     Copyright (C) 2004-12  The R Foundation

 *                     written by Stefano M. Iacus and Simon Urbanek

 *

 *                  

 *  R Copyright notes:

 *                     Copyright (C) 1995-1996   Robert Gentleman and Ross Ihaka

 *                     Copyright (C) 1998-2001   The R Development Core Team

 *                     Copyright (C) 2002-2004   The R Foundation

 *

 *  This program is free software; you can redistribute it and/or modify

 *  it under the terms of the GNU General Public License as published by

 *  the Free Software Foundation; either version 2 of the License, or

 *  (at your option) any later version.

 *

 *  This program is distributed in the hope that it will be useful,

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 *  GNU General Public License for more details.

 *

 *  A copy of the GNU General Public License is available via WWW at

 *  http://www.gnu.org/copyleft/gpl.html.  You can also obtain it by

 *  writing to the Free Software Foundation, Inc., 59 Temple Place,

 *  Suite 330, Boston, MA  02111-1307  USA.

 *

 *  RScriptEditorTextStorage.m

 *

 *  Created by Hans-J. Bibiko on 01/03/2012.

 *

 */

#import "RScriptEditorTextStorage.h"

#import "RScriptEditorTypeSetter.h"

#import "RScriptEditorTextView.h"

#import "FoldingSignTextAttachmentCell.h"

#import "RGUI.h"

@implementation RScriptEditorTextStorage

static NSTextAttachment *sharedAttachment = nil;

static SEL _getSel;

static SEL _setSel;

static SEL _strSel;

static SEL _replSel;

static SEL _editSel;

static SEL _getlSel;

+ (void)initialize

{

	if ([self class] == [RScriptEditorTextStorage class]) {

		FoldingSignTextAttachmentCell *cell = [[FoldingSignTextAttachmentCell alloc] initImageCell:nil];

		sharedAttachment = [[NSTextAttachment alloc] init];

		[sharedAttachment setAttachmentCell:cell];

		[cell release];

		_getSel  = @selector(attributesAtIndex:effectiveRange:);

		_setSel  = @selector(setAttributes:range:);

		_strSel  = @selector(string);

		_replSel = @selector(replaceCharactersInRange:withString:);

		_editSel = @selector(edited:range:changeInLength:);

		_getlSel = @selector(attribute:atIndex:longestEffectiveRange:inRange:);

	}

}

+ (NSTextAttachment *)attachment

{

	return sharedAttachment;

}

- (id)initWithDelegate:(id)theDelegate

{

	self = [super init];

	if (self != nil) {

		_attributedString = [[NSTextStorage alloc] init];

		selfDelegate = (RScriptEditorTextView*)theDelegate;

		[self setDelegate:theDelegate];

		foldedCounter = 0;

		currentMaxFoldedIndex = -1;

		for(NSInteger i = 0; i < R_MAX_FOLDED_ITEMS; i++) {

			foldedRanges[i][0] = -1;

			foldedRanges[i][1] = 0;

			foldedRanges[i][2] = 0;

		}

	}

	return self;

}

- (void)dealloc

{

	[[NSNotificationCenter defaultCenter] removeObserver:self];

	[_attributedString release];

	if(sharedAttachment) [sharedAttachment release];

	[super dealloc];

}

- (BOOL)hasFoldedItems

{

	return (foldedCounter == 0) ? NO : YES;

}

- (BOOL)inFoldedRangeForRange:(NSRange)range

{

	if(!foldedCounter) return NO;

	NSInteger i = 0;

	NSInteger maxRange = NSMaxRange(range);

	NSInteger rangeLoc = range.location;

	for(i = 0; i < currentMaxFoldedIndex+1; i++) {

		if(rangeLoc > foldedRanges[i][0] && maxRange <= foldedRanges[i][2]) {

			return YES;

		}

	}

	return NO;

}

- (NSInteger)foldedAtIndex:(NSInteger)index

{

	if(!foldedCounter) return -1;

	NSInteger i = 0;

	for(i = 0; i < currentMaxFoldedIndex+1; i++) {

		if(foldedRanges[i][2] > index && foldedRanges[i][0] <= index) {

			return i;

		}

	}

	return -1;

}

- (NSInteger)foldedForIndicatorAtIndex:(NSInteger)index

{

	if(!foldedCounter) return -1;

	if(index) {

		// Folded ranges are stored from { to } but indicator will drawn inside of { and }

		NSInteger adjIndex = index + 1;

		for(NSInteger i = 0; i < currentMaxFoldedIndex+1; i++) {

			if(foldedRanges[i][2] > adjIndex && foldedRanges[i][0] < index) {

				return i;

			}

		}

	}

	return -1;

}

- (NSInteger)registerFoldedRange:(NSRange)range

{

	[[selfDelegate undoManager] disableUndoRegistration];

	NSInteger index = -1;

	for(NSInteger i = 0; i < R_MAX_FOLDED_ITEMS; i++) {

		if(foldedRanges[i][0] == -1) {

			index = i;

			foldedRanges[i][0] = (NSInteger)range.location;

			foldedRanges[i][1] = (NSInteger)range.length;

			foldedRanges[i][2] = (NSInteger)NSMaxRange(range);

			foldedCounter++;

			if(i > currentMaxFoldedIndex) currentMaxFoldedIndex = i;

			SLog(@"RScriptEditorTextStorage:registerFoldedRange %@ at position %ld : max index %ld", NSStringFromRange(range), (long)i, (long)currentMaxFoldedIndex);

			break;

		}

	}

	[[selfDelegate undoManager] enableUndoRegistration];

	return(index);

}

- (BOOL)removeFoldedRangeWithIndex:(NSInteger)index

{

	BOOL exists = NO;

	NSRange range;

	SLog(@"RScriptEditorTextStorage:removeFoldedRangeWithIndex %ld", (long)index);

	if(index > -1 && index < R_MAX_FOLDED_ITEMS) {

		if(foldedRanges[index][0] > -1 && foldedRanges[index][1] > 0) {

			range = NSMakeRange(foldedRanges[index][0], foldedRanges[index][1]);

			exists = YES;

		}

	}

	if(!exists) {

		[self removeAllFoldedRanges];

		NSLog(@"Removing folded text chunk failed. For safety reasons all folded chunks were be unfolded.");

		return NO;

	}

	[[selfDelegate undoManager] disableUndoRegistration];

	range = NSIntersectionRange(NSMakeRange(0, [[_attributedString string] length]), range);

	if(range.length) {

		[self removeAttribute:NSCursorAttributeName range:range];

		[self removeAttribute:NSToolTipAttributeName range:range];

	}

	foldedRanges[index][0] = -1;

	foldedRanges[index][1] = 0;

	foldedRanges[index][2] = 0;

	foldedCounter--;

	if(foldedCounter < 0) foldedCounter = 0;

	// check folded chunks inside range

	NSInteger rloc = range.location;

	NSInteger maxrlen = NSMaxRange(range);

	NSRange r;

	for(NSInteger j = currentMaxFoldedIndex; j >= 0; j--) {

		if(foldedRanges[j][0] > rloc && foldedRanges[j][2] < maxrlen) {

			r = NSMakeRange(foldedRanges[j][0], foldedRanges[j][1]);

			foldedRanges[j][0] = -1;

			foldedRanges[j][1] = 0;

			foldedRanges[j][2] = 0;

			[selfDelegate refoldLinesInRange:r];

		}

	}

	[[selfDelegate undoManager] enableUndoRegistration];

	// update currentMaxFoldedIndex

	NSInteger maxCount = -1;

	for(NSInteger i = 0; i < R_MAX_FOLDED_ITEMS; i++) {

		if(foldedRanges[i][0] > -1) {

			if(i > maxCount) maxCount = i;

		}

	}

	currentMaxFoldedIndex = maxCount;

	SLog(@"RScriptEditorTextStorage:removeFoldedRangeWithIndex: done. Max index: %ld", (long) currentMaxFoldedIndex);

	return YES;

}

- (void)removeAllFoldedRanges

{

	[[selfDelegate undoManager] disableUndoRegistration];

	for(NSInteger i = 0; i < R_MAX_FOLDED_ITEMS; i++) {

		foldedRanges[i][0] = -1;

		foldedRanges[i][1] = 0;

		foldedRanges[i][2] = 0;

	}

	NSRange range = NSMakeRange(0, [_attributedString length]);

	[self removeAttribute:NSCursorAttributeName range:range];

	[self removeAttribute:NSToolTipAttributeName range:range];

	foldedCounter = 0;

	currentMaxFoldedIndex = -1;

	[[selfDelegate undoManager] enableUndoRegistration];

}

- (BOOL)existsFoldedRange:(NSRange)range

{

	if(!foldedCounter) return NO;

	BOOL success = NO;

	for(NSInteger i = 0; i < currentMaxFoldedIndex+1; i++) {

		if(foldedRanges[i][0] == range.location && foldedRanges[i][1] == range.length) {

			success = YES;

			break;

		}

	}

	return success;

}

- (NSRange)foldedRangeAtIndex:(NSInteger)index

{

	if(!foldedCounter || index < 0 || index > R_MAX_FOLDED_ITEMS) return NSMakeRange(NSNotFound, 0);

	NSInteger loc = foldedRanges[index][0];

	if(loc == -1) return NSMakeRange(NSNotFound, 0);

	return NSMakeRange(loc, foldedRanges[index][1]);

}

#pragma mark -

#pragma mark Primitives

- (NSString *)string

{ 

    return _attributedString ? [_attributedString string] : nil;

}

- (NSDictionary *)attributesAtIndex:(NSUInteger)location effectiveRange:(NSRangePointer)range

{

    NSDictionary *attributes = [_attributedString attributesAtIndex:location effectiveRange:range];

	if(!foldedCounter || location > [_attributedString length]) return attributes;

	NSRange effectiveRange;

	// Check if location is inside folded range for drawing indicator

	NSInteger index = -1;

	if(location) {

		// Notes folded ranges are stored from { to } but indicator will drawn inside of { and }

		NSInteger adjLocation = location + 2;

		for(NSInteger i = 0; i < currentMaxFoldedIndex+1; i++) {

			if(foldedRanges[i][2] > adjLocation && foldedRanges[i][0] < location) {

				index = i;

				break;

			}

		}

	}

	if (index > -1) {

		effectiveRange = NSMakeRange(foldedRanges[index][0]+1, foldedRanges[index][1]-2);

		// We adds NSAttachmentAttributeName if location is at beginning of folded range

		if (location == effectiveRange.location) { // beginning of a folded range

			NSMutableDictionary *dict = [attributes mutableCopyWithZone:NULL];

			[dict setObject:sharedAttachment forKey:NSAttachmentAttributeName];

			attributes = [dict autorelease];

			effectiveRange.length = 1;

		} else {

			++(effectiveRange.location); --(effectiveRange.length);

		}

		effectiveRange = NSIntersectionRange(effectiveRange, NSMakeRange(0, [_attributedString length]));

		if (range) *range = effectiveRange;

	}

	return attributes;

}

- (void)edited:(NSTextStorageEditActions)mask range:(NSRange)oldRange changeInLength:(NSInteger)lengthChange

{

	if(foldedCounter && mask == NSTextStorageEditedCharacters) {

		// update foldedRanges array due to changes

		NSInteger index = oldRange.location-1;

		NSInteger maxOldRange = NSMaxRange(oldRange) + 1;

		for(NSInteger i = 0; i < currentMaxFoldedIndex+1; i++) {

			if(index < foldedRanges[i][0]) {

				// if change covers the entire folded range -> delete it

				if(foldedRanges[i][2] < maxOldRange && foldedRanges[i][0] > index) {

					[self removeFoldedRangeWithIndex:i];

					continue;

				}

				// otherwise correct folded start range and maxrange

				foldedRanges[i][0] += lengthChange;

				foldedRanges[i][2] += lengthChange;

				// for safety delete it if new location is negative

				if(foldedRanges[i][0] < 0) {

					[self removeFoldedRangeWithIndex:i];

				}

			}

		}

	}

	[super edited:mask range:oldRange changeInLength:lengthChange];

}

// NSMutableAttributedString primitives

- (void)replaceCharactersInRange:(NSRange)range withString:(NSString *)str

{

    [_attributedString replaceCharactersInRange:range withString:str];

    [self edited:NSTextStorageEditedCharacters range:range changeInLength: [str length] - range.length];

}

- (void)setAttributes:(NSDictionary *)attrs range:(NSRange)range

{

    [_attributedString setAttributes:attrs range:range];

    [self edited:NSTextStorageEditedAttributes range:range changeInLength:0];

}

// Attribute Fixing Overrides

/*

- (void)fixAttributesInRange:(NSRange)range

{

	[super fixAttributesInRange:range];

	if(NSMaxRange(range) == 0) return;

	//	we want to avoid extending to the last paragraph separator

	NSDictionary *attributeDict;

	NSRange effectiveRange = { 0, 0 };

	NSUInteger idx = range.location;

	while (NSMaxRange(effectiveRange) < NSMaxRange(range)) {

		attributeDict = [_attributedString attributesAtIndex:idx

								   longestEffectiveRange:&effectiveRange

												 inRange:range];

		id value = [attributeDict objectForKey:foldingAttributeName];

		if (value && effectiveRange.length) {

			NSUInteger paragraphStart, paragraphEnd, contentsEnd;

			[[self string] getParagraphStart:&paragraphStart end:&paragraphEnd contentsEnd:&contentsEnd forRange:range];

			if ((NSMaxRange(range) == paragraphEnd) && (contentsEnd < paragraphEnd)) {

				[self removeAttribute:foldingAttributeName range:NSMakeRange(contentsEnd, paragraphEnd - contentsEnd)];

			}

		}

		idx = NSMaxRange(effectiveRange);

	}

	// 10.6 implementation

	// [self enumerateAttribute:lineFoldingAttributeName inRange:range options:0 usingBlock:^(id value, NSRange range, BOOL *stop) {

	// 	if (value && (range.length > 1)) {

	// 		NSUInteger paragraphStart, paragraphEnd, contentsEnd;

	// 		[[self string] getParagraphStart:&paragraphStart end:&paragraphEnd contentsEnd:&contentsEnd forRange:range];

	// 		if ((NSMaxRange(range) == paragraphEnd) && (contentsEnd < paragraphEnd)) {

	// 			[self removeAttribute:lineFoldingAttributeName range:NSMakeRange(contentsEnd, paragraphEnd - contentsEnd)];

	// 		}

	// 	}

	// }];

}

*/

@end