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

204 lines
11 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: chess_printer.h 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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>chess_printer.h File Reference</h1> </div>
</div>
<div class="contents">
<code>#include &quot;<a class="el" href="chess_8h.html">chess.h</a>&quot;</code><br/>
<div class="dynheader">
Include dependency graph for chess_printer.h:</div>
<div class="dyncontent">
<div class="center"><img src="chess__printer_8h__incl.png" border="0" usemap="#chess__printer_8h" alt=""/></div>
<map name="chess__printer_8h" id="chess__printer_8h">
</map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="chess__printer_8h__dep__incl.png" border="0" usemap="#chess__printer_8hdep" alt=""/></div>
<map name="chess__printer_8hdep" id="chess__printer_8hdep">
</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="chess__printer_8h.html#a7ce17bb785e2a8e843c28f53a939c63e">PIECE_SYMBOL_STRING_LEN</a>&nbsp;&nbsp;&nbsp;14</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="chess__printer_8h.html#a8af5aa6c3c4b0de9fe8cb22933b8e462">ChessPieceSymbol</a> [PIECE_SYMBOL_STRING_LEN]</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="chess__printer_8h.html#a034e47a2bfbeeaed3ec619511ab50455">print_chess_board</a> (<a class="el" href="chess_8h.html#a6b333a9100c3f98762a6260c4c3cb673">ChessBoard</a> chess_board)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="chess__printer_8h.html#a7ed805d66d52f87984092f63891adf31">get_piece_symbol</a> (struct <a class="el" href="struct_chess_piece.html">ChessPiece</a> piece, <a class="el" href="chess__printer_8h.html#a8af5aa6c3c4b0de9fe8cb22933b8e462">ChessPieceSymbol</a> piece_symbol)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a7ce17bb785e2a8e843c28f53a939c63e"></a><!-- doxytag: member="chess_printer.h::PIECE_SYMBOL_STRING_LEN" ref="a7ce17bb785e2a8e843c28f53a939c63e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PIECE_SYMBOL_STRING_LEN&nbsp;&nbsp;&nbsp;14</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constant defining the length of the string holding the symbol of a chess piece. This string also holds the color information and, therefore, has to get this length. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a8af5aa6c3c4b0de9fe8cb22933b8e462"></a><!-- doxytag: member="chess_printer.h::ChessPieceSymbol" ref="a8af5aa6c3c4b0de9fe8cb22933b8e462" args="[PIECE_SYMBOL_STRING_LEN]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef char <a class="el" href="chess__printer_8h.html#a8af5aa6c3c4b0de9fe8cb22933b8e462">ChessPieceSymbol</a>[PIECE_SYMBOL_STRING_LEN]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The chess piece symbol holds the printable form of a chess piece. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7ed805d66d52f87984092f63891adf31"></a><!-- doxytag: member="chess_printer.h::get_piece_symbol" ref="a7ed805d66d52f87984092f63891adf31" args="(struct ChessPiece piece, ChessPieceSymbol piece_symbol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool get_piece_symbol </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_chess_piece.html">ChessPiece</a>&nbsp;</td>
<td class="paramname"> <em>piece</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="chess__printer_8h.html#a8af5aa6c3c4b0de9fe8cb22933b8e462">ChessPieceSymbol</a>&nbsp;</td>
<td class="paramname"> <em>piece_symbol</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides a printable symbol for a specific chess piece. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>piece</em>&nbsp;</td><td>The chess piece which symbol to be returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>piece_symbol</em>&nbsp;</td><td>The symbol of the chess piece in printable form </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the requested symbol was found, i.e, the given piece has a valid color and type, False otherwise. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="chess_8h.html#a12ed9719bbdf7bc596ff7a6f4bf3f021">PieceType</a>, <a class="el" href="chess_8h.html#ad7595c48bb74c0dd2a7648712a2d4985">PieceColor</a>, <a class="el" href="struct_chess_piece.html">ChessPiece</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a034e47a2bfbeeaed3ec619511ab50455"></a><!-- doxytag: member="chess_printer.h::print_chess_board" ref="a034e47a2bfbeeaed3ec619511ab50455" args="(ChessBoard chess_board)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void print_chess_board </td>
<td>(</td>
<td class="paramtype"><a class="el" href="chess_8h.html#a6b333a9100c3f98762a6260c4c3cb673">ChessBoard</a>&nbsp;</td>
<td class="paramname"> <em>chess_board</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>print_chess_board prints a chess board into the terminal window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>chess_board</em>&nbsp;</td><td>The chess board to be printed. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="chess__printer_8h_a034e47a2bfbeeaed3ec619511ab50455_cgraph.png" border="0" usemap="#chess__printer_8h_a034e47a2bfbeeaed3ec619511ab50455_cgraph" alt=""/></div>
<map name="chess__printer_8h_a034e47a2bfbeeaed3ec619511ab50455_cgraph" id="chess__printer_8h_a034e47a2bfbeeaed3ec619511ab50455_cgraph">
</map>
</div>
</p>
</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