/usr/include/cpl_parameter.h is in libcpl-dev 6.6.1-1build1.
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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | /* $Id: cpl_parameter.h,v 1.16 2013-02-11 13:30:57 rpalsa Exp $
*
* This file is part of the ESO Common Pipeline Library
* Copyright (C) 2001-2005 European Southern Observatory
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* $Author: rpalsa $
* $Date: 2013-02-11 13:30:57 $
* $Revision: 1.16 $
* $Name: not supported by cvs2svn $
*/
#ifndef CPL_PARAMETER_H
#define CPL_PARAMETER_H
#include <stdio.h>
#include <cpl_error.h>
#include <cpl_type.h>
CPL_BEGIN_DECLS
/**
* @ingroup cpl_parameter
*
* @brief
* Supported parameter modes.
*
* The parameter mode is used to set or get context specific parameter
* attributes.
*/
enum _cpl_parameter_mode_ {
/**
* Command line mode of the parameter.
* @hideinitializer
*/
CPL_PARAMETER_MODE_CLI = 1 << 0,
/**
* Environment variable mode of the parameter.
* @hideinitializer
*/
CPL_PARAMETER_MODE_ENV = 1 << 1,
/**
* Configuration file mode of the parameter.
* @hideinitializer
*/
CPL_PARAMETER_MODE_CFG = 1 << 2
};
/**
* @ingroup cpl_parameter
*
* @brief
* The parameter mode data type.
*/
typedef enum _cpl_parameter_mode_ cpl_parameter_mode;
/**
* @ingroup cpl_parameter
*
* @brief
* Supported parameter classes.
*/
enum _cpl_parameter_class_ {
/**
* Parameter of undefined or invalid class.
* @hideinitializer
*/
CPL_PARAMETER_CLASS_INVALID = 1 << 0,
/**
* Parameter representing a plain value.
* @hideinitializer
*/
CPL_PARAMETER_CLASS_VALUE = 1 << 1,
/**
* Parameter representing a range of values.
* @hideinitializer
*/
CPL_PARAMETER_CLASS_RANGE = 1 << 2,
/**
* Parameter representing an enumeration value.
* @hideinitializer
*/
CPL_PARAMETER_CLASS_ENUM = 1 << 3
};
/**
* @ingroup cpl_parameter
*
* @brief
* The parameter class data type.
*/
typedef enum _cpl_parameter_class_ cpl_parameter_class;
/**
* @ingroup cpl_parameter
*
* @brief
* The opaque parameter data type.
*/
typedef struct _cpl_parameter_ cpl_parameter;
/*
* Create and destroy operations
*/
cpl_parameter *cpl_parameter_new_value(const char *name, cpl_type type,
const char *description,
const char *context, ...) CPL_ATTR_ALLOC;
cpl_parameter *cpl_parameter_new_range(const char *name, cpl_type type,
const char *description,
const char *context, ...) CPL_ATTR_ALLOC;
cpl_parameter *cpl_parameter_new_enum(const char *name, cpl_type type,
const char *description,
const char *context, ...) CPL_ATTR_ALLOC;
cpl_parameter *cpl_parameter_duplicate(const cpl_parameter *other) CPL_ATTR_ALLOC;
void cpl_parameter_delete(cpl_parameter *self);
/*
* Non-modifying operations
*/
cpl_type cpl_parameter_get_type(const cpl_parameter *self);
cpl_parameter_class cpl_parameter_get_class(const cpl_parameter *self);
int cpl_parameter_is_enabled(const cpl_parameter *self,
cpl_parameter_mode mode);
/*
* Assignment operations
*/
cpl_error_code cpl_parameter_set_bool(cpl_parameter *self, int value);
cpl_error_code cpl_parameter_set_int(cpl_parameter *self, int value);
cpl_error_code cpl_parameter_set_double(cpl_parameter *self, double value);
cpl_error_code cpl_parameter_set_string(cpl_parameter *self,
const char *value);
cpl_error_code cpl_parameter_set_default_bool(cpl_parameter *self,
int value);
cpl_error_code cpl_parameter_set_default_int(cpl_parameter *self,
int value);
cpl_error_code cpl_parameter_set_default_double(cpl_parameter *self,
double value);
cpl_error_code cpl_parameter_set_default_string(cpl_parameter *self,
const char *value);
cpl_error_code cpl_parameter_set_default_flag(cpl_parameter *self,
int status);
/*
* Element access
*/
const char *cpl_parameter_get_name(const cpl_parameter *self);
const char *cpl_parameter_get_context(const cpl_parameter *self);
const char *cpl_parameter_get_help(const cpl_parameter *self);
int cpl_parameter_get_default_flag(const cpl_parameter *self);
int cpl_parameter_get_range_min_int(const cpl_parameter *self);
double cpl_parameter_get_range_min_double(const cpl_parameter *self);
int cpl_parameter_get_range_max_int(const cpl_parameter *self);
double cpl_parameter_get_range_max_double(const cpl_parameter *self);
int cpl_parameter_get_enum_size(const cpl_parameter *self);
int cpl_parameter_get_enum_int(const cpl_parameter *self, int position);
double cpl_parameter_get_enum_double(const cpl_parameter *self, int position);
const char *cpl_parameter_get_enum_string(const cpl_parameter *self,
int position);
int cpl_parameter_get_default_bool(const cpl_parameter *self);
int cpl_parameter_get_default_int(const cpl_parameter *self);
double cpl_parameter_get_default_double(const cpl_parameter *self);
const char *cpl_parameter_get_default_string(const cpl_parameter *self);
int cpl_parameter_get_bool(const cpl_parameter *self);
int cpl_parameter_get_int(const cpl_parameter *self);
double cpl_parameter_get_double(const cpl_parameter *self);
const char *cpl_parameter_get_string(const cpl_parameter *self);
/*
* Miscellaneous
*/
cpl_error_code cpl_parameter_enable(cpl_parameter *self,
cpl_parameter_mode mode);
cpl_error_code cpl_parameter_disable(cpl_parameter *self,
cpl_parameter_mode mode);
int cpl_parameter_get_id(const cpl_parameter *self);
cpl_error_code cpl_parameter_set_id(cpl_parameter *self, int id);
const char *cpl_parameter_get_tag(const cpl_parameter *self);
cpl_error_code cpl_parameter_set_tag(cpl_parameter *self, const char *tag);
const char *cpl_parameter_get_alias(const cpl_parameter *self,
cpl_parameter_mode mode);
cpl_error_code cpl_parameter_set_alias(cpl_parameter *self,
cpl_parameter_mode mode,
const char *alias);
/*
* Debugging
*/
void cpl_parameter_dump(const cpl_parameter *self, FILE *stream);
CPL_END_DECLS
#endif /* CPL_PARAMETER_H */
|