Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "PTP/user-guides/jaxb etfw workflow"

m
m
Line 86: Line 86:
  
 
<source lang="XML">
 
<source lang="XML">
 +
<toolPanes virtual="false" embedded="false" pane-name="Tau Compiler" prepend-with="-tau_options=" enclose-with="'" separate-with=" ">
 +
  <configId>Tau Compiler.performance.options.configuration_id_</configId>
 +
  <configVarId>Tau Compiler.performance.options.environmentvariables.configuration_id_</configVarId>
 +
  <optionPane>
 +
    <rm:title>Tau Compiler</rm:title>
 +
    <rm:layout>
 +
      <rm:grid-layout />
 +
    </rm:layout>
 +
    <rm:composite>
 +
      <rm:layout>
 +
        <rm:grid-layout numColumns="3" makeColumnsEqualWidth="false" />
 +
      </rm:layout>
 +
      <rm:layout-data>
 +
        <rm:grid-data horizontalAlign="SWT.FILL" verticalAlign="SWT.FILL" grabExcessHorizontal="true" />
 +
      </rm:layout-data>
 +
      <rm:widget type="checkbox" title="Verbose" style="SWT.LEFT" attribute="Tau Compiler.performance.options.configuration_id_-OPTVERBOSE_ARGUMENT_DEFAULT">
 +
        <rm:layout-data>
 +
          <rm:grid-data horizontalAlign="SWT.FILL" grabExcessHorizontal="false" horizontalSpan="3" />
 +
        </rm:layout-data>
 +
      </rm:widget>
 +
    </rm:composite>
 +
  </optionPane>
 +
</toolPanes>
 
</source>
 
</source>
  
 
==== Paired Program Arguments ====
 
==== Paired Program Arguments ====

Revision as of 13:07, 20 December 2012

Overview

The intent of this user guide is to provide information on writing ETFw XML workflows using JAXB by going through the various parts of the workflow.

Creating an ETFw Workflow

This section will explain the parts critical parts of the XML file that represents an ETFw workflow.

Control Data

For those that are familiar with creating target configurations, this is probably a familiar term. The control data tag contains all of the attributes that are associated with the workflow. The attributes will be used to control UI actions and store information based on user selections. Below is a snippet from the ETFw TAU XML workflow. These attributes were selected because they illustrate how environment variables are stored, how UI options can be translated into program arguments and how a program argument can be paired with another attribute that has the value to pass in. In the next few sub-sections, each set of attributes will be explained in more detail with the corresponding XML UI code. 

<controlData>
  <!-- This is how an environment variable, TAU_SYNCHRONIZE_CLOCKS is set -->
  <attribute name="TAU Runtime.performance.options.environmentvariables.configuration_id_TAU_SYNCHRONIZE_CLOCKS" type="boolean" translateBooleanAs="1, ">
    <rm:default>1</rm:default>
  </attribute>
  <!-- This is how a program option is set, e.g. -optVerbose, which will get passed as a command line argument -->
  <attribute name="Tau Compiler.performance.options.configuration_id_-OPTVERBOSE_ARGUMENT_DEFAULT" type="boolean" translateBooleanAs="-optVerbose, ">
    <rm:description>Turn on verbose debugging message</rm:description>
    <rm:tooltip>Turn on verbose debugging message</rm:tooltip>
    <rm:default> </rm:default>
  </attribute>
  <!-- These last two attributes contain the program argument, -optPdtDir=, and the value to set it equal to -->
  <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT" type="boolean" translateBooleanAs="-optPdtDir=, ">
    <rm:description></rm:description>
    <rm:tooltip></rm:tooltip>
    <rm:default> </rm:default>
  </attribute>
  <attribute name="Tau Compiler.performance.options.configuration_id_-OPTPDTDIR_ARGUMENT_SAVED" type="string">
    <rm:default></rm:default>
  </attribute>
</controlData>

Environment Variables

The primary parts of the attribute for setting environment variables are:

  • Name
    • TAU Runtime.performance.options.environmentvariables.configuration_id_ is the key and should match the option panes <configVarId /> tag to which it belongs.
    • TAU_SYNCHRONIZE_CLOCKS is the environment variable to set.
  • translateBooleanAs - In many cases, environment attributes will be tied to checkbox UI options that will return a boolean that needs to be translated to something else (e.g. 1 or 0, or even a string). In the case of this attribute above, the boolean is translated as 1 for true, empty for false.

Below is a snippet of the xml workflow that would create the checkbox attribute and associate it with a tool pane. The critical parts to understand are the <configVarId> and the <rm:widget> tags. The other XML tags will be explained later in this document. 

<execTool tool-name="TAU Runtime">
  <global>
    <toolPanes virtual="false" embedded="false">
    <configId>TAU Runtime.performance.options.configuration_id_</configId>
    <configVarId>TAU Runtime.performance.options.environmentvariables.configuration_id_</configVarId>
    <optionPane>
      <rm:title>Tau Runtime</rm:title>
      <rm:layout>
        <rm:grid-layout />
      </rm:layout>
        <rm:composite>
          <rm:layout>
            <rm:grid-layout numColumns="3" makeColumnsEqualWidth="false" />
	  </rm:layout>
          <rm:layout-data>
            <rm:grid-data horizontalAlign="SWT.FILL" verticalAlign="SWT.FILL" grabExcessHorizontal="true" />
          </rm:layout-data>
          <rm:widget type="checkbox" title="Synchronize Clocks" style="SWT.LEFT" attribute="TAU Runtime.performance.options.environmentvariables.configuration_id_TAU_SYNCHRONIZE_CLOCKS">
	    <rm:layout-data>
              <rm:grid-data horizontalAlign="SWT.FILL" grabExcessHorizontal="false" horizontalSpan="3" />
            </rm:layout-data>
	  </rm:widget>
        </rm:composite>
      </optionPane>
    </toolPanes>
  </global>
</execTool>

Program Arguments

This section will discuss how UI options get translated into program arguments using the above control data as an example. In the Control Data, the option -optVerbose should get passed as a program argument based on a boolean translation (similar to the environment variable). As with the environment variable, the main parts of the attribute are:

  • name
    • Tau Compiler.performance.options.configuration_id_ is the key and should match the option panes <confiId /> tag to which it belongs. This will let the system know that it is a program argument for this tools option pane and the value should be passed to the tool.
    • -OPTVERBOSE_ARGUMENT_DEFAULT - Unlike the environment variable, this string can be anything since it doesn't have any significance.
  • translateBooleanAs - Similar to environment variables, attributes containing program arguments will primarily be tied to checkbox UI widgets that will return a boolean that needs to be translated to something else (e.g. a string value). In the case of this attribute above, the boolean is translated as -optVerbose for true, empty for false.

Below is a snippet of the xml workflow that would create the checkbox attribute for this program argument and associate it with the specified tool pane. The critical parts to understand are the <configId> and the <rm:widget> tags. The other XML tags will be explained later in this document. 

<toolPanes virtual="false" embedded="false" pane-name="Tau Compiler" prepend-with="-tau_options=" enclose-with="'" separate-with=" ">
  <configId>Tau Compiler.performance.options.configuration_id_</configId>
  <configVarId>Tau Compiler.performance.options.environmentvariables.configuration_id_</configVarId>
  <optionPane>
    <rm:title>Tau Compiler</rm:title>
    <rm:layout>
      <rm:grid-layout />
    </rm:layout>
    <rm:composite>
      <rm:layout>
        <rm:grid-layout numColumns="3" makeColumnsEqualWidth="false" />
      </rm:layout>
      <rm:layout-data>
        <rm:grid-data horizontalAlign="SWT.FILL" verticalAlign="SWT.FILL" grabExcessHorizontal="true" />
      </rm:layout-data>
      <rm:widget type="checkbox" title="Verbose" style="SWT.LEFT" attribute="Tau Compiler.performance.options.configuration_id_-OPTVERBOSE_ARGUMENT_DEFAULT">
        <rm:layout-data>
          <rm:grid-data horizontalAlign="SWT.FILL" grabExcessHorizontal="false" horizontalSpan="3" />
        </rm:layout-data>
      </rm:widget>
    </rm:composite>
  </optionPane>
</toolPanes>

Paired Program Arguments

Retrieved from "https://wiki.eclipse.org/index.php?title=PTP/user-guides/jaxb_etfw_workflow&oldid=325103"

Back to the top