XQuilla/docs/simple-api/XQException_8hpp_source.html
2020-02-17 22:24:47 +01:00

126 lines
19 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_e3266bbc227f825a287bdb912a8a79c0.html">include</a></li><li class="navelem"><a class="el" href="dir_a1bc92396ffc8a3dc7aa16f9f9aed8c7.html">xqilla</a></li><li class="navelem"><a class="el" href="dir_7d7a68009c713f027cda8b1a802087bf.html">exceptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">XQException.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="XQException_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2001, 2008,</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * DecisionSoft Limited. All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef XQEXCEPTION_HPP</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define XQEXCEPTION_HPP</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;xqilla/framework/XQillaExport.hpp&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;xqilla/utils/XStr.hpp&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="XQException_8hpp.html#a507a2ba7ec1efdf595885497d7f68c56"> 26</a></span>&#160;<span class="preprocessor">#define XQThrow(type, function, reason) throw type(function, reason, this, __FILE__, __LINE__)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="XQException_8hpp.html#a327d5c87a463e2d8c3a930186c36fee3"> 27</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define XQThrow2(type, function, reason) throw type(function, reason, 0, __FILE__, __LINE__)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="XQException_8hpp.html#a832e1a1e3c37d9a3067737602af496a0"> 28</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define XQThrow3(type, function, reason, location) throw type(function, reason, location, __FILE__, __LINE__)</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="XQException_8hpp.html#aebd782793874e0428b04b72bc8cff2e0"> 29</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define XQSimpleThrow(reason, xqfile, xqline, xqcolumn) throw XQException(reason, xqfile, xqline, (unsigned int)xqcolumn, __FILE__, __LINE__)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">class </span><a class="code" href="classLocationInfo.html">LocationInfo</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classXQException.html"> 33</a></span>&#160;<span class="keyword">class </span>XQILLA_API <a class="code" href="classXQException.html">XQException</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classXQException.html">XQException</a>(<span class="keyword">const</span> XMLCh *reason, <span class="keyword">const</span> XMLCh* file, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> line, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> column, <span class="keyword">const</span> <span class="keywordtype">char</span> *cppFile, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cppLine);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classXQException.html">XQException</a>(<span class="keyword">const</span> <a class="code" href="classXQException.html">XQException</a> &amp;);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classXQException.html">XQException</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classXQException.html#a97b3a891dbe6de394bba1ba8f7dd1a74"> 40</a></span>&#160; <span class="keyword">const</span> XMLCh *<a class="code" href="classXQException.html#a97b3a891dbe6de394bba1ba8f7dd1a74">getType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> type_; }</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classXQException.html#ade1b990b979052f61f5a24ee3a923003"> 41</a></span>&#160; <span class="keyword">const</span> XMLCh *<a class="code" href="classXQException.html#ade1b990b979052f61f5a24ee3a923003">getError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> error_; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classXQException.html#af0a00b7b0682584ce2fa39618c878658"> 43</a></span>&#160; <span class="keyword">const</span> XMLCh *<a class="code" href="classXQException.html#af0a00b7b0682584ce2fa39618c878658">getXQueryFile</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xqFile_; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classXQException.html#a752d40f94b150e6a9b1e0d2a1b785c64"> 44</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classXQException.html#a752d40f94b150e6a9b1e0d2a1b785c64">getXQueryLine</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xqLine_; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classXQException.html#a3b08206a47f7f7784222d2f1065d5fe6"> 45</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classXQException.html#a3b08206a47f7f7784222d2f1065d5fe6">getXQueryColumn</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xqColumn_; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> setXQueryPosition(<span class="keyword">const</span> XMLCh *file, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> line, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> column);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> setXQueryPosition(<span class="keyword">const</span> <a class="code" href="classLocationInfo.html">LocationInfo</a> *info);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classXQException.html#abfd512896e7648c5e699736d34df16bb"> 50</a></span>&#160; <span class="keyword">const</span> XMLCh *<a class="code" href="classXQException.html#abfd512896e7648c5e699736d34df16bb">getCppFunction</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cppFunction_; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classXQException.html#aa7e77546ff02de470310fbe2ec15affe"> 51</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classXQException.html#aa7e77546ff02de470310fbe2ec15affe">getCppFile</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cppFile_; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classXQException.html#a62118633b07d9e474f887c6196220dae"> 52</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classXQException.html#a62118633b07d9e474f887c6196220dae">getCppLine</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> cppLine_; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> printDebug(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> context) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classXQException.html">XQException</a>(<span class="keyword">const</span> XMLCh* <span class="keyword">const</span> type, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> functionName, <span class="keyword">const</span> XMLCh* <span class="keyword">const</span> reason, <span class="keyword">const</span> <a class="code" href="classLocationInfo.html">LocationInfo</a> *info, <span class="keyword">const</span> <span class="keywordtype">char</span> *cppFile, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cppLine);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="classXQException.html">XQException</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classXQException.html">XQException</a> &amp;);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; XMLCh* type_;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; XMLCh* error_;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; XMLCh* cppFunction_;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *cppFile_;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cppLine_;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> xqLine_, xqColumn_;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; XMLCh* xqFile_;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="classXQException_html_af0a00b7b0682584ce2fa39618c878658"><div class="ttname"><a href="classXQException.html#af0a00b7b0682584ce2fa39618c878658">XQException::getXQueryFile</a></div><div class="ttdeci">const XMLCh * getXQueryFile() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:43</div></div>
<div class="ttc" id="classXQException_html_ade1b990b979052f61f5a24ee3a923003"><div class="ttname"><a href="classXQException.html#ade1b990b979052f61f5a24ee3a923003">XQException::getError</a></div><div class="ttdeci">const XMLCh * getError() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:41</div></div>
<div class="ttc" id="classXQException_html_aa7e77546ff02de470310fbe2ec15affe"><div class="ttname"><a href="classXQException.html#aa7e77546ff02de470310fbe2ec15affe">XQException::getCppFile</a></div><div class="ttdeci">const char * getCppFile() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:51</div></div>
<div class="ttc" id="classXQException_html_a3b08206a47f7f7784222d2f1065d5fe6"><div class="ttname"><a href="classXQException.html#a3b08206a47f7f7784222d2f1065d5fe6">XQException::getXQueryColumn</a></div><div class="ttdeci">unsigned int getXQueryColumn() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:45</div></div>
<div class="ttc" id="classXQException_html"><div class="ttname"><a href="classXQException.html">XQException</a></div><div class="ttdef"><b>Definition:</b> XQException.hpp:33</div></div>
<div class="ttc" id="classXQException_html_a62118633b07d9e474f887c6196220dae"><div class="ttname"><a href="classXQException.html#a62118633b07d9e474f887c6196220dae">XQException::getCppLine</a></div><div class="ttdeci">unsigned int getCppLine() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:52</div></div>
<div class="ttc" id="classXQException_html_a97b3a891dbe6de394bba1ba8f7dd1a74"><div class="ttname"><a href="classXQException.html#a97b3a891dbe6de394bba1ba8f7dd1a74">XQException::getType</a></div><div class="ttdeci">const XMLCh * getType() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:40</div></div>
<div class="ttc" id="classXQException_html_abfd512896e7648c5e699736d34df16bb"><div class="ttname"><a href="classXQException.html#abfd512896e7648c5e699736d34df16bb">XQException::getCppFunction</a></div><div class="ttdeci">const XMLCh * getCppFunction() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:50</div></div>
<div class="ttc" id="classLocationInfo_html"><div class="ttname"><a href="classLocationInfo.html">LocationInfo</a></div><div class="ttdoc">A class that gives records a location in the query. </div><div class="ttdef"><b>Definition:</b> LocationInfo.hpp:29</div></div>
<div class="ttc" id="classXQException_html_a752d40f94b150e6a9b1e0d2a1b785c64"><div class="ttname"><a href="classXQException.html#a752d40f94b150e6a9b1e0d2a1b785c64">XQException::getXQueryLine</a></div><div class="ttdeci">unsigned int getXQueryLine() const </div><div class="ttdef"><b>Definition:</b> XQException.hpp:44</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>