parameter_group.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 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.
*/
 
/*
 * parameter_group.h
 *
 *  Created on: 9 Feb 2016
 *      Author: billy
 */
 
#ifndef PARAMETERS_INCLUDE_PARAMETER_GROUP_H_
#define PARAMETERS_INCLUDE_PARAMETER_GROUP_H_
 
#include "jansson.h"
#include "linked_list.h"
 
#include "parameter.h"
 
 
 
/*
 * The following preprocessor macros allow us to declare
 * and define the variables in the same place. By default,
 * they will expand to
 *
 *    extern const char *SERVICE_NAME_S;
 *
 * however if ALLOCATE_JSON_TAGS is defined then it will
 * become
 *
 *    const char *SERVICE_NAME_S = "path";
 *
 * ALLOCATE_JSON_TAGS must be defined only once prior to
 * including this header file. Currently this happens in
 * json_util.c.
 */
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_PARAMETER_GROUP_TAGS_H
  #define PARAMETER_GROUP_PREFIX GRASSROOTS_SERVICE_API
  #define PARAMETER_GROUP_VAL(x)  = x
#else
  #define PARAMETER_GROUP_PREFIX GRASSROOTS_SERVICE_API
  #define PARAMETER_GROUP_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
/*
PARAMETER_GROUP_PREFIX const char *PARAM_GROUP_DELIMITER_S PARAMETER_GROUP_VAL("/");
*/
 
/* forward declaration */
struct ServiceData;
struct ParameterGroup;
struct ParameterSet;
 
typedef struct ParameterGroup
{
  char *pg_name_s;
 
  bool pg_visible_flag;
 
 
  bool pg_full_display_flag;
 
 
  bool pg_vertical_layout_flag;
 
 
  bool pg_repeatable_flag;
 
 
  LinkedList *pg_repeatable_label_params_p;
 
  uint32 pg_current_repeatable_group_index;
 
 
  LinkedList *pg_params_p;
 
 
  LinkedList *pg_child_groups_p;
 
 
  const struct ServiceData *pg_service_data_p;
 
} ParameterGroup;
 
 
 
typedef struct ParameterGroupNode
{
  ListItem pgn_node;
 
  ParameterGroup *pgn_param_group_p;
} ParameterGroupNode;
 
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API ParameterGroupNode *AllocateParameterGroupNode (ParameterGroup *group_p);
 
 
 
 
GRASSROOTS_SERVICE_API void FreeParameterGroupNode (ListItem *node_p);
 
 
GRASSROOTS_SERVICE_API ParameterGroup *AllocateParameterGroup (const char *name_s,  const bool repeatable_flag, const struct ServiceData *service_data_p);
 
 
GRASSROOTS_SERVICE_API void FreeParameterGroup (ParameterGroup *param_group_p);
 
 
GRASSROOTS_SERVICE_API bool AddParameterGroupAsJSON (ParameterGroup *param_group_p, json_t *groups_array_p, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_SERVICE_API json_t *GetParameterGroupAsJSON (const ParameterGroup *param_group_p, const bool include_params_flag, const bool full_definition_flag, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_SERVICE_API bool AddParameterGroupChild (ParameterGroup *parent_group_p, ParameterGroup *child_group_p);
 
 
GRASSROOTS_SERVICE_API ParameterGroup *CreateAndAddParameterGroupChild (ParameterGroup *parent_group_p, const char *name_s, const bool repeatable_flag, const bool add_params_flag);
 
 
GRASSROOTS_SERVICE_API bool RemoveParameterGroupChild (ParameterGroup *parent_group_p, ParameterGroup *child_group_p);
 
 
GRASSROOTS_SERVICE_API bool CloneParameters (const ParameterGroup * const src_group_p, ParameterGroup *dest_group_p);
 
 
GRASSROOTS_SERVICE_API bool AddParameterToParameterGroup (ParameterGroup *parent_group_p, Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API ParameterGroup *CreateAndAddParameterGroupToParameterSet (const char *name_s, const bool repeatable_flag, const struct ServiceData *service_data_p, struct ParameterSet *param_set_p);
 
 
GRASSROOTS_SERVICE_API ParameterNode *GetParameterNodeFromParameterGroupByName (const ParameterGroup * const group_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API Parameter *GetParameterFromParameterGroupByName (const ParameterGroup * const group_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API char *GetRepeatableParameterGroupName (ParameterGroup * const group_p);
 
 
GRASSROOTS_SERVICE_API char *GetRepeatableParameterGroupRegularExpression (const ParameterGroup * const group_p);
 
 
 
GRASSROOTS_SERVICE_API bool AddRepeatableParameterGroupLabelParam (ParameterGroup *group_p, Parameter *param_p);
 
 
 
GRASSROOTS_SERVICE_API bool ReplaceParameterInParameterGroup (ParameterGroup *params_p, Parameter *old_param_p, Parameter *new_param_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* PARAMETERS_INCLUDE_PARAMETER_GROUP_H_ */