forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patherror_8hpp_source.html
More file actions
122 lines (120 loc) · 22.2 KB
/
error_8hpp_source.html
File metadata and controls
122 lines (120 loc) · 22.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cpp-Taskflow</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>
 <span id="projectnumber">2.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('error_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">error.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <sstream></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <exception></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <system_error></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">namespace </span><a class="code" href="namespacetf.html">tf</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structtf_1_1Error.html"> 15</a></span> <span class="keyword">struct </span><a class="code" href="structtf_1_1Error.html">Error</a> : <span class="keyword">public</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/error_category.html">std::error_category</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3"> 21</a></span>  <span class="keyword">enum</span> <a class="code" href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3">Code</a> : <span class="keywordtype">int</span> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  SUCCESS = 0,</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  TASKFLOW,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  EXECUTOR</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  };</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structtf_1_1Error.html#a18a5c2f16b543d5361e8a24554ebd12c">name</a>() <span class="keyword">const</span> noexcept <span class="keyword">override</span> <span class="keyword">final</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/error_category.html">std::error_category</a>& <span class="keyword">get</span>();</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">inline</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code" href="structtf_1_1Error.html#ae2d8630128262023502664f3cae5daab">message</a>(<span class="keywordtype">int</span>) <span class="keyword">const</span> <span class="keyword">override</span> <span class="keyword">final</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Function: name</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structtf_1_1Error.html#a18a5c2f16b543d5361e8a24554ebd12c"> 44</a></span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structtf_1_1Error.html#a18a5c2f16b543d5361e8a24554ebd12c">Error::name</a>() const noexcept {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> <span class="stringliteral">"Taskflow error"</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Function: get </span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structtf_1_1Error.html#a2fdb64a058ea1ff03706d0cd69c36021"> 49</a></span> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/error_category.html">std::error_category</a>& <a class="code" href="structtf_1_1Error.html#a2fdb64a058ea1ff03706d0cd69c36021">Error::get</a>() {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <a class="code" href="structtf_1_1Error.html">Error</a> instance;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> instance;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Function: message</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structtf_1_1Error.html#ae2d8630128262023502664f3cae5daab"> 55</a></span> <span class="keyword">inline</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code" href="structtf_1_1Error.html#ae2d8630128262023502664f3cae5daab">Error::message</a>(<span class="keywordtype">int</span> code)<span class="keyword"> const </span>{</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">switch</span>(<span class="keyword">auto</span> ec = static_cast<Error::Code>(code); ec) {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">case</span> SUCCESS:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> <span class="stringliteral">"success"</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">case</span> TASKFLOW:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> <span class="stringliteral">"taskflow error"</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">case</span> EXECUTOR:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> <span class="stringliteral">"executor error"</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> <span class="stringliteral">"unknown"</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  };</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// Function: make_error_code</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// Argument dependent lookup.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">inline</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/error_code.html">std::error_code</a> make_error_code(<a class="code" href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3">Error::Code</a> e) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/error_code.html">std::error_code</a>(static_cast<int>(e), <a class="code" href="structtf_1_1Error.html#a2fdb64a058ea1ff03706d0cd69c36021">Error::get</a>());</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">// end of namespace tf ----------------------------------------------------</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Register for implicit conversion </span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">namespace </span><a class="code" href="namespacestd.html">std</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">template</span> <></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">struct </span>is_error_code_enum<tf::<a class="code" href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3">Error::Code</a>> : true_type {};</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// ----------------------------------------------------------------------------</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">namespace </span><a class="code" href="namespacetf.html">tf</a> {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// Procedure: throw_se</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Throws the system error under a given error code.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">template</span> <<span class="keyword">typename</span>... ArgsT></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">void</span> throw_se(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname, <span class="keyword">const</span> <span class="keywordtype">size_t</span> line, <a class="code" href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3">Error::Code</a> c, ArgsT&&... args) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/io/basic_ostringstream.html">std::ostringstream</a> oss;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  oss << <span class="stringliteral">"["</span> << fname << <span class="stringliteral">":"</span> << line << <span class="stringliteral">"] "</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  (oss << ... << args);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">throw</span> <a class="codeRef" doxygen="/home/twhuang/PhD/Code/cpp-taskflow/doxygen/cppreference-doxygen-web.tag.xml:http://en.cppreference.com/w/" href="http://en.cppreference.com/w/cpp/error/system_error.html">std::system_error</a>(c, oss.str());</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// ------------------------------------------------------------------------</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#define TF_THROW(...) tf::throw_se(__FILE__, __LINE__, __VA_ARGS__);</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
<div class="ttc" id="error_code_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/error_code.html">std::error_code</a></div></div>
<div class="ttc" id="structtf_1_1Error_html_aad6732b815bfe4ae3cea402042ee43a3"><div class="ttname"><a href="structtf_1_1Error.html#aad6732b815bfe4ae3cea402042ee43a3">tf::Error::Code</a></div><div class="ttdeci">Code</div><div class="ttdoc">Error code definition. </div><div class="ttdef"><b>Definition:</b> error.hpp:21</div></div>
<div class="ttc" id="namespacetf_html"><div class="ttname"><a href="namespacetf.html">tf</a></div><div class="ttdef"><b>Definition:</b> taskflow.hpp:5</div></div>
<div class="ttc" id="basic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="structtf_1_1Error_html_a2fdb64a058ea1ff03706d0cd69c36021"><div class="ttname"><a href="structtf_1_1Error.html#a2fdb64a058ea1ff03706d0cd69c36021">tf::Error::get</a></div><div class="ttdeci">static const std::error_category & get()</div><div class="ttdoc">acquires the singleton instance of the taskflow error category </div><div class="ttdef"><b>Definition:</b> error.hpp:49</div></div>
<div class="ttc" id="basic_ostringstream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostringstream.html">std::ostringstream</a></div></div>
<div class="ttc" id="system_error_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/system_error.html">std::system_error</a></div></div>
<div class="ttc" id="error_category_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/error_category.html">std::error_category</a></div></div>
<div class="ttc" id="structtf_1_1Error_html_a18a5c2f16b543d5361e8a24554ebd12c"><div class="ttname"><a href="structtf_1_1Error.html#a18a5c2f16b543d5361e8a24554ebd12c">tf::Error::name</a></div><div class="ttdeci">const char * name() const noexcept override final</div><div class="ttdoc">returns the name of the taskflow error category </div><div class="ttdef"><b>Definition:</b> error.hpp:44</div></div>
<div class="ttc" id="structtf_1_1Error_html_ae2d8630128262023502664f3cae5daab"><div class="ttname"><a href="structtf_1_1Error.html#ae2d8630128262023502664f3cae5daab">tf::Error::message</a></div><div class="ttdeci">std::string message(int) const override final</div><div class="ttdoc">query the human-readable string of each error code </div><div class="ttdef"><b>Definition:</b> error.hpp:55</div></div>
<div class="ttc" id="structtf_1_1Error_html"><div class="ttname"><a href="structtf_1_1Error.html">tf::Error</a></div><div class="ttdoc">The error category of taskflow. </div><div class="ttdef"><b>Definition:</b> error.hpp:15</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_88dad41ea55ca2177e141d32a93e931c.html">taskflow</a></li><li class="navelem"><a class="el" href="dir_cccf8f0bee609cd7239b09b8a4e55133.html">error</a></li><li class="navelem"><b>error.hpp</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>