docs/md_ARCHITECTURE.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>generic_iterators: Architecture</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<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>

<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/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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">generic_iterators
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
   <div id="projectbrief">Demonstration of implementing and using type safe generic iterators in pure, standard C</div>
  </td>
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('md_ARCHITECTURE.html',''); initResizable(); });
/* @license-end */
</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><div class="header">
  <div class="headertitle">
<div class="title">Architecture </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p class="">This document aims to describe the file structure and contents of this project.</p>
<h1>Root</h1>
<p class="">The root directory contains the primary header files to define and implement iterators and iterator instances (i.e iterables) </p><table class="doxtable">
<tr>
<th>File </th><th>Description  </th></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code><a class="el" href="typeclass_8h.html" title="Utilities to define a typeclass and its instance.">typeclass.h</a></code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Utility macros to define a typeclass and its instance.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code><a class="el" href="maybe_8h.html" title="Utilities to define and use a Maybe type.">maybe.h</a></code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Utility macros to define and use a <code>Maybe</code> type.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code><a class="el" href="iterator_8h.html" title="Utilities to define and implement an Iterable.">iterator.h</a></code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Primary file containing macros to define the <code>Iterator</code> typeclass, <code>Iterable</code> typeclass instance and a utility macro, <code>impl_iterable</code>, that defines a function to wrap a pointer type into an <code>Iterable</code> - essentially implementing the <code>Iterator</code> typeclass for that type.</p>
<p class="endtd"></p>
</td></tr>
</table>
<h1>Examples</h1>
<p class="">The <code>examples/</code> directory contains usage examples of the Iterator typeclass pattern.</p>
<p class="">This also contains a subdirectory - <code>iterutils</code>, which contains utilities to work with generic <code>Iterable</code>s.</p>
<h2><code>iterutils</code></h2>
<table class="doxtable">
<tr>
<th>File </th><th>Description  </th></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>take.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Macros to define an <code>IterTake</code> struct of a certain element type.</p>
<p class="intertd">This struct stores a source iterable, and keeps track of how many elements to extract from it. This is used to implement a <code>take</code>-like function.</p>
<p class="intertd">Defines a macro to implement <code>Iterator</code> for an <code>IterTake</code> struct, as well as a macro (<code>take_from</code>) to "take" <code>n</code> elements from a given iterable, lazily.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>map.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Macros to define an <code>IterMap</code> struct of a certain element and return type.</p>
<p class="intertd">This struct stores a source iterable, and a function to map over the iterable.</p>
<p class="intertd">Defines a macro to implement <code>Iterator</code> for an <code>IterMap</code> struct, as well as a macro (<code>map_over</code>) to map a function (<code>fn</code>) over a given iterable, lazily.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>iterable_utils.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Declarations of all the utility functions to be exposed to the examples.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>iterable_utils.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Definitions of the utility functions.</p>
<p class="endtd"></p>
</td></tr>
</table>
<p class="">The usage of these iterutils and the primary header files are demonstrated by the files in <code>examples/</code>- </p><table class="doxtable">
<tr>
<th>File </th><th>Description  </th></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>func_iter.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Includes all the primary headers from the root directory. Also defines <code>Maybe</code> and <code>Iterator</code> for the following types-</p><ul>
<li><code>int</code></li>
<li><code>char*</code> (Typedef-ed to <code>string</code>)</li>
<li><code>uint32_t</code></li>
</ul>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>examples.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Declarations for all the functions demonstrating iterable usage.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>main.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">The main function definition, executes the functions demonstrating iterable usage. (Declared in <code>examples.h</code>)</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>array_iterable.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Declarations for functions and structs to be used to use an array as an <code>Iterable</code>.</p>
<p class="intertd">This defines the <code>ArrIter</code> struct - this struct wraps an array and has an <code>Iterator</code> implementation.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>array_iterable.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Definitons for functions be used to use an array as an <code>Iterable</code>.</p>
<p class="intertd">This implements the <code>Iterator</code> typeclass for the <code>ArrIter</code> struct.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>list_iterable.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Declarations for functions and structs to be used to use a singly linked list as an <code>Iterable</code>.</p>
<p class="intertd">This defines the <code>ListIter</code> struct - this struct wraps a singly linked list and has an <code>Iterator</code> implementation.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>list_iterable.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Definitons for functions to be used to use a singly linked list as an <code>Iterable</code>.</p>
<p class="intertd">This implements the <code>Iterator</code> typeclass for the <code>ListIter</code> struct.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>fibonacci_iterable.h</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Declarations for functions and structs to be used to use an <code>Iterable</code> representing the infinite fibonacci sequence.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>fibonacci_iterable.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Definitions for functions to be used to use an <code>Iterable</code> representing the infinite fibonacci sequence.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>arr_to_iterble.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Example function that wraps an array into an <code>Iterable</code> to be used by a generic function operating on iterables.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>list_to_iterble.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Example function that wraps a singly linked list into an <code>Iterable</code> to be used by a generic function operating on iterables.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>list_from_arr.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Example function that wraps an array into an <code>Iterable</code> that can be used to build a singly linked list from a generic function operating on iterables.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>fibonacci.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Example function that prints the elements from an <code>Iterable</code> representing the infinite fibonacci sequence.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"></p>
<p class="intertd"><code>map_over.c</code></p>
<p class="endtd"></p>
</td><td><p class="starttd"></p>
<p class="intertd">Example usage of the <code>map</code> utility, that maps functions over an <code>Iterable</code>.</p>
<p class="endtd"></p>
</td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->

<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
  </ul>
</div>


</body>
</html>