Adding cmake file at the root directory

[apps/app-templates.git] / README.md

diff --git a/README.md b/README.md
index 7ad999d..97009df 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ To use these templates files on your project just install the reference files us
 ```bash
 git submodule add https://gerrit.automotivelinux.org/gerrit/p/apps/app-templates.git conf.d/app-templates
 mkdir conf.d/cmake
 ```bash
 git submodule add https://gerrit.automotivelinux.org/gerrit/p/apps/app-templates.git conf.d/app-templates
 mkdir conf.d/cmake

-cp conf.d/app-templates/cmake/config.cmake.sample conf.d/cmake/config.cmake
+cp conf.d/app-templates/samples.d/config.cmake.sample conf.d/cmake/config.cmake

 ```
 
 Edit the copied config.cmake file to fit your needs.
 ```
 
 Edit the copied config.cmake file to fit your needs.


@@ -39,7 +39,7 @@ An example is available in **app-templates** submodule that you can copy and
 use:
 
 ```bash
 use:
 
 ```bash

-cp conf.d/app-templates/cmake/CMakeLists.txt.sample CMakeLists.txt
+cp conf.d/app-templates/samples.d/CMakeLists.txt.sample CMakeLists.txt

 ```
 
 ### Create your CMake targets
 ```
 
 ### Create your CMake targets


@@ -48,7 +48,7 @@ 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
 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. 
+***PROJECT_TARGET_ADD*** is invoked with a new target name.

 
 So, typical usage defining a target is:
 
 
 So, typical usage defining a target is:
 


@@ -59,8 +59,6 @@ add_executable/add_library(${TARGET_NAME}.... --> defining your target sources
 
 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
 for macros usage
 
 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties
 for macros usage

-
-INSTALL(TARGETS ${TARGET_NAME}....

 ```
 
 ### Targets PROPERTIES
 ```
 
 ### Targets PROPERTIES


@@ -74,20 +72,40 @@ widget package with the property **LABELS**:
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework

-- **HTDOCS**: Root directory of a web app
-- **DATA**: Resources used by your application
+- **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 Alternatively, you can choose the name, without the extension, using macro
+ **set_openapi_filename**. If you use C++, you have to set
+ **PROJECT_LANGUAGES** with *CXX*.
+- **PLUGIN**: Shared library meant to be used as a binding plugin. Binding
+ would load it as a plugin to extend its functionnalities. It should be named
+ with a special extension that you choose with SUFFIX cmake target property or
+ it'd be **.ctlso** by default.
+- **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
 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework

+- **LIBRARY**: An external 3rd party library bundled with the binding for its
+ own purpose because platform doesn't provide it.
+
+> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
+> stand for **Application Framework Binding**.

 
 ```cmake
 SET_TARGET_PROPERTIES(${TARGET_NAME}
        PREFIX "afb-"
 
 ```cmake
 SET_TARGET_PROPERTIES(${TARGET_NAME}
        PREFIX "afb-"

-       LABELS "BINDING"
-       OUTPUT_NAME "file_output_name")
+       LABELS "BINDINGV2"
+       OUTPUT_NAME "file_output_name"
+)

 ```
 
 ```
 

-> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
-> stand for **Application Framework Binding**.
+> **NOTE**: You doesn't need to specify an **INSTALL** command for these
+> targets. This is already handle by template and will be installed in the
+> following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**

 
 ## More details: Typical project architecture
 
 
 ## More details: Typical project architecture
 


@@ -106,24 +124,34 @@ A typical project architecture would be :
 │   │       └── autobuild
 │   ├── app-templates/
 │   │   ├── README.md
 │   │       └── autobuild
 │   ├── app-templates/
 │   │   ├── README.md

-│   │   ├── autobuild/
-│   │   │   ├── agl
-│   │   │   │   └── autobuild.in
-│   │   │   ├── linux
-│   │   │   │   └── autobuild.in
-│   │   │   └── windows
-│   │   │       └── autobuild.in

 │   │   ├── cmake/
 │   │   ├── cmake/

-│   │   │   ├── config.cmake.sample

 │   │   │   ├── export.map
 │   │   │   └── macros.cmake
 │   │   │   ├── export.map
 │   │   │   └── macros.cmake

-│   │   ├── deb/
-│   │   │   └── config.deb.in
-│   │   ├── rpm/
-│   │   │   └── config.spec.in
+│   │   ├── samples.d/
+│   │   │   ├── CMakeLists.txt.sample
+│   │   │   ├── config.cmake.sample
+│   │   │   ├── config.xml.in.sample
+│   │   │   └── xds-config.env.sample
+│   │   ├── template.d/
+│   │   │   ├── autobuild/
+│   │   │   │   ├── agl
+│   │   │   │   │   └── autobuild.in
+│   │   │   │   ├── linux
+│   │   │   │   │   └── autobuild.in
+│   │   │   │   └── windows
+│   │   │   │       └── autobuild.in
+│   │   │   ├── config.xml.in
+│   │   │   ├── deb-config.dsc.in
+│   │   │   ├── deb-config.install.in
+│   │   │   ├── debian.changelog.in
+│   │   │   ├── debian.compat.in
+│   │   │   ├── debian.rules.in
+│   │   │   ├── gdb-on-target.ini.in
+│   │   │   ├── install-wgt-on-target.sh.in
+│   │   │   ├── start-on-target.sh.in
+│   │   │   ├── rpm-config.spec.in
+│   │   │   └── xds-project-target.conf.in

 │   │   └── wgt/
 │   │   └── wgt/

-│   │       ├── config.xml.in
-│   │       ├── config.xml.in.sample

 │   │       ├── icon-default.png
 │   │       ├── icon-html5.png
 │   │       ├── icon-native.png
 │   │       ├── icon-default.png
 │   │       ├── icon-html5.png
 │   │       ├── icon-native.png


@@ -215,10 +243,28 @@ application, macros make the difference using ***LABELS*** property.
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework
 Choose between:
 
 - **BINDING**: Shared library that be loaded by the AGL Application Framework

-- **HTDOCS**: Root directory of a web app
-- **DATA**: Resources used by your application
+- **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 Alternatively, you can choose the name, without the extension, using macro
+ **set_openapi_filename**. If you use C++, you have to set
+ **PROJECT_LANGUAGES** with *CXX*.
+- **PLUGIN**: Shared library meant to be used as a binding plugin. Binding
+ would load it as a plugin to extend its functionnalities. It should be named
+ with a special extension that you choose with SUFFIX cmake target property or
+ it'd be **.ctlso** by default.
+- **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
 - **EXECUTABLE**: Entry point of your application executed by the AGL
  Application Framework

+- **LIBRARY**: An external 3rd party library bundled with the binding for its
+ own purpose because platform doesn't provide it.
+
+> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
+> stand for **Application Framework Binding**.

 
 Example:
 
 
 Example:
 


@@ -229,17 +275,104 @@ SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
        )
 ```
 
        )
 ```
 

-If your target output is not named as the ***TARGET_NAME***, you need to specify
-***OUTPUT_NAME*** property that will be used by the ***populate_widget*** macro.
+> **NOTE**: You doesn't need to specify an **INSTALL** command for these
+> targets. This is already handle by template and will be installed in the
+> following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**
+
+> **NOTE**: if you want to set and use `rpath` with your target you should use
+> and set the target property `INSTALL_RPATH`.
+
+## Add external 3rd party library
+
+### Build, link and ship external library with the project
+
+You could need to include an external library that isn't shipped in the
+platform. Then you have to bundle the required library in the `lib` widget
+directory.
+
+Templates includes some facilities to help you to do so. Classic way to do so
+is to declare as many CMake ExternalProject as library you need.
+
+An ExternalProject is a special CMake module that let you define how to:
+download, update, patch, configure, build and install an external project. It
+doesn't have to be a CMake project and custom step could be added for special
+needs using ExternalProject step. More informations on CMake [ExternalProject
+documentation site](https://cmake.org/cmake/help/v3.5/module/ExternalProject.html?highlight=externalproject).
+
+Example to include `mxml` library for [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
+project:
+
+```cmake
+set(MXML external-mxml)
+set(MXML_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/mxml)
+ExternalProject_Add(${MXML}
+    GIT_REPOSITORY https://github.com/michaelrsweet/mxml.git
+    GIT_TAG release-2.10
+    SOURCE_DIR ${MXML_SOURCE_DIR}
+    CONFIGURE_COMMAND ./configure --build x86_64 --host aarch64
+    BUILD_COMMAND make libmxml.so.1.5
+    BUILD_IN_SOURCE 1
+    INSTALL_COMMAND ""
+)
+
+PROJECT_TARGET_ADD(mxml)
+
+add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL)
+
+SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
+    LABELS LIBRARY
+    IMPORTED_LOCATION ${MXML_SOURCE_DIR}/libmxml.so.1
+    INTERFACE_INCLUDE_DIRECTORIES ${MXML_SOURCE_DIR}
+)
+
+add_dependencies(${TARGET_NAME} ${MXML})
+```
+
+Here we define an external project that drive the build of the library then we
+define new CMake target of type **IMPORTED**. Meaning that this target hasn't
+been built using CMake but is available at the location defined in the target
+property *IMPORTED_LOCATION*.
+
+You could want to build the library as *SHARED* or *STATIC* depending on your needs
+and goals. Then you only have to modify the external project configure step and change
+filename used by **IMPORTED** library target defined after external project.
+
+Then target *LABELS* property is set to **LIBRARY** to ship it in the widget.
+
+Unicens project also need some header from this library, so we use the target
+property *INTERFACE_INCLUDE_DIRECTORIES*. Setting that when another target link
+to that imported target, it can access to the include directories.
+
+We bound the target to the external project using a CMake dependency at last.

 
 

-Use the ***populate_widget*** macro as latest statement of your target
-definition. Then at the end of your project definition you should use the macro
-***build_widget*** that make an archive from the populated widget tree using the
-`wgtpkg-pack` Application Framework tools.
+Then this target could be use like any other CMake target and be linked etc.

 
 

-## Macro reference
+### Only link and ship external library with the project

 
 

-### PROJECT_TARGET_ADD
+If you already have a binary version of the library that you want to use and you
+can't or don't want to build the library then you only have to add an **IMPORTED**
+library target.
+
+So, taking the above example, `mxml` library inclusion would be:
+
+```cmake
+PROJECT_TARGET_ADD(mxml)
+
+add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL)
+
+SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
+    LABELS LIBRARY
+    IMPORTED_LOCATION /path/to/library/libmxml.so.1
+    INTERFACE_INCLUDE_DIRECTORIES /path/to/mxml/include/dir
+)
+```
+
+Finally, you can link any other lib or executable target with this imported
+library like any other target.
+
+#### Macro reference
+
+##### PROJECT_TARGET_ADD

 
 Typical usage would be to add the target to your project using macro
 `PROJECT_TARGET_ADD` with the name of your target as parameter.
 
 Typical usage would be to add the target to your project using macro
 `PROJECT_TARGET_ADD` with the name of your target as parameter.


@@ -254,7 +387,7 @@ PROJECT_TARGET_ADD(low-can-demo)
 > set with the specificied name. This variable will change at the next call
 > to this macros.
 
 > set with the specificied name. This variable will change at the next call
 > to this macros.
 

-### project_subdirs_add
+##### project_subdirs_add

 
 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 it will be added to your project. This could be use in an hybrid application by
 
 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 it will be added to your project. This could be use in an hybrid application by


@@ -276,10 +409,47 @@ anything:
 project_subdirs_add("[0-9]-*")
 ```
 
 project_subdirs_add("[0-9]-*")
 ```
 

-## Advanced customization
+### set_openapi_filename
+
+Used with a target labelized **BINDINGV2** to define the file name, and
+possibly a relative path with the current *CMakeLists.txt*.
+
+If you don't use that macro to specify the name of your definition file
+then the default one will be used, *${OUTPUT_NAME}-apidef* with
+**OUTPUT_NAME** as the [target property].
+
+> **CAUTION** you must only specify the name **WITHOUT** the extension.
+
+```cmake
+set_openapi_filename('binding/mybinding_definition')
+```
+
+[target property]: https://cmake.org/cmake/help/v3.6/prop_tgt/OUTPUT_NAME.html "OUTPUT_NAME property documentation"
+
+### add_input_files
+
+Create custom target dedicated for HTML5 and data resource files. This macro
+provides syntax and schema verification for differents languages which are
+about now: LUA, JSON and XML.
+
+You could change the tools used to check files with the following variables:
+
+- XML_CHECKER: set to use **xmllint** provided with major linux distribution.
+- LUA_CHECKER: set to use **luac** provided with major linux distribution.
+- JSON_CHECKER: no tools found at the moment.
+
+```cmake
+add_input_file("${MY_FILES_LIST}")
+```
+
+> **NOTE**: an issue at the check step on a file will stop at the build step.
+
+## Advanced build customization

 
 ### Including additionnals cmake files
 
 
 ### Including additionnals cmake files
 

+#### Machine and system custom cmake files
+

 Advanced tuning is possible using addionnals cmake files that are included
 automatically from some specifics locations. They are included in that order:
 
 Advanced tuning is possible using addionnals cmake files that are included
 automatically from some specifics locations. They are included in that order:
 


@@ -287,8 +457,13 @@ automatically from some specifics locations. They are included in that order:
 - Home CMake files located in _$HOME/.config/app-templates/cmake.d_
 - System CMake files located in _/etc/app-templates/cmake.d_
 
 - Home CMake files located in _$HOME/.config/app-templates/cmake.d_
 - System CMake files located in _/etc/app-templates/cmake.d_
 

-CMake files has to be named using the following convention: `XX-***.cmake`,
-where `XX` are numbers, `***` file name (ie. `99-my_customs.cmake`).
+CMake files has to be named using the following convention: `XX-common*.cmake`
+or `XX-${PROJECT_NAME}*.cmake`, where `XX` are numbers, `*` file name
+(ie. `99-common-my_customs.cmake`).
+
+> **NOTE** You need to specify after numbers that indicate include order, to
+which project that file applies, if it applies to all project then use keyword
+`common`.

 
 So, saying that you should be aware that every normal cmake variables used at
 project level could be overwrited by home or system located cmake files if
 
 So, saying that you should be aware that every normal cmake variables used at
 project level could be overwrited by home or system located cmake files if


@@ -301,6 +476,28 @@ Example:
 set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring')
 ```
 
 set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring')
 ```
 

+#### OS custom cmake files
+
+This is meant to personalize the project depending on the OS your are using.
+At the end of config.cmake, common.cmake will include lot of cmake file to
+customize project build depending on your plateform. It will detect your OS
+deducing it from file _/etc/os-release_ now as default in almost all Linux
+distribution.
+
+So you can use the value of field **ID_LIKE** or **ID** if the
+first one doesn't exists and add a cmake file for that distribution in your
+_conf.d/cmake/_ directory or relatively to your _app-templates_ submodule path
+_app-templates/../cmake/_
+
+Those files has to be named use the following scheme _XX-${OSRELEASE}*.cmake_
+where _XX_ are numbers, ${OSRELEASE} the **ID_LIKE** or **ID** field from
+_/etc/os-release_ file. You can also define default OS configuration file
+to use as fallback is none specific OS configuration is available using the
+scheme _XX-default*.cmake_. Then is you need by example a module that isn't
+named the same in one distro only, you only has to define a specific file to
+handle that case then for all the other case put the configuration in the
+default file.
+

 ### Include customs templated scripts
 
 As well as for additionnals cmake files you can include your own templated
 ### Include customs templated scripts
 
 As well as for additionnals cmake files you can include your own templated