Documentation/Maemo Eclipse Tutorial/Using ESbox

(wikify slightly, use ambox)
(wikify slightly, incomplete)
Line 11: Line 11:
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
-
To create a new C or C++ project, select '''File > New > Project''', figure [[#fig:esbox_usage_project_new|8.1]].
+
To create a new C or C++ project, select '''File > New > Project''', figure [[#figure-esbox_usage_project_new|8.1]].
* C > C Maemo Project
* C > C Maemo Project
Line 18: Line 18:
For Qt4 projects, select C++ project.
For Qt4 projects, select C++ project.
-
{| summary="New Project Menu"
+
<div id="figure-esbox_usage_project_new">
-
|+ align="BOTTOM" |'''Figure 8.1:''' New Project Menu
+
[[Image:project-Python-new.png|frame|center|alt=Screenshot of New Project menu|Figure 8.1: New Project Menu]]
-
|-
+
</div>
-
|
+
-
[[Image:project-Python-new.png|Image project-Python-new]]
+
-
|}
+
-
ESbox supports simple Qt4, Makefile and Autotools projects, figure [[#fig:esbox_usage_c_01_projects|8.2]].
+
ESbox supports simple Qt4, Makefile and Autotools projects, figure [[#figure-esbox_usage_c_01_projects|8.2]].
-
{| summary="New C/C++ Project"
+
<div id="figure-esbox_usage_c_01_projects">
-
|+ align="BOTTOM" |'''Figure 8.2:''' New C/C++ Project
+
[[Image:c-01-projects.png|frame|center|alt=Screenshot of New C/C++ project|Figure 8.2: New C/C++ Project]]
-
|-
+
</div>
-
|
+
-
[[Image:c-01-projects.png|Image c-01-projects]]
+
-
|}
+
-
Select any of the available templates on the '''Template Project Type''' page, figure [[#fig:esbox_usage_c_02_templates|8.3]].
+
Select any of the available templates on the '''Template Project Type''' page, figure [[#figure-esbox_usage_c_02_templates|8.3]].
-
{| summary="C/C++ Project Template"
+
<div id="figure-esbox_usage_c_02_templates">
-
|+ align="BOTTOM" |'''Figure 8.3:''' C/C++ Project Template
+
[[Image:c-02-templates.png|frame|center|alt=Screenshot of CC++ project template|Figure 8.3: C/C++ Project Template]]
-
|-
+
</div>
-
|
+
-
[[Image:c-02-templates.png|Image c-02-templates]]
+
-
|}
+
{{ambox
{{ambox
-
|text='''Maemo 4''' templates are only for Diablo targets and '''Maemo 5''' templates for Fremantle. Select the correct template depending on your installation.
+
|text='''Maemo 4''' templates are only for [[Open development/Maemo roadmap/Diablo|Diablo]] targets and '''Maemo 5''' templates for [[Open development/Maemo roadmap/Fremantle|Fremantle]]. Select the correct template depending on your installation.
}}
}}
Line 51: Line 42:
You can select multiple targets for a project. Optimized targets are compiled using compiler optimization while debug targets are compiled with debug options.
You can select multiple targets for a project. Optimized targets are compiled using compiler optimization while debug targets are compiled with debug options.
-
If you want to run a project on a Maemo device, select the <span><font face="monospace">ARMEL</font></span> target. To run a project on the emulator, select the <span><font face="monospace">X86</font></span> target.
+
If you want to run a project on a Maemo device, select the <code>ARMEL</code> target. To run a project on the emulator, select the <code>X86</code> target.
-
Select all targets for a project, figure [[#fig:esbox_usage_c_03_targets|8.4]]. You can change the targets after you have created the project.
+
Select all targets for a project, figure [[#figure-esbox_usage_c_03_targets|8.4]]. You can change the targets after you have created the project.
-
{| summary="C/C++ Project Target"
+
<div id="figure-esbox_usage_c_03_targets">
-
|+ align="BOTTOM" |'''Figure 8.4:''' C/C++ Project Target
+
[[Image:c-03-targets.png|frame|center|alt=Screenshot of C/C++ project target|Figure 8.4: C/C++ Project Target]]
-
|-
+
</div>
-
|
+
-
[[Image:c-03-targets.png|Image c-03-targets]]
+
-
|}
+
If you do not see any targets on the '''Project Configuration''' page, check that Maemo SDK targets are installed and install them if necessary. For more information on how to install Maemo SDK and targets for ESbox, see ESbox installation chapters.
If you do not see any targets on the '''Project Configuration''' page, check that Maemo SDK targets are installed and install them if necessary. For more information on how to install Maemo SDK and targets for ESbox, see ESbox installation chapters.
Line 66: Line 54:
=== C/C++ and Qt4 Metadata ===
=== C/C++ and Qt4 Metadata ===
-
Other project pages define different metadata the template uses. You can specify additional information in the fields or use the default values, figure [[#fig:esbox_usage_c_04_metadata|8.5]].
+
Other project pages define different metadata the template uses. You can specify additional information in the fields or use the default values, figure [[#figure-esbox_usage_c_04_metadata|8.5]].
-
{| summary="C/C++ Project Metadata"
+
<div id="figure-esbox_usage_c_04_metadata">
-
|+ align="BOTTOM" |'''Figure 8.5:''' C/C++ Project Metadata
+
[[Image:c-04-metadata.png|frame|center|alt=Screenshot of C/C++ project metadata|Figure 8.5: C/C++ Project Metadata]]
-
|-
+
</div>
-
|
+
-
[[Image:c-04-metadata.png|Image c-04-metadata]]
+
-
|}
+
After defining the values, click '''Finish''' to create a project.
After defining the values, click '''Finish''' to create a project.
Line 79: Line 64:
=== Validating C/C++ and Qt4 Project Packages for Maemo SDK ===
=== Validating C/C++ and Qt4 Project Packages for Maemo SDK ===
-
When you have created a new project, ESbox suggests package validation, figure [[#fig:esbox_usage_c_05_validate|8.6]]. If you are not sure that the required development environments have been installed for your targets, click '''Yes'''.
+
When you have created a new project, ESbox suggests package validation, figure [[#figure-esbox_usage_c_05_validate|8.6]]. If you are not sure that the required development environments have been installed for your targets, click '''Yes'''.
-
{| summary="Validate Packages Dialog"
+
<div id="figure-esbox_usage_c_05_validate">
-
|+ align="BOTTOM" |'''Figure 8.6:''' Validate Packages Dialog
+
[[Image:c-05-validate.png|frame|center|alt=Screenshot of package validation dialog|Figure 8.6: Validate Packages Dialog]]
-
|-
+
</div>
-
|
+
-
[[Image:c-05-validate.png|Image c-05-validate]]
+
-
|}
+
-
ESbox installs all the required dependencies for your project for the selected targets, if they are not installed already, figure [[#fig:esbox_usage_c_06_validate_wizard|8.7]].
+
ESbox installs all the required dependencies for your project for the selected targets, if they are not installed already, figure [[#figure-esbox_usage_c_06_validate_wizard|8.7]].
If ESbox asks you about changing the target, click '''Yes''' to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.
If ESbox asks you about changing the target, click '''Yes''' to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.
-
{| summary="Validate Packages Wizard"
+
<div id="figure-esbox_usage_c_06_validate_wizard">
-
|+ align="BOTTOM" |'''Figure 8.7:''' Validate Packages Wizard
+
[[Image:c-06-validate-wizard.png|frame|center|alt=Screenshot of package validation wizard|Figure 8.7: Validate Packages Wizard]]
-
|-
+
</div>
-
|
+
-
[[Image:c-06-validate-wizard.png|Image c-06-validate-wizard]]
+
-
|}
+
You can also validate project packages afterwards. To start the validation, select '''Project &gt; Project Menu &gt; Validate Installed Packages'''.
You can also validate project packages afterwards. To start the validation, select '''Project &gt; Project Menu &gt; Validate Installed Packages'''.
Line 103: Line 82:
During validation, the projects are scanned for dependencies using the following information:
During validation, the projects are scanned for dependencies using the following information:
-
* Autotools projects: <span><font face="monospace">PKG_CONFIG_CHECK</font></span> macros in configure.ac
+
* Autotools projects: <code>PKG_CHECK_MODULES</code> macros in <code>configure.ac</code>
* Makefile projects: default metapackages for the project type and libraries detected through <code>pkg-config</code> invocations
* Makefile projects: default metapackages for the project type and libraries detected through <code>pkg-config</code> invocations
== Running C/C++ and Qt4 Applications on Maemo SDK ==
== Running C/C++ and Qt4 Applications on Maemo SDK ==
-
First, select the build configuration. Change the build configuration to <span><font face="monospace">DIABLO_X86 (Debug)</font></span> or <span><font face="monospace">FREMANTLE_X86 (Debug)</font></span>.
+
First, select the build configuration. Change the build configuration to <code>DIABLO_X86 (Debug)</code> or <code>FREMANTLE_X86 (Debug)<code>.
-
To activate the selected configuration, right-click the project and select '''Build Configurations &gt; Set active''', figure [[#fig:esbox_usage_c_07_set_target|8.8]].
+
To activate the selected configuration, right-click the project and select '''Build Configurations &gt; Set active''', figure [[#figure-esbox_usage_c_07_set_target|8.8]].
-
{| summary="Set C/C++ Project Target"
+
<div id="figure-esbox_usage_c_07_set_target">
-
|+ align="BOTTOM" |'''Figure 8.8:''' Set C/C++ Project Target
+
[[Image:c-07-set-target.png|frame|center|alt=Screenshot of C/C++ project target|Figure 8.8: Set C/C++ Project Target]]
-
|-
+
</div>
-
|
+
-
[[Image:c-07-set-target.png|Image c-07-set-target]]
+
-
|}
+
To add or remove targets, select '''Manage''' in the same menu.
To add or remove targets, select '''Manage''' in the same menu.
-
The project is ready to be launched on Maemo SDK. To launch it, right-click the project and select '''Run As &gt; Maemo Local Application''', figure [[#fig:esbox_usage_c_08_run_as|8.9]].
+
The project is ready to be launched on Maemo SDK. To launch it, right-click the project and select '''Run As &gt; Maemo Local Application''', figure [[#figure-esbox_usage_c_08_run_as|8.9]].
-
{| summary="Run C/C++ Project as Local Application"
+
<div id="figure-esbox_usage_c_08_run_as">
-
|+ align="BOTTOM" |'''Figure 8.9:''' Run C/C++ Project as Local Application
+
[[Image:c-08-run-as.png|frame|center|alt=Screenshot of C/C++ project running as a local application|'''Figure 8.9:''' Run C/C++ Project as Local Application]]
-
|-
+
</div>
-
|
+
-
[[Image:c-08-run-as.png|Image c-08-run-as]]
+
-
|}
+
-
If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched the Application Framework successfully, you can see the Application Framework and the program running, figure [[#fig:esbox_usage_c_09_result|8.10]].
+
If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched the Application Framework successfully, you can see the Application Framework and the program running, figure [[#figure-esbox_usage_c_09_result|8.10]].
-
{| summary="C/C++ Project Local Launch Result"
+
<div id="figure-esbox_usage_c_09_result">
-
|+ align="BOTTOM" |'''Figure 8.10:''' C/C++ Project Local Launch Result
+
[[Image:c-09-result.png|frame|center|alt=Screenshot of result of launching local project|'''Figure 8.10:''' C/C++ Project Local Launch Result]]
-
|-
+
</div>
-
|
+
-
[[Image:c-09-result.png|Image c-09-result]]
+
-
|}
+
== Running C/C++ and Qt4 Applications on a Maemo Device ==
== Running C/C++ and Qt4 Applications on a Maemo Device ==
Line 143: Line 113:
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
-
Because the device uses <span><font face="monospace">ARMEL</font></span> binaries, you must to change the target platform to <span><font face="monospace">DIABLO_ARMEL</font></span> or <span><font face="monospace">FREMANTLE_ARMEL</font></span> and rebuild your application for the Maemo device.
+
Because the device uses <code>ARMEL</code> binaries, you must to change the target platform to <code>DIABLO_ARMEL</code> or <code>FREMANTLE_ARMEL</code> and rebuild your application for the Maemo device.
-
First, make sure that <span><font face="monospace">DIABLO_ARMEL</font></span> or <span><font face="monospace">FREMANTLE_ARMEL</font></span> target is selected by right-clicking the project and selecting '''Properties &gt; Build Configurations &gt; Manage''', figure [[#fig:esbox_usage_c_remote_01_manage|8.11]].
+
First, make sure that <code>DIABLO_ARMEL</code> or <code>FREMANTLE_ARMEL</code> target is selected by right-clicking the project and selecting '''Properties &gt; Build Configurations &gt; Manage''', figure [[#figure-esbox_usage_c_remote_01_manage|8.11]].
-
{| summary="C/C++ Project Manage Target Menu"
+
<div id="figure-esbox_usage_c_remote_01_manage">
-
|+ align="BOTTOM" |'''Figure 8.11:''' C/C++ Project Manage Target Menu
+
[[Image:c-remote-01-manage.png|frame|center|alt=Screenshot of project management target menu|Figure 8.11: C/C++ Project Manage Target Menu]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-01-manage.png|Image c-remote-01-manage]]
+
-
|}
+
-
Set the target to <span><font face="monospace">DIABLO_ARMEL</font></span> or <span><font face="monospace">FREMANTLE_ARMEL</font></span>, figure [[#fig:esbox_usage_c_remote_02_targets|8.12]].
+
Set the target to <code>DIABLO_ARMEL</code> or <code>FREMANTLE_ARMEL</code>, figure [[#figure-esbox_usage_c_remote_02_targets|8.12]].
-
{| summary="C/C++ Project Manage Targets"
+
<div id="figure-esbox_usage_c_remote_02_targets">
-
|+ align="BOTTOM" |'''Figure 8.12:''' C/C++ Project Manage Targets
+
[[Image:c-remote-02-targets.png|frame|center|alt=Screenshot of project management of targets|'''Figure 8.12:''' C/C++ Project Manage Targets]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-02-targets.png|Image c-remote-02-targets]]
+
-
|}
+
-
Right-click the project, select '''Build Configurations &gt; Set Active''' and activate <span><font face="monospace">DIABLO_ARMEL (Debug)</font></span> or <span><font face="monospace">FREMANTLE_ARMEL (Debug)</font></span>, figure [[#fig:esbox_usage_c_remote_03_set_target|8.13]].
+
Right-click the project, select '''Build Configurations &gt; Set Active''' and activate <code>DIABLO_ARMEL (Debug)</code> or <code>FREMANTLE_ARMEL (Debug)</code>, figure [[#figure-esbox_usage_c_remote_03_set_target|8.13]].
-
{| summary="Set C/C++ Project Target"
+
<div id="figure-esbox_usage_c_remote_03_set_target">
-
|+ align="BOTTOM" |'''Figure 8.13:''' Set C/C++ Project Target
+
[[Image:c-remote-03-set-target.png|frame|center|alt=Screnshot of C/C++ project target setting|Figure 8.13: Set C/C++ Project Target]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-03-set-target.png|Image c-remote-03-set-target]]
+
-
|}
+
=== Validating C/C++ and Qt4 Project Packages on a Maemo Device ===
=== Validating C/C++ and Qt4 Project Packages on a Maemo Device ===
Line 176: Line 137:
To be able to run your application on the Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.
To be able to run your application on the Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.
-
Select '''Project Menu &gt; Validate Installed Packages'''. On the first page, select the project to be validated, figure [[#fig:esbox_usage_c_remote_04_validate_device|8.14]].
+
Select '''Project Menu &gt; Validate Installed Packages'''. On the first page, select the project to be validated, figure [[#figure-esbox_usage_c_remote_04_validate_device|8.14]].
-
{| summary="Validate Packages Menu"
+
<div id="figure-esbox_usage_c_remote_04_validate_device">
-
|+ align="BOTTOM" |'''Figure 8.14:''' Validate Packages Menu
+
[[Image:c-remote-04-validate-device.png|frame|center|alt=Screenshot of package validation menu|Figure 8.14: Validate Packages Menu]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-04-validate-device.png|Image c-remote-04-validate-device]]
+
-
|}
+
-
On the '''Target Selection''' page, select the correct Maemo device connection and <span><font face="monospace">ARMEL</font></span> target, Figure [[#fig:esbox_usage_c_remote_05_validate_targets|8.15]].
+
On the '''Target Selection''' page, select the correct Maemo device connection and <span><font face="monospace">ARMEL</font></span> target, Figure [[#figure-esbox_usage_c_remote_05_validate_targets|8.15]].
-
{| summary="Validate Package Targets"
+
<div id="figure-esbox_usage_c_remote_05_validate_targets">
-
|+ align="BOTTOM" |'''Figure 8.15:''' Validate Package Targets
+
[[Image:c-remote-05-validate-targets.png|frame|center|alt=Screenshot of package validation targets|Figure 8.15: Validate Package Targets]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-05-validate-targets.png|Image c-remote-05-validate-targets]]
+
-
|}
+
To start the validation, click '''Finish''' on the last page. This installs the required packages for the selected project on the Maemo device.
To start the validation, click '''Finish''' on the last page. This installs the required packages for the selected project on the Maemo device.
Line 202: Line 157:
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
-
After you have set the target to <span><font face="monospace">ARMEL</font></span> and built your application as <span><font face="monospace">ARMEL</font></span>, you can run your application on the Maemo device. To run the application, right-click the project and select '''Run As &gt; Maemo Remote Application''', figure [[#fig:esbox_usage_c_remote_06_run|8.16]].
+
After you have set the target to <code>ARMEL</code> and built your application as <code>ARMEL</code>, you can run your application on the Maemo device. To run the application, right-click the project and select '''Run As &gt; Maemo Remote Application''', figure [[#figure-esbox_usage_c_remote_06_run|8.16]].
-
{| summary="Run C/C++ Project as Remote Maemo Application"
+
<div id="figure-esbox_usage_c_remote_06_run">
-
|+ align="BOTTOM" |'''Figure 8.16:''' Run C/C++ Project as Remote Maemo Application
+
[[Image:c-remote-06-run.png|frame|center|alt=Screenshot of running C/C++ project as a remote Maemo application|Figure 8.16: Run C/C++ Project as Remote Maemo Application]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-06-run.png|Image c-remote-06-run]]
+
-
|}
+
-
Select SSH as the connection type (using the SBRSH connection type requires additional configuration), figure [[#fig:esbox_usage_c_remote_07_use_ssh|8.17]].
+
Select SSH as the connection type (using the SBRSH connection type requires additional configuration), figure [[#figure-esbox_usage_c_remote_07_use_ssh|8.17]].
-
{| summary="Connection Type Dialog"
+
<div id="figure-esbox_usage_c_remote_07_use_ssh">
-
|+ align="BOTTOM" |'''Figure 8.17:''' Connection Type Dialog
+
[[Image:c-remote-07-use-ssh.png|frame|center|alt=Screenshot of connection type dialog|Figure 8.17: Connection Type Dialog]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-07-use-ssh.png|Image c-remote-07-use-ssh]]
+
-
|}
+
-
Select the device connection, figure [[#fig:esbox_usage_c_remote_06_run|8.16]]. Use USB connection because it is faster than Bluetooth or WLAN.
+
Select the device connection, figure [[#figure-esbox_usage_c_remote_06_run|8.16]]. Use USB connection because it is faster than Bluetooth or WLAN.
-
{| summary="Select Device Connection Dialog"
+
<div id="figure-esbox_usage_c_remote_06_run">
-
|+ align="BOTTOM" |'''Figure 8.18:''' Select Device Connection Dialog
+
[[Image:c-remote-08-select-connection.png|frame|center|alt=Screenshot of device selection connection dialog|Figure 8.18: Select Device Connection Dialog]]
-
|-
+
</div>
-
|
+
-
[[Image:c-remote-08-select-connection.png|Image c-remote-08-select-connection]]
+
-
|}
+
You can now see your application running on the Maemo device.
You can now see your application running on the Maemo device.
Line 233: Line 179:
You can use VNC Viewer to control the Maemo device and your application running on it. Select '''Window &gt; Show View &gt; Other &gt; VNC Viewer'''.
You can use VNC Viewer to control the Maemo device and your application running on it. Select '''Window &gt; Show View &gt; Other &gt; VNC Viewer'''.
-
{ambox
+
{{ambox
-
|text=To use VNC Viewer, the <span><font face="monospace">x11vnc</font></span> service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity.
+
|text=To use VNC Viewer, the <code>x11vnc</code> service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity.
-
}
+
}}
== Debugging C/C++ and Qt4 Applications ==
== Debugging C/C++ and Qt4 Applications ==
-
To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select '''Add Breakpoint''', figure [[#fig:esbox_usage_c_debug_01_breakpoint|8.19]].
+
To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select '''Add Breakpoint''', figure [[#figure-esbox_usage_c_debug_01_breakpoint|8.19]].
-
{| summary="Adding Breakpoint to C/C++ Source File"
+
<div id="figure-esbox_usage_c_debug_01_breakpoint">
-
|+ align="BOTTOM" |'''Figure 8.19:''' Adding Breakpoint to C/C++ Source File
+
[[Image:c-debug-01-breakpoint.png|frame|center|alt=Screenshot of adding a breakpoint to a C/C++ source file|Figure 8.19: Adding a Breakpoint to a C/C++ Source File]]
-
|-
+
</div>
-
|
+
-
[[Image:c-debug-01-breakpoint.png|Image c-debug-01-breakpoint]]
+
-
|}
+
-
To launch your project in debug mode, right-click the project and select '''Debug As &gt; Maemo Local or Remote Application'''. When prompted, accept changing to the debug perspective, figure [[#fig:esbox_usage_c_debug_02_debug|8.20]].
+
To launch your project in debug mode, right-click the project and select '''Debug As &gt; Maemo Local or Remote Application'''. When prompted, accept changing to the debug perspective, figure [[#figure-esbox_usage_c_debug_02_debug|8.20]].
-
{| summary="Debug as Maemo Application Menu"
+
<div id="figure-esbox_usage_c_debug_02_debug">
-
|+ align="BOTTOM" |'''Figure 8.20:''' Debug as Maemo Application Menu
+
[[Image:c-debug-02-debug.png|frame|center|alt=Screenshot of Maemo application debugging menu|Figure 8.20: Debug as Maemo Application Menu]]
-
|-
+
</div>
-
|
+
-
[[Image:c-debug-02-debug.png|Image c-debug-02-debug]]
+
-
|}
+
-
In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures [[#fig:esbox_usage_c_debug_03_perspective|8.21]] and [[#fig:esbox_usage_c_debug_04_variables|8.22]].
+
In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures [[#figure-esbox_usage_c_debug_03_perspective|8.21]] and [[#figure-esbox_usage_c_debug_04_variables|8.22]].
{{ambox
{{ambox
Line 263: Line 203:
}}
}}
-
{| summary="C/C++ Project Debug View"
+
<div id="figure-esbox_usage_c_debug_03_perspective">
-
|+ align="BOTTOM" |'''Figure 8.21:''' C/C++ Project Debug View
+
[[Image:c-debug-03-perspective.png|frame|center|alt=Screenshot of C/C++ project debug view|Figure 8.21: C/C++ Project Debug View]]
-
|-
+
</div>
-
|
+
-
[[Image:c-debug-03-perspective.png|Image c-debug-03-perspective]]
+
-
|}
+
-
{| summary="Inspect C/C++ Variables"
+
<div id="figure-esbox_usage_c_debug_04_variables">
-
|+ align="BOTTOM" |'''Figure 8.22:''' Inspect C/C++ Variables
+
[[Image:c-debug-04-variables.png|frame|center|alt=Screenshot of inspecting C/C++ variables|Figure 8.22: Inspect C/C++ Variables]]
-
|-
+
</div>
-
|
+
-
[[Image:c-debug-04-variables.png|Image c-debug-04-variables]]
+
-
|}
+
== Creating Python Projects ==
== Creating Python Projects ==
Line 285: Line 219:
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
-
To create a new Python project, select '''File &gt; New &gt; Project''' and then '''Python Maemo Project''', figure [[#fig:esbox_usage_project_python_new|8.23]].
+
To create a new Python project, select '''File &gt; New &gt; Project''' and then '''Python Maemo Project''', figure [[#figure-esbox_usage_project_python_new|8.23]].
-
{| summary="New Project Menu"
+
<div id="figure-esbox_usage_project_python_new">
-
|+ align="BOTTOM" |'''Figure 8.23:''' New Project Menu
+
[[Image:project-Python-new.png|frame|center|alt=Screenshot of new project menu|Figure 8.23: New Project Menu]]
-
|-
+
</div>
-
|
+
-
[[Image:project-Python-new.png|Image project-Python-new]]
+
-
|}
+
-
Select any of the Python example templates on the '''Template''' page, figure [[#fig:esbox_usage_python_01_template|8.24]].
+
Select any of the Python example templates on the '''Template''' page, figure [[#figure-esbox_usage_python_01_template|8.24]].
-
{| summary="Python Project Template"
+
<div id="figure-esbox_usage_python_01_template">
-
|+ align="BOTTOM" |'''Figure 8.24:''' Python Project Template
+
[[Image:python-01-template.png|frame|center|alt=Screenshot of Python project template|Figure 8.24: Python Project Template]]
-
|-
+
</div>
-
|
+
-
[[Image:python-01-template.png|Image python-01-template]]
+
-
|}
+
=== Python Targets ===
=== Python Targets ===
-
Select <span><font face="monospace">DIABLO_X86</font></span> or <span><font face="monospace">FREMANTLE_X86</font></span> as the target, figure [[#fig:esbox_usage_python_02_target|8.25]].
+
Select <code>DIABLO_X86</code> or <code>FREMANTLE_X86</code> as the target, figure [[#figure-esbox_usage_python_02_target|8.25]].
-
{| summary="Python Project Target"
+
<div id="figure-esbox_usage_python_02_target">
-
|+ align="BOTTOM" |'''Figure 8.25:''' Python Project Target
+
[[Image:python-02-target.png|frame|center|alt=Screenshot of Python project target|Figure 8.25: Python Project Target]]
-
|-
+
</div>
-
|
+
-
[[Image:python-02-target.png|Image python-02-target]]
+
-
|}
+
=== Python Metadata ===
=== Python Metadata ===
-
The '''Basic Settings''' page defines different metadata the selected template uses. You can specify additional information in the fields or use the default values, figure [[#fig:esbox_usage_python_03_metadata|8.26]].
+
The '''Basic Settings''' page defines different metadata the selected template uses. You can specify additional information in the fields or use the default values, figure [[#figure-esbox_usage_python_03_metadata|8.26]].
-
{| summary="Python Project Metadata"
+
<div id="figure-esbox_usage_python_03_metadata">
-
|+ align="BOTTOM" |'''Figure 8.26:''' Python Project Metadata
+
[[Image:python-03-metadata.png|frame|center|alt=Screenshot of Python project metadata|Figure 8.26: Python Project Metadata]]
-
|-
+
</div>
-
|
+
-
[[Image:python-03-metadata.png|Image python-03-metadata]]
+
-
|}
+
=== Python Configuration ===
=== Python Configuration ===
Line 329: Line 251:
You can define the Python configuration settings on the last page. If the wizard cannot find an existing Python configuration, it suggests to create a new configuration.
You can define the Python configuration settings on the last page. If the wizard cannot find an existing Python configuration, it suggests to create a new configuration.
-
You can use the default values and click '''Finish''' to a create project, figure [[#fig:esbox_usage_python_04_grammar|8.27]].
+
You can use the default values and click '''Finish''' to a create project, figure [[#figure-esbox_usage_python_04_grammar|8.27]].
-
{| summary="Python Project Configuration"
+
<div id="figure-esbox_usage_python_04_grammar">
-
|+ align="BOTTOM" |'''Figure 8.27:''' Python Project Configuration
+
[[Image:python-04-grammar.png|frame|center|alt=Screenshot of Python project configuration|Figure 8.27: Python Project Configuration]]
-
|-
+
</div>
-
|
+
-
[[Image:python-04-grammar.png|Image python-04-grammar]]
+
-
|}
+
If there is no previous configuration for your project, ESbox asks you to create a new configuration. To create one, click '''Yes'''.
If there is no previous configuration for your project, ESbox asks you to create a new configuration. To create one, click '''Yes'''.
-
For the Python interpreter configuration, you can add all the Python paths and confirm this by clicking '''OK''', figure [[#fig:esbox_usage_python_05_path|8.28]].
+
For the Python interpreter configuration, you can add all the Python paths and confirm this by clicking '''OK''', figure [[#figure-esbox_usage_python_05_path|8.28]].
-
{| summary="Python Project Interpreter Paths"
+
<div id="figure-esbox_usage_python_05_path">
-
|+ align="BOTTOM" |'''Figure 8.28:''' Python Project Interpreter Paths
+
[[Image:python-05-path.png|frame|center|alt=Screenshot of Python project interpreter paths|Figure 8.28: Python Project Interpreter Paths]]
-
|-
+
</div>
-
|
+
-
[[Image:python-05-path.png|Image python-05-path]]
+
-
|}
+
=== Validating Python Project Packages ===
=== Validating Python Project Packages ===
-
When you have created a new project, ESbox suggests package validation. Click '''Yes''' to accept, figure [[#fig:esbox_usage_python_c_05_validate|8.29]].
+
When you have created a new project, ESbox suggests package validation. Click '''Yes''' to accept, figure [[#figure-esbox_usage_python_c_05_validate|8.29]].
-
{| summary="Validate Packages"
+
<div id="figure-esbox_usage_python_c_05_validate">
-
|+ align="BOTTOM" |'''Figure 8.29:''' Validate Packages
+
[[Image:c-05-validate.png|frame|center|alt=Screenshot of package validation|Figure 8.29: Validate Packages]]
-
|-
+
</div>
-
|
+
-
[[Image:c-05-validate.png|Image c-05-validate]]
+
-
|}
+
-
Click '''Finish''' on the Package Validation Wizard dialog, figure [[#fig:esbox_usage_python_c_06_validate_wizard|8.30]]. ESbox installs all the required dependencies for the selected targets.
+
Click '''Finish''' on the Package Validation Wizard dialog, figure [[#figure-esbox_usage_python_c_06_validate_wizard|8.30]]. ESbox installs all the required dependencies for the selected targets.
-
{| summary="Validate Packages Wizard"
+
<div id="figure-esbox_usage_python_c_06_validate_wizard">
-
|+ align="BOTTOM" |'''Figure 8.30:''' Validate Packages Wizard
+
[[Image:c-06-validate-wizard.png|frame|center|alt=Screenshot of package validation wizard|'''Figure 8.30:''' Validate Packages Wizard]]
-
|-
+
</div>
-
|
+
-
[[Image:c-06-validate-wizard.png|Image c-06-validate-wizard]]
+
-
|}
+
If ESbox asks you about changing the target, click '''Yes''' to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.
If ESbox asks you about changing the target, click '''Yes''' to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.

Revision as of 11:12, 11 November 2010

ESbox supports C, C++, Python and Qt4 projects. This chapter briefly describes how to create different types of projects and applications and how to run, test and debug applications using Maemo SDK and a Maemo device.

ESbox requires that C/C++, Python and Qt4 development environments are installed on the host PC where Maemo SDK is run and on the Maemo device. For detailed instructions on how to install ESbox and the required development environments, see ESbox installation chapters. You need PC Connectivity to connect the Maemo device to the host PC and ESbox. For instructions on how to install and configure Maemo PC Connectivity on the Maemo device and Maemo Host PC Connectivity on the host PC where the ESbox Eclipse environment is run, see PC Connectivity documentation.

Before creating your first project with ESbox, make sure that you can connect to your Maemo device from the host PC (that PC Connectivity has been properly installed and configured).

Contents

Creating C/C++ and Qt4 Projects

C/C++ and Qt4 Templates

Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.

To create a new C or C++ project, select File > New > Project, figure 8.1.

  • C > C Maemo Project
  • C++ > C++ Maemo Project

For Qt4 projects, select C++ project.

File:Project-Python-new.png
Figure 8.1: New Project Menu

ESbox supports simple Qt4, Makefile and Autotools projects, figure 8.2.

File:C-01-projects.png
Figure 8.2: New C/C++ Project

Select any of the available templates on the Template Project Type page, figure 8.3.

File:C-02-templates.png
Figure 8.3: C/C++ Project Template
Image:Ambox_notice.png
 Maemo 4 templates are only for Diablo targets and Maemo 5 templates for Fremantle. Select the correct template depending on your installation.

C/C++ and Qt4 Targets

You can select multiple targets for a project. Optimized targets are compiled using compiler optimization while debug targets are compiled with debug options.

If you want to run a project on a Maemo device, select the ARMEL target. To run a project on the emulator, select the X86 target.

Select all targets for a project, figure 8.4. You can change the targets after you have created the project.

File:C-03-targets.png
Figure 8.4: C/C++ Project Target

If you do not see any targets on the Project Configuration page, check that Maemo SDK targets are installed and install them if necessary. For more information on how to install Maemo SDK and targets for ESbox, see ESbox installation chapters.

C/C++ and Qt4 Metadata

Other project pages define different metadata the template uses. You can specify additional information in the fields or use the default values, figure 8.5.

File:C-04-metadata.png
Figure 8.5: C/C++ Project Metadata

After defining the values, click Finish to create a project.

Validating C/C++ and Qt4 Project Packages for Maemo SDK

When you have created a new project, ESbox suggests package validation, figure 8.6. If you are not sure that the required development environments have been installed for your targets, click Yes.

File:C-05-validate.png
Figure 8.6: Validate Packages Dialog

ESbox installs all the required dependencies for your project for the selected targets, if they are not installed already, figure 8.7.

If ESbox asks you about changing the target, click Yes to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.

File:C-06-validate-wizard.png
Figure 8.7: Validate Packages Wizard

You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.

During validation, the projects are scanned for dependencies using the following information:

  • Autotools projects: PKG_CHECK_MODULES macros in configure.ac
  • Makefile projects: default metapackages for the project type and libraries detected through pkg-config invocations

Running C/C++ and Qt4 Applications on Maemo SDK

First, select the build configuration. Change the build configuration to DIABLO_X86 (Debug) or FREMANTLE_X86 (Debug)<code>.

To activate the selected configuration, right-click the project and select Build Configurations > Set active, figure 8.8.

File:C-07-set-target.png
Figure 8.8: Set C/C++ Project Target

To add or remove targets, select Manage in the same menu.

The project is ready to be launched on Maemo SDK. To launch it, right-click the project and select Run As > Maemo Local Application, figure 8.9.

File:C-08-run-as.png
Figure 8.9: Run C/C++ Project as Local Application

If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched the Application Framework successfully, you can see the Application Framework and the program running, figure 8.10.

File:C-09-result.png
Figure 8.10: C/C++ Project Local Launch Result

Running C/C++ and Qt4 Applications on a Maemo Device

To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.

Because the device uses <code>ARMEL binaries, you must to change the target platform to DIABLO_ARMEL or FREMANTLE_ARMEL and rebuild your application for the Maemo device.

First, make sure that DIABLO_ARMEL or FREMANTLE_ARMEL target is selected by right-clicking the project and selecting Properties > Build Configurations > Manage, figure 8.11.

File:C-remote-01-manage.png
Figure 8.11: C/C++ Project Manage Target Menu

Set the target to DIABLO_ARMEL or FREMANTLE_ARMEL, figure 8.12.

File:C-remote-02-targets.png
Figure 8.12: C/C++ Project Manage Targets

Right-click the project, select Build Configurations > Set Active and activate DIABLO_ARMEL (Debug) or FREMANTLE_ARMEL (Debug), figure 8.13.

File:C-remote-03-set-target.png
Figure 8.13: Set C/C++ Project Target

Validating C/C++ and Qt4 Project Packages on a Maemo Device

To be able to run your application on the Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.

Select Project Menu > Validate Installed Packages. On the first page, select the project to be validated, figure 8.14.

File:C-remote-04-validate-device.png
Figure 8.14: Validate Packages Menu

On the Target Selection page, select the correct Maemo device connection and ARMEL target, Figure 8.15.

File:C-remote-05-validate-targets.png
Figure 8.15: Validate Package Targets

To start the validation, click Finish on the last page. This installs the required packages for the selected project on the Maemo device.

You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.

Running C/C++ and Qt4 Projects on a Maemo Device

To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.

After you have set the target to ARMEL and built your application as ARMEL, you can run your application on the Maemo device. To run the application, right-click the project and select Run As > Maemo Remote Application, figure 8.16.

File:C-remote-06-run.png
Figure 8.16: Run C/C++ Project as Remote Maemo Application

Select SSH as the connection type (using the SBRSH connection type requires additional configuration), figure 8.17.

File:C-remote-07-use-ssh.png
Figure 8.17: Connection Type Dialog

Select the device connection, figure 8.16. Use USB connection because it is faster than Bluetooth or WLAN.

File:C-remote-08-select-connection.png
Figure 8.18: Select Device Connection Dialog

You can now see your application running on the Maemo device.

You can use VNC Viewer to control the Maemo device and your application running on it. Select Window > Show View > Other > VNC Viewer.

Image:Ambox_notice.png
 To use VNC Viewer, the x11vnc service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity.

Debugging C/C++ and Qt4 Applications

To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select Add Breakpoint, figure 8.19.

File:C-debug-01-breakpoint.png
Figure 8.19: Adding a Breakpoint to a C/C++ Source File

To launch your project in debug mode, right-click the project and select Debug As > Maemo Local or Remote Application. When prompted, accept changing to the debug perspective, figure 8.20.

File:C-debug-02-debug.png
Figure 8.20: Debug as Maemo Application Menu

In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures 8.21 and 8.22.

Image:Ambox_notice.png
 You can switch back and forth between perspectives by selecting from the top right corner.
File:C-debug-03-perspective.png
Figure 8.21: C/C++ Project Debug View
File:C-debug-04-variables.png
Figure 8.22: Inspect C/C++ Variables

Creating Python Projects

ESbox Python projects require that Python is installed on the host PC. For more information, see ESbox installation chapters.

Python Templates

Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.

To create a new Python project, select File > New > Project and then Python Maemo Project, figure 8.23.

File:Project-Python-new.png
Figure 8.23: New Project Menu

Select any of the Python example templates on the Template page, figure 8.24.

File:Python-01-template.png
Figure 8.24: Python Project Template

Python Targets

Select DIABLO_X86 or FREMANTLE_X86 as the target, figure 8.25.

File:Python-02-target.png
Figure 8.25: Python Project Target

Python Metadata

The Basic Settings page defines different metadata the selected template uses. You can specify additional information in the fields or use the default values, figure 8.26.

File:Python-03-metadata.png
Figure 8.26: Python Project Metadata

Python Configuration

You can define the Python configuration settings on the last page. If the wizard cannot find an existing Python configuration, it suggests to create a new configuration.

You can use the default values and click Finish to a create project, figure 8.27.

File:Python-04-grammar.png
Figure 8.27: Python Project Configuration

If there is no previous configuration for your project, ESbox asks you to create a new configuration. To create one, click Yes.

For the Python interpreter configuration, you can add all the Python paths and confirm this by clicking OK, figure 8.28.

File:Python-05-path.png
Figure 8.28: Python Project Interpreter Paths

Validating Python Project Packages

When you have created a new project, ESbox suggests package validation. Click Yes to accept, figure 8.29.

File:C-05-validate.png
Figure 8.29: Validate Packages

Click Finish on the Package Validation Wizard dialog, figure 8.30. ESbox installs all the required dependencies for the selected targets.

File:C-06-validate-wizard.png
Figure 8.30: Validate Packages Wizard

If ESbox asks you about changing the target, click Yes to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.

You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.

During validation, the projects are scanned for dependencies using Python package imports from the source files.

Running Python Applications on Maemo SDK

First, select the build configuration. Change the build configuration to DIABLO_X86 or FREMANTLE_X86.

Right-click the project and select Properties, figures 8.31.

Figure 8.31: Python Project Properties

File:Python-06-properties.png

Select Maemo Build Configurations and activate the configuration, figures 8.32

Figure 8.32: Python Project Build Configuration

File:Python-07-configuration.png

To launch the project on Maemo SDK, right-click the project and select Run As > Python Maemo Local Application, figure 8.33.

Figure 8.33: Python Project Run as Local Application

File:Python-08-run-as.png

Select the file you want to run on Maemo SDK. Do not select setup.py because it is used only for Debian package creation, figure 8.34.

Figure 8.34: Python Project Select File on Launch

File:Python-09-run-file.png

If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched Maemo Application Framework successfully, you can see the Application Framework and the program running, figure 8.35.

Figure 8.35: Python Project Local Launch Result

File:Python-10-result.png

Running Python Applications on a Maemo Device

To be able to run your Python application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.

First, make sure that DIABLO_ARMEL or FREMANTLE_ARMEL target is selected by right-clicking the project and selecting Maemo Build Configurations. Select DIABLO_ARMEL or FREMANTLE_ARMEL as the target, figure 8.36.

Figure 8.36: Select Python Project Target

File:Python-remote-02-target.png

If there is no configuration for the target, ESbox asks you to create one. To configure a new target, click Select all.

Validating Python Project Packages on a Maemo Device

To be able to run your application on a Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.

Select Project Menu > Validate Installed Packages. On the first page, select the project to be validated, figure 8.37.

Figure 8.37: Validate Packages Menu

File:C-remote-04-validate-device.png

On the Target Selection page, select the correct Maemo device connection and ARMEL target, Figure 8.38.

Figure 8.38: Validate Package Targets

File:C-remote-05-validate-targets.png

To start the validation, click Finish on the last page. This installs the required packages for the selected project on the Maemo device.

During validation, the projects are scanned for dependencies using Python package imports from the source files.

Running Python Projects on a Maemo Device

To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.

After you have set the target to ARMEL you can run your application on the Maemo device. To run the application, right-click the project and select Run As > Maemo Remote Application, figure 8.39.

Figure 8.39: Python Project Run as Remote Application

File:Python-remote-03-run.png

Select the Python file you want to run. Do not select setup.py because it is used only for Debian package creation. Select SSH as the connection type (using SBRSH requires additional configuration). Select the correct device connection.

You can now see your application running on the Maemo device.

You can use VNC Viewer to control the Maemo device and your application running on it. Select Window > Show View > Other > VNC Viewer.

Image:Ambox_notice.png
 To be able to use VNC Viewer, the x11vnc service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity.

Debugging Python Applications

To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select Add Breakpoint, figure 8.40.

Figure 8.40: Add Breakpoint to Python Project

File:Python-debug-01-breakpoint.png

To launch your project in debug mode, right-click the project and select Debug As > Maemo Local or Remote Application. When prompted, accept changing to the debug perspective, figure 8.41.

Figure 8.41: Debug Python Project as

File:Python-debug-02-debug.png

In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures 8.42 and 8.43.

Image:Ambox_notice.png
 You can switch back and forth between perspectives by selecting from the top right corner.
Figure 8.42: Python Debug View

File:Python-debug-03-perspective.png

Figure 8.43: Inspect Python Variables

File:Python-debug-04-variables.png

Debian Packaging ESbox Project

You can create Debian installation packages for your C/C++, Qt4 and Python projects using ESbox wizards. ESbox also provides some tools to help in creating the Debian package structure, and building and installing the package.

Debian Package Structure

Debian structure is debian folder under project directory. If you do not have Debian structure in your project you can create it by right clicking project and choosing Debian Package > Create Debian Structure.

Python projects need setup.py script to create a Debian package and it should be in the project root folder. You can create setup.py from the last page of the Structure wizard.

ESbox does not automate the whole Debian structure creation process, so you might need to manually modify the files in debian folder. A Debian installation package is built using Makefile located at debian/rules directory. Other files are usually install scripts and metadata.

You can find complete information on the Debian installation package structure from Debian New Maintainers' Guide

Building Debian Package

ESbox can create a Debian installation package from your project by right clicking project and choosing Debian Package > Build Debian Package. If the project does not have Debian structure defined, the wizard helps you to create one. You must select the destination where the new Debian package is created.

Installing Debian Package

After you have built a Debian installation package, you can install it inside ESbox by right-clicking project and choosing Debian Package > Install Debian Package.

Importing Projects from Repository

Background

This feature assumes you know a little bit about the workings of Debian packages. If not, the full details are in The Debian GNU/Linux FAQ; Chapter 7 - Basics of the Debian package management system.

Repositories and package types

In the Debian package manager apt (used in Scratchbox and Maemo devices), the sources.list repository configuration files contain two kinds of entries: deb and deb-src repositories. Both point to external or local repositories of packages (called system packages here). deb repositories point to binary packages while deb-src repositories point to the (usually in sync) source packages for those binary packages.

One source package may generate several binary packages; for instance, one for programs and primary data, one for auxiliary data, one for libraries, and one for development.

In apt, when fetching the sources for a binary package, you start with an interesting binary package and find its corresponding source package (for example, apt-get source <package>).

Source package structure

The sources for a package come usually in three files: a control file (*.dsc), an archive (*.tar.gz or *.tar.bz2), and a patch (*.diff.gz). apt-get source command invokes the dpkg-source command to expand the archive and apply the patch. The control file is used when rebuilding the binary package.

Once extracted, the contents of the original patched sources vary wildly. The contents may contain a bare-bones Makefile project, an autotools-based project, a nest of programs and libraries and test code, or even another archive.

There is one guarantee, though: the package expands to contain a debian directory and its various control files (see the "Source packages" chapter of the Debian Policy Manual for more details).

The debian/rules file is an executable Makefile which is the primary means of interaction with the source from the perspective of a Debian package. In other words, even if the extracted sources contain autoconf files or Makefiles, you must use debian/rules to configure, build, clean, install, and re-package the package.

For example, debian/rules configure, debian/rules build, debian/rules install are typical ways to use a source package.

It must be mentioned that even debian/rules can have varying degrees of fluctuation in the targets it provides. Most packages not developed in the Debian project itself come from a large community of people who think differently, and the targets vary accordingly. While the utility dh_make tries to promote a standard set of guidelines, some projects may, for instance, lack a configure target (or have several), lack a build target (or have several), and so on.

ESbox attempts to corral this kind of diversity with its import wizard.

Using the Wizard

Find the wizard under File > Import > ESbox > Project from Debian Repository, figure 8.44.

Figure 8.44: Import

File:ImportPackageWizard.png

Select the package to import, figure 8.45.

Figure 8.45: Import ESbox Project from Repository - Select Package

File:ImportPackageSelect.png

The target providing packages is one of the Scratchbox targets on the host PC.

{{ambox |text=The target must have the necessary deb-src entries in sources.list. Standard Maemo SDK configurations have such entries by default. |}

The package selector shows a tree of packages organized by category. You can search by typing in the filter (for words in the name or description) or typing in the tree (for the name alone).

The Fetch build dependencies option ensures that, in addition to fetching the source for the selected package, any packages needed to build the source are installed as well.

The Always re-fetch source components option asks the wizard to always go to the network and find the source components (the .dsc file, archives, and patches) for the package. This may be necessary if you have modified the package locally.

The Delete source components option deletes the .dsc file, source archives, and patches after extraction.

Next, select the build targets for the package, figure 8.46.

Figure 8.46: Import ESbox Project from Repository - Project Configuration

File:ImportPackageProject.png

The next page prepares for the source fetch, figure 8.47.

Figure 8.47: Import ESbox Project from Repository - Fetching and Importing, proxy

File:ImportPackageFetch0.png

Visit the link to ensure your proxy is configured, or else the download does not work.

Press Next to start the process, figure 8.48.

Figure 8.48: Import ESbox Project from Repository - Fetching and Importing, fetching

File:ImportPackageFetch1.png

If the fetch fails â usually indicated by a long pause after the Building dependency tree message - press Cancel to abort the process. You can select View Log from the dialog, press Back, then press Next again to retry.

The next page lets you choose the project type and builder for the package.

This is a normal case, figure 8.49.

Figure 8.49: Import ESbox Project from Repository - Convert Project

File:ImportPackageConvert1.png

Here, the project (sysstat from earlier pages) expands into a project with a Makefile. Also (off-screen) there are C sources and headers. Thus, the wizard is able to guess the project type. This page, therefore, is merely informative and you can press Next.

An imported package may, however, be provided as a compressed archive with patches. In this case, you can preconfigure the project to extract the sources and decide whether the project is really the one you are looking for.

The following screenshot shows the inimitable bash shell, which is packaged as an archive, figure 8.50.

Figure 8.50: Import ESbox Project from Repository - Convert Project, compressed archive

File:ImportPackageConvert2.png

To handle this case, the wizard selects a build rule, which appears to be a configuration rule. This would be expected to extract the archive and apply the patches.

You can manually select the rule for configuration, if desired. For example, bash can be built in several configurations for different footprints. Here are the rules found in bash's debian/rules, figure 8.51.

Figure 8.51: Import ESbox Project from Repository - Convert Project, rule selection

File:ImportPackageConvert3.png

Select a rule and click Setup project... to run the build for the given rule. The build results go to the Console behind the wizard.

For bash, and probably other packages, this configure step actually proceeds to build the entire program and run its tests â you may Cancel after the archive has been extracted and the patches have been applied, then proceed with the wizard, figure 8.52.

Figure 8.52: Import ESbox Project from Repository - Convert Project, building

File:ImportPackageConvert3b.png

Once the configuration step has been run, the conversion page updates its guess about the project, figure 8.53.

Figure 8.53: Import ESbox Project from Repository - Convert Project, updated

File:ImportPackageConvert4.png

Once the project type and builder type are known, you can Finish the wizard.

Projects imported from Debian packages can be edited, navigated, built, and launched like normal ESbox projects. You can, of course, also recreate Debian packages from them.

Related Topics

Retrieved from "http://wiki.maemo.org/Documentation/Maemo_Eclipse_Tutorial/Using_ESbox"