1/*****************************************************************************/
2/* */
3/* filepos.h */
4/* */
5/* File position data structure */
6/* */
7/* */
8/* */
9/* (C) 1998-2011, Ullrich von Bassewitz */
10/* Roemerstrasse 52 */
11/* D-70794 Filderstadt */
12/* EMail: uz@cc65.org */
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 FILEPOS_H
37#define FILEPOS_H
38
39
40
41/*****************************************************************************/
42/* Data */
43/*****************************************************************************/
44
45
46
47/* Type of a file position */
48typedef struct FilePos FilePos;
49struct FilePos {
50 unsigned Line; /* Line */
51 unsigned Col; /* Column */
52 unsigned Name; /* File */
53};
54
55/* Initializer for a FilePos */
56#define STATIC_FILEPOS_INITIALIZER { 0, 0, 0 }
57
58
59
60/*****************************************************************************/
61/* Code */
62/*****************************************************************************/
63
64
65
66void InitFilePos (FilePos* P);
67/* Initialize the file position (set all fields to zero) */
68
69int CompareFilePos (const FilePos* P1, const FilePos* P2);
70/* Compare two file positions. Return zero if both are equal, return a value
71** > 0 if P1 is greater and P2, and a value < 0 if P1 is less than P2. The
72** compare rates file index over line over column.
73*/
74
75
76
77/* End of filepos.h */
78
79#endif
80