2 * This file is part of buxton.
4 * Copyright (C) 2013 Intel Corporation
6 * buxton is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as
8 * published by the Free Software Foundation; either version 2.1
9 * of the License, or (at your option) any later version.
13 * \file configurator.h Internal header
14 * This file is used internally by buxton to provide functionality
15 * used to handle the configuration
23 typedef enum ConfigKey {
28 CONFIG_SMACK_LOAD_FILE,
34 * Slightly duplicative of BuxtonLayer, but defined here instead of
35 * there. This will probably be deprecated for BuxtonLayer once
36 * things are integrated.
38 typedef struct ConfigLayer {
49 * @brief Add command line data
51 * @note This API is draft
53 void buxton_add_cmd_line(ConfigKey confkey, const char *data);
57 * @brief Get the directory of plugin modules
59 * @return the path to the plugin module. Do not free this pointer.
60 * It belongs to configurator.
62 const char *buxton_module_dir(void)
63 __attribute__((warn_unused_result));
67 * @brief Get the path of the config file
69 * @return the path of the config file. Do not free this pointer.
70 * It belongs to configurator.
72 const char *buxton_conf_file(void)
73 __attribute__((warn_unused_result));
77 * @brief Get the path of the buxton database
80 * @return the path of the database file. Do not free this pointer.
81 * It belongs to configurator.
83 const char *buxton_db_path(void)
84 __attribute__((warn_unused_result));
88 * @brief Get the path of the smack load file.
91 * @return the path of the smack load file. Do not free this pointer.
92 * It belongs to configurator.
94 const char *buxton_smack_load_file(void)
95 __attribute__((warn_unused_result));
99 * @brief Get the path of the buxton socket.
102 * @return the path of the buxton socket. Do not free this pointer.
103 * It belongs to configurator.
105 const char *buxton_socket(void)
106 __attribute__((warn_unused_result));
110 * @brief Get an array of ConfigLayers from the conf file
112 * @param layers pointer to a pointer where the array of ConfigLayers
113 * will be stored. Callers should free this pointer with free when
114 * they are done with it.
116 * @return an integer that indicates the number of layers.
118 int buxton_key_get_layers(ConfigLayer **layers)
119 __attribute__((warn_unused_result));
121 void include_configurator(void);
124 * Editor modelines - http://www.wireshark.org/tools/modelines.html
129 * indent-tabs-mode: t
132 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
133 * :indentSize=8:tabSize=8:noTabs=false: