symbol.h

Go to the documentation of this file.

#ifndef SYMBOL_H
#define SYMBOL_H
/***************************************************************************
 *   Copyright (C) 2007-2011 Mike Kinghan, imk@strudl.org                  *
 *   All rights reserved.                                                  *
 *                                                                         *
 *   Contributed originally by Mike Kinghan, imk@strudl.org                *
 *                                                                         *
 *   Redistribution and use in source and binary forms, with or without    *
 *   modification, are permitted provided that the following conditions    *
 *   are met:                                                              *
 *                                                                         *
 *   Redistributions of source code must retain the above copyright        *
 *   notice, this list of conditions and the following disclaimer.         *
 *                                                                         *
 *   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.  *
 *                                                                         *
 *   Neither the name of Symbian Software Ltd. 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.                                                               *
 *                                                                         *
 **************************************************************************/
#include "bool.h"
#include "canonical_string.h"
#include "eval_result.h"
#include "ptr_vector.h"
#include <math.h>
#include <stddef.h>
#include <ctype.h>


typedef struct eval_result * symbol_h;

typedef struct eval_result const * symbol_const_h;

extern symbol_h
symbol_new(char const *name, size_t namelen);

extern void
symbol_dispose(symbol_h sym);

extern symbol_h
symbol_copy(symbol_const_h src);

extern void
symbol_swap(symbol_h lhs, symbol_h rhs);

extern void
symbol_assign(symbol_h dest, symbol_const_h src);

extern bool
symbol_equal(symbol_const_h lhs,symbol_const_h rhs);


extern line_type_t
symbol_define(symbol_h sym, char const *tail, char const **pend);

extern line_type_t
symbol_undefine(symbol_h sym, char const *tail, char const **pend);


extern char const *
symbol_name(symbol_const_h sym);

extern canonical_string_const_h
symbol_definition(symbol_const_h sym);


extern int
symbol_compare(symbol_const_h lhs, void const * rhs, size_t namelen);

extern bool
symbol_is_legal(char const *tok, size_t toklen);

extern bool
symbol_is_configured(symbol_const_h sym);

bool
symbol_is_global(symbol_const_h sym);

extern bool
is_symbol_start_char(char cp);

extern bool
is_symbol_inner_char(char cp);

extern canonical_string_const_h
symbol_resolve(symbol_h sym, ptr_vector_h history);

extern bool
symbol_reported(symbol_const_h sym);

line_type_t
symbol_evaluate_status(bool define, char const *symstart, const char *tail, const char **pend);



#endif /* EOF*/