util-enum.c

Go to the documentation of this file.

/* Copyright (C) 2007-2010 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
 
/**
 * \file
 *
 * \author Anoop Saldanha <anoopsaldanha@gmail.com>
 */
 
#include "suricata-common.h"
 
#include "util-enum.h"
#include "util-debug.h"
 
/**
 * \brief Maps a string name to an enum value from the supplied table.  Please
 *        specify the last element of any map table with a {NULL, -1}.  If
 *        missing, you will be welcomed with a segfault :)
 *
 * \param enum_name Character string that has to be mapped to an enum value
 *                  from the table
 * \param table     Enum-Char table, from which the mapping is retrieved
 *
 * \retval result The enum_value for the enum_name string or -1 on failure
 */
int SCMapEnumNameToValue(const char *enum_name, SCEnumCharMap *table)
{
    int result = -1;
 
    if (enum_name == NULL || table == NULL) {
        SCLogDebug("Invalid argument(s) passed into SCMapEnumNameToValue");
        return -1;
    }
 
    for (; table->enum_name != NULL; table++) {
        if (strcasecmp(table->enum_name, enum_name) == 0) {
            result = table->enum_value;
            break;
        }
    }
 
    return result;
}
 
/**
 * \brief Maps an enum value to a string name, from the supplied table
 *
 * \param enum_value Enum_value that has to be mapped to a string_value
 *                   from the table
 * \param table      Enum-Char table, from which the mapping is retrieved
 *
 * \retval result The enum_name for the enum_value supplied or NULL on failure
 */
const char * SCMapEnumValueToName(int enum_value, SCEnumCharMap *table)
{
    if (table == NULL) {
        SCLogDebug("Invalid argument(s) passed into SCMapEnumValueToName");
        return NULL;
    }
 
    for (; table->enum_name != NULL; table++) {
        if (table->enum_value == enum_value) {
            return table->enum_name;
        }
    }
 
    SCLogDebug("A enum by the value %d doesn't exist in this table", enum_value);
 
    return NULL;
}