source: variable.c @ c8d9f84

release-1.7release-1.8release-1.9
Last change on this file since c8d9f84 was b120bd3, checked in by Nelson Elhage <nelhage@mit.edu>, 11 years ago
add a random zsig function
  • Property mode set to 100644
File size: 36.6 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               "specifies 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 will 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 mechanism 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               "BarnOwl will append a dot and the current process's pid to the filename."),
190 
191  OWLVAR_PATH( "zsigproc" /* %OwlVarStub:zsigproc */, NULL,
192               "name of a program to run that will generate zsigs",
193               "This program should produce a zsig on stdout when run.\n"
194               "Note that it is important that this program not block.\n\n"
195               "See the documentation for 'zsig' for more information about\n"
196               "how the outgoing zsig is chosen."
197               ),
198
199  OWLVAR_PATH( "newmsgproc" /* %OwlVarStub:newmsgproc */, NULL,
200               "name of a program to run when new messages are present",
201               "The named program will be run when owl receives new\n"
202               "messages.  It will not be run again until the first\n"
203               "instance exits"),
204
205  OWLVAR_STRING( "zsender" /* %OwlVarStub */, "",
206             "zephyr sender name",
207         "Allows you to customize the outgoing username in\n"
208         "zephyrs.  If this is unset, it will use your Kerberos\n"
209         "principal. Note that customizing the sender name will\n"
210         "cause your zephyrs to be sent unauthenticated."),
211
212  OWLVAR_STRING( "zsigfunc" /* %OwlVarStub */, "BarnOwl::default_zephyr_signature()",
213                 "zsig perl function",
214                 "Called every time you start a zephyrgram without an\n"
215                 "explicit zsig.  The default setting implements the policy\n"
216                 "described in the documentation for the 'zsig' variable.\n"
217                 "See also BarnOwl::random_zephyr_signature().\n"),
218
219  OWLVAR_STRING( "zsig" /* %OwlVarStub */, "",
220                 "zephyr signature",
221                 "The zsig to get on outgoing messages. If this variable is\n"
222                 "unset, 'zsigproc' will be run to generate a zsig. If that is\n"
223                 "also unset, the 'zwrite-signature' zephyr variable will be\n"
224                 "used instead.\n"),
225
226  OWLVAR_STRING( "appendtosepbar" /* %OwlVarStub */, "",
227                 "string to append to the end of the sepbar",
228                 "The sepbar is the bar separating the top and bottom\n"
229                 "of the owl screen.  Any string specified here will\n"
230                 "be displayed on the right of the sepbar\n"),
231
232  OWLVAR_BOOL( "zaway" /* %OwlVarStub */, 0,
233               "turn zaway on or off", "" ),
234
235  OWLVAR_STRING( "zaway_msg" /* %OwlVarStub */, 
236                 OWL_DEFAULT_ZAWAYMSG,
237                 "zaway msg for responding to zephyrs when away", "" ),
238
239  OWLVAR_STRING( "zaway_msg_default" /* %OwlVarStub */, 
240                 OWL_DEFAULT_ZAWAYMSG,
241                 "default zaway message", "" ),
242
243  OWLVAR_BOOL_FULL( "aaway" /* %OwlVarStub */, 0,
244                    "Set AIM away status",
245                    "",
246                    NULL, owl_variable_aaway_set, NULL),
247
248  OWLVAR_STRING( "aaway_msg" /* %OwlVarStub */, 
249                 OWL_DEFAULT_AAWAYMSG,
250                 "AIM away msg for responding when away", "" ),
251
252  OWLVAR_STRING( "aaway_msg_default" /* %OwlVarStub */, 
253                 OWL_DEFAULT_AAWAYMSG,
254                 "default AIM away message", "" ),
255
256  OWLVAR_STRING( "view_home" /* %OwlVarStub */, "all",
257                 "home view to switch to after 'X' and 'V'", 
258                 "SEE ALSO: view, filter\n" ),
259
260  OWLVAR_STRING( "alert_filter" /* %OwlVarStub */, "none",
261                 "filter on which to trigger alert actions",
262                 "" ),
263
264  OWLVAR_STRING( "alert_action" /* %OwlVarStub */, "nop",
265                 "owl command to execute for alert actions",
266                 "" ),
267
268  OWLVAR_STRING_FULL( "tty" /* %OwlVarStub */, "", "tty name for zephyr location", "",
269                      NULL, owl_variable_tty_set, NULL),
270
271  OWLVAR_STRING( "default_style" /* %OwlVarStub */, "__unspecified__",
272                 "name of the default formatting style",
273                 "This sets the default message formatting style.\n"
274                 "Styles may be created with the 'style' command.\n"
275                 "Some built-in styles include:\n"
276                 "   default  - the default owl formatting\n"
277                 "   oneline  - one line per-message\n"
278                 "   perl     - legacy perl interface\n"
279                 "\nSEE ALSO: style, show styles, view -s <style>\n"
280                 ),
281
282
283  OWLVAR_INT(    "edit:maxfillcols" /* %OwlVarStub:edit_maxfillcols */, 70,
284                 "maximum number of columns for M-q (edit:fill-paragraph) to fill text to",
285                 "This specifies the maximum number of columns for M-q to fill text\n"
286                 "to.  If set to 0, M-q will wrap to the width of the window, and\n"
287                 "values less than 0 disable M-q entirely.\n"),
288
289  OWLVAR_INT(    "edit:maxwrapcols" /* %OwlVarStub:edit_maxwrapcols */, 70,
290                 "maximum number of columns for line-wrapping",
291                 "This specifies the maximum number of columns for\n"
292                 "auto-line-wrapping.  If set to 0, text will be wrapped at the\n"
293                 "window width. Values less than 0 disable automatic wrapping.\n"
294                 "\n"
295                 "As a courtesy to recipients, it is recommended that outgoing\n"
296                 "Zephyr messages be no wider than 70 columns.\n"),
297
298  OWLVAR_INT( "aim_ignorelogin_timer" /* %OwlVarStub */, 15,
299              "number of seconds after AIM login to ignore login messages",
300              "This specifies the number of seconds to wait after an\n"
301              "AIM login before allowing the receipt of AIM login notifications.\n"
302              "By default this is set to 15.  If you would like to view login\n"
303              "notifications of buddies as soon as you login, set it to 0 instead."),
304
305             
306  OWLVAR_INT_FULL( "typewinsize" /* %OwlVarStub:typwin_lines */, 
307                   OWL_TYPWIN_SIZE,
308                  "number of lines in the typing window", 
309                   "This specifies the height of the window at the\n"
310                   "bottom of the screen where commands are entered\n"
311                   "and where messages are composed.\n",
312                   "int > 0",
313                   owl_variable_int_validate_gt0,
314                   owl_variable_typewinsize_set,
315                   NULL /* use default for get */
316                   ),
317
318  OWLVAR_INT( "typewindelta" /* %OwlVarStub */, 0,
319                  "number of lines to add to the typing window when in use",
320                   "On small screens you may want the typing window to\n"
321                   "auto-hide when not entering a command or message.\n"
322                   "This variable is the number of lines to add to the\n"
323           "typing window when it is in use; you can then set\n"
324           "typewinsize to 1.\n\n"
325           "This works a lot better with a non-default scrollmode;\n"
326           "try :set scrollmode pagedcenter.\n"),
327
328  OWLVAR_ENUM( "scrollmode" /* %OwlVarStub */, OWL_SCROLLMODE_NORMAL,
329               "how to scroll up and down",
330               "This controls how the screen is scrolled as the\n"
331               "cursor moves between messages being displayed.\n"
332               "The following modes are supported:\n\n"
333               "   normal      - This is the owl default.  Scrolling happens\n"
334               "                 when it needs to, and an attempt is made to\n"
335               "                 keep the current message roughly near\n"
336               "                 the middle of the screen.\n"
337               "   top         - The current message will always be the\n"
338               "                 the top message displayed.\n"
339               "   neartop     - The current message will be one down\n"
340               "                 from the top message displayed,\n"
341               "                 where possible.\n"
342               "   center      - An attempt is made to keep the current\n"
343               "                 message near the center of the screen.\n"
344               "   paged       - The top message displayed only changes\n"
345               "                 when user moves the cursor to the top\n"
346               "                 or bottom of the screen.  When it moves,\n"
347               "                 the screen will be paged up or down and\n"
348               "                 the cursor will be near the top or\n"
349               "                 the bottom.\n"
350               "   pagedcenter - The top message displayed only changes\n"
351               "                 when user moves the cursor to the top\n"
352               "                 or bottom of the screen.  When it moves,\n"
353               "                 the screen will be paged up or down and\n"
354               "                 the cursor will be near the center.\n",
355               "normal,top,neartop,center,paged,pagedcenter" ),
356
357  OWLVAR_BOOL( "narrow-related" /* %OwlVarStub:narrow_related */, 1,
358               "Make smartnarrow use broader filters",
359               "Causes smartfiler to narrow to messages \"related\" to \n"
360               "the current message, as well as ones to the same place.\n\n"
361               "for Zephyr, this controls whether to narrow to e.g. class-help or\n"
362               "class-help.d alone, or to related-class-help, which includes\n"
363               "help, unhelp, help.d, etc.\n\nDefault is true (include unclasses, etc.).\n" ),
364
365  OWLVAR_BOOL( "_followlast" /* %OwlVarStub */, 0,
366               "enable automatic following of the last zephyr",
367               "If the cursor is at the last message, it will\n"
368               "continue to follow the last message if this is set.\n"
369               "Note that this is currently risky as you might accidentally\n"
370               "delete a message right as it came in.\n" ),
371
372  /* This MUST be last... */
373  { NULL, 0, NULL, 0, NULL, NULL, NULL, NULL,
374    NULL, NULL, NULL, NULL, NULL, NULL }
375
376};
377
378/**************************************************************************/
379/*********************** SPECIFIC TO VARIABLES ****************************/
380/**************************************************************************/
381
382
383/* commonly useful */
384
385int owl_variable_int_validate_gt0(const owl_variable *v, const void *newval)
386{
387  if (newval == NULL) return(0);
388  else if (*(const int*)newval < 1) return(0);
389  else return (1);
390}
391
392int owl_variable_int_validate_positive(const owl_variable *v, const void *newval)
393{
394  if (newval == NULL) return(0);
395  else if (*(const int*)newval < 0) return(0);
396  else return (1);
397}
398
399/* typewinsize */
400int owl_variable_typewinsize_set(owl_variable *v, const void *newval)
401{
402  int rv;
403  rv = owl_variable_int_set_default(v, newval);
404  if (0 == rv) owl_mainpanel_layout_contents(&g.mainpanel);
405  return(rv);
406}
407
408/* debug (cache value in g->debug) */
409int owl_variable_debug_set(owl_variable *v, const void *newval)
410{
411  if (newval && (*(const int*)newval == 1 || *(const int*)newval == 0)) {
412    g.debug = *(const int*)newval;
413  }
414  return owl_variable_bool_set_default(v, newval);
415}
416
417/* When 'aaway' is changed, need to notify the AIM server */
418int owl_variable_aaway_set(owl_variable *v, const void *newval)
419{
420  if (newval) {
421    if (*(const int*)newval == 1) {
422      owl_aim_set_awaymsg(owl_global_get_aaway_msg(&g));
423    } else if (*(const int*)newval == 0) {
424      owl_aim_set_awaymsg("");
425    }
426  }
427  return owl_variable_bool_set_default(v, newval);
428}
429
430int owl_variable_pseudologins_set(owl_variable *v, const void *newval)
431{
432  static owl_timer *timer = NULL;
433  if (newval) {
434    if (*(const int*)newval == 1) {
435      owl_function_zephyr_buddy_check(0);
436      if (timer == NULL) {
437        timer = owl_select_add_timer(180, 180, owl_zephyr_buddycheck_timer, NULL, NULL);
438      }
439    } else {
440      if (timer != NULL) {
441        owl_select_remove_timer(timer);
442        timer = NULL;
443      }
444    }
445  }
446  return owl_variable_bool_set_default(v, newval);
447}
448
449/* note that changing the value of this will clobber
450 * any user setting of this */
451int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval)
452{
453  if (newval && !owl_context_is_startup(owl_global_get_context(&g))) {
454    if (*(const int*)newval == 2) {
455      owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char");
456    } else if (*(const int*)newval == 1) {
457      owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete");
458    } else {
459      owl_function_command_norv("bindkey editmulti C-d command edit:done");
460    }
461  } 
462  return owl_variable_int_set_default(v, newval); 
463}
464
465int owl_variable_tty_set(owl_variable *v, const void *newval)
466{
467  owl_zephyr_set_locationinfo(owl_global_get_hostname(&g), newval);
468  return(owl_variable_string_set_default(v, newval));
469}
470
471
472/**************************************************************************/
473/****************************** GENERAL ***********************************/
474/**************************************************************************/
475
476int owl_variable_dict_setup(owl_vardict *vd) {
477  owl_variable *var, *cur;
478  if (owl_dict_create(vd)) return(-1);
479  for (var = variables_to_init; var->name != NULL; var++) {
480    cur = owl_malloc(sizeof(owl_variable));
481    *cur = *var;
482    switch (cur->type) {
483    case OWL_VARIABLE_OTHER:
484      cur->set_fn(cur, cur->pval_default);
485      break;
486    case OWL_VARIABLE_STRING:
487      if (!cur->validate_fn) 
488        cur->validate_fn = owl_variable_string_validate_default;
489      if (!cur->set_fn) 
490        cur->set_fn = owl_variable_string_set_default;
491      if (!cur->set_fromstring_fn) 
492        cur->set_fromstring_fn = owl_variable_string_set_fromstring_default;
493      if (!cur->get_fn) 
494        cur->get_fn = owl_variable_get_default;
495      if (!cur->get_tostring_fn) 
496        cur->get_tostring_fn = owl_variable_string_get_tostring_default;     
497      if (!cur->delete_fn)
498        cur->delete_fn = owl_variable_delete_default;
499      cur->set_fn(cur, cur->pval_default);
500      break;
501    case OWL_VARIABLE_BOOL:
502      if (!cur->validate_fn) 
503        cur->validate_fn = owl_variable_bool_validate_default;
504      if (!cur->set_fn) 
505        cur->set_fn = owl_variable_bool_set_default;
506      if (!cur->set_fromstring_fn) 
507        cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
508      if (!cur->get_fn) 
509        cur->get_fn = owl_variable_get_default;
510      if (!cur->get_tostring_fn) 
511        cur->get_tostring_fn = owl_variable_bool_get_tostring_default;     
512      if (!cur->delete_fn)
513        cur->delete_fn = owl_variable_delete_default;
514      cur->val = owl_malloc(sizeof(int));
515      cur->set_fn(cur, &cur->ival_default);
516      break;
517    case OWL_VARIABLE_INT:
518      if (!cur->validate_fn) 
519        cur->validate_fn = owl_variable_int_validate_default;
520      if (!cur->set_fn) 
521        cur->set_fn = owl_variable_int_set_default;
522      if (!cur->set_fromstring_fn) 
523        cur->set_fromstring_fn = owl_variable_int_set_fromstring_default;
524      if (!cur->get_fn) 
525        cur->get_fn = owl_variable_get_default;
526      if (!cur->get_tostring_fn) 
527        cur->get_tostring_fn = owl_variable_int_get_tostring_default;     
528      if (!cur->delete_fn)
529        cur->delete_fn = owl_variable_delete_default;
530      cur->val = owl_malloc(sizeof(int));
531      cur->set_fn(cur, &cur->ival_default);
532      break;
533    default:
534      fprintf(stderr, "owl_variable_setup: invalid variable type\n");
535      return(-2);
536    }
537    owl_dict_insert_element(vd, cur->name, cur, NULL);
538  }
539  return 0;
540}
541
542void owl_variable_dict_add_variable(owl_vardict * vardict,
543                                    owl_variable * var) {
544  owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete);
545}
546
547owl_variable * owl_variable_newvar(const char *name, const char *summary, const char * description) {
548  owl_variable * var = owl_malloc(sizeof(owl_variable));
549  memset(var, 0, sizeof(owl_variable));
550  var->name = owl_strdup(name);
551  var->summary = owl_strdup(summary);
552  var->description = owl_strdup(description);
553  return var;
554}
555
556void owl_variable_update(owl_variable *var, const char *summary, const char *desc) {
557  if(var->summary) owl_free(var->summary);
558  var->summary = owl_strdup(summary);
559  if(var->description) owl_free(var->description);
560  var->description = owl_strdup(desc);
561}
562
563void owl_variable_dict_newvar_string(owl_vardict * vd, const char *name, const char *summ, const char * desc, const char * initval) {
564  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_STRING);
565  if(old) {
566    owl_variable_update(old, summ, desc);
567    if(old->pval_default) owl_free(old->pval_default);
568    old->pval_default = owl_strdup(initval);
569  } else {
570    owl_variable * var = owl_variable_newvar(name, summ, desc);
571    var->type = OWL_VARIABLE_STRING;
572    var->pval_default = owl_strdup(initval);
573    var->set_fn = owl_variable_string_set_default;
574    var->set_fromstring_fn = owl_variable_string_set_fromstring_default;
575    var->get_fn = owl_variable_get_default;
576    var->get_tostring_fn = owl_variable_string_get_tostring_default;
577    var->delete_fn = owl_variable_delete_default;
578    var->set_fn(var, initval);
579    owl_variable_dict_add_variable(vd, var);
580  }
581}
582
583void owl_variable_dict_newvar_int(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
584  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_INT);
585  if(old) {
586    owl_variable_update(old, summ, desc);
587    old->ival_default = initval;
588  } else {
589    owl_variable * var = owl_variable_newvar(name, summ, desc);
590    var->type = OWL_VARIABLE_INT;
591    var->ival_default = initval;
592    var->validate_fn = owl_variable_int_validate_default;
593    var->set_fn = owl_variable_int_set_default;
594    var->set_fromstring_fn = owl_variable_int_set_fromstring_default;
595    var->get_fn = owl_variable_get_default;
596    var->get_tostring_fn = owl_variable_int_get_tostring_default;
597    var->delete_fn = owl_variable_delete_default;
598    var->val = owl_malloc(sizeof(int));
599    var->set_fn(var, &initval);
600    owl_variable_dict_add_variable(vd, var);
601  }
602}
603
604void owl_variable_dict_newvar_bool(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
605  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_BOOL);
606  if(old) {
607    owl_variable_update(old, summ, desc);
608    old->ival_default = initval;
609  } else {
610    owl_variable * var = owl_variable_newvar(name, summ, desc);
611    var->type = OWL_VARIABLE_BOOL;
612    var->ival_default = initval;
613    var->validate_fn = owl_variable_bool_validate_default;
614    var->set_fn = owl_variable_bool_set_default;
615    var->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
616    var->get_fn = owl_variable_get_default;
617    var->get_tostring_fn = owl_variable_bool_get_tostring_default;
618    var->delete_fn = owl_variable_delete_default;
619    var->val = owl_malloc(sizeof(int));
620    var->set_fn(var, &initval);
621    owl_variable_dict_add_variable(vd, var);
622  }
623}
624
625void owl_variable_dict_cleanup(owl_vardict *d)
626{
627  owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete);
628}
629
630/* free the list with owl_variable_dict_namelist_cleanup */
631void owl_variable_dict_get_names(const owl_vardict *d, owl_list *l) {
632  owl_dict_get_keys(d, l);
633}
634
635void owl_variable_dict_namelist_cleanup(owl_list *l)
636{
637  owl_list_cleanup(l, owl_free);
638}
639
640void owl_variable_delete(owl_variable *v)
641{
642  if (v->delete_fn) v->delete_fn(v);
643  owl_free(v);
644}
645
646
647const char *owl_variable_get_description(const owl_variable *v) {
648  return v->description;
649}
650
651const char *owl_variable_get_summary(const owl_variable *v) {
652  return v->summary;
653}
654
655const char *owl_variable_get_validsettings(const owl_variable *v) {
656  if (v->validsettings) {
657    return v->validsettings;
658  } else {
659    return "";
660  }
661}
662
663/* functions for getting and setting variable values */
664
665/* returns 0 on success, prints a status msg if msg is true */
666int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) {
667  owl_variable *v;
668  char buff2[1024];
669  if (!name) return(-1);
670  v = owl_dict_find_element(d, name);
671  if (v == NULL) {
672    if (msg) owl_function_error("Unknown variable %s", name);
673    return -1;
674  }
675  if (!v->set_fromstring_fn) {
676    if (msg) owl_function_error("Variable %s is read-only", name);
677    return -1;   
678  }
679  if (requirebool && v->type!=OWL_VARIABLE_BOOL) {
680    if (msg) owl_function_error("Variable %s is not a boolean", name);
681    return -1;   
682  }
683  if (0 != v->set_fromstring_fn(v, value)) {
684    if (msg) owl_function_error("Unable to set %s (must be %s)", name, 
685                                  owl_variable_get_validsettings(v));
686    return -1;
687  }
688  if (msg && v->get_tostring_fn) {
689    v->get_tostring_fn(v, buff2, 1024, v->val);
690    owl_function_makemsg("%s = '%s'", name, buff2);
691  }   
692  return 0;
693}
694 
695int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) {
696  owl_variable *v;
697  if (!name) return(-1);
698  v = owl_dict_find_element(d, name);
699  if (v == NULL || !v->set_fn) return(-1);
700  if (v->type!=OWL_VARIABLE_STRING) return(-1);
701  return v->set_fn(v, newval);
702}
703 
704int owl_variable_set_int(owl_vardict *d, const char *name, int newval) {
705  owl_variable *v;
706  if (!name) return(-1);
707  v = owl_dict_find_element(d, name);
708  if (v == NULL || !v->set_fn) return(-1);
709  if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1);
710  return v->set_fn(v, &newval);
711}
712 
713int owl_variable_set_bool_on(owl_vardict *d, const char *name) {
714  return owl_variable_set_int(d,name,1);
715}
716
717int owl_variable_set_bool_off(owl_vardict *d, const char *name) {
718  return owl_variable_set_int(d,name,0);
719}
720
721int owl_variable_get_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) {
722  owl_variable *v;
723  if (!name) return(-1);
724  v = owl_dict_find_element(d, name);
725  if (v == NULL || !v->get_tostring_fn) return(-1);
726  return v->get_tostring_fn(v, buf, bufsize, v->val);
727}
728
729int owl_variable_get_default_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) {
730  owl_variable *v;
731  if (!name) return(-1);
732  v = owl_dict_find_element(d, name);
733  if (v == NULL || !v->get_tostring_fn) return(-1);
734  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
735    return v->get_tostring_fn(v, buf, bufsize, &(v->ival_default));
736  } else {
737    return v->get_tostring_fn(v, buf, bufsize, v->pval_default);
738  }
739}
740
741owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name, int require_type) {
742  owl_variable *v;
743  if (!name) return(NULL);
744  v = owl_dict_find_element(d, name);
745  if (v == NULL || !v->get_fn || v->type != require_type) return(NULL);
746  return v;
747}
748
749/* returns a reference */
750const void *owl_variable_get(const owl_vardict *d, const char *name, int require_type) {
751  owl_variable *v = owl_variable_get_var(d, name, require_type);
752  if(v == NULL) return NULL;
753  return v->get_fn(v);
754}
755
756/* returns a reference */
757const char *owl_variable_get_string(const owl_vardict *d, const char *name) {
758  return owl_variable_get(d,name, OWL_VARIABLE_STRING);
759}
760
761/* returns a reference */
762const void *owl_variable_get_other(const owl_vardict *d, const char *name) {
763  return owl_variable_get(d,name, OWL_VARIABLE_OTHER);
764}
765
766int owl_variable_get_int(const owl_vardict *d, const char *name) {
767  const int *pi;
768  pi = owl_variable_get(d,name,OWL_VARIABLE_INT);
769  if (!pi) return(-1);
770  return(*pi);
771}
772
773int owl_variable_get_bool(const owl_vardict *d, const char *name) {
774  const int *pi;
775  pi = owl_variable_get(d,name,OWL_VARIABLE_BOOL);
776  if (!pi) return(-1);
777  return(*pi);
778}
779
780void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) {
781  char defaultbuf[50];
782  char buf[1024];
783  int buflen = 1023;
784  owl_variable *v;
785
786  if (!name
787      || (v = owl_dict_find_element(d, name)) == NULL 
788      || !v->get_fn) {
789    snprintf(buf, buflen, "     No such variable '%s'\n", name);     
790    owl_fmtext_append_normal(fm, buf);
791    return;
792  }
793  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
794    v->get_tostring_fn(v, defaultbuf, 50, &(v->ival_default));
795  } else {
796    v->get_tostring_fn(v, defaultbuf, 50, v->pval_default);
797  }
798  snprintf(buf, buflen, OWL_TABSTR "%-20s - %s (default: '%s')\n", 
799                  v->name, 
800                  owl_variable_get_summary(v), defaultbuf);
801  owl_fmtext_append_normal(fm, buf);
802}
803
804void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) {
805  char buff[1024];
806  int bufflen = 1023;
807  owl_variable *v;
808
809  if (!name
810      || (v = owl_dict_find_element(d, name)) == NULL 
811      || !v->get_fn) {
812    owl_fmtext_append_normal(fm, "No such variable...\n");
813    return;
814  }
815
816  owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
817  owl_fmtext_append_normal(fm, OWL_TABSTR);
818  owl_fmtext_append_normal(fm, name);
819  owl_fmtext_append_normal(fm, " - ");
820  owl_fmtext_append_normal(fm, v->summary);
821  owl_fmtext_append_normal(fm, "\n\n");
822
823  owl_fmtext_append_normal(fm, "Current:        ");
824  owl_variable_get_tostring(d, name, buff, bufflen);
825  owl_fmtext_append_normal(fm, buff);
826  owl_fmtext_append_normal(fm, "\n\n");
827
828
829  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
830    v->get_tostring_fn(v, buff, bufflen, &(v->ival_default));
831  } else {
832    v->get_tostring_fn(v, buff, bufflen, v->pval_default);
833  }
834  owl_fmtext_append_normal(fm, "Default:        ");
835  owl_fmtext_append_normal(fm, buff);
836  owl_fmtext_append_normal(fm, "\n\n");
837
838  owl_fmtext_append_normal(fm, "Valid Settings: ");
839  owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
840  owl_fmtext_append_normal(fm, "\n\n");
841
842  if (v->description && *v->description) {
843    owl_fmtext_append_normal(fm, "Description:\n");
844    owl_fmtext_append_normal(fm, owl_variable_get_description(v));
845    owl_fmtext_append_normal(fm, "\n\n");
846  }
847}
848
849
850
851
852/**************************************************************************/
853/*********************** GENERAL TYPE-SPECIFIC ****************************/
854/**************************************************************************/
855
856/* default common functions */
857
858const void *owl_variable_get_default(const owl_variable *v) {
859  return v->val;
860}
861
862void owl_variable_delete_default(owl_variable *v)
863{
864  if (v->val) owl_free(v->val);
865}
866
867/* default functions for booleans */
868
869int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) {
870  if (newval == NULL) return(0);
871  else if (*(const int*)newval==1 || *(const int*)newval==0) return(1);
872  else return (0);
873}
874
875int owl_variable_bool_set_default(owl_variable *v, const void *newval) {
876  if (v->validate_fn) {
877    if (!v->validate_fn(v, newval)) return(-1);
878  }
879  *(int*)v->val = *(const int*)newval;
880  return(0);
881}
882
883int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) {
884  int i;
885  if (!strcmp(newval, "on")) i=1;
886  else if (!strcmp(newval, "off")) i=0;
887  else return(-1);
888  return (v->set_fn(v, &i));
889}
890
891int owl_variable_bool_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
892  if (val == NULL) {
893    snprintf(buf, bufsize, "<null>");
894    return -1;
895  } else if (*(const int*)val == 0) {
896    snprintf(buf, bufsize, "off");
897    return 0;
898  } else if (*(const int*)val == 1) {
899    snprintf(buf, bufsize, "on");
900    return 0;
901  } else {
902    snprintf(buf, bufsize, "<invalid>");
903    return -1;
904  }
905}
906
907/* default functions for integers */
908
909int owl_variable_int_validate_default(const owl_variable *v, const void *newval) {
910  if (newval == NULL) return(0);
911  else return (1);
912}
913
914int owl_variable_int_set_default(owl_variable *v, const void *newval) {
915  if (v->validate_fn) {
916    if (!v->validate_fn(v, newval)) return(-1);
917  }
918  *(int*)v->val = *(const int*)newval;
919  return(0);
920}
921
922int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) {
923  int i;
924  char *ep;
925  i = strtol(newval, &ep, 10);
926  if (*ep || ep==newval) return(-1);
927  return (v->set_fn(v, &i));
928}
929
930int owl_variable_int_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
931  if (val == NULL) {
932    snprintf(buf, bufsize, "<null>");
933    return -1;
934  } else {
935    snprintf(buf, bufsize, "%d", *(const int*)val);
936    return 0;
937  } 
938}
939
940/* default functions for enums (a variant of integers) */
941
942int owl_variable_enum_validate(const owl_variable *v, const void *newval) { 
943  char **enums;
944  int nenums, val;
945  if (newval == NULL) return(0);
946  enums = atokenize(v->validsettings, ",", &nenums);
947  if (enums == NULL) return(0);
948  atokenize_delete(enums, nenums);
949  val = *(const int*)newval;
950  if (val < 0 || val >= nenums) {
951    return(0);
952  }
953  return(1);
954}
955
956int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) {
957  char **enums;
958  int nenums, i, val=-1;
959  if (newval == NULL) return(-1);
960  enums = atokenize(v->validsettings, ",", &nenums);
961  if (enums == NULL) return(-1);
962  for (i=0; i<nenums; i++) {
963    if (0==strcmp(newval, enums[i])) {
964      val = i;
965    }
966  }
967  atokenize_delete(enums, nenums);
968  if (val == -1) return(-1);
969  return (v->set_fn(v, &val));
970}
971
972int owl_variable_enum_get_tostring(const owl_variable *v, char* buf, int bufsize, const void *val) {
973  char **enums;
974  int nenums, i;
975
976  if (val == NULL) {
977    snprintf(buf, bufsize, "<null>");
978    return -1;
979  }
980  enums = atokenize(v->validsettings, ",", &nenums);
981  i = *(const int*)val;
982  if (i<0 || i>=nenums) {
983    snprintf(buf, bufsize, "<invalid:%d>",i);
984    atokenize_delete(enums, nenums);
985    return(-1);
986  }
987  snprintf(buf, bufsize, "%s", enums[i]);
988  atokenize_delete(enums, nenums);
989  return 0;
990}
991
992/* default functions for stringeans */
993
994int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) {
995  if (newval == NULL) return(0);
996  else return (1);
997}
998
999int owl_variable_string_set_default(owl_variable *v, const void *newval) {
1000  if (v->validate_fn) {
1001    if (!v->validate_fn(v, newval)) return(-1);
1002  }
1003  if (v->val) owl_free(v->val);
1004  v->val = owl_strdup(newval);
1005  return(0);
1006}
1007
1008int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) {
1009  return (v->set_fn(v, newval));
1010}
1011
1012int owl_variable_string_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) {
1013  if (val == NULL) {
1014    snprintf(buf, bufsize, "<null>");
1015    return -1;
1016  } else {
1017    snprintf(buf, bufsize, "%s", (const char*)val);
1018    return 0;
1019  }
1020}
1021
Note: See TracBrowser for help on using the repository browser.