-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathindex.html
102 lines (100 loc) · 4.96 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Home2L - C/C++ API: Home2L - C/C++ API</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="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="projectlogo"><img alt="Logo" src="home2l-icon-web.png"/></td>
<td id="projectalign">
<div id="projectname">Home2L - C/C++ API<span id="projectnumber"> v1.4-0-g38cc (2024-05-25)</span>
</div>
<div id="projectbrief">Smart Tools for a Private Home</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">Home2L - C/C++ API </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p >This is the documentation of the <b>C/C++ API</b> of the <em>Home2L</em> suite. It is meant as a reference for developers of</p><ul>
<li>resource drivers,</li>
<li>new <em>WallClock</em> applets and</li>
<li>new software tools using the <em>Home2L Resources</em> library.</li>
</ul>
<p >The main documentation of the <em>Home2L</em> project can be found in the <a href="../home2l-book.pdf"><em>Home2L Book</em></a>. Automation rules are best written using the <a href="../home2l-api_python/index.html"><em>Python API</em></a>.</p>
<p >To get started, navigate to the <a href="modules.html">Modules</a> page.</p>
<h2>Notes </h2>
<h3>Coding Conventions</h3>
<p >Obviously, the source files are no pure C, but have a C++ suffix, are compiled with a C++ compiler, and contain classes. However, for portability, efficiency and readability reasons, C++ language features are used only in a limited way. The reason for using C++ at all instead of pure C are the base classes and the UI modules, where operand overloading (base classes) and inheritance with virtual mathods (UI classes) are very helpful to improve the readability of code.</p>
<p >For these reasons, the following conventions apply:</p><ol type="1">
<li>All C code is C99-compliant and C++-compliant. All C++ code complies to C++98 (the GCC default in GCC 6.1).</li>
<li>No classes or templates from standard C++ libraries are used (STL/libstdc++).</li>
<li>From C++, only the following syntax constructs are generally used:<ul>
<li>classes with constructors, destructors, methods, either virtual or not</li>
<li>operators 'new' and 'delete'</li>
<li>no reference arguments to methods (unless for copy constructors)</li>
</ul>
</li>
<li>Only in modules <a class="el" href="group__common__strings.html">Strings</a> and <a class="el" href="group__common__containers.html">Containers</a>, the following additional constructs may occur:<ul>
<li>overloaded operator []</li>
<li>templates (to be used very carefully) </li>
</ul>
</li>
</ol>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.4
</small></address>
</body>
</html>