src/location.h

/* Locations for Bison
   Copyright (C) 2002, 2004, 2005, 2006 Free Software Foundation, Inc.

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

   Bison 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 2, or (at your option)
   any later version.

   Bison 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 Bison; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.  */

#ifndef LOCATION_H_
# define LOCATION_H_

# include <stdbool.h>
# include "uniqstr.h"

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

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

  /* 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.  */
  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

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);

#endif /* ! defined LOCATION_H_ */
Commit	Line	Data
	1	/* Locations for Bison
	2	Copyright (C) 2002, 2004, 2005, 2006 Free Software Foundation, Inc.
	3
	4	This file is part of Bison, the GNU Compiler Compiler.
	5
	6	Bison 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 2, or (at your option)
	9	any later version.
	10
	11	Bison 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 Bison; see the file COPYING. If not, write to
	18	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	19	Boston, MA 02110-1301, USA. */
	20
	21	#ifndef LOCATION_H_
	22	# define LOCATION_H_
	23
	24	# include <stdbool.h>
	25	# include "uniqstr.h"
	26
	27	/* A boundary between two characters. */
	28	typedef struct
	29	{
	30	/* The name of the file that contains the boundary. */
	31	uniqstr file;
	32
	33	/* The (origin-1) line that contains the boundary.
	34	If this is INT_MAX, the line number has overflowed. */
	35	int line;
	36
	37	/* The (origin-1) column just after the boundary. This is neither a
	38	byte count, nor a character count; it is a column count.
	39	If this is INT_MAX, the column number has overflowed. */
	40	int column;
	41
	42	} boundary;
	43
	44	/* Set the position of \a a. */
	45	static inline void
	46	boundary_set (boundary b, const char f, int l, int c)
	47	{
	48	b->file = f;
	49	b->line = l;
	50	b->column = c;
	51	}
	52
	53	/* Return nonzero if A and B are equal boundaries. */
	54	static inline bool
	55	equal_boundaries (boundary a, boundary b)
	56	{
	57	return (a.column == b.column
	58	&& a.line == b.line
	59	&& UNIQSTR_EQ (a.file, b.file));
	60	}
	61
	62	/* A location, that is, a region of source code. */
	63	typedef struct
	64	{
	65	/* Boundary just before the location starts. */
	66	boundary start;
	67
	68	/* Boundary just after the location ends. */
	69	boundary end;
	70
	71	} location;
	72
	73	#define YYLTYPE location
	74
	75	extern location const empty_location;
	76
	77	/* Set *LOC and adjust scanner cursor to account for token TOKEN of
	78	size SIZE. */
	79	void location_compute (location *loc,
	80	boundary cur, char const token, size_t size);
	81
	82	void location_print (FILE *out, location loc);
	83
	84	#endif /* ! defined LOCATION_H_ */