rtxEnum.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXENUM_H_
#define _RTXENUM_H_

#include "rtxsrc/rtxContext.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct OSEnumItem {
   const OSUTF8CHAR* name;
   OSINT32           value;
   OSUINT16          namelen;
   OSUINT16          transidx;
} OSEnumItem;

typedef struct OSEnumItemU32 {
   const OSUTF8CHAR* name;
   OSUINT32          value;
   OSUINT16          namelen;
   OSUINT16          transidx;
} OSEnumItemU32;

typedef struct OSBigEnumItem {
   const OSUTF8CHAR* name;
   const char*       value;
   OSUINT16          namelen;
   OSUINT16          transidx;
} OSBigEnumItem;

typedef struct OSNumericEnumItem {
   OSINT32           start;
   OSINT32           end;
} OSNumericEnumItem;

typedef struct OSNumericEnumItemU32 {
   OSUINT32           start;
   OSUINT32           end;
} OSNumericEnumItemU32;

typedef struct OSNumericEnumItem64 {
   OSINT64           start;
   OSINT64           end;
} OSNumericEnumItem64;

typedef struct OSNumericEnumItemU64 {
   OSUINT64           start;
   OSUINT64           end;
} OSNumericEnumItemU64;

EXTERNRT OSINT32 rtxLookupEnum
(const OSUTF8CHAR* strValue, size_t strValueSize,
 const OSEnumItem enumTable[], OSUINT16 enumTableSize);

EXTERNRT OSINT32 rtxLookupEnumU32
(const OSUTF8CHAR* strValue, size_t strValueSize,
 const OSEnumItemU32 enumTable[], OSUINT16 enumTableSize);

EXTERNRT OSINT32 rtxLookupBigEnum
(const OSUTF8CHAR* strValue, size_t strValueSize,
 const OSBigEnumItem enumTable[], OSUINT16 enumTableSize);

EXTERNRT OSINT32 rtxLookupEnumByValue
(OSINT32 value, const OSEnumItem enumTable[], size_t enumTableSize);

EXTERNRT OSINT32 rtxLookupEnumU32ByValue
(OSUINT32 value, const OSEnumItemU32 enumTable[], size_t enumTableSize);

EXTERNRT OSINT32 rtxLookupBigEnumByValue
(const char* value, const OSBigEnumItem enumTable[], size_t enumTableSize);

EXTERNRT int rtxTestNumericEnum
(OSINT32 ivalue, const OSNumericEnumItem enumTable[], OSUINT16 enumTableSize);

EXTERNRT int rtxTestNumericEnumU32
(OSUINT32 ivalue, const OSNumericEnumItemU32 enumTable[], OSUINT16 enumTableSize);

EXTERNRT int rtxTestNumericEnum64
(OSINT64 ivalue, const OSNumericEnumItem64 enumTable[], OSUINT16 enumTableSize);

EXTERNRT int rtxTestNumericEnumU64
(OSUINT64 ivalue, const OSNumericEnumItemU64 enumTable[], OSUINT16 enumTableSize);
#ifdef __cplusplus
}
#endif

#endif