From http://www.jwz.org/xscreensaver/xscreensaver-5.18.tar.gz
[xscreensaver] / OSX / PrefsReader.m
1 /* xscreensaver, Copyright (c) 2006-2012 Jamie Zawinski <jwz@jwz.org>
2  *
3  * Permission to use, copy, modify, distribute, and sell this software and its
4  * documentation for any purpose is hereby granted without fee, provided that
5  * the above copyright notice appear in all copies and that both that
6  * copyright notice and this permission notice appear in supporting
7  * documentation.  No representations are made about the suitability of this
8  * software for any purpose.  It is provided "as is" without express or 
9  * implied warranty.
10  */
11
12 /* This implements the substrate of the xscreensaver preferences code:
13    It does this by writing defaults to, and reading values from, the
14    NSUserDefaultsController (and ScreenSaverDefaults/NSUserDefaults)
15    and thereby reading the preferences that may have been edited by
16    the UI (XScreenSaverConfigSheet).
17  */
18
19 #ifndef USE_IPHONE
20 # import <ScreenSaver/ScreenSaverDefaults.h>
21 #endif
22
23 #import "PrefsReader.h"
24 #import "screenhackI.h"
25
26 @implementation PrefsReader
27
28 /* Normally we read resources by looking up "KEY" in the database
29    "org.jwz.xscreensaver.SAVERNAME".  But in the all-in-one iPhone
30    app, everything is stored in the database "org.jwz.xscreensaver"
31    instead, so transform keys to "SAVERNAME.KEY".
32
33    NOTE: This is duplicated in XScreenSaverConfigSheet.m, cause I suck.
34 */
35 - (NSString *) makeKey:(NSString *)key
36 {
37 # ifdef USE_IPHONE
38   NSString *prefix = [saver_name stringByAppendingString:@"."];
39   if (! [key hasPrefix:prefix])  // Don't double up!
40     key = [prefix stringByAppendingString:key];
41 # endif
42   return key;
43 }
44
45 - (NSString *) makeCKey:(const char *)key
46 {
47   return [self makeKey:[NSString stringWithCString:key
48                                  encoding:NSUTF8StringEncoding]];
49 }
50
51
52 /* Converts an array of "key:value" strings to an NSDictionary.
53  */
54 - (NSDictionary *) defaultsToDict: (const char * const *) defs
55 {
56   NSDictionary *dict = [NSMutableDictionary dictionaryWithCapacity:20];
57   while (*defs) {
58     char *line = strdup (*defs);
59     char *key, *val;
60     key = line;
61     while (*key == '.' || *key == '*' || *key == ' ' || *key == '\t')
62       key++;
63     val = key;
64     while (*val && *val != ':')
65       val++;
66     if (*val != ':') abort();
67     *val++ = 0;
68     while (*val == ' ' || *val == '\t')
69       val++;
70
71     int L = strlen(val);
72     while (L > 0 && (val[L-1] == ' ' || val[L-1] == '\t'))
73       val[--L] = 0;
74
75     // When storing into preferences, look at the default string and
76     // decide whether it's a boolean, int, float, or string, and store
77     // an object of the appropriate type in the prefs.
78     //
79     NSString *nskey = [self makeCKey:key];
80     NSObject *nsval;
81     int dd;
82     double ff;
83     char cc;
84     if (!strcasecmp (val, "true") || !strcasecmp (val, "yes"))
85       nsval = [NSNumber numberWithBool:YES];
86     else if (!strcasecmp (val, "false") || !strcasecmp (val, "no"))
87       nsval = [NSNumber numberWithBool:NO];
88     else if (1 == sscanf (val, " %d %c", &dd, &cc))
89       nsval = [NSNumber numberWithInt:dd];
90     else if (1 == sscanf (val, " %lf %c", &ff, &cc))
91       nsval = [NSNumber numberWithDouble:ff];
92     else
93       nsval = [NSString stringWithCString:val encoding:NSUTF8StringEncoding];
94       
95 //    NSLog (@"default: \"%@\" = \"%@\" [%@]", nskey, nsval, [nsval class]);
96     [dict setValue:nsval forKey:nskey];
97     free (line);
98     defs++;
99   }
100   return dict;
101 }
102
103
104 /* Initialize the Cocoa preferences database:
105    - sets the default preferences values from the 'defaults' array;
106    - binds 'self' to each preference as an observer;
107    - ensures that nothing is mentioned in 'options' and not in 'defaults';
108    - ensures that nothing is mentioned in 'defaults' and not in 'options'.
109  */
110 - (void) registerXrmKeys: (const XrmOptionDescRec *) opts
111                 defaults: (const char * const *) defs
112 {
113   // Store the contents of 'defaults' into the real preferences database.
114   NSDictionary *defsdict = [self defaultsToDict:defs];
115   [userDefaults registerDefaults:defsdict];
116
117   // Save a copy of the default options, since iOS doesn't have
118   // [userDefaultsController initialValues].
119   //
120   if (defaultOptions) 
121     [defaultOptions release];
122   defaultOptions = [[NSMutableDictionary dictionaryWithCapacity:20]
123                      retain];
124   for (NSString *key in defsdict) {
125     [defaultOptions setValue:[defsdict objectForKey:key] forKey:key];
126   }
127
128 # ifndef USE_IPHONE
129   userDefaultsController = 
130     [[NSUserDefaultsController alloc] initWithDefaults:userDefaults
131                                       initialValues:defsdict];
132 # else  // USE_IPHONE
133   userDefaultsController = userDefaults;
134 # endif // USE_IPHONE
135
136   NSDictionary *optsdict = [NSMutableDictionary dictionaryWithCapacity:20];
137
138   while (opts[0].option) {
139     //const char *option   = opts->option;
140     const char *resource = opts->specifier;
141     
142     while (*resource == '.' || *resource == '*')
143       resource++;
144     NSString *nsresource = [self makeCKey:resource];
145     
146     // make sure there's no resource mentioned in options and not defaults.
147     if (![defsdict objectForKey:nsresource]) {
148       if (! (!strcmp(resource, "font")        ||    // don't warn about these
149              !strcmp(resource, "textLiteral") ||
150              !strcmp(resource, "textFile")    ||
151              !strcmp(resource, "textURL")     ||
152              !strcmp(resource, "textProgram") ||
153              !strcmp(resource, "imageDirectory")))
154         NSLog (@"warning: \"%s\" is in options but not defaults", resource);
155     }
156     [optsdict setValue:nsresource forKey:nsresource];
157     
158     opts++;
159   }
160
161 #if 0
162   // make sure there's no resource mentioned in defaults and not options.
163   for (NSString *key in defsdict) {
164     if (! [optsdict objectForKey:key])
165       if (! ([key isEqualToString:@"foreground"] || // don't warn about these
166              [key isEqualToString:@"background"] ||
167              [key isEqualToString:@"Background"] ||
168              [key isEqualToString:@"geometry"] ||
169              [key isEqualToString:@"font"] ||
170              [key isEqualToString:@"dontClearRoot"] ||
171
172              // fps.c settings
173              [key isEqualToString:@"fpsSolid"] ||
174              [key isEqualToString:@"fpsTop"] ||
175              [key isEqualToString:@"titleFont"] ||
176
177              // analogtv.c settings
178              [key isEqualToString:@"TVBrightness"] ||
179              [key isEqualToString:@"TVColor"] ||
180              [key isEqualToString:@"TVContrast"] ||
181              [key isEqualToString:@"TVTint"]
182              ))
183       NSLog (@"warning: \"%@\" is in defaults but not options", key);
184   }
185 #endif /* 0 */
186
187 #if 0
188   // Dump the entire resource database.
189   NSDictionary *d = [userDefaults dictionaryRepresentation];
190   for (NSObject *key in [[d allKeys]
191                           sortedArrayUsingSelector:@selector(compare:)]) {
192     NSObject *val = [d objectForKey:key];
193     NSLog (@"%@ = %@", key, val);
194   }
195 #endif
196
197 }
198
199 - (NSUserDefaultsController *) userDefaultsController
200 {
201   NSAssert(userDefaultsController, @"userDefaultsController uninitialized");
202   return userDefaultsController;
203 }
204
205 - (NSDictionary *) defaultOptions
206 {
207   NSAssert(defaultOptions, @"userDefaultsController uninitialized");
208   return defaultOptions;
209 }
210
211
212 - (NSObject *) getObjectResource: (const char *) name
213 {
214   while (1) {
215     NSString *key = [self makeCKey:name];
216     NSObject *obj = [userDefaults objectForKey:key];
217     if (obj)
218       return obj;
219
220     // If key is "foo.bar.baz", check "foo.bar.baz", "bar.baz", and "baz".
221     //
222     const char *dot = strchr (name, '.');
223     if (dot && dot[1])
224       name = dot + 1;
225     else
226       return nil;
227   }
228 }
229
230
231 - (char *) getStringResource: (const char *) name
232 {
233   NSObject *o = [self getObjectResource:name];
234   //NSLog(@"%s = %@",name,o);
235   if (o == nil) {
236     if (! (!strcmp(name, "eraseMode") || // erase.c
237            // xlockmore.c reads all of these whether used or not...
238            !strcmp(name, "right3d") ||
239            !strcmp(name, "left3d") ||
240            !strcmp(name, "both3d") ||
241            !strcmp(name, "none3d") ||
242            !strcmp(name, "font") ||
243            !strcmp(name, "labelFont") ||  // grabclient.c
244            !strcmp(name, "titleFont") ||
245            !strcmp(name, "fpsFont") ||    // fps.c
246            !strcmp(name, "foreground") || // fps.c
247            !strcmp(name, "background") ||
248            !strcmp(name, "textLiteral")
249            ))
250       NSLog(@"warning: no preference \"%s\" [string]", name);
251     return NULL;
252   }
253   if (! [o isKindOfClass:[NSString class]]) {
254     NSLog(@"asked for %s as a string, but it is a %@", name, [o class]);
255     o = [(NSNumber *) o stringValue];
256   }
257
258   NSString *os = (NSString *) o;
259   char *result = strdup ([os cStringUsingEncoding:NSUTF8StringEncoding]);
260
261   // Kludge: if the string is surrounded with single-quotes, remove them.
262   // This happens when the .xml file says things like arg="-foo 'bar baz'"
263   if (result[0] == '\'' && result[strlen(result)-1] == '\'') {
264     result[strlen(result)-1] = 0;
265     strcpy (result, result+1);
266   }
267
268   // Kludge: assume that any string that begins with "~" and has a "/"
269   // anywhere in it should be expanded as if it is a pathname.
270   if (result[0] == '~' && strchr (result, '/')) {
271     os = [NSString stringWithCString:result encoding:NSUTF8StringEncoding];
272     free (result);
273     result = strdup ([[os stringByExpandingTildeInPath]
274                        cStringUsingEncoding:NSUTF8StringEncoding]);
275   }
276
277   return result;
278 }
279
280
281 - (double) getFloatResource: (const char *) name
282 {
283   NSObject *o = [self getObjectResource:name];
284   if (o == nil) {
285     // xlockmore.c reads all of these whether used or not...
286     if (! (!strcmp(name, "cycles") ||
287            !strcmp(name, "size") ||
288            !strcmp(name, "use3d") ||
289            !strcmp(name, "delta3d") ||
290            !strcmp(name, "wireframe") ||
291            !strcmp(name, "showFPS") ||
292            !strcmp(name, "fpsSolid") ||
293            !strcmp(name, "fpsTop") ||
294            !strcmp(name, "mono") ||
295            !strcmp(name, "count") ||
296            !strcmp(name, "ncolors") ||
297            !strcmp(name, "doFPS") ||      // fps.c
298            !strcmp(name, "eraseSeconds")  // erase.c
299            ))
300       NSLog(@"warning: no preference \"%s\" [float]", name);
301     return 0.0;
302   }
303   if ([o isKindOfClass:[NSString class]]) {
304     return [(NSString *) o doubleValue];
305   } else if ([o isKindOfClass:[NSNumber class]]) {
306     return [(NSNumber *) o doubleValue];
307   } else {
308     NSAssert2(0, @"%s = \"%@\" but should have been an NSNumber", name, o);
309     abort();
310   }
311 }
312
313
314 - (int) getIntegerResource: (const char *) name
315 {
316   // Sliders might store float values for integral resources; round them.
317   float v = [self getFloatResource:name];
318   int i = (int) (v + (v < 0 ? -0.5 : 0.5)); // ignore sign or -1 rounds to 0
319   // if (i != v) NSLog(@"%s: rounded %.3f to %d", name, v, i);
320   return i;
321 }
322
323
324 - (BOOL) getBooleanResource: (const char *) name
325 {
326   NSObject *o = [self getObjectResource:name];
327   if (! o) {
328     return NO;
329   } else if ([o isKindOfClass:[NSNumber class]]) {
330     double n = [(NSNumber *) o doubleValue];
331     if (n == 0) return NO;
332     else if (n == 1) return YES;
333     else goto FAIL;
334   } else if ([o isKindOfClass:[NSString class]]) {
335     NSString *s = (NSString *) o;
336     if ([s isEqualToString:@"true"] ||
337         [s isEqualToString:@"yes"] ||
338         [s isEqualToString:@"1"])
339       return YES;
340     else if ([s isEqualToString:@"false"] ||
341              [s isEqualToString:@"no"] ||
342              [s isEqualToString:@"0"] ||
343              [s isEqualToString:@""])
344       return NO;
345     else
346       goto FAIL;
347   } else {
348   FAIL:
349     NSAssert2(0, @"%s = \"%@\" but should have been a boolean", name, o);
350     abort();
351   }
352 }
353
354
355 - (id) initWithName: (NSString *) name
356             xrmKeys: (const XrmOptionDescRec *) opts
357            defaults: (const char * const *) defs
358 {
359   self = [self init];
360   if (!self) return nil;
361
362 # ifndef USE_IPHONE
363   userDefaults = [ScreenSaverDefaults defaultsForModuleWithName:name];
364 # else  // USE_IPHONE
365   userDefaults = [NSUserDefaults standardUserDefaults];
366 # endif // USE_IPHONE
367
368   // Convert "org.jwz.xscreensaver.NAME" to just "NAME".
369   NSRange r = [name rangeOfString:@"." options:NSBackwardsSearch];
370   if (r.length)
371     name = [name substringFromIndex:r.location+1];
372   name = [name stringByReplacingOccurrencesOfString:@" " withString:@""];
373   saver_name = [name retain];
374
375   [self registerXrmKeys:opts defaults:defs];
376   return self;
377 }
378
379 - (void) dealloc
380 {
381   [saver_name release];
382   [userDefaultsController release];
383   [super dealloc];
384 }
385
386 @end