docs/dev_guide/3_advanced_usage.md

   1 # Build a widget
   2
   3 ## config.xml.in file
   4
   5 To build a widget you need a _config.xml_ file describing what is your apps and
   6 how Application Framework would launch it. This repo provide a simple default
   7 file _config.xml.in_ that should work for simple application without
   8 interactions with others bindings.
   9
  10 It is recommanded that you use the sample one which is more complete. You can
  11 find it at the same location under the name _config.xml.in.sample_ (stunning
  12 isn't it). Just copy the sample file to your _conf.d/wgt_ directory and name it
  13 _config.xml.in_, then edit it to fit your needs.
  14
  15 > ***CAUTION*** : The default file is only meant to be use for a
  16 > simple widget app, more complicated ones which needed to export
  17 > their api, or ship several app in one widget need to use the provided
  18 > _config.xml.in.sample_ which had all new Application Framework
  19 > features explained and examples.
  20
  21 ## Using cmake template macros
  22
  23 To leverage all cmake templates features, you have to specify ***properties***
  24 on your targets. Some macros will not works without specifying which is the
  25 target type.
  26
  27 As the type is not always specified for some custom targets, like an ***HTML5***
  28 application, macros make the difference using ***LABELS*** property.
  29
  30 Choose between:
  31
  32 - **BINDING**: Shared library that be loaded by the AGL Application Framework
  33 - **BINDINGV2**: Shared library that be loaded by the AGL Application Framework
  34  This has to be accompagnied with a JSON file named like the
  35  *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI
  36  syntax (e.g: *mybinding-apidef*).
  37  Or Alternatively, you can choose the name, without the extension, using macro
  38  **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES**
  39  with *CXX*.
  40 - **BINDINGV3**: Shared library that be loaded by the AGL Application Framework
  41  This has to be accompagnied with a JSON file named like the
  42  *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI
  43  syntax (e.g: *mybinding-apidef*).
  44  Or Alternatively, you can choose the name, without the extension, using macro
  45  **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES**
  46  with *CXX*.
  47 - **PLUGIN**: Shared library meant to be used as a binding plugin. Binding
  48  would load it as a plugin to extend its functionnalities. It should be named
  49  with a special extension that you choose with SUFFIX cmake target property or
  50  it'd be **.ctlso** by default.
  51 - **HTDOCS**: Root directory of a web app. This target has to build its
  52  directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
  53 - **DATA**: Resources used by your application. This target has to build its
  54  directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
  55 - **EXECUTABLE**: Entry point of your application executed by the AGL
  56  Application Framework
  57 - **LIBRARY**: An external 3rd party library bundled with the binding for its
  58  own purpose because platform doesn't provide it.
  59 - **BINDING-CONFIG**: Any files used as configuration by your binding.
  60
  61 Two optionnals **LABELS** are available to define which resources are your tests
  62 materials:
  63
  64 - **TEST-CONFIG**: JSON configuration files that will be used by the afb-test
  65  binding to know how to execute tests.
  66 - **TEST-DATA**: Resources used to test your binding. It is at least your test
  67  plan and also could be fixtures and any needed files by your tests. These files
  68  will appear in a separate test widget.
  69
  70 Here is a mapping between LABELS and directories where files will be puted in
  71 the widget:
  72
  73 - **EXECUTABLE** : \<wgtrootdir\>/bin
  74 - **BINDING-CONFIG** : \<wgtrootdir\>/etc
  75 - **BINDING** | **BINDINGV2** | **BINDINGV3** | **LIBRARY** : \<wgtrootdir\>/lib
  76 - **PLUGIN** : \<wgtrootdir\>/lib/plugins
  77 - **HTDOCS** : \<wgtrootdir\>/htdocs
  78 - **BINDING-DATA** : \<wgtrootdir\>/var
  79 - **DATA** : \<wgtrootdir\>/var
  80
  81 And about test dedicated **LABELS**:
  82
  83 - **TEST-CONFIG** : \<TESTwgtrootdir\>/etc
  84 - **TEST-DATA** : \<TESTwgtrootdir\>/var
  85
  86 > **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
  87 > stand for **Application Framework Binding**.
  88
  89 Example:
  90
  91 ```cmake
  92 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
  93                 LABELS "HTDOCS"
  94                 OUTPUT_NAME dist.prod
  95         )
  96 ```
  97
  98 > **NOTE**: You doesn't need to specify an **INSTALL** command for these
  99 > targets. This is already handle by template and will be installed in the
 100 > following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**
 101
 102 > **NOTE**: if you want to set and use `rpath` with your target you should use
 103 > and set the target property `INSTALL_RPATH`.
 104
 105 ## Add external 3rd party library
 106
 107 ### Build, link and ship external library with the project
 108
 109 You could need to include an external library that isn't shipped in the
 110 platform. Then you have to bundle the required library in the `lib` widget
 111 directory.
 112
 113 Templates includes some facilities to help you to do so. Classic way to do so
 114 is to declare as many CMake ExternalProject as library you need.
 115
 116 An ExternalProject is a special CMake module that let you define how to:
 117 download, update, patch, configure, build and install an external project. It
 118 doesn't have to be a CMake project and custom step could be added for special
 119 needs using ExternalProject step. More informations on CMake [ExternalProject
 120 documentation site](https://cmake.org/cmake/help/v3.5/module/ExternalProject.html?highlight=externalproject).
 121
 122 Example to include `mxml` library for [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
 123 project:
 124
 125 ```cmake
 126 set(MXML external-mxml)
 127 set(MXML_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/mxml)
 128 ExternalProject_Add(${MXML}
 129     GIT_REPOSITORY https://github.com/michaelrsweet/mxml.git
 130     GIT_TAG release-2.10
 131     SOURCE_DIR ${MXML_SOURCE_DIR}
 132     CONFIGURE_COMMAND ./configure --build x86_64 --host aarch64
 133     BUILD_COMMAND make libmxml.so.1.5
 134     BUILD_IN_SOURCE 1
 135     INSTALL_COMMAND ""
 136 )
 137
 138 PROJECT_TARGET_ADD(mxml)
 139
 140 add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL)
 141
 142 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
 143     LABELS LIBRARY
 144     IMPORTED_LOCATION ${MXML_SOURCE_DIR}/libmxml.so.1
 145     INTERFACE_INCLUDE_DIRECTORIES ${MXML_SOURCE_DIR}
 146 )
 147
 148 add_dependencies(${TARGET_NAME} ${MXML})
 149 ```
 150
 151 Here we define an external project that drive the build of the library then we
 152 define new CMake target of type **IMPORTED**. Meaning that this target hasn't
 153 been built using CMake but is available at the location defined in the target
 154 property *IMPORTED_LOCATION*.
 155
 156 You could want to build the library as *SHARED* or *STATIC* depending on your needs
 157 and goals. Then you only have to modify the external project configure step and change
 158 filename used by **IMPORTED** library target defined after external project.
 159
 160 Then target *LABELS* property is set to **LIBRARY** to ship it in the widget.
 161
 162 Unicens project also need some header from this library, so we use the target
 163 property *INTERFACE_INCLUDE_DIRECTORIES*. Setting that when another target link
 164 to that imported target, it can access to the include directories.
 165
 166 We bound the target to the external project using a CMake dependency at last.
 167
 168 Then this target could be use like any other CMake target and be linked etc.
 169
 170 ### Only link and ship external library with the project
 171
 172 If you already have a binary version of the library that you want to use and you
 173 can't or don't want to build the library then you only have to add an **IMPORTED**
 174 library target.
 175
 176 So, taking the above example, `mxml` library inclusion would be:
 177
 178 ```cmake
 179 PROJECT_TARGET_ADD(mxml)
 180
 181 add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL)
 182
 183 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
 184     LABELS LIBRARY
 185     IMPORTED_LOCATION /path/to/library/libmxml.so.1
 186     INTERFACE_INCLUDE_DIRECTORIES /path/to/mxml/include/dir
 187 )
 188 ```
 189
 190 Finally, you can link any other lib or executable target with this imported
 191 library like any other target.
 192
 193 ## Macro reference
 194
 195 ### PROJECT_TARGET_ADD
 196
 197 Typical usage would be to add the target to your project using macro
 198 `PROJECT_TARGET_ADD` with the name of your target as parameter.
 199
 200 Example:
 201
 202 ```cmake
 203 PROJECT_TARGET_ADD(low-can-demo)
 204 ```
 205
 206 > ***NOTE***: This will make available the variable `${TARGET_NAME}`
 207 > set with the specificied name. This variable will change at the next call
 208 > to this macros.
 209
 210 ### project_subdirs_add
 211
 212 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 213 it will be added to your project. This could be use in an hybrid application by
 214 example where the binding lay in a sub directory.
 215
 216 Usage :
 217
 218 ```cmake
 219 project_subdirs_add()
 220 ```
 221
 222 You also can specify a globbing pattern as argument to filter which folders
 223 will be looked for.
 224
 225 To filter all directories that begin with a number followed by a dash the
 226 anything:
 227
 228 ```cmake
 229 project_subdirs_add("[0-9]-*")
 230 ```
 231
 232 ### set_openapi_filename
 233
 234 Used with a target labelized **BINDINGV2** to define the file name, and
 235 possibly a relative path with the current *CMakeLists.txt*.
 236
 237 If you don't use that macro to specify the name of your definition file
 238 then the default one will be used, *${OUTPUT_NAME}-apidef* with
 239 **OUTPUT_NAME** as the [target property].
 240
 241 > **CAUTION** you must only specify the name **WITHOUT** the extension.
 242
 243 ```cmake
 244 set_openapi_filename('binding/mybinding_definition')
 245 ```
 246
 247 [target property]: https://cmake.org/cmake/help/v3.6/prop_tgt/OUTPUT_NAME.html "OUTPUT_NAME property documentation"
 248
 249 ### add_input_files
 250
 251 Create custom target dedicated for HTML5 and data resource files. This macro
 252 provides syntax and schema verification for differents languages which are
 253 about now: LUA, JSON and XML.
 254
 255 You could change the tools used to check files with the following variables:
 256
 257 - XML_CHECKER: set to use **xmllint** provided with major linux distribution.
 258 - LUA_CHECKER: set to use **luac** provided with major linux distribution.
 259 - JSON_CHECKER: no tools found at the moment.
 260
 261 ```cmake
 262 add_input_file("${MY_FILES_LIST}")
 263 ```
 264
 265 > **NOTE**: an issue at the check step on a file will stop at the build step.