obt/ddparse.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/ddparse.h for the Openbox window manager
   4    Copyright (c) 2009        Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #include <glib.h>
  20
  21 typedef struct _ObtDDParseGroup ObtDDParseGroup;
  22
  23 typedef enum {
  24     OBT_DDPARSE_EXEC,
  25     OBT_DDPARSE_STRING,
  26     OBT_DDPARSE_LOCALESTRING,
  27     OBT_DDPARSE_STRINGS,
  28     OBT_DDPARSE_LOCALESTRINGS,
  29     OBT_DDPARSE_BOOLEAN,
  30     OBT_DDPARSE_NUMERIC,
  31     OBT_DDPARSE_ENUM_TYPE,
  32     OBT_DDPARSE_ENVIRONMENTS,
  33     OBT_DDPARSE_NUM_VALUE_TYPES
  34 } ObtDDParseValueType;
  35
  36 typedef struct _ObtDDParseValue {
  37     ObtDDParseValueType type;
  38     union _ObtDDParseValueValue {
  39         gchar *string;
  40         struct _ObtDDParseValueStrings {
  41             gchar **a;
  42             gulong n;
  43         } strings;
  44         gboolean boolean;
  45         gfloat numeric;
  46         guint enumerable;
  47         guint environments; /*!< A mask of flags from ObtLinkEnvMask */
  48     } value;
  49 } ObtDDParseValue;
  50
  51 /*! Parse a .desktop file.
  52   @param filename The full path to the .desktop file to be read.
  53   @return Returns a hash table where the keys are groups, and the values are
  54     ObtDDParseGroups */
  55 GHashTable* obt_ddparse_file(const gchar *filename);
  56
  57 /*! Get the keys in a group from a .desktop file.
  58   The group comes from the hash table returned by obt_ddparse_file.
  59   @return Returns a hash table where the keys are "keys" in the .desktop file,
  60     represented as strings.  The values are "values" in the .desktop file, for
  61     the group @g. Each value will be a pointer to an ObtDDParseValue structure.
  62 */
  63 GHashTable* obt_ddparse_group_keys(ObtDDParseGroup *g);
  64
  65 /*! Determine the id for a .desktop file.
  66   @param filename The path to the .desktop file, _relative to_ some
  67     basepath. filename must end with ".desktop" and be encoded in utf8.
  68   @return Returns a string which is the id for the given .desktop file in its
  69     current position.  Returns NULL if there is an error.
  70 */
  71 gchar* obt_ddparse_file_to_id(const gchar *filename);