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 /*****************************************************************************/
56 /*****************************************************************************/
58 /*****************************************************************************/
66 /*****************************************************************************/
68 /*****************************************************************************/
72 /* Size of the label hash table */
73 #define CS_LABEL_HASH_SIZE 29
75 /* Code segment structure */
76 typedef struct CodeSeg CodeSeg;
78 char* SegName; /* Segment name */
79 SymEntry* Func; /* Owner function */
80 Collection Entries; /* List of code entries */
81 Collection Labels; /* Labels for next insn */
82 CodeLabel* LabelHash [CS_LABEL_HASH_SIZE]; /* Label hash table */
83 unsigned char ExitRegs; /* Register use on exit */
88 /*****************************************************************************/
90 /*****************************************************************************/
94 CodeSeg* NewCodeSeg (const char* SegName, SymEntry* Func);
95 /* Create a new code segment, initialize and return it */
97 void CS_AddEntry (CodeSeg* S, struct CodeEntry* E);
98 /* Add an entry to the given code segment */
100 void CS_AddLine (CodeSeg* S, LineInfo* LI, const char* Format, va_list ap) attribute ((format(printf,3,0)));
101 /* Add a line to the given code segment */
103 void CS_InsertEntry (CodeSeg* S, struct CodeEntry* E, unsigned Index);
104 /* Insert the code entry at the index given. Following code entries will be
105 * moved to slots with higher indices.
108 void CS_DelEntry (CodeSeg* S, unsigned Index);
109 /* Delete an entry from the code segment. This includes moving any associated
110 * labels, removing references to labels and even removing the referenced labels
111 * if the reference count drops to zero.
114 void CS_DelEntries (CodeSeg* S, unsigned Start, unsigned Count);
115 /* Delete a range of code entries. This includes removing references to labels,
116 * labels attached to the entries and so on.
119 #if defined(HAVE_INLINE)
120 INLINE void CS_MoveEntry (CodeSeg* S, unsigned OldPos, unsigned NewPos)
121 /* Move an entry from one position to another. OldPos is the current position
122 * of the entry, NewPos is the new position of the entry.
125 CollMove (&S->Entries, OldPos, NewPos);
128 # define CS_MoveEntry(S, OldPos, NewPos) CollMove (&(S)->Entries, OldPos, NewPos)
131 #if defined(HAVE_INLINE)
132 INLINE void CS_MoveEntries (CodeSeg* S, unsigned Start, unsigned Count, unsigned NewPos)
133 /* Move a range of entries from one position to another. Start is the index
134 * of the first entry to move, Count is the number of entries and NewPos is
135 * the index of the target entry. The entry with the index Start will later
136 * have the index NewPos. All entries with indices NewPos and above are
137 * moved to higher indices.
140 CollMoveMultiple (&S->Entries, Start, Count, NewPos);
143 # define CS_MoveEntries(S, Start, Count, NewPos) CollMoveMultiple (&(S)->Entries, Start, Count, NewPos)
146 #if defined(HAVE_INLINE)
147 INLINE struct CodeEntry* CS_GetEntry (CodeSeg* S, unsigned Index)
148 /* Get an entry from the given code segment */
150 return CollAt (&S->Entries, Index);
153 # define CS_GetEntry(S, Index) CollAt(&(S)->Entries, (Index))
156 struct CodeEntry* CS_GetNextEntry (CodeSeg* S, unsigned Index);
157 /* Get the code entry following the one with the index Index. If there is no
158 * following code entry, return NULL.
161 int CS_GetEntries (CodeSeg* S, struct CodeEntry** List,
162 unsigned Start, unsigned Count);
163 /* Get Count code entries into List starting at index start. Return true if
164 * we got the lines, return false if not enough lines were available.
167 unsigned CS_GetEntryIndex (CodeSeg* S, struct CodeEntry* E);
168 /* Return the index of a code entry */
170 CodeLabel* CS_AddLabel (CodeSeg* S, const char* Name);
171 /* Add a code label for the next instruction to follow */
173 CodeLabel* CS_GenLabel (CodeSeg* S, struct CodeEntry* E);
174 /* If the code entry E does already have a label, return it. Otherwise
175 * create a new label, attach it to E and return it.
178 void CS_DelLabel (CodeSeg* S, CodeLabel* L);
179 /* Remove references from this label and delete it. */
181 void CS_MergeLabels (CodeSeg* S);
182 /* Merge code labels. That means: For each instruction, remove all labels but
183 * one and adjust references accordingly.
186 void CS_MoveLabels (CodeSeg* S, struct CodeEntry* Old, struct CodeEntry* New);
187 /* Move all labels from Old to New. The routine will move the labels itself
188 * if New does not have any labels, and move references if there is at least
189 * a label for new. If references are moved, the old label is deleted
193 void CS_RemoveLabelRef (CodeSeg* S, struct CodeEntry* E);
194 /* Remove the reference between E and the label it jumps to. The reference
195 * will be removed on both sides and E->JumpTo will be 0 after that. If
196 * the reference was the only one for the label, the label will get
200 void CS_MoveLabelRef (CodeSeg* S, struct CodeEntry* E, CodeLabel* L);
201 /* Change the reference of E to L instead of the current one. If this
202 * was the only reference to the old label, the old label will get
206 void CS_DelCodeAfter (CodeSeg* S, unsigned Last);
207 /* Delete all entries including the given one */
209 void CS_Output (const CodeSeg* S, FILE* F);
210 /* Output the code segment data to a file */
212 #if defined(HAVE_INLINE)
213 INLINE unsigned CS_GetEntryCount (const CodeSeg* S)
214 /* Return the number of entries for the given code segment */
216 return CollCount (&S->Entries);
219 # define CS_GetEntryCount(S) CollCount (&(S)->Entries)
224 /* End of codeseg.h */