LMU/musrfit
5
1
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 4 Activity
Files
b6fac619f95a6dd7b99e4eed6682d83ef18405b9
musrfit/mupp/html/structmupp_1_1PErrorHandler.html
T
Gitea Actions b6fac619f9 Deploy site
2026-05-28 07:32:41 +00:00

402 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mupp: mupp::PErrorHandler&lt; Iterator &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">mupp<span id="projectnumber">&#160;1.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemupp.html">mupp</a></li><li class="navelem"><a class="el" href="structmupp_1_1PErrorHandler.html">PErrorHandler</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmupp_1_1PErrorHandler-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">mupp::PErrorHandler&lt; Iterator &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="structmupp_1_1PErrorHandler.html" title="The PErrorHandler struct handles parsing and semantic errors.">PErrorHandler</a> struct handles parsing and semantic errors.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a37e1baa7a580a689c8c013d32a33f932" id="r_a37e1baa7a580a689c8c013d32a33f932"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37e1baa7a580a689c8c013d32a33f932">PErrorHandler</a> (Iterator <a class="el" href="#abef94a94b04b8524da968c2109aab423">first</a>, Iterator <a class="el" href="#a99a174a2631cbdd1fa97e5c34e09cc31">last</a>)</td></tr>
<tr class="memdesc:a37e1baa7a580a689c8c013d32a33f932"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that stores the source code range. <br /></td></tr>
<tr class="separator:a37e1baa7a580a689c8c013d32a33f932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f304f4663bf029678cb35a595305f87" id="r_a6f304f4663bf029678cb35a595305f87"><td class="memTemplParams" colspan="2">template&lt;typename Message, typename What&gt; </td></tr>
<tr class="memitem:a6f304f4663bf029678cb35a595305f87"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6f304f4663bf029678cb35a595305f87">operator()</a> (Message const &amp;message, What const &amp;what, Iterator err_pos) const</td></tr>
<tr class="memdesc:a6f304f4663bf029678cb35a595305f87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function call operator that logs an error to file. <br /></td></tr>
<tr class="separator:a6f304f4663bf029678cb35a595305f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a376bdcfc156a4b6d715e6b09dd3cd9e5" id="r_a376bdcfc156a4b6d715e6b09dd3cd9e5"><td class="memItemLeft" align="right" valign="top">Iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a376bdcfc156a4b6d715e6b09dd3cd9e5">get_pos</a> (Iterator err_pos, int &amp;line) const</td></tr>
<tr class="memdesc:a376bdcfc156a4b6d715e6b09dd3cd9e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the start of the line containing an error and computes line number. <br /></td></tr>
<tr class="separator:a376bdcfc156a4b6d715e6b09dd3cd9e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d9679eed2560b8859f07f411611354" id="r_aa1d9679eed2560b8859f07f411611354"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1d9679eed2560b8859f07f411611354">get_line</a> (Iterator err_pos) const</td></tr>
<tr class="memdesc:aa1d9679eed2560b8859f07f411611354"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the complete line containing an error. <br /></td></tr>
<tr class="separator:aa1d9679eed2560b8859f07f411611354"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abef94a94b04b8524da968c2109aab423" id="r_abef94a94b04b8524da968c2109aab423"><td class="memItemLeft" align="right" valign="top">Iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abef94a94b04b8524da968c2109aab423">first</a></td></tr>
<tr class="memdesc:abef94a94b04b8524da968c2109aab423"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator to the beginning of the source code. <br /></td></tr>
<tr class="separator:abef94a94b04b8524da968c2109aab423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99a174a2631cbdd1fa97e5c34e09cc31" id="r_a99a174a2631cbdd1fa97e5c34e09cc31"><td class="memItemLeft" align="right" valign="top">Iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a99a174a2631cbdd1fa97e5c34e09cc31">last</a></td></tr>
<tr class="memdesc:a99a174a2631cbdd1fa97e5c34e09cc31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator to the end of the source code. <br /></td></tr>
<tr class="separator:a99a174a2631cbdd1fa97e5c34e09cc31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f9f19bff3b3166e2631fb2dd6ea3bf" id="r_a39f9f19bff3b3166e2631fb2dd6ea3bf"><td class="memItemLeft" align="right" valign="top">std::vector&lt; Iterator &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a39f9f19bff3b3166e2631fb2dd6ea3bf">iters</a></td></tr>
<tr class="memdesc:a39f9f19bff3b3166e2631fb2dd6ea3bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector mapping AST node IDs to source positions (used by <a class="el" href="structmupp_1_1PAnnotation.html" title="The PAnnotation struct links AST nodes to source code positions.">PAnnotation</a>) <br /></td></tr>
<tr class="separator:a39f9f19bff3b3166e2631fb2dd6ea3bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Iterator&gt;<br />
struct mupp::PErrorHandler&lt; Iterator &gt;</div><p>The <a class="el" href="structmupp_1_1PErrorHandler.html" title="The PErrorHandler struct handles parsing and semantic errors.">PErrorHandler</a> struct handles parsing and semantic errors. </p>
<p>This error handler logs detailed error information to a file, including the error message, line number, source line, and a visual pointer to the error position. It integrates with the Boost.Spirit X3 parser error handling mechanism and works in conjunction with the <a class="el" href="structmupp_1_1PAnnotation.html" title="The PAnnotation struct links AST nodes to source code positions.">PAnnotation</a> handler to map AST node IDs back to source positions.</p>
<p>Errors are appended to: ~/.musrfit/mupp/mupp_err.log</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Iterator</td><td>the iterator type for the source code (typically std::string::const_iterator) </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00059">59</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a37e1baa7a580a689c8c013d32a33f932" name="a37e1baa7a580a689c8c013d32a33f932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37e1baa7a580a689c8c013d32a33f932">&#9670;&#160;</a></span>PErrorHandler()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::PErrorHandler </td>
<td>(</td>
<td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>last</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that stores the source code range. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>iterator pointing to the beginning of the source code </td></tr>
<tr><td class="paramname">last</td><td>iterator pointing to the end of the source code </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00067">67</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa1d9679eed2560b8859f07f411611354" name="aa1d9679eed2560b8859f07f411611354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1d9679eed2560b8859f07f411611354">&#9670;&#160;</a></span>get_line()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::get_line </td>
<td>(</td>
<td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>err_pos</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the complete line containing an error. </p>
<p>Returns the substring from the start of the line to the next line break.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err_pos</td><td>iterator pointing to the start of the line </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string containing the complete line (without line break characters) </dd></dl>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00149">149</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<a id="a376bdcfc156a4b6d715e6b09dd3cd9e5" name="a376bdcfc156a4b6d715e6b09dd3cd9e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a376bdcfc156a4b6d715e6b09dd3cd9e5">&#9670;&#160;</a></span>get_pos()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Iterator <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::get_pos </td>
<td>(</td>
<td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>err_pos</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int &amp;</td> <td class="paramname"><span class="paramname"><em>line</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the start of the line containing an error and computes line number. </p>
<p>Scans from the beginning of the source to the error position, counting line breaks (CR, LF, or CRLF) to determine the line number.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err_pos</td><td>iterator pointing to the error position </td></tr>
<tr><td class="paramname">line</td><td>output parameter that will contain the 1-based line number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>iterator pointing to the start of the line containing the error </dd></dl>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00118">118</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<a id="a6f304f4663bf029678cb35a595305f87" name="a6f304f4663bf029678cb35a595305f87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f304f4663bf029678cb35a595305f87">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<div class="memtemplate">
template&lt;typename Message, typename What&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Message const &amp;</td> <td class="paramname"><span class="paramname"><em>message</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">What const &amp;</td> <td class="paramname"><span class="paramname"><em>what</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>err_pos</em></span>&#160;) const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function call operator that logs an error to file. </p>
<p>Determines the line number and position of the error, formats a user-friendly error message with a visual indicator (^~~), and appends it to the error log file. Handles both mid-file errors and unexpected end-of-file errors.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Message</td><td>the message type (typically std::string) </td></tr>
<tr><td class="paramname">What</td><td>the expected element type (typically std::string) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>the error message prefix (e.g., "**ERROR** Expecting ") </td></tr>
<tr><td class="paramname">what</td><td>description of what was expected at the error position </td></tr>
<tr><td class="paramname">err_pos</td><td>iterator pointing to the position where the error occurred </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00085">85</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abef94a94b04b8524da968c2109aab423" name="abef94a94b04b8524da968c2109aab423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef94a94b04b8524da968c2109aab423">&#9670;&#160;</a></span>first</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="memname">
<tr>
<td class="memname">Iterator <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::first</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterator to the beginning of the source code. </p>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00158">158</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<a id="a39f9f19bff3b3166e2631fb2dd6ea3bf" name="a39f9f19bff3b3166e2631fb2dd6ea3bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39f9f19bff3b3166e2631fb2dd6ea3bf">&#9670;&#160;</a></span>iters</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::vector&lt;Iterator&gt; <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::iters</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector mapping AST node IDs to source positions (used by <a class="el" href="structmupp_1_1PAnnotation.html" title="The PAnnotation struct links AST nodes to source code positions.">PAnnotation</a>) </p>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00160">160</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<a id="a99a174a2631cbdd1fa97e5c34e09cc31" name="a99a174a2631cbdd1fa97e5c34e09cc31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99a174a2631cbdd1fa97e5c34e09cc31">&#9670;&#160;</a></span>last</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Iterator&gt; </div>
<table class="memname">
<tr>
<td class="memname">Iterator <a class="el" href="structmupp_1_1PErrorHandler.html">mupp::PErrorHandler</a>&lt; Iterator &gt;::last</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterator to the end of the source code. </p>
<p class="definition">Definition at line <a class="el" href="PErrorHandler_8hpp_source.html#l00159">159</a> of file <a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/workspace/LMU/musrfit/src/musredit_qt6/mupp/var/include/<a class="el" href="PErrorHandler_8hpp_source.html">PErrorHandler.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink