src/location.h

/* Locations for Bison

   Copyright (C) 2002, 2004-2013 Free Software Foundation, Inc.

   This file is part of Bison, the GNU Compiler Compiler.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef LOCATION_H_
# define LOCATION_H_

# include <stdbool.h>
# include <stdio.h>
# include <string.h> /* strcmp */

# include "uniqstr.h"

/* A boundary between two characters.  */
typedef struct
{
  /* The name of the file that contains the boundary.  */
  uniqstr file;

  /* If nonnegative, the (origin-1) line that contains the boundary.
     If this is INT_MAX, the line number has overflowed.

     Meaningless and not displayed if negative.
  */
  int line;

  /* If nonnegative, the (origin-1) column just after the boundary.
     This is neither a byte count, nor a character count; it is a
     column count.  If this is INT_MAX, the column number has
     overflowed.

     Meaningless and not displayed if negative.
  */
  int column;

} boundary;

/* Set the position of \a a. */
static inline void
boundary_set (boundary *b, const char *f, int l, int c)
{
  b->file = f;
  b->line = l;
  b->column = c;
}

/* Return -1, 0, 1, depending whether a is before, equal, or
   after b.  */
static inline int
boundary_cmp (boundary a, boundary b)
{
  int res = strcmp (a.file, b.file);
  if (!res)
    res = a.line - b.line;
  if (!res)
    res = a.column - b.column;
  return res;
}

/* Return nonzero if A and B are equal boundaries.  */
static inline bool
equal_boundaries (boundary a, boundary b)
{
  return (a.column == b.column
          && a.line == b.line
          && UNIQSTR_EQ (a.file, b.file));
}

/* A location, that is, a region of source code.  */
typedef struct
{
  /* Boundary just before the location starts.  */
  boundary start;

  /* Boundary just after the location ends.  */
  boundary end;

} location;

# define GRAM_LTYPE location

# define EMPTY_LOCATION_INIT {{NULL, 0, 0}, {NULL, 0, 0}}
extern location const empty_location;

/* Set *LOC and adjust scanner cursor to account for token TOKEN of
   size SIZE.  */
void location_compute (location *loc,
                       boundary *cur, char const *token, size_t size);

/* Print location to file.
   Return number of actually printed characters.
   Warning: uses quotearg's slot 3. */
unsigned location_print (location loc, FILE *out);

/* Free any allocated ressources and close any open file handles that are
   left-over by the usage of location_caret.  */
void cleanup_caret (void);

/* Output to OUT the line and caret corresponding to location LOC.  */
void location_caret (location loc, FILE *out);

/* Return -1, 0, 1, depending whether a is before, equal, or
   after b.  */
static inline int
location_cmp (location a, location b)
{
  int res = boundary_cmp (a.start, b.start);
  if (!res)
    res = boundary_cmp (a.end, b.end);
  return res;
}

/* LOC_STR must be formatted as 'file:line.column', it will be modified.  */
void boundary_set_from_string (boundary *bound, char *loc_str);

#endif /* ! defined LOCATION_H_ */
Commit	Line	Data
	1	/* Locations for Bison
	2
	3	Copyright (C) 2002, 2004-2013 Free Software Foundation, Inc.
	4
	5	This file is part of Bison, the GNU Compiler Compiler.
	6
	7	This program is free software: you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation, either version 3 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	19
	20	#ifndef LOCATION_H_
	21	# define LOCATION_H_
	22
	23	# include <stdbool.h>
	24	# include <stdio.h>
	25	# include <string.h> /* strcmp */
	26
	27	# include "uniqstr.h"
	28
	29	/* A boundary between two characters. */
	30	typedef struct
	31	{
	32	/* The name of the file that contains the boundary. */
	33	uniqstr file;
	34
	35	/* If nonnegative, the (origin-1) line that contains the boundary.
	36	If this is INT_MAX, the line number has overflowed.
	37
	38	Meaningless and not displayed if negative.
	39	*/
	40	int line;
	41
	42	/* If nonnegative, the (origin-1) column just after the boundary.
	43	This is neither a byte count, nor a character count; it is a
	44	column count. If this is INT_MAX, the column number has
	45	overflowed.
	46
	47	Meaningless and not displayed if negative.
	48	*/
	49	int column;
	50
	51	} boundary;
	52
	53	/* Set the position of \a a. */
	54	static inline void
	55	boundary_set (boundary b, const char f, int l, int c)
	56	{
	57	b->file = f;
	58	b->line = l;
	59	b->column = c;
	60	}
	61
	62	/* Return -1, 0, 1, depending whether a is before, equal, or
	63	after b. */
	64	static inline int
	65	boundary_cmp (boundary a, boundary b)
	66	{
	67	int res = strcmp (a.file, b.file);
	68	if (!res)
	69	res = a.line - b.line;
	70	if (!res)
	71	res = a.column - b.column;
	72	return res;
	73	}
	74
	75	/* Return nonzero if A and B are equal boundaries. */
	76	static inline bool
	77	equal_boundaries (boundary a, boundary b)
	78	{
	79	return (a.column == b.column
	80	&& a.line == b.line
	81	&& UNIQSTR_EQ (a.file, b.file));
	82	}
	83
	84	/* A location, that is, a region of source code. */
	85	typedef struct
	86	{
	87	/* Boundary just before the location starts. */
	88	boundary start;
	89
	90	/* Boundary just after the location ends. */
	91	boundary end;
	92
	93	} location;
	94
	95	# define GRAM_LTYPE location
	96
	97	# define EMPTY_LOCATION_INIT {{NULL, 0, 0}, {NULL, 0, 0}}
	98	extern location const empty_location;
	99
	100	/* Set *LOC and adjust scanner cursor to account for token TOKEN of
	101	size SIZE. */
	102	void location_compute (location *loc,
	103	boundary cur, char const token, size_t size);
	104
	105	/* Print location to file.
	106	Return number of actually printed characters.
	107	Warning: uses quotearg's slot 3. */
	108	unsigned location_print (location loc, FILE *out);
	109
	110	/* Free any allocated ressources and close any open file handles that are
	111	left-over by the usage of location_caret. */
	112	void cleanup_caret (void);
	113
	114	/* Output to OUT the line and caret corresponding to location LOC. */
	115	void location_caret (location loc, FILE *out);
	116
	117	/* Return -1, 0, 1, depending whether a is before, equal, or
	118	after b. */
	119	static inline int
	120	location_cmp (location a, location b)
	121	{
	122	int res = boundary_cmp (a.start, b.start);
	123	if (!res)
	124	res = boundary_cmp (a.end, b.end);
	125	return res;
	126	}
	127
	128	/* LOC_STR must be formatted as 'file:line.column', it will be modified. */
	129	void boundary_set_from_string (boundary bound, char loc_str);
	130
	131	#endif /* ! defined LOCATION_H_ */