KDevelop4/Manual/Plugins: Code Generation: Difference between revisions

Latest revision as of 19:11, 17 August 2012

How To

Under Construction

This is a new page, currently under construction!

Files organization

The Code Generation plugin files are located into the KDE user data directory of KDevelop.

Each resource has its own folder :

codegeneration/
- templates/
- contexts/
- generators /

Flexibility

As Code Generation plugin is very flexible, you do not need to create templates, contexts and generators for simple tasks.

You can edit a template to modify generated source code using the same contexts. If provided data are not enough, modify the context and use your new variables in your template or simply add existing contexts.

Creating your context

The first step is to create a new widget with Qt Designer.

Information

Do not add usual dialog buttons ("Finish", "Cancel", etc.). Your widget will be inserted into a standard wizard.

Creating your context as a simple Widget

Then add a new dynamic property called contextName. Set up the value with the name of your context.

Tip

Try to find an unique context name to avoid conflicts.

It's time to define your data. Add many fields into your form. Use layouts, labels and others setup tools to make your own dialog. They will do not produce any data.

Take care of the fields names. They will be used to generate variables in the template.

Like previously mentionned, each kind of form field will produce a different data type:

name will be a string containing the name of the class
baseClasses will be a list of string containing the names of base classes
all implements* fields will be boolean

All variables names wil be prefixed by the context name : MyCppClassContext.name, MyCppClassContext.baseClasses, etc.

Now, you can save your context in an UI file named <contextName>.ui:

codegeneration/
- templates/
- contexts/
  - MyCppClassContext.ui
- generators/

Using data in your template

Create a simple text file <templateName>.tpl:

codegeneration/
- templates/
  - MyCppClassTemplate.tpl
- contexts/
  - MyCppClassContext.ui
- generators/

Use data you have defined into your context :

#ifndef {{ MyCppClassContext.name }}
#define {{ MyCppClassContext.name }}

class {{ MyCppClassContext.name }} : {% for %}{% endfor %}
{
}

#endif // {{ MyCppClassContext.name }}

@@ Line 1: / Line 1: @@
+== How To ==
 {{Construction}}
-KDevelop Code Generation plugin uses [http://grantlee.org Grantlee template engine] to generate code (like classes, functions, code documentation etc.).
-The goal of KDevelop's Grantlee implementation is to provide a very flexible template system. The architecture is based on 3 main concepts which results as resources for the plugin:
-* Template
-* Context
-* Generator
-== Resources ==
-=== Template ===
-The template define the body of the generated code.
-Templates syntax is the same as the [http://www.grantlee.org/apidox/for_themers.html Grantlee templates syntax]. All features provided by its engine are available.
-=== Context ===
-{{Note|The context handles both the user interface and the data available to the template.}}
-The user interface is what the end-user uses to configure the template. You should use Qt UIs files created with [http://doc.qt.nokia.com/4.7-snapshot/designer-manual.html Qt Designer] to define your own context.
-Code Generation plugin uses form fields to generate data. Typically, binary valued fields (checkboxs) will result as booleans, single valued fields (text fields, text areas, single selection lists, radio buttons) as strings and multi valued fields (multiple selection lists) as lists of strings.
-For convenience, all variables defined in a context are included in a namespace. It enables the use of several contexts into a single template without variables names conflict.
-==== Global contexts ====
-Many global contexts are always available in any template. They give data which does not need to be configurable by the end-user.
-Currently available global contexts are :
-===== environment =====
-===== file =====
-===== class =====
-===== function =====
-=== Generator ===
-The generator contains the templates and contexts used to generate a coherent object (a class, a function, the documentation for an item in the code etc.).
-The generator also define outputs. Each template is associated to one output where generated code will be put.
-{{Note|A generator will result as a new entry in the Code Generation menu.}}
-== How To ==
 === Files organization ===
@@ Line 81: / Line 45: @@
 * '''baseClasses''' will be a list of string containing the names of base classes
 * all '''implements*''' fields will be boolean
+All variables names wil be prefixed by the context name : '''MyCppClassContext.name''', '''MyCppClassContext.baseClasses''', etc.
@@ Line 89: / Line 55: @@
 *** MyCppClassContext.ui
 ** generators/
+=== Using data in your template ===
+Create a simple text file '''<templateName>.tpl''':
+* codegeneration/
+** templates/
+*** MyCppClassTemplate.tpl
+** contexts/
+*** MyCppClassContext.ui
+** generators/
+Use data you have defined into your context :
+{{Input|<syntaxhighlight lang="cpp" line>
+#ifndef {{ MyCppClassContext.name }}
+#define {{ MyCppClassContext.name }}
+class {{ MyCppClassContext.name }} : {% for %}{% endfor %}
+{
+}
+#endif // {{ MyCppClassContext.name }}
+</syntaxhighlight>}}
+== See also ==
+{{TechbaseLink|KDevelop4/Plugins:_Code_Generation}}
+[[Category:Development]]