Projects/KDevelop4/Plugins: Code Generation - Revision history

Neverendingo: Text replace - "`" to ""`


2011-06-29T21:05:45Z
Text replace - "<code ini n>" to "<syntaxhighlight lang="ini" line>"

				
				
				
				
			
			← Older revision
			Revision as of 21:05, 29 June 2011
			
Line 117:
Line 117:
  <div class="codebox">   <div class="codebox">
  <div class="codebarbg">generators/cpp/class.rc</div>   <div class="codebarbg">generators/cpp/class.rc</div>
− <code ini n> + <syntaxhighlight lang="ini" line>
  [Generator]   [Generator]
  actionName=Create class   actionName=Create class

`Neverendingo: Text replace - "`" to ""

2011-06-29T20:49:05Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:38:28Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 20:38, 29 June 2011
			
Line 85:
Line 85:
    
  '''templates/cpp/class.rc'''   '''templates/cpp/class.rc'''
− <code ini> + <syntaxhighlight lang="ini">
  [Template]   [Template]
  contexts=cpp/class.ui   contexts=cpp/class.ui



Odysseus: moved KDevelop4/Plugins: Code Generation to Projects/KDevelop4/Plugins: Code Generation: Move to correct place in page hierarchy, although most content probably belongs on community.kde.org
2011-03-19T13:34:54Z
moved KDevelop4/Plugins: Code Generation to Projects/KDevelop4/Plugins: Code Generation: Move to correct place in page hierarchy, although most content probably belongs on community.kde.org

			
			← Older revision
			Revision as of 13:34, 19 March 2011
			


Damien.flament: /* Configuring generators */
2011-03-04T16:05:19Z
‎Configuring generators

				
				
				
				
			
			← Older revision
			Revision as of 16:05, 4 March 2011
			
Line 113:
Line 113:
  :***'''''class.rc'''''   :***'''''class.rc'''''
    
− As the template configuration file, the generator configuration file is is handled as a '''KConfig''' file: + As the  template configuration file, the generator configuration file is is handled as a '''KConfig''' file:
    
− '''generators/cpp/class.rc''' + <div class="codebox">
− <code ini> + <div class="codebarbg">generators/cpp/class.rc</div>
  + <code ini n>
  [Generator]   [Generator]
  actionName=Create class   actionName=Create class
Line 125:
Line 126:
  outputs=<classname>.cpp   outputs=<classname>.cpp
  </code>   </code>
  + </div>
  + 
  + :The '''actionName''' value is the name of your generator like it appears in the Code Generation menu.
  + :The '''description''' value is a short description of your generator used to display a tooltip.
    
  == See also ==   == See also ==
  {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}   {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}



Damien.flament: /* Configuring generators */
2011-03-04T14:06:53Z
‎Configuring generators

				
				
				
				
			
			← Older revision
			Revision as of 14:06, 4 March 2011
			
Line 124:
Line 124:
  templates=cpp/class.tpl   templates=cpp/class.tpl
  outputs=<classname>.cpp   outputs=<classname>.cpp
− <code> + </code>
    
  == See also ==   == See also ==
  {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}   {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}



Damien.flament: /* Files organization */
2011-03-04T14:06:33Z
‎Files organization

				
				
				
				
			
			← Older revision
			Revision as of 14:06, 4 March 2011
			
Line 42:
Line 42:
  The Code Generation plugin files are located into the [http://techbase.kde.org/KDE_System_Administration/KDE_Filesystem_Hierarchy#Directory_Tree KDE user data directory] of KDevelop.   The Code Generation plugin files are located into the [http://techbase.kde.org/KDE_System_Administration/KDE_Filesystem_Hierarchy#Directory_Tree KDE user data directory] of KDevelop.
    
− Each resource has its own directory : + Each resource has its own directory:
    
− *codegeneration/ + :*codegeneration/
− **'''templates/''' + :**'''templates/'''
− ***cpp/ + :***cpp/
− ***php/ + :***php/
− **'''contexts/''' + :**'''contexts/'''
− ***cpp/ + :***cpp/
− ***php/ + :***php/
− **'''generators /''' + :**'''generators /'''
− ***cpp/ + :***cpp/
− ***php/ + :***php/
    
  Each resource directory can contain directories to organize files in categories (typically, a directory by language).   Each resource directory can contain directories to organize files in categories (typically, a directory by language).
Line 82:
Line 82:
  :**generators/   :**generators/
    
− The template configuration file is handled as a '''KConfig''' file : + The template configuration file is handled as a '''KConfig''' file:
    
  + '''templates/cpp/class.rc'''
  <code ini>   <code ini>
  [Template]   [Template]
− contexts=cpp/class + contexts=cpp/class.ui
− includes=cpp/function + includes=cpp/function.tpl
  </code>   </code>
    
  :The '''contexts''' value is a list of context names   :The '''contexts''' value is a list of context names
− :The '''includes''' values is a list of template names. It contains all templates included into the current template with the '''{% include %}''' directive. It seems repetitive but it is necessary to allow the plugin to load the contexts needed by the included templates (until Grantlee provide an API to parse template files). + :The '''includes''' values is a list of template names. It contains the templates included into the current template with the '''{% include %}''' directive. It seems repetitive but it is necessary to allow the plugin to load the contexts needed by the included templates (until Grantlee provide an API to parse template files).
    
  === Configuring generators ===   === Configuring generators ===
  + Creating a generator consists in creating a '''.rc''' config file.
  + 
  + :*codegeneration/
  + :**templates/
  + :***cpp/
  + :****''class.tpl''
  + :****''class.rc''
  + :****''function.tpl''
  + :****''function.rc''
  + :***php/
  + :**contexts/
  + :***cpp/
  + :****''class.ui''
  + :***php/
  + :**generators/
  + :***cpp/
  + :***'''''class.rc'''''
  + 
  + As the template configuration file, the generator configuration file is is handled as a '''KConfig''' file:
  + 
  + '''generators/cpp/class.rc'''
  + <code ini>
  + [Generator]
  + actionName=Create class
  + desciption=Create a simple C++ class with member functions.
  + 
  + [Files]
  + templates=cpp/class.tpl
  + outputs=<classname>.cpp
  + <code>
    
  == See also ==   == See also ==
  {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}   {{UserbaseLink|KDevelop4/Manual/Plugins:_Code_Generation}}



Damien.flament: /* Configuring templates */
2011-03-04T13:44:41Z
‎Configuring templates

				
				
				
				
			
			← Older revision
			Revision as of 13:44, 4 March 2011
			
Line 68:
Line 68:
  The file hierarchy may look like this:   The file hierarchy may look like this:
    
− *codegeneration/ + :*codegeneration/
− **templates/ + :**templates/
− ***cpp/ + :***cpp/
− ****'''''class.tpl''''' + :****'''''class.tpl'''''
− ****'''''class.rc''''' + :****'''''class.rc'''''
− ****'''''function.tpl''''' + :****'''''function.tpl'''''
− ****'''''function.rc''''' + :****'''''function.rc'''''
− ***php/ + :***php/
− **contexts/ + :**contexts/
− ***cpp/ + :***cpp/
− ****''class.ui'' + :****''class.ui''
− ***php/ + :***php/
− **generators/ + :**generators/
    
  The template configuration file is handled as a '''KConfig''' file :   The template configuration file is handled as a '''KConfig''' file :
Line 89:
Line 89:
  includes=cpp/function   includes=cpp/function
  </code>   </code>
  + 
  + :The '''contexts''' value is a list of context names
  + :The '''includes''' values is a list of template names. It contains all templates included into the current template with the '''{% include %}''' directive. It seems repetitive but it is necessary to allow the plugin to load the contexts needed by the included templates (until Grantlee provide an API to parse template files).
    
  === Configuring generators ===   === Configuring generators ===



Damien.flament: /* Files organization */
2011-03-04T13:14:21Z
‎Files organization

				
				
				
				
			
			← Older revision
			Revision as of 13:14, 4 March 2011
			
Line 89:
Line 89:
  includes=cpp/function   includes=cpp/function
  </code>   </code>
−  
− == Files organization ==  
−  
− The Code Generation plugin files are located into the [http://techbase.kde.org/KDE_System_Administration/KDE_Filesystem_Hierarchy#Directory_Tree KDE user data directory] of KDevelop.  
−  
− Each resource has its own directory :  
−  
− *codegeneration/  
− **'''templates/'''  
− ***cpp/  
− ***php/  
− **'''contexts/'''  
− ***cpp/  
− ***php/  
− **'''generators /'''  
− ***cpp/  
− ***php/  
    
  === Configuring generators ===   === Configuring generators ===



Damien.flament: /* Configuring templates */
2011-03-03T21:55:00Z
‎Configuring templates

				
				
				
				
			
			← Older revision
			Revision as of 21:55, 3 March 2011
			
Line 61:
Line 61:
  === Configuring templates ===   === Configuring templates ===
    
− Each template + For each template, 2 files should be created:
  + * the template file itself, with the '''.tpl''' extension
  + * a '''.rc''' configuration file
  +  
  +  
  + The file hierarchy may look like this:
    
  *codegeneration/   *codegeneration/
− **'''templates/''' + **templates/
  ***cpp/   ***cpp/
− ****''function.tpl'' + ****'''''class.tpl'''''
− ****''function.rc'' + ****'''''class.rc'''''
  + ****'''''function.tpl'''''
  + ****'''''function.rc'''''
  ***php/   ***php/
− ****''function.tpl'' + **contexts/
− ****''function.rc'' + 
− **'''contexts/''' + 
− ***''function.ui'' + 
  ***cpp/   ***cpp/
  + ****''class.ui''
  ***php/   ***php/
− **'''generators /''' + **generators/
  +  
  + The template configuration file is handled as a '''KConfig''' file :
  +  
  + <code ini>
  + [Template]
  + contexts=cpp/class
  + includes=cpp/function
  + </code>
  +  
  == Files organization ==   == Files organization ==

Projects/KDevelop4/Plugins: Code Generation - Revision history

Neverendingo: Text replace - "" to ""

Neverendingo: Text replace - "" to ""

Neverendingo: Text replace - "" to ""

Odysseus: moved KDevelop4/Plugins: Code Generation to Projects/KDevelop4/Plugins: Code Generation: Move to correct place in page hierarchy, although most content probably belongs on community.kde.org

Damien.flament: /* Configuring generators */

Damien.flament: /* Configuring generators */

Damien.flament: /* Files organization */

Damien.flament: /* Configuring templates */

Damien.flament: /* Files organization */

Damien.flament: /* Configuring templates */

Neverendingo: Text replace - "`" to ""`

`Neverendingo: Text replace - "`" to ""

Neverendingo: Text replace - "`" to ""`