source: variable.c @ ca54fd6

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