blob: 9aad1ef7f5e63de1c886740da9a898c5588cbde0 (
plain)
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
|
# Quickstart
## Initialization
To use these templates files on your project just install the reference files using
**git submodule** then use `config.cmake` file to configure your project specificities :
```bash
git submodule add https://gerrit.automotivelinux.org/gerrit/apps/app-templatesconf.d/app-templates conf.d/app-templates
mkdir conf.d/cmake
cp conf.d/app-templates/cmake/config.cmake.sample conf.d/cmake/config.cmake
```
Edit the copied config.cmake file to fit your needs.
Now, create your top CMakeLists.txt file which include `config.cmake` file.
An example is available in **app-templates** submodule that you can copy and
use:
```bash
cp conf.d/app-templates/cmake/CMakeLists.txt CMakeLists.txt
```
## Create your CMake targets
For each target part of your project, you need to use ***PROJECT_TARGET_ADD***
to include this target to your project.
Using it, make available the cmake variable ***TARGET_NAME*** until the next
***PROJECT_TARGET_ADD*** is invoked with a new target name.
So, typical usage defining a target is:
```cmake
PROJECT_TARGET_ADD(SuperExampleName) --> Adding target to your project
add_executable/add_library(${TARGET_NAME}.... --> defining your target sources
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
for macros usage
INSTALL(TARGETS ${TARGET_NAME}....
```
## Targets PROPERTIES
You should set properties on your targets that will be used to package your
apps in a widget file that could be installed on an AGL system.
Specify what is the type of your targets that you want to be included in the
widget package with the property **LABELS**:
Choose between:
- **BINDING**: Shared library that be loaded by the AGL Application Framework
- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework.
This has to be accompagnied with a JSON file named like the *${OUTPUT_NAME}-apidef* of
the target that describe the API with OpenAPI syntax (e.g: *mybinding-apidef*).
Or you can choose the name by setting the *CACHE* cmake variable *OPENAPI_DEF*
(***CAUTION***: setting a CACHE variable is needed, or set a normal variable
with the *PARENT_SCOPE* option to make it visible for the parent scope
where the target is defined) JSON file will be used to generate header file
using `afb-genskel` tool.
- **HTDOCS**: Root directory of a web app. This target has to build its
directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
- **DATA**: Resources used by your application. This target has to build its
directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
- **EXECUTABLE**: Entry point of your application executed by the AGL
Application Framework
```cmake
SET_TARGET_PROPERTIES(${TARGET_NAME}
PREFIX "afb-"
LABELS "BINDING"
OUTPUT_NAME "file_output_name")
```
> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
> stand for **Application Framework Binding**.
|
