-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__cmake.html
171 lines (169 loc) · 9.07 KB
/
group__cpp__cmake.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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<!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>Kodi Development: CMake addon creation structure</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</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&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__cmake.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">CMake addon creation structure<div class="ingroups"><a class="el" href="group__cpp.html">C++</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><b>CMake help macros to create addon for Kodi</b> </p>
<p>Kodi which uses it as a library for its binary addons has a special build system for this.</p>
<p>To implement this, a CMake macro brought by Kodi is used, this is "build_addon (...)". This processes various definitions passed by the addon to process the construction.</p>
<hr />
<p><b>Here a minmal example of the for addon used CMakeLists.txt:</b></p>
<div class="fragment"><div class="line">cmake_minimum_required(VERSION 3.5)</div>
<div class="line">project(example.addon)</div>
<div class="line"> </div>
<div class="line">set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR})</div>
<div class="line"> </div>
<div class="line">find_package(Kodi REQUIRED)</div>
<div class="line"> </div>
<div class="line">include_directories(${KODI_INCLUDE_DIR}</div>
<div class="line"> </div>
<div class="line">set(DEPLIBS ) # Here empty</div>
<div class="line">set(EXAMPLE_SOURCES src/main.cpp)</div>
<div class="line">set(EXAMPLE_HEADERS src/main.h)</div>
<div class="line"> </div>
<div class="line">build_addon((example.addon EXAMPLE DEPLIBS)</div>
<div class="line"> </div>
<div class="line">include(CPack)</div>
</div><!-- fragment --><hr />
<p>This is a list of special variables that can be passed to the macro. The parts defined with "*" must be given the second name given to the macro.</p>
<p>Here to define the necessary creation and installation files on addon CMakeLists.txt: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name </th><th class="markdownTableHeadNone">Description </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">*_SOURCES </td><td class="markdownTableBodyNone">List of source code files to be complicated. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">*_HEADERS </td><td class="markdownTableBodyNone">List of used source code header files. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">*_CUSTOM_BINARY </td><td class="markdownTableBodyNone">For special cases where an already created library from an external source is inserted, the <b>"* _SOURCES"</b> and <b>"* _HEADERS"</b> are unused in this case.<br />
This is currently used primarily on game addons. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">*_CUSTOM_DATA </td><td class="markdownTableBodyNone">To add additional required data from a folder, which are stored in the shared folder of the addon.<br />
With a "/" at the end of the content given to the folder is used, without the folder itself. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">*_ADDITIONAL_BINARY </td><td class="markdownTableBodyNone">In case the additional library has to be installed for the addon, the path or CMake name can be given here. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">*_ADDITIONAL_BINARY_EXE </td><td class="markdownTableBodyNone">In case you need to addon an additional application you can give the path or CMake name, it will be in the same folder as the addon library.<br />
The mode bits are set there as EXE. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">*_ADDITIONAL_BINARY_DIRS </td><td class="markdownTableBodyNone">To add complete folders additionally to folders containing the addon library.<br />
With a "/" at the end of the content given to the folder is used, without the folder itself. </td></tr>
</table>
<p>External creation Options, given by <code>-D...</code>: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name </th><th class="markdownTableHeadNone">Description </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">PACKAGE_ZIP </td><td class="markdownTableBodyNone">To create a package as a ZIP file. This is also used to install locally addon together.<br />
Default is OFF. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">PACKAGE_TGZ </td><td class="markdownTableBodyNone">To create a package as a TGZ file.<br />
Default is OFF. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">BUILD_SHARED_LIBS </td><td class="markdownTableBodyNone">To define if addon library is shared or static.<br />
Default is ON to have shared. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">USE_LTO </td><td class="markdownTableBodyNone">Use link time optimization.<br />
Default is OFF. </td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>