From efeb2fcfcd9a86bf80558c86fc92dadc3fbf52b8 Mon Sep 17 00:00:00 2001 From: James Booth Date: Sun, 7 Aug 2016 00:16:57 +0100 Subject: [PATCH 1/3] Rename plugins settings functions --- src/plugins/api.c | 32 +++++++++++++-------------- src/plugins/api.h | 16 +++++++------- src/plugins/c_api.c | 48 ++++++++++++++++++++-------------------- src/plugins/profapi.c | 16 +++++++------- src/plugins/profapi.h | 16 +++++++------- src/plugins/python_api.c | 48 ++++++++++++++++++++-------------------- src/plugins/settings.c | 16 +++++++------- src/plugins/settings.h | 16 +++++++------- 8 files changed, 104 insertions(+), 104 deletions(-) diff --git a/src/plugins/api.c b/src/plugins/api.c index e89ce454..965eedde 100644 --- a/src/plugins/api.c +++ b/src/plugins/api.c @@ -399,33 +399,33 @@ api_send_stanza(const char *const stanza) } gboolean -api_settings_get_boolean(const char *const group, const char *const key, gboolean def) +api_settings_boolean_get(const char *const group, const char *const key, gboolean def) { - return plugin_settings_get_boolean(group, key, def); + return plugin_settings_boolean_get(group, key, def); } void -api_settings_set_boolean(const char *const group, const char *const key, gboolean value) +api_settings_boolean_set(const char *const group, const char *const key, gboolean value) { - plugin_settings_set_boolean(group, key, value); + plugin_settings_boolean_set(group, key, value); } char* -api_settings_get_string(const char *const group, const char *const key, const char *const def) +api_settings_string_get(const char *const group, const char *const key, const char *const def) { - return plugin_settings_get_string(group, key, def); + return plugin_settings_string_get(group, key, def); } void -api_settings_set_string(const char *const group, const char *const key, const char *const value) +api_settings_string_set(const char *const group, const char *const key, const char *const value) { - plugin_settings_set_string(group, key, value); + plugin_settings_string_set(group, key, value); } char** -api_settings_get_string_list(const char *const group, const char *const key) +api_settings_string_list_get(const char *const group, const char *const key) { - return plugin_settings_get_string_list(group, key); + return plugin_settings_string_list_get(group, key); } void @@ -441,21 +441,21 @@ api_settings_string_list_remove(const char *const group, const char *const key, } int -api_settings_string_list_remove_all(const char *const group, const char *const key) +api_settings_string_list_clear(const char *const group, const char *const key) { - return plugin_settings_string_list_remove_all(group, key); + return plugin_settings_string_list_clear(group, key); } int -api_settings_get_int(const char *const group, const char *const key, int def) +api_settings_int_get(const char *const group, const char *const key, int def) { - return plugin_settings_get_int(group, key, def); + return plugin_settings_int_get(group, key, def); } void -api_settings_set_int(const char *const group, const char *const key, int value) +api_settings_int_set(const char *const group, const char *const key, int value) { - plugin_settings_set_int(group, key, value); + plugin_settings_int_set(group, key, value); } void diff --git a/src/plugins/api.h b/src/plugins/api.h index 28dfee57..70ac02a2 100644 --- a/src/plugins/api.h +++ b/src/plugins/api.h @@ -78,16 +78,16 @@ int api_win_show_themed(const char *tag, const char *const group, const char *co int api_send_stanza(const char *const stanza); -gboolean api_settings_get_boolean(const char *const group, const char *const key, gboolean def); -void api_settings_set_boolean(const char *const group, const char *const key, gboolean value); -char* api_settings_get_string(const char *const group, const char *const key, const char *const def); -void api_settings_set_string(const char *const group, const char *const key, const char *const value); -int api_settings_get_int(const char *const group, const char *const key, int def); -void api_settings_set_int(const char *const group, const char *const key, int value); -char** api_settings_get_string_list(const char *const group, const char *const key); +gboolean api_settings_boolean_get(const char *const group, const char *const key, gboolean def); +void api_settings_boolean_set(const char *const group, const char *const key, gboolean value); +char* api_settings_string_get(const char *const group, const char *const key, const char *const def); +void api_settings_string_set(const char *const group, const char *const key, const char *const value); +int api_settings_int_get(const char *const group, const char *const key, int def); +void api_settings_int_set(const char *const group, const char *const key, int value); +char** api_settings_string_list_get(const char *const group, const char *const key); void api_settings_string_list_add(const char *const group, const char *const key, const char *const value); int api_settings_string_list_remove(const char *const group, const char *const key, const char *const value); -int api_settings_string_list_remove_all(const char *const group, const char *const key); +int api_settings_string_list_clear(const char *const group, const char *const key); void api_incoming_message(const char *const barejid, const char *const resource, const char *const message); diff --git a/src/plugins/c_api.c b/src/plugins/c_api.c index 9d5fdaad..89d84d34 100644 --- a/src/plugins/c_api.c +++ b/src/plugins/c_api.c @@ -251,33 +251,33 @@ c_api_send_stanza(char *stanza) } static int -c_api_settings_get_boolean(char *group, char *key, int def) +c_api_settings_boolean_get(char *group, char *key, int def) { - return api_settings_get_boolean(group, key, def); + return api_settings_boolean_get(group, key, def); } static void -c_api_settings_set_boolean(char *group, char *key, int value) +c_api_settings_boolean_set(char *group, char *key, int value) { - api_settings_set_boolean(group, key, value); + api_settings_boolean_set(group, key, value); } static char* -c_api_settings_get_string(char *group, char *key, char *def) +c_api_settings_string_get(char *group, char *key, char *def) { - return api_settings_get_string(group, key, def); + return api_settings_string_get(group, key, def); } static void -c_api_settings_set_string(char *group, char *key, char *value) +c_api_settings_string_set(char *group, char *key, char *value) { - api_settings_set_string(group, key, value); + api_settings_string_set(group, key, value); } static char** -c_api_settings_get_string_list(char *group, char *key) +c_api_settings_string_list_get(char *group, char *key) { - return api_settings_get_string_list(group, key); + return api_settings_string_list_get(group, key); } static void @@ -293,21 +293,21 @@ c_api_settings_string_list_remove(char *group, char *key, char *value) } static int -c_api_settings_string_list_remove_all(char *group, char *key) +c_api_settings_string_list_clear(char *group, char *key) { - return api_settings_string_list_remove_all(group, key); + return api_settings_string_list_clear(group, key); } static int -c_api_settings_get_int(char *group, char *key, int def) +c_api_settings_int_get(char *group, char *key, int def) { - return api_settings_get_int(group, key, def); + return api_settings_int_get(group, key, def); } static void -c_api_settings_set_int(char *group, char *key, int value) +c_api_settings_int_set(char *group, char *key, int value) { - api_settings_set_int(group, key, value); + api_settings_int_set(group, key, value); } static void @@ -375,16 +375,16 @@ c_api_init(void) prof_win_show = c_api_win_show; prof_win_show_themed = c_api_win_show_themed; prof_send_stanza = c_api_send_stanza; - prof_settings_get_boolean = c_api_settings_get_boolean; - prof_settings_set_boolean = c_api_settings_set_boolean; - prof_settings_get_string = c_api_settings_get_string; - prof_settings_set_string = c_api_settings_set_string; - prof_settings_get_int = c_api_settings_get_int; - prof_settings_set_int = c_api_settings_set_int; - prof_settings_get_string_list = c_api_settings_get_string_list; + prof_settings_boolean_get = c_api_settings_boolean_get; + prof_settings_boolean_set = c_api_settings_boolean_set; + prof_settings_string_get = c_api_settings_string_get; + prof_settings_string_set = c_api_settings_string_set; + prof_settings_int_get = c_api_settings_int_get; + prof_settings_int_set = c_api_settings_int_set; + prof_settings_string_list_get = c_api_settings_string_list_get; prof_settings_string_list_add = c_api_settings_string_list_add; prof_settings_string_list_remove = c_api_settings_string_list_remove; - prof_settings_string_list_remove_all = c_api_settings_string_list_remove_all; + prof_settings_string_list_clear = c_api_settings_string_list_clear; prof_incoming_message = c_api_incoming_message; prof_disco_add_feature = c_api_disco_add_feature; } diff --git a/src/plugins/profapi.c b/src/plugins/profapi.c index c1fe60c9..bb08623b 100644 --- a/src/plugins/profapi.c +++ b/src/plugins/profapi.c @@ -75,16 +75,16 @@ int (*prof_win_show_themed)(PROF_WIN_TAG tag, char *group, char *key, char *def, int (*prof_send_stanza)(char *stanza) = NULL; -int (*prof_settings_get_boolean)(char *group, char *key, int def) = NULL; -void (*prof_settings_set_boolean)(char *group, char *key, int value) = NULL; -char* (*prof_settings_get_string)(char *group, char *key, char *def) = NULL; -void (*prof_settings_set_string)(char *group, char *key, char *value) = NULL; -int (*prof_settings_get_int)(char *group, char *key, int def) = NULL; -void (*prof_settings_set_int)(char *group, char *key, int value) = NULL; -char** (*prof_settings_get_string_list)(char *group, char *key) = NULL; +int (*prof_settings_boolean_get)(char *group, char *key, int def) = NULL; +void (*prof_settings_boolean_set)(char *group, char *key, int value) = NULL; +char* (*prof_settings_string_get)(char *group, char *key, char *def) = NULL; +void (*prof_settings_string_set)(char *group, char *key, char *value) = NULL; +int (*prof_settings_int_get)(char *group, char *key, int def) = NULL; +void (*prof_settings_int_set)(char *group, char *key, int value) = NULL; +char** (*prof_settings_string_list_get)(char *group, char *key) = NULL; void (*prof_settings_string_list_add)(char *group, char *key, char *value) = NULL; int (*prof_settings_string_list_remove)(char *group, char *key, char *value) = NULL; -int (*prof_settings_string_list_remove_all)(char *group, char *key) = NULL; +int (*prof_settings_string_list_clear)(char *group, char *key) = NULL; void (*prof_incoming_message)(char *barejid, char *resource, char *message) = NULL; diff --git a/src/plugins/profapi.h b/src/plugins/profapi.h index 6a9a2edd..0ab5520d 100644 --- a/src/plugins/profapi.h +++ b/src/plugins/profapi.h @@ -85,16 +85,16 @@ int (*prof_win_show_themed)(PROF_WIN_TAG tag, char *group, char *key, char *def, int (*prof_send_stanza)(char *stanza); -int (*prof_settings_get_boolean)(char *group, char *key, int def); -void (*prof_settings_set_boolean)(char *group, char *key, int value); -char* (*prof_settings_get_string)(char *group, char *key, char *def); -void (*prof_settings_set_string)(char *group, char *key, char *value); -int (*prof_settings_get_int)(char *group, char *key, int def); -void (*prof_settings_set_int)(char *group, char *key, int value); -char** (*prof_settings_get_string_list)(char *group, char *key); +int (*prof_settings_boolean_get)(char *group, char *key, int def); +void (*prof_settings_boolean_set)(char *group, char *key, int value); +char* (*prof_settings_string_get)(char *group, char *key, char *def); +void (*prof_settings_string_set)(char *group, char *key, char *value); +int (*prof_settings_int_get)(char *group, char *key, int def); +void (*prof_settings_int_set)(char *group, char *key, int value); +char** (*prof_settings_string_list_get)(char *group, char *key); void (*prof_settings_string_list_add)(char *group, char *key, char *value); int (*prof_settings_string_list_remove)(char *group, char *key, char *value); -int (*prof_settings_string_list_remove_all)(char *group, char *key); +int (*prof_settings_string_list_clear)(char *group, char *key); void (*prof_incoming_message)(char *barejid, char *resource, char *message); diff --git a/src/plugins/python_api.c b/src/plugins/python_api.c index 27314d83..b58237a9 100644 --- a/src/plugins/python_api.c +++ b/src/plugins/python_api.c @@ -666,7 +666,7 @@ python_api_send_stanza(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_get_boolean(PyObject *self, PyObject *args) +python_api_settings_boolean_get(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -681,7 +681,7 @@ python_api_settings_get_boolean(PyObject *self, PyObject *args) int def = PyObject_IsTrue(defobj); allow_python_threads(); - int res = api_settings_get_boolean(group_str, key_str, def); + int res = api_settings_boolean_get(group_str, key_str, def); free(group_str); free(key_str); disable_python_threads(); @@ -694,7 +694,7 @@ python_api_settings_get_boolean(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_set_boolean(PyObject *self, PyObject *args) +python_api_settings_boolean_set(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -709,7 +709,7 @@ python_api_settings_set_boolean(PyObject *self, PyObject *args) int val = PyObject_IsTrue(valobj); allow_python_threads(); - api_settings_set_boolean(group_str, key_str, val); + api_settings_boolean_set(group_str, key_str, val); free(group_str); free(key_str); disable_python_threads(); @@ -718,7 +718,7 @@ python_api_settings_set_boolean(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_get_string(PyObject *self, PyObject *args) +python_api_settings_string_get(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -733,7 +733,7 @@ python_api_settings_get_string(PyObject *self, PyObject *args) char *def_str = python_str_or_unicode_to_string(def); allow_python_threads(); - char *res = api_settings_get_string(group_str, key_str, def_str); + char *res = api_settings_string_get(group_str, key_str, def_str); free(group_str); free(key_str); free(def_str); @@ -749,7 +749,7 @@ python_api_settings_get_string(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_set_string(PyObject *self, PyObject *args) +python_api_settings_string_set(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -764,7 +764,7 @@ python_api_settings_set_string(PyObject *self, PyObject *args) char *val_str = python_str_or_unicode_to_string(val); allow_python_threads(); - api_settings_set_string(group_str, key_str, val_str); + api_settings_string_set(group_str, key_str, val_str); free(group_str); free(key_str); free(val_str); @@ -774,7 +774,7 @@ python_api_settings_set_string(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_get_int(PyObject *self, PyObject *args) +python_api_settings_int_get(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -788,7 +788,7 @@ python_api_settings_get_int(PyObject *self, PyObject *args) char *key_str = python_str_or_unicode_to_string(key); allow_python_threads(); - int res = api_settings_get_int(group_str, key_str, def); + int res = api_settings_int_get(group_str, key_str, def); free(group_str); free(key_str); disable_python_threads(); @@ -797,7 +797,7 @@ python_api_settings_get_int(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_set_int(PyObject *self, PyObject *args) +python_api_settings_int_set(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -811,7 +811,7 @@ python_api_settings_set_int(PyObject *self, PyObject *args) char *key_str = python_str_or_unicode_to_string(key); allow_python_threads(); - api_settings_set_int(group_str, key_str, val); + api_settings_int_set(group_str, key_str, val); free(group_str); free(key_str); disable_python_threads(); @@ -820,7 +820,7 @@ python_api_settings_set_int(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_get_string_list(PyObject *self, PyObject *args) +python_api_settings_string_list_get(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -833,7 +833,7 @@ python_api_settings_get_string_list(PyObject *self, PyObject *args) char *key_str = python_str_or_unicode_to_string(key); allow_python_threads(); - char** c_list = api_settings_get_string_list(group_str, key_str); + char** c_list = api_settings_string_list_get(group_str, key_str); free(group_str); free(key_str); disable_python_threads(); @@ -915,7 +915,7 @@ python_api_settings_string_list_remove(PyObject *self, PyObject *args) } static PyObject* -python_api_settings_string_list_remove_all(PyObject *self, PyObject *args) +python_api_settings_string_list_clear(PyObject *self, PyObject *args) { PyObject *group = NULL; PyObject *key = NULL; @@ -928,7 +928,7 @@ python_api_settings_string_list_remove_all(PyObject *self, PyObject *args) char *key_str = python_str_or_unicode_to_string(key); allow_python_threads(); - int res = api_settings_string_list_remove_all(group_str, key_str); + int res = api_settings_string_list_clear(group_str, key_str); free(group_str); free(key_str); disable_python_threads(); @@ -1077,16 +1077,16 @@ static PyMethodDef apiMethods[] = { { "win_show", python_api_win_show, METH_VARARGS, "Show text in the window." }, { "win_show_themed", python_api_win_show_themed, METH_VARARGS, "Show themed text in the window." }, { "send_stanza", python_api_send_stanza, METH_VARARGS, "Send an XMPP stanza." }, - { "settings_get_boolean", python_api_settings_get_boolean, METH_VARARGS, "Get a boolean setting." }, - { "settings_set_boolean", python_api_settings_set_boolean, METH_VARARGS, "Set a boolean setting." }, - { "settings_get_string", python_api_settings_get_string, METH_VARARGS, "Get a string setting." }, - { "settings_set_string", python_api_settings_set_string, METH_VARARGS, "Set a string setting." }, - { "settings_get_int", python_api_settings_get_int, METH_VARARGS, "Get a integer setting." }, - { "settings_set_int", python_api_settings_set_int, METH_VARARGS, "Set a integer setting." }, - { "settings_get_string_list", python_api_settings_get_string_list, METH_VARARGS, "Get a string list setting." }, + { "settings_boolean_get", python_api_settings_boolean_get, METH_VARARGS, "Get a boolean setting." }, + { "settings_boolean_set", python_api_settings_boolean_set, METH_VARARGS, "Set a boolean setting." }, + { "settings_string_get", python_api_settings_string_get, METH_VARARGS, "Get a string setting." }, + { "settings_string_set", python_api_settings_string_set, METH_VARARGS, "Set a string setting." }, + { "settings_int_get", python_api_settings_int_get, METH_VARARGS, "Get a integer setting." }, + { "settings_int_set", python_api_settings_int_set, METH_VARARGS, "Set a integer setting." }, + { "settings_string_list_get", python_api_settings_string_list_get, METH_VARARGS, "Get a string list setting." }, { "settings_string_list_add", python_api_settings_string_list_add, METH_VARARGS, "Add item to string list setting." }, { "settings_string_list_remove", python_api_settings_string_list_remove, METH_VARARGS, "Remove item from string list setting." }, - { "settings_string_list_remove_all", python_api_settings_string_list_remove_all, METH_VARARGS, "Remove all items from string list setting." }, + { "settings_string_list_clear", python_api_settings_string_list_clear, METH_VARARGS, "Remove all items from string list setting." }, { "incoming_message", python_api_incoming_message, METH_VARARGS, "Show an incoming message." }, { "disco_add_feature", python_api_disco_add_feature, METH_VARARGS, "Add a feature to disco info response." }, { NULL, NULL, 0, NULL } diff --git a/src/plugins/settings.c b/src/plugins/settings.c index 77d3fb4b..0ca2283b 100644 --- a/src/plugins/settings.c +++ b/src/plugins/settings.c @@ -75,7 +75,7 @@ plugin_settings_close(void) } gboolean -plugin_settings_get_boolean(const char *const group, const char *const key, gboolean def) +plugin_settings_boolean_get(const char *const group, const char *const key, gboolean def) { if (group && key && g_key_file_has_key(settings, group, key, NULL)) { return g_key_file_get_boolean(settings, group, key, NULL); @@ -85,14 +85,14 @@ plugin_settings_get_boolean(const char *const group, const char *const key, gboo } void -plugin_settings_set_boolean(const char *const group, const char *const key, gboolean value) +plugin_settings_boolean_set(const char *const group, const char *const key, gboolean value) { g_key_file_set_boolean(settings, group, key, value); _save_settings(); } char* -plugin_settings_get_string(const char *const group, const char *const key, const char *const def) +plugin_settings_string_get(const char *const group, const char *const key, const char *const def) { if (group && key && g_key_file_has_key(settings, group, key, NULL)) { return g_key_file_get_string(settings, group, key, NULL); @@ -104,14 +104,14 @@ plugin_settings_get_string(const char *const group, const char *const key, const } void -plugin_settings_set_string(const char *const group, const char *const key, const char *const value) +plugin_settings_string_set(const char *const group, const char *const key, const char *const value) { g_key_file_set_string(settings, group, key, value); _save_settings(); } int -plugin_settings_get_int(const char *const group, const char *const key, int def) +plugin_settings_int_get(const char *const group, const char *const key, int def) { if (group && key && g_key_file_has_key(settings, group, key, NULL)) { return g_key_file_get_integer(settings, group, key, NULL); @@ -121,14 +121,14 @@ plugin_settings_get_int(const char *const group, const char *const key, int def) } void -plugin_settings_set_int(const char *const group, const char *const key, int value) +plugin_settings_int_set(const char *const group, const char *const key, int value) { g_key_file_set_integer(settings, group, key, value); _save_settings(); } gchar** -plugin_settings_get_string_list(const char *const group, const char *const key) +plugin_settings_string_list_get(const char *const group, const char *const key) { if (!g_key_file_has_key(settings, group, key, NULL)) { return NULL; @@ -156,7 +156,7 @@ plugin_settings_string_list_remove(const char *const group, const char *const ke } int -plugin_settings_string_list_remove_all(const char *const group, const char *const key) +plugin_settings_string_list_clear(const char *const group, const char *const key) { if (!g_key_file_has_key(settings, group, key, NULL)) { return 0; diff --git a/src/plugins/settings.h b/src/plugins/settings.h index f3a5bf6d..e05ee7ac 100644 --- a/src/plugins/settings.h +++ b/src/plugins/settings.h @@ -38,15 +38,15 @@ void plugin_settings_init(void); void plugin_settings_close(void); -gboolean plugin_settings_get_boolean(const char *const group, const char *const key, gboolean def); -void plugin_settings_set_boolean(const char *const group, const char *const key, gboolean value); -char* plugin_settings_get_string(const char *const group, const char *const key, const char *const def); -void plugin_settings_set_string(const char *const group, const char *const key, const char *const value); -int plugin_settings_get_int(const char *const group, const char *const key, int def); -void plugin_settings_set_int(const char *const group, const char *const key, int value); -char** plugin_settings_get_string_list(const char *const group, const char *const key); +gboolean plugin_settings_boolean_get(const char *const group, const char *const key, gboolean def); +void plugin_settings_boolean_set(const char *const group, const char *const key, gboolean value); +char* plugin_settings_string_get(const char *const group, const char *const key, const char *const def); +void plugin_settings_string_set(const char *const group, const char *const key, const char *const value); +int plugin_settings_int_get(const char *const group, const char *const key, int def); +void plugin_settings_int_set(const char *const group, const char *const key, int value); +char** plugin_settings_string_list_get(const char *const group, const char *const key); void plugin_settings_string_list_add(const char *const group, const char *const key, const char *const value); int plugin_settings_string_list_remove(const char *const group, const char *const key, const char *const value); -int plugin_settings_string_list_remove_all(const char *const group, const char *const key); +int plugin_settings_string_list_clear(const char *const group, const char *const key); #endif From 4f7af4e429612167c8c4242a2096e001a43a2318 Mon Sep 17 00:00:00 2001 From: James Booth Date: Sun, 7 Aug 2016 00:22:21 +0100 Subject: [PATCH 2/3] Update plugin API docs --- apidocs/c/profapi.h | 16 ++++++++-------- apidocs/python/src/prof.py | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h index c6b293e7..6e625f2c 100644 --- a/apidocs/c/profapi.h +++ b/apidocs/c/profapi.h @@ -217,7 +217,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param def default value if setting not found @return the setting, or default value */ -int prof_settings_get_boolean(char *group, char *key, int def); +int prof_settings_boolean_get(char *group, char *key, int def); /** Set a boolean setting @@ -226,7 +226,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param key the item name within the group @param value value to set */ -void prof_settings_set_boolean(char *group, char *key, int value); +void prof_settings_boolean_set(char *group, char *key, int value); /** Get a string setting @@ -236,7 +236,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param def default value if setting not found @return the setting, or default value */ -char* prof_settings_get_string(char *group, char *key, char *def); +char* prof_settings_string_get(char *group, char *key, char *def); /** Set a string setting @@ -245,7 +245,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param key the item name within the group @param value value to set */ -void prof_settings_set_string(char *group, char *key, char *value); +void prof_settings_string_set(char *group, char *key, char *value); /** Get a string list setting @@ -255,7 +255,7 @@ The string list setting items are separated by semicolons. @param key the item name within the group @return the list setting */ -char** prof_settings_get_string_list(char *group, char *key); +char** prof_settings_string_list_get(char *group, char *key); /** Add an item to a string list setting @@ -284,7 +284,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param key the item name within the group @return 1 if the list was cleared, 0 if the list does not exist */ -int prof_settings_string_list_remove_all(char *group, char *key); +int prof_settings_string_list_clear(char *group, char *key); /** Get an integer setting @@ -294,7 +294,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param def default value if setting not found @return the setting, or default value */ -int prof_settings_get_int(char *group, char *key, int def); +int prof_settings_int_get(char *group, char *key, int def); /** Set an integer setting @@ -303,7 +303,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings @param key the item name within the group @param value value to set */ -void prof_settings_set_int(char *group, char *key, int value); +void prof_settings_int_set(char *group, char *key, int value); /** Trigger incoming message handling, this plugin will make profanity act as if the message has been received diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index d25a5943..e91e8852 100644 --- a/apidocs/python/src/prof.py +++ b/apidocs/python/src/prof.py @@ -388,7 +388,7 @@ def send_stanza(stanza): pass -def settings_get_boolean(group, key, default): +def settings_boolean_get(group, key, default): """Get a boolean setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` @@ -406,7 +406,7 @@ def settings_get_boolean(group, key, default): pass -def settings_set_boolean(group, key, value): +def settings_boolean_set(group, key, value): """Set a boolean setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` @@ -424,7 +424,7 @@ def settings_set_boolean(group, key, value): pass -def settings_get_string(group, key, default): +def settings_string_get(group, key, default): """Get a string setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` @@ -442,7 +442,7 @@ def settings_get_string(group, key, default): pass -def settings_set_string(group, key, value): +def settings_string_set(group, key, value): """Set a string setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` @@ -460,7 +460,7 @@ def settings_set_string(group, key, value): pass -def settings_get_string_list(group, key): +def settings_string_list_get(group, key): """Get a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n The string list setting items are separated by semicolons. @@ -515,7 +515,7 @@ def settings_string_list_remove(group, key, value): """ -def settings_string_list_remove_all(group, key): +def settings_string_list_clear(group, key): """Remove all items from a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n @@ -532,7 +532,7 @@ def settings_string_list_remove_all(group, key): """ -def settings_get_int(group, key, default): +def settings_int_get(group, key, default): """Get an integer setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` @@ -550,7 +550,7 @@ def settings_get_int(group, key, default): pass -def settings_set_int(group, key, value): +def settings_int_set(group, key, value): """Set an integer setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` From b64a9c3d6d99eabdcb3005b009cf034c348bbb03 Mon Sep 17 00:00:00 2001 From: James Booth Date: Mon, 8 Aug 2016 22:01:04 +0100 Subject: [PATCH 3/3] Fix type in python API docs --- apidocs/python/src/prof.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py index e91e8852..789e1f3e 100644 --- a/apidocs/python/src/prof.py +++ b/apidocs/python/src/prof.py @@ -110,7 +110,7 @@ def register_command(name, min_args, max_args, synopsis, description, arguments, def register_timed(callback, interval): """Register a function that Profanity will call periodically. - :param callback: the funciton to call + :param callback: the function to call :param interval: the time between each call to the function, in seconds :type callback: function :type interval: int @@ -594,4 +594,4 @@ def disco_add_feature(feature): :: prof.disco_add_feature("urn:xmpp:omemo:0:devicelist+notify") """ - pass \ No newline at end of file + pass