RTKRevision.m

   1 //
   2 //   RTKRevision.m
   3 //   (CleverRabbit.app)
   4 //
   5 //   Copyright (c) 2005 A. Karl Keller (http://karlk.net)
   6 //
   7 //   This code is open-source, free software, made available without warranty under
   8 //   the terms of the GNU General Public License, either version 2 or later (see
   9 //   http://www.gnu.org/licenses/gpl.html or included copy); as such, it may be
  10 //   redistributed and/or modified in accordance with that document.
  11 //
  12
  13
  14
  15 #import "RTKRevision.h"
  16 #import "RTKStringCategory.h"
  17 #import "RTKMutableAttributedStringCategory.h"
  18 #import "Chomp/Chomp.h"
  19
  20
  21 @implementation RTKRevision
  22
  23 - (id)init
  24 {
  25     if(self = [super init]) {
  26         roman = @"";
  27         script = @"";
  28         backTranslation = @"";
  29         notes = @"";
  30         checking = @"";
  31                 locked = NO;
  32
  33         [self setDictionary:[NSDictionary dictionary]];
  34     }
  35     return self;
  36 }
  37
  38 - (id)initWithDictionary:(NSDictionary *)dict
  39 {
  40     if(self = [self init]) {
  41         [self setRoman:[dict objectForKey:@"roman"]];
  42         [self setScript:[dict objectForKey:@"script"]];
  43         [self setBackTranslation:[dict objectForKey:@"backTranslation"]];
  44         [self setNotes:[dict objectForKey:@"notes"]];
  45         [self setChecking:[dict objectForKey:@"checking"]];
  46                 [self setLocked:[[dict objectForKey:@"locked"] intValue]];
  47
  48         [self setDictionary:dict];
  49     }
  50     return self;
  51 }
  52
  53
  54 + (RTKRevision *)revisionWithDictionary:(NSDictionary *)dict
  55 {
  56     return [[[RTKRevision alloc] initWithDictionary:dict] autorelease];
  57 }
  58
  59
  60 - (id)initWithString:(NSString *)string
  61 {
  62     if(self = [self init]) {
  63         NSEnumerator * e = [[string componentsSeparatedByString:[[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextDelimiter"]] objectEnumerator];
  64
  65         [self setScript:[self stringFromTextSafeString:[e nextObject]]];
  66         [self setRoman:[self stringFromTextSafeString:[e nextObject]]];
  67         [self setBackTranslation:[self stringFromTextSafeString:[e nextObject]]];
  68         [self setNotes:[self stringFromTextSafeString:[e nextObject]]];
  69         [self setChecking:[self stringFromTextSafeString:[e nextObject]]];
  70     }
  71     return self;
  72 }
  73
  74 + (RTKRevision *)revisionWithString:string
  75 {
  76     return [[[RTKRevision alloc] initWithString:string] autorelease];
  77 }
  78
  79
  80 - (id)initWithSFMString:(NSString *)string
  81 {
  82     if(self = [self init]) {
  83         [self setRoman:string];
  84     }
  85     return self;
  86 }
  87
  88 + (RTKRevision *)revisionWithSFMString:string
  89 {
  90     return [[[RTKRevision alloc] initWithSFMString:string] autorelease];
  91 }
  92
  93 - (void)appendLine:(NSString *)line
  94 {
  95     [self setRoman:[NSString stringWithFormat:@"%@\n%@", roman, line]];
  96 }
  97
  98 - (void)dealloc
  99 {
 100     [script release];
 101     [roman release];
 102     [backTranslation release];
 103     [notes release];
 104     [checking release];
 105
 106     [dictionary release];
 107
 108     [super dealloc];
 109 }
 110
 111
 112 - (id)deepCopy
 113 {
 114     RTKRevision * copy = [[[RTKRevision alloc] init] autorelease];
 115
 116     // Should be safe, since NSString is immutable.
 117     [copy setScript:script];
 118     [copy setRoman:roman];
 119     [copy setBackTranslation:backTranslation];
 120     [copy setNotes:notes];
 121     [copy setChecking:checking];
 122         [copy setLocked:locked];
 123
 124     [copy setDictionary:dictionary];
 125
 126     return copy;
 127 }
 128
 129
 130 - (NSMutableDictionary *)dictionaryRepresentation
 131 {
 132     NSMutableDictionary * dict = [NSMutableDictionary dictionaryWithDictionary:dictionary];
 133
 134     [dict setObject:roman forKey:@"roman"];
 135     [dict setObject:script forKey:@"script"];
 136     [dict setObject:backTranslation forKey:@"backTranslation"];
 137     [dict setObject:notes forKey:@"notes"];
 138     [dict setObject:checking forKey:@"checking"];
 139         [dict setObject:[NSNumber numberWithInt:locked] forKey:@"locked"];
 140
 141     return dict;
 142 }
 143
 144
 145 - (NSMutableString *)textSafeStringForString:(NSString *)string;
 146 {
 147     NSMutableString * textSafeString = [string mutableCopy];
 148
 149     [textSafeString replaceOccurrencesOfString:[NSString stringWithFormat:@"%C", 0x2028] // LINE SEPARATOR
 150                                     withString:[[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextReturnCharacter"]
 151                                        options:NSLiteralSearch
 152                                          range:NSMakeRange(0,[string length])];
 153
 154     [textSafeString replaceOccurrencesOfString:@"\n" // newline
 155                                     withString:[[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextReturnCharacter"]
 156                                        options:NSLiteralSearch
 157                                          range:NSMakeRange(0,[string length])];
 158
 159     [textSafeString replaceOccurrencesOfString:@"\r" // return
 160                                     withString:[[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextReturnCharacter"]
 161                                        options:NSLiteralSearch
 162                                          range:NSMakeRange(0,[string length])];
 163
 164     return textSafeString;
 165 }
 166
 167
 168 - (NSMutableString *)stringFromTextSafeString:(NSString *)textSafeString;
 169 {
 170     NSMutableString * string = [textSafeString mutableCopy];
 171
 172     [string replaceOccurrencesOfString:[[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextReturnCharacter"]
 173                             withString:@"\n" // newline -- just go with standard unix way
 174                                options:NSLiteralSearch
 175                                  range:NSMakeRange(0,[string length])];
 176     if(!string)
 177         string = [NSMutableString stringWithString:@""];  // AKK 2012
 178
 179     return string;
 180 }
 181
 182 - (NSString *)stringWithVerseNumber:(NSString *)verseNumber
 183 {
 184     NSMutableString * string = [NSMutableString new];
 185     NSString * delimiter = [[NSUserDefaults standardUserDefaults] objectForKey:@"RTKPlainTextDelimiter"];
 186     if(!verseNumber)
 187         verseNumber = @"";
 188
 189     [string appendString:[self textSafeStringForString:[verseNumber stringByAppendingString:script]]];
 190     [string appendString:delimiter];
 191     [string appendString:[self textSafeStringForString:[verseNumber stringByAppendingString:roman]]];
 192     [string appendString:delimiter];
 193     [string appendString:[self textSafeStringForString:backTranslation]];
 194     [string appendString:delimiter];
 195     [string appendString:[self textSafeStringForString:notes]];
 196     [string appendString:delimiter];
 197     [string appendString:[self textSafeStringForString:checking]];
 198
 199     return string;
 200 }
 201
 202 - (NSMutableAttributedString *)mutableAttributedString:(BOOL)romanString
 203 {
 204     // TODO: Add support for transliteration.
 205     NSMutableAttributedString * string = [[NSMutableAttributedString alloc] initWithString:(romanString ? roman : script)];
 206     // Provide a link back from the string to this object.
 207     [string addAttribute:@"RTKRevision" value:self];
 208     return string;
 209 }
 210
 211
 212 - (void)setDictionary:(NSDictionary *)theDictionary
 213 {
 214     [theDictionary retain];
 215     [dictionary release];
 216     dictionary = theDictionary;
 217 }
 218
 219 - (NSDictionary *)dictionary
 220 {
 221     return dictionary;
 222 }
 223
 224
 225 - (RTKRevision *)copy
 226 {
 227     return [self deepCopy];
 228 }
 229
 230
 231 - (NSString *)roman
 232 {
 233     return roman;
 234 }
 235
 236
 237 - (NSString *)script
 238 {
 239     return script;
 240 }
 241
 242
 243 - (NSString *)backTranslation
 244 {
 245     return backTranslation;
 246 }
 247
 248
 249 - (NSString *)notes
 250 {
 251     return notes;
 252 }
 253
 254
 255 - (NSString *)checking
 256 {
 257     return checking;
 258 }
 259
 260
 261 - (BOOL)locked
 262 {
 263         return locked;
 264 }
 265
 266
 267 - (void)setRoman:(NSString *)string
 268 {
 269     [string retain];
 270     [roman release];
 271     roman = string;
 272
 273     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetRoman" object:self userInfo:nil];
 274 }
 275
 276 - (void)setScript:(NSString *)string
 277 {
 278     [string retain];
 279     [script release];
 280     script = string;
 281
 282     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetScript" object:self userInfo:nil];
 283 }
 284
 285 - (void)setBackTranslation:(NSString *)string
 286 {
 287     [string retain];
 288     [backTranslation release];
 289     backTranslation = string;
 290
 291     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetBackTranslation" object:self userInfo:nil];
 292 }
 293
 294 - (void)setNotes:(NSString *)string
 295 {
 296     [string retain];
 297     [notes release];
 298     notes = string;
 299
 300     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetNotes" object:self userInfo:nil];
 301 }
 302
 303 - (void)setChecking:(NSString *)string
 304 {
 305     [string retain];
 306     [checking release];
 307     checking = string;
 308
 309     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetChecking" object:self userInfo:nil];
 310 }
 311
 312 - (void)setLocked:(bool)state
 313 {
 314         locked = state;
 315
 316     [[NSNotificationCenter defaultCenter] postNotificationName:@"RTKRevisionSetLocked" object:self userInfo:nil];
 317 }
 318
 319
 320 // Returns YES if all fields are still set to default values.
 321 - (BOOL)blank
 322 {
 323     //if(![script isEqualToString:@""])
 324     //    return NO;
 325     if(![roman isEqualToString:@""])
 326         return NO;
 327     if(![backTranslation isEqualToString:@""])
 328         return NO;
 329     if(![notes isEqualToString:@""])
 330         return NO;
 331     if(![checking isEqualToString:@""])
 332         return NO;
 333     if(locked)
 334         return NO;
 335
 336     return YES;
 337 }
 338
 339 - (BOOL)matchesString:(NSString *)string
 340 {
 341     if([script containsCaseInsensitiveSubstring:string])
 342         return YES;
 343     if([roman containsCaseInsensitiveSubstring:string])
 344         return YES;
 345     if([backTranslation containsCaseInsensitiveSubstring:string])
 346         return YES;
 347     if([notes containsCaseInsensitiveSubstring:string])
 348         return YES;
 349     if([checking containsCaseInsensitiveSubstring:string])
 350         return YES;
 351     return NO;
 352 }
 353
 354
 355 @end