1 /*****************************************************************************/
5 /* Code segment structure */
9 /* (C) 2001 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@cc65.org */
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. */
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: */
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 */
32 /*****************************************************************************/
55 /*****************************************************************************/
57 /*****************************************************************************/
65 /*****************************************************************************/
67 /*****************************************************************************/
71 /* Size of the label hash table */
72 #define CS_LABEL_HASH_SIZE 29
74 /* Code segment structure */
75 typedef struct CodeSeg CodeSeg;
77 char* SegName; /* Segment name */
78 SymEntry* Func; /* Owner function */
79 Collection Entries; /* List of code entries */
80 Collection Labels; /* Labels for next insn */
81 CodeLabel* LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
82 unsigned char ExitRegs; /* Register use on exit */
87 /*****************************************************************************/
89 /*****************************************************************************/
93 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
94 /* Create a new code segment, initialize and return it */
96 void AddCodeEntry (CodeSeg* S, const char* Format, va_list ap) attribute ((format(printf,2,0)));
97 /* Add a line to the given code segment */
99 void InsertCodeEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
100 /* Insert the code entry at the index given. Following code entries will be
101 * moved to slots with higher indices.
104 void DelCodeEntry (CodeSeg* S, unsigned Index);
105 /* Delete an entry from the code segment. This includes moving any associated
106 * labels, removing references to labels and even removing the referenced labels
107 * if the reference count drops to zero.
110 void DelCodeEntries (CodeSeg* S, unsigned Start, unsigned Count);
111 /* Delete a range of code entries. This includes removing references to labels,
112 * labels attached to the entries and so on.
115 #if defined(HAVE_INLINE)
116 INLINE struct CodeEntry* GetCodeEntry (CodeSeg* S, unsigned Index)
117 /* Get an entry from the given code segment */
119 return CollAt (&S->Entries, Index);
122 # define GetCodeEntry(S, Index) CollAt(&(S)->Entries, (Index))
125 struct CodeEntry* GetNextCodeEntry (CodeSeg* S, unsigned Index);
126 /* Get the code entry following the one with the index Index. If there is no
127 * following code entry, return NULL.
130 int GetCodeEntries (CodeSeg* S, struct CodeEntry** List,
131 unsigned Start, unsigned Count);
132 /* Get Count code entries into List starting at index start. Return true if
133 * we got the lines, return false if not enough lines were available.
136 unsigned GetCodeEntryIndex (CodeSeg* S, struct CodeEntry* E);
137 /* Return the index of a code entry */
139 void AddCodeLabel (CodeSeg* S, const char* Name);
140 /* Add a code label for the next instruction to follow */
142 CodeLabel* GenCodeLabel (CodeSeg* S, struct CodeEntry* E);
143 /* If the code entry E does already have a label, return it. Otherwise
144 * create a new label, attach it to E and return it.
147 void DelCodeLabel (CodeSeg* S, CodeLabel* L);
148 /* Remove references from this label and delete it. */
150 void MergeCodeLabels (CodeSeg* S);
151 /* Merge code labels. That means: For each instruction, remove all labels but
152 * one and adjust references accordingly.
155 void MoveCodeLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
156 /* Move all labels from Old to New. The routine will move the labels itself
157 * if New does not have any labels, and move references if there is at least
158 * a label for new. If references are moved, the old label is deleted
162 void RemoveCodeLabelRef (CodeSeg* S, struct CodeEntry* E);
163 /* Remove the reference between E and the label it jumps to. The reference
164 * will be removed on both sides and E->JumpTo will be 0 after that. If
165 * the reference was the only one for the label, the label will get
169 void MoveCodeLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
170 /* Change the reference of E to L instead of the current one. If this
171 * was the only reference to the old label, the old label will get
175 void AddCodeSegHint (CodeSeg* S, unsigned Hint);
176 /* Add a hint for the preceeding instruction */
178 void DelCodeSegAfter (CodeSeg* S, unsigned Last);
179 /* Delete all entries including the given one */
181 void OutputCodeSeg (const CodeSeg* S, FILE* F);
182 /* Output the code segment data to a file */
184 #if defined(HAVE_INLINE)
185 INLINE unsigned GetCodeEntryCount (const CodeSeg* S)
186 /* Return the number of entries for the given code segment */
188 return CollCount (&S->Entries);
191 # define GetCodeEntryCount(S) CollCount (&(S)->Entries)
196 /* End of codeseg.h */