libpurple/pluginpref.c

   1 /**
   2  * purple
   3  *
   4  * Purple is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22 #ifdef HAVE_CONFIG_H
  23 # include <config.h>
  24 #endif
  25
  26 #include <glib.h>
  27
  28 #include "debug.h"
  29 #include "internal.h"
  30 #include "pluginpref.h"
  31 #include "prefs.h"
  32
  33 struct _PurplePluginPrefFrame
  34 {
  35         GList *prefs;
  36 };
  37
  38 struct _PurplePluginPref
  39 {
  40         char *name;
  41         char *label;
  42
  43         PurplePluginPrefType type;
  44
  45         int min;
  46         int max;
  47         GList *choices;
  48         unsigned int max_length;
  49         gboolean masked;
  50         PurpleStringFormatType format;
  51 };
  52
  53 PurplePluginPrefFrame *
  54 purple_plugin_pref_frame_new()
  55 {
  56         PurplePluginPrefFrame *frame;
  57
  58         frame = g_new0(PurplePluginPrefFrame, 1);
  59
  60         return frame;
  61 }
  62
  63 void
  64 purple_plugin_pref_frame_destroy(PurplePluginPrefFrame *frame)
  65 {
  66         g_return_if_fail(frame != NULL);
  67
  68         g_list_foreach(frame->prefs, (GFunc)purple_plugin_pref_destroy, NULL);
  69         g_list_free(frame->prefs);
  70         g_free(frame);
  71 }
  72
  73 void
  74 purple_plugin_pref_frame_add(PurplePluginPrefFrame *frame, PurplePluginPref *pref)
  75 {
  76         g_return_if_fail(frame != NULL);
  77         g_return_if_fail(pref  != NULL);
  78
  79         frame->prefs = g_list_append(frame->prefs, pref);
  80 }
  81
  82 GList *
  83 purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame)
  84 {
  85         g_return_val_if_fail(frame        != NULL, NULL);
  86         g_return_val_if_fail(frame->prefs != NULL, NULL);
  87
  88         return frame->prefs;
  89 }
  90
  91 PurplePluginPref *
  92 purple_plugin_pref_new()
  93 {
  94         PurplePluginPref *pref;
  95
  96         pref = g_new0(PurplePluginPref, 1);
  97
  98         return pref;
  99 }
 100
 101 PurplePluginPref *
 102 purple_plugin_pref_new_with_name(const char *name)
 103 {
 104         PurplePluginPref *pref;
 105
 106         g_return_val_if_fail(name != NULL, NULL);
 107
 108         pref = g_new0(PurplePluginPref, 1);
 109         pref->name = g_strdup(name);
 110
 111         return pref;
 112 }
 113
 114 PurplePluginPref *
 115 purple_plugin_pref_new_with_label(const char *label)
 116 {
 117         PurplePluginPref *pref;
 118
 119         g_return_val_if_fail(label != NULL, NULL);
 120
 121         pref = g_new0(PurplePluginPref, 1);
 122         pref->label = g_strdup(label);
 123
 124         return pref;
 125 }
 126
 127 PurplePluginPref *
 128 purple_plugin_pref_new_with_name_and_label(const char *name, const char *label)
 129 {
 130         PurplePluginPref *pref;
 131
 132         g_return_val_if_fail(name  != NULL, NULL);
 133         g_return_val_if_fail(label != NULL, NULL);
 134
 135         pref = g_new0(PurplePluginPref, 1);
 136         pref->name = g_strdup(name);
 137         pref->label = g_strdup(label);
 138
 139         return pref;
 140 }
 141
 142 void
 143 purple_plugin_pref_destroy(PurplePluginPref *pref)
 144 {
 145         GList *tmp;
 146         g_return_if_fail(pref != NULL);
 147
 148         g_free(pref->name);
 149         g_free(pref->label);
 150         tmp = pref->choices;
 151         while(tmp) {
 152                 g_free(tmp->data);
 153                 /* Remove the string, and the data entries */
 154                 tmp = g_list_delete_link(tmp, tmp);
 155                 tmp = g_list_delete_link(tmp, tmp);
 156         }
 157         g_free(pref);
 158 }
 159
 160 void
 161 purple_plugin_pref_set_name(PurplePluginPref *pref, const char *name)
 162 {
 163         g_return_if_fail(pref != NULL);
 164         g_return_if_fail(name != NULL);
 165
 166         g_free(pref->name);
 167         pref->name = g_strdup(name);
 168 }
 169
 170 const char *
 171 purple_plugin_pref_get_name(PurplePluginPref *pref)
 172 {
 173         g_return_val_if_fail(pref != NULL, NULL);
 174
 175         return pref->name;
 176 }
 177
 178 void
 179 purple_plugin_pref_set_label(PurplePluginPref *pref, const char *label)
 180 {
 181         g_return_if_fail(pref  != NULL);
 182         g_return_if_fail(label != NULL);
 183
 184         g_free(pref->label);
 185         pref->label = g_strdup(label);
 186 }
 187
 188 const char *
 189 purple_plugin_pref_get_label(PurplePluginPref *pref)
 190 {
 191         g_return_val_if_fail(pref != NULL, NULL);
 192
 193         return pref->label;
 194 }
 195
 196 void
 197 purple_plugin_pref_set_bounds(PurplePluginPref *pref, int min, int max)
 198 {
 199         int tmp;
 200
 201         g_return_if_fail(pref       != NULL);
 202         g_return_if_fail(pref->name != NULL);
 203
 204         if (purple_prefs_get_pref_type(pref->name) != PURPLE_PREF_INT)
 205         {
 206                 purple_debug_warning("pluginpref",
 207                                 "purple_plugin_pref_set_bounds: %s is not an integer pref\n",
 208                                 pref->name);
 209                 return;
 210         }
 211
 212         if (min > max)
 213         {
 214                 tmp = min;
 215                 min = max;
 216                 max = tmp;
 217         }
 218
 219         pref->min = min;
 220         pref->max = max;
 221 }
 222
 223 void purple_plugin_pref_get_bounds(PurplePluginPref *pref, int *min, int *max)
 224 {
 225         g_return_if_fail(pref       != NULL);
 226         g_return_if_fail(pref->name != NULL);
 227
 228         if (purple_prefs_get_pref_type(pref->name) != PURPLE_PREF_INT)
 229         {
 230                 purple_debug_warning("pluginpref",
 231                                 "purple_plugin_pref_get_bounds: %s is not an integer pref\n",
 232                                 pref->name);
 233                 return;
 234         }
 235
 236         *min = pref->min;
 237         *max = pref->max;
 238 }
 239
 240 void
 241 purple_plugin_pref_set_pref_type(PurplePluginPref *pref, PurplePluginPrefType type)
 242 {
 243         g_return_if_fail(pref != NULL);
 244
 245         pref->type = type;
 246 }
 247
 248 PurplePluginPrefType
 249 purple_plugin_pref_get_pref_type(PurplePluginPref *pref)
 250 {
 251         g_return_val_if_fail(pref != NULL, PURPLE_PLUGIN_PREF_NONE);
 252
 253         return pref->type;
 254 }
 255
 256 void
 257 purple_plugin_pref_add_choice(PurplePluginPref *pref, const char *label, gpointer choice)
 258 {
 259         g_return_if_fail(pref  != NULL);
 260         g_return_if_fail(label != NULL);
 261         g_return_if_fail(choice || purple_prefs_get_pref_type(pref->name) == PURPLE_PREF_INT);
 262
 263         pref->choices = g_list_append(pref->choices, g_strdup(label));
 264         pref->choices = g_list_append(pref->choices, choice);
 265 }
 266
 267 GList *
 268 purple_plugin_pref_get_choices(PurplePluginPref *pref)
 269 {
 270         g_return_val_if_fail(pref != NULL, NULL);
 271
 272         return pref->choices;
 273 }
 274
 275 void
 276 purple_plugin_pref_set_max_length(PurplePluginPref *pref, unsigned int max_length)
 277 {
 278         g_return_if_fail(pref != NULL);
 279
 280         pref->max_length = max_length;
 281 }
 282
 283 unsigned int
 284 purple_plugin_pref_get_max_length(PurplePluginPref *pref)
 285 {
 286         g_return_val_if_fail(pref != NULL, 0);
 287
 288         return pref->max_length;
 289 }
 290
 291 void
 292 purple_plugin_pref_set_masked(PurplePluginPref *pref, gboolean masked)
 293 {
 294         g_return_if_fail(pref != NULL);
 295
 296         pref->masked = masked;
 297 }
 298
 299 gboolean
 300 purple_plugin_pref_get_masked(PurplePluginPref *pref)
 301 {
 302         g_return_val_if_fail(pref != NULL, FALSE);
 303
 304         return pref->masked;
 305 }
 306
 307 void
 308 purple_plugin_pref_set_format_type(PurplePluginPref *pref, PurpleStringFormatType format)
 309 {
 310         g_return_if_fail(pref != NULL);
 311         g_return_if_fail(pref->type == PURPLE_PLUGIN_PREF_STRING_FORMAT);
 312
 313         pref->format = format;
 314 }
 315
 316 PurpleStringFormatType
 317 purple_plugin_pref_get_format_type(PurplePluginPref *pref)
 318 {
 319         g_return_val_if_fail(pref != NULL, 0);
 320
 321         if (pref->type != PURPLE_PLUGIN_PREF_STRING_FORMAT)
 322                 return PURPLE_STRING_FORMAT_TYPE_NONE;
 323
 324         return pref->format;
 325 }
 326