[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) \ |
---|
[9efc154] | 9 | { g_strdup(name), OWL_VARIABLE_BOOL, NULL, default, "on,off", g_strdup(summary), g_strdup(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) \ |
---|
[9efc154] | 13 | { g_strdup(name), OWL_VARIABLE_BOOL, NULL, default, "on,off", g_strdup(summary), g_strdup(description), NULL, \ |
---|
[c1d9441] | 14 | validate, set, NULL, get, NULL, NULL } |
---|
[7d4fbcd] | 15 | |
---|
[aa2f33b3] | 16 | #define OWLVAR_INT(name,default,summary,description) \ |
---|
[9efc154] | 17 | { g_strdup(name), OWL_VARIABLE_INT, NULL, default, "<int>", g_strdup(summary), g_strdup(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) \ |
---|
[9efc154] | 21 | { g_strdup(name), OWL_VARIABLE_INT, NULL, default, validset, g_strdup(summary), g_strdup(description), NULL, \ |
---|
[7d4fbcd] | 22 | validate, set, NULL, get, NULL, NULL } |
---|
| 23 | |
---|
[aa2f33b3] | 24 | #define OWLVAR_PATH(name,default,summary,description) \ |
---|
[9efc154] | 25 | { g_strdup(name), OWL_VARIABLE_STRING, g_strdup(default), 0, "<path>", g_strdup(summary), g_strdup(description), NULL, \ |
---|
[7d4fbcd] | 26 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
| 27 | |
---|
[aa2f33b3] | 28 | #define OWLVAR_STRING(name,default,summary,description) \ |
---|
[9efc154] | 29 | { g_strdup(name), OWL_VARIABLE_STRING, g_strdup(default), 0, "<string>", g_strdup(summary), g_strdup(description), NULL, \ |
---|
[7d4fbcd] | 30 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
| 31 | |
---|
[f203cad] | 32 | #define OWLVAR_STRING_FULL(name,default,validset,summary,description,validate,set,get) \ |
---|
[9efc154] | 33 | { g_strdup(name), OWL_VARIABLE_STRING, g_strdup(default), 0, validset, g_strdup(summary), g_strdup(description), NULL, \ |
---|
[c01e477] | 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) \ |
---|
[9efc154] | 40 | { g_strdup(name), OWL_VARIABLE_INT, NULL, default, validset, g_strdup(summary), g_strdup(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) \ |
---|
[9efc154] | 47 | { g_strdup(name), OWL_VARIABLE_INT, NULL, default, validset, g_strdup(summary), g_strdup(description), NULL, \ |
---|
[217a43e] | 48 | validate, \ |
---|
| 49 | set, owl_variable_enum_set_fromstring, \ |
---|
| 50 | get, owl_variable_enum_get_tostring, \ |
---|
| 51 | NULL } |
---|
| 52 | |
---|
[9e86f6f] | 53 | int owl_variable_add_defaults(owl_vardict *vd) |
---|
| 54 | { |
---|
| 55 | owl_variable variables_to_init[] = { |
---|
[7d4fbcd] | 56 | |
---|
[5d365f6] | 57 | OWLVAR_STRING( "personalbell" /* %OwlVarStub */, "off", |
---|
[213a3eb] | 58 | "ring the terminal bell when personal messages are received", |
---|
[5d365f6] | 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"), |
---|
[7d4fbcd] | 61 | |
---|
| 62 | OWLVAR_BOOL( "bell" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 63 | "enable / disable the terminal bell", "" ), |
---|
[7d4fbcd] | 64 | |
---|
| 65 | OWLVAR_BOOL_FULL( "debug" /* %OwlVarStub */, OWL_DEBUG, |
---|
| 66 | "whether debugging is enabled", |
---|
[aa2f33b3] | 67 | "If set to 'on', debugging messages are logged to the\n" |
---|
| 68 | "file specified by the debugfile variable.\n", |
---|
[7d4fbcd] | 69 | NULL, owl_variable_debug_set, NULL), |
---|
| 70 | |
---|
| 71 | OWLVAR_BOOL( "startuplogin" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 72 | "send a login message when owl starts", "" ), |
---|
[7d4fbcd] | 73 | |
---|
| 74 | OWLVAR_BOOL( "shutdownlogout" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 75 | "send a logout message when owl exits", "" ), |
---|
[7d4fbcd] | 76 | |
---|
| 77 | OWLVAR_BOOL( "rxping" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 78 | "display received pings", "" ), |
---|
[7d4fbcd] | 79 | |
---|
| 80 | OWLVAR_BOOL( "txping" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 81 | "send pings", "" ), |
---|
[7d4fbcd] | 82 | |
---|
[73624b4] | 83 | OWLVAR_BOOL( "sepbar_disable" /* %OwlVarStub */, 0, |
---|
[451db9e] | 84 | "disable printing information in the separator bar", "" ), |
---|
[73624b4] | 85 | |
---|
[f9c43ae] | 86 | OWLVAR_BOOL( "smartstrip" /* %OwlVarStub */, 1, |
---|
| 87 | "strip kerberos instance for reply", ""), |
---|
| 88 | |
---|
[7e3e00a] | 89 | OWLVAR_BOOL( "newlinestrip" /* %OwlVarStub */, 1, |
---|
| 90 | "strip leading and trailing newlines", ""), |
---|
| 91 | |
---|
[7d4fbcd] | 92 | OWLVAR_BOOL( "displayoutgoing" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 93 | "display outgoing messages", "" ), |
---|
[7d4fbcd] | 94 | |
---|
| 95 | OWLVAR_BOOL( "loginsubs" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 96 | "load logins from .anyone on startup", "" ), |
---|
[7d4fbcd] | 97 | |
---|
| 98 | OWLVAR_BOOL( "logging" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 104 | |
---|
| 105 | OWLVAR_BOOL( "classlogging" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 112 | |
---|
[12c35df] | 113 | OWLVAR_ENUM( "loggingdirection" /* %OwlVarStub */, OWL_LOGGING_DIRECTION_BOTH, |
---|
[d544237] | 114 | "specifies which kind of messages should be logged", |
---|
[12c35df] | 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 | |
---|
[e1c4636] | 122 | OWLVAR_BOOL( "colorztext" /* %OwlVarStub */, 1, |
---|
[aa2f33b3] | 123 | "allow @color() in zephyrs to change color", |
---|
| 124 | "Note that only messages received after this variable\n" |
---|
| 125 | "is set will be affected." ), |
---|
[e1c4636] | 126 | |
---|
[c15bbfb] | 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 | |
---|
[d309eb3] | 133 | OWLVAR_BOOL( "zcrypt" /* %OwlVarStub */, 1, |
---|
| 134 | "Do automatic zcrypt processing", |
---|
| 135 | "" ), |
---|
| 136 | |
---|
[4357be8] | 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" |
---|
[d544237] | 142 | "logout message, a pseudo login or logout message will be created\n", |
---|
[4357be8] | 143 | NULL, owl_variable_pseudologins_set, NULL), |
---|
[5a95b69] | 144 | |
---|
[280ddc6] | 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" |
---|
[3038d13] | 148 | "for AIM, zephyr, or other protocols. If disabled Owl will not print\n" |
---|
| 149 | "login or logout notifications.\n"), |
---|
[280ddc6] | 150 | |
---|
[15b34fd] | 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" |
---|
[d544237] | 155 | "This is a completely separate mechanism from the other logging\n" |
---|
[15b34fd] | 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 | |
---|
[e22f27c] | 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 | |
---|
[217a43e] | 166 | OWLVAR_ENUM_FULL( "disable-ctrl-d" /* %OwlVarStub:lockout_ctrld */, 1, |
---|
[aa2f33b3] | 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", |
---|
[7d4fbcd] | 176 | NULL, owl_variable_disable_ctrl_d_set, NULL), |
---|
| 177 | |
---|
| 178 | OWLVAR_PATH( "logpath" /* %OwlVarStub */, "~/zlog/people", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 182 | |
---|
| 183 | OWLVAR_PATH( "classlogpath" /* %OwlVarStub:classlogpath */, "~/zlog/class", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 187 | |
---|
| 188 | OWLVAR_PATH( "debug_file" /* %OwlVarStub */, OWL_DEBUG_FILE, |
---|
[aa2f33b3] | 189 | "path for logging debug messages when debugging is enabled", |
---|
[26ad412] | 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."), |
---|
[7d4fbcd] | 192 | |
---|
[ced25d1] | 193 | OWLVAR_PATH( "zsigproc" /* %OwlVarStub:zsigproc */, NULL, |
---|
[aa2f33b3] | 194 | "name of a program to run that will generate zsigs", |
---|
| 195 | "This program should produce a zsig on stdout when run.\n" |
---|
[81a96af] | 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 | ), |
---|
[7d4fbcd] | 200 | |
---|
[700c712] | 201 | OWLVAR_PATH( "newmsgproc" /* %OwlVarStub:newmsgproc */, NULL, |
---|
| 202 | "name of a program to run when new messages are present", |
---|
[d544237] | 203 | "The named program will be run when owl receives new\n" |
---|
[700c712] | 204 | "messages. It will not be run again until the first\n" |
---|
| 205 | "instance exits"), |
---|
| 206 | |
---|
[247cbc9] | 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 | |
---|
[de3f641] | 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" |
---|
[b120bd3] | 218 | "described in the documentation for the 'zsig' variable.\n" |
---|
| 219 | "See also BarnOwl::random_zephyr_signature().\n"), |
---|
[de3f641] | 220 | |
---|
[7d4fbcd] | 221 | OWLVAR_STRING( "zsig" /* %OwlVarStub */, "", |
---|
[81a96af] | 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"), |
---|
[7d4fbcd] | 227 | |
---|
| 228 | OWLVAR_STRING( "appendtosepbar" /* %OwlVarStub */, "", |
---|
[aa2f33b3] | 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"), |
---|
[7d4fbcd] | 233 | |
---|
| 234 | OWLVAR_BOOL( "zaway" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 235 | "turn zaway on or off", "" ), |
---|
[7d4fbcd] | 236 | |
---|
| 237 | OWLVAR_STRING( "zaway_msg" /* %OwlVarStub */, |
---|
| 238 | OWL_DEFAULT_ZAWAYMSG, |
---|
[aa2f33b3] | 239 | "zaway msg for responding to zephyrs when away", "" ), |
---|
[7d4fbcd] | 240 | |
---|
| 241 | OWLVAR_STRING( "zaway_msg_default" /* %OwlVarStub */, |
---|
| 242 | OWL_DEFAULT_ZAWAYMSG, |
---|
[aa2f33b3] | 243 | "default zaway message", "" ), |
---|
[7d4fbcd] | 244 | |
---|
[4b660cc] | 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 | |
---|
[7d4fbcd] | 258 | OWLVAR_STRING( "view_home" /* %OwlVarStub */, "all", |
---|
[aa2f33b3] | 259 | "home view to switch to after 'X' and 'V'", |
---|
| 260 | "SEE ALSO: view, filter\n" ), |
---|
[7d4fbcd] | 261 | |
---|
[ecd5dc5] | 262 | OWLVAR_STRING( "alert_filter" /* %OwlVarStub */, "none", |
---|
| 263 | "filter on which to trigger alert actions", |
---|
| 264 | "" ), |
---|
| 265 | |
---|
| 266 | OWLVAR_STRING( "alert_action" /* %OwlVarStub */, "nop", |
---|
[b278973] | 267 | "owl command to execute for alert actions", |
---|
[ecd5dc5] | 268 | "" ), |
---|
| 269 | |
---|
[f203cad] | 270 | OWLVAR_STRING_FULL( "tty" /* %OwlVarStub */, "", "<string>", "tty name for zephyr location", "", |
---|
[c01e477] | 271 | NULL, owl_variable_tty_set, NULL), |
---|
[bd3f232] | 272 | |
---|
[bc14adc] | 273 | OWLVAR_STRING( "default_style" /* %OwlVarStub */, "default", |
---|
[c3ab155] | 274 | "name of the default formatting style", |
---|
[f1e629d] | 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 | |
---|
[c3ab155] | 284 | |
---|
[d36f2cb] | 285 | OWLVAR_INT( "edit:maxfillcols" /* %OwlVarStub:edit_maxfillcols */, 70, |
---|
[4d9e4254] | 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"), |
---|
[d36f2cb] | 290 | |
---|
[a4bbd80] | 291 | OWLVAR_INT( "edit:maxwrapcols" /* %OwlVarStub:edit_maxwrapcols */, 70, |
---|
[aa2f33b3] | 292 | "maximum number of columns for line-wrapping", |
---|
[4d9e4254] | 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"), |
---|
[d36f2cb] | 299 | |
---|
[1db061d] | 300 | OWLVAR_INT( "aim_ignorelogin_timer" /* %OwlVarStub */, 15, |
---|
[6a415e9] | 301 | "number of seconds after AIM login to ignore login messages", |
---|
| 302 | "This specifies the number of seconds to wait after an\n" |
---|
[d544237] | 303 | "AIM login before allowing the receipt of AIM login notifications.\n" |
---|
[1db061d] | 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."), |
---|
[6a415e9] | 306 | |
---|
| 307 | |
---|
[7d4fbcd] | 308 | OWLVAR_INT_FULL( "typewinsize" /* %OwlVarStub:typwin_lines */, |
---|
| 309 | OWL_TYPWIN_SIZE, |
---|
[aa2f33b3] | 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", |
---|
[7d4fbcd] | 315 | owl_variable_int_validate_gt0, |
---|
| 316 | owl_variable_typewinsize_set, |
---|
| 317 | NULL /* use default for get */ |
---|
| 318 | ), |
---|
| 319 | |
---|
[da466e0] | 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 | |
---|
[aa2f33b3] | 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 | |
---|
[66e409c] | 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" ), |
---|
[ecd5dc5] | 366 | |
---|
[7d4fbcd] | 367 | OWLVAR_BOOL( "_followlast" /* %OwlVarStub */, 0, |
---|
[aa2f33b3] | 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" ), |
---|
[7d4fbcd] | 373 | |
---|
[f203cad] | 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 | |
---|
[7d4fbcd] | 439 | /* This MUST be last... */ |
---|
[aa2f33b3] | 440 | { NULL, 0, NULL, 0, NULL, NULL, NULL, NULL, |
---|
| 441 | NULL, NULL, NULL, NULL, NULL, NULL } |
---|
[7d4fbcd] | 442 | |
---|
[9e86f6f] | 443 | }; |
---|
| 444 | |
---|
[9efc154] | 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; |
---|
[9e86f6f] | 450 | } |
---|
[7d4fbcd] | 451 | |
---|
| 452 | /**************************************************************************/ |
---|
| 453 | /*********************** SPECIFIC TO VARIABLES ****************************/ |
---|
| 454 | /**************************************************************************/ |
---|
| 455 | |
---|
| 456 | |
---|
| 457 | /* commonly useful */ |
---|
| 458 | |
---|
[64735f0] | 459 | int owl_variable_int_validate_gt0(const owl_variable *v, const void *newval) |
---|
[4357be8] | 460 | { |
---|
[7d4fbcd] | 461 | if (newval == NULL) return(0); |
---|
[defe4a3] | 462 | else if (*(const int*)newval < 1) return(0); |
---|
[7d4fbcd] | 463 | else return (1); |
---|
| 464 | } |
---|
| 465 | |
---|
[64735f0] | 466 | int owl_variable_int_validate_positive(const owl_variable *v, const void *newval) |
---|
[4357be8] | 467 | { |
---|
[7d4fbcd] | 468 | if (newval == NULL) return(0); |
---|
[defe4a3] | 469 | else if (*(const int*)newval < 0) return(0); |
---|
[7d4fbcd] | 470 | else return (1); |
---|
| 471 | } |
---|
| 472 | |
---|
| 473 | /* typewinsize */ |
---|
[e19eb97] | 474 | int owl_variable_typewinsize_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 475 | { |
---|
[7d4fbcd] | 476 | int rv; |
---|
| 477 | rv = owl_variable_int_set_default(v, newval); |
---|
[f6fae8d] | 478 | if (0 == rv) owl_mainpanel_layout_contents(&g.mainpanel); |
---|
[7d4fbcd] | 479 | return(rv); |
---|
| 480 | } |
---|
| 481 | |
---|
| 482 | /* debug (cache value in g->debug) */ |
---|
[e19eb97] | 483 | int owl_variable_debug_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 484 | { |
---|
[defe4a3] | 485 | if (newval && (*(const int*)newval == 1 || *(const int*)newval == 0)) { |
---|
| 486 | g.debug = *(const int*)newval; |
---|
[7d4fbcd] | 487 | } |
---|
| 488 | return owl_variable_bool_set_default(v, newval); |
---|
[4b660cc] | 489 | } |
---|
| 490 | |
---|
| 491 | /* When 'aaway' is changed, need to notify the AIM server */ |
---|
[e19eb97] | 492 | int owl_variable_aaway_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 493 | { |
---|
[4b660cc] | 494 | if (newval) { |
---|
[defe4a3] | 495 | if (*(const int*)newval == 1) { |
---|
[4b660cc] | 496 | owl_aim_set_awaymsg(owl_global_get_aaway_msg(&g)); |
---|
[defe4a3] | 497 | } else if (*(const int*)newval == 0) { |
---|
[4b660cc] | 498 | owl_aim_set_awaymsg(""); |
---|
| 499 | } |
---|
| 500 | } |
---|
| 501 | return owl_variable_bool_set_default(v, newval); |
---|
[7d4fbcd] | 502 | } |
---|
| 503 | |
---|
[e19eb97] | 504 | int owl_variable_pseudologins_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 505 | { |
---|
[72146c7] | 506 | static guint timer = 0; |
---|
[4357be8] | 507 | if (newval) { |
---|
[defe4a3] | 508 | if (*(const int*)newval == 1) { |
---|
[4357be8] | 509 | owl_function_zephyr_buddy_check(0); |
---|
[72146c7] | 510 | if (timer == 0) { |
---|
| 511 | timer = g_timeout_add_seconds(180, owl_zephyr_buddycheck_timer, NULL); |
---|
[3687413] | 512 | } |
---|
| 513 | } else { |
---|
[72146c7] | 514 | if (timer != 0) { |
---|
| 515 | g_source_remove(timer); |
---|
| 516 | timer = 0; |
---|
[3687413] | 517 | } |
---|
[4357be8] | 518 | } |
---|
| 519 | } |
---|
| 520 | return owl_variable_bool_set_default(v, newval); |
---|
| 521 | } |
---|
| 522 | |
---|
[7d4fbcd] | 523 | /* note that changing the value of this will clobber |
---|
| 524 | * any user setting of this */ |
---|
[e19eb97] | 525 | int owl_variable_disable_ctrl_d_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 526 | { |
---|
[217a43e] | 527 | if (newval && !owl_context_is_startup(owl_global_get_context(&g))) { |
---|
[defe4a3] | 528 | if (*(const int*)newval == 2) { |
---|
[7d4fbcd] | 529 | owl_function_command_norv("bindkey editmulti C-d command edit:delete-next-char"); |
---|
[defe4a3] | 530 | } else if (*(const int*)newval == 1) { |
---|
[3b42640] | 531 | owl_function_command_norv("bindkey editmulti C-d command edit:done-or-delete"); |
---|
[7d4fbcd] | 532 | } else { |
---|
[3b42640] | 533 | owl_function_command_norv("bindkey editmulti C-d command edit:done"); |
---|
[7d4fbcd] | 534 | } |
---|
| 535 | } |
---|
[217a43e] | 536 | return owl_variable_int_set_default(v, newval); |
---|
[7d4fbcd] | 537 | } |
---|
| 538 | |
---|
[e19eb97] | 539 | int owl_variable_tty_set(owl_variable *v, const void *newval) |
---|
[4357be8] | 540 | { |
---|
[f54b07d] | 541 | owl_zephyr_set_locationinfo(g_get_host_name(), newval); |
---|
[c01e477] | 542 | return(owl_variable_string_set_default(v, newval)); |
---|
| 543 | } |
---|
| 544 | |
---|
[f203cad] | 545 | int owl_variable_default_exposure_set(owl_variable *v, const void *newval) |
---|
| 546 | { |
---|
| 547 | return owl_zephyr_set_default_exposure(newval); |
---|
| 548 | } |
---|
| 549 | |
---|
| 550 | const void *owl_variable_default_exposure_get(const owl_variable *v) |
---|
| 551 | { |
---|
| 552 | return owl_zephyr_get_default_exposure(); |
---|
| 553 | } |
---|
| 554 | |
---|
| 555 | int 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 | } |
---|
[7d4fbcd] | 562 | |
---|
| 563 | /**************************************************************************/ |
---|
| 564 | /****************************** GENERAL ***********************************/ |
---|
| 565 | /**************************************************************************/ |
---|
| 566 | |
---|
| 567 | int owl_variable_dict_setup(owl_vardict *vd) { |
---|
[4c7c21f] | 568 | owl_dict_create(vd); |
---|
[9e86f6f] | 569 | return owl_variable_add_defaults(vd); |
---|
| 570 | } |
---|
| 571 | |
---|
| 572 | int owl_variable_dict_add_from_list(owl_vardict *vd, owl_variable *variables_to_init) |
---|
| 573 | { |
---|
[3dfc083] | 574 | int ret; |
---|
[9e86f6f] | 575 | owl_variable *var, *cur; |
---|
[d536e72] | 576 | for (var = variables_to_init; var->name != NULL; var++) { |
---|
[96828e4] | 577 | cur = g_new(owl_variable, 1); |
---|
[66a8cd6] | 578 | *cur = *var; |
---|
[7d7326c] | 579 | /* strdup all the strings so we can delete them consistently. */ |
---|
[d4927a7] | 580 | cur->name = g_strdup(var->name); |
---|
| 581 | cur->summary = g_strdup(var->summary); |
---|
| 582 | cur->description = g_strdup(var->description); |
---|
[3dfc083] | 583 | if (var->type == OWL_VARIABLE_STRING) |
---|
| 584 | cur->pval_default = g_strdup(var->pval_default); |
---|
| 585 | ret = owl_variable_init_defaults(cur); |
---|
| 586 | if (ret != 0) { |
---|
| 587 | fprintf(stderr, "owl_variable_setup: invalid variable type\n"); |
---|
| 588 | return ret; |
---|
| 589 | } |
---|
| 590 | owl_dict_insert_element(vd, cur->name, cur, NULL); |
---|
| 591 | } |
---|
| 592 | return 0; |
---|
| 593 | } |
---|
| 594 | int owl_variable_init_defaults(owl_variable *cur) |
---|
| 595 | { |
---|
| 596 | switch (cur->type) { |
---|
[7d4fbcd] | 597 | case OWL_VARIABLE_OTHER: |
---|
| 598 | cur->set_fn(cur, cur->pval_default); |
---|
| 599 | break; |
---|
| 600 | case OWL_VARIABLE_STRING: |
---|
| 601 | if (!cur->validate_fn) |
---|
| 602 | cur->validate_fn = owl_variable_string_validate_default; |
---|
| 603 | if (!cur->set_fn) |
---|
| 604 | cur->set_fn = owl_variable_string_set_default; |
---|
| 605 | if (!cur->set_fromstring_fn) |
---|
| 606 | cur->set_fromstring_fn = owl_variable_string_set_fromstring_default; |
---|
| 607 | if (!cur->get_fn) |
---|
| 608 | cur->get_fn = owl_variable_get_default; |
---|
| 609 | if (!cur->get_tostring_fn) |
---|
| 610 | cur->get_tostring_fn = owl_variable_string_get_tostring_default; |
---|
[bbd74a9] | 611 | if (!cur->delete_fn) |
---|
| 612 | cur->delete_fn = owl_variable_delete_default; |
---|
[7d4fbcd] | 613 | cur->set_fn(cur, cur->pval_default); |
---|
| 614 | break; |
---|
| 615 | case OWL_VARIABLE_BOOL: |
---|
| 616 | if (!cur->validate_fn) |
---|
| 617 | cur->validate_fn = owl_variable_bool_validate_default; |
---|
| 618 | if (!cur->set_fn) |
---|
| 619 | cur->set_fn = owl_variable_bool_set_default; |
---|
| 620 | if (!cur->set_fromstring_fn) |
---|
| 621 | cur->set_fromstring_fn = owl_variable_bool_set_fromstring_default; |
---|
| 622 | if (!cur->get_fn) |
---|
| 623 | cur->get_fn = owl_variable_get_default; |
---|
| 624 | if (!cur->get_tostring_fn) |
---|
| 625 | cur->get_tostring_fn = owl_variable_bool_get_tostring_default; |
---|
[bbd74a9] | 626 | if (!cur->delete_fn) |
---|
| 627 | cur->delete_fn = owl_variable_delete_default; |
---|
[96828e4] | 628 | cur->val = g_new(int, 1); |
---|
[7d4fbcd] | 629 | cur->set_fn(cur, &cur->ival_default); |
---|
| 630 | break; |
---|
| 631 | case OWL_VARIABLE_INT: |
---|
| 632 | if (!cur->validate_fn) |
---|
| 633 | cur->validate_fn = owl_variable_int_validate_default; |
---|
| 634 | if (!cur->set_fn) |
---|
| 635 | cur->set_fn = owl_variable_int_set_default; |
---|
| 636 | if (!cur->set_fromstring_fn) |
---|
| 637 | cur->set_fromstring_fn = owl_variable_int_set_fromstring_default; |
---|
| 638 | if (!cur->get_fn) |
---|
| 639 | cur->get_fn = owl_variable_get_default; |
---|
| 640 | if (!cur->get_tostring_fn) |
---|
| 641 | cur->get_tostring_fn = owl_variable_int_get_tostring_default; |
---|
[bbd74a9] | 642 | if (!cur->delete_fn) |
---|
| 643 | cur->delete_fn = owl_variable_delete_default; |
---|
[96828e4] | 644 | cur->val = g_new(int, 1); |
---|
[7d4fbcd] | 645 | cur->set_fn(cur, &cur->ival_default); |
---|
| 646 | break; |
---|
| 647 | default: |
---|
[3dfc083] | 648 | return -2; |
---|
[7d4fbcd] | 649 | } |
---|
| 650 | return 0; |
---|
| 651 | } |
---|
| 652 | |
---|
[a695a68] | 653 | void owl_variable_dict_add_variable(owl_vardict * vardict, |
---|
| 654 | owl_variable * var) { |
---|
[3b0edaa] | 655 | owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete); |
---|
[a695a68] | 656 | } |
---|
| 657 | |
---|
[3dfc083] | 658 | CALLER_OWN owl_variable *owl_variable_newvar(const char *name, const char *summary, const char *description, const char *validsettings, int type) |
---|
[d427f08] | 659 | { |
---|
[3dfc083] | 660 | owl_variable *var = g_new0(owl_variable, 1); |
---|
[d4927a7] | 661 | var->name = g_strdup(name); |
---|
| 662 | var->summary = g_strdup(summary); |
---|
| 663 | var->description = g_strdup(description); |
---|
[3dfc083] | 664 | var->validsettings = validsettings; |
---|
| 665 | var->type = type; |
---|
[a695a68] | 666 | return var; |
---|
| 667 | } |
---|
| 668 | |
---|
[3dfc083] | 669 | void owl_variable_dict_newvar_string(owl_vardict *vd, const char *name, const char *summ, const char *desc, const char *initval) |
---|
| 670 | { |
---|
| 671 | owl_variable *var = owl_variable_newvar(name, summ, desc, "<string>", OWL_VARIABLE_STRING); |
---|
| 672 | var->pval_default = g_strdup(initval); |
---|
| 673 | owl_variable_init_defaults(var); |
---|
| 674 | owl_variable_dict_add_variable(vd, var); |
---|
[a695a68] | 675 | } |
---|
| 676 | |
---|
[3dfc083] | 677 | void owl_variable_dict_newvar_int(owl_vardict *vd, const char *name, const char *summ, const char *desc, int initval) |
---|
| 678 | { |
---|
| 679 | owl_variable *var = owl_variable_newvar(name, summ, desc, "<int>", OWL_VARIABLE_INT); |
---|
| 680 | var->ival_default = initval; |
---|
| 681 | owl_variable_init_defaults(var); |
---|
| 682 | owl_variable_dict_add_variable(vd, var); |
---|
[a695a68] | 683 | } |
---|
| 684 | |
---|
[3dfc083] | 685 | void owl_variable_dict_newvar_bool(owl_vardict *vd, const char *name, const char *summ, const char *desc, bool initval) |
---|
| 686 | { |
---|
| 687 | owl_variable *var = owl_variable_newvar(name, summ, desc, "on,off", OWL_VARIABLE_BOOL); |
---|
| 688 | var->ival_default = initval; |
---|
| 689 | owl_variable_init_defaults(var); |
---|
| 690 | owl_variable_dict_add_variable(vd, var); |
---|
[a695a68] | 691 | } |
---|
| 692 | |
---|
[0fef6eb] | 693 | void owl_variable_dict_cleanup(owl_vardict *d) |
---|
| 694 | { |
---|
[bf7aa1d] | 695 | owl_dict_cleanup(d, (void (*)(void *))owl_variable_delete); |
---|
[7d4fbcd] | 696 | } |
---|
| 697 | |
---|
[ce68f23] | 698 | CALLER_OWN GPtrArray *owl_variable_dict_get_names(const owl_vardict *d) { |
---|
| 699 | return owl_dict_get_keys(d); |
---|
[7d4fbcd] | 700 | } |
---|
| 701 | |
---|
[9efc154] | 702 | void owl_variable_cleanup(owl_variable *v) |
---|
[3b0edaa] | 703 | { |
---|
[bbd74a9] | 704 | if (v->delete_fn) v->delete_fn(v); |
---|
[ddbbcffa] | 705 | g_free(v->name); |
---|
| 706 | g_free(v->summary); |
---|
| 707 | g_free(v->description); |
---|
[ea68035] | 708 | if (v->type == OWL_VARIABLE_STRING) |
---|
| 709 | g_free(v->pval_default); |
---|
[9efc154] | 710 | } |
---|
| 711 | |
---|
| 712 | void owl_variable_delete(owl_variable *v) |
---|
| 713 | { |
---|
| 714 | owl_variable_cleanup(v); |
---|
[ddbbcffa] | 715 | g_free(v); |
---|
[7d4fbcd] | 716 | } |
---|
| 717 | |
---|
| 718 | |
---|
[64735f0] | 719 | const char *owl_variable_get_description(const owl_variable *v) { |
---|
[aa2f33b3] | 720 | return v->description; |
---|
| 721 | } |
---|
| 722 | |
---|
[64735f0] | 723 | const char *owl_variable_get_summary(const owl_variable *v) { |
---|
[aa2f33b3] | 724 | return v->summary; |
---|
[7d4fbcd] | 725 | } |
---|
| 726 | |
---|
[64735f0] | 727 | const char *owl_variable_get_validsettings(const owl_variable *v) { |
---|
[f4e857f] | 728 | return v->validsettings; |
---|
[7d4fbcd] | 729 | } |
---|
| 730 | |
---|
| 731 | /* functions for getting and setting variable values */ |
---|
| 732 | |
---|
| 733 | /* returns 0 on success, prints a status msg if msg is true */ |
---|
[e19eb97] | 734 | int owl_variable_set_fromstring(owl_vardict *d, const char *name, const char *value, int msg, int requirebool) { |
---|
[7d4fbcd] | 735 | owl_variable *v; |
---|
[010a951] | 736 | char *tostring; |
---|
[7d4fbcd] | 737 | if (!name) return(-1); |
---|
| 738 | v = owl_dict_find_element(d, name); |
---|
| 739 | if (v == NULL) { |
---|
[836ea3a3] | 740 | if (msg) owl_function_error("Unknown variable %s", name); |
---|
[7d4fbcd] | 741 | return -1; |
---|
| 742 | } |
---|
| 743 | if (!v->set_fromstring_fn) { |
---|
[836ea3a3] | 744 | if (msg) owl_function_error("Variable %s is read-only", name); |
---|
[486688f] | 745 | return -1; |
---|
| 746 | } |
---|
| 747 | if (requirebool && v->type!=OWL_VARIABLE_BOOL) { |
---|
[836ea3a3] | 748 | if (msg) owl_function_error("Variable %s is not a boolean", name); |
---|
[486688f] | 749 | return -1; |
---|
[7d4fbcd] | 750 | } |
---|
| 751 | if (0 != v->set_fromstring_fn(v, value)) { |
---|
[836ea3a3] | 752 | if (msg) owl_function_error("Unable to set %s (must be %s)", name, |
---|
[7d4fbcd] | 753 | owl_variable_get_validsettings(v)); |
---|
| 754 | return -1; |
---|
| 755 | } |
---|
[f4e857f] | 756 | if (msg) { |
---|
[779bd3d] | 757 | tostring = v->get_tostring_fn(v, v->get_fn(v)); |
---|
[010a951] | 758 | owl_function_makemsg("%s = '%s'", name, tostring); |
---|
| 759 | g_free(tostring); |
---|
[7d4fbcd] | 760 | } |
---|
| 761 | return 0; |
---|
| 762 | } |
---|
| 763 | |
---|
[e19eb97] | 764 | int owl_variable_set_string(owl_vardict *d, const char *name, const char *newval) { |
---|
[7d4fbcd] | 765 | owl_variable *v; |
---|
| 766 | if (!name) return(-1); |
---|
| 767 | v = owl_dict_find_element(d, name); |
---|
| 768 | if (v == NULL || !v->set_fn) return(-1); |
---|
| 769 | if (v->type!=OWL_VARIABLE_STRING) return(-1); |
---|
[ba6c8bd] | 770 | return v->set_fn(v, newval); |
---|
[7d4fbcd] | 771 | } |
---|
| 772 | |
---|
[e19eb97] | 773 | int owl_variable_set_int(owl_vardict *d, const char *name, int newval) { |
---|
[7d4fbcd] | 774 | owl_variable *v; |
---|
| 775 | if (!name) return(-1); |
---|
| 776 | v = owl_dict_find_element(d, name); |
---|
| 777 | if (v == NULL || !v->set_fn) return(-1); |
---|
| 778 | if (v->type!=OWL_VARIABLE_INT && v->type!=OWL_VARIABLE_BOOL) return(-1); |
---|
| 779 | return v->set_fn(v, &newval); |
---|
| 780 | } |
---|
| 781 | |
---|
[e19eb97] | 782 | int owl_variable_set_bool_on(owl_vardict *d, const char *name) { |
---|
[7d4fbcd] | 783 | return owl_variable_set_int(d,name,1); |
---|
| 784 | } |
---|
| 785 | |
---|
[e19eb97] | 786 | int owl_variable_set_bool_off(owl_vardict *d, const char *name) { |
---|
[7d4fbcd] | 787 | return owl_variable_set_int(d,name,0); |
---|
| 788 | } |
---|
| 789 | |
---|
[6829afc] | 790 | CALLER_OWN char *owl_variable_get_tostring(const owl_vardict *d, const char *name) |
---|
[d427f08] | 791 | { |
---|
[7d4fbcd] | 792 | owl_variable *v; |
---|
[010a951] | 793 | if (!name) return NULL; |
---|
[7d4fbcd] | 794 | v = owl_dict_find_element(d, name); |
---|
[f4e857f] | 795 | if (v == NULL) return NULL; |
---|
[779bd3d] | 796 | return v->get_tostring_fn(v, v->get_fn(v)); |
---|
[7d4fbcd] | 797 | } |
---|
| 798 | |
---|
[6829afc] | 799 | CALLER_OWN char *owl_variable_get_default_tostring(const owl_vardict *d, const char *name) |
---|
[d427f08] | 800 | { |
---|
[7d4fbcd] | 801 | owl_variable *v; |
---|
[010a951] | 802 | if (!name) return NULL; |
---|
[7d4fbcd] | 803 | v = owl_dict_find_element(d, name); |
---|
[f4e857f] | 804 | if (v == NULL) return NULL; |
---|
[7d4fbcd] | 805 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
[010a951] | 806 | return v->get_tostring_fn(v, &(v->ival_default)); |
---|
[7d4fbcd] | 807 | } else { |
---|
[010a951] | 808 | return v->get_tostring_fn(v, v->pval_default); |
---|
[7d4fbcd] | 809 | } |
---|
| 810 | } |
---|
| 811 | |
---|
[eeba011] | 812 | owl_variable *owl_variable_get_var(const owl_vardict *d, const char *name) |
---|
| 813 | { |
---|
[7d4fbcd] | 814 | owl_variable *v; |
---|
| 815 | if (!name) return(NULL); |
---|
| 816 | v = owl_dict_find_element(d, name); |
---|
[f4e857f] | 817 | if (v == NULL) return NULL; |
---|
[d536e72] | 818 | return v; |
---|
| 819 | } |
---|
| 820 | |
---|
| 821 | /* returns a reference */ |
---|
[eeba011] | 822 | const void *owl_variable_get(const owl_vardict *d, const char *name) |
---|
| 823 | { |
---|
| 824 | const owl_variable *v = owl_variable_get_var(d, name); |
---|
[d536e72] | 825 | if(v == NULL) return NULL; |
---|
[7d4fbcd] | 826 | return v->get_fn(v); |
---|
| 827 | } |
---|
| 828 | |
---|
| 829 | /* returns a reference */ |
---|
[e5c9b14a] | 830 | const char *owl_variable_get_string(const owl_vardict *d, const char *name) { |
---|
[eeba011] | 831 | /* XXX TODO: Put type checking back in */ |
---|
| 832 | return owl_variable_get(d, name); |
---|
[7d4fbcd] | 833 | } |
---|
| 834 | |
---|
| 835 | /* returns a reference */ |
---|
[e5c9b14a] | 836 | const void *owl_variable_get_other(const owl_vardict *d, const char *name) { |
---|
[eeba011] | 837 | /* XXX TODO: Put type checking back in */ |
---|
| 838 | return owl_variable_get(d, name); |
---|
[7d4fbcd] | 839 | } |
---|
| 840 | |
---|
[e5c9b14a] | 841 | int owl_variable_get_int(const owl_vardict *d, const char *name) { |
---|
[eeba011] | 842 | /* XXX TODO: Put type checking back in */ |
---|
| 843 | const int *pi = owl_variable_get(d, name); |
---|
[7d4fbcd] | 844 | if (!pi) return(-1); |
---|
| 845 | return(*pi); |
---|
| 846 | } |
---|
| 847 | |
---|
[e5c9b14a] | 848 | int owl_variable_get_bool(const owl_vardict *d, const char *name) { |
---|
[eeba011] | 849 | /* XXX TODO: Put type checking back in */ |
---|
| 850 | const int *pi = owl_variable_get(d, name); |
---|
[7d4fbcd] | 851 | if (!pi) return(-1); |
---|
| 852 | return(*pi); |
---|
| 853 | } |
---|
| 854 | |
---|
[e5c9b14a] | 855 | void owl_variable_describe(const owl_vardict *d, const char *name, owl_fmtext *fm) { |
---|
[010a951] | 856 | char *default_buf; |
---|
[7d4fbcd] | 857 | owl_variable *v; |
---|
| 858 | |
---|
| 859 | if (!name |
---|
[f4e857f] | 860 | || (v = owl_dict_find_element(d, name)) == NULL) { |
---|
[010a951] | 861 | owl_fmtext_appendf_normal(fm, " No such variable '%s'\n", name); |
---|
[7d4fbcd] | 862 | return; |
---|
| 863 | } |
---|
| 864 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
[010a951] | 865 | default_buf = v->get_tostring_fn(v, &(v->ival_default)); |
---|
[7d4fbcd] | 866 | } else { |
---|
[010a951] | 867 | default_buf = v->get_tostring_fn(v, v->pval_default); |
---|
[7d4fbcd] | 868 | } |
---|
[010a951] | 869 | owl_fmtext_appendf_normal(fm, OWL_TABSTR "%-20s - %s (default: '%s')\n", |
---|
| 870 | v->name, |
---|
| 871 | owl_variable_get_summary(v), default_buf); |
---|
| 872 | g_free(default_buf); |
---|
[7d4fbcd] | 873 | } |
---|
| 874 | |
---|
[e5c9b14a] | 875 | void owl_variable_get_help(const owl_vardict *d, const char *name, owl_fmtext *fm) { |
---|
[010a951] | 876 | char *tostring; |
---|
[7d4fbcd] | 877 | owl_variable *v; |
---|
| 878 | |
---|
| 879 | if (!name |
---|
[f4e857f] | 880 | || (v = owl_dict_find_element(d, name)) == NULL) { |
---|
[7d4fbcd] | 881 | owl_fmtext_append_normal(fm, "No such variable...\n"); |
---|
| 882 | return; |
---|
| 883 | } |
---|
| 884 | |
---|
| 885 | owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n"); |
---|
| 886 | owl_fmtext_append_normal(fm, OWL_TABSTR); |
---|
| 887 | owl_fmtext_append_normal(fm, name); |
---|
| 888 | owl_fmtext_append_normal(fm, " - "); |
---|
[aa2f33b3] | 889 | owl_fmtext_append_normal(fm, v->summary); |
---|
[7d4fbcd] | 890 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 891 | |
---|
| 892 | owl_fmtext_append_normal(fm, "Current: "); |
---|
[010a951] | 893 | tostring = owl_variable_get_tostring(d, name); |
---|
| 894 | owl_fmtext_append_normal(fm, tostring); |
---|
| 895 | g_free(tostring); |
---|
[7d4fbcd] | 896 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 897 | |
---|
| 898 | |
---|
| 899 | if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) { |
---|
[010a951] | 900 | tostring = v->get_tostring_fn(v, &(v->ival_default)); |
---|
[7d4fbcd] | 901 | } else { |
---|
[010a951] | 902 | tostring = v->get_tostring_fn(v, v->pval_default); |
---|
[7d4fbcd] | 903 | } |
---|
| 904 | owl_fmtext_append_normal(fm, "Default: "); |
---|
[010a951] | 905 | owl_fmtext_append_normal(fm, tostring); |
---|
[7d4fbcd] | 906 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 907 | |
---|
| 908 | owl_fmtext_append_normal(fm, "Valid Settings: "); |
---|
| 909 | owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v)); |
---|
| 910 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
[aa2f33b3] | 911 | |
---|
| 912 | if (v->description && *v->description) { |
---|
| 913 | owl_fmtext_append_normal(fm, "Description:\n"); |
---|
| 914 | owl_fmtext_append_normal(fm, owl_variable_get_description(v)); |
---|
| 915 | owl_fmtext_append_normal(fm, "\n\n"); |
---|
| 916 | } |
---|
[010a951] | 917 | g_free(tostring); |
---|
[7d4fbcd] | 918 | } |
---|
| 919 | |
---|
| 920 | |
---|
| 921 | |
---|
| 922 | |
---|
| 923 | /**************************************************************************/ |
---|
| 924 | /*********************** GENERAL TYPE-SPECIFIC ****************************/ |
---|
| 925 | /**************************************************************************/ |
---|
| 926 | |
---|
| 927 | /* default common functions */ |
---|
| 928 | |
---|
[64735f0] | 929 | const void *owl_variable_get_default(const owl_variable *v) { |
---|
[7d4fbcd] | 930 | return v->val; |
---|
| 931 | } |
---|
| 932 | |
---|
[bbd74a9] | 933 | void owl_variable_delete_default(owl_variable *v) |
---|
| 934 | { |
---|
[3b8a563] | 935 | g_free(v->val); |
---|
[7d4fbcd] | 936 | } |
---|
| 937 | |
---|
| 938 | /* default functions for booleans */ |
---|
| 939 | |
---|
[64735f0] | 940 | int owl_variable_bool_validate_default(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 941 | if (newval == NULL) return(0); |
---|
[defe4a3] | 942 | else if (*(const int*)newval==1 || *(const int*)newval==0) return(1); |
---|
[7d4fbcd] | 943 | else return (0); |
---|
| 944 | } |
---|
| 945 | |
---|
[e19eb97] | 946 | int owl_variable_bool_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 947 | if (v->validate_fn) { |
---|
| 948 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 949 | } |
---|
[defe4a3] | 950 | *(int*)v->val = *(const int*)newval; |
---|
[7d4fbcd] | 951 | return(0); |
---|
| 952 | } |
---|
| 953 | |
---|
[e19eb97] | 954 | int owl_variable_bool_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 955 | int i; |
---|
| 956 | if (!strcmp(newval, "on")) i=1; |
---|
| 957 | else if (!strcmp(newval, "off")) i=0; |
---|
| 958 | else return(-1); |
---|
| 959 | return (v->set_fn(v, &i)); |
---|
| 960 | } |
---|
| 961 | |
---|
[6829afc] | 962 | CALLER_OWN char *owl_variable_bool_get_tostring_default(const owl_variable *v, const void *val) |
---|
[d427f08] | 963 | { |
---|
[7d4fbcd] | 964 | if (val == NULL) { |
---|
[010a951] | 965 | return g_strdup("<null>"); |
---|
[defe4a3] | 966 | } else if (*(const int*)val == 0) { |
---|
[010a951] | 967 | return g_strdup("off"); |
---|
[defe4a3] | 968 | } else if (*(const int*)val == 1) { |
---|
[010a951] | 969 | return g_strdup("on"); |
---|
[7d4fbcd] | 970 | } else { |
---|
[010a951] | 971 | return g_strdup("<invalid>"); |
---|
[7d4fbcd] | 972 | } |
---|
| 973 | } |
---|
| 974 | |
---|
| 975 | /* default functions for integers */ |
---|
| 976 | |
---|
[64735f0] | 977 | int owl_variable_int_validate_default(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 978 | if (newval == NULL) return(0); |
---|
| 979 | else return (1); |
---|
| 980 | } |
---|
| 981 | |
---|
[e19eb97] | 982 | int owl_variable_int_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 983 | if (v->validate_fn) { |
---|
| 984 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 985 | } |
---|
[defe4a3] | 986 | *(int*)v->val = *(const int*)newval; |
---|
[7d4fbcd] | 987 | return(0); |
---|
| 988 | } |
---|
| 989 | |
---|
[e19eb97] | 990 | int owl_variable_int_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 991 | int i; |
---|
[99525be] | 992 | char *ep; |
---|
| 993 | i = strtol(newval, &ep, 10); |
---|
[7d4fbcd] | 994 | if (*ep || ep==newval) return(-1); |
---|
| 995 | return (v->set_fn(v, &i)); |
---|
| 996 | } |
---|
| 997 | |
---|
[6829afc] | 998 | CALLER_OWN char *owl_variable_int_get_tostring_default(const owl_variable *v, const void *val) |
---|
[d427f08] | 999 | { |
---|
[7d4fbcd] | 1000 | if (val == NULL) { |
---|
[010a951] | 1001 | return g_strdup("<null>"); |
---|
[7d4fbcd] | 1002 | } else { |
---|
[010a951] | 1003 | return g_strdup_printf("%d", *(const int*)val); |
---|
[7d4fbcd] | 1004 | } |
---|
| 1005 | } |
---|
| 1006 | |
---|
| 1007 | /* default functions for enums (a variant of integers) */ |
---|
| 1008 | |
---|
[64735f0] | 1009 | int owl_variable_enum_validate(const owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 1010 | char **enums; |
---|
| 1011 | int nenums, val; |
---|
| 1012 | if (newval == NULL) return(0); |
---|
[d275eb2] | 1013 | enums = g_strsplit_set(v->validsettings, ",", 0); |
---|
| 1014 | nenums = g_strv_length(enums); |
---|
| 1015 | g_strfreev(enums); |
---|
[defe4a3] | 1016 | val = *(const int*)newval; |
---|
[7d4fbcd] | 1017 | if (val < 0 || val >= nenums) { |
---|
| 1018 | return(0); |
---|
| 1019 | } |
---|
| 1020 | return(1); |
---|
| 1021 | } |
---|
| 1022 | |
---|
[e19eb97] | 1023 | int owl_variable_enum_set_fromstring(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 1024 | char **enums; |
---|
[d275eb2] | 1025 | int i, val=-1; |
---|
[7d4fbcd] | 1026 | if (newval == NULL) return(-1); |
---|
[d275eb2] | 1027 | enums = g_strsplit_set(v->validsettings, ",", 0); |
---|
| 1028 | for (i = 0; enums[i] != NULL; i++) { |
---|
[7d4fbcd] | 1029 | if (0==strcmp(newval, enums[i])) { |
---|
| 1030 | val = i; |
---|
| 1031 | } |
---|
| 1032 | } |
---|
[d275eb2] | 1033 | g_strfreev(enums); |
---|
[7d4fbcd] | 1034 | if (val == -1) return(-1); |
---|
| 1035 | return (v->set_fn(v, &val)); |
---|
| 1036 | } |
---|
| 1037 | |
---|
[6829afc] | 1038 | CALLER_OWN char *owl_variable_enum_get_tostring(const owl_variable *v, const void *val) |
---|
[d427f08] | 1039 | { |
---|
[7d4fbcd] | 1040 | char **enums; |
---|
| 1041 | int nenums, i; |
---|
[010a951] | 1042 | char *tostring; |
---|
[7d4fbcd] | 1043 | |
---|
| 1044 | if (val == NULL) { |
---|
[010a951] | 1045 | return g_strdup("<null>"); |
---|
[7d4fbcd] | 1046 | } |
---|
[d275eb2] | 1047 | enums = g_strsplit_set(v->validsettings, ",", 0); |
---|
| 1048 | nenums = g_strv_length(enums); |
---|
[defe4a3] | 1049 | i = *(const int*)val; |
---|
[7d4fbcd] | 1050 | if (i<0 || i>=nenums) { |
---|
[d275eb2] | 1051 | g_strfreev(enums); |
---|
[010a951] | 1052 | return g_strdup_printf("<invalid:%d>", i); |
---|
[7d4fbcd] | 1053 | } |
---|
[010a951] | 1054 | tostring = g_strdup(enums[i]); |
---|
[d275eb2] | 1055 | g_strfreev(enums); |
---|
[010a951] | 1056 | return tostring; |
---|
[7d4fbcd] | 1057 | } |
---|
| 1058 | |
---|
| 1059 | /* default functions for stringeans */ |
---|
| 1060 | |
---|
[64735f0] | 1061 | int owl_variable_string_validate_default(const struct _owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 1062 | if (newval == NULL) return(0); |
---|
| 1063 | else return (1); |
---|
| 1064 | } |
---|
| 1065 | |
---|
[e19eb97] | 1066 | int owl_variable_string_set_default(owl_variable *v, const void *newval) { |
---|
[7d4fbcd] | 1067 | if (v->validate_fn) { |
---|
| 1068 | if (!v->validate_fn(v, newval)) return(-1); |
---|
| 1069 | } |
---|
[3b8a563] | 1070 | g_free(v->val); |
---|
[d4927a7] | 1071 | v->val = g_strdup(newval); |
---|
[7d4fbcd] | 1072 | return(0); |
---|
| 1073 | } |
---|
| 1074 | |
---|
[e19eb97] | 1075 | int owl_variable_string_set_fromstring_default(owl_variable *v, const char *newval) { |
---|
[7d4fbcd] | 1076 | return (v->set_fn(v, newval)); |
---|
| 1077 | } |
---|
| 1078 | |
---|
[6829afc] | 1079 | CALLER_OWN char *owl_variable_string_get_tostring_default(const owl_variable *v, const void *val) |
---|
[d427f08] | 1080 | { |
---|
[7d4fbcd] | 1081 | if (val == NULL) { |
---|
[010a951] | 1082 | return g_strdup("<null>"); |
---|
[7d4fbcd] | 1083 | } else { |
---|
[010a951] | 1084 | return g_strdup((const char*)val); |
---|
[7d4fbcd] | 1085 | } |
---|
| 1086 | } |
---|
| 1087 | |
---|