param_bool.c

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#include "param_bool.h"
#include "param_internal.h"
#include "utils_common.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <limits.h>
 
static const struct yac_name_type_pair bool_table[] = {
  {"false", 0},
  {"False", 0},
  {"FALSE", 0},
  {"no", 0},
  {"NO", 0},
  {"0", 0},
  {"true", 1},
  {"True", 1},
  {"TRUE", 1},
  {"yes", 1},
  {"YES", 1},
  {"1", 1},
};
enum {BOOL_TABLE_SIZE = sizeof(bool_table) / sizeof(bool_table[0])};
 
struct yac_param_bool {
  const struct yac_param_vtable *vtable;
  char *name;
  int *value_ptr;
  int default_value;
  int has_default;
  int is_defined;
};
 
static enum yac_param_type
  yac_param_bool_get_type(
  const struct yac_param *param) {
  UNUSED(param);
  return YAC_PARAM_TYPE_SCALAR;
}
 
static int yac_param_bool_is_default(
  const struct yac_param *param) {
  const struct yac_param_bool *self =
    (const struct yac_param_bool *)param;
  if (!self->has_default) return 0;
  return *(self->value_ptr) == self->default_value;
}
 
static const char *yac_param_bool_get_name(
  const struct yac_param *param) {
  const struct yac_param_bool *self =
    (const struct yac_param_bool *)param;
  return self->name;
}
 
static int yac_param_bool_set_scalar(
  struct yac_param *param, const char *value_str) {
  struct yac_param_bool *self =
    (struct yac_param_bool *)param;
  YAC_PARAM_ASSERT(
    value_str,
    "No value provided for boolean parameter '%s'", self->name);
  int value =
    yac_name_type_pair_get_type(bool_table, BOOL_TABLE_SIZE, value_str);
  YAC_PARAM_ASSERT(
    value != INT_MAX,
    "'%s' is not a valid bool value for parameter '%s'",
    value_str, self->name);
  *(self->value_ptr) = value;
  self->is_defined = 1;
  return 0;
}
 
static int yac_param_bool_get_scalar(
  const struct yac_param *param, char *buf, size_t buflen) {
  const struct yac_param_bool *self =
    (const struct yac_param_bool *)param;
  if (!self || !self->value_ptr || !buf) return 1;
  YAC_PARAM_ASSERT(
    self->has_default || self->is_defined,
    "value for parameter '%s' is undefined, user must set it first",
    self->name);
  // Use yac_name_type_pair_get_name to get the canonical string for the value
  const char *str =
    yac_name_type_pair_get_name(
      bool_table, BOOL_TABLE_SIZE, *(self->value_ptr));
  YAC_ASSERT(str, "internal error");
  YAC_ASSERT(str, "buf is NULL");
  int n = snprintf(buf, buflen, "%s", str);
  YAC_PARAM_ASSERT(
    (n >= 0) && ((size_t)n < buflen),
    "buffer too small for value '%s' of parameter '%s'", str, self->name);
  return 0;
}
 
static int yac_param_bool_get_scalar_kind(
  const struct yac_param *param,
  enum yac_param_scalar_kind *scalar_kind) {
  UNUSED(param);
  *scalar_kind = YAC_PARAM_SCALAR_KIND_INT;
  return 0;
}
 
// int setter for bool
static int yac_param_bool_set_scalar_int(
  struct yac_param *param, int value) {
  struct yac_param_bool *self =
    (struct yac_param_bool *)param;
  *(self->value_ptr) = (value != 0);
  self->is_defined = 1;
  return 0;
}
 
// int getter for bool
static int yac_param_bool_get_scalar_int(
  const struct yac_param *param, int *value) {
  const struct yac_param_bool *self =
    (const struct yac_param_bool *)param;
  YAC_ASSERT(value, "value is NULL");
  YAC_PARAM_ASSERT(
    self->has_default || self->is_defined,
    "value for parameter '%s' is undefined, user must set it first",
    self->name);
  *value = *(self->value_ptr);
  return 0;
}
 
static void yac_param_bool_delete(
  struct yac_param *param) {
  struct yac_param_bool *self =
    (struct yac_param_bool *)param;
  free(self->name);
  free(param);
}
 
static const struct yac_param_vtable
  yac_param_bool_vtable = {
  .get_type = yac_param_bool_get_type,
  .is_default = yac_param_bool_is_default,
  .get_name = yac_param_bool_get_name,
  .delete = yac_param_bool_delete,
  .get_sub_count = NULL,
  .get_sub_by_name = NULL,
  .get_sub_by_index = NULL,
  .append = NULL,
  .set_scalar = yac_param_bool_set_scalar,
  .get_scalar = yac_param_bool_get_scalar,
  .get_scalar_kind = yac_param_bool_get_scalar_kind,
  .set_scalar_int = yac_param_bool_set_scalar_int,
  .set_scalar_dble = NULL,
  .get_scalar_int = yac_param_bool_get_scalar_int,
  .get_scalar_dble = NULL
};
 
struct yac_param *yac_param_bool_new(
  const char *name, int *value_ptr, int default_value, int has_default,
  int is_defined) {
 
  YAC_PARAM_CHECK_BASIC();
  YAC_ASSERT_F(
    !is_defined || ((*value_ptr == 0) || (*value_ptr == 1)),
    "initial value %d is not a valid bool for parameter '%s'",
    *value_ptr, name);
  struct yac_param_bool *self = xmalloc(1 * sizeof(*self));
  self->vtable = &yac_param_bool_vtable;
  self->name = xstrdup(name);
  self->value_ptr = value_ptr;
  self->default_value = default_value;
  self->has_default = has_default;
  self->is_defined = is_defined;
  return (struct yac_param *)self;
}