git.sur5r.net Git - cc65/blob - src/ca65/symbol.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 symbol.h                                  */
   4 /*                                                                           */
   5 /*                   Parse a symbol name and search for it                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2012, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef SYMBOL_H
  37 #define SYMBOL_H
  38
  39
  40
  41 /* cc65 */
  42 #include "symtab.h"
  43
  44
  45
  46 /*****************************************************************************/
  47 /*                                 Forwards                                  */
  48 /*****************************************************************************/
  49
  50
  51
  52 struct StrBuf;
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                   Code                                    */
  58 /*****************************************************************************/
  59
  60
  61
  62 struct SymTable* ParseScopedIdent (struct StrBuf* Name, struct StrBuf* FullName);
  63 /* Parse a (possibly scoped) identifer. The scope of the name must exist and
  64  * is returned as function result, while the last part (the identifier) which
  65  * may be either a symbol or a scope depending on the context is returned in
  66  * Name. FullName is a string buffer that is used to store the full name of
  67  * the identifier including the scope. It is used internally and may be used
  68  * by the caller for error messages or similar.
  69  */
  70
  71 struct SymEntry* ParseScopedSymName (SymFindAction Action);
  72 /* Parse a (possibly scoped) symbol name, search for it in the symbol table
  73  * and return the symbol table entry.
  74  */
  75
  76 struct SymTable* ParseScopedSymTable (void);
  77 /* Parse a (possibly scoped) symbol table (scope) name, search for it in the
  78  * symbol space and return the symbol table struct.
  79  */
  80
  81 struct SymEntry* ParseAnySymName (SymFindAction Action);
  82 /* Parse a cheap local symbol or a a (possibly scoped) symbol name, search
  83  * for it in the symbol table and return the symbol table entry.
  84  */
  85
  86
  87
  88 /* End of symbol.h */
  89
  90 #endif
  91
  92
  93