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*). Or you can choose the name, without the
  37  extension, by setting the *CACHE* cmake variable *OPENAPI_DEF* (***CAUTION***:
  38  setting a CACHE variable is needed, or set a normal variable with the
  39  *PARENT_SCOPE* option to make it visible for the parent scope where the target
  40  is defined) JSON file will be used to generate header file using `afb-genskel`
  41  tool.
  42 - **PLUGIN**: Shared library meant to be used as a binding plugin. Binding
  43  would load it as a plugin to extend its functionnalities. It should be named
  44  with a special extension that you choose with SUFFIX cmake target property or
  45  it'd be **.ctlso** by default.
  46 - **HTDOCS**: Root directory of a web app. This target has to build its
  47  directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
  48 - **DATA**: Resources used by your application. This target has to build its
  49  directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
  50 - **EXECUTABLE**: Entry point of your application executed by the AGL
  51  Application Framework
  52 - **LIBRARY**: An external 3rd party library bundled with the binding for its
  53  own purpose because platform doesn't provide it.
  54
  55 > **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
  56 > stand for **Application Framework Binding**.
  57
  58 Example:
  59
  60 ```cmake
  61 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
  62                 LABELS "HTDOCS"
  63                 OUTPUT_NAME dist.prod
  64         )
  65 ```
  66
  67 > **NOTE**: You doesn't need to specify an **INSTALL** command for these
  68 > targets. This is already handle by template and will be installed in the
  69 > following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**
  70
  71 ## Add external 3rd party library
  72
  73 You could need to include an external library that isn't shipped in the
  74 platform. Then you have to bundle the required library in the `lib` widget
  75 directory.
  76
  77 Templates includes some facilities to help you to do so. Classic way to do so
  78 is to declare as many CMake ExternalProject as library you need.
  79
  80 An ExternalProject is a special CMake module that let you define how to:
  81 download, update, patch, configure, build and install an external project. It
  82 doesn't have to be a CMake project and custom step could be added for special
  83 needs using ExternalProject step. More informations on CMake [ExternalProject
  84 documentation site](https://cmake.org/cmake/help/v3.5/module/ExternalProject.html?highlight=externalproject).
  85
  86 Example to include `mxml` library for [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
  87 project:
  88
  89 ```cmake
  90 set(MXML external-mxml)
  91 set(MXML_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/mxml)
  92 ExternalProject_Add(${MXML}
  93     GIT_REPOSITORY https://github.com/michaelrsweet/mxml.git
  94     GIT_TAG release-2.10
  95     SOURCE_DIR ${MXML_SOURCE_DIR}
  96     CONFIGURE_COMMAND ./configure --build x86_64 --host aarch64
  97     BUILD_COMMAND make libmxml.so.1.5
  98     BUILD_IN_SOURCE 1
  99     INSTALL_COMMAND ""
 100 )
 101
 102 PROJECT_TARGET_ADD(mxml)
 103
 104 add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL)
 105
 106 SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
 107     LABELS LIBRARY
 108     IMPORTED_LOCATION ${MXML_SOURCE_DIR}/libmxml.so.1
 109     INTERFACE_INCLUDE_DIRECTORIES ${MXML_SOURCE_DIR}
 110 )
 111
 112 add_dependencies(${TARGET_NAME} ${MXML})
 113 ```
 114
 115 Here we define an external project that drive the build of the library then we
 116 define new CMake target of type **IMPORTED**. Meaning that this target hasn't
 117 be built using CMake but is available at the location defined in the target
 118 property *IMPORTED_LOCATION*.
 119
 120 Then target *LABELS* property is set to **LIBRARY** to ship it in the widget.
 121
 122 Unicens project also need some header from this library, so we use the target
 123 property *INTERFACE_INCLUDE_DIRECTORIES*. Setting that when another target link
 124 to that imported target, it can access to the include directories.
 125
 126 We bound the target to the external project using a CMake dependency at last.
 127
 128 ## Macro reference
 129
 130 ### PROJECT_TARGET_ADD
 131
 132 Typical usage would be to add the target to your project using macro
 133 `PROJECT_TARGET_ADD` with the name of your target as parameter.
 134
 135 Example:
 136
 137 ```cmake
 138 PROJECT_TARGET_ADD(low-can-demo)
 139 ```
 140
 141 > ***NOTE***: This will make available the variable `${TARGET_NAME}`
 142 > set with the specificied name. This variable will change at the next call
 143 > to this macros.
 144
 145 ### project_subdirs_add
 146
 147 This macro will search in all subfolder any `CMakeLists.txt` file. If found then
 148 it will be added to your project. This could be use in an hybrid application by
 149 example where the binding lay in a sub directory.
 150
 151 Usage :
 152
 153 ```cmake
 154 project_subdirs_add()
 155 ```
 156
 157 You also can specify a globbing pattern as argument to filter which folders
 158 will be looked for.
 159
 160 To filter all directories that begin with a number followed by a dash the
 161 anything:
 162
 163 ```cmake
 164 project_subdirs_add("[0-9]-*")
 165 ```