Bug 287622

Description Antóin Óg Ó Cuinneagáin 2009-08-25 18:28:41 EDT

Created attachment 145607 [details]
Basic article with same text as initial comment

Groovy has an XML Builder called MarkupBuilder
http://groovy.codehaus.org/Creating+XML+using+Groovy%27s+MarkupBuilder

code like this:
def xml = new MarkupBuilder(writer)
xml.records() {
  car(name:'HSV Maloo', make:'Holden', year:2006) {
    country('Australia')
    record(type:'speed', 'Production Pickup Truck with speed of 271kph')
  }

Produces XML like this:
 <records>
      <car name='HSV Maloo' make='Holden' year='2006'>
        <country>Australia</country>
        <record type='speed'>Production Pickup Truck with speed of 271kph</record>
      </car>


This could be useful for autogenerating extensions like commands, which also need corresponding handlers, menu entries, and commandImages.  The list of commands could also come from a Use Case document.

An example:
This groovy code:
def UseCases=[
              "CreateProject":"Create a new Project",
              "CreateBusinessObject":"Create a new Business Object",
              "GenerateDocumention":"Generate Documentation"
              ]

def pluginXMLFile=new  FileWriter(workspaceRoot+"/"+pkgSuffix+"/plugin.xml");
def pluginXML=new MarkupBuilder(pluginXMLFile);
pluginXML.setDoubleQuotes true

pluginXML.plugin(){
	extension(point:"org.eclipse.ui.commands"){
		UseCases.each {
			command(id:pkgSuffix+"."+it.key,name:it.value)
			}
	}
	extension(point:"org.eclipse.ui.commandImages"){
		UseCases.each {
			image(commandId:pkgSuffix+"."+it.key,icon:"icons/sample.gif")
			}
	}
	extension(point:"org.eclipse.ui.handlers"){
		UseCases.each {
			handler(commandId:pkgSuffix+"."+it.key,class:pkgSuffix+".handler.CommonHandler")
			}
	}
	extension(point:"org.eclipse.ui.menus"){
		menuContribution(locationURI:"menu:org.eclipse.ui.main.menu?after=additions"){
			menu(id:pkgSuffix+".menus.sampleMenu",label:"Sample Menu"){
				UseCases.each {
					command(commandId:pkgSuffix+"."+it.key)
					}				
			}
		}
	}
}

Produces this xml:
<plugin>
  <extension point="org.eclipse.ui.commands">
    <command id="com.companyname.groovygen.CreateProject" name="Create a new Project" />
    <command id="com.companyname.groovygen.CreateBusinessObject" name="Create a new Business Object" />
    <command id="com.companyname.groovygen.GenerateDocumention" name="Generate Documentation" />
  </extension>
  <extension point="org.eclipse.ui.commandImages">
    <image commandId="com.companyname.groovygen.CreateProject" icon="icons/sample.gif" />
    <image commandId="com.companyname.groovygen.CreateBusinessObject" icon="icons/sample.gif" />
    <image commandId="com.companyname.groovygen.GenerateDocumention" icon="icons/sample.gif" />
  </extension>
  <extension point="org.eclipse.ui.handlers">
    <handler commandId="com.companyname.groovygen.CreateProject" class="com.companyname.groovygen.handler.CommonHandler" />
    <handler commandId="com.companyname.groovygen.CreateBusinessObject" class="com.companyname.groovygen.handler.CommonHandler" />
    <handler commandId="com.companyname.groovygen.GenerateDocumention" class="com.companyname.groovygen.handler.CommonHandler" />
  </extension>
  <extension point="org.eclipse.ui.menus">
    <menuContribution locationURI="menu:org.eclipse.ui.main.menu?after=additions">
      <menu id="com.companyname.groovygen.menus.sampleMenu" label="Sample Menu">
        <command commandId="com.companyname.groovygen.CreateProject" />
        <command commandId="com.companyname.groovygen.CreateBusinessObject" />
        <command commandId="com.companyname.groovygen.GenerateDocumention" />
      </menu>
    </menuContribution>
  </extension>
</plugin>