SCTextIndex.h

Go to the documentation of this file.

//
//  SCTextIndex.h
//  scl
//
//  Created by Viacheslav Smolensky on 06.02.13.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCCollectionProtocols.h>
#import <scl/SCService.h>

#pragma mark -
#pragma mark Class Constants

#define SCTextIndexClass    @"SCTextIndex"


@interface SCTextIndex : SCService {
    SCIndex _line;      // String number
    SCIndex _character; // Character number in string
}

@property (nonatomic, readwrite, assign) SCIndex line;

@property (nonatomic, readwrite, assign) SCIndex character;

#pragma mark -
#pragma mark Creating Text Indexes
+ (instancetype)textIndexWithCoder:(NSCoder *)coder;
+ (instancetype)textIndexWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)textIndexWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)textIndexWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)textIndexWithStream:(SCStream *)stream;
+ (instancetype)textIndexWithFileStream:(NSString *)path;
+ (instancetype)textIndexWithData:(NSData *)data;
+ (instancetype)textIndexWithContentsOfFile:(NSString *)path;
+ (instancetype)textIndexWithContentsOfURL:(NSURL *)url;
+ (instancetype)textIndexWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)textIndexWithLine:(SCIndex)line character:(SCIndex)character;
+ (instancetype)textIndexWithTextIndex:(SCTextIndex *)textIndex;
+ (instancetype)textIndex;

#pragma mark -
#pragma mark Initializing Text Indexes
- (instancetype)initWithLine:(SCIndex)line character:(SCIndex)character;
- (instancetype)initWithTextIndex:(SCTextIndex *)textIndex;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Text Indexes
- (void)setLine:(SCIndex)line character:(SCIndex)character;
- (void)setTextIndex:(SCTextIndex *)index;

#pragma mark -
#pragma mark Comparing Text Indexes
- (BOOL)isEqualToTextIndex:(SCTextIndex *)index;
- (BOOL)isEqualTo:(id)object;
- (BOOL)isEqual:(id)object;
- (BOOL)isEqualToLine:(SCIndex)line character:(SCIndex)character;

@end

#pragma mark -
#pragma mark Functions

SCTextIndex *SCMakeTextIndex( SCIndex line, SCIndex character);