started woking on figuring out doxygen documentation and added readme
This commit is contained in:
parent
c598f3e106
commit
3f0556341c
1192 changed files with 199462 additions and 29 deletions
244
doc/doxygen/html/dc/dac/io_8h.html
Normal file
244
doc/doxygen/html/dc/dac/io_8h.html
Normal file
|
|
@ -0,0 +1,244 @@
|
|||
<!-- HTML header for doxygen 1.9.2-->
|
||||
<!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" class="dark-mode">
|
||||
<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.12.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/std/io.h File Reference</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="../../navtreedata.js"></script>
|
||||
<script type="text/javascript" src="../../navtree.js"></script>
|
||||
<script type="text/javascript" src="../../resize.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" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
|
||||
</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">Archeus<span id="projectnumber"> 0.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.12.0 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(1); });
|
||||
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('../../',true,false,'search.php','Search',true);
|
||||
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('dc/dac/io_8h.html','../../'); initResizable(true); });
|
||||
/* @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">
|
||||
<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="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle"><div class="title">io.h File Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include <stdint.h></code><br />
|
||||
<code>#include "<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>"</code><br />
|
||||
</div>
|
||||
<p><a href="../../dc/dac/io_8h_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:a70350710f6f2124edcd32cabd641f1f4" id="r_a70350710f6f2124edcd32cabd641f1f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a70350710f6f2124edcd32cabd641f1f4">ARC_IO_ReadFileToUint8t</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path, uint8_t **data, uint64_t *length)</td></tr>
|
||||
<tr class="memdesc:a70350710f6f2124edcd32cabd641f1f4"><td class="mdescLeft"> </td><td class="mdescRight">get string and size from file <br /></td></tr>
|
||||
<tr class="separator:a70350710f6f2124edcd32cabd641f1f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a264d33a54ba5175d36341c27011654f4" id="r_a264d33a54ba5175d36341c27011654f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a264d33a54ba5175d36341c27011654f4">ARC_IO_FileToStr</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> **data)</td></tr>
|
||||
<tr class="memdesc:a264d33a54ba5175d36341c27011654f4"><td class="mdescLeft"> </td><td class="mdescRight">get string and size from file <br /></td></tr>
|
||||
<tr class="separator:a264d33a54ba5175d36341c27011654f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a580578d50c6d90d08a00701285e28f3b" id="r_a580578d50c6d90d08a00701285e28f3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a580578d50c6d90d08a00701285e28f3b">ARC_IO_WriteStrToFile</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *data)</td></tr>
|
||||
<tr class="memdesc:a580578d50c6d90d08a00701285e28f3b"><td class="mdescLeft"> </td><td class="mdescRight">write string to file <br /></td></tr>
|
||||
<tr class="separator:a580578d50c6d90d08a00701285e28f3b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a264d33a54ba5175d36341c27011654f4" name="a264d33a54ba5175d36341c27011654f4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a264d33a54ba5175d36341c27011654f4">◆ </a></span>ARC_IO_FileToStr()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_IO_FileToStr </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> **</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>get string and size from file </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">path</td><td>a string to path of target file </td></tr>
|
||||
<tr><td class="paramname">data</td><td>pointer to where string will be created this will need to be freed once done using it </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a70350710f6f2124edcd32cabd641f1f4" name="a70350710f6f2124edcd32cabd641f1f4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a70350710f6f2124edcd32cabd641f1f4">◆ </a></span>ARC_IO_ReadFileToUint8t()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_IO_ReadFileToUint8t </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t **</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint64_t *</td> <td class="paramname"><span class="paramname"><em>length</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>get string and size from file </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">path</td><td>a string to path of target file </td></tr>
|
||||
<tr><td class="paramname">data</td><td>pointer to where uint8_t array will be created this will need to be freed once done using it </td></tr>
|
||||
<tr><td class="paramname">length</td><td>length of the data read in </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a580578d50c6d90d08a00701285e28f3b" name="a580578d50c6d90d08a00701285e28f3b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a580578d50c6d90d08a00701285e28f3b">◆ </a></span>ARC_IO_WriteStrToFile()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_IO_WriteStrToFile </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>write string to file </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">path</td><td>a string to path of target file </td></tr>
|
||||
<tr><td class="paramname">data</td><td>data to be written </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- HTML footer for doxygen 1.9.2-->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../dc/dac/io_8h.html">io.h</a></li></ul>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
// script for doxygen 1.9.1
|
||||
$(function() {
|
||||
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
|
||||
toggleButton.title = "Toggle Light/Dark Mode"
|
||||
$(document).ready(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
$(window).resize(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
})
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
6
doc/doxygen/html/dc/dac/io_8h.js
Normal file
6
doc/doxygen/html/dc/dac/io_8h.js
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
var io_8h =
|
||||
[
|
||||
[ "ARC_IO_FileToStr", "dc/dac/io_8h.html#a264d33a54ba5175d36341c27011654f4", null ],
|
||||
[ "ARC_IO_ReadFileToUint8t", "dc/dac/io_8h.html#a70350710f6f2124edcd32cabd641f1f4", null ],
|
||||
[ "ARC_IO_WriteStrToFile", "dc/dac/io_8h.html#a580578d50c6d90d08a00701285e28f3b", null ]
|
||||
];
|
||||
175
doc/doxygen/html/dc/dac/io_8h_source.html
Normal file
175
doc/doxygen/html/dc/dac/io_8h_source.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!-- HTML header for doxygen 1.9.2-->
|
||||
<!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" class="dark-mode">
|
||||
<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.12.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/std/io.h Source File</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="../../navtreedata.js"></script>
|
||||
<script type="text/javascript" src="../../navtree.js"></script>
|
||||
<script type="text/javascript" src="../../resize.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" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
|
||||
</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">Archeus<span id="projectnumber"> 0.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.12.0 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(1); });
|
||||
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('../../',true,false,'search.php','Search',true);
|
||||
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('dc/dac/io_8h_source.html','../../'); initResizable(true); });
|
||||
/* @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">
|
||||
<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">io.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="../../dc/dac/io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_STD_IO_H_</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_IO_H_</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <stdint.h></span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "<a class="code" href="../../da/d66/string_8h.html">arc/std/string.h</a>"</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @brief get string and size from file</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * @param path a string to path of target file</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * @param data pointer to where uint8_t array will be created</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * this will need to be freed once done using it</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @param length length of the data read in</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">*/</span></div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../dc/dac/io_8h.html#a70350710f6f2124edcd32cabd641f1f4"> 19</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dc/dac/io_8h.html#a70350710f6f2124edcd32cabd641f1f4">ARC_IO_ReadFileToUint8t</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path, uint8_t **data, uint64_t *length);</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @brief get string and size from file</span></div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param path a string to path of target file</span></div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param data pointer to where string will be created</span></div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * this will need to be freed once done using it</span></div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">*/</span></div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="../../dc/dac/io_8h.html#a264d33a54ba5175d36341c27011654f4"> 28</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dc/dac/io_8h.html#a264d33a54ba5175d36341c27011654f4">ARC_IO_FileToStr</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> **data);</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @brief write string to file</span></div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param path a string to path of target file</span></div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param data data to be written</span></div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">*/</span></div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="../../dc/dac/io_8h.html#a580578d50c6d90d08a00701285e28f3b"> 36</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dc/dac/io_8h.html#a580578d50c6d90d08a00701285e28f3b">ARC_IO_WriteStrToFile</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *data);</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif </span><span class="comment">//ARC_STD_IO_H_</span></div>
|
||||
<div class="ttc" id="aio_8h_html_a264d33a54ba5175d36341c27011654f4"><div class="ttname"><a href="../../dc/dac/io_8h.html#a264d33a54ba5175d36341c27011654f4">ARC_IO_FileToStr</a></div><div class="ttdeci">void ARC_IO_FileToStr(ARC_String *path, ARC_String **data)</div><div class="ttdoc">get string and size from file</div></div>
|
||||
<div class="ttc" id="aio_8h_html_a580578d50c6d90d08a00701285e28f3b"><div class="ttname"><a href="../../dc/dac/io_8h.html#a580578d50c6d90d08a00701285e28f3b">ARC_IO_WriteStrToFile</a></div><div class="ttdeci">void ARC_IO_WriteStrToFile(ARC_String *path, ARC_String *data)</div><div class="ttdoc">write string to file</div></div>
|
||||
<div class="ttc" id="aio_8h_html_a70350710f6f2124edcd32cabd641f1f4"><div class="ttname"><a href="../../dc/dac/io_8h.html#a70350710f6f2124edcd32cabd641f1f4">ARC_IO_ReadFileToUint8t</a></div><div class="ttdeci">void ARC_IO_ReadFileToUint8t(ARC_String *path, uint8_t **data, uint64_t *length)</div><div class="ttdoc">get string and size from file</div></div>
|
||||
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</a></div></div>
|
||||
<div class="ttc" id="astructARC__String_html"><div class="ttname"><a href="../../df/d06/structARC__String.html">ARC_String</a></div><div class="ttdoc">substring position within a string</div><div class="ttdef"><b>Definition</b> <a href="../../da/d66/string_8h_source.html#l00014">string.h:14</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- HTML footer for doxygen 1.9.2-->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../dc/dac/io_8h.html">io.h</a></li></ul>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
// script for doxygen 1.9.1
|
||||
$(function() {
|
||||
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
|
||||
toggleButton.title = "Toggle Light/Dark Mode"
|
||||
$(document).ready(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
$(window).resize(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
})
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue