1 /*****************************************************************************/
5 /* Source file line info structure */
9 /* (C) 2001-2012, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
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 /*****************************************************************************/
53 /*****************************************************************************/
55 /*****************************************************************************/
64 /*****************************************************************************/
66 /*****************************************************************************/
70 /* Structure holding line information. The Pos.Name field is always the
71 ** global string id of the file name. If the line info was read from the
72 ** object file, the File pointer is valid, otherwise it is NULL.
74 typedef struct LineInfo LineInfo;
76 unsigned Id; /* Line info id */
77 struct FileInfo* File; /* File struct for this line if any */
78 unsigned Type; /* Type of line info */
79 FilePos Pos; /* Position in file */
80 unsigned* Spans; /* Spans for this line */
85 /*****************************************************************************/
87 /*****************************************************************************/
91 LineInfo* GenLineInfo (const FilePos* Pos);
92 /* Generate a new (internally used) line info with the given information */
94 LineInfo* ReadLineInfo (FILE* F, struct ObjData* O);
95 /* Read a line info from a file and return it */
97 void FreeLineInfo (LineInfo* LI);
98 /* Free a LineInfo structure. */
100 LineInfo* DupLineInfo (const LineInfo* LI);
101 /* Creates a duplicate of a line info structure */
103 void ReadLineInfoList (FILE* F, struct ObjData* O, Collection* LineInfos);
104 /* Read a list of line infos stored as a list of indices in the object file,
105 ** make real line infos from them and place them into the passed collection.
108 const LineInfo* GetAsmLineInfo (const Collection* LineInfos);
109 /* Find a line info of type LI_TYPE_ASM and count zero in the given collection
110 ** and return it. Return NULL if no such line info was found.
113 #if defined(HAVE_INLINE)
114 INLINE const FilePos* GetSourcePos (const LineInfo* LI)
115 /* Return the source file position from the given line info */
120 # define GetSourcePos(LI) (&(LI)->Pos)
123 #if defined(HAVE_INLINE)
124 INLINE const char* GetSourceName (const LineInfo* LI)
125 /* Return the name of a source file from the given line info */
127 return GetString (LI->Pos.Name);
130 # define GetSourceName(LI) (GetString ((LI)->Pos.Name))
133 #if defined(HAVE_INLINE)
134 INLINE unsigned GetSourceLine (const LineInfo* LI)
135 /* Return the source file line from the given line info */
140 # define GetSourceLine(LI) ((LI)->Pos.Line)
143 #if defined(HAVE_INLINE)
144 INLINE unsigned GetSourceCol (const LineInfo* LI)
145 /* Return the source file column from the given line info */
150 # define GetSourceCol(LI) ((LI)->Pos.Col)
153 #if defined(HAVE_INLINE)
154 INLINE const char* GetSourceNameFromList (const Collection* LineInfos)
155 /* Return the name of a source file from a list of line infos */
157 /* The relevant entry is in slot zero */
158 return GetSourceName (CollConstAt (LineInfos, 0));
161 # define GetSourceNameFromList(LineInfos) \
162 GetSourceName ((const LineInfo*) CollConstAt ((LineInfos), 0))
165 #if defined(HAVE_INLINE)
166 INLINE unsigned GetSourceLineFromList (const Collection* LineInfos)
167 /* Return the source file line from a list of line infos */
169 /* The relevant entry is in slot zero */
170 return GetSourceLine (CollConstAt (LineInfos, 0));
173 # define GetSourceLineFromList(LineInfos) \
174 GetSourceLine ((const LineInfo*) CollConstAt ((LineInfos), 0))
177 unsigned LineInfoCount (void);
178 /* Return the total number of line infos */
180 void AssignLineInfoIds (void);
181 /* Assign the ids to the line infos */
183 void PrintDbgLineInfo (FILE* F);
184 /* Output the line infos to a debug info file */
188 /* End of lineinfo.h */