libaaruformat/docs/html/options_8c.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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: src/options.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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>
<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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
   </div>
   <div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
  "relPath": "",
  "generateTreeView": true,
  "searchEngine": true,
  "serverBasedSearch": false,
  "disableIndex": false,
  "dynamicMenus": true,
  "fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
  <ul class="sm sm-dox" id="main-menu">
    <li id="searchBoxPos2">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
    </li>
  </ul>
</div><!-- main-nav -->
</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" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('options_8c.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">options.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;errno.h&gt;</code><br />
<code>#include &lt;limits.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="options_8h_source.html">structs/options.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="log_8h_source.html">log.h</a>&quot;</code><br />
</div>
<p><a href="options_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab6712856cb106e6d17a0f03f39bbf2f0" id="r_ab6712856cb106e6d17a0f03f39bbf2f0"><td class="memItemLeft">static char *&#160;</td><td class="memItemRight"><a class="el" href="#ab6712856cb106e6d17a0f03f39bbf2f0">aaru_strtok_reentrant</a> (char *str, const char *delim, char **saveptr)</td></tr>
<tr class="memitem:addf13857b7c9f36eb32cfd3c7efab10b" id="r_addf13857b7c9f36eb32cfd3c7efab10b"><td class="memItemLeft"><a class="el" href="structaaru__options.html">aaru_options</a>&#160;</td><td class="memItemRight"><a class="el" href="#addf13857b7c9f36eb32cfd3c7efab10b">parse_options</a> (const char *options, bool *table_shift_found)</td></tr>
<tr class="memdesc:addf13857b7c9f36eb32cfd3c7efab10b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the options string for AaruFormat image creation/opening.  <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="ab6712856cb106e6d17a0f03f39bbf2f0" name="ab6712856cb106e6d17a0f03f39bbf2f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6712856cb106e6d17a0f03f39bbf2f0">&#9670;&#160;</a></span>aaru_strtok_reentrant()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">char * aaru_strtok_reentrant </td>
          <td>(</td>
          <td class="paramtype">char *</td>          <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>delim</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **</td>          <td class="paramname"><span class="paramname"><em>saveptr</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="options_8c_source.html#l00030">30</a> of file <a class="el" href="options_8c_source.html">options.c</a>.</p>

<p class="reference">References <a class="el" href="options_8c_source.html#l00030">aaru_strtok_reentrant()</a>.</p>

<p class="reference">Referenced by <a class="el" href="options_8c_source.html#l00030">aaru_strtok_reentrant()</a>, and <a class="el" href="options_8c_source.html#l00047">parse_options()</a>.</p>

</div>
</div>
<a id="addf13857b7c9f36eb32cfd3c7efab10b" name="addf13857b7c9f36eb32cfd3c7efab10b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addf13857b7c9f36eb32cfd3c7efab10b">&#9670;&#160;</a></span>parse_options()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structaaru__options.html">aaru_options</a> parse_options </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>options</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *</td>          <td class="paramname"><span class="paramname"><em>table_shift_found</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parses the options string for AaruFormat image creation/opening. </p>
<p>Parses the options string and returns a struct with the parsed options for image creation or opening.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">options</td><td>String with options to parse (may be NULL). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Parsed options as an <a class="el" href="structaaru__options.html" title="Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry.">aaru_options</a> struct. </dd></dl>

<p class="definition">Definition at line <a class="el" href="options_8c_source.html#l00047">47</a> of file <a class="el" href="options_8c_source.html">options.c</a>.</p>

<p class="reference">References <a class="el" href="options_8c_source.html#l00030">aaru_strtok_reentrant()</a>, <a class="el" href="options_8h_source.html#l00231">aaru_options::blake3</a>, <a class="el" href="options_8h_source.html#l00227">aaru_options::block_alignment</a>, <a class="el" href="options_8h_source.html#l00221">aaru_options::compress</a>, <a class="el" href="options_8h_source.html#l00226">aaru_options::data_shift</a>, <a class="el" href="options_8h_source.html#l00222">aaru_options::deduplicate</a>, <a class="el" href="options_8h_source.html#l00224">aaru_options::dictionary</a>, <a class="el" href="options_8h_source.html#l00228">aaru_options::md5</a>, <a class="el" href="options_8h_source.html#l00235">aaru_options::num_threads</a>, <a class="el" href="options_8c_source.html#l00047">parse_options()</a>, <a class="el" href="options_8h_source.html#l00229">aaru_options::sha1</a>, <a class="el" href="options_8h_source.html#l00230">aaru_options::sha256</a>, <a class="el" href="options_8h_source.html#l00232">aaru_options::spamsum</a>, <a class="el" href="options_8h_source.html#l00225">aaru_options::table_shift</a>, <a class="el" href="log_8h_source.html#l00025">TRACE</a>, <a class="el" href="options_8h_source.html#l00233">aaru_options::zstd</a>, and <a class="el" href="options_8h_source.html#l00234">aaru_options::zstd_level</a>.</p>

<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00291">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, and <a class="el" href="options_8c_source.html#l00047">parse_options()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="options_8c.html">options.c</a></li>
    <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.18.0 </li>
  </ul>
</div>
</body>
</html>