source: variable.c @ f8074e9

release-1.6release-1.7release-1.8release-1.9
Last change on this file since f8074e9 was 66a8cd6, checked in by Anders Kaseorg <andersk@mit.edu>, 12 years ago
Copy structs without memcpy. Signed-off-by: Anders Kaseorg <andersk@mit.edu> Reviewed-by: Nelson Elhage <nelhage@mit.edu>
  • Property mode set to 100644
File size: 35.8 KB
Line 
1#include <stdio.h>
2#include <stdlib.h>
3#include <string.h>
4#include <unistd.h>
5#include <ctype.h>
6#include "owl.h"
7
8#define OWLVAR_BOOL(name,default,summary,description) \
9        { name, OWL_VARIABLE_BOOL, NULL, default, "on,off", summary,description, NULL, \
10        NULL, NULL, NULL, NULL, NULL, NULL }
11
12#define OWLVAR_BOOL_FULL(name,default,summary,description,validate,set,get) \
13        { name, OWL_VARIABLE_BOOL, NULL, default, "on,off", summary,description, NULL, \
14        validate, set, NULL, get, NULL, NULL }
15
16#define OWLVAR_INT(name,default,summary,description) \
17        { name, OWL_VARIABLE_INT, NULL, default, "<int>", summary,description, NULL, \
18        NULL, NULL, NULL, NULL, NULL, NULL }
19
20#define OWLVAR_INT_FULL(name,default,summary,description,validset,validate,set,get) \
21        { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \
22        validate, set, NULL, get, NULL, NULL }
23
24#define OWLVAR_PATH(name,default,summary,description) \
25        { name, OWL_VARIABLE_STRING, default, 0, "<path>", summary,description,  NULL, \
26        NULL, NULL, NULL, NULL, NULL, NULL }
27
28#define OWLVAR_STRING(name,default,summary,description) \
29        { name, OWL_VARIABLE_STRING, default, 0, "<string>", summary,description, NULL, \
30        NULL, NULL, NULL, NULL, NULL, NULL }
31
32#define OWLVAR_STRING_FULL(name,default,summary,description,validate,set,get) \
33        { name, OWL_VARIABLE_STRING, default, 0, "<string>", summary,description, NULL, \
34        validate, set, NULL, get, NULL, NULL }
35
36/* enums are really integers, but where validset is a comma-separated
37 * list of strings which can be specified.  The tokens, starting at 0,
38 * correspond to the values that may be specified. */
39#define OWLVAR_ENUM(name,default,summary,description,validset) \
40        { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \
41        owl_variable_enum_validate, \
42        NULL, owl_variable_enum_set_fromstring, \
43        NULL, owl_variable_enum_get_tostring, \
44        NULL }
45
46#define OWLVAR_ENUM_FULL(name,default,summary,description,validset,validate, set, get) \
47        { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \
48        validate, \
49        set, owl_variable_enum_set_fromstring, \
50        get, owl_variable_enum_get_tostring, \
51        NULL }
52
53static owl_variable variables_to_init[] = {
54
55  OWLVAR_STRING( "personalbell" /* %OwlVarStub */, "off",
56                 "ring the terminal bell when personal messages are received",
57                 "Can be set to 'on', 'off', or the name of a filter which\n"
58                 "messages need to match in order to ring the bell"),
59
60  OWLVAR_BOOL( "bell" /* %OwlVarStub */, 1,
61               "enable / disable the terminal bell", "" ),
62
63  OWLVAR_BOOL_FULL( "debug" /* %OwlVarStub */, OWL_DEBUG,
64                    "whether debugging is enabled",
65                    "If set to 'on', debugging messages are logged to the\n"
66                    "file specified by the debugfile variable.\n",
67                    NULL, owl_variable_debug_set, NULL),
68
69  OWLVAR_BOOL( "startuplogin" /* %OwlVarStub */, 1,
70               "send a login message when owl starts", "" ),
71
72  OWLVAR_BOOL( "shutdownlogout" /* %OwlVarStub */, 1,
73               "send a logout message when owl exits", "" ),
74
75  OWLVAR_BOOL( "rxping" /* %OwlVarStub */, 0,
76               "display received pings", "" ),
77
78  OWLVAR_BOOL( "txping" /* %OwlVarStub */, 1,
79               "send pings", "" ),
80
81  OWLVAR_BOOL( "sepbar_disable" /* %OwlVarStub */, 0,
82               "disable printing information in the separator bar", "" ),
83
84  OWLVAR_BOOL( "smartstrip" /* %OwlVarStub */, 1,
85               "strip kerberos instance for reply", ""),
86
87  OWLVAR_BOOL( "newlinestrip" /* %OwlVarStub */, 1,
88               "strip leading and trailing newlines", ""),
89
90  OWLVAR_BOOL( "displayoutgoing" /* %OwlVarStub */, 1,
91               "display outgoing messages", "" ),
92
93  OWLVAR_BOOL( "loginsubs" /* %OwlVarStub */, 1,
94               "load logins from .anyone on startup", "" ),
95
96  OWLVAR_BOOL( "logging" /* %OwlVarStub */, 0,
97               "turn personal logging on or off", 
98               "If this is set to on, personal messages are\n"
99               "logged in the directory specified\n"
100               "by the 'logpath' variable.  The filename in that\n"
101               "directory is derived from the sender of the message.\n" ),
102
103  OWLVAR_BOOL( "classlogging" /* %OwlVarStub */, 0,
104               "turn class logging on or off",
105               "If this is set to on, class messages are\n"
106               "logged in the directory specified\n"
107               "by the 'classlogpath' variable.\n" 
108               "The filename in that directory is derived from\n"
109               "the name of the class to which the message was sent.\n" ),
110
111  OWLVAR_ENUM( "loggingdirection" /* %OwlVarStub */, OWL_LOGGING_DIRECTION_BOTH,
112               "specifices which kind of messages should be logged",
113               "Can be one of 'both', 'in', or 'out'.  If 'in' is\n"
114               "selected, only incoming messages are logged, if 'out'\n"
115               "is selected only outgoing messages are logged.  If 'both'\n"
116               "is selected both incoming and outgoing messages are\n"
117               "logged.",
118               "both,in,out"),
119
120  OWLVAR_BOOL( "colorztext" /* %OwlVarStub */, 1,
121               "allow @color() in zephyrs to change color",
122               "Note that only messages received after this variable\n"
123               "is set will be affected." ),
124
125  OWLVAR_BOOL( "fancylines" /* %OwlVarStub */, 1,
126               "Use 'nice' line drawing on the terminal.",
127               "If turned off, dashes, pipes and pluses will be used\n"
128               "to draw lines on the screen.  Useful when the terminal\n"
129               "is causing problems" ),
130
131  OWLVAR_BOOL( "zcrypt" /* %OwlVarStub */, 1,
132               "Do automatic zcrypt processing",
133               "" ),
134
135  OWLVAR_BOOL_FULL( "pseudologins" /* %OwlVarStub */, 0,
136                    "Enable zephyr pseudo logins",
137                    "When this is enabled, Owl will periodically check the zephyr\n"
138                    "location of users in your .anyone file.  If a user is present\n"
139                    "but sent no login message, or a user is not present that sent no\n"
140                    "logout message, a pseudo login or logout message wil be created\n",
141                    NULL, owl_variable_pseudologins_set, NULL),
142
143  OWLVAR_BOOL( "ignorelogins" /* %OwlVarStub */, 0,
144               "Enable printing of login notifications",
145               "When this is enabled, Owl will print login and logout notifications\n"
146               "for AIM, zephyr, or other protocols.  If disabled Owl will not print\n"
147               "login or logout notifications.\n"),
148
149  OWLVAR_STRING( "logfilter" /* %OwlVarStub */, "",
150                 "name of a filter controlling which messages to log",
151
152                 "If non empty, any messages matching the given filter will be logged.\n"
153                 "This is a completely separate mechanisim from the other logging\n"
154                 "variables like logging, classlogging, loglogins, loggingdirection,\n"
155                 "etc.  If you want this variable to control all logging, make sure\n"
156                 "all other logging variables are in their default state.\n"),
157
158  OWLVAR_BOOL( "loglogins" /* %OwlVarStub */, 0,
159               "Enable logging of login notifications",
160               "When this is enabled, Owl will login login and logout notifications\n"
161               "for AIM, zephyr, or other protocols.  If disabled Owl will not print\n"
162               "login or logout notifications.\n"),
163
164  OWLVAR_ENUM_FULL( "disable-ctrl-d" /* %OwlVarStub:lockout_ctrld */, 1,
165                    "don't send zephyrs on C-d",
166                    "If set to 'off', C-d won't send a zephyr from the edit\n"
167                    "window.  If set to 'on', C-d will always send a zephyr\n"
168                    "being composed in the edit window.  If set to 'middle',\n"
169                    "C-d will only ever send a zephyr if the cursor is at\n"
170                    "the end of the message being composed.\n\n"
171                    "Note that this works by changing the C-d keybinding\n"
172                    "in the editmulti keymap.\n",
173                    "off,middle,on",
174                    NULL, owl_variable_disable_ctrl_d_set, NULL),
175
176  OWLVAR_PATH( "logpath" /* %OwlVarStub */, "~/zlog/people",
177               "path for logging personal zephyrs", 
178               "Specifies a directory which must exist.\n"
179               "Files will be created in the directory for each sender.\n"),
180
181  OWLVAR_PATH( "classlogpath" /* %OwlVarStub:classlogpath */, "~/zlog/class",
182               "path for logging class zephyrs",
183               "Specifies a directory which must exist.\n"
184               "Files will be created in the directory for each class.\n"),
185
186  OWLVAR_PATH( "debug_file" /* %OwlVarStub */, OWL_DEBUG_FILE,
187               "path for logging debug messages when debugging is enabled",
188               "This file will be logged to if 'debug' is set to 'on'.\n"),
189 
190  OWLVAR_PATH( "zsigproc" /* %OwlVarStub:zsigproc */, NULL,
191               "name of a program to run that will generate zsigs",
192               "This program should produce a zsig on stdout when run.\n"
193               "Note that it is important that this program not block.\n\n"
194               "See the documentation for 'zsig' for more information about\n"
195               "how the outgoing zsig is chosen."
196               ),
197
198  OWLVAR_PATH( "newmsgproc" /* %OwlVarStub:newmsgproc */, NULL,
199               "name of a program to run when new messages are present",
200               "The named program will be run when owl recevies new.\n"
201               "messages.  It will not be run again until the first\n"
202               "instance exits"),
203
204  OWLVAR_STRING( "zsender" /* %OwlVarStub */, "",
205             "zephyr sender name",
206         "Allows you to customize the outgoing username in\n"
207         "zephyrs.  If this is unset, it will use your Kerberos\n"
208         "principal. Note that customizing the sender name will\n"
209         "cause your zephyrs to be sent unauthenticated."),
210
211  OWLVAR_STRING( "zsigfunc" /* %OwlVarStub */, "BarnOwl::default_zephyr_signature()",
212                 "zsig perl function",
213                 "Called every time you start a zephyrgram without an\n"
214                 "explicit zsig.  The default setting implements the policy\n"
215                 "descripted in the documentation for the 'zsig' variable.\n"),
216
217  OWLVAR_STRING( "zsig" /* %OwlVarStub */, "",
218                 "zephyr signature",
219                 "The zsig to get on outgoing messages. If this variable is\n"
220                 "unset, 'zsigproc' will be run to generate a zsig. If that is\n"
221                 "also unset, the 'zwrite-signature' zephyr variable will be\n"
222                 "used instead.\n"),
223
224  OWLVAR_STRING( "appendtosepbar" /* %OwlVarStub */, "",
225                 "string to append to the end of the sepbar",
226                 "The sepbar is the bar separating the top and bottom\n"
227                 "of the owl screen.  Any string specified here will\n"
228                 "be displayed on the right of the sepbar\n"),
229
230  OWLVAR_BOOL( "zaway" /* %OwlVarStub */, 0,
231               "turn zaway on or off", "" ),
232
233  OWLVAR_STRING( "zaway_msg" /* %OwlVarStub */, 
234                 OWL_DEFAULT_ZAWAYMSG,
235                 "zaway msg for responding to zephyrs when away", "" ),
236
237  OWLVAR_STRING( "zaway_msg_default" /* %OwlVarStub */, 
238                 OWL_DEFAULT_ZAWAYMSG,
239                 "default zaway message", "" ),
240
241  OWLVAR_BOOL_FULL( "aaway" /* %OwlVarStub */, 0,
242                    "Set AIM away status",
243                    "",
244                    NULL, owl_variable_aaway_set, NULL),
245
246  OWLVAR_STRING( "aaway_msg" /* %OwlVarStub */, 
247                 OWL_DEFAULT_AAWAYMSG,
248                 "AIM away msg for responding when away", "" ),
249
250  OWLVAR_STRING( "aaway_msg_default" /* %OwlVarStub */, 
251                 OWL_DEFAULT_AAWAYMSG,
252                 "default AIM away message", "" ),
253
254  OWLVAR_STRING( "view_home" /* %OwlVarStub */, "all",
255                 "home view to switch to after 'X' and 'V'", 
256                 "SEE ALSO: view, filter\n" ),
257
258  OWLVAR_STRING( "alert_filter" /* %OwlVarStub */, "none",
259                 "filter on which to trigger alert actions",
260                 "" ),
261
262  OWLVAR_STRING( "alert_action" /* %OwlVarStub */, "nop",
263                 "owl command to execute for alert actions",
264                 "" ),
265
266  OWLVAR_STRING_FULL( "tty" /* %OwlVarStub */, "", "tty name for zephyr location", "",
267                      NULL, owl_variable_tty_set, NULL),
268
269  OWLVAR_STRING( "default_style" /* %OwlVarStub */, "__unspecified__",
270                 "name of the default formatting style",
271                 "This sets the default message formatting style.\n"
272                 "Styles may be created with the 'style' command.\n"
273                 "Some built-in styles include:\n"
274                 "   default  - the default owl formatting\n"
275                 "   oneline  - one line per-message\n"
276                 "   perl     - legacy perl interface\n"
277                 "\nSEE ALSO: style, show styles, view -s <style>\n"
278                 ),
279
280
281  OWLVAR_INT(    "edit:maxfillcols" /* %OwlVarStub:edit_maxfillcols */, 70,
282                 "maximum number of columns for M-q to fill text to",
283                 "This specifies the maximum number of columns for M-q\n"
284                 "to fill text to.  If set to 0, ther will be no maximum\n"
285                 "limit.  In all cases, the current width of the screen\n"
286                 "will also be taken into account.  It will be used instead\n"
287                 "if it is narrower than the maximum, or if this\n"
288                 "is set to 0.\n" ),
289
290  OWLVAR_INT(    "edit:maxwrapcols" /* %OwlVarStub:edit_maxwrapcols */, 0,
291                 "maximum number of columns for line-wrapping",
292                 "This specifies the maximum number of columns for\n"
293                 "auto-line-wrapping.  If set to 0, ther will be no maximum\n"
294                 "limit.  In all cases, the current width of the screen\n"
295                 "will also be taken into account.  It will be used instead\n"
296                 "if it is narrower than the maximum, or if this\n"
297                 "is set to 0.\n\n"
298                 "It is recommended that outgoing messages be no wider\n"
299                 "than 60 columns, as a courtesy to recipients.\n"),
300
301  OWLVAR_INT( "aim_ignorelogin_timer" /* %OwlVarStub */, 15,
302              "number of seconds after AIM login to ignore login messages",
303              "This specifies the number of seconds to wait after an\n"
304              "AIM login before allowing the recipt of AIM login notifications.\n"
305              "By default this is set to 15.  If you would like to view login\n"
306              "notifications of buddies as soon as you login, set it to 0 instead."),
307
308             
309  OWLVAR_INT_FULL( "typewinsize" /* %OwlVarStub:typwin_lines */, 
310                   OWL_TYPWIN_SIZE,
311                  "number of lines in the typing window", 
312                   "This specifies the height of the window at the\n"
313                   "bottom of the screen where commands are entered\n"
314                   "and where messages are composed.\n",
315                   "int > 0",
316                   owl_variable_int_validate_gt0,
317                   owl_variable_typewinsize_set,
318                   NULL /* use default for get */
319                   ),
320
321  OWLVAR_INT( "typewindelta" /* %OwlVarStub */, 0,
322                  "number of lines to add to the typing window when in use",
323                   "On small screens you may want the typing window to\n"
324                   "auto-hide when not entering a command or message.\n"
325                   "This variable is the number of lines to add to the\n"
326           "typing window when it is in use; you can then set\n"
327           "typewinsize to 1.\n\n"
328           "This works a lot better with a non-default scrollmode;\n"
329           "try :set scrollmode pagedcenter.\n"),
330
331  OWLVAR_ENUM( "scrollmode" /* %OwlVarStub */, OWL_SCROLLMODE_NORMAL,
332               "how to scroll up and down",
333               "This controls how the screen is scrolled as the\n"
334               "cursor moves between messages being displayed.\n"
335               "The following modes are supported:\n\n"
336               "   normal      - This is the owl default.  Scrolling happens\n"
337               "                 when it needs to, and an attempt is made to\n"
338               "                 keep the current message roughly near\n"
339               "                 the middle of the screen.\n"
340               "   top         - The current message will always be the\n"
341               "                 the top message displayed.\n"
342               "   neartop     - The current message will be one down\n"
343               "                 from the top message displayed,\n"
344               "                 where possible.\n"
345               "   center      - An attempt is made to keep the current\n"
346               "                 message near the center of the screen.\n"
347               "   paged       - The top message displayed only changes\n"
348               "                 when user moves the cursor to the top\n"
349               "                 or bottom of the screen.  When it moves,\n"
350               "                 the screen will be paged up or down and\n"
351               "                 the cursor will be near the top or\n"
352               "                 the bottom.\n"
353               "   pagedcenter - The top message displayed only changes\n"
354               "                 when user moves the cursor to the top\n"
355               "                 or bottom of the screen.  When it moves,\n"
356               "                 the screen will be paged up or down and\n"
357               "                 the cursor will be near the center.\n",
358               "normal,top,neartop,center,paged,pagedcenter" ),
359
360
361  OWLVAR_BOOL( "_followlast" /* %OwlVarStub */, 0,
362               "enable automatic following of the last zephyr",
363               "If the cursor is at the last message, it will\n"
364               "continue to follow the last message if this is set.\n"
365               "Note that this is currently risky as you might accidentally\n"
366               "delete a message right as it came in.\n" ),
367
368  /* This MUST be last... */
369  { NULL, 0, NULL, 0, NULL, NULL, NULL, NULL,
370    NULL, NULL, NULL, NULL, NULL, NULL }
371
372};
373
374/**************************************************************************/
375/*********************** SPECIFIC TO VARIABLES ****************************/
376/**************************************************************************/
377
378
379/* commonly useful */
380
381int owl_variable_int_validate_gt0(const owl_variable *v, const void *newval)
382{
383  if (newval == NULL) return(0);
384  else if (*(const int*)newval < 1) return(0);
385  else return (1);
386}
387
388int owl_variable_int_validate_positive(const owl_variable *v, const void *newval)
389{
390  if (newval == NULL) return(0);
391  else if (*(const int*)newval < 0) return(0);
392  else return (1);
393}
394
395/* typewinsize */
396int owl_variable_typewinsize_set(owl_variable *v, const void *newval)
397{
398  int rv;
399  rv = owl_variable_int_set_default(v, newval);
400  if (0 == rv) owl_function_resize();
401  return(rv);
402}
403
404/* debug (cache value in g->debug) */
405int owl_variable_debug_set(owl_variable *v, const void *newval)
406{
407  if (newval && (*(const int*)newval == 1 || *(const int*)newval == 0)) {
408    g.debug = *(const int*)newval;
409  }
410  return owl_variable_bool_set_default(v, newval);
411}
412
413/* When 'aaway' is changed, need to notify the AIM server */
414int owl_variable_aaway_set(owl_variable *v, const void *newval)
415{
416  if (newval) {
417    if (*(const int*)newval == 1) {
418      owl_aim_set_awaymsg(owl_global_get_aaway_msg(&g));
419    } else if (*(const int*)newval == 0) {
420      owl_aim_set_awaymsg("");
421    }
422  }
423  return owl_variable_bool_set_default(v, newval);
424}
425
426int owl_variable_pseudologins_set(owl_variable *v, const void *newval)
427{
428  if (newval) {
429    if (*(const int*)newval == 1) {
430      owl_function_zephyr_buddy_check(0);
431    }
432  }
433  return owl_variable_bool_set_default(v, newval);
434}
435
436/* note that changing the value of this will clobber
437 * any user setting of this */
438int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval)
439{
440  if (newval && !owl_context_is_startup(owl_global_get_context(&g))) {
441    if (*(const int*)newval == 2) {
442      owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char");
443    } else if (*(const int*)newval == 1) {
444      owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete");
445    } else {
446      owl_function_command_norv("bindkey editmulti C-d command edit:done");
447    }
448  } 
449  return owl_variable_int_set_default(v, newval); 
450}
451
452int owl_variable_tty_set(owl_variable *v, const void *newval)
453{
454  owl_zephyr_set_locationinfo(owl_global_get_hostname(&g), newval);
455  return(owl_variable_string_set_default(v, newval));
456}
457
458
459/**************************************************************************/
460/****************************** GENERAL ***********************************/
461/**************************************************************************/
462
463int owl_variable_dict_setup(owl_vardict *vd) {
464  owl_variable *var, *cur;
465  if (owl_dict_create(vd)) return(-1);
466  for (var = variables_to_init; var->name != NULL; var++) {
467    cur = owl_malloc(sizeof(owl_variable));
468    *cur = *var;
469    switch (cur->type) {
470    case OWL_VARIABLE_OTHER:
471      cur->set_fn(cur, cur->pval_default);
472      break;
473    case OWL_VARIABLE_STRING:
474      if (!cur->validate_fn) 
475        cur->validate_fn = owl_variable_string_validate_default;
476      if (!cur->set_fn) 
477        cur->set_fn = owl_variable_string_set_default;
478      if (!cur->set_fromstring_fn) 
479        cur->set_fromstring_fn = owl_variable_string_set_fromstring_default;
480      if (!cur->get_fn) 
481        cur->get_fn = owl_variable_get_default;
482      if (!cur->get_tostring_fn) 
483        cur->get_tostring_fn = owl_variable_string_get_tostring_default;     
484      if (!cur->delete_fn)
485        cur->delete_fn = owl_variable_delete_default;
486      cur->set_fn(cur, cur->pval_default);
487      break;
488    case OWL_VARIABLE_BOOL:
489      if (!cur->validate_fn) 
490        cur->validate_fn = owl_variable_bool_validate_default;
491      if (!cur->set_fn) 
492        cur->set_fn = owl_variable_bool_set_default;
493      if (!cur->set_fromstring_fn) 
494        cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
495      if (!cur->get_fn) 
496        cur->get_fn = owl_variable_get_default;
497      if (!cur->get_tostring_fn) 
498        cur->get_tostring_fn = owl_variable_bool_get_tostring_default;     
499      if (!cur->delete_fn)
500        cur->delete_fn = owl_variable_delete_default;
501      cur->val = owl_malloc(sizeof(int));
502      cur->set_fn(cur, &cur->ival_default);
503      break;
504    case OWL_VARIABLE_INT:
505      if (!cur->validate_fn) 
506        cur->validate_fn = owl_variable_int_validate_default;
507      if (!cur->set_fn) 
508        cur->set_fn = owl_variable_int_set_default;
509      if (!cur->set_fromstring_fn) 
510        cur->set_fromstring_fn = owl_variable_int_set_fromstring_default;
511      if (!cur->get_fn) 
512        cur->get_fn = owl_variable_get_default;
513      if (!cur->get_tostring_fn) 
514        cur->get_tostring_fn = owl_variable_int_get_tostring_default;     
515      if (!cur->delete_fn)
516        cur->delete_fn = owl_variable_delete_default;
517      cur->val = owl_malloc(sizeof(int));
518      cur->set_fn(cur, &cur->ival_default);
519      break;
520    default:
521      fprintf(stderr, "owl_variable_setup: invalid variable type\n");
522      return(-2);
523    }
524    owl_dict_insert_element(vd, cur->name, cur, NULL);
525  }
526  return 0;
527}
528
529void owl_variable_dict_add_variable(owl_vardict * vardict,
530                                    owl_variable * var) {
531  owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete);
532}
533
534owl_variable * owl_variable_newvar(const char *name, const char *summary, const char * description) {
535  owl_variable * var = owl_malloc(sizeof(owl_variable));
536  memset(var, 0, sizeof(owl_variable));
537  var->name = owl_strdup(name);
538  var->summary = owl_strdup(summary);
539  var->description = owl_strdup(description);
540  return var;
541}
542
543void owl_variable_update(owl_variable *var, const char *summary, const char *desc) {
544  if(var->summary) owl_free(var->summary);
545  var->summary = owl_strdup(summary);
546  if(var->description) owl_free(var->description);
547  var->description = owl_strdup(desc);
548}
549
550void owl_variable_dict_newvar_string(owl_vardict * vd, const char *name, const char *summ, const char * desc, const char * initval) {
551  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_STRING);
552  if(old) {
553    owl_variable_update(old, summ, desc);
554    if(old->pval_default) owl_free(old->pval_default);
555    old->pval_default = owl_strdup(initval);
556  } else {
557    owl_variable * var = owl_variable_newvar(name, summ, desc);
558    var->type = OWL_VARIABLE_STRING;
559    var->pval_default = owl_strdup(initval);
560    var->set_fn = owl_variable_string_set_default;
561    var->set_fromstring_fn = owl_variable_string_set_fromstring_default;
562    var->get_fn = owl_variable_get_default;
563    var->get_tostring_fn = owl_variable_string_get_tostring_default;
564    var->delete_fn = owl_variable_delete_default;
565    var->set_fn(var, initval);
566    owl_variable_dict_add_variable(vd, var);
567  }
568}
569
570void owl_variable_dict_newvar_int(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
571  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_INT);
572  if(old) {
573    owl_variable_update(old, summ, desc);
574    old->ival_default = initval;
575  } else {
576    owl_variable * var = owl_variable_newvar(name, summ, desc);
577    var->type = OWL_VARIABLE_INT;
578    var->ival_default = initval;
579    var->validate_fn = owl_variable_int_validate_default;
580    var->set_fn = owl_variable_int_set_default;
581    var->set_fromstring_fn = owl_variable_int_set_fromstring_default;
582    var->get_fn = owl_variable_get_default;
583    var->get_tostring_fn = owl_variable_int_get_tostring_default;
584    var->delete_fn = owl_variable_delete_default;
585    var->val = owl_malloc(sizeof(int));
586    var->set_fn(var, &initval);
587    owl_variable_dict_add_variable(vd, var);
588  }
589}
590
591void owl_variable_dict_newvar_bool(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
592  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_BOOL);
593  if(old) {
594    owl_variable_update(old, summ, desc);
595    old->ival_default = initval;
596  } else {
597    owl_variable * var = owl_variable_newvar(name, summ, desc);
598    var->type = OWL_VARIABLE_BOOL;
599    var->ival_default = initval;
600    var->validate_fn = owl_variable_bool_validate_default;
601    var->set_fn = owl_variable_bool_set_default;
602    var->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
603    var->get_fn = owl_variable_get_default;
604    var->get_tostring_fn = owl_variable_bool_get_tostring_default;
605    var->delete_fn = owl_variable_delete_default;
606    var->val = owl_malloc(sizeof(int));
607    var->set_fn(var, &initval);
608    owl_variable_dict_add_variable(vd, var);
609  }
610}
611
612void owl_variable_dict_cleanup(owl_vardict *d)
613{
614  owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete);
615}
616
617/* free the list with owl_variable_dict_namelist_cleanup */
618void owl_variable_dict_get_names(const owl_vardict *d, owl_list *l) {
619  owl_dict_get_keys(d, l);
620}
621
622void owl_variable_dict_namelist_cleanup(owl_list *l)
623{
624  owl_list_cleanup(l, owl_free);
625}
626
627void owl_variable_delete(owl_variable *v)
628{
629  if (v->delete_fn) v->delete_fn(v);
630  owl_free(v);
631}
632
633
634const char *owl_variable_get_description(const owl_variable *v) {
635  return v->description;
636}
637
638const char *owl_variable_get_summary(const owl_variable *v) {
639  return v->summary;
640}
641
642const char *owl_variable_get_validsettings(const owl_variable *v) {
643  if (v->validsettings) {
644    return v->validsettings;
645  } else {
646    return "";
647  }
648}
649
650/* functions for getting and setting variable values */
651
652/* returns 0 on success, prints a status msg if msg is true */
653int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) {
654  owl_variable *v;
655  char buff2[1024];
656  if (!name) return(-1);
657  v = owl_dict_find_element(d, name);
658  if (v == NULL) {
659    if (msg) owl_function_error("Unknown variable %s", name);
660    return -1;
661  }
662  if (!v->set_fromstring_fn) {
663    if (msg) owl_function_error("Variable %s is read-only", name);
664    return -1;   
665  }
666  if (requirebool && v->type!=OWL_VARIABLE_BOOL) {
667    if (msg) owl_function_error("Variable %s is not a boolean", name);
668    return -1;   
669  }
670  if (0 != v->set_fromstring_fn(v, value)) {
671    if (msg) owl_function_error("Unable to set %s (must be %s)", name, 
672                                  owl_variable_get_validsettings(v));
673    return -1;
674  }
675  if (msg && v->get_tostring_fn) {
676    v->get_tostring_fn(v, buff2, 1024, v->val);
677    owl_function_makemsg("%s = '%s'", name, buff2);
678  }   
679  return 0;
680}
681 
682int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) {
683  owl_variable *v;
684  if (!name) return(-1);
685  v = owl_dict_find_element(d, name);
686  if (v == NULL || !v->set_fn) return(-1);
687  if (v->type!=OWL_VARIABLE_STRING) return(-1);
688  return v->set_fn(v, newval);
689}
690 
691int owl_variable_set_int(owl_vardict *d, const char *name, int newval) {
692  owl_variable *v;
693  if (!name) return(-1);
694  v = owl_dict_find_element(d, name);
695  if (v == NULL || !v->set_fn) return(-1);
696  if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1);
697  return v->set_fn(v, &newval);
698}
699 
700int owl_variable_set_bool_on(owl_vardict *d, const char *name) {
701  return owl_variable_set_int(d,name,1);
702}
703
704int owl_variable_set_bool_off(owl_vardict *d, const char *name) {
705  return owl_variable_set_int(d,name,0);
706}
707
708int owl_variable_get_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) {
709  owl_variable *v;
710  if (!name) return(-1);
711  v = owl_dict_find_element(d, name);
712  if (v == NULL || !v->get_tostring_fn) return(-1);
713  return v->get_tostring_fn(v, buf, bufsize, v->val);
714}
715
716int owl_variable_get_default_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) {
717  owl_variable *v;
718  if (!name) return(-1);
719  v = owl_dict_find_element(d, name);
720  if (v == NULL || !v->get_tostring_fn) return(-1);
721  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
722    return v->get_tostring_fn(v, buf, bufsize, &(v->ival_default));
723  } else {
724    return v->get_tostring_fn(v, buf, bufsize, v->pval_default);
725  }
726}
727
728owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name, int require_type) {
729  owl_variable *v;
730  if (!name) return(NULL);
731  v = owl_dict_find_element(d, name);
732  if (v == NULL || !v->get_fn || v->type != require_type) return(NULL);
733  return v;
734}
735
736/* returns a reference */
737const void *owl_variable_get(const owl_vardict *d, const char *name, int require_type) {
738  owl_variable *v = owl_variable_get_var(d, name, require_type);
739  if(v == NULL) return NULL;
740  return v->get_fn(v);
741}
742
743/* returns a reference */
744const char *owl_variable_get_string(const owl_vardict *d, const char *name) {
745  return owl_variable_get(d,name, OWL_VARIABLE_STRING);
746}
747
748/* returns a reference */
749const void *owl_variable_get_other(const owl_vardict *d, const char *name) {
750  return owl_variable_get(d,name, OWL_VARIABLE_OTHER);
751}
752
753int owl_variable_get_int(const owl_vardict *d, const char *name) {
754  const int *pi;
755  pi = owl_variable_get(d,name,OWL_VARIABLE_INT);
756  if (!pi) return(-1);
757  return(*pi);
758}
759
760int owl_variable_get_bool(const owl_vardict *d, const char *name) {
761  const int *pi;
762  pi = owl_variable_get(d,name,OWL_VARIABLE_BOOL);
763  if (!pi) return(-1);
764  return(*pi);
765}
766
767void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) {
768  char defaultbuf[50];
769  char buf[1024];
770  int buflen = 1023;
771  owl_variable *v;
772
773  if (!name
774      || (v = owl_dict_find_element(d, name)) == NULL 
775      || !v->get_fn) {
776    snprintf(buf, buflen, "     No such variable '%s'\n", name);     
777    owl_fmtext_append_normal(fm, buf);
778    return;
779  }
780  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
781    v->get_tostring_fn(v, defaultbuf, 50, &(v->ival_default));
782  } else {
783    v->get_tostring_fn(v, defaultbuf, 50, v->pval_default);
784  }
785  snprintf(buf, buflen, OWL_TABSTR "%-20s - %s (default: '%s')\n", 
786                  v->name, 
787                  owl_variable_get_summary(v), defaultbuf);
788  owl_fmtext_append_normal(fm, buf);
789}
790
791void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) {
792  char buff[1024];
793  int bufflen = 1023;
794  owl_variable *v;
795
796  if (!name
797      || (v = owl_dict_find_element(d, name)) == NULL 
798      || !v->get_fn) {
799    owl_fmtext_append_normal(fm, "No such variable...\n");
800    return;
801  }
802
803  owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
804  owl_fmtext_append_normal(fm, OWL_TABSTR);
805  owl_fmtext_append_normal(fm, name);
806  owl_fmtext_append_normal(fm, " - ");
807  owl_fmtext_append_normal(fm, v->summary);
808  owl_fmtext_append_normal(fm, "\n\n");
809
810  owl_fmtext_append_normal(fm, "Current:        ");
811  owl_variable_get_tostring(d, name, buff, bufflen);
812  owl_fmtext_append_normal(fm, buff);
813  owl_fmtext_append_normal(fm, "\n\n");
814
815
816  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
817    v->get_tostring_fn(v, buff, bufflen, &(v->ival_default));
818  } else {
819    v->get_tostring_fn(v, buff, bufflen, v->pval_default);
820  }
821  owl_fmtext_append_normal(fm, "Default:        ");
822  owl_fmtext_append_normal(fm, buff);
823  owl_fmtext_append_normal(fm, "\n\n");
824
825  owl_fmtext_append_normal(fm, "Valid Settings: ");
826  owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
827  owl_fmtext_append_normal(fm, "\n\n");
828
829  if (v->description && *v->description) {
830    owl_fmtext_append_normal(fm, "Description:\n");
831    owl_fmtext_append_normal(fm, owl_variable_get_description(v));
832    owl_fmtext_append_normal(fm, "\n\n");
833  }
834}
835
836
837
838
839/**************************************************************************/
840/*********************** GENERAL TYPE-SPECIFIC ****************************/
841/**************************************************************************/
842
843/* default common functions */
844
845const void *owl_variable_get_default(const owl_variable *v) {
846  return v->val;
847}
848
849void owl_variable_delete_default(owl_variable *v)
850{
851  if (v->val) owl_free(v->val);
852}
853
854/* default functions for booleans */
855
856int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) {
857  if (newval == NULL) return(0);
858  else if (*(const int*)newval==1 || *(const int*)newval==0) return(1);
859  else return (0);
860}
861
862int owl_variable_bool_set_default(owl_variable *v, const void *newval) {
863  if (v->validate_fn) {
864    if (!v->validate_fn(v, newval)) return(-1);
865  }
866  *(int*)v->val = *(const int*)newval;
867  return(0);
868}
869
870int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) {
871  int i;
872  if (!strcmp(newval, "on")) i=1;
873  else if (!strcmp(newval, "off")) i=0;
874  else return(-1);
875  return (v->set_fn(v, &i));
876}
877
878int owl_variable_bool_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
879  if (val == NULL) {
880    snprintf(buf, bufsize, "<null>");
881    return -1;
882  } else if (*(const int*)val == 0) {
883    snprintf(buf, bufsize, "off");
884    return 0;
885  } else if (*(const int*)val == 1) {
886    snprintf(buf, bufsize, "on");
887    return 0;
888  } else {
889    snprintf(buf, bufsize, "<invalid>");
890    return -1;
891  }
892}
893
894/* default functions for integers */
895
896int owl_variable_int_validate_default(const owl_variable *v, const void *newval) {
897  if (newval == NULL) return(0);
898  else return (1);
899}
900
901int owl_variable_int_set_default(owl_variable *v, const void *newval) {
902  if (v->validate_fn) {
903    if (!v->validate_fn(v, newval)) return(-1);
904  }
905  *(int*)v->val = *(const int*)newval;
906  return(0);
907}
908
909int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) {
910  int i;
911  char *ep;
912  i = strtol(newval, &ep, 10);
913  if (*ep || ep==newval) return(-1);
914  return (v->set_fn(v, &i));
915}
916
917int owl_variable_int_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
918  if (val == NULL) {
919    snprintf(buf, bufsize, "<null>");
920    return -1;
921  } else {
922    snprintf(buf, bufsize, "%d", *(const int*)val);
923    return 0;
924  } 
925}
926
927/* default functions for enums (a variant of integers) */
928
929int owl_variable_enum_validate(const owl_variable *v, const void *newval) { 
930  char **enums;
931  int nenums, val;
932  if (newval == NULL) return(0);
933  enums = atokenize(v->validsettings, ",", &nenums);
934  if (enums == NULL) return(0);
935  atokenize_delete(enums, nenums);
936  val = *(const int*)newval;
937  if (val < 0 || val >= nenums) {
938    return(0);
939  }
940  return(1);
941}
942
943int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) {
944  char **enums;
945  int nenums, i, val=-1;
946  if (newval == NULL) return(-1);
947  enums = atokenize(v->validsettings, ",", &nenums);
948  if (enums == NULL) return(-1);
949  for (i=0; i<nenums; i++) {
950    if (0==strcmp(newval, enums[i])) {
951      val = i;
952    }
953  }
954  atokenize_delete(enums, nenums);
955  if (val == -1) return(-1);
956  return (v->set_fn(v, &val));
957}
958
959int owl_variable_enum_get_tostring(const owl_variable *v, char* buf, int bufsize, const void *val) {
960  char **enums;
961  int nenums, i;
962
963  if (val == NULL) {
964    snprintf(buf, bufsize, "<null>");
965    return -1;
966  }
967  enums = atokenize(v->validsettings, ",", &nenums);
968  i = *(const int*)val;
969  if (i<0 || i>=nenums) {
970    snprintf(buf, bufsize, "<invalid:%d>",i);
971    atokenize_delete(enums, nenums);
972    return(-1);
973  }
974  snprintf(buf, bufsize, "%s", enums[i]);
975  atokenize_delete(enums, nenums);
976  return 0;
977}
978
979/* default functions for stringeans */
980
981int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) {
982  if (newval == NULL) return(0);
983  else return (1);
984}
985
986int owl_variable_string_set_default(owl_variable *v, const void *newval) {
987  if (v->validate_fn) {
988    if (!v->validate_fn(v, newval)) return(-1);
989  }
990  if (v->val) owl_free(v->val);
991  v->val = owl_strdup(newval);
992  return(0);
993}
994
995int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) {
996  return (v->set_fn(v, newval));
997}
998
999int owl_variable_string_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
1000  if (val == NULL) {
1001    snprintf(buf, bufsize, "<null>");
1002    return -1;
1003  } else {
1004    snprintf(buf, bufsize, "%s", (const char*)val);
1005    return 0;
1006  }
1007}
1008
Note: See TracBrowser for help on using the repository browser.