vaikene.ee Git - evaf/blob - www/pswgen11.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html lang="et" xmlns="http://www.w3.org/1999/xhtml" xml:lang="et">
   3
   4     <head>
   5         <meta http-equiv="CONTENT-TYPE" content="text/html; charset=utf-8" />
   6         <title>eVaf Tutorial - 11 - Building PswGen application</title>
   7         <meta name="Author" content="Enar Väikene" />
   8         <meta name="description" content="eVaf Tutorial" />
   9         <meta name="keywords" content="evaf c++ application development framework tutorial password generator" />
  10         <link rel="StyleSheet" href="evaf.css" type="text/css" media="all" />
  11         <link rel="StyleSheet" href="highlight.css" type="text/css" media="all" />
  12     </head>
  13
  14     <body>
  15
  16         <h1>eVaf Tutorial</h1>
  17
  18         <h2>11 - Buiding PswGen application</h2>
  19
  20         <h3>CMakeLists.txt</h3>
  21
  22         <p>Copy an existing <tt>CMakeLists.txt</tt> file from the <tt>Storage</tt> module:</p>
  23
  24         <pre>evaf/src/apps/PswGen/GUI $ <code>cp ../Storage/CMakeLists.txt .</code></pre>
  25
  26         <p>We need to modify the <tt>TARGET</tt> variable and remove <tt>QT_USE_QTSQL</tt> and <tt>QT_DONT_USE_QTGUI</tt> variables.
  27         This module needs <tt>QtGui</tt> and does not need <tt>QtSql</tt>. Als add <tt>SdiWindow</tt> to the list of eVaf libraries
  28         as the module that implements the main window.</p>
  29
  30         <pre class="hl"><span class="hl com"># Name of the target</span>
  31 <span class="hl kwa">set</span><span class="hl opt">(</span>TARGET PswGui<span class="hl opt">)</span>
  32
  33 <span class="hl com"># Qt modules</span>
  34 <span class="hl kwa">include</span><span class="hl opt">(</span><span class="hl kwd">${QT_USE_FILE}</span><span class="hl opt">)</span>
  35
  36 <span class="hl com"># Required eVaf libraries</span>
  37 <span class="hl kwa">set</span><span class="hl opt">(</span>eVaf_LIBRARIES CommonLib PluginsLib SdiWindow<span class="hl opt">)</span></pre>
  38
  39         <p>Here is the final <tt>CMakeLists.txt</tt> file:</p>
  40
  41 <pre class="hl"><span class="hl com"># src/apps/PswGen/GUI/CMakeLists.txt</span>
  42
  43 <span class="hl com"># Name of the target</span>
  44 <span class="hl kwa">set</span><span class="hl opt">(</span>TARGET PswGui<span class="hl opt">)</span>
  45
  46 <span class="hl com"># Qt modules</span>
  47 <span class="hl kwa">include</span><span class="hl opt">(</span><span class="hl kwd">${QT_USE_FILE}</span><span class="hl opt">)</span>
  48
  49 <span class="hl com"># Include directories</span>
  50 <span class="hl kwa">include_directories</span><span class="hl opt">(</span><span class="hl kwd">${eVaf_INCLUDE}<span class="hl opt">)</span>
  51
  52 <span class="hl com"># Required eVaf libraries</span>
  53 <span class="hl kwa">set</span><span class="hl opt">(</span>eVaf_LIBRARIES CommonLib PluginsLib SdiWindow<span class="hl opt">)</span>
  54
  55 <span class="hl com"># Source files</span>
  56 <span class="hl kwa">set</span><span class="hl opt">(</span>SRCS
  57     gui.cpp
  58 <span class="hl opt">)</span>
  59
  60 <span class="hl com"># Header files for the Qt meta-object compiler</span>
  61 <span class="hl kwa">set</span><span class="hl opt">(</span>MOC_HDRS
  62     gui.h
  63 <span class="hl opt">)</span>
  64
  65 <span class="hl com"># Version info resource file for Windows builds</span>
  66 <span class="hl kwa">if</span><span class="hl opt">(</span><span class="hl kwb">WIN32</span><span class="hl opt">)</span>
  67     <span class="hl kwa">set</span><span class="hl opt">(</span>SRCS <span class="hl kwd">${SRCS}</span> version.rc<span class="hl opt">)</span>
  68 <span class="hl kwa">endif</span><span class="hl opt">(</span><span class="hl kwb">WIN32</span><span class="hl opt">)</span>
  69
  70 <span class="hl com"># Run the Qt meta-object compiler</span>
  71 <span class="hl kwd">qt4_wrap_cpp</span><span class="hl opt">(</span>MOC_SRCS <span class="hl kwd">${MOC_HDRS}</span><span class="hl opt">)</span>
  72
  73 <span class="hl com"># Compile the module</span>
  74 <span class="hl kwa">add_library</span><span class="hl opt">(</span><span class="hl kwd">${TARGET}</span> <span class="hl kwb">SHARED</span> <span class="hl kwd">${SRCS} ${MOC_SRCS}</span><span class="hl opt">)</span>
  75
  76 <span class="hl com"># Link the module</span>
  77 <span class="hl kwa">target_link_libraries</span><span class="hl opt">(</span><span class="hl kwd">${TARGET} ${QT_LIBRARIES} ${eVaf_LIBRARIES}</span><span class="hl opt">)</span></pre>
  78
  79         <p>Open the <tt>CMakeLists.txt</tt> file in the parent directory and add the command to include the <tt>GUI</tt>
  80         sub-directory:</p>
  81
  82         <pre class="hl"><span class="hl com"># src/apps/PswGen/CMakeLists.txt</span>
  83 <span class="hl com"># ...</span>
  84 <span class="hl kwa">add_subdirectory</span><span class="hl opt">(</span>GUI<span class="hl opt">)</span></pre>
  85
  86         <h3>Building the module</h3>
  87
  88         <p>Go to the previously made <tt>build</tt> directory and build the module:</p>
  89
  90         <pre>evaf $ <code>cd build</code>
  91 evaf/build $ <code>make PswGui</code></pre>
  92
  93         <p>Check the <tt>bin</tt> directory, which should now contain two new libraries:</p>
  94
  95         <pre>evaf/build $ <code>ls bin</code>
  96 libCommonLib.so*  libPluginsLib.so*  libPswGen.so*  <b>libPswGui.so*</b>  libPswStorage.so*  <b>libSdiWindow.so*</b>
  97 evaf/build $</pre>
  98
  99         <p>The <tt>libSdiWindow.so</tt> library was built because it is a dependency of the <tt>GUI</tt> module.</p>
 100
 101         <h3>Running the PswGen application</h3>
 102
 103         <p>In the same <tt>build</tt> directory, create few more sub-directories needed by any <tt>eVaf</tt> applications:</p>
 104
 105         <pre> evaf/build $ <code>mkdir {etc,log}</code></pre>
 106
 107         <p>Create the <tt>PswGen.xml</tt> file in the <tt>build/etc</tt> directory. The <tt>PswGen.xml</tt> file defines the
 108         application by specifying all the modules that the application needs to load.</p>
 109
 110         <pre class="hl"><span class="hl kwa">&lt;?xml</span> <span class="hl kwb">version</span>=<span class="hl str">&quot;1.0&quot;</span> <span class="hl kwb">encoding</span>=<span class="hl str">&quot;UTF-8&quot;</span><span class="hl kwa">?&gt;</span>
 111 <span class="hl kwa">&lt;!DOCTYPE</span> eVaf<span class="hl kwa">&gt;</span>
 112 <span class="hl kwa">&lt;eVaf</span> <span class="hl kwb">version</span>=<span class="hl str">&quot;1.0&quot;</span><span class="hl kwa">&gt;</span>
 113     <span class="hl kwa">&lt;plugins&gt;</span>
 114         <span class="hl kwa">&lt;plugin</span> <span class="hl kwb">name</span>=<span class="hl str">&quot;SdiWindow&quot;</span> <span class="hl kwb">filename</span>=<span class="hl str">&quot;SdiWindow&quot;</span> <span class="hl kwa">/&gt;</span>
 115         <span class="hl kwa">&lt;plugin</span> <span class="hl kwb">name</span>=<span class="hl str">&quot;Generator&quot;</span> <span class="hl kwb">filename</span>=<span class="hl str">&quot;PswGen&quot;</span> <span class="hl kwa">/&gt;</span>
 116         <span class="hl kwa">&lt;plugin</span> <span class="hl kwb">name</span>=<span class="hl str">&quot;Storage&quot;</span> <span class="hl kwb">filename</span>=<span class="hl str">&quot;PswStorage&quot;</span> <span class="hl kwa">/&gt;</span>
 117         <span class="hl kwa">&lt;plugin</span> <span class="hl kwb">name</span>=<span class="hl str">&quot;GUI&quot;</span> <span class="hl kwb">filename</span>=<span class="hl str">&quot;PswGui&quot;</span> <span class="hl kwa">/&gt;</span>
 118     <span class="hl kwa">&lt;/plugins&gt;</span>
 119 <span class="hl kwa">&lt;/eVaf&gt;</span></pre>
 120
 121         <p>Modules are loaded and initialized in the order how they are specified in the xml file. We have to make sure that
 122         <tt>SdiWindow</tt>, <tt>Generator</tt> and <tt>Storage</tt> modules are loaded before the <tt>GUI</tt> module. Otherwise
 123         their interfaces wouldn't be available when the <tt>GUI</tt> module is initialized.</p>
 124
 125         <p>The <tt>name</tt> attribute here is optional and will be replaced with the name reported by the actual module.</p>
 126
 127         <p>The <tt>filename</tt> attribute specifies the name of the library file without prefixes and suffixes meaning that
 128         <tt>lib<b>PswGen</b>.so</tt> shall be specified as <tt>PswGen</tt>. This makes sure that the same xml file can be also used
 129         on Windows, where the library would be called <tt><b>PswGen</b>.dll</tt>.</p>
 130
 131         <p>There is no executable file yet that we can run. Build it with the following command:</p>
 132
 133         <pre>evaf/build $ <code>make eVafGUI</code></pre>
 134
 135         <p>This command builds the GUI executable and stores it in the <tt>evaf/build/bin</tt> directory. The <tt>bin</tt> directory should look now the following:</p>
 136
 137         <pre>evaf/build $ <code>ls bin</code>
 138 eVafGUI*  libCommonLib.so*  libPluginsLib.so*  libPswGen.so*  libPswGui.so*  libPswStorage.so*  libSdiWindow.so*
 139 evaf/build $</pre>
 140
 141         <p>Now we can run the PswGen application. Change <tt>--dataroot=${HOME}/evaf/build</tt> to your actual build directory name:</p>
 142
 143         <pre>evaf/build $ <code>bin/eVafGUI --application=PswGen --dataroot=${HOME}/evaf/build --verbose=INFO</code></pre>
 144
 145         <p>The <tt>--application=PswGen</tt> command line option specifies the name of the application and also means that the xml file
 146         should be called <tt>PswGen.xml</tt>. Different applications can be run in the same build directories by changing the name
 147         of the application. The default application is called <tt>eVaf</tt> and if no name is given, then the xml file should be called
 148         <tt>eVaf.xml</tt>.</p>
 149
 150         <p>The <tt>--dataroot=${HOME}/evaf/build</tt> command line option specifies the location of data files for the application. The
 151         application assumes that <tt>etc</tt> and <tt>spool</tt> directories are sub-directories in the data root directory. The default
 152         data root directory is <tt>${HOME}/.local/share/data</tt> on
 153         Linux.</p>
 154
 155         <p>Finally, the <tt>--verbose=INFO</tt> command line option makes the application to be verbose and output all the info
 156         messages to the console.</p>
 157
 158         <h3>Releasing the PswGen application</h3>
 159
 160         <p>Now the application is written and tested. We are ready to make a release build and ship it.</p>
 161
 162         <p>Clean the build directory:</p>
 163
 164         <pre>evaf/build $ <code>make clean &amp;&amp; rm CMakeCache.txt</code></pre>
 165
 166         <p>Prepare for a release build and build the application:</p>
 167
 168         <pre>evaf/build $ <code>cmake -DCMAKE_BUILD_TYPE=Release ..</code>
 169 evaf/build $ <code>make eVafGUI SdiWindow PswGen PswStorage PswGui</code></pre>
 170
 171         <p>Packaging and shipping the application is out of the scope of this tutorial and involves more than just copying files that
 172         we built. As a minimum, we have to make sure that the target system has Qt libraries installed. In this tutorial, we simply copy the
 173         released application into the <tt>{$HOME}/bin/evaf</tt> directory. Qt libraries are already installed and we do not need to
 174         worry about them.</p>
 175
 176         <p>Create the <tt>${HOME}/bin/evaf</tt> directory:</p>
 177
 178         <pre>evaf/build $ <code>mkdir -p ${HOME}/bin/evaf</code></pre>
 179
 180         <p>Copy the content of <tt>bin</tt> and </tt>etc</tt> directories</p>
 181
 182         <pre>evaf/build $ <code>cp -R bin etc ${HOME}/bin/evaf/</code></pre>
 183
 184         <p>Create the bash script <tt>PswGen</tt> in the <tt>${HOME}/bin</tt> directory:</p>
 185
 186         <pre class="hl"><span class="hl slc">#!/bin/bash</span>
 187 EVAF_DIR<span class="hl opt">=</span><span class="hl kwd">${HOME}</span><span class="hl opt">/</span>bin<span class="hl opt">/</span>evaf
 188 <span class="hl kwd">${EVAF_DIR}</span><span class="hl opt">/</span>bin<span class="hl opt">/</span>eVafGUI <span class="hl opt">--</span>rootdir<span class="hl opt">=</span><span class="hl kwd">${EVAF_DIR}</span> <span class="hl opt">--</span>dataroot<span class="hl opt">=</span><span class="hl kwd">${EVAF_DIR}</span> <span class="hl opt">--</span>application<span class="hl opt">=</span>PswGen
 189 </pre>
 190
 191         <p>Don't forget to make it runnable:</p>
 192
 193         <pre> bin $ <code>chmod a+x PswGen</code></pre>
 194
 195         <p>Now we can run the application by simply running the bash script <tt>PswGen</tt> in the <tt>${HOME}/bin</tt> directory.
 196
 197     </body>
 198 </html>