Development/Tutorials/KDevelop/Creating a class template - Revision history

Miha: Add warning that an unreleased kdevelop is required

2012-07-11T13:48:59Z

Add warning that an unreleased kdevelop is required

Miha: /* The implementation file */

2012-07-11T13:46:13Z

‎The implementation file

Miha: /* Installing the template */

2012-07-11T13:43:23Z

‎Installing the template

Miha: /* Installing the template */

2012-07-11T13:42:54Z

‎Installing the template

Miha: /* The implementation file */

2012-07-11T13:36:45Z

‎The implementation file

Miha: /* The class implementation */

2012-07-11T13:28:19Z

‎The class implementation

Miha: /* Whole header */

2012-07-11T13:28:05Z

‎Whole header

Miha: /* The class header file */ Include the whole file

2012-07-11T13:27:36Z

‎The class header file: Include the whole file

Miha: /* Members */

2012-07-11T13:23:47Z

‎Members

Miha: /* Class declaration */

2012-07-11T12:30:18Z

‎Class declaration

← Older revision		Revision as of 13:48, 11 July 2012
Line 1:		Line 1:
	{{Construction}}		{{Construction}}
		+
		+	{{Warning\|The functionaly described here requires an unreleased version of KDevelop. If you are not using the latest development version, while you can write class templates, you will not be able to use them.}}

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 187: / Line 187: @@
 Including the header can be done using variables. For every output file in the template, '''KDevelop''' adds two variables: <tt>output_file_foo</tt> with the relative path to file Foo, and <tt>output_file_foo_absolute</tt> with the absolute path. For C++ includes, we will use the relative path.
-<syntaxhighlight lang="smarty">
+Member functions difinitions are very similar to their declarations, except that static and virtual modifiers are dropped and the class name is prepended to function names. Therefore we can copy the function declaration code and only make a small modification.
-#include {{ output_file_header }}
-</syntaxhighlight>
-Member functions difinitions are very similar to their declaration, except that static and virtual modifiers are dropped and the class name is prepended to function names. Therefore we can copy the function declaration code and make a slight modification.
+The whole implementation is below
 <syntaxhighlight lang="smarty">
 {% for f in functions %}
    {% with f.arguments as arguments %}

@@ Line 214: / Line 214: @@
 * templates should be saved into {{path|1=<nowiki>${PREFIX}/share/apps/kdevfiletemplates/templates</nowiki>}}
 * they can be loaded from the <menuchoice>Code -> Create class from template</menuchoice> dialog
-* the CMake macro is named <tt>kdevelop_add_file_templates</tt> instead of <tt>kdevelop_add_app_templates</tt>.
+* the CMake macro is named <tt>kdevplatform_add_file_templates</tt> instead of <tt>kdevplatform_add_app_templates</tt>.

@@ Line 210: / Line 210: @@
 Now we have all the template contents prepared. We only need to compress the directory and make it available to '''KDevelop'''.
-There are three ways for doing that:
+This can be done in a similar way as installing [[special:myLanguage/Development/Tutorials/KDevelop/Creating_a_project_template#Installing_the_template|project templates]]. The only differences are:
-* compressing and loading it manually
-* loading it from within '''KDevelop'''
-* using a CMake macro.
-=== Manually ===
+* templates should be saved into {{path|1=<nowiki>${PREFIX}/share/apps/kdevfiletemplates/templates</nowiki>}}
+* they can be loaded from the <menuchoice>Code -> Create class from template</menuchoice> dialog
-First create an archive out of the {{path|kdev_tutorial}} directory. Many archive formats are accepted, but for best compatibility use {{path|.zip}} in Windows and {{path|.tar.bz2}} everywhere else. In '''Dolphin''', this can be achieved by right clicking within the directory, choosing <menuchoice>Compress -> Compress To...</menuchoice>, and entering the filename as {{path|kdev_tutorial.tar.bz2}}.
+* the CMake macro is named <tt>kdevelop_add_file_templates</tt> instead of <tt>kdevelop_add_app_templates</tt>.
-−
-Now copy the new archive somewhere where '''KDevelop''' will find it. It looks for template archives in the {{path|${PREFIX}/share/apps/kdevappwizard/templates}}, where prefix is either the system directory where KDE is installed (for example {{path|/usr}}) or the the local KDE configuration (for example {{path|~/.kde}} or {{path|~/.kde4}}). Copying our template to either is fine, choose dependeng on whether you want the template available only to you or all users on your computer.
-−
-After a run of <tt>kbuildsycoca4</tt>, '''KDevelop''' should pick up and offer you new template when creating a new project.
-−
-=== From '''KDevelop''' ===
-−
-{{Note|This method requires an unreleased version of KDevelop. If you are not using the latest development version, use one of the other two options. }}
-−
-You can have '''KDevelop''' do all this. Select <menuchoice>Project -> New From Template</menuchoice>, then in the dialog click the <menuchoice>Load Template From File</menuchoice>. Navigate to the {{path|kdev_tutorial}} directory, and open the {{path|kdev_tutorial.kdevtemplate}} file. Your template directory will be compressed and install into the local directory (usually {{path|~/.kde/share/apps/kdevappwizard/templates}}).
-−
-=== With CMake ===
-−
-'''KDevPlatform''' includes a CMake macro that takes care of compressing and installing templates. This has the disadvantage of requiring a large library for installing a simple archive file, but may be useful especially for project that already depend on it. Alternatively, you may copy [https://projects.kde.org/projects/extragear/kdevelop/kdevplatform/repository/revisions/master/entry/cmake/modules/KDevPlatformMacros.cmake KDevPlatformMacros.cmake] and put it into your project.
-−
-The macro requires that each template is in a separate directory, so create a new {{path|kdev_tutorial_templates}} directory and move {{path|kdev_tutorial}} into it. Then add the following {{path|CMakeLists.txt}} file to the top-level directory
-−
-<syntaxhighlight lang="cmake">
-project(kdevelop_template_tutorial)
-−
-find_package(KDE4 REQUIRED)
-find_package(KDevPlatform REQUIRED)
-−
-set(TEMPLATE_DIRS kdev_tutorial)
-kdevplatform_add_app_templates(${TEMPLATE_DIRS})
-</syntaxhighlight>
-−
-Build and install the project with the usual CMake steps
-−
-{{Input|1=<nowiki>
-mkdir build
-cd build
-cmake ..
-make
-make install
-</nowiki>}}
-−
-Note that this will install the template into {{path|<nowiki>${CMAKE_INSTALL_PREFIX}</nowiki>}}, for which you may need root privileges.

← Older revision		Revision as of 13:36, 11 July 2012
Line 182:		Line 182:

	=== The implementation file ===		=== The implementation file ===
		+
		+	Class implementation has the same license as the header, and needs no include guard. Instead, it has to include the header file and contain bodies for member functions.
		+
		+	Including the header can be done using variables. For every output file in the template, '''KDevelop''' adds two variables: <tt>output_file_foo</tt> with the relative path to file Foo, and <tt>output_file_foo_absolute</tt> with the absolute path. For C++ includes, we will use the relative path.
		+
		+	<syntaxhighlight lang="smarty">
		+	#include {{ output_file_header }}
		+	</syntaxhighlight>
		+
		+	Member functions difinitions are very similar to their declaration, except that static and virtual modifiers are dropped and the class name is prepended to function names. Therefore we can copy the function declaration code and make a slight modification.
		+
		+	<syntaxhighlight lang="smarty">
		+	{% for f in functions %}
		+	{% with f.arguments as arguments %}
		+	{{ f.returnType\|default:"void" }} {{ name }}::{{ f.name }}({% include "arguments_types_names.txt" %});
		+	{% endwith %}
		+	{
		+
		+	}
		+	{% endfor %}
		+	</syntaxhighlight>
		+
		+	The function body is left empty and has to be implemented by the user.

	== Installing the template ==		== Installing the template ==

@@ Line 181: / Line 181: @@
 </syntaxhighlight>
-=== The class implementation ===
+=== The implementation file ===
 == Installing the template ==

← Older revision		Revision as of 13:27, 11 July 2012
Line 147:		Line 147:

	Member variables are simple, they only require a type and a name.		Member variables are simple, they only require a type and a name.
		+
		+	==== Whole header ====
		+
		+	The entire header file looks like this
		+
		+	<syntaxhighlight lang="smarty">
		+	{% load kdev_filters %}
		+	/*
		+	{{ license\|lines_prepend:" * " }}
		+	*/
		+
		+	#ifndef {% include "include_guard_cpp.txt" %}
		+	#define {% include "include_guard_cpp.txt" %}
		+
		+	class {{ name }}
		+	{% if baseClasses %}
		+	: {% for b in baseClasses %}b.inheritanceMode b.baseType{% if not forloop.last %}, {% endif %}{% endfor %}
		+	{% endif %}
		+	{
		+	public:
		+	{% for f in functions %}
		+	{% with f.arguments as arguments %}
		+	{{ f.returnType\|default:"void" }} {{ f.name }}({% include "arguments_types_names.txt" %});
		+	{% endwith %}
		+	{% endfor %}
		+
		+	{% for m in members %}
		+	{{ m.type }} {{ m.name }};
		+	{% endfor %}
		+	};
		+
		+	#endif // {% include "include_guard_cpp.txt" %}
		+	</syntaxhighlight>

	== Installing the template ==		== Installing the template ==

← Older revision		Revision as of 13:23, 11 July 2012
Line 125:		Line 125:

	==== Members ====		==== Members ====
		+
		+	Classes can have two kinds of members: variables and functions. They are available to templates as <tt>members</tt> and <tt>functions</tt> variables, respectively. Both are lists and are intended to be iterated.
		+
		+	For simplicity, we will ignore access modes and various function modifiers (const, virtual, static, etc).
		+
		+	<syntaxhighlight lang="smarty">
		+	{% for f in functions %}
		+	{% with f.arguments as arguments %}
		+	{{ f.returnType\|default:"void" }} {{ f.name }}({% include "arguments_types_names.txt" %});
		+	{% endwith %}
		+	{% endfor %}
		+	</syntaxhighlight>
		+
		+	Every function in C++ has a return type, if it returns nothing that type is <tt>void</tt>, which is what the <tt>default</tt> filter assures. Next, we have included another templates, called <tt>arguments_types_names.txt</tt>, which creates an argument list for language that require both argument types and names to be specified. This template requires a variables called <tt>arguments</tt>, which we created within the <tt>{% with %}</tt> statement.
		+
		+	<syntaxhighlight lang="smarty">
		+	{% for m in members %}
		+	{{ m.type }} {{ m.name }};
		+	{% endfor %}
		+	</syntaxhighlight>
		+
		+	Member variables are simple, they only require a type and a name.

	== Installing the template ==		== Installing the template ==

← Older revision		Revision as of 12:30, 11 July 2012
Line 103:		Line 103:

	==== Class declaration ====		==== Class declaration ====
		+
		+	Information about inheritance is stored in the <tt>baseClasses</tt> variable. It is a list that can be iterated using a <tt>for</tt> loop. Each list element has two properties, <tt>inheritanceMode</tt> and <tt>baseType</tt>, which can be accessed using the dot notation, like class members in C++ or Python.
		+
		+	<syntaxhighlight lang="cpp">
		+	class {{ name }}
		+	{% if baseClasses %}
		+	: {% for b in baseClasses %}b.inheritanceMode b.baseType{% if not forloop.last %}, {% endif %}{% endfor %}
		+	{% endif %}
		+	{
		+	</syntaxhighlight>
		+
		+	If our new class inherites from KFoo and KBar, and both inheritances are public, the output from such a template looks like
		+
		+	{{Output\|1=<nowiki>
		+	class Example
		+	: public KFoo, public KBar
		+	{
		+	</nowiki>}}
		+
		+	The template text could also be written in one line, so that the inheritance declarations (as possible the opening brace) would be on the same line as the class name. It is only written out this way in the tutorial for better readability. Both versions are valid C++.

	==== Members ====		==== Members ====