Source/charon/definitions.h

   1 /**
   2  * @file definitions.h
   3  *
   4  * @brief general purpose definitions and macros
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef DEFINITIONS_H_
  24 #define DEFINITIONS_H_
  25
  26
  27 #define MAPPING_END -1
  28
  29 /**
  30  * @brief mapping entry, where enum-to-string mappings are stored
  31  */
  32 typedef struct mapping_s mapping_t;
  33 struct mapping_s
  34 {
  35         /**
  36          * enumeration value
  37          */
  38         int value;
  39         /**
  40          * mapped string
  41          */
  42         char *string;
  43 };
  44
  45
  46 /**
  47  * @brief find a mapping_string in the mapping[]
  48  *
  49  * @param mappings              mappings array
  50  * @param value                 enum-value to get the string from
  51  *
  52  */
  53 char *mapping_find(mapping_t *mappings, int value);
  54
  55
  56 #endif /*DEFINITIONS_H_*/