HTL-2IHIF-C/06-chess
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
06-chess/assignment/html/shortcut_8cpp.html
github-classroom[bot] fd154a8ed5
Initial commit
2024-10-24 13:14:23 +00:00

413 lines
19 KiB
HTML
Raw Blame History

<!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"/>
<title>Chess: shortcut.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.0 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<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>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>shortcut.cpp File Reference</h1> </div>
</div>
<div class="contents">
<code>#include &lt;stdio.h&gt;</code><br/>
<code>#include &lt;string.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="shortcut_8h.html">shortcut.h</a>&quot;</code><br/>
<div class="dynheader">
Include dependency graph for shortcut.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="shortcut_8cpp__incl.png" border="0" usemap="#shortcut_8cpp" alt=""/></div>
<map name="shortcut_8cpp" id="shortcut_8cpp">
</map>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#a7b0914426a43493071e832a453a9b5b7">MAX_TEST_FUNCTIONS</a>&nbsp;&nbsp;&nbsp;256</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#a51d90ea93d4b55e086cb490f7478e684">MAX_MSG_LEN</a>&nbsp;&nbsp;&nbsp;128</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#aae0723227a447e55f27ee7d2cbfc81cc">version</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#afbf1c9fa185219d9a7270bce81e4b68e">assert_true</a> (bool bool_expr, struct <a class="el" href="struct_test_case.html">TestCase</a> *tc, const char *msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#a9636d5c29cac0fdf4745a7f41e7f1727">assert_false</a> (bool bool_expr, struct <a class="el" href="struct_test_case.html">TestCase</a> *tc, const char *msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#af4fac78f7fc154a519a363e5c055b634">assert_equals</a> (const char *expected, char *actual, struct <a class="el" href="struct_test_case.html">TestCase</a> *tc, const char *msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#ad9e71dffaf6cefb5a8e75aeeb095673d">assert_equals</a> (int expected, int actual, struct <a class="el" href="struct_test_case.html">TestCase</a> *tc, const char *msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#aa7982398308844766b98a83b672f05cd">get_test_count</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#a1b5aec2cecb6b4db5fcce5b945643991">add_test</a> (void(*test_function)(struct <a class="el" href="struct_test_case.html">TestCase</a> *tc), const char *test_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="shortcut_8cpp.html#ac3ef4e4ac9b8681e56bf390cb4c152cd">run_tests</a> ()</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a51d90ea93d4b55e086cb490f7478e684"></a><!-- doxytag: member="shortcut.cpp::MAX_MSG_LEN" ref="a51d90ea93d4b55e086cb490f7478e684" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_MSG_LEN&nbsp;&nbsp;&nbsp;128</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7b0914426a43493071e832a453a9b5b7"></a><!-- doxytag: member="shortcut.cpp::MAX_TEST_FUNCTIONS" ref="a7b0914426a43493071e832a453a9b5b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_TEST_FUNCTIONS&nbsp;&nbsp;&nbsp;256</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a1b5aec2cecb6b4db5fcce5b945643991"></a><!-- doxytag: member="shortcut.cpp::add_test" ref="a1b5aec2cecb6b4db5fcce5b945643991" args="(void(*test_function)(struct TestCase *tc), const char *test_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool add_test </td>
<td>(</td>
<td class="paramtype">void(*)(struct <a class="el" href="struct_test_case.html">TestCase</a> *tc)&nbsp;</td>
<td class="paramname"> <em>test_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>test_case_name</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>add_test creates a new test case and adds the a test function to this test case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>test_function</em>&nbsp;</td><td>Pointer to the test function to be added to the newly created test case. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>test_case_name</em>&nbsp;</td><td>Name which should be assigned to the newly created test case. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af4fac78f7fc154a519a363e5c055b634"></a><!-- doxytag: member="shortcut.cpp::assert_equals" ref="af4fac78f7fc154a519a363e5c055b634" args="(const char *expected, char *actual, struct TestCase *tc, const char *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void assert_equals </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>expected</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>actual</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_test_case.html">TestCase</a> *&nbsp;</td>
<td class="paramname"> <em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>assert_equals checks whether two values are equal. Currently the following data formats are supported:</p>
<ul>
<li>strings</li>
<li>integer <dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expected</em>&nbsp;</td><td>The expected string value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>actual</em>&nbsp;</td><td>The actual string value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tc</em>&nbsp;</td><td>Pointer to the test case which states this assertion. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>Message to be printed if assertion evaluates to false. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>assert </dd></dl>
</li>
</ul>
</div>
</div>
<a class="anchor" id="ad9e71dffaf6cefb5a8e75aeeb095673d"></a><!-- doxytag: member="shortcut.cpp::assert_equals" ref="ad9e71dffaf6cefb5a8e75aeeb095673d" args="(int expected, int actual, struct TestCase *tc, const char *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void assert_equals </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>expected</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>actual</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_test_case.html">TestCase</a> *&nbsp;</td>
<td class="paramname"> <em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="shortcut_8cpp_ad9e71dffaf6cefb5a8e75aeeb095673d_cgraph.png" border="0" usemap="#shortcut_8cpp_ad9e71dffaf6cefb5a8e75aeeb095673d_cgraph" alt=""/></div>
<map name="shortcut_8cpp_ad9e71dffaf6cefb5a8e75aeeb095673d_cgraph" id="shortcut_8cpp_ad9e71dffaf6cefb5a8e75aeeb095673d_cgraph">
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a9636d5c29cac0fdf4745a7f41e7f1727"></a><!-- doxytag: member="shortcut.cpp::assert_false" ref="a9636d5c29cac0fdf4745a7f41e7f1727" args="(bool bool_expr, struct TestCase *tc, const char *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void assert_false </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>bool_expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_test_case.html">TestCase</a> *&nbsp;</td>
<td class="paramname"> <em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>assert_false does the same as assert() but the boolean expression has to evaluate to false. If it evaluates to true the assertion fails. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>assert </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="shortcut_8cpp_a9636d5c29cac0fdf4745a7f41e7f1727_cgraph.png" border="0" usemap="#shortcut_8cpp_a9636d5c29cac0fdf4745a7f41e7f1727_cgraph" alt=""/></div>
<map name="shortcut_8cpp_a9636d5c29cac0fdf4745a7f41e7f1727_cgraph" id="shortcut_8cpp_a9636d5c29cac0fdf4745a7f41e7f1727_cgraph">
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="afbf1c9fa185219d9a7270bce81e4b68e"></a><!-- doxytag: member="shortcut.cpp::assert_true" ref="afbf1c9fa185219d9a7270bce81e4b68e" args="(bool bool_expr, struct TestCase *tc, const char *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void assert_true </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>bool_expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="struct_test_case.html">TestCase</a> *&nbsp;</td>
<td class="paramname"> <em>tc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>assert_true checks, whether a boolean expression passed is true or false. in case it is false the test case stating the assertion is marked as failed and msg is printed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bool_expr</em>&nbsp;</td><td>Expression which is evaluated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tc</em>&nbsp;</td><td>Pointer to the test case which states this assertion. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>Message to be printed if assertion evaluates to false. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa7982398308844766b98a83b672f05cd"></a><!-- doxytag: member="shortcut.cpp::get_test_count" ref="aa7982398308844766b98a83b672f05cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int get_test_count </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The total number of test cases added to the test. </dd></dl>
</div>
</div>
<a class="anchor" id="ac3ef4e4ac9b8681e56bf390cb4c152cd"></a><!-- doxytag: member="shortcut.cpp::run_tests" ref="ac3ef4e4ac9b8681e56bf390cb4c152cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void run_tests </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="shortcut_8cpp_ac3ef4e4ac9b8681e56bf390cb4c152cd_cgraph.png" border="0" usemap="#shortcut_8cpp_ac3ef4e4ac9b8681e56bf390cb4c152cd_cgraph" alt=""/></div>
<map name="shortcut_8cpp_ac3ef4e4ac9b8681e56bf390cb4c152cd_cgraph" id="shortcut_8cpp_ac3ef4e4ac9b8681e56bf390cb4c152cd_cgraph">
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aae0723227a447e55f27ee7d2cbfc81cc"></a><!-- doxytag: member="shortcut.cpp::version" ref="aae0723227a447e55f27ee7d2cbfc81cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* version </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Version of shortcut as string </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 11 2017 22:56:40 for Chess by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.0 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink