Development with Code Generation: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
Line 21: Line 21:
Specific syntax is used in openPETRA for  
Specific syntax is used in openPETRA for  
* defining the hierarchy of Namespaces  
* defining the hierarchy of Namespaces  
  (U:\csharp\openpetraorg\csharp\ICT\Petra\Definitions\NamespaceHierarchy.yml)
  (csharp\ICT\Petra\Definitions\NamespaceHierarchy.yml)
* defining the navigation menu hierarchy
* defining the navigation menu hierarchy
  U:\csharp\openpetraorg\csharp\ICT\Petra\Definitions\UINavigation.yml)
  (csharp\ICT\Petra\Definitions\UINavigation.yml)
* defining the cached datatables
** csharp\ICT\Petra\Definitions\CacheableTablesAndLists.yaml
** see also [[Documentation Cacheable Tables]]
* screen definition files (see [[Documentation_YAML_for_OpenPetra_Forms]])
* screen definition files (see [[Documentation_YAML_for_OpenPetra_Forms]])
nant generateORMCachedTables


=== XAML ===
=== XAML ===

Revision as of 19:09, 6 August 2010

Tools

  • In csharp/ICT/PetraTools
  • uses CSParser to parse existing C# files
  • write code:
    • can comment generated code
    • can insert regions with name ManualCode (need endregion ManualCode as well)
  • TODO: write into Templates
  • Plugin writers for different output (Winforms, GTK, ASP.net)

YAML

YAML is a text file format that is shorter and easier to write and read than XML, but you can get the same structure than XML. This is achieved by not having opening and closing tags, but by using identation to define the hierarchy of elements. It is more friedly to read than XML, since it is less technical (no markup!).

  • Overview
  • Official specification
  • Parsers
    • see a parser for YAML: http://yaml-net-parser.sourceforge.net/default.html
    • For openPETRA we have developed our own converter from yaml to xml: project Ict.Tools.CodeGeneration, Yml2Xml.cs, Ict.Tools.CodeGeneration.Yml2Xml
      • Advantage: we can write short yaml code, but can use the comfort of the XML parser in .Net to walk through the hierarchy
      • yml2xml maps the YAML into XML

openPETRA YAML syntax

Specific syntax is used in openPETRA for

  • defining the hierarchy of Namespaces
(csharp\ICT\Petra\Definitions\NamespaceHierarchy.yml)
  • defining the navigation menu hierarchy
(csharp\ICT\Petra\Definitions\UINavigation.yml)
nant generateORMCachedTables

XAML

  • TODO: XAML idea

Documentation YML for OpenPetra Forms

see also Documentation GUI generation with YAML and Documentation YAML for OpenPetra Forms for details