blob: 3af6595e62565cff6f527d3d752b3a7170b02621 [file] [log] [blame]
H. Peter Anvin1aa79452018-12-10 23:00:10 -08001/* ----------------------------------------------------------------------- *
2 *
3 * Copyright 1996-2016 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * ----------------------------------------------------------------------- */
33
34/*
35 * These functions are used to keep track of the source code file and name.
36 */
37#ifndef ASM_SRCFILE_H
38#define ASM_SRCFILE_H
39
40#include "compiler.h"
41
H. Peter Anvin026b62f2018-12-10 23:28:01 -080042struct src_location {
43 const char *filename;
44 int32_t lineno;
45};
46extern struct src_location _src_here;
47
H. Peter Anvin1aa79452018-12-10 23:00:10 -080048void src_init(void);
49void src_free(void);
50const char *src_set_fname(const char *newname);
H. Peter Anvin026b62f2018-12-10 23:28:01 -080051static inline const char *src_get_fname(void)
52{
53 return _src_here.filename;
54}
55static inline int32_t src_set_linnum(int32_t newline)
56{
57 int32_t oldline = _src_here.lineno;
58 _src_here.lineno = newline;
59 return oldline;
60}
61static inline int32_t src_get_linnum(void)
62{
63 return _src_here.lineno;
64}
H. Peter Anvin1aa79452018-12-10 23:00:10 -080065/* Can be used when there is no need for the old information */
66void src_set(int32_t line, const char *filename);
H. Peter Anvin026b62f2018-12-10 23:28:01 -080067
H. Peter Anvin1aa79452018-12-10 23:00:10 -080068/*
69 * src_get gets both the source file name and line.
70 * It is also used if you maintain private status about the source location
71 * It return 0 if the information was the same as the last time you
72 * checked, -2 if the name changed and (new-old) if just the line changed.
H. Peter Anvin026b62f2018-12-10 23:28:01 -080073 *
74 * xname must point to a filename string previously returned from any
75 * function of this subsystem or be NULL; another string value will
76 * not work.
H. Peter Anvin1aa79452018-12-10 23:00:10 -080077 */
H. Peter Anvin026b62f2018-12-10 23:28:01 -080078static inline int32_t src_get(int32_t *xline, const char **xname)
79{
80 const char *xn = *xname;
81 int32_t xl = *xline;
82
83 *xline = _src_here.lineno;
84 *xname = _src_here.filename;
85
86 /* The return value is expected to be optimized out almost everywhere */
87 if (!xn || xn != _src_here.filename)
88 return -2;
89 else
90 return _src_here.lineno - xl;
91}
92
93/*
94 * Returns and sets/returns the current information as a structure.
95 */
96static inline struct src_location src_where(void)
97{
98 return _src_here;
99}
100struct src_location src_update(struct src_location);
H. Peter Anvin1aa79452018-12-10 23:00:10 -0800101
102#endif /* ASM_SRCFILE_H */