Support for Qt Creator Generic project export and associated Makefile #4115

cvtsi2sd · 2017-04-05T10:05:39Z

Description

This commit adds minimal support to mbed export to generate Qt Creator Generic Projects.

Status

READY

Link to my profile, with signed contributor agreement: https://developer.mbed.org/users/cvtsi2sd/

0xc0170 · 2017-04-05T15:03:31Z

cc @theotherjimmy

0xc0170 · 2017-04-05T15:03:59Z

@cvtsi2sd Thanks ! What does it minimal ? what it covers? any space for improvements?

cvtsi2sd · 2017-04-05T15:35:51Z

Well it's minimal because it generates a "Qt Creator Generic" project, which doesn't integrate with Qt Creator's build/debug features (as opposed to qmake, CMake and QBS based projects).

Other than that, I'd say it's complete - it produces all that a QC generic project can accept (files belonging to the project, preprocessor definitions + mbed_config.h, include paths). This enables the project pane, the class view and almost all the editing goodies - clang-based autocomplete/instant error reporting/fixits, go to definition, find usages, refactoring actions and the like.

theotherjimmy

This exporter looks great!

I have one nit: You generate files in the current directory only. For this exporter to work as an online service, it cannot modify the root of the project. In the online export service, we export to a temporary directory.

Could you change the open calls to heed the export directory and add the files you generate to the generated_files member?

theotherjimmy · 2017-04-05T16:36:01Z

Another note: your code might be made simpler if you use the jinja2 template system and the self.gen_file() method

cvtsi2sd · 2017-04-05T17:13:53Z

Export directory: sure, for some reason I was convinced that this was handled by invoking mbed directly from the other directory, and providing an appropriate --source option (as you do e.g. in cmake to have an out-of-tree build); I'll fix it this evening.

Jinja: I considered that when looking at the other exporters, but the format is so trivial that it seemed to me that it would just spread around the logic for no particular gain. OTOH if it already manages the subtleties above I may switch to it.

cvtsi2sd · 2017-04-05T17:18:51Z

I also just noticed that, although in a "generic project" it's not possible to specify the build steps through the documented files, by default Qt Creator tries to launch make in the project directory when asked to build the project, so it turns out that it may be useful to generate a Makefile as well.

theotherjimmy · 2017-04-05T18:10:05Z

@cvtsi2sd You're in luck! You can inherit from the GCC ARM Makefile exporter and call the super class generate. That will get you a makefile without any work by you.

theotherjimmy · 2017-04-05T18:10:26Z

OTOH if it already manages the subtleties above I may switch to it.

It does.

this also makes so that the export directory setting is honored

this allows Qt Creator to build the generated project "out of the box", enabling integration with the "Issues" list

cvtsi2sd · 2017-04-06T10:27:00Z

Ok, I switched to Jinja2 templates and added the Makefile generation, everything seems to be working well!

theotherjimmy · 2017-04-06T18:43:08Z

tools/export/qtcreator/creator.tmpl

@@ -0,0 +1 @@
+[General]


10/10 best template

Hahaha I told you that I was a bit ashamed to inconvenience Jinja just for this kind of output. 😄

Now it's there if we need to add something to that configuration file.

theotherjimmy · 2017-04-06T18:43:36Z

tools/export/qtcreator/__init__.py

@@ -0,0 +1,68 @@
+"""
+mbed SDK
+Copyright (c) 2014-2016 ARM Limited


Maybe extend this to 2017?

theotherjimmy

Nice job! LGTM

theotherjimmy · 2017-04-06T18:45:42Z

@cvtsi2sd Thanks so much for the exporter.

@0xc0170 After export-build finishes this is Ready for Merge

/morph export-build

bridadan · 2017-04-06T22:37:44Z

FYI, pretty sure the export-build test will fail at the moment due to an issue with gnuarmeclipse. The issue is being addressed in #4069.

mbed-bot · 2017-04-07T01:58:36Z

Result: FAILURE

Your command has finished executing! Here's what you wrote!

/morph export-build

Output

mbed Build Number: 153

Exporter Build failed!

bridadan · 2017-04-07T17:30:58Z

I've since disabled the exporter for now to test the release branch, so I'll go ahead and test this one now as well (should be passing)

/morph export-build

mbed-bot · 2017-04-07T18:59:21Z

Result: SUCCESS

Your command has finished executing! Here's what you wrote!

/morph export-build

Output

mbed Build Number: 155

All exports and builds passed!

sg- · 2017-04-10T16:03:48Z

@cvtsi2sd Can you also write a handbook page on how to use this exporter? https://github.com/ARMmbed/Handbook/tree/5.4

theotherjimmy · 2017-04-10T18:29:25Z

@sg- are you going to block merging this until we get a PR for adding this exporter to the handbook?

cvtsi2sd · 2017-04-10T19:57:10Z

@sg- I hope I did it correctly, there isn't much to write about this, so I essentially outlined what is supported and how to use it.
ARMmbed/mbed-os-5-docs#146

theotherjimmy · 2017-04-10T21:17:11Z

Thanks @cvtsi2sd. Looks like nothing is blocking this.

0xc0170 · 2017-04-21T12:21:37Z

@theotherjimmy release label for this one please?

theotherjimmy · 2017-04-21T14:17:09Z

whoops. I have got to get that habit going.

…lwip_broadcast Release mbed OS 5.4.5 and mbed lib v142 Ports for Upcoming Targets Fixes and Changes 4059: [Silicon Labs] Rename targets ARMmbed#4059 4115: Support for Qt Creator Generic project export and associated Makefile ARMmbed#4115 3915: Feature vscode ARMmbed#3915 4205: tests: race test - add not supported for single threaded env ARMmbed#4205 4187: [NCS36510] Reduce default heap size allocated by IAR to 1/4 of RAM ARMmbed#4187 4145: test - add nanostack to examples.json file ARMmbed#4145 4093: Update.py: New feature - update a branch instead of a fork, plus general improvements. ARMmbed#4093 4225: fixed missing device_name for xDot and removed progen ARMmbed#4225 4243: Config: config header file should contain new line ARMmbed#4243 4251: Fix C++11 build error w/ u-blox EVK-ODIN-W2 ARMmbed#4251 4236: STM32 Fixed warning related to __packed redefinition ARMmbed#4236 4224: Add `mbed new .` output to export ARMmbed#4224 4190: LPC4088: Enable LWIP feature ARMmbed#4190 4136: Error when bootloader is specified but does not exist ARMmbed#4136 3881: Remove debug links to printf/exit in NDEBUG builds ARMmbed#3881 4260: Inherit Xadow M0 target from LPC11U35_501 ARMmbed#4260 4249: Add consistent button names across targets ARMmbed#4249 4254: Removed unused variable in TARGET_NXP/lpc17_emac.c ARMmbed#4254

Added minimal support for Qt Creator projects

f3ccfbe

cvtsi2sd changed the title ~~Added minimal support for Qt Creator projects~~ Added minimal support for Qt Creator Generic projects Apr 5, 2017

0xc0170 added the needs: review label Apr 5, 2017

0xc0170 requested a review from theotherjimmy April 5, 2017 15:04

theotherjimmy suggested changes Apr 5, 2017

View reviewed changes

cvtsi2sd force-pushed the master branch from 84f869c to 0e0ec0b Compare April 6, 2017 09:14

QtCreator exporter: switch to jinja-based templates

70412ec

this also makes so that the export directory setting is honored

cvtsi2sd force-pushed the master branch from 0e0ec0b to 70412ec Compare April 6, 2017 09:22

Qt Creator exporter: added derivation from GccArm Makefile

92eae30

this allows Qt Creator to build the generated project "out of the box", enabling integration with the "Issues" list

0xc0170 added needs: work and removed needs: review labels Apr 6, 2017

theotherjimmy reviewed Apr 6, 2017

View reviewed changes

theotherjimmy approved these changes Apr 6, 2017

View reviewed changes

theotherjimmy added needs: CI and removed needs: work labels Apr 6, 2017

Updated year in license header

2baa215

cvtsi2sd changed the title ~~Added minimal support for Qt Creator Generic projects~~ Support for Qt Creator Generic projects and associated Makefile Apr 6, 2017

cvtsi2sd changed the title ~~Support for Qt Creator Generic projects and associated Makefile~~ Support for Qt Creator Generic project export and associated Makefile Apr 6, 2017

bridadan mentioned this pull request Apr 7, 2017

Update gnuarmeclipse to preprocess linker scripts #4069

Merged

3 tasks

0xc0170 added ready for merge and removed needs: CI labels Apr 10, 2017

cvtsi2sd mentioned this pull request Apr 10, 2017

Added documentation about the Qt Creator export ARMmbed/mbed-os-5-docs#146

Merged

theotherjimmy merged commit 55884de into ARMmbed:master Apr 10, 2017

0xc0170 removed the ready for merge label Apr 11, 2017

0xc0170 added the release-version: 5.4.5 label Apr 21, 2017

		@@ -0,0 +1 @@
		[General]

Support for Qt Creator Generic project export and associated Makefile #4115

Support for Qt Creator Generic project export and associated Makefile #4115

Uh oh!

Conversation

cvtsi2sd commented Apr 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Status

Uh oh!

0xc0170 commented Apr 5, 2017

Uh oh!

0xc0170 commented Apr 5, 2017

Uh oh!

cvtsi2sd commented Apr 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theotherjimmy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

cvtsi2sd commented Apr 5, 2017

Uh oh!

cvtsi2sd commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

cvtsi2sd commented Apr 6, 2017

Uh oh!

theotherjimmy Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

cvtsi2sd Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

theotherjimmy Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

theotherjimmy Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

cvtsi2sd Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

theotherjimmy left a comment

Choose a reason for hiding this comment

Uh oh!

theotherjimmy commented Apr 6, 2017

Uh oh!

bridadan commented Apr 6, 2017

Uh oh!

mbed-bot commented Apr 7, 2017

Result: FAILURE

Output

Uh oh!

bridadan commented Apr 7, 2017

Uh oh!

mbed-bot commented Apr 7, 2017

Result: SUCCESS

Output

Uh oh!

sg- commented Apr 10, 2017

Uh oh!

theotherjimmy commented Apr 10, 2017

Uh oh!

cvtsi2sd commented Apr 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theotherjimmy commented Apr 10, 2017

Uh oh!

0xc0170 commented Apr 21, 2017

Uh oh!

theotherjimmy commented Apr 21, 2017

Uh oh!

Uh oh!

cvtsi2sd commented Apr 5, 2017 •

edited

Loading

cvtsi2sd commented Apr 5, 2017 •

edited

Loading

theotherjimmy left a comment •

edited

Loading

cvtsi2sd commented Apr 10, 2017 •

edited

Loading