trap_module_info.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 CESNET
 *
 * LICENSE TERMS
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of the Company nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * ALTERNATIVELY, provided that this notice is retained in full, this
 * product may be distributed under the terms of the GNU General Public
 * License (GPL) version 2 or later, in which case the provisions
 * of the GPL apply INSTEAD OF those given above.
 *
 * This software is provided ``as is'', and any express or implied
 * warranties, including, but not limited to, the implied warranties of
 * merchantability and fitness for a particular purpose are disclaimed.
 * In no event shall the company or contributors be liable for any
 * direct, indirect, incidental, special, exemplary, or consequential
 * damages (including, but not limited to, procurement of substitute
 * goods or services; loss of use, data, or profits; or business
 * interruption) however caused and on any theory of liability, whether
 * in contract, strict liability, or tort (including negligence or
 * otherwise) arising in any way out of the use of this software, even
 * if advised of the possibility of such damage.
 *
 */

#ifndef _TRAP_MODULE_INFO_H_
#define _TRAP_MODULE_INFO_H_

typedef struct trap_module_info_parameter_s {
   char   short_opt;
   char  *long_opt;
   char  *description;
   int param_required_argument;
   char  *argument_type;
} trap_module_info_parameter_t;

typedef struct trap_module_info_s {
   char *name;           
   char *description;    
   int num_ifc_in;  
   int num_ifc_out; 
   trap_module_info_parameter_t **params;
} trap_module_info_t;

#define GEN_LONG_OPT_STRUCT_LINE(p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) {p_long_opt, p_required_argument, 0, p_short_opt},

#define GEN_LONG_OPT_STRUCT(PARAMS) \
   static struct option long_options[] __attribute__((used)) = { \
      PARAMS(GEN_LONG_OPT_STRUCT_LINE) \
      {0, 0, 0, 0} \
   };

#define ALLOCATE_BASIC_INFO_2(module_info, p_name, p_description, p_input, p_output) \
   if (module_info != NULL) { \
      if (p_name != NULL) { \
         module_info->name = strdup(p_name); \
      } else { \
         module_info->name = NULL; \
      } \
      if (p_description != NULL) { \
         module_info->description = strdup(p_description); \
      } else { \
         module_info->description = NULL; \
      } \
      module_info->num_ifc_in = p_input; \
      module_info->num_ifc_out = p_output; \
   }

#define ALLOCATE_BASIC_INFO(p_name, p_description, p_input, p_output) \
   ALLOCATE_BASIC_INFO_2(module_info, p_name, p_description, p_input, p_output)

#define ALLOCATE_PARAM_ITEMS_2(m, param_id, p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) \
   if (m != NULL) { \
      if (m->params[param_id] == NULL) { \
         m->params[param_id] = (trap_module_info_parameter_t *) calloc(1, sizeof(trap_module_info_parameter_t)); \
      } \
      if (m->params[param_id] != NULL) { \
         if (p_short_opt != 0) { \
            m->params[param_id]->short_opt = p_short_opt; \
         } else { \
            m->params[param_id]->short_opt = 0; \
         } \
         if (p_long_opt != NULL) { \
            m->params[param_id]->long_opt = strdup(p_long_opt); \
         } else { \
            m->params[param_id]->long_opt = strdup(""); \
         } \
         if (p_description != NULL) { \
            m->params[param_id]->description = strdup(p_description); \
         } else { \
            m->params[param_id]->description = strdup(""); \
         } \
         if (p_required_argument == 1) { \
            m->params[param_id]->param_required_argument = p_required_argument; \
         } else { \
            m->params[param_id]->param_required_argument = 0; \
         } \
         if (p_argument_type != NULL) { \
            m->params[param_id]->argument_type = strdup(p_argument_type); \
         } else { \
            m->params[param_id]->argument_type = strdup(""); \
         } \
      } \
   }

#define ALLOCATE_PARAM_ITEMS(p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) \
   ALLOCATE_PARAM_ITEMS_2(module_info, trap_module_params_cnt, p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) \
   trap_module_params_cnt++;

#define FREE_BASIC_INFO(p_name, p_description, p_input, p_output) \
   if (module_info->name != NULL) { \
      free(module_info->name); \
      module_info->name = NULL; \
   } \
   if (module_info->description != NULL) { \
      free(module_info->description); \
      module_info->description = NULL; \
   }

#define FREE_PARAM_ITEMS(p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) \
   if (module_info->params[trap_module_params_cnt] != NULL) { \
      if (module_info->params[trap_module_params_cnt]->long_opt != NULL) { \
         free(module_info->params[trap_module_params_cnt]->long_opt); \
         module_info->params[trap_module_params_cnt]->long_opt= NULL; \
      } \
      if (module_info->params[trap_module_params_cnt]->description != NULL) { \
         free(module_info->params[trap_module_params_cnt]->description); \
         module_info->params[trap_module_params_cnt]->description= NULL; \
      } \
      if (module_info->params[trap_module_params_cnt]->argument_type != NULL) { \
         free(module_info->params[trap_module_params_cnt]->argument_type); \
         module_info->params[trap_module_params_cnt]->argument_type= NULL; \
      } \
      if (module_info->params[trap_module_params_cnt] != NULL) { \
         free(module_info->params[trap_module_params_cnt]); \
      } \
      trap_module_params_cnt++; \
   }

#define GENERATE_GETOPT_STRING(p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) \
  if (module_getopt_string_size <= (strlen(module_getopt_string) + 2)) { \
    module_getopt_string_size += module_getopt_string_size/2; \
    module_getopt_string = (char *) realloc(module_getopt_string, module_getopt_string_size * sizeof(char)); \
    memset(module_getopt_string + (2*module_getopt_string_size)/3, 0, module_getopt_string_size/3); \
  } \
  module_getopt_string[strlen(module_getopt_string)] = p_short_opt; \
  if (p_required_argument == required_argument) { \
    module_getopt_string[strlen(module_getopt_string)] = ':'; \
  }

#define COUNT_MODULE_PARAMS(p_short_opt, p_long_opt, p_description, p_required_argument, p_argument_type) trap_module_params_cnt++;

#define INIT_MODULE_INFO_STRUCT(BASIC, PARAMS) \
   int trap_module_params_cnt = 0; \
   size_t module_getopt_string_size = 50; \
   char * module_getopt_string = (char *) calloc(module_getopt_string_size, sizeof(char)); \
   module_info = (trap_module_info_t *) calloc(1, sizeof(trap_module_info_t)); \
   GEN_LONG_OPT_STRUCT(PARAMS); \
   BASIC(ALLOCATE_BASIC_INFO) \
   PARAMS(COUNT_MODULE_PARAMS) \
   if (module_info != NULL) { \
      module_info->params = (trap_module_info_parameter_t **) calloc(trap_module_params_cnt + 1, sizeof(trap_module_info_parameter_t *)); \
      if (module_info->params != NULL) { \
         trap_module_params_cnt = 0; \
         PARAMS(ALLOCATE_PARAM_ITEMS) \
         PARAMS(GENERATE_GETOPT_STRING) \
      } \
   }

trap_module_info_t *trap_create_module_info(const char *mname, const char *mdesc, int8_t i_ifcs, int8_t o_ifcs, uint16_t param_count);

int trap_update_module_param(trap_module_info_t *m, uint16_t param_id, char shortopt, const char *longopt, const char *desc, int req_arg, const char *arg_type);

#define FREE_MODULE_INFO_STRUCT(BASIC, PARAMS) \
   if (module_info != NULL) { \
      trap_module_params_cnt = 0; \
      BASIC(FREE_BASIC_INFO) \
      if (module_info->params != NULL) { \
         PARAMS(FREE_PARAM_ITEMS) \
         free(module_info->params); \
         module_info->params = NULL; \
      } \
      free(module_info); \
      module_info = NULL; \
      if (module_getopt_string != NULL) { \
        free(module_getopt_string); \
      } \
   }


#endif