git.sur5r.net Git - cc65/blob - src/cc65/codeent.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codeent.h                                 */
   4 /*                                                                           */
   5 /*                            Code segment entry                             */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001     Ullrich von Bassewitz                                        */
  10 /*              Wacholderweg 14                                              */
  11 /*              D-70597 Stuttgart                                            */
  12 /* EMail:       uz@musoftware.de                                             */
  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 CODEENT_H
  37 #define CODEENT_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "coll.h"
  45 #include "inline.h"
  46
  47 /* cc65 */
  48 #include "codelab.h"
  49 #include "lineinfo.h"
  50 #include "opcodes.h"
  51
  52
  53
  54 /*****************************************************************************/
  55 /*                                   Data                                    */
  56 /*****************************************************************************/
  57
  58
  59
  60 /* Flags used */
  61 #define CEF_USERMARK    0x0001U         /* Generic mark by user functions */
  62 #define CEF_NUMARG      0x0002U         /* Insn has numerical argument */
  63
  64 /* Code entry structure */
  65 typedef struct CodeEntry CodeEntry;
  66 struct CodeEntry {
  67     opc_t               OPC;            /* Opcode */
  68     am_t                AM;             /* Adressing mode */
  69     char*               Arg;            /* Argument as string */
  70     unsigned long       Num;            /* Numeric argument */
  71     unsigned short      Flags;          /* Flags */
  72     unsigned char       Size;           /* Estimated size */
  73     unsigned char       Info;           /* Additional code info */
  74     unsigned char       Use;            /* Registers used */
  75     unsigned char       Chg;            /* Registers changed/destroyed */
  76     CodeLabel*          JumpTo;         /* Jump label */
  77     Collection          Labels;         /* Labels for this instruction */
  78     LineInfo*           LI;             /* Source line info for this insn */
  79 };
  80
  81
  82
  83 /*****************************************************************************/
  84 /*                                   Code                                    */
  85 /*****************************************************************************/
  86
  87
  88
  89 CodeEntry* NewCodeEntry (opc_t OPC, am_t AM, const char* Arg,
  90                          CodeLabel* JumpTo, LineInfo* LI);
  91 /* Create a new code entry, initialize and return it */
  92
  93 void FreeCodeEntry (CodeEntry* E);
  94 /* Free the given code entry */
  95
  96 void ReplaceOPC (CodeEntry* E, opc_t OPC);
  97 /* Replace the opcode of the instruction. This will also replace related info,
  98  * Size, Use and Chg, but it will NOT update any arguments or labels.
  99  */
 100
 101 int CodeEntriesAreEqual (const CodeEntry* E1, const CodeEntry* E2);
 102 /* Check if both code entries are equal */
 103
 104 void AttachCodeLabel (CodeEntry* E, CodeLabel* L);
 105 /* Attach the label to the entry */
 106
 107 #if defined(HAVE_INLINE)
 108 INLINE int CodeEntryHasLabel (const CodeEntry* E)
 109 /* Check if the given code entry has labels attached */
 110 {
 111     return (CollCount (&E->Labels) > 0);
 112 }
 113 #else
 114 #  define CodeEntryHasLabel(E)  (CollCount (&(E)->Labels) > 0)
 115 #endif
 116
 117 #if defined(HAVE_INLINE)
 118 INLINE unsigned GetCodeLabelCount (const CodeEntry* E)
 119 /* Get the number of labels attached to this entry */
 120 {
 121     return CollCount (&E->Labels);
 122 }
 123 #else
 124 #  define GetCodeLabelCount(E)  CollCount (&(E)->Labels)
 125 #endif
 126
 127 #if defined(HAVE_INLINE)
 128 INLINE CodeLabel* GetCodeLabel (CodeEntry* E, unsigned Index)
 129 /* Get a label from this code entry */
 130 {
 131     return CollAt (&E->Labels, Index);
 132 }
 133 #else
 134 #  define GetCodeLabel(E, Index)        CollAt (&(E)->Labels, (Index))
 135 #endif
 136
 137 void MoveCodeLabel (CodeLabel* L, CodeEntry* E);
 138 /* Move the code label L from it's former owner to the code entry E. */
 139
 140 #if defined(HAVE_INLINE)
 141 INLINE int CodeEntryHasMark (const CodeEntry* E)
 142 /* Return true if the given code entry has the CEF_USERMARK flag set */
 143 {
 144     return (E->Flags & CEF_USERMARK) != 0;
 145 }
 146 #else
 147 #  define CodeEntryHasMark(E)   (((E)->Flags & CEF_USERMARK) != 0)
 148 #endif
 149
 150 #if defined(HAVE_INLINE)
 151 INLINE void CodeEntrySetMark (CodeEntry* E)
 152 /* Set the CEF_USERMARK flag for the given entry */
 153 {
 154     E->Flags |= CEF_USERMARK;
 155 }
 156 #else
 157 #  define CodeEntrySetMark(E)   ((E)->Flags |= CEF_USERMARK)
 158 #endif
 159
 160 #if defined(HAVE_INLINE)
 161 INLINE void CodeEntryResetMark (CodeEntry* E)
 162 /* Reset the CEF_USERMARK flag for the given entry */
 163 {
 164     E->Flags &= ~CEF_USERMARK;
 165 }
 166 #else
 167 #  define CodeEntryResetMark(E) ((E)->Flags &= ~CEF_USERMARK)
 168 #endif
 169
 170 void CodeEntrySetArg (CodeEntry* E, const char* Arg);
 171 /* Set a new argument for the given code entry. An old string is deleted. */
 172
 173 void OutputCodeEntry (const CodeEntry* E, FILE* F);
 174 /* Output the code entry to a file */
 175
 176
 177
 178 /* End of codeent.h */
 179 #endif
 180
 181
 182