grasp_settings.c File Reference
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "grasp_settings.h"
#include "grasp_settings_data_types.h"
#include "yamlsettings/yamlsettings_validators.h"
#include "yamlsettings/yamlsettings_dictionary.h"
#include "yamlsettings/yamlsettings_data_types.h"
#include "yamlsettings/yamlsettings_assign_data.h"
#include "grasp_settings_assign_data.h"
#include "grasp_settings_validators.h"
#include "yamlsettings/yamlsettings.h"
#include <grasp/utils.h>
#include "../global/grasp_compilation_information.h"
#include "../global/grasp_error_codes.h"
#include "../input/grasp_input_load_functions.h"
#include "../output/grasp_output_load_function.h"
#include "../output/grasp_output_stream.h"

Enumerations

enum  grasp_settings_type_parameter {
  GRASP_NO_EXTENSION, GRASP_EXTENSION_DRIVER, GRASP_EXTENSION_TRANSFORMER, GRASP_EXTENSION_SEGMENT_FUNCTION,
  GRASP_EXTENSION_CURRENT_FUNCTION, GRASP_EXTENSION_TILE_FUNCTION
}
 

Functions

void grasp_settings_copy_parameter (yamlsettings_parameter *origin, yamlsettings_parameter *dest, grasp_settings_type_parameter extension_type, const char *extension_name)
 
yamlsettings_dictionary_t * grasp_settings_dictionary_get (grasp_settings *settings)
 
void grasp_settings_postprocess_function (yamlsettings_dictionary_t *dictionary)
 
int grasp_settings_to_yaml_string (char content[], grasp_settings *settings, bool print_defaults, bool force_arrays)
 
int grasp_settings_description_json (char *json, int json_length)
 
int grasp_settings_dump (char *stream_pattern, grasp_settings *settings, bool print_defaults, bool force_arrays)
 
int grasp_settings_read (grasp_output_stream *controller_stream, yamlsettings_dictionary_t **dictionary, int nparameters, char const *parameters[], yamlsettings_parser_settings_file_mode settings_file_mode)
 
void grasp_settings_help (grasp_output_stream *controller_stream, const char *filter)
 
char * grasp_settings_list_paths ()
 
char * grasp_settings_to_string (const char *filename)
 
void grasp_settings_destroy (grasp_settings *settings)
 
grasp_settings_parameter_arraygrasp_settings_parameter_array_allocate (int nelements)
 
void grasp_settings_parameter_array_destroy (grasp_settings_parameter_array *x)
 
int grasp_settings_deduct_nwl (yamlsettings_dictionary_t *dictionary)
 

Enumeration Type Documentation

◆ grasp_settings_type_parameter

Enumerator
GRASP_NO_EXTENSION 
GRASP_EXTENSION_DRIVER 
GRASP_EXTENSION_TRANSFORMER 
GRASP_EXTENSION_SEGMENT_FUNCTION 
GRASP_EXTENSION_CURRENT_FUNCTION 
GRASP_EXTENSION_TILE_FUNCTION 

Function Documentation

◆ grasp_settings_copy_parameter()

void grasp_settings_copy_parameter ( yamlsettings_parameter *  origin,
yamlsettings_parameter *  dest,
grasp_settings_type_parameter  extension_type,
const char *  extension_name 
)

◆ grasp_settings_deduct_nwl()

int grasp_settings_deduct_nwl ( yamlsettings_dictionary_t *  dictionary)

◆ grasp_settings_description_json()

int grasp_settings_description_json ( char *  json,
int  json_length 
)

◆ grasp_settings_destroy()

void grasp_settings_destroy ( grasp_settings settings)

◆ grasp_settings_dictionary_get()

yamlsettings_dictionary_t* grasp_settings_dictionary_get ( grasp_settings settings)

◆ grasp_settings_dump()

int grasp_settings_dump ( char *  stream_pattern,
grasp_settings settings,
bool  print_defaults,
bool  force_arrays 
)

Function which dumps grasp settings in yaml format

Parameters
stream_patternPatter to initialize grasp_output_stream
settingsCurrent settings you want to dump
print_defaultsif you want to print default values or you prefer a reduced settings file based on only set information
Returns
0 if everything was ok, otherwise a value different than 0

◆ grasp_settings_help()

void grasp_settings_help ( grasp_output_stream controller_stream,
const char *  filter 
)

◆ grasp_settings_list_paths()

char* grasp_settings_list_paths ( )

◆ grasp_settings_parameter_array_allocate()

grasp_settings_parameter_array* grasp_settings_parameter_array_allocate ( int  nelements)

◆ grasp_settings_parameter_array_destroy()

void grasp_settings_parameter_array_destroy ( grasp_settings_parameter_array x)

◆ grasp_settings_postprocess_function()

void grasp_settings_postprocess_function ( yamlsettings_dictionary_t *  dictionary)

◆ grasp_settings_read()

int grasp_settings_read ( grasp_output_stream controller_stream,
yamlsettings_dictionary_t **  dictionary,
int  nparameters,
char const *  parameters[],
yamlsettings_parser_settings_file_mode  settings_file_mode 
)

◆ grasp_settings_to_string()

char* grasp_settings_to_string ( const char *  filename)

◆ grasp_settings_to_yaml_string()

int grasp_settings_to_yaml_string ( char  content[],
grasp_settings settings,
bool  print_defaults,
bool  force_arrays 
)