apio/sapphire
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
06d7f6bb09
sapphire/docs/html/_file_i_o_8h_source.html

120 lines
7.8 KiB
HTML
Raw Normal View History

updates
2022-07-02 10:03:06 +00:00
<!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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>sapphirec: src/FileIO.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="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>
<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"/>
</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">sapphirec
</div>
<div id="projectbrief">The Sapphire documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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('_file_i_o_8h_source.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 class="header">
<div class="headertitle">
<div class="title">FileIO.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_file_i_o_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sapphirepch_8h.html">sapphirepch.h</a>&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">/* Namespace for simple file operations. */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="namespace_file_i_o.html"> 5</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_file_i_o.html">FileIO</a></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;{</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">/* Helper function to read all of a file&#39;s contents. */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;std::string <a class="code" href="namespace_file_i_o.html#ab49a427f3ddb1f750b4314dfdb17be2b">read_all</a>(<span class="keyword">const</span> std::string&amp; filename);</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">/* Helper function to write a string to a file. */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespace_file_i_o.html#a84b962dcd17d16c361902d8b179d3b47">write_all</a>(<span class="keyword">const</span> std::string&amp; filename, <span class="keyword">const</span> std::string&amp; contents);</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">/* Return a filename without its extension. */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;std::string <a class="code" href="namespace_file_i_o.html#a3aa60357e37b7acc57f3e89e80d6e7a4">remove_file_extension</a>(<span class="keyword">const</span> std::string&amp; filename);</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;} <span class="comment">// namespace FileIO</span></div>
<div class="ttc" id="anamespace_file_i_o_html"><div class="ttname"><a href="namespace_file_i_o.html">FileIO</a></div><div class="ttdef"><b>Definition:</b> FileIO.h:6</div></div>
<div class="ttc" id="anamespace_file_i_o_html_a3aa60357e37b7acc57f3e89e80d6e7a4"><div class="ttname"><a href="namespace_file_i_o.html#a3aa60357e37b7acc57f3e89e80d6e7a4">FileIO::remove_file_extension</a></div><div class="ttdeci">std::string remove_file_extension(const std::string &amp;filename)</div><div class="ttdef"><b>Definition:</b> FileIO.cpp:42</div></div>
<div class="ttc" id="anamespace_file_i_o_html_a84b962dcd17d16c361902d8b179d3b47"><div class="ttname"><a href="namespace_file_i_o.html#a84b962dcd17d16c361902d8b179d3b47">FileIO::write_all</a></div><div class="ttdeci">void write_all(const std::string &amp;filename, const std::string &amp;contents)</div><div class="ttdef"><b>Definition:</b> FileIO.cpp:35</div></div>
<div class="ttc" id="anamespace_file_i_o_html_ab49a427f3ddb1f750b4314dfdb17be2b"><div class="ttname"><a href="namespace_file_i_o.html#ab49a427f3ddb1f750b4314dfdb17be2b">FileIO::read_all</a></div><div class="ttdeci">std::string read_all(const std::string &amp;filename)</div><div class="ttdef"><b>Definition:</b> FileIO.cpp:9</div></div>
<div class="ttc" id="asapphirepch_8h_html"><div class="ttname"><a href="sapphirepch_8h.html">sapphirepch.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_file_i_o_8h.html">FileIO.h</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.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink