2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file cgi/options.c
21 * Options represent an additional configuration system private to the
25 #include "disorder-cgi.h"
32 struct read_options_state
{
40 static void option__readfile(const char *name
);
42 static void option__label(int attribute((unused
)) nvec
,
44 option_set(vec
[0], vec
[1]);
47 static void option__include(int attribute((unused
)) nvec
,
49 option__readfile(vec
[0]);
52 static void option__columns(int nvec
,
56 c
.ncolumns
= nvec
- 1;
58 hash_add(columns
, vec
[0], &c
, HASH_INSERT_OR_REPLACE
);
61 /** @brief Definition of an option command */
62 static struct option
{
63 /** @brief Command name */
65 /** @brief Minimum number of arguments */
67 /** @brief Maximum number of arguments */
69 /** @brief Command handler */
70 void (*handler
)(int nvec
, char **vec
);
72 { "columns", 1, INT_MAX
, option__columns
},
73 { "include", 1, 1, option__include
},
74 { "label", 2, 2, option__label
},
77 static void option__split_error(const char *msg
,
79 struct read_options_state
*cs
= u
;
81 disorder_error(0, "%s:%d: %s", cs
->name
, cs
->line
, msg
);
84 static void option__readfile(const char *name
) {
88 struct read_options_state cs
;
90 if(!(cs
.name
= mx_find(name
, 1/*report*/)))
92 if(!(fp
= fopen(cs
.name
, "r")))
93 disorder_fatal(errno
, "error opening %s", cs
.name
);
95 while(!inputline(cs
.name
, fp
, &buffer
, '\n')) {
97 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
98 option__split_error
, &cs
)))
102 if((i
= TABLE_FIND(options
, name
, vec
[0])) == -1) {
103 disorder_error(0, "%s:%d: unknown option '%s'", cs
.name
, cs
.line
, vec
[0]);
108 if(n
< options
[i
].minargs
) {
109 disorder_error(0, "%s:%d: too few arguments to '%s'", cs
.name
, cs
.line
, vec
[-1]);
112 if(n
> options
[i
].maxargs
) {
113 disorder_error(0, "%s:%d: too many arguments to '%s'", cs
.name
, cs
.line
, vec
[-1]);
116 options
[i
].handler(n
, vec
);
121 static void option__init(void) {
122 static int have_read_options
;
124 if(!have_read_options
) {
125 have_read_options
= 1;
126 labels
= hash_new(sizeof (char *));
127 columns
= hash_new(sizeof (struct column
));
128 option__readfile("options");
132 /** @brief Set an option
133 * @param name Option name
134 * @param value Option value
136 * If the option was already set its value is replaced.
138 * @p name and @p value are copied.
140 void option_set(const char *name
, const char *value
) {
141 char *v
= xstrdup(value
);
144 hash_add(labels
, name
, &v
, HASH_INSERT_OR_REPLACE
);
147 /** @brief Get a label
148 * @param key Name of label
149 * @return Value of label (never NULL)
151 * If label images.X isn't found then the return value is
152 * <url.static>X.png, allowing url.static to be used to provide a base
153 * for all images with per-image overrides.
155 * Otherwise undefined labels expand to their last (dot-separated)
158 const char *option_label(const char *key
) {
163 lptr
= hash_find(labels
, key
);
167 if(!strncmp(key
, "images.", 7)) {
168 static const char *url_static
;
169 /* images.X defaults to <url.static>X.png */
172 url_static
= option_label("url.static");
173 byte_xasprintf((char **)&label
, "%s%s.png", url_static
, key
+ 7);
174 } else if((label
= strrchr(key
, '.')))
175 /* X.Y defaults to Y */
178 /* otherwise default to label name */
183 /** @brief Test whether a label exists
184 * @param key Name of label
185 * @return 1 if label exists, otherwise 0
187 * Labels that don't exist still have an expansion (per option_label()
188 * documentation), and possibly not even a placeholder one.
190 int option_label_exists(const char *key
) {
192 return !!hash_find(labels
, key
);
195 /** @brief Return a column list
196 * @param name Context (playing/recent/etc)
197 * @param ncolumns Where to store column count or NULL
198 * @return Pointer to column list
200 char **option_columns(const char *name
, int *ncolumns
) {
204 c
= hash_find(columns
, name
);
207 *ncolumns
= c
->ncolumns
;