src/location.h

/* Locations for Bison
   Copyright (C) 2002, 2004-2010 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 "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 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 YYLTYPE 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);

void location_print (FILE *out, location loc);

/* 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	Copyright (C) 2002, 2004-2010 Free Software Foundation, Inc.
	3
	4	This file is part of Bison, the GNU Compiler Compiler.
	5
	6	This program is free software: you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation, either version 3 of the License, or
	9	(at your option) any later version.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	18
	19	#ifndef LOCATION_H_
	20	# define LOCATION_H_
	21
	22	# include "uniqstr.h"
	23
	24	/* A boundary between two characters. */
	25	typedef struct
	26	{
	27	/* The name of the file that contains the boundary. */
	28	uniqstr file;
	29
	30	/* If nonnegative, the (origin-1) line that contains the boundary.
	31	If this is INT_MAX, the line number has overflowed.
	32
	33	Meaningless and not displayed if negative.
	34	*/
	35	int line;
	36
	37	/* If nonnegative, the (origin-1) column just after the boundary.
	38	This is neither a byte count, nor a character count; it is a
	39	column count. If this is INT_MAX, the column number has
	40	overflowed.
	41
	42	Meaningless and not displayed if negative.
	43	*/
	44	int column;
	45
	46	} boundary;
	47
	48	/* Set the position of \a a. */
	49	static inline void
	50	boundary_set (boundary b, const char f, int l, int c)
	51	{
	52	b->file = f;
	53	b->line = l;
	54	b->column = c;
	55	}
	56
	57	/* Return nonzero if A and B are equal boundaries. */
	58	static inline bool
	59	equal_boundaries (boundary a, boundary b)
	60	{
	61	return (a.column == b.column
	62	&& a.line == b.line
	63	&& UNIQSTR_EQ (a.file, b.file));
	64	}
	65
	66	/* A location, that is, a region of source code. */
	67	typedef struct
	68	{
	69	/* Boundary just before the location starts. */
	70	boundary start;
	71
	72	/* Boundary just after the location ends. */
	73	boundary end;
	74
	75	} location;
	76
	77	#define YYLTYPE location
	78
	79	#define EMPTY_LOCATION_INIT {{NULL, 0, 0}, {NULL, 0, 0}}
	80	extern location const empty_location;
	81
	82	/* Set *LOC and adjust scanner cursor to account for token TOKEN of
	83	size SIZE. */
	84	void location_compute (location *loc,
	85	boundary cur, char const token, size_t size);
	86
	87	void location_print (FILE *out, location loc);
	88
	89	/* LOC_STR must be formatted as `file:line.column', it will be modified. */
	90	void boundary_set_from_string (boundary bound, char loc_str);
	91
	92	#endif /* ! defined LOCATION_H_ */