YAC 3.21.0
Yet Another Coupler
Loading...
Searching...
No Matches
param.h
Go to the documentation of this file.
1// Copyright (c) 2026 The YAC Authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef YAC_PARAM_H
6#define YAC_PARAM_H
7
8#include <stddef.h>
9
167// Opaque handle for a parameter (scalar, struct, or list)
168struct yac_param;
169
183
195
196//------------------------------------------------------------------------------
197// General parameter access functions
198//------------------------------------------------------------------------------
199
211 const struct yac_param *param);
212
224 const struct yac_param *param);
225
237const char *yac_param_get_name(
238 const struct yac_param *param);
239
240//------------------------------------------------------------------------------
241// Struct and list access functions
242//------------------------------------------------------------------------------
243
258 const struct yac_param *param, size_t *count);
259
279 struct yac_param *param, const char *name,
280 struct yac_param **sub_param);
281
298 struct yac_param *param, size_t idx,
299 struct yac_param **sub_param);
300
301//------------------------------------------------------------------------------
302// List manipulation functions for list parameters
303//------------------------------------------------------------------------------
304
318 struct yac_param *param,
319 struct yac_param **sub_param);
320
321//------------------------------------------------------------------------------
322// Scalar parameter access functions
323//------------------------------------------------------------------------------
324
337 struct yac_param *param, const char *value_str);
338
352 const struct yac_param *param, char *buf, size_t buflen);
353
365 const struct yac_param *param,
366 enum yac_param_scalar_kind *scalar_kind);
367
379 struct yac_param *param, int value);
380
392 struct yac_param *param, double value);
393
405 const struct yac_param *param, int *value);
406
418 const struct yac_param *param, double *value);
419
420//------------------------------------------------------------------------------
421// Error handling and cleanup
422//------------------------------------------------------------------------------
423
433const char *yac_param_get_last_error(void);
434
435// Delete a parameter handle (if needed)
436void yac_param_delete(struct yac_param *param);
437
438#endif // YAC_PARAM_H
struct @23::@24 value
yac_param_scalar_kind
Scalar parameter storage kind.
Definition param.h:185
@ YAC_PARAM_SCALAR_KIND_INVALID
Invalid or unsupported scalar kind.
Definition param.h:187
@ YAC_PARAM_SCALAR_KIND_INT
Scalar value backed by int storage.
Definition param.h:189
@ YAC_PARAM_SCALAR_KIND_DBLE
Scalar value backed by double storage.
Definition param.h:191
@ YAC_PARAM_SCALAR_KIND_STR
Scalar value backed by string storage.
Definition param.h:193
int yac_param_get_scalar_dble(const struct yac_param *param, double *value)
Get the value of a scalar parameter as a double.
Definition param.c:174
void yac_param_delete(struct yac_param *param)
Definition param.c:304
int yac_param_get_sub_by_index(struct yac_param *param, size_t idx, struct yac_param **sub_param)
Get a handle to a subparameter by index.
Definition param.c:89
int yac_param_is_default(const struct yac_param *param)
Check whether a parameter is at its default value.
Definition param.c:37
yac_param_type
Parameter type for generic configuration interface.
Definition param.h:171
@ YAC_PARAM_TYPE_SCALAR
Single typed value (e.g., int, double, string, enum)
Definition param.h:177
@ YAC_PARAM_TYPE_LIST
Ordered, growable list of subparameters.
Definition param.h:181
@ YAC_PARAM_TYPE_EMPTY
No value (used for optional/absent parameters)
Definition param.h:175
@ YAC_PARAM_TYPE_INVALID
Uninitialized or error state.
Definition param.h:173
@ YAC_PARAM_TYPE_STRUCT
Named, fixed set of subparameters.
Definition param.h:179
int yac_param_get_scalar_kind(const struct yac_param *param, enum yac_param_scalar_kind *scalar_kind)
Get the storage kind of a scalar parameter.
Definition param.c:134
int yac_param_get_scalar(const struct yac_param *param, char *buf, size_t buflen)
Get the value of a scalar parameter as a string.
Definition param.c:123
int yac_param_set_scalar(struct yac_param *param, const char *value_str)
Set the value of a scalar parameter from a string.
Definition param.c:113
enum yac_param_type yac_param_get_type(const struct yac_param *param)
Get the type of a parameter.
Definition param.c:24
int yac_param_append(struct yac_param *param, struct yac_param **sub_param)
Append a new default subparameter to a list parameter and return a handle to it.
Definition param.c:102
int yac_param_set_scalar_int(struct yac_param *param, int value)
Set the value of a scalar parameter as an int.
Definition param.c:147
int yac_param_get_sub_count(const struct yac_param *param, size_t *count)
Get the number of subparameters.
Definition param.c:61
int yac_param_set_scalar_dble(struct yac_param *param, double value)
Set the value of a scalar parameter as a double.
Definition param.c:156
const char * yac_param_get_last_error(void)
Retrieve the last error message for the calling thread.
Definition param.c:298
int yac_param_get_scalar_int(const struct yac_param *param, int *value)
Get the value of a scalar parameter as an int.
Definition param.c:165
const char * yac_param_get_name(const struct yac_param *param)
Get the name of the current parameter.
Definition param.c:50
int yac_param_get_sub_by_name(struct yac_param *param, const char *name, struct yac_param **sub_param)
Get a handle to a subparameter by name.
Definition param.c:75
char const * name
Definition toy_scrip.c:114