1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 obt/ddparse.h for the Openbox window manager
4 Copyright (c) 2009 Dana Jansens
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.
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.
16 See the COPYING file for a copy of the GNU General Public License.
21 typedef struct _ObtDDParseGroup ObtDDParseGroup;
26 OBT_DDPARSE_LOCALESTRING,
28 OBT_DDPARSE_LOCALESTRINGS,
31 OBT_DDPARSE_ENUM_TYPE,
32 OBT_DDPARSE_ENVIRONMENTS,
33 OBT_DDPARSE_NUM_VALUE_TYPES
34 } ObtDDParseValueType;
37 OBT_DDPARSE_MATCH_NONE = 0,
38 OBT_DDPARSE_MATCH_FAIL,
39 OBT_DDPARSE_MATCH_LANG,
40 OBT_DDPARSE_MATCH_LANG_MODIFIER,
41 OBT_DDPARSE_MATCH_LANG_COUNTRY,
42 OBT_DDPARSE_MATCH_LANG_COUNTRY_MODIFIER
43 } ObtDDParseLangMatch;
45 typedef struct _ObtDDParseValue {
46 ObtDDParseValueType type;
47 union _ObtDDParseValueValue {
49 struct _ObtDDParseValueStrings {
56 guint environments; /*!< A mask of flags from ObtLinkEnvMask */
58 ObtDDParseLangMatch language_match;
61 /*! Parse a .desktop file.
62 @param filename The full path to the .desktop file to be read.
63 @return Returns a hash table where the keys are groups, and the values are
65 GHashTable* obt_ddparse_file(const gchar *filename,
66 const gchar *language,
68 const gchar *modifier);
70 /*! Get the keys in a group from a .desktop file.
71 The group comes from the hash table returned by obt_ddparse_file.
72 @return Returns a hash table where the keys are "keys" in the .desktop file,
73 represented as strings. The values are "values" in the .desktop file, for
74 the group @g. Each value will be a pointer to an ObtDDParseValue structure.
76 GHashTable* obt_ddparse_group_keys(ObtDDParseGroup *g);
78 /*! Determine the id for a .desktop file.
79 @param filename The path to the .desktop file, _relative to_ some
80 basepath. filename must end with ".desktop" and be encoded in utf8.
81 @return Returns a string which is the id for the given .desktop file in its
82 current position. Returns NULL if there is an error.
84 gchar* obt_ddparse_file_to_id(const gchar *filename);