/usr/include/cdebconf/debconfclient.h is in libdebconfclient0-dev 0.187ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | /**
* @file debconfclient.h
* @brief debconf client support interface
*
* \defgroup debconf client object
* @{
*/
#ifndef _DEBCONFCLIENT_H_
#define _DEBCONFCLIENT_H_
#include <stdio.h>
/**
* @brief debconf client object
*/
struct debconfclient {
/** internal use only */
char *value;
/* methods */
/**
* @brief sends a command to the confmodule
* @param struct debconfclient *client - client object
* @param const char *command, ... - null terminated command string
* @return return code from confmodule
*/
int (*command)(struct debconfclient *client, const char *cmd, ...)
#if defined(__GNUC__) && __GNUC__ >= 4
__attribute__((sentinel))
#endif
;
/**
* @brief sends a command to the confmodule (printf style)
* @param struct debconfclient *client - client object
* @param const char *commandf, printf style command format
* @param ... - command parameters
* @return return code from confmodule
*/
int (*commandf)(struct debconfclient *client, const char *cmd, ...)
#ifdef __GNUC__
__attribute__((format(printf, 2, 3)))
#endif
;
/**
* @brief simple accessor method for the return value
* @param struct debconfclient *client - client object
* @return char * - return value
*/
char *(*ret)(struct debconfclient *client);
/* Added to the end so we don't have to change the SONAME */
FILE *out;
};
/**
* @brief creates a debconfclient object
* @return struct debconfclient * - newly created debconfclient object
*/
struct debconfclient *debconfclient_new(void);
/**
* @brief destroys the debconfclient object
* @param struct debconfclient *client - client object to destroy
*/
void debconfclient_delete(struct debconfclient *client);
#define DEBCONF_OLD_FD_BASE 4
#define DEBCONF_OLD_STDIN_FD DEBCONF_OLD_FD_BASE
#define DEBCONF_OLD_STDOUT_FD DEBCONF_OLD_FD_BASE + 1
#define DEBCONF_OLD_STDERR_FD DEBCONF_OLD_FD_BASE + 2
/**
* @brief command codes returned by debconf commands
*/
typedef enum {
CMD_SUCCESS = 0,
CMD_ESCAPEDDATA = 1,
CMD_BADQUESTION = 10,
CMD_BADPARAM = 15,
CMD_SYNTAXERROR = 20,
CMD_INPUTINVISIBLE = 30, // from debconf_input()
CMD_BADVERSION = 30, // from debconf_version()
CMD_GOBACK = 30, // from debconf_go()
CMD_PROGRESSCANCELLED = 30, // from debconf_progress_{set,step,info}()
CMD_INTERNALERROR = 100
} cmdstatus_t;
/**
* @}
*/
/* Helper macros for the debconf commands */
#define debconf_input(_client, _priority, _question) \
_client->commandf(_client, "INPUT %s %s", _priority, _question)
#define debconf_clear(_client) \
_client->commandf(_client, "CLEAR")
#define debconf_version(_client, _version) \
_client->commandf(_client, "VERSION %u", _version)
#define debconf_capb(_client, _capb...) \
_client->command(_client, "CAPB", ##_capb, NULL)
#define debconf_title(_client, _title) \
_client->commandf(_client, "TITLE %s", _title)
#define debconf_beginblock(_client) \
_client->command(_client, "BEGINBLOCK", NULL)
#define debconf_endblock(_client) \
_client->command(_client, "ENDBLOCK", NULL)
#define debconf_go(_client) \
_client->command(_client, "GO", NULL)
#define debconf_get(_client, _question) \
_client->commandf(_client, "GET %s", _question)
#define debconf_set(_client, _question, _value) \
_client->commandf(_client, "SET %s %s", _question, _value)
#define debconf_reset(_client, _question) \
_client->commandf(_client, "RESET %s", _question)
#define debconf_subst(_client, _question, _var, _value) \
_client->commandf(_client, "SUBST %s %s %s", _question, _var, _value)
#define debconf_register(_client, _template, _question) \
_client->commandf(_client, "REGISTER %s %s", _template, _question)
#define debconf_unregister(_client, _question) \
_client->commandf(_client, "UNREGISTER %s", _question)
#define debconf_purge(_client) \
_client->command(_client, "PURGE", NULL)
#define debconf_metaget(_client, _question, _field) \
_client->commandf(_client, "METAGET %s %s", _question, _field)
#define debconf_fget(_client, _question, _flag) \
_client->commandf(_client, "FGET %s %s", _question, _flag)
#define debconf_fset(_client, _question, _flag, _value) \
_client->commandf(_client, "FSET %s %s %s", _question, _flag, _value)
#define debconf_exists(_client, _question) \
_client->commandf(_client, "EXIST %s", _question)
#define debconf_stop(_client) \
_client->command(_client, "STOP", NULL)
#define debconf_progress_info(_client, _info) \
_client->commandf(_client, "PROGRESS INFO %s", _info)
#define debconf_progress_set(_client, _val) \
_client->commandf(_client, "PROGRESS SET %d", _val)
#define debconf_progress_start(_client, _min, _max, _title) \
_client->commandf(_client, "PROGRESS START %d %d %s", _min, _max, _title)
#define debconf_progress_step(_client, _step) \
_client->commandf(_client, "PROGRESS STEP %d", _step)
#define debconf_progress_stop(_client) \
_client->command(_client, "PROGRESS STOP", NULL)
#define debconf_x_loadtemplate(_client, _template) \
_client->commandf(_client, "X_LOADTEMPLATEFILE %s", _template)
#define debconf_settitle(_client, _title) \
_client->commandf(_client, "SETTITLE %s", _title)
#define debconf_x_save(_client) \
_client->command(_client, "X_SAVE", NULL)
#define debconf_info(_client, _question) \
_client->commandf(_client, "INFO %s", _question)
#endif
|