[7d4fbcd] | 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 | |
---|
[aa2f33b3] | 8 | #define OWLVAR_BOOL(name,default,summary,description) \ |
---|
| 9 | { name, OWL_VARIABLE_BOOL, NULL, default, "on,off", summary,description, NULL, \ |
---|
[c1d9441] | 10 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
[7d4fbcd] | 11 | |
---|
[aa2f33b3] | 12 | #define OWLVAR_BOOL_FULL(name,default,summary,description,validate,set,get) \ |
---|
| 13 | { name, OWL_VARIABLE_BOOL, NULL, default, "on,off", summary,description, NULL, \ |
---|
[c1d9441] | 14 | validate, set, NULL, get, NULL, NULL } |
---|
[7d4fbcd] | 15 | |
---|
[aa2f33b3] | 16 | #define OWLVAR_INT(name,default,summary,description) \ |
---|
| 17 | { name, OWL_VARIABLE_INT, NULL, default, "<int>", summary,description, NULL, \ |
---|
[7d4fbcd] | 18 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
| 19 | |
---|
[aa2f33b3] | 20 | #define OWLVAR_INT_FULL(name,default,summary,description,validset,validate,set,get) \ |
---|
| 21 | { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \ |
---|
[7d4fbcd] | 22 | validate, set, NULL, get, NULL, NULL } |
---|
| 23 | |
---|
[aa2f33b3] | 24 | #define OWLVAR_PATH(name,default,summary,description) \ |
---|
| 25 | { name, OWL_VARIABLE_STRING, default, 0, "<path>", summary,description, NULL, \ |
---|
[7d4fbcd] | 26 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
| 27 | |
---|
[aa2f33b3] | 28 | #define OWLVAR_STRING(name,default,summary,description) \ |
---|
| 29 | { name, OWL_VARIABLE_STRING, default, 0, "<string>", summary,description, NULL, \ |
---|
[7d4fbcd] | 30 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
| 31 | |
---|
[c01e477] | 32 | #define OWLVAR_STRING_FULL(name,default,summary,description,validate,set,get) \ |
---|
| 33 | { name, OWL_VARIABLE_STRING, default, 0, "<string>", summary,description, NULL, \ |
---|
| 34 | validate, set, NULL, get, NULL, NULL } |
---|
| 35 | |
---|
[7d4fbcd] | 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. */ |
---|
[aa2f33b3] | 39 | #define OWLVAR_ENUM(name,default,summary,description,validset) \ |
---|
| 40 | { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \ |
---|
[7d4fbcd] | 41 | owl_variable_enum_validate, \ |
---|
| 42 | NULL, owl_variable_enum_set_fromstring, \ |
---|
| 43 | NULL, owl_variable_enum_get_tostring, \ |
---|
| 44 | NULL } |
---|
| 45 | |
---|
[aa2f33b3] | 46 | #define OWLVAR_ENUM_FULL(name,default,summary,description,validset,validate, set, get) \ |
---|
| 47 | { name, OWL_VARIABLE_INT, NULL, default, validset, summary,description, NULL, \ |
---|
[217a43e] | 48 | validate, \ |
---|
| 49 | set, owl_variable_enum_set_fromstring, \ |
---|
| 50 | get, owl_variable_enum_get_tostring, \ |
---|
| 51 | NULL } |
---|
| 52 | |
---|
[7d4fbcd] | 53 | static owl_variable variables_to_init[] = { |
---|
| 54 | |
---|
[5d365f6] | 55 | OWLVAR_STRING( "personalbell" /* %OwlVarStub */, "off", |
---|
[213a3eb] | 56 | "ring the terminal bell when personal messages are received", |
---|
[5d365f6] | 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"), |
---|
[7d4fbcd] | 59 | |
---|
| 60 | OWLVAR_BOOL( "bell" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 61 | "enable / disable the terminal bell", "" ), |
---|
[7d4fbcd] | 62 | |
---|
| 63 | OWLVAR_BOOL_FULL( "debug" /* %OwlVarStub */, OWL_DEBUG, |
---|
| 64 | "whether debugging is enabled", |
---|
[aa2f33b3] | 65 | "If set to 'on', debugging messages are logged to the\n" |
---|
| 66 | "file specified by the debugfile variable.\n", |
---|
[7d4fbcd] | 67 | NULL, owl_variable_debug_set, NULL), |
---|
| 68 | |
---|
| 69 | OWLVAR_BOOL( "startuplogin" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 70 | "send a login message when owl starts", "" ), |
---|
[7d4fbcd] | 71 | |
---|
| 72 | OWLVAR_BOOL( "shutdownlogout" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 73 | "send a logout message when owl exits", "" ), |
---|
[7d4fbcd] | 74 | |
---|
| 75 | OWLVAR_BOOL( "rxping" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 76 | "display received pings", "" ), |
---|
[7d4fbcd] | 77 | |
---|
| 78 | OWLVAR_BOOL( "txping" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 79 | "send pings", "" ), |
---|
[7d4fbcd] | 80 | |
---|
[73624b4] | 81 | OWLVAR_BOOL( "sepbar_disable" /* %OwlVarStub */, 0, |
---|
[451db9e] | 82 | "disable printing information in the separator bar", "" ), |
---|
[73624b4] | 83 | |
---|
[f9c43ae] | 84 | OWLVAR_BOOL( "smartstrip" /* %OwlVarStub */, 1, |
---|
| 85 | "strip kerberos instance for reply", ""), |
---|
| 86 | |
---|
[7e3e00a] | 87 | OWLVAR_BOOL( "newlinestrip" /* %OwlVarStub */, 1, |
---|
| 88 | "strip leading and trailing newlines", ""), |
---|
| 89 | |
---|
[7d4fbcd] | 90 | OWLVAR_BOOL( "displayoutgoing" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 91 | "display outgoing messages", "" ), |
---|
[7d4fbcd] | 92 | |
---|
| 93 | OWLVAR_BOOL( "loginsubs" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 94 | "load logins from .anyone on startup", "" ), |
---|
[7d4fbcd] | 95 | |
---|
| 96 | OWLVAR_BOOL( "logging" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 102 | |
---|
| 103 | OWLVAR_BOOL( "classlogging" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 110 | |
---|
[12c35df] | 111 | OWLVAR_ENUM( "loggingdirection" /* %OwlVarStub */, OWL_LOGGING_DIRECTION_BOTH, |
---|
[d544237] | 112 | "specifies which kind of messages should be logged", |
---|
[12c35df] | 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 | |
---|
[e1c4636] | 120 | OWLVAR_BOOL( "colorztext" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 121 | "allow @color() in zephyrs to change color", |
---|
| 122 | "Note that only messages received after this variable\n" |
---|
| 123 | "is set will be affected." ), |
---|
[e1c4636] | 124 | |
---|
[c15bbfb] | 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 | |
---|
[d309eb3] | 131 | OWLVAR_BOOL( "zcrypt" /* %OwlVarStub */, 1, |
---|
| 132 | "Do automatic zcrypt processing", |
---|
| 133 | "" ), |
---|
| 134 | |
---|
[4357be8] | 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" |
---|
[d544237] | 140 | "logout message, a pseudo login or logout message will be created\n", |
---|
[4357be8] | 141 | NULL, owl_variable_pseudologins_set, NULL), |
---|
[5a95b69] | 142 | |
---|
[280ddc6] | 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" |
---|
[3038d13] | 146 | "for AIM, zephyr, or other protocols. If disabled Owl will not print\n" |
---|
| 147 | "login or logout notifications.\n"), |
---|
[280ddc6] | 148 | |
---|
[15b34fd] | 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" |
---|
[d544237] | 153 | "This is a completely separate mechanism from the other logging\n" |
---|
[15b34fd] | 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 | |
---|
[e22f27c] | 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 | |
---|
[217a43e] | 164 | OWLVAR_ENUM_FULL( "disable-ctrl-d" /* %OwlVarStub:lockout_ctrld */, 1, |
---|
[aa2f33b3] | 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", |
---|
[7d4fbcd] | 174 | NULL, owl_variable_disable_ctrl_d_set, NULL), |
---|
| 175 | |
---|
| 176 | OWLVAR_PATH( "logpath" /* %OwlVarStub */, "~/zlog/people", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 180 | |
---|
| 181 | OWLVAR_PATH( "classlogpath" /* %OwlVarStub:classlogpath */, "~/zlog/class", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 185 | |
---|
| 186 | OWLVAR_PATH( "debug_file" /* %OwlVarStub */, OWL_DEBUG_FILE, |
---|
[aa2f33b3] | 187 | "path for logging debug messages when debugging is enabled", |
---|
[26ad412] | 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."), |
---|
[7d4fbcd] | 190 | |
---|
[ced25d1] | 191 | OWLVAR_PATH( "zsigproc" /* %OwlVarStub:zsigproc */, NULL, |
---|
[aa2f33b3] | 192 | "name of a program to run that will generate zsigs", |
---|
| 193 | "This program should produce a zsig on stdout when run.\n" |
---|
[81a96af] | 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 | ), |
---|
[7d4fbcd] | 198 | |
---|
[700c712] | 199 | OWLVAR_PATH( "newmsgproc" /* %OwlVarStub:newmsgproc */, NULL, |
---|
| 200 | "name of a program to run when new messages are present", |
---|
[d544237] | 201 | "The named program will be run when owl receives new\n" |
---|
[700c712] | 202 | "messages. It will not be run again until the first\n" |
---|
| 203 | "instance exits"), |
---|
| 204 | |
---|
[247cbc9] | 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 | |
---|
[de3f641] | 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" |
---|
[b120bd3] | 216 | "described in the documentation for the 'zsig' variable.\n" |
---|
| 217 | "See also BarnOwl::random_zephyr_signature().\n"), |
---|
[de3f641] | 218 | |
---|
[7d4fbcd] | 219 | OWLVAR_STRING( "zsig" /* %OwlVarStub */, "", |
---|
[81a96af] | 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"), |
---|
[7d4fbcd] | 225 | |
---|
| 226 | OWLVAR_STRING( "appendtosepbar" /* %OwlVarStub */, "", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 231 | |
---|
| 232 | OWLVAR_BOOL( "zaway" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 233 | "turn zaway on or off", "" ), |
---|
[7d4fbcd] | 234 | |
---|
| 235 | OWLVAR_STRING( "zaway_msg" /* %OwlVarStub */, |
---|
| 236 | OWL_DEFAULT_ZAWAYMSG, |
---|
[aa2f33b3] | 237 | "zaway msg for responding to zephyrs when away", "" ), |
---|
[7d4fbcd] | 238 | |
---|
| 239 | OWLVAR_STRING( "zaway_msg_default" /* %OwlVarStub */, |
---|
| 240 | OWL_DEFAULT_ZAWAYMSG, |
---|
[aa2f33b3] | 241 | "default zaway message", "" ), |
---|
[7d4fbcd] | 242 | |
---|
[4b660cc] | 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 | |
---|
[7d4fbcd] | 256 | OWLVAR_STRING( "view_home" /* %OwlVarStub */, "all", |
---|
[aa2f33b3] | 257 | "home view to switch to after 'X' and 'V'", |
---|
| 258 | "SEE ALSO: view, filter\n" ), |
---|
[7d4fbcd] | 259 | |
---|
[ecd5dc5] | 260 | OWLVAR_STRING( "alert_filter" /* %OwlVarStub */, "none", |
---|
| 261 | "filter on which to trigger alert actions", |
---|
| 262 | "" ), |
---|
| 263 | |
---|
| 264 | OWLVAR_STRING( "alert_action" /* %OwlVarStub */, "nop", |
---|
[b278973] | 265 | "owl command to execute for alert actions", |
---|
[ecd5dc5] | 266 | "" ), |
---|
| 267 | |
---|
[c01e477] | 268 | OWLVAR_STRING_FULL( "tty" /* %OwlVarStub */, "", "tty name for zephyr location", "", |
---|
| 269 | NULL, owl_variable_tty_set, NULL), |
---|
[bd3f232] | 270 | |
---|
[27c3a93] | 271 | OWLVAR_STRING( "default_style" /* %OwlVarStub */, "__unspecified__", |
---|
[c3ab155] | 272 | "name of the default formatting style", |
---|
[f1e629d] | 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 | |
---|
[c3ab155] | 282 | |
---|
[d36f2cb] | 283 | OWLVAR_INT( "edit:maxfillcols" /* %OwlVarStub:edit_maxfillcols */, 70, |
---|
[4d9e4254] | 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"), |
---|
[d36f2cb] | 288 | |
---|
[a4bbd80] | 289 | OWLVAR_INT( "edit:maxwrapcols" /* %OwlVarStub:edit_maxwrapcols */, 70, |
---|
[aa2f33b3] | 290 | "maximum number of columns for line-wrapping", |
---|
[4d9e4254] | 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"), |
---|
[d36f2cb] | 297 | |
---|
[1db061d] | 298 | OWLVAR_INT( "aim_ignorelogin_timer" /* %OwlVarStub */, 15, |
---|
[6a415e9] | 299 | "number of seconds after AIM login to ignore login messages", |
---|
| 300 | "This specifies the number of seconds to wait after an\n" |
---|
[d544237] | 301 | "AIM login before allowing the receipt of AIM login notifications.\n" |
---|
[1db061d] | 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."), |
---|
[6a415e9] | 304 | |
---|
| 305 | |
---|
[7d4fbcd] | 306 | OWLVAR_INT_FULL( "typewinsize" /* %OwlVarStub:typwin_lines */, |
---|
| 307 | OWL_TYPWIN_SIZE, |
---|
[aa2f33b3] | 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", |
---|
[7d4fbcd] | 313 | owl_variable_int_validate_gt0, |
---|
| 314 | owl_variable_typewinsize_set, |
---|
| 315 | NULL /* use default for get */ |
---|
| 316 | ), |
---|
| 317 | |
---|
[da466e0] | 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 | |
---|
[aa2f33b3] | 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 | |
---|
[66e409c] | 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" ), |
---|
[ecd5dc5] | 364 | |
---|
[7d4fbcd] | 365 | OWLVAR_BOOL( "_followlast" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 371 | |
---|
| 372 | /* This MUST be last... */ |
---|
[aa2f33b3] | 373 | { NULL, 0, NULL, 0, NULL, NULL, NULL, NULL, |
---|
| 374 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
[7d4fbcd] | 375 | |
---|
| 376 | }; |
---|
| 377 | |
---|
| 378 | /**************************************************************************/ |
---|
| 379 | /*********************** SPECIFIC TO VARIABLES ****************************/ |
---|
| 380 | /**************************************************************************/ |
---|
| 381 | |
---|
| 382 | |
---|
| 383 | /* commonly useful */ |
---|
| 384 | |
---|
[64735f0] | 385 | int owl_variable_int_validate_gt0(const owl_variable *v, const void *newval) |
---|
[4357be8] | 386 | { |
---|
[7d4fbcd] | 387 | if (newval == NULL) return(0); |
---|
[defe4a3] | 388 | else if (*(const int*)newval < 1) return(0); |
---|
[7d4fbcd] | 389 | else return (1); |
---|
| 390 | } |
---|
| 391 | |
---|
[64735f0] | 392 | int owl_variable_int_validate_positive(const owl_variable *v, const void *newval) |
---|
[4357be8] | 393 | { |
---|
[7d4fbcd] | 394 | if (newval == NULL) return(0); |
---|
[defe4a3] | 395 | else if (*(const int*)newval < 0) return(0); |
---|
[7d4fbcd] | 396 | else return (1); |
---|
| 397 | } |
---|
| 398 | |
---|
| 399 | /* typewinsize */ |
---|
[e19eb97] | 400 | int owl_variable_typewinsize_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 401 | { |
---|
[7d4fbcd] | 402 | int rv; |
---|
| 403 | rv = owl_variable_int_set_default(v, newval); |
---|
[f6fae8d] | 404 | if (0 == rv) owl_mainpanel_layout_contents(&g.mainpanel); |
---|
[7d4fbcd] | 405 | return(rv); |
---|
| 406 | } |
---|
| 407 | |
---|
| 408 | /* debug (cache value in g->debug) */ |
---|
[e19eb97] | 409 | int owl_variable_debug_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 410 | { |
---|
[defe4a3] | 411 | if (newval && (*(const int*)newval == 1 || *(const int*)newval == 0)) { |
---|
| 412 | g.debug = *(const int*)newval; |
---|
[7d4fbcd] | 413 | } |
---|
| 414 | return owl_variable_bool_set_default(v, newval); |
---|
[4b660cc] | 415 | } |
---|
| 416 | |
---|
| 417 | /* When 'aaway' is changed, need to notify the AIM server */ |
---|
[e19eb97] | 418 | int owl_variable_aaway_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 419 | { |
---|
[4b660cc] | 420 | if (newval) { |
---|
[defe4a3] | 421 | if (*(const int*)newval == 1) { |
---|
[4b660cc] | 422 | owl_aim_set_awaymsg(owl_global_get_aaway_msg(&g)); |
---|
[defe4a3] | 423 | } else if (*(const int*)newval == 0) { |
---|
[4b660cc] | 424 | owl_aim_set_awaymsg(""); |
---|
| 425 | } |
---|
| 426 | } |
---|
| 427 | return owl_variable_bool_set_default(v, newval); |
---|
[7d4fbcd] | 428 | } |
---|
| 429 | |
---|
[e19eb97] | 430 | int owl_variable_pseudologins_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 431 | { |
---|
[3687413] | 432 | static owl_timer *timer = NULL; |
---|
[4357be8] | 433 | if (newval) { |
---|
[defe4a3] | 434 | if (*(const int*)newval == 1) { |
---|
[4357be8] | 435 | owl_function_zephyr_buddy_check(0); |
---|
[3687413] | 436 | if (timer == NULL) { |
---|
[c6adf17] | 437 | timer = owl_select_add_timer("owl_zephyr_buddycheck_timer", |
---|
| 438 | 180, 180, owl_zephyr_buddycheck_timer, NULL, NULL); |
---|
[3687413] | 439 | } |
---|
| 440 | } else { |
---|
| 441 | if (timer != NULL) { |
---|
| 442 | owl_select_remove_timer(timer); |
---|
| 443 | timer = NULL; |
---|
| 444 | } |
---|
[4357be8] | 445 | } |
---|
| 446 | } |
---|
| 447 | return owl_variable_bool_set_default(v, newval); |
---|
| 448 | } |
---|
| 449 | |
---|
[7d4fbcd] | 450 | /* note that changing the value of this will clobber |
---|
| 451 | * any user setting of this */ |
---|
[e19eb97] | 452 | int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 453 | { |
---|
[217a43e] | 454 | if (newval && !owl_context_is_startup(owl_global_get_context(&g))) { |
---|
[defe4a3] | 455 | if (*(const int*)newval == 2) { |
---|
[7d4fbcd] | 456 | owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char"); |
---|
[defe4a3] | 457 | } else if (*(const int*)newval == 1) { |
---|
[3b42640] | 458 | owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete"); |
---|
[7d4fbcd] | 459 | } else { |
---|
[3b42640] | 460 | owl_function_command_norv("bindkey editmulti C-d command edit:done"); |
---|
[7d4fbcd] | 461 | } |
---|
| 462 | } |
---|
[217a43e] | 463 | return owl_variable_int_set_default(v, newval); |
---|
[7d4fbcd] | 464 | } |
---|
| 465 | |
---|
[e19eb97] | 466 | int owl_variable_tty_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 467 | { |
---|
[09489b89] | 468 | owl_zephyr_set_locationinfo(owl_global_get_hostname(&g), newval); |
---|
[c01e477] | 469 | return(owl_variable_string_set_default(v, newval)); |
---|
| 470 | } |
---|
| 471 | |
---|
[7d4fbcd] | 472 | |
---|
| 473 | /**************************************************************************/ |
---|
| 474 | /****************************** GENERAL ***********************************/ |
---|
| 475 | /**************************************************************************/ |
---|
| 476 | |
---|
| 477 | int owl_variable_dict_setup(owl_vardict *vd) { |
---|
[d536e72] | 478 | owl_variable *var, *cur; |
---|
[7d4fbcd] | 479 | if (owl_dict_create(vd)) return(-1); |
---|
[d536e72] | 480 | for (var = variables_to_init; var->name != NULL; var++) { |
---|
| 481 | cur = owl_malloc(sizeof(owl_variable)); |
---|
[66a8cd6] | 482 | *cur = *var; |
---|
[7d7326c] | 483 | /* strdup all the strings so we can delete them consistently. */ |
---|
| 484 | cur->name = owl_strdup(var->name); |
---|
| 485 | cur->summary = owl_strdup(var->summary); |
---|
| 486 | cur->description = owl_strdup(var->description); |
---|
[7d4fbcd] | 487 | switch (cur->type) { |
---|
| 488 | case OWL_VARIABLE_OTHER: |
---|
| 489 | cur->set_fn(cur, cur->pval_default); |
---|
| 490 | break; |
---|
| 491 | case OWL_VARIABLE_STRING: |
---|
| 492 | if (!cur->validate_fn) |
---|
| 493 | cur->validate_fn = owl_variable_string_validate_default; |
---|
| 494 | if (!cur->set_fn) |
---|
| 495 | cur->set_fn = owl_variable_string_set_default; |
---|
| 496 | if (!cur->set_fromstring_fn) |
---|
| 497 | cur->set_fromstring_fn = owl_variable_string_set_fromstring_default; |
---|
| 498 | if (!cur->get_fn) |
---|
| 499 | cur->get_fn = owl_variable_get_default; |
---|
| 500 | if (!cur->get_tostring_fn) |
---|
| 501 | cur->get_tostring_fn = owl_variable_string_get_tostring_default; |
---|
[bbd74a9] | 502 | if (!cur->delete_fn) |
---|
| 503 | cur->delete_fn = owl_variable_delete_default; |
---|
[7d4fbcd] | 504 | cur->set_fn(cur, cur->pval_default); |
---|
| 505 | break; |
---|
| 506 | case OWL_VARIABLE_BOOL: |
---|
| 507 | if (!cur->validate_fn) |
---|
| 508 | cur->validate_fn = owl_variable_bool_validate_default; |
---|
| 509 | if (!cur->set_fn) |
---|
| 510 | cur->set_fn = owl_variable_bool_set_default; |
---|
| 511 | if (!cur->set_fromstring_fn) |
---|
| 512 | cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default; |
---|
| 513 | if (!cur->get_fn) |
---|
| 514 | cur->get_fn = owl_variable_get_default; |
---|
| 515 | if (!cur->get_tostring_fn) |
---|
| 516 | cur->get_tostring_fn = owl_variable_bool_get_tostring_default; |
---|
[bbd74a9] | 517 | if (!cur->delete_fn) |
---|
| 518 | cur->delete_fn = owl_variable_delete_default; |
---|
[7d4fbcd] | 519 | cur->val = owl_malloc(sizeof(int)); |
---|
| 520 | cur->set_fn(cur, &cur->ival_default); |
---|
| 521 | break; |
---|
| 522 | case OWL_VARIABLE_INT: |
---|
| 523 | if (!cur->validate_fn) |
---|
| 524 | cur->validate_fn = owl_variable_int_validate_default; |
---|
| 525 | if (!cur->set_fn) |
---|
| 526 | cur->set_fn = owl_variable_int_set_default; |
---|
| 527 | if (!cur->set_fromstring_fn) |
---|
| 528 | cur->set_fromstring_fn = owl_variable_int_set_fromstring_default; |
---|
| 529 | if (!cur->get_fn) |
---|
| 530 | cur->get_fn = owl_variable_get_default; |
---|
| 531 | if (!cur->get_tostring_fn) |
---|
| 532 | cur->get_tostring_fn = owl_variable_int_get_tostring_default; |
---|
[bbd74a9] | 533 | if (!cur->delete_fn) |
---|
| 534 | cur->delete_fn = owl_variable_delete_default; |
---|
[7d4fbcd] | 535 | cur->val = owl_malloc(sizeof(int)); |
---|
| 536 | cur->set_fn(cur, &cur->ival_default); |
---|
| 537 | break; |
---|
| 538 | default: |
---|
| 539 | fprintf(stderr, "owl_variable_setup: invalid variable type\n"); |
---|
| 540 | return(-2); |
---|
| 541 | } |
---|
[4d86e06] | 542 | owl_dict_insert_element(vd, cur->name, cur, NULL); |
---|
[7d4fbcd] | 543 | } |
---|
| 544 | return 0; |
---|
| 545 | } |
---|
| 546 | |
---|
[a695a68] | 547 | void owl_variable_dict_add_variable(owl_vardict * vardict, |
---|
| 548 | owl_variable * var) { |
---|
[3b0edaa] | 549 | owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete); |
---|
[a695a68] | 550 | } |
---|
| 551 | |
---|
[e19eb97] | 552 | owl_variable * owl_variable_newvar(const char *name, const char *summary, const char * description) { |
---|
[4d86e06] | 553 | owl_variable * var = owl_malloc(sizeof(owl_variable)); |
---|
[a695a68] | 554 | memset(var, 0, sizeof(owl_variable)); |
---|
| 555 | var->name = owl_strdup(name); |
---|
| 556 | var->summary = owl_strdup(summary); |
---|
| 557 | var->description = owl_strdup(description); |
---|
| 558 | return var; |
---|
| 559 | } |
---|
| 560 | |
---|
[e19eb97] | 561 | void owl_variable_update(owl_variable *var, const char *summary, const char *desc) { |
---|
[d536e72] | 562 | if(var->summary) owl_free(var->summary); |
---|
| 563 | var->summary = owl_strdup(summary); |
---|
| 564 | if(var->description) owl_free(var->description); |
---|
| 565 | var->description = owl_strdup(desc); |
---|
| 566 | } |
---|
| 567 | |
---|
[e19eb97] | 568 | void owl_variable_dict_newvar_string(owl_vardict * vd, const char *name, const char *summ, const char * desc, const char * initval) { |
---|
[d536e72] | 569 | owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_STRING); |
---|
| 570 | if(old) { |
---|
| 571 | owl_variable_update(old, summ, desc); |
---|
| 572 | if(old->pval_default) owl_free(old->pval_default); |
---|
| 573 | old->pval_default = owl_strdup(initval); |
---|
| 574 | } else { |
---|
| 575 | owl_variable * var = owl_variable_newvar(name, summ, desc); |
---|
| 576 | var->type = OWL_VARIABLE_STRING; |
---|
| 577 | var->pval_default = owl_strdup(initval); |
---|
| 578 | var->set_fn = owl_variable_string_set_default; |
---|
| 579 | var->set_fromstring_fn = owl_variable_string_set_fromstring_default; |
---|
| 580 | var->get_fn = owl_variable_get_default; |
---|
| 581 | var->get_tostring_fn = owl_variable_string_get_tostring_default; |
---|
[bbd74a9] | 582 | var->delete_fn = owl_variable_delete_default; |
---|
[d536e72] | 583 | var->set_fn(var, initval); |
---|
| 584 | owl_variable_dict_add_variable(vd, var); |
---|
| 585 | } |
---|
[a695a68] | 586 | } |
---|
| 587 | |
---|
[e19eb97] | 588 | void owl_variable_dict_newvar_int(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) { |
---|
[d536e72] | 589 | owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_INT); |
---|
| 590 | if(old) { |
---|
| 591 | owl_variable_update(old, summ, desc); |
---|
| 592 | old->ival_default = initval; |
---|
| 593 | } else { |
---|
| 594 | owl_variable * var = owl_variable_newvar(name, summ, desc); |
---|
| 595 | var->type = OWL_VARIABLE_INT; |
---|
| 596 | var->ival_default = initval; |
---|
| 597 | var->validate_fn = owl_variable_int_validate_default; |
---|
| 598 | var->set_fn = owl_variable_int_set_default; |
---|
| 599 | var->set_fromstring_fn = owl_variable_int_set_fromstring_default; |
---|
| 600 | var->get_fn = owl_variable_get_default; |
---|
| 601 | var->get_tostring_fn = owl_variable_int_get_tostring_default; |
---|
[bbd74a9] | 602 | var->delete_fn = owl_variable_delete_default; |
---|
[d536e72] | 603 | var->val = owl_malloc(sizeof(int)); |
---|
| 604 | var->set_fn(var, &initval); |
---|
| 605 | owl_variable_dict_add_variable(vd, var); |
---|
| 606 | } |
---|
[a695a68] | 607 | } |
---|
| 608 | |
---|
[e19eb97] | 609 | void owl_variable_dict_newvar_bool(owl_vardict * vd, const char *name, const char *summ, const char * desc, int initval) { |
---|
[d536e72] | 610 | owl_variable *old = owl_variable_get_var(vd, name, OWL_VARIABLE_BOOL); |
---|
| 611 | if(old) { |
---|
| 612 | owl_variable_update(old, summ, desc); |
---|
| 613 | old->ival_default = initval; |
---|
| 614 | } else { |
---|
| 615 | owl_variable * var = owl_variable_newvar(name, summ, desc); |
---|
| 616 | var->type = OWL_VARIABLE_BOOL; |
---|
| 617 | var->ival_default = initval; |
---|
| 618 | var->validate_fn = owl_variable_bool_validate_default; |
---|
| 619 | var->set_fn = owl_variable_bool_set_default; |
---|
| 620 | var->set_fromstring_fn = owl_variable_bool_set_fromstring_default; |
---|
| 621 | var->get_fn = owl_variable_get_default; |
---|
| 622 | var->get_tostring_fn = owl_variable_bool_get_tostring_default; |
---|
[bbd74a9] | 623 | var->delete_fn = owl_variable_delete_default; |
---|
[d536e72] | 624 | var->val = owl_malloc(sizeof(int)); |
---|
| 625 | var->set_fn(var, &initval); |
---|
| 626 | owl_variable_dict_add_variable(vd, var); |
---|
| 627 | } |
---|
[a695a68] | 628 | } |
---|
| 629 | |
---|
[0fef6eb] | 630 | void owl_variable_dict_cleanup(owl_vardict *d) |
---|
| 631 | { |
---|
[bf7aa1d] | 632 | owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete); |
---|
[7d4fbcd] | 633 | } |
---|
| 634 | |
---|
[0e57335] | 635 | /* free the list with owl_variable_dict_namelist_cleanup */ |
---|
[e5c9b14a] | 636 | void owl_variable_dict_get_names(const owl_vardict *d, owl_list *l) { |
---|
[7d4fbcd] | 637 | owl_dict_get_keys(d, l); |
---|
| 638 | } |
---|
| 639 | |
---|
[0e57335] | 640 | void owl_variable_dict_namelist_cleanup(owl_list *l) |
---|
| 641 | { |
---|
[8c59178] | 642 | owl_list_cleanup(l, owl_free); |
---|
[7d4fbcd] | 643 | } |
---|
| 644 | |
---|
[3b0edaa] | 645 | void owl_variable_delete(owl_variable *v) |
---|
| 646 | { |
---|
[bbd74a9] | 647 | if (v->delete_fn) v->delete_fn(v); |
---|
[7d7326c] | 648 | owl_free(v->name); |
---|
| 649 | owl_free(v->summary); |
---|
| 650 | owl_free(v->description); |
---|
[d536e72] | 651 | owl_free(v); |
---|
[7d4fbcd] | 652 | } |
---|
| 653 | |
---|
| 654 | |
---|
[64735f0] | 655 | const char *owl_variable_get_description(const owl_variable *v) { |
---|
[aa2f33b3] | 656 | return v->description; |
---|
| 657 | } |
---|
| 658 | |
---|
[64735f0] | 659 | const char *owl_variable_get_summary(const owl_variable *v) { |
---|
[aa2f33b3] | 660 | return v->summary; |
---|
[7d4fbcd] | 661 | } |
---|
| 662 | |
---|
[64735f0] | 663 | const char *owl_variable_get_validsettings(const owl_variable *v) { |
---|
[7d4fbcd] | 664 | if (v->validsettings) { |
---|
| 665 | return v->validsettings; |
---|
| 666 | } else { |
---|
| 667 | return ""; |
---|
| 668 | } |
---|
| 669 | } |
---|
| 670 | |
---|
| 671 | /* functions for getting and setting variable values */ |
---|
| 672 | |
---|
| 673 | /* returns 0 on success, prints a status msg if msg is true */ |
---|
[e19eb97] | 674 | int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) { |
---|
[7d4fbcd] | 675 | owl_variable *v; |
---|
| 676 | char buff2[1024]; |
---|
| 677 | if (!name) return(-1); |
---|
| 678 | v = owl_dict_find_element(d, name); |
---|
| 679 | if (v == NULL) { |
---|
[836ea3a3] | 680 | if (msg) owl_function_error("Unknown variable %s", name); |
---|
[7d4fbcd] | 681 | return -1; |
---|
| 682 | } |
---|
| 683 | if (!v->set_fromstring_fn) { |
---|
[836ea3a3] | 684 | if (msg) owl_function_error("Variable %s is read-only", name); |
---|
[486688f] | 685 | return -1; |
---|
| 686 | } |
---|
| 687 | if (requirebool && v->type!=OWL_VARIABLE_BOOL) { |
---|
[836ea3a3] | 688 | if (msg) owl_function_error("Variable %s is not a boolean", name); |
---|
[486688f] | 689 | return -1; |
---|
[7d4fbcd] | 690 | } |
---|
| 691 | if (0 != v->set_fromstring_fn(v, value)) { |
---|
[836ea3a3] | 692 | if (msg) owl_function_error("Unable to set %s (must be %s)", name, |
---|
[7d4fbcd] | 693 | owl_variable_get_validsettings(v)); |
---|
| 694 | return -1; |
---|
| 695 | } |
---|
| 696 | if (msg && v->get_tostring_fn) { |
---|
| 697 | v->get_tostring_fn(v, buff2, 1024, v->val); |
---|
| 698 | owl_function_makemsg("%s = '%s'", name, buff2); |
---|
| 699 | } |
---|
| 700 | return 0; |
---|
| 701 | } |
---|
| 702 | |
---|
[e19eb97] | 703 | int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) { |
---|
[7d4fbcd] | 704 | owl_variable *v; |
---|
| 705 | if (!name) return(-1); |
---|
| 706 | v = owl_dict_find_element(d, name); |
---|
| 707 | if (v == NULL || !v->set_fn) return(-1); |
---|
| 708 | if (v->type!=OWL_VARIABLE_STRING) return(-1); |
---|
[ba6c8bd] | 709 | return v->set_fn(v, newval); |
---|
[7d4fbcd] | 710 | } |
---|
| 711 | |
---|
[e19eb97] | 712 | int owl_variable_set_int(owl_vardict *d, const char *name, int newval) { |
---|
[7d4fbcd] | 713 | owl_variable *v; |
---|
| 714 | if (!name) return(-1); |
---|
| 715 | v = owl_dict_find_element(d, name); |
---|
| 716 | if (v == NULL || !v->set_fn) return(-1); |
---|
| 717 | if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1); |
---|
| 718 | return v->set_fn(v, &newval); |
---|
| 719 | } |
---|
| 720 | |
---|
[e19eb97] | 721 | int owl_variable_set_bool_on(owl_vardict *d, const char *name) { |
---|
[7d4fbcd] | 722 | return owl_variable_set_int(d,name,1); |
---|
| 723 | } |
---|
| 724 | |
---|
[e19eb97] | 725 | int owl_variable_set_bool_off(owl_vardict *d, const char *name) { |
---|
[7d4fbcd] | 726 | return owl_variable_set_int(d,name,0); |
---|
| 727 | } |
---|
| 728 | |
---|
[e5c9b14a] | 729 | int owl_variable_get_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) { |
---|
[7d4fbcd] | 730 | owl_variable *v; |
---|
| 731 | if (!name) return(-1); |
---|
| 732 | v = owl_dict_find_element(d, name); |
---|
| 733 | if (v == NULL || !v->get_tostring_fn) return(-1); |
---|
| 734 | return v->get_tostring_fn(v, buf, bufsize, v->val); |
---|
| 735 | } |
---|
| 736 | |
---|
[e5c9b14a] | 737 | int owl_variable_get_default_tostring(const owl_vardict *d, const char *name, char *buf, int bufsize) { |
---|
[7d4fbcd] | 738 | owl_variable *v; |
---|
| 739 | if (!name) return(-1); |
---|
| 740 | v = owl_dict_find_element(d, name); |
---|
| 741 | if (v == NULL || !v->get_tostring_fn) return(-1); |
---|
| 742 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
| 743 | return v->get_tostring_fn(v, buf, bufsize, &(v->ival_default)); |
---|
| 744 | } else { |
---|
| 745 | return v->get_tostring_fn(v, buf, bufsize, v->pval_default); |
---|
| 746 | } |
---|
| 747 | } |
---|
| 748 | |
---|
[e5c9b14a] | 749 | owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name, int require_type) { |
---|
[7d4fbcd] | 750 | owl_variable *v; |
---|
| 751 | if (!name) return(NULL); |
---|
| 752 | v = owl_dict_find_element(d, name); |
---|
| 753 | if (v == NULL || !v->get_fn || v->type != require_type) return(NULL); |
---|
[d536e72] | 754 | return v; |
---|
| 755 | } |
---|
| 756 | |
---|
| 757 | /* returns a reference */ |
---|
[e5c9b14a] | 758 | const void *owl_variable_get(const owl_vardict *d, const char *name, int require_type) { |
---|
[d536e72] | 759 | owl_variable *v = owl_variable_get_var(d, name, require_type); |
---|
| 760 | if(v == NULL) return NULL; |
---|
[7d4fbcd] | 761 | return v->get_fn(v); |
---|
| 762 | } |
---|
| 763 | |
---|
| 764 | /* returns a reference */ |
---|
[e5c9b14a] | 765 | const char *owl_variable_get_string(const owl_vardict *d, const char *name) { |
---|
[4d86e06] | 766 | return owl_variable_get(d,name, OWL_VARIABLE_STRING); |
---|
[7d4fbcd] | 767 | } |
---|
| 768 | |
---|
| 769 | /* returns a reference */ |
---|
[e5c9b14a] | 770 | const void *owl_variable_get_other(const owl_vardict *d, const char *name) { |
---|
[4d86e06] | 771 | return owl_variable_get(d,name, OWL_VARIABLE_OTHER); |
---|
[7d4fbcd] | 772 | } |
---|
| 773 | |
---|
[e5c9b14a] | 774 | int owl_variable_get_int(const owl_vardict *d, const char *name) { |
---|
[defe4a3] | 775 | const int *pi; |
---|
[4d86e06] | 776 | pi = owl_variable_get(d,name,OWL_VARIABLE_INT); |
---|
[7d4fbcd] | 777 | if (!pi) return(-1); |
---|
| 778 | return(*pi); |
---|
| 779 | } |
---|
| 780 | |
---|
[e5c9b14a] | 781 | int owl_variable_get_bool(const owl_vardict *d, const char *name) { |
---|
[defe4a3] | 782 | const int *pi; |
---|
[4d86e06] | 783 | pi = owl_variable_get(d,name,OWL_VARIABLE_BOOL); |
---|
[7d4fbcd] | 784 | if (!pi) return(-1); |
---|
| 785 | return(*pi); |
---|
| 786 | } |
---|
| 787 | |
---|
[e5c9b14a] | 788 | void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) { |
---|
[aa2f33b3] | 789 | char defaultbuf[50]; |
---|
[7d4fbcd] | 790 | char buf[1024]; |
---|
| 791 | int buflen = 1023; |
---|
| 792 | owl_variable *v; |
---|
| 793 | |
---|
| 794 | if (!name |
---|
| 795 | || (v = owl_dict_find_element(d, name)) == NULL |
---|
| 796 | || !v->get_fn) { |
---|
| 797 | snprintf(buf, buflen, " No such variable '%s'\n", name); |
---|
| 798 | owl_fmtext_append_normal(fm, buf); |
---|
| 799 | return; |
---|
| 800 | } |
---|
| 801 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
[aa2f33b3] | 802 | v->get_tostring_fn(v, defaultbuf, 50, &(v->ival_default)); |
---|
[7d4fbcd] | 803 | } else { |
---|
[aa2f33b3] | 804 | v->get_tostring_fn(v, defaultbuf, 50, v->pval_default); |
---|
[7d4fbcd] | 805 | } |
---|
[aa2f33b3] | 806 | snprintf(buf, buflen, OWL_TABSTR "%-20s - %s (default: '%s')\n", |
---|
[7d4fbcd] | 807 | v->name, |
---|
[aa2f33b3] | 808 | owl_variable_get_summary(v), defaultbuf); |
---|
[7d4fbcd] | 809 | owl_fmtext_append_normal(fm, buf); |
---|
| 810 | } |
---|
| 811 | |
---|
[e5c9b14a] | 812 | void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) { |
---|
[7d4fbcd] | 813 | char buff[1024]; |
---|
| 814 | int bufflen = 1023; |
---|
| 815 | owl_variable *v; |
---|
| 816 | |
---|
| 817 | if (!name |
---|
| 818 | || (v = owl_dict_find_element(d, name)) == NULL |
---|
| 819 | || !v->get_fn) { |
---|
| 820 | owl_fmtext_append_normal(fm, "No such variable...\n"); |
---|
| 821 | return; |
---|
| 822 | } |
---|
| 823 | |
---|
| 824 | owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n"); |
---|
| 825 | owl_fmtext_append_normal(fm, OWL_TABSTR); |
---|
| 826 | owl_fmtext_append_normal(fm, name); |
---|
| 827 | owl_fmtext_append_normal(fm, " - "); |
---|
[aa2f33b3] | 828 | owl_fmtext_append_normal(fm, v->summary); |
---|
[7d4fbcd] | 829 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 830 | |
---|
| 831 | owl_fmtext_append_normal(fm, "Current: "); |
---|
| 832 | owl_variable_get_tostring(d, name, buff, bufflen); |
---|
| 833 | owl_fmtext_append_normal(fm, buff); |
---|
| 834 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 835 | |
---|
| 836 | |
---|
| 837 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
| 838 | v->get_tostring_fn(v, buff, bufflen, &(v->ival_default)); |
---|
| 839 | } else { |
---|
| 840 | v->get_tostring_fn(v, buff, bufflen, v->pval_default); |
---|
| 841 | } |
---|
| 842 | owl_fmtext_append_normal(fm, "Default: "); |
---|
| 843 | owl_fmtext_append_normal(fm, buff); |
---|
| 844 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 845 | |
---|
| 846 | owl_fmtext_append_normal(fm, "Valid Settings: "); |
---|
| 847 | owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v)); |
---|
| 848 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
[aa2f33b3] | 849 | |
---|
| 850 | if (v->description && *v->description) { |
---|
| 851 | owl_fmtext_append_normal(fm, "Description:\n"); |
---|
| 852 | owl_fmtext_append_normal(fm, owl_variable_get_description(v)); |
---|
| 853 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 854 | } |
---|
[7d4fbcd] | 855 | } |
---|
| 856 | |
---|
| 857 | |
---|
| 858 | |
---|
| 859 | |
---|
| 860 | /**************************************************************************/ |
---|
| 861 | /*********************** GENERAL TYPE-SPECIFIC ****************************/ |
---|
| 862 | /**************************************************************************/ |
---|
| 863 | |
---|
| 864 | /* default common functions */ |
---|
| 865 | |
---|
[64735f0] | 866 | const void *owl_variable_get_default(const owl_variable *v) { |
---|
[7d4fbcd] | 867 | return v->val; |
---|
| 868 | } |
---|
| 869 | |
---|
[bbd74a9] | 870 | void owl_variable_delete_default(owl_variable *v) |
---|
| 871 | { |
---|
[7d4fbcd] | 872 | if (v->val) owl_free(v->val); |
---|
| 873 | } |
---|
| 874 | |
---|
| 875 | /* default functions for booleans */ |
---|
| 876 | |
---|
[64735f0] | 877 | int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 878 | if (newval == NULL) return(0); |
---|
[defe4a3] | 879 | else if (*(const int*)newval==1 || *(const int*)newval==0) return(1); |
---|
[7d4fbcd] | 880 | else return (0); |
---|
| 881 | } |
---|
| 882 | |
---|
[e19eb97] | 883 | int owl_variable_bool_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 884 | if (v->validate_fn) { |
---|
| 885 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 886 | } |
---|
[defe4a3] | 887 | *(int*)v->val = *(const int*)newval; |
---|
[7d4fbcd] | 888 | return(0); |
---|
| 889 | } |
---|
| 890 | |
---|
[e19eb97] | 891 | int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 892 | int i; |
---|
| 893 | if (!strcmp(newval, "on")) i=1; |
---|
| 894 | else if (!strcmp(newval, "off")) i=0; |
---|
| 895 | else return(-1); |
---|
| 896 | return (v->set_fn(v, &i)); |
---|
| 897 | } |
---|
| 898 | |
---|
[64735f0] | 899 | int owl_variable_bool_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) { |
---|
[7d4fbcd] | 900 | if (val == NULL) { |
---|
| 901 | snprintf(buf, bufsize, "<null>"); |
---|
| 902 | return -1; |
---|
[defe4a3] | 903 | } else if (*(const int*)val == 0) { |
---|
[7d4fbcd] | 904 | snprintf(buf, bufsize, "off"); |
---|
| 905 | return 0; |
---|
[defe4a3] | 906 | } else if (*(const int*)val == 1) { |
---|
[7d4fbcd] | 907 | snprintf(buf, bufsize, "on"); |
---|
| 908 | return 0; |
---|
| 909 | } else { |
---|
| 910 | snprintf(buf, bufsize, "<invalid>"); |
---|
| 911 | return -1; |
---|
| 912 | } |
---|
| 913 | } |
---|
| 914 | |
---|
| 915 | /* default functions for integers */ |
---|
| 916 | |
---|
[64735f0] | 917 | int owl_variable_int_validate_default(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 918 | if (newval == NULL) return(0); |
---|
| 919 | else return (1); |
---|
| 920 | } |
---|
| 921 | |
---|
[e19eb97] | 922 | int owl_variable_int_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 923 | if (v->validate_fn) { |
---|
| 924 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 925 | } |
---|
[defe4a3] | 926 | *(int*)v->val = *(const int*)newval; |
---|
[7d4fbcd] | 927 | return(0); |
---|
| 928 | } |
---|
| 929 | |
---|
[e19eb97] | 930 | int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 931 | int i; |
---|
[99525be] | 932 | char *ep; |
---|
| 933 | i = strtol(newval, &ep, 10); |
---|
[7d4fbcd] | 934 | if (*ep || ep==newval) return(-1); |
---|
| 935 | return (v->set_fn(v, &i)); |
---|
| 936 | } |
---|
| 937 | |
---|
[64735f0] | 938 | int owl_variable_int_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) { |
---|
[7d4fbcd] | 939 | if (val == NULL) { |
---|
| 940 | snprintf(buf, bufsize, "<null>"); |
---|
| 941 | return -1; |
---|
| 942 | } else { |
---|
[defe4a3] | 943 | snprintf(buf, bufsize, "%d", *(const int*)val); |
---|
[7d4fbcd] | 944 | return 0; |
---|
| 945 | } |
---|
| 946 | } |
---|
| 947 | |
---|
| 948 | /* default functions for enums (a variant of integers) */ |
---|
| 949 | |
---|
[64735f0] | 950 | int owl_variable_enum_validate(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 951 | char **enums; |
---|
| 952 | int nenums, val; |
---|
| 953 | if (newval == NULL) return(0); |
---|
| 954 | enums = atokenize(v->validsettings, ",", &nenums); |
---|
| 955 | if (enums == NULL) return(0); |
---|
[1672650] | 956 | atokenize_delete(enums, nenums); |
---|
[defe4a3] | 957 | val = *(const int*)newval; |
---|
[7d4fbcd] | 958 | if (val < 0 || val >= nenums) { |
---|
| 959 | return(0); |
---|
| 960 | } |
---|
| 961 | return(1); |
---|
| 962 | } |
---|
| 963 | |
---|
[e19eb97] | 964 | int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 965 | char **enums; |
---|
| 966 | int nenums, i, val=-1; |
---|
| 967 | if (newval == NULL) return(-1); |
---|
| 968 | enums = atokenize(v->validsettings, ",", &nenums); |
---|
| 969 | if (enums == NULL) return(-1); |
---|
| 970 | for (i=0; i<nenums; i++) { |
---|
| 971 | if (0==strcmp(newval, enums[i])) { |
---|
| 972 | val = i; |
---|
| 973 | } |
---|
| 974 | } |
---|
[1672650] | 975 | atokenize_delete(enums, nenums); |
---|
[7d4fbcd] | 976 | if (val == -1) return(-1); |
---|
| 977 | return (v->set_fn(v, &val)); |
---|
| 978 | } |
---|
| 979 | |
---|
[64735f0] | 980 | int owl_variable_enum_get_tostring(const owl_variable *v, char* buf, int bufsize, const void *val) { |
---|
[7d4fbcd] | 981 | char **enums; |
---|
| 982 | int nenums, i; |
---|
| 983 | |
---|
| 984 | if (val == NULL) { |
---|
| 985 | snprintf(buf, bufsize, "<null>"); |
---|
| 986 | return -1; |
---|
| 987 | } |
---|
| 988 | enums = atokenize(v->validsettings, ",", &nenums); |
---|
[defe4a3] | 989 | i = *(const int*)val; |
---|
[7d4fbcd] | 990 | if (i<0 || i>=nenums) { |
---|
| 991 | snprintf(buf, bufsize, "<invalid:%d>",i); |
---|
[1672650] | 992 | atokenize_delete(enums, nenums); |
---|
[7d4fbcd] | 993 | return(-1); |
---|
| 994 | } |
---|
| 995 | snprintf(buf, bufsize, "%s", enums[i]); |
---|
[1672650] | 996 | atokenize_delete(enums, nenums); |
---|
[7d4fbcd] | 997 | return 0; |
---|
| 998 | } |
---|
| 999 | |
---|
| 1000 | /* default functions for stringeans */ |
---|
| 1001 | |
---|
[64735f0] | 1002 | int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 1003 | if (newval == NULL) return(0); |
---|
| 1004 | else return (1); |
---|
| 1005 | } |
---|
| 1006 | |
---|
[e19eb97] | 1007 | int owl_variable_string_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 1008 | if (v->validate_fn) { |
---|
| 1009 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 1010 | } |
---|
| 1011 | if (v->val) owl_free(v->val); |
---|
| 1012 | v->val = owl_strdup(newval); |
---|
| 1013 | return(0); |
---|
| 1014 | } |
---|
| 1015 | |
---|
[e19eb97] | 1016 | int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 1017 | return (v->set_fn(v, newval)); |
---|
| 1018 | } |
---|
| 1019 | |
---|
[64735f0] | 1020 | int owl_variable_string_get_tostring_default(const owl_variable *v, char* buf, int bufsize, const void *val) { |
---|
[7d4fbcd] | 1021 | if (val == NULL) { |
---|
| 1022 | snprintf(buf, bufsize, "<null>"); |
---|
| 1023 | return -1; |
---|
| 1024 | } else { |
---|
[e19eb97] | 1025 | snprintf(buf, bufsize, "%s", (const char*)val); |
---|
[7d4fbcd] | 1026 | return 0; |
---|
| 1027 | } |
---|
| 1028 | } |
---|
| 1029 | |
---|