source: variable.c @ 89fe67e

Last change on this file since 89fe67e was 89fe67e, checked in by David Benjamin <davidben@mit.edu>, 10 years ago
Convert pseudologins timer to glib timers
  • Property mode set to 100644
File size: 41.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,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 guint timer = 0;
498  if (newval) {
499    if (*(const int*)newval == 1) {
500      owl_function_zephyr_buddy_check(0);
501      if (timer == 0) {
502        timer = g_timeout_add_seconds(180, owl_zephyr_buddycheck_timer, NULL);
503      }
504    } else {
505      if (timer != 0) {
506        g_source_remove(timer);
507        timer = 0;
508      }
509    }
510  }
511  return owl_variable_bool_set_default(v, newval);
512}
513
514/* note that changing the value of this will clobber
515 * any user setting of this */
516int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval)
517{
518  if (newval && !owl_context_is_startup(owl_global_get_context(&g))) {
519    if (*(const int*)newval == 2) {
520      owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char");
521    } else if (*(const int*)newval == 1) {
522      owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete");
523    } else {
524      owl_function_command_norv("bindkey editmulti C-d command edit:done");
525    }
526  } 
527  return owl_variable_int_set_default(v, newval); 
528}
529
530int owl_variable_tty_set(owl_variable *v, const void *newval)
531{
532  owl_zephyr_set_locationinfo(g_get_host_name(), newval);
533  return(owl_variable_string_set_default(v, newval));
534}
535
536int owl_variable_default_exposure_set(owl_variable *v, const void *newval)
537{
538  return owl_zephyr_set_default_exposure(newval);
539}
540
541const void *owl_variable_default_exposure_get(const owl_variable *v)
542{
543  return owl_zephyr_get_default_exposure();
544}
545
546int owl_variable_exposure_set(owl_variable *v, const void *newval)
547{
548  int ret = owl_zephyr_set_exposure(newval);
549  if (ret != 0)
550    return ret;
551  return owl_variable_string_set_default(v, owl_zephyr_normalize_exposure(newval));
552}
553
554/**************************************************************************/
555/****************************** GENERAL ***********************************/
556/**************************************************************************/
557
558int owl_variable_dict_setup(owl_vardict *vd) {
559  owl_variable *var, *cur;
560  owl_dict_create(vd);
561  for (var = variables_to_init; var->name != NULL; var++) {
562    cur = g_new(owl_variable, 1);
563    *cur = *var;
564    /* strdup all the strings so we can delete them consistently. */
565    cur->name = g_strdup(var->name);
566    cur->summary = g_strdup(var->summary);
567    cur->description = g_strdup(var->description);
568    switch (cur->type) {
569    case OWL_VARIABLE_OTHER:
570      cur->set_fn(cur, cur->pval_default);
571      break;
572    case OWL_VARIABLE_STRING:
573      if (!cur->validate_fn) 
574        cur->validate_fn = owl_variable_string_validate_default;
575      if (!cur->set_fn) 
576        cur->set_fn = owl_variable_string_set_default;
577      if (!cur->set_fromstring_fn) 
578        cur->set_fromstring_fn = owl_variable_string_set_fromstring_default;
579      if (!cur->get_fn) 
580        cur->get_fn = owl_variable_get_default;
581      if (!cur->get_tostring_fn) 
582        cur->get_tostring_fn = owl_variable_string_get_tostring_default;     
583      if (!cur->delete_fn)
584        cur->delete_fn = owl_variable_delete_default;
585      cur->set_fn(cur, cur->pval_default);
586      break;
587    case OWL_VARIABLE_BOOL:
588      if (!cur->validate_fn) 
589        cur->validate_fn = owl_variable_bool_validate_default;
590      if (!cur->set_fn) 
591        cur->set_fn = owl_variable_bool_set_default;
592      if (!cur->set_fromstring_fn) 
593        cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
594      if (!cur->get_fn) 
595        cur->get_fn = owl_variable_get_default;
596      if (!cur->get_tostring_fn) 
597        cur->get_tostring_fn = owl_variable_bool_get_tostring_default;     
598      if (!cur->delete_fn)
599        cur->delete_fn = owl_variable_delete_default;
600      cur->val = g_new(int, 1);
601      cur->set_fn(cur, &cur->ival_default);
602      break;
603    case OWL_VARIABLE_INT:
604      if (!cur->validate_fn) 
605        cur->validate_fn = owl_variable_int_validate_default;
606      if (!cur->set_fn) 
607        cur->set_fn = owl_variable_int_set_default;
608      if (!cur->set_fromstring_fn) 
609        cur->set_fromstring_fn = owl_variable_int_set_fromstring_default;
610      if (!cur->get_fn) 
611        cur->get_fn = owl_variable_get_default;
612      if (!cur->get_tostring_fn) 
613        cur->get_tostring_fn = owl_variable_int_get_tostring_default;     
614      if (!cur->delete_fn)
615        cur->delete_fn = owl_variable_delete_default;
616      cur->val = g_new(int, 1);
617      cur->set_fn(cur, &cur->ival_default);
618      break;
619    default:
620      fprintf(stderr, "owl_variable_setup: invalid variable type\n");
621      return(-2);
622    }
623    owl_dict_insert_element(vd, cur->name, cur, NULL);
624  }
625  return 0;
626}
627
628void owl_variable_dict_add_variable(owl_vardict * vardict,
629                                    owl_variable * var) {
630  owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete);
631}
632
633owl_variable * owl_variable_newvar(const char *name, const char *summary, const char * description) {
634  owl_variable * var = g_new0(owl_variable, 1);
635  var->name = g_strdup(name);
636  var->summary = g_strdup(summary);
637  var->description = g_strdup(description);
638  return var;
639}
640
641void owl_variable_update(owl_variable *var, const char *summary, const char *desc) {
642  g_free(var->summary);
643  var->summary = g_strdup(summary);
644  g_free(var->description);
645  var->description = g_strdup(desc);
646}
647
648void owl_variable_dict_newvar_string(owl_vardict * vd, const char *name, const char *summ, const char * desc, const char * initval) {
649  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_STRING);
650  if(old) {
651    owl_variable_update(old, summ, desc);
652    g_free(old->pval_default);
653    old->pval_default = g_strdup(initval);
654  } else {
655    owl_variable * var = owl_variable_newvar(name, summ, desc);
656    var->type = OWL_VARIABLE_STRING;
657    var->pval_default = g_strdup(initval);
658    var->set_fn = owl_variable_string_set_default;
659    var->set_fromstring_fn = owl_variable_string_set_fromstring_default;
660    var->get_fn = owl_variable_get_default;
661    var->get_tostring_fn = owl_variable_string_get_tostring_default;
662    var->delete_fn = owl_variable_delete_default;
663    var->set_fn(var, initval);
664    owl_variable_dict_add_variable(vd, var);
665  }
666}
667
668void owl_variable_dict_newvar_int(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
669  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_INT);
670  if(old) {
671    owl_variable_update(old, summ, desc);
672    old->ival_default = initval;
673  } else {
674    owl_variable * var = owl_variable_newvar(name, summ, desc);
675    var->type = OWL_VARIABLE_INT;
676    var->ival_default = initval;
677    var->validate_fn = owl_variable_int_validate_default;
678    var->set_fn = owl_variable_int_set_default;
679    var->set_fromstring_fn = owl_variable_int_set_fromstring_default;
680    var->get_fn = owl_variable_get_default;
681    var->get_tostring_fn = owl_variable_int_get_tostring_default;
682    var->delete_fn = owl_variable_delete_default;
683    var->val = g_new(int, 1);
684    var->set_fn(var, &initval);
685    owl_variable_dict_add_variable(vd, var);
686  }
687}
688
689void owl_variable_dict_newvar_bool(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) {
690  owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_BOOL);
691  if(old) {
692    owl_variable_update(old, summ, desc);
693    old->ival_default = initval;
694  } else {
695    owl_variable * var = owl_variable_newvar(name, summ, desc);
696    var->type = OWL_VARIABLE_BOOL;
697    var->ival_default = initval;
698    var->validate_fn = owl_variable_bool_validate_default;
699    var->set_fn = owl_variable_bool_set_default;
700    var->set_fromstring_fn = owl_variable_bool_set_fromstring_default;
701    var->get_fn = owl_variable_get_default;
702    var->get_tostring_fn = owl_variable_bool_get_tostring_default;
703    var->delete_fn = owl_variable_delete_default;
704    var->val = g_new(int, 1);
705    var->set_fn(var, &initval);
706    owl_variable_dict_add_variable(vd, var);
707  }
708}
709
710void owl_variable_dict_cleanup(owl_vardict *d)
711{
712  owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete);
713}
714
715void owl_variable_dict_get_names(const owl_vardict *d, owl_list *l) {
716  owl_dict_get_keys(d, l);
717}
718
719void owl_variable_delete(owl_variable *v)
720{
721  if (v->delete_fn) v->delete_fn(v);
722  g_free(v->name);
723  g_free(v->summary);
724  g_free(v->description);
725  g_free(v);
726}
727
728
729const char *owl_variable_get_description(const owl_variable *v) {
730  return v->description;
731}
732
733const char *owl_variable_get_summary(const owl_variable *v) {
734  return v->summary;
735}
736
737const char *owl_variable_get_validsettings(const owl_variable *v) {
738  if (v->validsettings) {
739    return v->validsettings;
740  } else {
741    return "";
742  }
743}
744
745/* functions for getting and setting variable values */
746
747/* returns 0 on success, prints a status msg if msg is true */
748int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) {
749  owl_variable *v;
750  char *tostring;
751  if (!name) return(-1);
752  v = owl_dict_find_element(d, name);
753  if (v == NULL) {
754    if (msg) owl_function_error("Unknown variable %s", name);
755    return -1;
756  }
757  if (!v->set_fromstring_fn) {
758    if (msg) owl_function_error("Variable %s is read-only", name);
759    return -1;   
760  }
761  if (requirebool && v->type!=OWL_VARIABLE_BOOL) {
762    if (msg) owl_function_error("Variable %s is not a boolean", name);
763    return -1;   
764  }
765  if (0 != v->set_fromstring_fn(v, value)) {
766    if (msg) owl_function_error("Unable to set %s (must be %s)", name, 
767                                  owl_variable_get_validsettings(v));
768    return -1;
769  }
770  if (msg && v->get_tostring_fn) {
771    tostring = v->get_tostring_fn(v, v->get_fn(v));
772    owl_function_makemsg("%s = '%s'", name, tostring);
773    g_free(tostring);
774  }   
775  return 0;
776}
777 
778int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) {
779  owl_variable *v;
780  if (!name) return(-1);
781  v = owl_dict_find_element(d, name);
782  if (v == NULL || !v->set_fn) return(-1);
783  if (v->type!=OWL_VARIABLE_STRING) return(-1);
784  return v->set_fn(v, newval);
785}
786 
787int owl_variable_set_int(owl_vardict *d, const char *name, int newval) {
788  owl_variable *v;
789  if (!name) return(-1);
790  v = owl_dict_find_element(d, name);
791  if (v == NULL || !v->set_fn) return(-1);
792  if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1);
793  return v->set_fn(v, &newval);
794}
795 
796int owl_variable_set_bool_on(owl_vardict *d, const char *name) {
797  return owl_variable_set_int(d,name,1);
798}
799
800int owl_variable_set_bool_off(owl_vardict *d, const char *name) {
801  return owl_variable_set_int(d,name,0);
802}
803
804char *owl_variable_get_tostring(const owl_vardict *d, const char *name) {
805  owl_variable *v;
806  if (!name) return NULL;
807  v = owl_dict_find_element(d, name);
808  if (v == NULL || !v->get_tostring_fn) return NULL;
809  return v->get_tostring_fn(v, v->get_fn(v));
810}
811
812char *owl_variable_get_default_tostring(const owl_vardict *d, const char *name) {
813  owl_variable *v;
814  if (!name) return NULL;
815  v = owl_dict_find_element(d, name);
816  if (v == NULL || !v->get_tostring_fn) return NULL;
817  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
818    return v->get_tostring_fn(v, &(v->ival_default));
819  } else {
820    return v->get_tostring_fn(v, v->pval_default);
821  }
822}
823
824owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name, int require_type) {
825  owl_variable *v;
826  if (!name) return(NULL);
827  v = owl_dict_find_element(d, name);
828  if (v == NULL || !v->get_fn || v->type != require_type) return(NULL);
829  return v;
830}
831
832/* returns a reference */
833const void *owl_variable_get(const owl_vardict *d, const char *name, int require_type) {
834  owl_variable *v = owl_variable_get_var(d, name, require_type);
835  if(v == NULL) return NULL;
836  return v->get_fn(v);
837}
838
839/* returns a reference */
840const char *owl_variable_get_string(const owl_vardict *d, const char *name) {
841  return owl_variable_get(d,name, OWL_VARIABLE_STRING);
842}
843
844/* returns a reference */
845const void *owl_variable_get_other(const owl_vardict *d, const char *name) {
846  return owl_variable_get(d,name, OWL_VARIABLE_OTHER);
847}
848
849int owl_variable_get_int(const owl_vardict *d, const char *name) {
850  const int *pi;
851  pi = owl_variable_get(d,name,OWL_VARIABLE_INT);
852  if (!pi) return(-1);
853  return(*pi);
854}
855
856int owl_variable_get_bool(const owl_vardict *d, const char *name) {
857  const int *pi;
858  pi = owl_variable_get(d,name,OWL_VARIABLE_BOOL);
859  if (!pi) return(-1);
860  return(*pi);
861}
862
863void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) {
864  char *default_buf;
865  owl_variable *v;
866
867  if (!name
868      || (v = owl_dict_find_element(d, name)) == NULL 
869      || !v->get_fn) {
870    owl_fmtext_appendf_normal(fm, "     No such variable '%s'\n", name);
871    return;
872  }
873  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
874    default_buf = v->get_tostring_fn(v, &(v->ival_default));
875  } else {
876    default_buf = v->get_tostring_fn(v, v->pval_default);
877  }
878  owl_fmtext_appendf_normal(fm, OWL_TABSTR "%-20s - %s (default: '%s')\n",
879                            v->name,
880                            owl_variable_get_summary(v), default_buf);
881  g_free(default_buf);
882}
883
884void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) {
885  char *tostring;
886  owl_variable *v;
887
888  if (!name
889      || (v = owl_dict_find_element(d, name)) == NULL 
890      || !v->get_fn) {
891    owl_fmtext_append_normal(fm, "No such variable...\n");
892    return;
893  }
894
895  owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
896  owl_fmtext_append_normal(fm, OWL_TABSTR);
897  owl_fmtext_append_normal(fm, name);
898  owl_fmtext_append_normal(fm, " - ");
899  owl_fmtext_append_normal(fm, v->summary);
900  owl_fmtext_append_normal(fm, "\n\n");
901
902  owl_fmtext_append_normal(fm, "Current:        ");
903  tostring = owl_variable_get_tostring(d, name);
904  owl_fmtext_append_normal(fm, tostring);
905  g_free(tostring);
906  owl_fmtext_append_normal(fm, "\n\n");
907
908
909  if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
910    tostring = v->get_tostring_fn(v, &(v->ival_default));
911  } else {
912    tostring = v->get_tostring_fn(v, v->pval_default);
913  }
914  owl_fmtext_append_normal(fm, "Default:        ");
915  owl_fmtext_append_normal(fm, tostring);
916  owl_fmtext_append_normal(fm, "\n\n");
917
918  owl_fmtext_append_normal(fm, "Valid Settings: ");
919  owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
920  owl_fmtext_append_normal(fm, "\n\n");
921
922  if (v->description && *v->description) {
923    owl_fmtext_append_normal(fm, "Description:\n");
924    owl_fmtext_append_normal(fm, owl_variable_get_description(v));
925    owl_fmtext_append_normal(fm, "\n\n");
926  }
927  g_free(tostring);
928}
929
930
931
932
933/**************************************************************************/
934/*********************** GENERAL TYPE-SPECIFIC ****************************/
935/**************************************************************************/
936
937/* default common functions */
938
939const void *owl_variable_get_default(const owl_variable *v) {
940  return v->val;
941}
942
943void owl_variable_delete_default(owl_variable *v)
944{
945  g_free(v->val);
946}
947
948/* default functions for booleans */
949
950int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) {
951  if (newval == NULL) return(0);
952  else if (*(const int*)newval==1 || *(const int*)newval==0) return(1);
953  else return (0);
954}
955
956int owl_variable_bool_set_default(owl_variable *v, const void *newval) {
957  if (v->validate_fn) {
958    if (!v->validate_fn(v, newval)) return(-1);
959  }
960  *(int*)v->val = *(const int*)newval;
961  return(0);
962}
963
964int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) {
965  int i;
966  if (!strcmp(newval, "on")) i=1;
967  else if (!strcmp(newval, "off")) i=0;
968  else return(-1);
969  return (v->set_fn(v, &i));
970}
971
972char *owl_variable_bool_get_tostring_default(const owl_variable *v, const void *val) {
973  if (val == NULL) {
974    return g_strdup("<null>");
975  } else if (*(const int*)val == 0) {
976    return g_strdup("off");
977  } else if (*(const int*)val == 1) {
978    return g_strdup("on");
979  } else {
980    return g_strdup("<invalid>");
981  }
982}
983
984/* default functions for integers */
985
986int owl_variable_int_validate_default(const owl_variable *v, const void *newval) {
987  if (newval == NULL) return(0);
988  else return (1);
989}
990
991int owl_variable_int_set_default(owl_variable *v, const void *newval) {
992  if (v->validate_fn) {
993    if (!v->validate_fn(v, newval)) return(-1);
994  }
995  *(int*)v->val = *(const int*)newval;
996  return(0);
997}
998
999int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) {
1000  int i;
1001  char *ep;
1002  i = strtol(newval, &ep, 10);
1003  if (*ep || ep==newval) return(-1);
1004  return (v->set_fn(v, &i));
1005}
1006
1007char *owl_variable_int_get_tostring_default(const owl_variable *v, const void *val) {
1008  if (val == NULL) {
1009    return g_strdup("<null>");
1010  } else {
1011    return g_strdup_printf("%d", *(const int*)val);
1012  } 
1013}
1014
1015/* default functions for enums (a variant of integers) */
1016
1017int owl_variable_enum_validate(const owl_variable *v, const void *newval) { 
1018  char **enums;
1019  int nenums, val;
1020  if (newval == NULL) return(0);
1021  enums = g_strsplit_set(v->validsettings, ",", 0);
1022  nenums = g_strv_length(enums);
1023  g_strfreev(enums);
1024  val = *(const int*)newval;
1025  if (val < 0 || val >= nenums) {
1026    return(0);
1027  }
1028  return(1);
1029}
1030
1031int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) {
1032  char **enums;
1033  int i, val=-1;
1034  if (newval == NULL) return(-1);
1035  enums = g_strsplit_set(v->validsettings, ",", 0);
1036  for (i = 0; enums[i] != NULL; i++) {
1037    if (0==strcmp(newval, enums[i])) {
1038      val = i;
1039    }
1040  }
1041  g_strfreev(enums);
1042  if (val == -1) return(-1);
1043  return (v->set_fn(v, &val));
1044}
1045
1046char *owl_variable_enum_get_tostring(const owl_variable *v, const void *val) {
1047  char **enums;
1048  int nenums, i;
1049  char *tostring;
1050
1051  if (val == NULL) {
1052    return g_strdup("<null>");
1053  }
1054  enums = g_strsplit_set(v->validsettings, ",", 0);
1055  nenums = g_strv_length(enums);
1056  i = *(const int*)val;
1057  if (i<0 || i>=nenums) {
1058    g_strfreev(enums);
1059    return g_strdup_printf("<invalid:%d>", i);
1060  }
1061  tostring = g_strdup(enums[i]);
1062  g_strfreev(enums);
1063  return tostring;
1064}
1065
1066/* default functions for stringeans */
1067
1068int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) {
1069  if (newval == NULL) return(0);
1070  else return (1);
1071}
1072
1073int owl_variable_string_set_default(owl_variable *v, const void *newval) {
1074  if (v->validate_fn) {
1075    if (!v->validate_fn(v, newval)) return(-1);
1076  }
1077  g_free(v->val);
1078  v->val = g_strdup(newval);
1079  return(0);
1080}
1081
1082int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) {
1083  return (v->set_fn(v, newval));
1084}
1085
1086char *owl_variable_string_get_tostring_default(const owl_variable *v, const void *val) {
1087  if (val == NULL) {
1088    return g_strdup("<null>");
1089  } else {
1090    return g_strdup((const char*)val);
1091  }
1092}
1093
Note: See TracBrowser for help on using the repository browser.