source: variable.c @ 4c7c21f

release-1.8release-1.9
Last change on this file since 4c7c21f was 4c7c21f, checked in by David Benjamin <davidben@mit.edu>, 7 years ago
owl_dict_create also never fails And like everywhere else, we weren't checking the return values most of the time anyway.
  • Property mode set to 100644
File size: 41.9 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,validset,summary,description,validate,set,get) \
33        { name, OWL_VARIABLE_STRING, default, 0, validset, 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 */, "", "<string>", "tty name for zephyr location", "",
269                      NULL, owl_variable_tty_set, NULL),
270
271  OWLVAR_STRING( "default_style" /* %OwlVarStub */, "default",
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  OWLVAR_STRING_FULL( "default_exposure" /* %OwlVarStub */, "",
373                      "none,opstaff,realm-visible,realm-announced,net-visible,net-announced",
374                      "controls the persistent value for exposure",
375                      "The default exposure level corresponds to the Zephyr exposure value\n"
376                      "in ~/.zephyr.vars.  Defaults to realm-visible if there is no value in\n"
377                      "~/.zephyr.vars.\n"
378                      "See the description of exposure for the values this can be.",
379                      NULL, owl_variable_default_exposure_set, owl_variable_default_exposure_get ),
380
381  OWLVAR_STRING_FULL( "exposure" /* %OwlVarStub */, "",
382                      "none,opstaff,realm-visible,realm-announced,net-visible,net-announced",
383                      "controls who can zlocate you",
384                      "The exposure level, defaulting to the value of default_exposure,\n"
385                      "can be one of the following (from least exposure to widest exposure,\n"
386                      "as listed in zctl(1)):\n"
387                      "\n"
388                      "   none            - This completely disables Zephyr for the user. \n"
389                      "                     The user is not registered with Zephyr.  No user\n"
390                      "                     location information is retained by Zephyr.  No\n"
391                      "                     login or logout announcements will be sent.  No\n"
392                      "                     subscriptions will be entered for the user, and\n"
393                      "                     no notices will be displayed by zwgc(1).\n"
394                      "   opstaff         - The user is registered with Zephyr.  No login or\n"
395                      "                     logout announcements will be sent, and location\n"
396                      "                     information will only be visible to Operations\n"
397                      "                     staff.  Default subscriptions and any additional\n"
398                      "                     personal subscriptions will be entered for the\n"
399                      "                     user.\n"
400                      "   realm-visible   - The user is registered with Zephyr.  User\n"
401                      "                     location information is retained by Zephyr and\n"
402                      "                     made available only to users within the user’s\n"
403                      "                     Kerberos realm.  No login or logout\n"
404                      "                     announcements will be sent.  This is the system\n"
405                      "                     default.  Default subscriptions and any\n"
406                      "                     additional personal subscriptions will be\n"
407                      "                     entered for the user.\n"
408                      "   realm-announced - The user is registered with Zephyr.  User\n"
409                      "                     location information is retained by Zephyr and\n"
410                      "                     made available only to users authenticated\n"
411                      "                     within the user’s Kerberos realm.  Login and\n"
412                      "                     logout announcements will be sent, but only to\n"
413                      "                     users within the user’s Kerberos realm who have\n"
414                      "                     explicitly requested such via subscriptions. \n"
415                      "                     Default subscriptions and any additional\n"
416                      "                     personal subscriptions will be entered for the\n"
417                      "                     user.\n"
418                      "   net-visible     - The user is registered with Zephyr.  User\n"
419                      "                     location information is retained by Zephyr and\n"
420                      "                     made available to any authenticated user who\n"
421                      "                     requests such.  Login and logout announcements\n"
422                      "                     will be sent only to users within the user’s\n"
423                      "                     Kerberos realm who have explicitly requested\n"
424                      "                     such via subscriptions.  Default subscriptions\n"
425                      "                     and any additional personal subscriptions will\n"
426                      "                     be entered for the user.\n"
427                      "   net-announced   - The user is registered with Zephyr.  User\n"
428                      "                     location information is retained by Zephyr and\n"
429                      "                     made available to any authenticated user who\n"
430                      "                     requests such.  Login and logout announcements\n"
431                      "                     will be sent to any user has requested such. \n"
432                      "                     Default subscriptions and any additional\n"
433                      "                     personal subscriptions will be entered for the\n"
434                      "                     user.\n",
435                      NULL, owl_variable_exposure_set, NULL /* use default for get */ ),
436
437  /* This MUST be last... */
438  { NULL, 0, NULL, 0, NULL, NULL, NULL, NULL,
439    NULL, NULL, NULL, NULL, NULL, NULL }
440
441};
442
443/**************************************************************************/
444/*********************** SPECIFIC TO VARIABLES ****************************/
445/**************************************************************************/
446
447
448/* commonly useful */
449
450int owl_variable_int_validate_gt0(const owl_variable *v, const void *newval)
451{
452  if (newval == NULL) return(0);
453  else if (*(const int*)newval < 1) return(0);
454  else return (1);
455}
456
457int owl_variable_int_validate_positive(const owl_variable *v, const void *newval)
458{
459  if (newval == NULL) return(0);
460  else if (*(const int*)newval < 0) return(0);
461  else return (1);
462}
463
464/* typewinsize */
465int owl_variable_typewinsize_set(owl_variable *v, const void *newval)
466{
467  int rv;
468  rv = owl_variable_int_set_default(v, newval);
469  if (0 == rv) owl_mainpanel_layout_contents(&g.mainpanel);
470  return(rv);
471}
472
473/* debug (cache value in g->debug) */
474int owl_variable_debug_set(owl_variable *v, const void *newval)
475{
476  if (newval && (*(const int*)newval == 1 || *(const int*)newval == 0)) {
477    g.debug = *(const int*)newval;
478  }
479  return owl_variable_bool_set_default(v, newval);
480}
481
482/* When 'aaway' is changed, need to notify the AIM server */
483int owl_variable_aaway_set(owl_variable *v, const void *newval)
484{
485  if (newval) {
486    if (*(const int*)newval == 1) {
487      owl_aim_set_awaymsg(owl_global_get_aaway_msg(&g));
488    } else if (*(const int*)newval == 0) {
489      owl_aim_set_awaymsg("");
490    }
491  }
492  return owl_variable_bool_set_default(v, newval);
493}
494
495int owl_variable_pseudologins_set(owl_variable *v, const void *newval)
496{
497  static owl_timer *timer = NULL;
498  if (newval) {
499    if (*(const int*)newval == 1) {
500      owl_function_zephyr_buddy_check(0);
501      if (timer == NULL) {
502        timer = owl_select_add_timer("owl_zephyr_buddycheck_timer",
503                                     180, 180, owl_zephyr_buddycheck_timer, NULL, NULL);
504      }
505    } else {
506      if (timer != NULL) {
507        owl_select_remove_timer(timer);
508        timer = NULL;
509      }
510    }
511  }
512  return owl_variable_bool_set_default(v, newval);
513}
514
515/* note that changing the value of this will clobber
516 * any user setting of this */
517int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval)
518{
519  if (newval && !owl_context_is_startup(owl_global_get_context(&g))) {
520    if (*(const int*)newval == 2) {
521      owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char");
522    } else if (*(const int*)newval == 1) {
523      owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete");
524    } else {
525      owl_function_command_norv("bindkey editmulti C-d command edit:done");
526    }
527  } 
528  return owl_variable_int_set_default(v, newval); 
529}
530
531int owl_variable_tty_set(owl_variable *v, const void *newval)
532{
533  owl_zephyr_set_locationinfo(g_get_host_name(), newval);
534  return(owl_variable_string_set_default(v, newval));
535}
536
537int owl_variable_default_exposure_set(owl_variable *v, const void *newval)
538{
539  return owl_zephyr_set_default_exposure(newval);
540}
541
542const void *owl_variable_default_exposure_get(const owl_variable *v)
543{
544  return owl_zephyr_get_default_exposure();
545}
546
547int owl_variable_exposure_set(owl_variable *v, const void *newval)
548{
549  int ret = owl_zephyr_set_exposure(newval);
550  if (ret != 0)
551    return ret;
552  return owl_variable_string_set_default(v, owl_zephyr_normalize_exposure(newval));
553}
554
555/**************************************************************************/
556/****************************** GENERAL ***********************************/
557/**************************************************************************/
558
559int owl_variable_dict_setup(owl_vardict *vd) {
560  owl_variable *var, *cur;
561  owl_dict_create(vd);
562  for (var = variables_to_init; var->name != NULL; var++) {
563    cur = g_new(owl_variable, 1);
564    *cur = *var;
565    /* strdup all the strings so we can delete them consistently. */
566    cur->name = g_strdup(var->name);
567    cur->summary = g_strdup(var->summary);
568    cur->description = g_strdup(var->description);
569    switch (cur->type) {
570    case OWL_VARIABLE_OTHER:
571      cur->set_fn(cur, cur->pval_default);
572      break;
573    case OWL_VARIABLE_STRING:
574      if (!cur->validate_fn) 
575        cur->validate_fn = owl_variable_string_validate_default;
576      if (!cur->set_fn) 
577        cur->set_fn = owl_variable_string_set_default;
578      if (!cur->set_fromstring_fn) 
579        cur->set_fromstring_fn = owl_variable_string_set_fromstring_default;
580      if (!cur->get_fn) 
581        cur->get_fn = owl_variable_get_default;
582      if (!cur->get_tostring_fn) 
583        cur->get_tostring_fn = owl_variable_string_get_tostring_default;     
584      if (!cur->delete_fn)
585        cur->delete_fn = owl_variable_delete_default;
586      cur->set_fn(cur, cur->pval_default);
587      break;
588    case OWL_VARIABLE_BOOL:
589      if (!cur->validate_fn) 
590        cur->validate_fn = owl_variable_bool_validate_default;
591      if (!cur->set_fn) 
592        cur->set_fn = owl_variable_bool_set_default;
593      if (!cur->set_fromstring_fn) 
594        cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
595      if (!cur->get_fn) 
596        cur->get_fn = owl_variable_get_default;
597      if (!cur->get_tostring_fn) 
598        cur->get_tostring_fn = owl_variable_bool_get_tostring_default;     
599      if (!cur->delete_fn)
600        cur->delete_fn = owl_variable_delete_default;
601      cur->val = g_new(int, 1);
602      cur->set_fn(cur, &cur->ival_default);
603      break;
604    case OWL_VARIABLE_INT:
605      if (!cur->validate_fn) 
606        cur->validate_fn = owl_variable_int_validate_default;
607      if (!cur->set_fn) 
608        cur->set_fn = owl_variable_int_set_default;
609      if (!cur->set_fromstring_fn) 
610        cur->set_fromstring_fn = owl_variable_int_set_fromstring_default;
611      if (!cur->get_fn) 
612        cur->get_fn = owl_variable_get_default;
613      if (!cur->get_tostring_fn) 
614        cur->get_tostring_fn = owl_variable_int_get_tostring_default;     
615      if (!cur->delete_fn)
616        cur->delete_fn = owl_variable_delete_default;
617      cur->val = g_new(int, 1);
618      cur->set_fn(cur, &cur->ival_default);
619      break;
620    default:
621      fprintf(stderr, "owl_variable_setup: invalid variable type\n");
622      return(-2);
623    }
624    owl_dict_insert_element(vd, cur->name, cur, NULL);
625  }
626  return 0;
627}
628
629void owl_variable_dict_add_variable(owl_vardict * vardict,
630                                    owl_variable * var) {
631  owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete);
632}
633
634owl_variable * owl_variable_newvar(const char *name, const char *summary, const char * description) {
635  owl_variable * var = g_new0(owl_variable, 1);
636  var->name = g_strdup(name);
637  var->summary = g_strdup(summary);
638  var->description = g_strdup(description);
639  return var;
640}
641
642void owl_variable_update(owl_variable *var, const char *summary, const char *desc) {
643  g_free(var->summary);
644  var->summary = g_strdup(summary);
645  g_free(var->description);
646  var->description = g_strdup(desc);
647}
648
649void owl_variable_dict_newvar_string(owl_vardict * vd, const char *name, const char *summ, const char * desc, const char * initval) {
650  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_STRING);
651  if(old) {
652    owl_variable_update(old, summ, desc);
653    g_free(old->pval_default);
654    old->pval_default = g_strdup(initval);
655  } else {
656    owl_variable * var = owl_variable_newvar(name, summ, desc);
657    var->type = OWL_VARIABLE_STRING;
658    var->pval_default = g_strdup(initval);
659    var->set_fn = owl_variable_string_set_default;
660    var->set_fromstring_fn = owl_variable_string_set_fromstring_default;
661    var->get_fn = owl_variable_get_default;
662    var->get_tostring_fn = owl_variable_string_get_tostring_default;
663    var->delete_fn = owl_variable_delete_default;
664    var->set_fn(var, initval);
665    owl_variable_dict_add_variable(vd, var);
666  }
667}
668
669void owl_variable_dict_newvar_int(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
670  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_INT);
671  if(old) {
672    owl_variable_update(old, summ, desc);
673    old->ival_default = initval;
674  } else {
675    owl_variable * var = owl_variable_newvar(name, summ, desc);
676    var->type = OWL_VARIABLE_INT;
677    var->ival_default = initval;
678    var->validate_fn = owl_variable_int_validate_default;
679    var->set_fn = owl_variable_int_set_default;
680    var->set_fromstring_fn = owl_variable_int_set_fromstring_default;
681    var->get_fn = owl_variable_get_default;
682    var->get_tostring_fn = owl_variable_int_get_tostring_default;
683    var->delete_fn = owl_variable_delete_default;
684    var->val = g_new(int, 1);
685    var->set_fn(var, &initval);
686    owl_variable_dict_add_variable(vd, var);
687  }
688}
689
690void owl_variable_dict_newvar_bool(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
691  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_BOOL);
692  if(old) {
693    owl_variable_update(old, summ, desc);
694    old->ival_default = initval;
695  } else {
696    owl_variable * var = owl_variable_newvar(name, summ, desc);
697    var->type = OWL_VARIABLE_BOOL;
698    var->ival_default = initval;
699    var->validate_fn = owl_variable_bool_validate_default;
700    var->set_fn = owl_variable_bool_set_default;
701    var->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
702    var->get_fn = owl_variable_get_default;
703    var->get_tostring_fn = owl_variable_bool_get_tostring_default;
704    var->delete_fn = owl_variable_delete_default;
705    var->val = g_new(int, 1);
706    var->set_fn(var, &initval);
707    owl_variable_dict_add_variable(vd, var);
708  }
709}
710
711void owl_variable_dict_cleanup(owl_vardict *d)
712{
713  owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete);
714}
715
716void owl_variable_dict_get_names(const owl_vardict *d, owl_list *l) {
717  owl_dict_get_keys(d, l);
718}
719
720void owl_variable_delete(owl_variable *v)
721{
722  if (v->delete_fn) v->delete_fn(v);
723  g_free(v->name);
724  g_free(v->summary);
725  g_free(v->description);
726  g_free(v);
727}
728
729
730const char *owl_variable_get_description(const owl_variable *v) {
731  return v->description;
732}
733
734const char *owl_variable_get_summary(const owl_variable *v) {
735  return v->summary;
736}
737
738const char *owl_variable_get_validsettings(const owl_variable *v) {
739  if (v->validsettings) {
740    return v->validsettings;
741  } else {
742    return "";
743  }
744}
745
746/* functions for getting and setting variable values */
747
748/* returns 0 on success, prints a status msg if msg is true */
749int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) {
750  owl_variable *v;
751  char *tostring;
752  if (!name) return(-1);
753  v = owl_dict_find_element(d, name);
754  if (v == NULL) {
755    if (msg) owl_function_error("Unknown variable %s", name);
756    return -1;
757  }
758  if (!v->set_fromstring_fn) {
759    if (msg) owl_function_error("Variable %s is read-only", name);
760    return -1;   
761  }
762  if (requirebool && v->type!=OWL_VARIABLE_BOOL) {
763    if (msg) owl_function_error("Variable %s is not a boolean", name);
764    return -1;   
765  }
766  if (0 != v->set_fromstring_fn(v, value)) {
767    if (msg) owl_function_error("Unable to set %s (must be %s)", name, 
768                                  owl_variable_get_validsettings(v));
769    return -1;
770  }
771  if (msg && v->get_tostring_fn) {
772    tostring = v->get_tostring_fn(v, v->get_fn(v));
773    owl_function_makemsg("%s = '%s'", name, tostring);
774    g_free(tostring);
775  }   
776  return 0;
777}
778 
779int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) {
780  owl_variable *v;
781  if (!name) return(-1);
782  v = owl_dict_find_element(d, name);
783  if (v == NULL || !v->set_fn) return(-1);
784  if (v->type!=OWL_VARIABLE_STRING) return(-1);
785  return v->set_fn(v, newval);
786}
787 
788int owl_variable_set_int(owl_vardict *d, const char *name, int newval) {
789  owl_variable *v;
790  if (!name) return(-1);
791  v = owl_dict_find_element(d, name);
792  if (v == NULL || !v->set_fn) return(-1);
793  if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1);
794  return v->set_fn(v, &newval);
795}
796 
797int owl_variable_set_bool_on(owl_vardict *d, const char *name) {
798  return owl_variable_set_int(d,name,1);
799}
800
801int owl_variable_set_bool_off(owl_vardict *d, const char *name) {
802  return owl_variable_set_int(d,name,0);
803}
804
805char *owl_variable_get_tostring(const owl_vardict *d, const char *name) {
806  owl_variable *v;
807  if (!name) return NULL;
808  v = owl_dict_find_element(d, name);
809  if (v == NULL || !v->get_tostring_fn) return NULL;
810  return v->get_tostring_fn(v, v->get_fn(v));
811}
812
813char *owl_variable_get_default_tostring(const owl_vardict *d, const char *name) {
814  owl_variable *v;
815  if (!name) return NULL;
816  v = owl_dict_find_element(d, name);
817  if (v == NULL || !v->get_tostring_fn) return NULL;
818  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
819    return v->get_tostring_fn(v, &(v->ival_default));
820  } else {
821    return v->get_tostring_fn(v, v->pval_default);
822  }
823}
824
825owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name, int require_type) {
826  owl_variable *v;
827  if (!name) return(NULL);
828  v = owl_dict_find_element(d, name);
829  if (v == NULL || !v->get_fn || v->type != require_type) return(NULL);
830  return v;
831}
832
833/* returns a reference */
834const void *owl_variable_get(const owl_vardict *d, const char *name, int require_type) {
835  owl_variable *v = owl_variable_get_var(d, name, require_type);
836  if(v == NULL) return NULL;
837  return v->get_fn(v);
838}
839
840/* returns a reference */
841const char *owl_variable_get_string(const owl_vardict *d, const char *name) {
842  return owl_variable_get(d,name, OWL_VARIABLE_STRING);
843}
844
845/* returns a reference */
846const void *owl_variable_get_other(const owl_vardict *d, const char *name) {
847  return owl_variable_get(d,name, OWL_VARIABLE_OTHER);
848}
849
850int owl_variable_get_int(const owl_vardict *d, const char *name) {
851  const int *pi;
852  pi = owl_variable_get(d,name,OWL_VARIABLE_INT);
853  if (!pi) return(-1);
854  return(*pi);
855}
856
857int owl_variable_get_bool(const owl_vardict *d, const char *name) {
858  const int *pi;
859  pi = owl_variable_get(d,name,OWL_VARIABLE_BOOL);
860  if (!pi) return(-1);
861  return(*pi);
862}
863
864void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) {
865  char *default_buf;
866  owl_variable *v;
867
868  if (!name
869      || (v = owl_dict_find_element(d, name)) == NULL 
870      || !v->get_fn) {
871    owl_fmtext_appendf_normal(fm, "     No such variable '%s'\n", name);
872    return;
873  }
874  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
875    default_buf = v->get_tostring_fn(v, &(v->ival_default));
876  } else {
877    default_buf = v->get_tostring_fn(v, v->pval_default);
878  }
879  owl_fmtext_appendf_normal(fm, OWL_TABSTR "%-20s - %s (default: '%s')\n",
880                            v->name,
881                            owl_variable_get_summary(v), default_buf);
882  g_free(default_buf);
883}
884
885void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) {
886  char *tostring;
887  owl_variable *v;
888
889  if (!name
890      || (v = owl_dict_find_element(d, name)) == NULL 
891      || !v->get_fn) {
892    owl_fmtext_append_normal(fm, "No such variable...\n");
893    return;
894  }
895
896  owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
897  owl_fmtext_append_normal(fm, OWL_TABSTR);
898  owl_fmtext_append_normal(fm, name);
899  owl_fmtext_append_normal(fm, " - ");
900  owl_fmtext_append_normal(fm, v->summary);
901  owl_fmtext_append_normal(fm, "\n\n");
902
903  owl_fmtext_append_normal(fm, "Current:        ");
904  tostring = owl_variable_get_tostring(d, name);
905  owl_fmtext_append_normal(fm, tostring);
906  g_free(tostring);
907  owl_fmtext_append_normal(fm, "\n\n");
908
909
910  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
911    tostring = v->get_tostring_fn(v, &(v->ival_default));
912  } else {
913    tostring = v->get_tostring_fn(v, v->pval_default);
914  }
915  owl_fmtext_append_normal(fm, "Default:        ");
916  owl_fmtext_append_normal(fm, tostring);
917  owl_fmtext_append_normal(fm, "\n\n");
918
919  owl_fmtext_append_normal(fm, "Valid Settings: ");
920  owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
921  owl_fmtext_append_normal(fm, "\n\n");
922
923  if (v->description && *v->description) {
924    owl_fmtext_append_normal(fm, "Description:\n");
925    owl_fmtext_append_normal(fm, owl_variable_get_description(v));
926    owl_fmtext_append_normal(fm, "\n\n");
927  }
928  g_free(tostring);
929}
930
931
932
933
934/**************************************************************************/
935/*********************** GENERAL TYPE-SPECIFIC ****************************/
936/**************************************************************************/
937
938/* default common functions */
939
940const void *owl_variable_get_default(const owl_variable *v) {
941  return v->val;
942}
943
944void owl_variable_delete_default(owl_variable *v)
945{
946  g_free(v->val);
947}
948
949/* default functions for booleans */
950
951int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) {
952  if (newval == NULL) return(0);
953  else if (*(const int*)newval==1 || *(const int*)newval==0) return(1);
954  else return (0);
955}
956
957int owl_variable_bool_set_default(owl_variable *v, const void *newval) {
958  if (v->validate_fn) {
959    if (!v->validate_fn(v, newval)) return(-1);
960  }
961  *(int*)v->val = *(const int*)newval;
962  return(0);
963}
964
965int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) {
966  int i;
967  if (!strcmp(newval, "on")) i=1;
968  else if (!strcmp(newval, "off")) i=0;
969  else return(-1);
970  return (v->set_fn(v, &i));
971}
972
973char *owl_variable_bool_get_tostring_default(const owl_variable *v, const void *val) {
974  if (val == NULL) {
975    return g_strdup("<null>");
976  } else if (*(const int*)val == 0) {
977    return g_strdup("off");
978  } else if (*(const int*)val == 1) {
979    return g_strdup("on");
980  } else {
981    return g_strdup("<invalid>");
982  }
983}
984
985/* default functions for integers */
986
987int owl_variable_int_validate_default(const owl_variable *v, const void *newval) {
988  if (newval == NULL) return(0);
989  else return (1);
990}
991
992int owl_variable_int_set_default(owl_variable *v, const void *newval) {
993  if (v->validate_fn) {
994    if (!v->validate_fn(v, newval)) return(-1);
995  }
996  *(int*)v->val = *(const int*)newval;
997  return(0);
998}
999
1000int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) {
1001  int i;
1002  char *ep;
1003  i = strtol(newval, &ep, 10);
1004  if (*ep || ep==newval) return(-1);
1005  return (v->set_fn(v, &i));
1006}
1007
1008char *owl_variable_int_get_tostring_default(const owl_variable *v, const void *val) {
1009  if (val == NULL) {
1010    return g_strdup("<null>");
1011  } else {
1012    return g_strdup_printf("%d", *(const int*)val);
1013  } 
1014}
1015
1016/* default functions for enums (a variant of integers) */
1017
1018int owl_variable_enum_validate(const owl_variable *v, const void *newval) { 
1019  char **enums;
1020  int nenums, val;
1021  if (newval == NULL) return(0);
1022  enums = g_strsplit_set(v->validsettings, ",", 0);
1023  nenums = g_strv_length(enums);
1024  g_strfreev(enums);
1025  val = *(const int*)newval;
1026  if (val < 0 || val >= nenums) {
1027    return(0);
1028  }
1029  return(1);
1030}
1031
1032int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) {
1033  char **enums;
1034  int i, val=-1;
1035  if (newval == NULL) return(-1);
1036  enums = g_strsplit_set(v->validsettings, ",", 0);
1037  for (i = 0; enums[i] != NULL; i++) {
1038    if (0==strcmp(newval, enums[i])) {
1039      val = i;
1040    }
1041  }
1042  g_strfreev(enums);
1043  if (val == -1) return(-1);
1044  return (v->set_fn(v, &val));
1045}
1046
1047char *owl_variable_enum_get_tostring(const owl_variable *v, const void *val) {
1048  char **enums;
1049  int nenums, i;
1050  char *tostring;
1051
1052  if (val == NULL) {
1053    return g_strdup("<null>");
1054  }
1055  enums = g_strsplit_set(v->validsettings, ",", 0);
1056  nenums = g_strv_length(enums);
1057  i = *(const int*)val;
1058  if (i<0 || i>=nenums) {
1059    g_strfreev(enums);
1060    return g_strdup_printf("<invalid:%d>", i);
1061  }
1062  tostring = g_strdup(enums[i]);
1063  g_strfreev(enums);
1064  return tostring;
1065}
1066
1067/* default functions for stringeans */
1068
1069int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) {
1070  if (newval == NULL) return(0);
1071  else return (1);
1072}
1073
1074int owl_variable_string_set_default(owl_variable *v, const void *newval) {
1075  if (v->validate_fn) {
1076    if (!v->validate_fn(v, newval)) return(-1);
1077  }
1078  g_free(v->val);
1079  v->val = g_strdup(newval);
1080  return(0);
1081}
1082
1083int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) {
1084  return (v->set_fn(v, newval));
1085}
1086
1087char *owl_variable_string_get_tostring_default(const owl_variable *v, const void *val) {
1088  if (val == NULL) {
1089    return g_strdup("<null>");
1090  } else {
1091    return g_strdup((const char*)val);
1092  }
1093}
1094
Note: See TracBrowser for help on using the repository browser.