asm/srcfile.h

   1 /* ----------------------------------------------------------------------- *
   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
  42 struct src_location {
  43     const char *filename;
  44     int32_t lineno;
  45 };
  46 extern struct src_location _src_here;
  47
  48 void src_init(void);
  49 void src_free(void);
  50 const char *src_set_fname(const char *newname);
  51 static inline const char *src_get_fname(void)
  52 {
  53     return _src_here.filename;
  54 }
  55 static 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 }
  61 static inline int32_t src_get_linnum(void)
  62 {
  63     return _src_here.lineno;
  64 }
  65
  66 /* Can be used when there is no need for the old information */
  67 void src_set(int32_t line, const char *filename);
  68
  69 /*
  70  * src_get gets both the source file name and line.
  71  * It is also used if you maintain private status about the source location
  72  * It return 0 if the information was the same as the last time you
  73  * checked, -2 if the name changed and (new-old) if just the line changed.
  74  *
  75  * xname must point to a filename string previously returned from any
  76  * function of this subsystem or be NULL; another string value will
  77  * not work.
  78  */
  79 static inline int32_t src_get(int32_t *xline, const char **xname)
  80 {
  81     const char *xn = *xname;
  82     int32_t xl = *xline;
  83
  84     *xline = _src_here.lineno;
  85     *xname = _src_here.filename;
  86
  87     /* The return value is expected to be optimized out almost everywhere */
  88     if (!xn || xn != _src_here.filename)
  89         return -2;
  90     else
  91         return _src_here.lineno - xl;
  92 }
  93
  94 /*
  95  * Returns the current information as a structure.
  96  */
  97 static inline struct src_location src_where(void)
  98 {
  99     return _src_here;
 100 }
 101
 102 /*
 103  * Sets the current information. The filename member of the structure
 104  * *must* have been previously returned by src_get(), src_where(), or
 105  * src_get_fname() and therefore be present in the hash.
 106  */
 107 static inline struct src_location src_update(struct src_location whence)
 108 {
 109     struct src_location old = _src_here;
 110     _src_here = whence;
 111     return old;
 112 }
 113
 114 #endif /* ASM_SRCFILE_H */