164 lines
6.4 KiB
C
164 lines
6.4 KiB
C
/****************************************************************************
|
|
* include/nuttx/symtab.h
|
|
*
|
|
* Copyright (C) 2009 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* 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 NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "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
|
|
* COPYRIGHT OWNER 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 __INCLUDE_NUTTX_SYMTAB_H
|
|
#define __INCLUDE_NUTTX_SYMTAB_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* struct symbtab_s describes one entry in the symbol table. A symbol table
|
|
* is a fixed size array of struct symtab_s. The information is intentionally
|
|
* minimal and supports only:
|
|
*
|
|
* 1. Function points as sym_values. Of other kinds of values need to be
|
|
* supported, then typing information would also need to be included in
|
|
* the structure.
|
|
*
|
|
* 2. Fixed size arrays. There is no explicit provisional for dyanamically
|
|
* adding or removing entries from the symbol table (realloc might be
|
|
* used for that purpose if needed). The intention is to support only
|
|
* fixed size arrays completely defined at compilation or link time.
|
|
*/
|
|
|
|
struct symtab_s
|
|
{
|
|
FAR const char *sym_name; /* A pointer to the symbol name string */
|
|
FAR const void *sym_value; /* The value associated witht the string */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C" {
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: symtab_findbyname
|
|
*
|
|
* Description:
|
|
* Find the symbol in the symbol table with the matching name.
|
|
* This version assumes that table is not ordered with respect to symbol
|
|
* name and, hence, access time will be linear with respect to nsyms.
|
|
*
|
|
* Returned Value:
|
|
* A reference to the symbol table entry if an entry with the matching
|
|
* name is found; NULL is returned if the entry is not found.
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN FAR const struct symtab_s *
|
|
symtab_findbyname(FAR const struct symtab_s *symtab,
|
|
FAR const char *name, int nsyms);
|
|
|
|
/****************************************************************************
|
|
* Name: symtab_findorderedbyname
|
|
*
|
|
* Description:
|
|
* Find the symbol in the symbol table with the matching name.
|
|
* This version assumes that table ordered with respect to symbol name.
|
|
*
|
|
* Returned Value:
|
|
* A reference to the symbol table entry if an entry with the matching
|
|
* name is found; NULL is returned if the entry is not found.
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN FAR const struct symtab_s *
|
|
symtab_findorderedbyname(FAR const struct symtab_s *symtab,
|
|
FAR const char *name, int nsyms);
|
|
|
|
/****************************************************************************
|
|
* Name: symtab_findbyvalue
|
|
*
|
|
* Description:
|
|
* Find the symbol in the symbol table whose value closest (but not greater
|
|
* than), the provided value. This version assumes that table is not ordered
|
|
* with respect to symbol name and, hence, access time will be linear with
|
|
* respect to nsyms.
|
|
*
|
|
* Returned Value:
|
|
* A reference to the symbol table entry if an entry with the matching
|
|
* name is found; NULL is returned if the entry is not found.
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN FAR const struct symtab_s *
|
|
symtab_findbyvalue(FAR const struct symtab_s *symtab,
|
|
FAR void *value, int nsyms);
|
|
|
|
/****************************************************************************
|
|
* Name: symtab_findorderedbyvalue
|
|
*
|
|
* Description:
|
|
* Find the symbol in the symbol table whose value closest (but not greater
|
|
* than), the provided value. This version assumes that table is ordered
|
|
* with respect to symbol name.
|
|
*
|
|
* Returned Value:
|
|
* A reference to the symbol table entry if an entry with the matching
|
|
* name is found; NULL is returned if the entry is not found.
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN FAR const struct symtab_s *
|
|
symtab_findorderedbyvalue(FAR const struct symtab_s *symtab,
|
|
FAR void *value, int nsyms);
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_SYMTAB_H */
|
|
|