1 | /*****************************************************************************/ |
2 | /* */ |
3 | /* lineinfo.h */ |
4 | /* */ |
5 | /* Source file line info structure */ |
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 LINEINFO_H |
37 | #define LINEINFO_H |
38 | |
39 | |
40 | |
41 | /* common */ |
42 | #include "strbuf.h" |
43 | |
44 | |
45 | |
46 | /*****************************************************************************/ |
47 | /* Forwards */ |
48 | /*****************************************************************************/ |
49 | |
50 | |
51 | |
52 | /* Input file structure */ |
53 | struct IFile; |
54 | |
55 | |
56 | |
57 | /*****************************************************************************/ |
58 | /* Data */ |
59 | /*****************************************************************************/ |
60 | |
61 | |
62 | |
63 | /* The text for the actual line is allocated at the end of the structure, so |
64 | ** the size of the structure varies. |
65 | */ |
66 | typedef struct LineInfo LineInfo; |
67 | struct LineInfo { |
68 | unsigned RefCount; /* Reference counter */ |
69 | struct IFile* InputFile; /* Input file for this line */ |
70 | unsigned LineNum; /* Line number */ |
71 | char Line[1]; /* Source code line */ |
72 | }; |
73 | |
74 | |
75 | |
76 | /*****************************************************************************/ |
77 | /* Code */ |
78 | /*****************************************************************************/ |
79 | |
80 | |
81 | |
82 | LineInfo* UseLineInfo (LineInfo* LI); |
83 | /* Increase the reference count of the given line info and return it. */ |
84 | |
85 | void ReleaseLineInfo (LineInfo* LI); |
86 | /* Release a reference to the given line info, free the structure if the |
87 | ** reference count drops to zero. |
88 | */ |
89 | |
90 | LineInfo* GetCurLineInfo (void); |
91 | /* Return a pointer to the current line info. The reference count is NOT |
92 | ** increased, use UseLineInfo for that purpose. |
93 | */ |
94 | |
95 | void UpdateLineInfo (struct IFile* F, unsigned LineNum, const StrBuf* Line); |
96 | /* Update the line info - called if a new line is read */ |
97 | |
98 | const char* GetInputName (const LineInfo* LI); |
99 | /* Return the file name from a line info */ |
100 | |
101 | unsigned GetInputLine (const LineInfo* LI); |
102 | /* Return the line number from a line info */ |
103 | |
104 | |
105 | |
106 | /* End of lineinfo.h */ |
107 | |
108 | #endif |
109 | |