libpurple/theme.c

   1 /*
   2  * Themes for libpurple
   3  *
   4  * Pidgin 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
  23 #include <glib.h>
  24 #include <string.h>
  25
  26 #include "internal.h"
  27 #include "theme.h"
  28 #include "util.h"
  29
  30 #define PURPLE_THEME_GET_PRIVATE(PurpleTheme) \
  31         ((PurpleThemePrivate *) ((PurpleTheme)->priv))
  32
  33 void purple_theme_set_type_string(PurpleTheme *theme, const gchar *type);
  34
  35 /******************************************************************************
  36  * Structs
  37  *****************************************************************************/
  38
  39 typedef struct {
  40         gchar *name;
  41         gchar *description;
  42         gchar *author;
  43         gchar *type;
  44         gchar *dir;
  45         gchar *img;
  46 } PurpleThemePrivate;
  47
  48 /******************************************************************************
  49  * Globals
  50  *****************************************************************************/
  51
  52 static GObjectClass *parent_class = NULL;
  53
  54 /******************************************************************************
  55  * Enums
  56  *****************************************************************************/
  57
  58 enum {
  59         PROP_ZERO = 0,
  60         PROP_NAME,
  61         PROP_DESCRIPTION,
  62         PROP_AUTHOR,
  63         PROP_TYPE,
  64         PROP_DIR,
  65         PROP_IMAGE
  66 };
  67
  68 /******************************************************************************
  69  * GObject Stuff
  70  *****************************************************************************/
  71
  72 static void
  73 purple_theme_get_property(GObject *obj, guint param_id, GValue *value,
  74                 GParamSpec *psec)
  75 {
  76         PurpleTheme *theme = PURPLE_THEME(obj);
  77
  78         switch (param_id) {
  79                 case PROP_NAME:
  80                         g_value_set_string(value, purple_theme_get_name(theme));
  81                         break;
  82                 case PROP_DESCRIPTION:
  83                         g_value_set_string(value, purple_theme_get_description(theme));
  84                         break;
  85                 case PROP_AUTHOR:
  86                         g_value_set_string(value, purple_theme_get_author(theme));
  87                         break;
  88                 case PROP_TYPE:
  89                         g_value_set_string(value, purple_theme_get_type_string(theme));
  90                         break;
  91                 case PROP_DIR:
  92                         g_value_set_string(value, purple_theme_get_dir(theme));
  93                         break;
  94                 case PROP_IMAGE:
  95                         g_value_set_string(value, purple_theme_get_image(theme));
  96                         break;
  97                 default:
  98                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, psec);
  99                         break;
 100         }
 101 }
 102
 103 static void
 104 purple_theme_set_property(GObject *obj, guint param_id, const GValue *value,
 105                 GParamSpec *psec)
 106 {
 107         PurpleTheme *theme = PURPLE_THEME(obj);
 108
 109         switch (param_id) {
 110                 case PROP_NAME:
 111                         purple_theme_set_name(theme, g_value_get_string(value));
 112                         break;
 113                 case PROP_DESCRIPTION:
 114                         purple_theme_set_description(theme, g_value_get_string(value));
 115                         break;
 116                 case PROP_AUTHOR:
 117                         purple_theme_set_author(theme, g_value_get_string(value));
 118                         break;
 119                 case PROP_TYPE:
 120                         purple_theme_set_type_string(theme, g_value_get_string(value));
 121                         break;
 122                 case PROP_DIR:
 123                         purple_theme_set_dir(theme, g_value_get_string(value));
 124                         break;
 125                 case PROP_IMAGE:
 126                         purple_theme_set_image(theme, g_value_get_string(value));
 127                         break;
 128                 default:
 129                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, psec);
 130                         break;
 131         }
 132 }
 133
 134 static void
 135 purple_theme_init(GTypeInstance *instance,
 136                 gpointer klass)
 137 {
 138         PurpleTheme *theme = PURPLE_THEME(instance);
 139         theme->priv = g_new0(PurpleThemePrivate, 1);
 140 }
 141
 142 static void
 143 purple_theme_finalize(GObject *obj)
 144 {
 145         PurpleTheme *theme = PURPLE_THEME(obj);
 146         PurpleThemePrivate *priv = PURPLE_THEME_GET_PRIVATE(theme);
 147
 148         g_free(priv->name);
 149         g_free(priv->description);
 150         g_free(priv->author);
 151         g_free(priv->type);
 152         g_free(priv->dir);
 153         g_free(priv->img);
 154
 155         G_OBJECT_CLASS (parent_class)->finalize (obj);
 156 }
 157
 158 static void
 159 purple_theme_class_init(PurpleThemeClass *klass)
 160 {
 161         GObjectClass *obj_class = G_OBJECT_CLASS(klass);
 162         GParamSpec *pspec;
 163
 164         parent_class = g_type_class_peek_parent(klass);
 165
 166         obj_class->get_property = purple_theme_get_property;
 167         obj_class->set_property = purple_theme_set_property;
 168         obj_class->finalize = purple_theme_finalize;
 169
 170         /* NAME */
 171         pspec = g_param_spec_string("name", "Name",
 172                         "The name of the theme",
 173                         NULL,
 174                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
 175         g_object_class_install_property(obj_class, PROP_NAME, pspec);
 176
 177         /* DESCRIPTION */
 178         pspec = g_param_spec_string("description", "Description",
 179                         "The description of the theme",
 180                         NULL,
 181                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
 182         g_object_class_install_property(obj_class, PROP_DESCRIPTION, pspec);
 183
 184         /* AUTHOR */
 185         pspec = g_param_spec_string("author", "Author",
 186                         "The author of the theme",
 187                         NULL,
 188                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
 189         g_object_class_install_property(obj_class, PROP_AUTHOR, pspec);
 190
 191         /* TYPE STRING (read only) */
 192         pspec = g_param_spec_string("type", "Type",
 193                         "The string representing the type of the theme",
 194                         NULL,
 195                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
 196         g_object_class_install_property(obj_class, PROP_TYPE, pspec);
 197
 198         /* DIRECTORY */
 199         pspec = g_param_spec_string("directory", "Directory",
 200                         "The directory that contains the theme and all its files",
 201                         NULL,
 202                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
 203         g_object_class_install_property(obj_class, PROP_DIR, pspec);
 204
 205         /* PREVIEW IMAGE */
 206         pspec = g_param_spec_string("image", "Image",
 207                         "A preview image of the theme",
 208                         NULL,
 209                         G_PARAM_READWRITE);
 210         g_object_class_install_property(obj_class, PROP_IMAGE, pspec);
 211 }
 212
 213
 214 GType
 215 purple_theme_get_type(void)
 216 {
 217         static GType type = 0;
 218         if (type == 0) {
 219                 static const GTypeInfo info = {
 220                         sizeof(PurpleThemeClass),
 221                         NULL, /* base_init */
 222                         NULL, /* base_finalize */
 223                         (GClassInitFunc)purple_theme_class_init, /* class_init */
 224                         NULL, /* class_finalize */
 225                         NULL, /* class_data */
 226                         sizeof(PurpleTheme),
 227                         0, /* n_preallocs */
 228                         purple_theme_init, /* instance_init */
 229                         NULL, /* value table */
 230                 };
 231                 type = g_type_register_static (G_TYPE_OBJECT,
 232                                 "PurpleTheme", &info, G_TYPE_FLAG_ABSTRACT);
 233         }
 234         return type;
 235 }
 236
 237 /******************************************************************************
 238  * Helper Functions
 239  *****************************************************************************/
 240
 241 static gchar *
 242 theme_clean_text(const gchar *text)
 243 {
 244         gchar *clean_text = NULL;
 245         if (text != NULL) {
 246                 clean_text = g_markup_escape_text(text, -1);
 247                 g_strdelimit(clean_text, "\n", ' ');
 248                 purple_str_strip_char(clean_text, '\r');
 249         }
 250         return clean_text;
 251 }
 252
 253 /*****************************************************************************
 254  * Public API function
 255  *****************************************************************************/
 256
 257 const gchar *
 258 purple_theme_get_name(PurpleTheme *theme)
 259 {
 260         PurpleThemePrivate *priv;
 261
 262         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 263
 264         priv = PURPLE_THEME_GET_PRIVATE(theme);
 265         return priv->name;
 266 }
 267
 268 void
 269 purple_theme_set_name(PurpleTheme *theme, const gchar *name)
 270 {
 271         PurpleThemePrivate *priv;
 272
 273         g_return_if_fail(PURPLE_IS_THEME(theme));
 274
 275         priv = PURPLE_THEME_GET_PRIVATE(theme);
 276
 277         g_free(priv->name);
 278         priv->name = theme_clean_text(name);
 279 }
 280
 281 const gchar *
 282 purple_theme_get_description(PurpleTheme *theme)
 283 {
 284         PurpleThemePrivate *priv;
 285
 286         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 287
 288         priv = PURPLE_THEME_GET_PRIVATE(theme);
 289         return priv->description;
 290 }
 291
 292 void
 293 purple_theme_set_description(PurpleTheme *theme, const gchar *description)
 294 {
 295         PurpleThemePrivate *priv;
 296
 297         g_return_if_fail(PURPLE_IS_THEME(theme));
 298
 299         priv = PURPLE_THEME_GET_PRIVATE(theme);
 300
 301         g_free(priv->description);
 302         priv->description = theme_clean_text(description);
 303 }
 304
 305 const gchar *
 306 purple_theme_get_author(PurpleTheme *theme)
 307 {
 308         PurpleThemePrivate *priv;
 309
 310         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 311
 312         priv = PURPLE_THEME_GET_PRIVATE(theme);
 313         return priv->author;
 314 }
 315
 316 void
 317 purple_theme_set_author(PurpleTheme *theme, const gchar *author)
 318 {
 319         PurpleThemePrivate *priv;
 320
 321         g_return_if_fail(PURPLE_IS_THEME(theme));
 322
 323         priv = PURPLE_THEME_GET_PRIVATE(theme);
 324
 325         g_free(priv->author);
 326         priv->author = theme_clean_text(author);
 327 }
 328
 329 const gchar *
 330 purple_theme_get_type_string(PurpleTheme *theme)
 331 {
 332         PurpleThemePrivate *priv;
 333
 334         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 335
 336         priv = PURPLE_THEME_GET_PRIVATE(theme);
 337         return priv->type;
 338 }
 339
 340 /* < private > */
 341 void
 342 purple_theme_set_type_string(PurpleTheme *theme, const gchar *type)
 343 {
 344         PurpleThemePrivate *priv;
 345
 346         g_return_if_fail(PURPLE_IS_THEME(theme));
 347
 348         priv = PURPLE_THEME_GET_PRIVATE(theme);
 349
 350         g_free(priv->type);
 351         priv->type = g_strdup(type);
 352 }
 353
 354 const gchar *
 355 purple_theme_get_dir(PurpleTheme *theme)
 356 {
 357         PurpleThemePrivate *priv;
 358
 359         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 360
 361         priv = PURPLE_THEME_GET_PRIVATE(theme);
 362         return priv->dir;
 363 }
 364
 365 void
 366 purple_theme_set_dir(PurpleTheme *theme, const gchar *dir)
 367 {
 368         PurpleThemePrivate *priv;
 369
 370         g_return_if_fail(PURPLE_IS_THEME(theme));
 371
 372         priv = PURPLE_THEME_GET_PRIVATE(theme);
 373
 374         g_free(priv->dir);
 375         priv->dir = g_strdup(dir);
 376 }
 377
 378 const gchar *
 379 purple_theme_get_image(PurpleTheme *theme)
 380 {
 381         PurpleThemePrivate *priv;
 382
 383         g_return_val_if_fail(PURPLE_IS_THEME(theme), NULL);
 384
 385         priv = PURPLE_THEME_GET_PRIVATE(theme);
 386
 387         return priv->img;
 388 }
 389
 390 gchar *
 391 purple_theme_get_image_full(PurpleTheme *theme)
 392 {
 393         const gchar *filename = purple_theme_get_image(theme);
 394
 395         if (filename)
 396                 return g_build_filename(purple_theme_get_dir(PURPLE_THEME(theme)), filename, NULL);
 397         else
 398                 return NULL;
 399 }
 400
 401 void
 402 purple_theme_set_image(PurpleTheme *theme, const gchar *img)
 403 {
 404         PurpleThemePrivate *priv;
 405
 406         g_return_if_fail(PURPLE_IS_THEME(theme));
 407
 408         priv = PURPLE_THEME_GET_PRIVATE(theme);
 409
 410         g_free(priv->img);
 411         priv->img = g_strdup(img);
 412 }