| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>The line position iterator</title> |
| <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../index.html" title="Spirit 2.5.2"> |
| <link rel="up" href="../support.html" title="Supporting Libraries"> |
| <link rel="prev" href="multi_pass.html" title="The multi pass iterator"> |
| <link rel="next" href="utree.html" title="The utree data structure"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="multi_pass.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="utree.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h3 class="title"> |
| <a name="spirit.support.line_pos_iterator"></a><a class="link" href="line_pos_iterator.html" title="The line position iterator">The line position iterator</a> |
| </h3></div></div></div> |
| <p> |
| The <code class="computeroutput"><span class="identifier">line_pos_iterator</span></code> is |
| a lightweight line position iterator. This iterator adapter only stores the |
| current line number, nothing else. Unlike <a href="../../../../../../libs/spirit/classic/index.html" target="_top"><span class="emphasis"><em>Spirit.Classic</em></span></a>'s |
| <code class="computeroutput"><span class="identifier">position_iterator</span></code>, it does |
| not store the column number and does not need an end iterator. The current |
| column can be computed, if needed. |
| </p> |
| <h5> |
| <a name="spirit.support.line_pos_iterator.h0"></a> |
| <span class="phrase"><a name="spirit.support.line_pos_iterator.class_reference"></a></span><a class="link" href="line_pos_iterator.html#spirit.support.line_pos_iterator.class_reference">Class |
| Reference</a> |
| </h5> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> |
| <span class="keyword">class</span> <span class="identifier">line_pos_iterator</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_adaptor</span><span class="special"><</span> |
| <span class="identifier">line_pos_iterator</span><span class="special"><</span><span class="identifier">Iterator</span><span class="special">></span> <span class="comment">// Derived</span> |
| <span class="special">,</span> <span class="identifier">Iterator</span> <span class="comment">// Base</span> |
| <span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">use_default</span> <span class="comment">// Value</span> |
| <span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">forward_traversal_tag</span> <span class="comment">// CategoryOrTraversal</span> |
| <span class="special">></span> <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="identifier">line_pos_iterator</span><span class="special">();</span> |
| |
| <span class="keyword">explicit</span> <span class="identifier">line_pos_iterator</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">);</span> |
| |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">position</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> |
| |
| <span class="keyword">private</span><span class="special">:</span> |
| <span class="keyword">friend</span> <span class="keyword">class</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_core_access</span><span class="special">;</span> |
| |
| <span class="keyword">void</span> <span class="identifier">increment</span><span class="special">();</span> |
| |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">line</span><span class="special">;</span> <span class="comment">// The line position.</span> |
| <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">Iterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="identifier">prev</span><span class="special">;</span> |
| <span class="special">};</span> |
| </pre> |
| <p> |
| </p> |
| <h5> |
| <a name="spirit.support.line_pos_iterator.h1"></a> |
| <span class="phrase"><a name="spirit.support.line_pos_iterator.get_line"></a></span><a class="link" href="line_pos_iterator.html#spirit.support.line_pos_iterator.get_line">get_line</a> |
| </h5> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> |
| <span class="keyword">inline</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">get_line</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Get the line position. Returns -1 if Iterator is not a <code class="computeroutput"><span class="identifier">line_pos_iterator</span></code>. |
| </p> |
| <h5> |
| <a name="spirit.support.line_pos_iterator.h2"></a> |
| <span class="phrase"><a name="spirit.support.line_pos_iterator.get_line_start"></a></span><a class="link" href="line_pos_iterator.html#spirit.support.line_pos_iterator.get_line_start">get_line_start</a> |
| </h5> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> |
| <span class="keyword">inline</span> <span class="identifier">Iterator</span> <span class="identifier">get_line_start</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">lower_bound</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">current</span><span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Get an iterator to the beginning of the line. Applicable to any iterator. |
| </p> |
| <h5> |
| <a name="spirit.support.line_pos_iterator.h3"></a> |
| <span class="phrase"><a name="spirit.support.line_pos_iterator.get_current_line"></a></span><a class="link" href="line_pos_iterator.html#spirit.support.line_pos_iterator.get_current_line">get_current_line</a> |
| </h5> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> |
| <span class="keyword">inline</span> <span class="identifier">iterator_range</span><span class="special"><</span><span class="identifier">Iterator</span><span class="special">></span> |
| <span class="identifier">get_current_line</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">lower_bound</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">current</span><span class="special">,</span> |
| <span class="identifier">Iterator</span> <span class="identifier">upper_bound</span><span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Get an <code class="computeroutput"><span class="identifier">iterator_range</span></code> containing |
| the current line. Applicable to any iterator. |
| </p> |
| <h5> |
| <a name="spirit.support.line_pos_iterator.h4"></a> |
| <span class="phrase"><a name="spirit.support.line_pos_iterator.get_column"></a></span><a class="link" href="line_pos_iterator.html#spirit.support.line_pos_iterator.get_column">get_column</a> |
| </h5> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">></span> |
| <span class="keyword">inline</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">get_column</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">lower_bound</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">current</span><span class="special">,</span> |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">tabs</span> <span class="special">=</span> <span class="number">4</span><span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| <p> |
| Get the current column. Applicable to any iterator. |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2001-2011 Joel de Guzman, Hartmut Kaiser<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="multi_pass.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="utree.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
