144 lines
6.7 KiB
HTML
144 lines
6.7 KiB
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.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MacStd: MacStd</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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<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" />
|
|
</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">MacStd
|
|
</div>
|
|
<div id="projectbrief">OS X API using Standard C++</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(0); });
|
|
/* @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',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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><div class="header">
|
|
<div class="headertitle"><div class="title">MacStd </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><a class="anchor" id="md__r_e_a_d_m_e"></a></p>
|
|
<p>Provides templates and function helpers for OS X API using Standard C++ in XCode 13+</p>
|
|
<h1><a class="anchor" id="autotoc_md1"></a>
|
|
Features</h1>
|
|
<h2><a class="anchor" id="autotoc_md2"></a>
|
|
Portable</h2>
|
|
<p>This project does not require building. Just <code>#include</code> individual files from this repository into your source code and get started.</p>
|
|
<h2><a class="anchor" id="autotoc_md3"></a>
|
|
Functions and Templates</h2>
|
|
<p>Different OS X API functions have different ways of returning variable-sized data. Getting tired of carefully studying manpages for each particular API function how to preallocate the output memory correctly? We too...</p>
|
|
<p>MacStd provides a subset of OS X API identically named functions (C++ polymorphism to the rescue), where one can use <code>std::string</code>, <code>std::wstring</code>, <code>std::vector<></code> etc. as an output parameter. MacStd handles all the dirty work with memory allocation for you, so you can focus on your code.</p>
|
|
<h3><a class="anchor" id="autotoc_md4"></a>
|
|
Example</h3>
|
|
<div class="fragment"><div class="line"> ++</div>
|
|
<div class="line">std::string path;</div>
|
|
<div class="line">_NSGetExecutablePath(path);</div>
|
|
<div class="line">std::cout << path.c_str() << std::endl;</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md5"></a>
|
|
What MacStd Is Not</h1>
|
|
<p>MacStd is not trying to be a full-fledged object-oriented framework on top of OS X API. MacStd aims at augmenting OS X API with a little bit of help from C++.</p>
|
|
<h1><a class="anchor" id="autotoc_md6"></a>
|
|
Usage</h1>
|
|
<ol type="1">
|
|
<li>Clone the repository into your solution folder.</li>
|
|
<li>Add MacStd's <code>include</code> folder to <em>Header Search Paths</em> in your project's C/C++ settings.</li>
|
|
<li>Include <code>.h</code> files from MacStd as needed: <div class="fragment"><div class="line"> ++</div>
|
|
<div class="line"><span class="preprocessor">#include <MacStd/dyld.hpp></span></div>
|
|
<div class="line"><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><span class="preprocessor">#include <iostream></span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keyword">using namespace </span>std;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">void</span> main()</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> wstring path;</div>
|
|
<div class="line"> _NSGetExecutablePath(path);</div>
|
|
<div class="line"> wcout << path.c_str() << endl;</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --></li>
|
|
</ol>
|
|
<p>An auto-generated documentation is <a href="https://amebis.github.io/MacStd/">here</a>.</p>
|
|
<p>More examples can also be found in the <code><a class="el" href="interface_tests.html">Tests</a></code> project.</p>
|
|
<p>This is a one-man project for the time being, so the OS X API support is far from complete. It is added as needed. Contributions are welcome. </p>
|
|
</div></div><!-- PageDoc -->
|
|
<a href="doxygen_crawl.html"></a>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Sep 16 2024 09:09:04 for MacStd by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|