mirror of
https://github.com/TREX-CoE/qmckl.git
synced 2024-11-03 20:54:09 +01:00
763 lines
26 KiB
HTML
763 lines
26 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<!-- 2023-03-09 Thu 10:03 -->
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>Error handling</title>
|
|
<meta name="generator" content="Org mode" />
|
|
<meta name="author" content="TREX CoE" />
|
|
<style type="text/css">
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
.title { text-align: center;
|
|
margin-bottom: .2em; }
|
|
.subtitle { text-align: center;
|
|
font-size: medium;
|
|
font-weight: bold;
|
|
margin-top:0; }
|
|
.todo { font-family: monospace; color: red; }
|
|
.done { font-family: monospace; color: green; }
|
|
.priority { font-family: monospace; color: orange; }
|
|
.tag { background-color: #eee; font-family: monospace;
|
|
padding: 2px; font-size: 80%; font-weight: normal; }
|
|
.timestamp { color: #bebebe; }
|
|
.timestamp-kwd { color: #5f9ea0; }
|
|
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
|
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
|
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
|
.underline { text-decoration: underline; }
|
|
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
|
p.verse { margin-left: 3%; }
|
|
pre {
|
|
border: 1px solid #ccc;
|
|
box-shadow: 3px 3px 3px #eee;
|
|
padding: 8pt;
|
|
font-family: monospace;
|
|
overflow: auto;
|
|
margin: 1.2em;
|
|
}
|
|
pre.src {
|
|
position: relative;
|
|
overflow: visible;
|
|
padding-top: 1.2em;
|
|
}
|
|
pre.src:before {
|
|
display: none;
|
|
position: absolute;
|
|
background-color: white;
|
|
top: -10px;
|
|
right: 10px;
|
|
padding: 3px;
|
|
border: 1px solid black;
|
|
}
|
|
pre.src:hover:before { display: inline;}
|
|
/* Languages per Org manual */
|
|
pre.src-asymptote:before { content: 'Asymptote'; }
|
|
pre.src-awk:before { content: 'Awk'; }
|
|
pre.src-C:before { content: 'C'; }
|
|
/* pre.src-C++ doesn't work in CSS */
|
|
pre.src-clojure:before { content: 'Clojure'; }
|
|
pre.src-css:before { content: 'CSS'; }
|
|
pre.src-D:before { content: 'D'; }
|
|
pre.src-ditaa:before { content: 'ditaa'; }
|
|
pre.src-dot:before { content: 'Graphviz'; }
|
|
pre.src-calc:before { content: 'Emacs Calc'; }
|
|
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
|
pre.src-fortran:before { content: 'Fortran'; }
|
|
pre.src-gnuplot:before { content: 'gnuplot'; }
|
|
pre.src-haskell:before { content: 'Haskell'; }
|
|
pre.src-hledger:before { content: 'hledger'; }
|
|
pre.src-java:before { content: 'Java'; }
|
|
pre.src-js:before { content: 'Javascript'; }
|
|
pre.src-latex:before { content: 'LaTeX'; }
|
|
pre.src-ledger:before { content: 'Ledger'; }
|
|
pre.src-lisp:before { content: 'Lisp'; }
|
|
pre.src-lilypond:before { content: 'Lilypond'; }
|
|
pre.src-lua:before { content: 'Lua'; }
|
|
pre.src-matlab:before { content: 'MATLAB'; }
|
|
pre.src-mscgen:before { content: 'Mscgen'; }
|
|
pre.src-ocaml:before { content: 'Objective Caml'; }
|
|
pre.src-octave:before { content: 'Octave'; }
|
|
pre.src-org:before { content: 'Org mode'; }
|
|
pre.src-oz:before { content: 'OZ'; }
|
|
pre.src-plantuml:before { content: 'Plantuml'; }
|
|
pre.src-processing:before { content: 'Processing.js'; }
|
|
pre.src-python:before { content: 'Python'; }
|
|
pre.src-R:before { content: 'R'; }
|
|
pre.src-ruby:before { content: 'Ruby'; }
|
|
pre.src-sass:before { content: 'Sass'; }
|
|
pre.src-scheme:before { content: 'Scheme'; }
|
|
pre.src-screen:before { content: 'Gnu Screen'; }
|
|
pre.src-sed:before { content: 'Sed'; }
|
|
pre.src-sh:before { content: 'shell'; }
|
|
pre.src-sql:before { content: 'SQL'; }
|
|
pre.src-sqlite:before { content: 'SQLite'; }
|
|
/* additional languages in org.el's org-babel-load-languages alist */
|
|
pre.src-forth:before { content: 'Forth'; }
|
|
pre.src-io:before { content: 'IO'; }
|
|
pre.src-J:before { content: 'J'; }
|
|
pre.src-makefile:before { content: 'Makefile'; }
|
|
pre.src-maxima:before { content: 'Maxima'; }
|
|
pre.src-perl:before { content: 'Perl'; }
|
|
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
|
pre.src-scala:before { content: 'Scala'; }
|
|
pre.src-shell:before { content: 'Shell Script'; }
|
|
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
|
/* additional language identifiers per "defun org-babel-execute"
|
|
in ob-*.el */
|
|
pre.src-cpp:before { content: 'C++'; }
|
|
pre.src-abc:before { content: 'ABC'; }
|
|
pre.src-coq:before { content: 'Coq'; }
|
|
pre.src-groovy:before { content: 'Groovy'; }
|
|
/* additional language identifiers from org-babel-shell-names in
|
|
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
|
the execution function name together. */
|
|
pre.src-bash:before { content: 'bash'; }
|
|
pre.src-csh:before { content: 'csh'; }
|
|
pre.src-ash:before { content: 'ash'; }
|
|
pre.src-dash:before { content: 'dash'; }
|
|
pre.src-ksh:before { content: 'ksh'; }
|
|
pre.src-mksh:before { content: 'mksh'; }
|
|
pre.src-posh:before { content: 'posh'; }
|
|
/* Additional Emacs modes also supported by the LaTeX listings package */
|
|
pre.src-ada:before { content: 'Ada'; }
|
|
pre.src-asm:before { content: 'Assembler'; }
|
|
pre.src-caml:before { content: 'Caml'; }
|
|
pre.src-delphi:before { content: 'Delphi'; }
|
|
pre.src-html:before { content: 'HTML'; }
|
|
pre.src-idl:before { content: 'IDL'; }
|
|
pre.src-mercury:before { content: 'Mercury'; }
|
|
pre.src-metapost:before { content: 'MetaPost'; }
|
|
pre.src-modula-2:before { content: 'Modula-2'; }
|
|
pre.src-pascal:before { content: 'Pascal'; }
|
|
pre.src-ps:before { content: 'PostScript'; }
|
|
pre.src-prolog:before { content: 'Prolog'; }
|
|
pre.src-simula:before { content: 'Simula'; }
|
|
pre.src-tcl:before { content: 'tcl'; }
|
|
pre.src-tex:before { content: 'TeX'; }
|
|
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
|
pre.src-verilog:before { content: 'Verilog'; }
|
|
pre.src-vhdl:before { content: 'VHDL'; }
|
|
pre.src-xml:before { content: 'XML'; }
|
|
pre.src-nxml:before { content: 'XML'; }
|
|
/* add a generic configuration mode; LaTeX export needs an additional
|
|
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
|
pre.src-conf:before { content: 'Configuration File'; }
|
|
|
|
table { border-collapse:collapse; }
|
|
caption.t-above { caption-side: top; }
|
|
caption.t-bottom { caption-side: bottom; }
|
|
td, th { vertical-align:top; }
|
|
th.org-right { text-align: center; }
|
|
th.org-left { text-align: center; }
|
|
th.org-center { text-align: center; }
|
|
td.org-right { text-align: right; }
|
|
td.org-left { text-align: left; }
|
|
td.org-center { text-align: center; }
|
|
dt { font-weight: bold; }
|
|
.footpara { display: inline; }
|
|
.footdef { margin-bottom: 1em; }
|
|
.figure { padding: 1em; }
|
|
.figure p { text-align: center; }
|
|
.equation-container {
|
|
display: table;
|
|
text-align: center;
|
|
width: 100%;
|
|
}
|
|
.equation {
|
|
vertical-align: middle;
|
|
}
|
|
.equation-label {
|
|
display: table-cell;
|
|
text-align: right;
|
|
vertical-align: middle;
|
|
}
|
|
.inlinetask {
|
|
padding: 10px;
|
|
border: 2px solid gray;
|
|
margin: 10px;
|
|
background: #ffffcc;
|
|
}
|
|
#org-div-home-and-up
|
|
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
|
textarea { overflow-x: auto; }
|
|
.linenr { font-size: smaller }
|
|
.code-highlighted { background-color: #ffff00; }
|
|
.org-info-js_info-navigation { border-style: none; }
|
|
#org-info-js_console-label
|
|
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
|
.org-info-js_search-highlight
|
|
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
|
.org-svg { width: 90%; }
|
|
/*]]>*/-->
|
|
</style>
|
|
<link rel="stylesheet" title="Standard" href="qmckl.css" type="text/css" />
|
|
|
|
<script type="text/javascript" src="org-info.js">
|
|
/**
|
|
*
|
|
* @source: org-info.js
|
|
*
|
|
* @licstart The following is the entire license notice for the
|
|
* JavaScript code in org-info.js.
|
|
*
|
|
* Copyright (C) 2012-2020 Free Software Foundation, Inc.
|
|
*
|
|
*
|
|
* The JavaScript code in this tag is free software: you can
|
|
* redistribute it and/or modify it under the terms of the GNU
|
|
* General Public License (GNU GPL) as published by the Free Software
|
|
* Foundation, either version 3 of the License, or (at your option)
|
|
* any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
* without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
*
|
|
* As additional permission under GNU GPL version 3 section 7, you
|
|
* may distribute non-source (e.g., minimized or compacted) forms of
|
|
* that code without the copy of the GNU GPL normally required by
|
|
* section 4, provided you include this license notice and a URL
|
|
* through which recipients can access the Corresponding Source.
|
|
*
|
|
* @licend The above is the entire license notice
|
|
* for the JavaScript code in org-info.js.
|
|
*
|
|
*/
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
|
|
/*
|
|
@licstart The following is the entire license notice for the
|
|
JavaScript code in this tag.
|
|
|
|
Copyright (C) 2012-2020 Free Software Foundation, Inc.
|
|
|
|
The JavaScript code in this tag is free software: you can
|
|
redistribute it and/or modify it under the terms of the GNU
|
|
General Public License (GNU GPL) as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option)
|
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
|
|
As additional permission under GNU GPL version 3 section 7, you
|
|
may distribute non-source (e.g., minimized or compacted) forms of
|
|
that code without the copy of the GNU GPL normally required by
|
|
section 4, provided you include this license notice and a URL
|
|
through which recipients can access the Corresponding Source.
|
|
|
|
|
|
@licend The above is the entire license notice
|
|
for the JavaScript code in this tag.
|
|
*/
|
|
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
org_html_manager.set("TOC_DEPTH", "4");
|
|
org_html_manager.set("LINK_HOME", "index.html");
|
|
org_html_manager.set("LINK_UP", "");
|
|
org_html_manager.set("LOCAL_TOC", "1");
|
|
org_html_manager.set("VIEW_BUTTONS", "0");
|
|
org_html_manager.set("MOUSE_HINT", "underline");
|
|
org_html_manager.set("FIXED_TOC", "0");
|
|
org_html_manager.set("TOC", "1");
|
|
org_html_manager.set("VIEW", "info");
|
|
org_html_manager.setup(); // activate after the parameters are set
|
|
/*]]>*///-->
|
|
</script>
|
|
<script type="text/javascript">
|
|
/*
|
|
@licstart The following is the entire license notice for the
|
|
JavaScript code in this tag.
|
|
|
|
Copyright (C) 2012-2020 Free Software Foundation, Inc.
|
|
|
|
The JavaScript code in this tag is free software: you can
|
|
redistribute it and/or modify it under the terms of the GNU
|
|
General Public License (GNU GPL) as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option)
|
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
|
|
As additional permission under GNU GPL version 3 section 7, you
|
|
may distribute non-source (e.g., minimized or compacted) forms of
|
|
that code without the copy of the GNU GPL normally required by
|
|
section 4, provided you include this license notice and a URL
|
|
through which recipients can access the Corresponding Source.
|
|
|
|
|
|
@licend The above is the entire license notice
|
|
for the JavaScript code in this tag.
|
|
*/
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
function CodeHighlightOn(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(null != target) {
|
|
elem.cacheClassElem = elem.className;
|
|
elem.cacheClassTarget = target.className;
|
|
target.className = "code-highlighted";
|
|
elem.className = "code-highlighted";
|
|
}
|
|
}
|
|
function CodeHighlightOff(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(elem.cacheClassElem)
|
|
elem.className = elem.cacheClassElem;
|
|
if(elem.cacheClassTarget)
|
|
target.className = elem.cacheClassTarget;
|
|
}
|
|
/*]]>*///-->
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="org-div-home-and-up">
|
|
<a accesskey="h" href=""> UP </a>
|
|
|
|
|
<a accesskey="H" href="index.html"> HOME </a>
|
|
</div><div id="content">
|
|
<h1 class="title">Error handling</h1>
|
|
<div id="table-of-contents">
|
|
<h2>Table of Contents</h2>
|
|
<div id="text-table-of-contents">
|
|
<ul>
|
|
<li><a href="#orgb7a7916">-</a></li>
|
|
<li><a href="#orge291544">1. Decoding errors</a></li>
|
|
<li><a href="#org708f147">2. Data structure in context</a></li>
|
|
<li><a href="#org8bd1a45">3. Updating errors in the context</a></li>
|
|
<li><a href="#orgd365a82">4. Get the error</a></li>
|
|
<li><a href="#org1f3b8c4">5. Failing</a></li>
|
|
<li><a href="#orgfebae0a">6. Last error</a>
|
|
<ul>
|
|
<li><a href="#org56c6b02">6.1. Fortran inteface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#orgfb6e1a2">7. Helper functions for debugging</a>
|
|
<ul>
|
|
<li><a href="#org9f64167">7.1. Fortran inteface</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orgb7a7916" class="outline-2">
|
|
<h2 id="orgb7a7916">-</h2>
|
|
<div class="outline-text-2" id="text-orgb7a7916">
|
|
<p>
|
|
The library should never make the calling programs abort, nor
|
|
perform any input/output operations. This decision has to be taken
|
|
by the developer of the code calling the library.
|
|
</p>
|
|
|
|
<p>
|
|
All the functions return with an exit code, defined as
|
|
</p>
|
|
<div class="org-src-container">
|
|
<pre class="src src-c" id="org4961ba9"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>;
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<p>
|
|
The exit code returns the completion status of the function to the
|
|
calling program. When a function call completed successfully,
|
|
<code>QMCKL_SUCCESS</code> is returned. If one of the functions of
|
|
the library fails to complete the requested task, an appropriate
|
|
error code is returned to the program.
|
|
</p>
|
|
|
|
<p>
|
|
Here is the complete list of exit codes.
|
|
</p>
|
|
|
|
<table id="orgcb81837" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
|
|
|
|
|
<colgroup>
|
|
<col class="org-left" />
|
|
|
|
<col class="org-right" />
|
|
|
|
<col class="org-left" />
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col" class="org-left">Macro</th>
|
|
<th scope="col" class="org-right">Code</th>
|
|
<th scope="col" class="org-left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_SUCCESS</code></td>
|
|
<td class="org-right">0</td>
|
|
<td class="org-left">'Success'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_1</code></td>
|
|
<td class="org-right">1</td>
|
|
<td class="org-left">'Invalid argument 1'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_2</code></td>
|
|
<td class="org-right">2</td>
|
|
<td class="org-left">'Invalid argument 2'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_3</code></td>
|
|
<td class="org-right">3</td>
|
|
<td class="org-left">'Invalid argument 3'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_4</code></td>
|
|
<td class="org-right">4</td>
|
|
<td class="org-left">'Invalid argument 4'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_5</code></td>
|
|
<td class="org-right">5</td>
|
|
<td class="org-left">'Invalid argument 5'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_6</code></td>
|
|
<td class="org-right">6</td>
|
|
<td class="org-left">'Invalid argument 6'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_7</code></td>
|
|
<td class="org-right">7</td>
|
|
<td class="org-left">'Invalid argument 7'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_8</code></td>
|
|
<td class="org-right">8</td>
|
|
<td class="org-left">'Invalid argument 8'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_9</code></td>
|
|
<td class="org-right">9</td>
|
|
<td class="org-left">'Invalid argument 9'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_10</code></td>
|
|
<td class="org-right">10</td>
|
|
<td class="org-left">'Invalid argument 10'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_11</code></td>
|
|
<td class="org-right">11</td>
|
|
<td class="org-left">'Invalid argument 11'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_12</code></td>
|
|
<td class="org-right">12</td>
|
|
<td class="org-left">'Invalid argument 12'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_13</code></td>
|
|
<td class="org-right">13</td>
|
|
<td class="org-left">'Invalid argument 13'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_14</code></td>
|
|
<td class="org-right">14</td>
|
|
<td class="org-left">'Invalid argument 14'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_15</code></td>
|
|
<td class="org-right">15</td>
|
|
<td class="org-left">'Invalid argument 15'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_16</code></td>
|
|
<td class="org-right">16</td>
|
|
<td class="org-left">'Invalid argument 16'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_17</code></td>
|
|
<td class="org-right">17</td>
|
|
<td class="org-left">'Invalid argument 17'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_18</code></td>
|
|
<td class="org-right">18</td>
|
|
<td class="org-left">'Invalid argument 18'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_19</code></td>
|
|
<td class="org-right">19</td>
|
|
<td class="org-left">'Invalid argument 19'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_ARG_20</code></td>
|
|
<td class="org-right">20</td>
|
|
<td class="org-left">'Invalid argument 20'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_FAILURE</code></td>
|
|
<td class="org-right">101</td>
|
|
<td class="org-left">'Failure'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_ERRNO</code></td>
|
|
<td class="org-right">102</td>
|
|
<td class="org-left">strerror(errno)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_CONTEXT</code></td>
|
|
<td class="org-right">103</td>
|
|
<td class="org-left">'Invalid context'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_ALLOCATION_FAILED</code></td>
|
|
<td class="org-right">104</td>
|
|
<td class="org-left">'Allocation failed'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_DEALLOCATION_FAILED</code></td>
|
|
<td class="org-right">105</td>
|
|
<td class="org-left">'De-allocation failed'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_NOT_PROVIDED</code></td>
|
|
<td class="org-right">106</td>
|
|
<td class="org-left">'Not provided'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_OUT_OF_BOUNDS</code></td>
|
|
<td class="org-right">107</td>
|
|
<td class="org-left">'Index out of bounds'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_ALREADY_SET</code></td>
|
|
<td class="org-right">108</td>
|
|
<td class="org-left">'Already set'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="org-left"><code>QMCKL_INVALID_EXIT_CODE</code></td>
|
|
<td class="org-right">109</td>
|
|
<td class="org-left">'Invalid exit code'</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>
|
|
The <code>qmckl_string_of_error</code> converts an exit code into a string. The
|
|
string is assumed to be large enough to contain the error message
|
|
(typically 128 characters).
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orge291544" class="outline-2">
|
|
<h2 id="orge291544"><span class="section-number-2">1</span> Decoding errors</h2>
|
|
<div class="outline-text-2" id="text-1">
|
|
<p>
|
|
To decode the error messages, <code>qmckl_string_of_error</code> converts an
|
|
error code into a string.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>*
|
|
<span style="color: #0000ff;">qmckl_string_of_error</span> (<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">error</span>);
|
|
</pre>
|
|
</div>
|
|
|
|
<p>
|
|
The text strings are extracted from the previous table.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org708f147" class="outline-2">
|
|
<h2 id="org708f147"><span class="section-number-2">2</span> Data structure in context</h2>
|
|
<div class="outline-text-2" id="text-2">
|
|
<p>
|
|
The strings are declared internally with a maximum fixed size to avoid
|
|
dynamic memory allocation.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_MAX_FUN_LEN</span> 256
|
|
<span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_MAX_MSG_LEN</span> 1024
|
|
|
|
<span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_error_struct</span> {
|
|
|
|
<span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">exit_code</span>;
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">function</span>[QMCKL_MAX_FUN_LEN];
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">message</span> [QMCKL_MAX_MSG_LEN];
|
|
|
|
} <span style="color: #228b22;">qmckl_error_struct</span>;
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org8bd1a45" class="outline-2">
|
|
<h2 id="org8bd1a45"><span class="section-number-2">3</span> Updating errors in the context</h2>
|
|
<div class="outline-text-2" id="text-3">
|
|
<p>
|
|
The error is updated in the context using <code>qmckl_set_error</code>.
|
|
When the error is set in the context, it is mandatory to specify
|
|
from which function the error is triggered, and a message
|
|
explaining the error. The exit code can't be <code>QMCKL_SUCCESS</code>.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
|
<span style="color: #0000ff;">qmckl_set_error</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">exit_code</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">function_name</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">message</span>);
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-orgd365a82" class="outline-2">
|
|
<h2 id="orgd365a82"><span class="section-number-2">4</span> Get the error</h2>
|
|
<div class="outline-text-2" id="text-4">
|
|
<p>
|
|
Upon error, the error type and message can be obtained from the
|
|
context using <code>qmckl_get_error</code>. The message and function name
|
|
is returned in the variables provided. Therefore, passing a
|
|
function name and message is mandatory.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
|
<span style="color: #0000ff;">qmckl_get_error</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
|
|
<span style="color: #228b22;">qmckl_exit_code</span> *<span style="color: #a0522d;">exit_code</span>,
|
|
<span style="color: #228b22;">char</span>* <span style="color: #a0522d;">function_name</span>,
|
|
<span style="color: #228b22;">char</span>* <span style="color: #a0522d;">message</span>);
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org1f3b8c4" class="outline-2">
|
|
<h2 id="org1f3b8c4"><span class="section-number-2">5</span> Failing</h2>
|
|
<div class="outline-text-2" id="text-5">
|
|
<p>
|
|
To make a function fail, the <code>qmckl_failwith</code> function should be
|
|
called, such that information about the failure is stored in
|
|
the context. The desired exit code is given as an argument, as
|
|
well as the name of the function and an error message. If the
|
|
message is <code>NULL</code>, then the default message obtained by
|
|
<code>qmckl_string_of_error</code> is used. The return code of the function is
|
|
the desired return code.
|
|
Upon failure, a <code>QMCKL_NULL_CONTEXT</code> is returned.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
|
<span style="color: #0000ff;">qmckl_failwith</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">exit_code</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">function</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">message</span>) ;
|
|
</pre>
|
|
</div>
|
|
|
|
<p>
|
|
For example, this function can be used as
|
|
</p>
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #a020f0;">if</span> (x < 0) {
|
|
<span style="color: #a020f0;">return</span> qmckl_failwith(context,
|
|
QMCKL_INVALID_ARG_2,
|
|
<span style="color: #8b2252;">"qmckl_function"</span>,
|
|
<span style="color: #8b2252;">"Expected x >= 0"</span>);
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orgfebae0a" class="outline-2">
|
|
<h2 id="orgfebae0a"><span class="section-number-2">6</span> Last error</h2>
|
|
<div class="outline-text-2" id="text-6">
|
|
<p>
|
|
Returns a string describing the last error, using <code>qmckl_get_error</code>.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
|
<span style="color: #0000ff;">qmckl_last_error</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">buffer</span>);
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org56c6b02" class="outline-3">
|
|
<h3 id="org56c6b02"><span class="section-number-3">6.1</span> Fortran inteface</h3>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orgfb6e1a2" class="outline-2">
|
|
<h2 id="orgfb6e1a2"><span class="section-number-2">7</span> Helper functions for debugging</h2>
|
|
<div class="outline-text-2" id="text-7">
|
|
<p>
|
|
The following function prints to <code>stderr</code> an error message is the return code is
|
|
not <code>QMCKL_SUCCESS</code>.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
|
<span style="color: #0000ff;">qmckl_check</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">rc</span>);
|
|
</pre>
|
|
</div>
|
|
|
|
<p>
|
|
It should be used as:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c">rc = qmckl_check(context,
|
|
qmckl_...(context, ...)
|
|
);
|
|
<span style="color: #0000ff;">assert</span> (rc == QMCKL_SUCCESS);
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org9f64167" class="outline-3">
|
|
<h3 id="org9f64167"><span class="section-number-3">7.1</span> Fortran inteface</h3>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="postamble" class="status">
|
|
<p class="author">Author: TREX CoE</p>
|
|
<p class="date">Created: 2023-03-09 Thu 10:03</p>
|
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
|
</div>
|
|
</body>
|
|
</html>
|