/usr/share/doc/bison-doc/html/Java-Location-Values.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 
This manual (22 January 2015) is for GNU Bison (version
3.0.4), the GNU parser generator.

Copyright (C) 1988-1993, 1995, 1998-2015 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover texts
being "A GNU Manual," and with the Back-Cover Texts as in
(a) below.  A copy of the license is included in the section entitled
"GNU Free Documentation License."

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF
supports it in developing GNU and promoting software
freedom." -->
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Bison 3.0.4: Java Location Values</title>

<meta name="description" content="Bison 3.0.4: Java Location Values">
<meta name="keywords" content="Bison 3.0.4: Java Location Values">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-of-Terms.html#Index-of-Terms" rel="index" title="Index of Terms">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Java-Parsers.html#Java-Parsers" rel="up" title="Java Parsers">
<link href="Java-Parser-Interface.html#Java-Parser-Interface" rel="next" title="Java Parser Interface">
<link href="Java-Semantic-Values.html#Java-Semantic-Values" rel="prev" title="Java Semantic Values">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Java-Location-Values"></a>
<div class="header">
<p>
Next: <a href="Java-Parser-Interface.html#Java-Parser-Interface" accesskey="n" rel="next">Java Parser Interface</a>, Previous: <a href="Java-Semantic-Values.html#Java-Semantic-Values" accesskey="p" rel="prev">Java Semantic Values</a>, Up: <a href="Java-Parsers.html#Java-Parsers" accesskey="u" rel="up">Java Parsers</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index-of-Terms.html#Index-of-Terms" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Java-Location-Values-1"></a>
<h4 class="subsection">10.2.3 Java Location Values</h4>

<p>When the directive <code>%locations</code> is used, the Java parser supports
location tracking, see <a href="Tracking-Locations.html#Tracking-Locations">Tracking Locations</a>.  An auxiliary user-defined
class defines a <em>position</em>, a single point in a file; Bison itself
defines a class representing a <em>location</em>, a range composed of a pair of
positions (possibly spanning several files).  The location class is an inner
class of the parser; the name is <code>Location</code> by default, and may also be
renamed using <code>%define api.location.type {<var>class-name</var>}</code>.
</p>
<p>The location class treats the position as a completely opaque value.
By default, the class name is <code>Position</code>, but this can be changed
with <code>%define api.position.type {<var>class-name</var>}</code>.  This class must
be supplied by the user.
</p>

<dl>
<dt><a name="index-begin-of-Location"></a>Instance Variable of Location: <em>Position</em> <strong>begin</strong></dt>
<dt><a name="index-end-of-Location"></a>Instance Variable of Location: <em>Position</em> <strong>end</strong></dt>
<dd><p>The first, inclusive, position of the range, and the first beyond.
</p></dd></dl>

<dl>
<dt><a name="index-Location-on-Location"></a>Constructor on Location: <em></em> <strong>Location</strong> <em>(Position <var>loc</var>)</em></dt>
<dd><p>Create a <code>Location</code> denoting an empty range located at a given point.
</p></dd></dl>

<dl>
<dt><a name="index-Location-on-Location-1"></a>Constructor on Location: <em></em> <strong>Location</strong> <em>(Position <var>begin</var>, Position <var>end</var>)</em></dt>
<dd><p>Create a <code>Location</code> from the endpoints of the range.
</p></dd></dl>

<dl>
<dt><a name="index-toString-on-Location"></a>Method on Location: <em>String</em> <strong>toString</strong> <em>()</em></dt>
<dd><p>Prints the range represented by the location.  For this to work
properly, the position class should override the <code>equals</code> and
<code>toString</code> methods appropriately.
</p></dd></dl>





</body>
</html>
bison-doc 1:3.0.4-1 / usr / share / doc / bison-doc / html / Java-Location-Values.html
