param_internal.h

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef YAC_PARAM_INTERNAL_H
#define YAC_PARAM_INTERNAL_H
 
#include <stddef.h>
#include <stdio.h>
#include "parameter/param.h"
 
struct yac_param;
 
struct yac_param_vtable {
 
  // General parameter operations
  enum yac_param_type (*get_type)(
    const struct yac_param *param);
  int (*is_default)(const struct yac_param *param);
  const char *(*get_name)(const struct yac_param *param);
 
  // Destructor
  void (*delete)(struct yac_param *param);
 
  // For struct and list parameters, get the number of subparameters
  // and their names
  int (*get_sub_count)(const struct yac_param *param,
                       size_t *count);
  int (*get_sub_by_name)(const struct yac_param *param,
                         const char *name,
                         struct yac_param **sub_param);
  int (*get_sub_by_index)(struct yac_param *param, size_t idx,
                          struct yac_param **sub_param);
 
  // For list parameters, manipulate the elements
  int (*append)(struct yac_param *param,
                struct yac_param **sub_param);
 
  // For scalar parameters, set/get the value as a string
  int (*set_scalar)(struct yac_param *param,
                    const char *value_str);
  int (*get_scalar)(const struct yac_param *param,
                    char *buf, size_t buflen);
 
  // Optional: set/get as int/double (only if supported by parameter)
  int (*set_scalar_int)(struct yac_param *param,
                        int value);
  int (*set_scalar_dble)(struct yac_param *param,
                         double value);
  int (*get_scalar_int)(const struct yac_param *param,
                        int *value);
  int (*get_scalar_dble)(const struct yac_param *param,
                         double *value);
};
 
void yac_param_get_error_buffer(char **buffer, size_t *buffer_size);
 
#define YAC_PARAM_ASSERT(COND, ...) do { \
  if (!(COND)) { \
    char *yac_param_error_buffer_ = NULL; \
    size_t yac_param_error_buffer_size_ = 0; \
    yac_param_get_error_buffer( \
      &yac_param_error_buffer_, &yac_param_error_buffer_size_); \
    if (yac_param_error_buffer_ && (yac_param_error_buffer_size_ > 0)) { \
      snprintf(yac_param_error_buffer_, yac_param_error_buffer_size_, \
              __VA_ARGS__); \
    } \
    return 1; \
  } \
} while (0)
 
int yac_param_parse_dble(
  const char *value_str, const char *param_name, double *value);
 
enum yac_param_angle_unit {
  YAC_PARAM_ANGLE_UNIT_DEG = 0, 
  YAC_PARAM_ANGLE_UNIT_RAD = 1, 
};
 
int yac_param_parse_dble_with_unit(
  const char *value_str, const char *param_name, double *value,
  enum yac_param_angle_unit *unit);
 
int yac_param_format_scalar_dble(
  char *buf, size_t buflen, double value, const char *value_desc,
  const char *param_name);
 
double yac_wrap_rad(double value, char const * param_name);
 
double yac_wrap_deg(double value, char const * param_name);
 
double yac_deg_to_rad(double deg, char const * param_name);
 
double yac_rad_to_deg(double rad, char const * param_name);
 
#define YAC_PARAM_CHECK_BASIC() \
  YAC_ASSERT(name, "name is NULL"); \
  YAC_ASSERT(name[0] != '\0', "name is empty string"); \
  YAC_ASSERT_F( \
    value_ptr, "value_ptr is NULL for parameter '%s'", name);
 
#define ERROR_BUF_SIZE (256)
 
#endif // YAC_PARAM_INTERNAL_H