/* returns 0 on success, prints a status msg if msg is true */
int owl_variable_set_fromstring(owl_variable *v, const char *value, int msg) {
char *tostring;
GValue values[] = {G_VALUE_INIT, G_VALUE_INIT};
GValue return_box = G_VALUE_INIT;
int set_successfully;
g_value_init(&values[0], G_TYPE_POINTER);
g_value_set_pointer(&values[0], NULL);
g_value_init(&values[1], G_TYPE_STRING);
g_value_set_static_string(&values[1], value);
g_value_init(&return_box, G_TYPE_INT);
g_closure_invoke(v->set_fromstring_fn, &return_box, 2, values, NULL);
set_successfully = g_value_get_int(&return_box);
if (0 != set_successfully) {
if (msg) owl_function_error("Unable to set %s (must be %s)", owl_variable_get_name(v),
owl_variable_get_validsettings(v));
} else if (msg) {
tostring = owl_variable_get_tostring(v);
if (tostring) {
owl_function_makemsg("%s = '%s'", owl_variable_get_name(v), tostring);
} else {
owl_function_makemsg("%s = <null>", owl_variable_get_name(v));
}
g_free(tostring);
}
g_value_unset(&return_box);
g_value_unset(&values[1]);
g_value_unset(&values[0]);
return set_successfully;
}
void owl_variable_get_help(const owl_variable *v, owl_fmtext *fm) {
char *tostring;
const char *default_str;
owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
owl_fmtext_append_normal(fm, OWL_TABSTR);
owl_fmtext_append_normal(fm, owl_variable_get_name(v));
owl_fmtext_append_normal(fm, " - ");
owl_fmtext_append_normal(fm, owl_variable_get_summary(v));
owl_fmtext_append_normal(fm, "\n\n");
owl_fmtext_append_normal(fm, "Current: ");
tostring = owl_variable_get_tostring(v);
owl_fmtext_append_normal(fm, (tostring ? tostring : "<null>"));
g_free(tostring);
owl_fmtext_append_normal(fm, "\n\n");
default_str = owl_variable_get_default_tostring(v);
owl_fmtext_append_normal(fm, "Default: ");
owl_fmtext_append_normal(fm, (default_str ? default_str : "<null>"));
owl_fmtext_append_normal(fm, "\n\n");
owl_fmtext_append_normal(fm, "Valid Settings: ");
owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
owl_fmtext_append_normal(fm, "\n\n");
if (v->description && *v->description) {
owl_fmtext_append_normal(fm, "Description:\n");
owl_fmtext_append_normal(fm, owl_variable_get_description(v));
owl_fmtext_append_normal(fm, "\n\n");
}
}
void owl_variable_dict_add_variable(owl_vardict * vardict,
owl_variable * var) {
char *oldvalue = NULL;
owl_variable *oldvar = owl_variable_get_var(vardict, var->name);
/* Save the old value as a string. */
if (oldvar) {
oldvalue = owl_variable_get_tostring(oldvar);
}
owl_dict_insert_element(vardict, var->name, var, (void (*)(void *))owl_variable_delete);
/* Restore the old value. */
if (oldvalue) {
owl_variable_set_fromstring(var, oldvalue, 0);
g_free(oldvalue);
}
}
void owl_variable_dict_newvar_other(owl_vardict *vd, const char *name, const char *summary, const char *description, const char *validsettings, bool takes_on_off, GClosure *get_tostring_fn, GClosure *set_fromstring_fn)
{
owl_variable *var = owl_variable_newvar(OWL_VARIABLE_OTHER, name, summary,
description, validsettings);
var->takes_on_off = takes_on_off;
var->get_tostring_fn = g_closure_ref(get_tostring_fn);
g_closure_sink(get_tostring_fn);
var->set_fromstring_fn = g_closure_ref(set_fromstring_fn);
g_closure_sink(set_fromstring_fn);
var->default_str = owl_variable_get_tostring(var);
/* Note: this'll overwrite any existing variable of that name, even a C one,
but it's consistent with previous behavior and commands. */
owl_variable_dict_add_variable(vd, var);
}
void owl_variable_get_help(owl_vardict *d, char *name, owl_fmtext *fm) {
char buff[1024];
int bufflen = 1023;
owl_variable *v;
if (!name
|| (v = owl_dict_find_element(d, name)) == NULL
|| !v->get_fn) {
owl_fmtext_append_normal(fm, "No such variable...\n");
return;
}
owl_fmtext_append_bold(fm, "OWL VARIABLE\n\n");
owl_fmtext_append_normal(fm, OWL_TABSTR);
owl_fmtext_append_normal(fm, name);
owl_fmtext_append_normal(fm, " - ");
owl_fmtext_append_normal(fm, v->summary);
owl_fmtext_append_normal(fm, "\n\n");
owl_fmtext_append_normal(fm, "Current: ");
owl_variable_get_tostring(d, name, buff, bufflen);
owl_fmtext_append_normal(fm, buff);
owl_fmtext_append_normal(fm, "\n\n");
if (v->type == OWL_VARIABLE_INT || v->type == OWL_VARIABLE_BOOL) {
v->get_tostring_fn(v, buff, bufflen, &(v->ival_default));
} else {
v->get_tostring_fn(v, buff, bufflen, v->pval_default);
}
owl_fmtext_append_normal(fm, "Default: ");
owl_fmtext_append_normal(fm, buff);
owl_fmtext_append_normal(fm, "\n\n");
owl_fmtext_append_normal(fm, "Valid Settings: ");
owl_fmtext_append_normal(fm, owl_variable_get_validsettings(v));
owl_fmtext_append_normal(fm, "\n\n");
if (v->description && *v->description) {
owl_fmtext_append_normal(fm, "Description:\n");
owl_fmtext_append_normal(fm, owl_variable_get_description(v));
owl_fmtext_append_normal(fm, "\n\n");
}
}
static void owl_variable_dict_newvar_enum_full(owl_vardict *vd, const char *name, int default_val, const char *summary, const char *description, const char *validsettings, validate_int_t validate_fn, set_int_t set_fn, get_int_t get_fn)
{
owl_variable *var = owl_variable_newvar(OWL_VARIABLE_INT, name, summary,
description, validsettings);
var->takes_on_off = false;
var->get_fn = G_CALLBACK(get_fn ? get_fn : owl_variable_int_get_default);
var->set_fn = G_CALLBACK(set_fn ? set_fn : owl_variable_int_set_default);
var->validate_fn = G_CALLBACK(validate_fn ? validate_fn : owl_variable_enum_validate);
var->get_tostring_fn = owl_variable_make_closure(
var, G_CALLBACK(owl_variable_enum_get_tostring),
g_cclosure_user_marshal_STRING__VOID);
var->set_fromstring_fn = owl_variable_make_closure(
var, G_CALLBACK(owl_variable_enum_set_fromstring),
g_cclosure_user_marshal_INT__STRING);
g_value_init(&var->val, G_TYPE_INT);
owl_variable_set_int(var, default_val);
var->default_str = owl_variable_get_tostring(var);
owl_variable_dict_add_variable(vd, var);
}
static void owl_variable_dict_newvar_bool_full(owl_vardict *vd, const char *name, bool default_val, const char *summary, const char *description, validate_bool_t validate_fn, set_bool_t set_fn, get_bool_t get_fn)
{
owl_variable *var = owl_variable_newvar(OWL_VARIABLE_BOOL, name, summary,
description, "on,off");
var->takes_on_off = true;
var->get_fn = G_CALLBACK(get_fn ? get_fn : owl_variable_bool_get_default);
var->set_fn = G_CALLBACK(set_fn ? set_fn : owl_variable_bool_set_default);
var->validate_fn = G_CALLBACK(validate_fn ? validate_fn : owl_variable_bool_validate_default);
var->get_tostring_fn = owl_variable_make_closure(
var, G_CALLBACK(owl_variable_bool_get_tostring_default),
g_cclosure_user_marshal_STRING__VOID);
var->set_fromstring_fn = owl_variable_make_closure(
var, G_CALLBACK(owl_variable_bool_set_fromstring_default),
g_cclosure_user_marshal_INT__STRING);
g_value_init(&var->val, G_TYPE_BOOLEAN);
owl_variable_set_bool(var, default_val);
var->default_str = owl_variable_get_tostring(var);
owl_variable_dict_add_variable(vd, var);
}
int owl_variable_regtest(void) {
owl_vardict vd;
int numfailed=0;
char buf[1024];
const void *v;
printf("# BEGIN testing owl_variable\n");
FAIL_UNLESS("setup", 0==owl_variable_dict_setup(&vd));
FAIL_UNLESS("get bool", 0==owl_variable_get_bool(&vd,"rxping"));
FAIL_UNLESS("get bool (no such)", -1==owl_variable_get_bool(&vd,"mumble"));
FAIL_UNLESS("get bool as string 1", 0==owl_variable_get_tostring(&vd,"rxping", buf, 1024));
FAIL_UNLESS("get bool as string 2", 0==strcmp(buf,"off"));
FAIL_UNLESS("set bool 1", 0==owl_variable_set_bool_on(&vd,"rxping"));
FAIL_UNLESS("get bool 2", 1==owl_variable_get_bool(&vd,"rxping"));
FAIL_UNLESS("set bool 3", 0==owl_variable_set_fromstring(&vd,"rxping","off",0,0));
FAIL_UNLESS("get bool 4", 0==owl_variable_get_bool(&vd,"rxping"));
FAIL_UNLESS("set bool 5", -1==owl_variable_set_fromstring(&vd,"rxping","xxx",0,0));
FAIL_UNLESS("get bool 6", 0==owl_variable_get_bool(&vd,"rxping"));
FAIL_UNLESS("get string", 0==strcmp("~/zlog/people", owl_variable_get_string(&vd,"logpath")));
FAIL_UNLESS("set string 7", 0==owl_variable_set_string(&vd,"logpath","whee"));
FAIL_UNLESS("get string", 0==strcmp("whee", owl_variable_get_string(&vd,"logpath")));
FAIL_UNLESS("get int", 8==owl_variable_get_int(&vd,"typewinsize"));
FAIL_UNLESS("get int (no such)", -1==owl_variable_get_int(&vd,"mmble"));
FAIL_UNLESS("get int as string 1", 0==owl_variable_get_tostring(&vd,"typewinsize", buf, 1024));
FAIL_UNLESS("get int as string 2", 0==strcmp(buf,"8"));
FAIL_UNLESS("set int 1", 0==owl_variable_set_int(&vd,"typewinsize",12));
FAIL_UNLESS("get int 2", 12==owl_variable_get_int(&vd,"typewinsize"));
FAIL_UNLESS("set int 1b", -1==owl_variable_set_int(&vd,"typewinsize",-3));
FAIL_UNLESS("get int 2b", 12==owl_variable_get_int(&vd,"typewinsize"));
FAIL_UNLESS("set int 3", 0==owl_variable_set_fromstring(&vd,"typewinsize","9",0,0));
FAIL_UNLESS("get int 4", 9==owl_variable_get_int(&vd,"typewinsize"));
FAIL_UNLESS("set int 5", -1==owl_variable_set_fromstring(&vd,"typewinsize","xxx",0,0));
FAIL_UNLESS("set int 6", -1==owl_variable_set_fromstring(&vd,"typewinsize","",0,0));
FAIL_UNLESS("get int 7", 9==owl_variable_get_int(&vd,"typewinsize"));
owl_variable_dict_newvar_string(&vd, "stringvar", "", "", "testval");
FAIL_UNLESS("get new string var", NULL != (v = owl_variable_get(&vd, "stringvar", OWL_VARIABLE_STRING)));
FAIL_UNLESS("get new string val", !strcmp("testval", owl_variable_get_string(&vd, "stringvar")));
owl_variable_set_string(&vd, "stringvar", "new val");
FAIL_UNLESS("update string val", !strcmp("new val", owl_variable_get_string(&vd, "stringvar")));
owl_variable_dict_newvar_int(&vd, "intvar", "", "", 47);
FAIL_UNLESS("get new int var", NULL != (v = owl_variable_get(&vd, "intvar", OWL_VARIABLE_INT)));
FAIL_UNLESS("get new int val", 47 == owl_variable_get_int(&vd, "intvar"));
owl_variable_set_int(&vd, "intvar", 17);
FAIL_UNLESS("update bool val", 17 == owl_variable_get_int(&vd, "intvar"));
owl_variable_dict_newvar_bool(&vd, "boolvar", "", "", 1);
FAIL_UNLESS("get new bool var", NULL != (v = owl_variable_get(&vd, "boolvar", OWL_VARIABLE_BOOL)));
FAIL_UNLESS("get new bool val", owl_variable_get_bool(&vd, "boolvar"));
owl_variable_set_bool_off(&vd, "boolvar");
FAIL_UNLESS("update string val", !owl_variable_get_bool(&vd, "boolvar"));
owl_variable_dict_cleanup(&vd);
/* if (numfailed) printf("*** WARNING: failures encountered with owl_variable\n"); */
printf("# END testing owl_variable (%d failures)\n", numfailed);
return(numfailed);
}
