json_parameter.h

Go to the documentation of this file.

/*
** Copyright 2014-2020 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
/*
 * json_parameter.h
 *
 *  Created on: 31 Jan 2020
 *      Author: billy
 */
 
#ifndef CORE_SHARED_PARAMETERS_INCLUDE_JSON_PARAMETER_H_
#define CORE_SHARED_PARAMETERS_INCLUDE_JSON_PARAMETER_H_
 
#include "parameter.h"
#include "grassroots_service_library.h"
#include "parameter_set.h"
 
 
 
typedef struct JSONParameter
{
  Parameter jp_base_param;
 
  json_t *jp_current_value_p;
 
  json_t *jp_default_value_p;
} JSONParameter;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_JSON_PARAMETER_TAGS
  #define JSON_PARAM_PREFIX GRASSROOTS_SERVICE_API
  #define JSON_PARAM_VAL(x) = x
#else
  #define JSON_PARAM_PREFIX extern GRASSROOTS_SERVICE_API
  #define JSON_PARAM_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
JSON_PARAM_PREFIX const char *TABLE_PARAM_ROW_S JSON_PARAM_VAL("row");
JSON_PARAM_PREFIX const char *TABLE_PARAM_COLUMN_S JSON_PARAM_VAL("column");
 
 
 
GRASSROOTS_SERVICE_API JSONParameter *AllocateJSONParameter (const struct ServiceData *service_data_p, const ParameterType pt, const char * const name_s, const char * const display_name_s, const char * const description_s, const json_t *default_value_p, const json_t *current_value_p, ParameterLevel level);
 
 
 
GRASSROOTS_SERVICE_API JSONParameter *AllocateJSONParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag, const ParameterType *pt_p);
 
 
GRASSROOTS_SERVICE_API Parameter *EasyCreateAndAddJSONParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, ParameterType type,
                                                      const char * const name_s, const char * const display_name_s, const char * const description_s,
                                                      const json_t *default_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API Parameter *CreateAndAddJSONParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, ParameterType type,
                                                      const char * const name_s, const char * const display_name_s, const char * const description_s,
                                                      const json_t *default_value_p, const json_t *current_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API void FreeJSONParameter (JSONParameter *param_p);
 
 
GRASSROOTS_SERVICE_API const json_t *GetJSONParameterCurrentValue (const JSONParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetJSONParameterCurrentValue (JSONParameter *param_p, const json_t *value_p);
 
 
GRASSROOTS_SERVICE_API const json_t *GetJSONParameterDefaultValue (const JSONParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetJSONParameterDefaultValue (JSONParameter *param_p, const json_t *value_p);
 
 
GRASSROOTS_SERVICE_API bool IsJSONParameter (Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool GetCurrentJSONParameterValueFromParameterSet (const ParameterSet * const params_p, const char * const name_s, const json_t **value_pp);
 
 
GRASSROOTS_SERVICE_API bool SetJSONParameterCurrentValueFromJSON (JSONParameter *param_p, const json_t *value_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* CORE_SHARED_PARAMETERS_INCLUDE_JSON_PARAMETER_H_ */