---

config.h

Go to the documentation of this file.

/*! \file config.h
    Header file for config.c.
 */

#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_HD

  /*! \brief Maximum number of modems' configuration records.
   */

  #define MODEM_CONF_MAX_ENTRY            256

  /*! \brief Maximum number of bytes (including the final 0) for the buffer used to store the constructor's signature.
   */

  #define MODEM_CONF_IDENTIFIER_SIZE      7

  /*! \brief Maximum number of bytes (including the final 0) for the label that represents the constructor.
   */

  #define MODEM_CONF_TAG_NAME_SIZE        256

  /*! \brief Maximum number of bytes (including the final 0) for the auto-configuration tag ("yes" or "no").
   */

  #define MODEM_CONF_AUTOCONF_SIZE        4

  /*! \brief Maximum number of bytes (including the final 0) for the path to the dinamically loadable module
             that implements the calculation of the MAC address.
   */

  #define MODEM_CONF_ACTION_SIZE          256


  /*! \brief This structure contains the modems' configuration data.
   */

  struct modem_conf_struct {
                              /*! \brief Modem's ID (this is the index in the array).
                               */

                              int id;

                              /*! \brief 6 first bytes of the modem's MAC address. This is called the manufacturor's sugnature.
                               */

                              char identifier[MODEM_CONF_IDENTIFIER_SIZE];

                              /*! \brief Arbitrary string that represents the modem's constructor. This is the trademark.
                               */

                              char tag_name[MODEM_CONF_TAG_NAME_SIZE];

                              /*! \brief This string represents the auto-configuration capability. Value can be:
                                         <ul>
                                           <li>"yes": the modem suports auto-configuration.
                                           <li>"no": the modem does not support auto-configuration.
                                         </ul>
                               */

                              char autoconf[MODEM_CONF_AUTOCONF_SIZE];

                              /*! \brief Path to the dinamically loadable module used to process the MAC address.
                               */

                              char action[MODEM_CONF_ACTION_SIZE];

                              /*! \brief Handle to the dinamically loadable module.
                               */

                              void *dll;

                              /*! \brief Pointer to the function (within the dinamically loadable module) that is called to
                                         process the MAC address.
                               */

                              char* (*calculate_mac_address)(char*);
                           }; 


  #ifdef PRIVATE_CODE_ONLY

     /*! \brief Thei FLEX configuration file is not valid.
      */

     #define CONF_PARSER_SYNTAX_ERROR   -1

     /*! \brief The FLEX configuration parser could not allocate memory.
      */

     #define CONF_PARSER_NO_MEM         -2

     /*! \brief The FLEX configuration parser found a duplicated tag in the configuration file.
      */

     #define CONF_PARSER_DUPLICATED_TAG -3

     /*! \brief The FLEX configuration parser found a modem's manufacturor MAC signature that is too long.
      */

     #define CONF_PARSER_IDENTIFIER_TOO_LONG  -4

     /*! \brief The FLEX configuration parser found a modem's manufacturor label that is too long.
      */

     #define CONF_PARSER_TAG_NAME_TOO_LONG    -5

     /*! \brief The FLEX configuration parser found a modem's autoconfiguration tag that is too long.
      */

     #define CONF_PARSER_AUTOCONF_TOO_LONG    -6

     /*! \brief The FLEX configuration parser found a modem's plugins that is too long.
      */

     #define CONF_PARSER_ACTION_TOO_LONG      -7  

     /*! \brief the configuration file contains too many modem's information.
      */

     #define CONF_PARSER_TOO_MANY_ENTRIES     -8

     /*! \brief The configuration file has been successfully parsed.
      */

     #define CONF_PARSER_OK             0

     /*! \brief Data structure used to store the couples (tag, value).
      */

     struct user_data {
                         char *tag;
                         char *value;
                      };

  #endif

  /*! \brief configuration parser could not open the configuration file.
   */

  #define PARSE_CONFIGURATION_FILE_NOT_FOUND    -1

  /*! \brief configuration parser could not allocate memory.
   */

  #define PARSE_CONFIGURATION_NO_MEM            -2

  /*! \brief configuration parser found an invalid line.
   */

  #define PARSE_CONFIGURATION_SYNTAX_ERROR      -3

  /*! \brief configuration parser found a duplicated tag.
   */

  #define PARSE_CONFIGURATION_DUPLICATED_TAG    -4

  /*! \brief Could not load the DLL.
   */

  #define PARSE_CONFIGURATION_DLL_OPEN_ERROR    -5

  /*! \brief The DLL is not valid.
   */

  #define PARSE_CONFIGURATION_DLL_INVALID       -6

  /*! \brief One record that represents a modem's configuration is not valid.
   */ 

  #define PARSE_CONFIGURATION_MODEM_CONF_NOT_VALID -7

  /*! \brief configuration parser terminated successfully.
   */

  #define PARSE_CONFIGURATION_OK                0


  int parse_configuration_file (char *path, int *err);
  void free_all_configuration_data();
  int get_value (char *tag, char **value);
  char* dummy_mac_processor (char* addr);
  char* conf_get_last_error();


  int get_number_of_modem_conf();
  int modem_conf_get_id (char *mac);
  char* modem_conf_get_tag_name (int id);
  int modem_conf_is_autoconf (int id);
  void* modem_conf_get_function (int id);


  #define CONFIG_HD

#endif

#ifdef __cplusplus
}
#endif

---