NaturalONE	Version 8.3.7	SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT

This document covers the following topics:

• General Information

• Checking the Natural Code

• Clearing the NATstyle Violations

• Working with Result Files

• Invoking NATstyle from Outside Eclipse

• Overview of NATstyle Rules, Error Messages and Solutions

• DTDs Used by NATstyle

General Information

NATstyle helps you write Natural code which adheres to your coding standards. It can check the source code of all Natural object types.

Restrictions:

• NATstyle only checks the Natural objects in the Eclipse workspace. It does not check the objects on a Natural server.

• NATstyle does not download missing sources from a Natural server when checking code.

• NATstyle checks only the selected objects. However, if the Parser check option is active in the NATstyle preferences, any objects called using the INCLUDE and USING statements are also checked, if available in the Eclipse workspace.

• NATstyle uses only the settings from the .natural file (for example, the DC character or steplib settings). It does not download any settings (for example, Natural Security settings) from a Natural server.

Checking the Natural Code

NATstyle uses the settings in the Natural preferences in order to check your Natural code. You can either use the default settings or you can create your own configuration file(s) containing your own rules for checking the Natural code. For further information, see NATstyle in Setting the Preferences.

To check the Natural code

1. In the Navigator view or in the Natural Navigator view, select the project, library or source file for which you want to check the Natural code.

2. Invoke the context menu and choose NATstyle > Check Code with NATstyle.

   If you check a large number of files, the check may take a while.

   Any NATstyle violations (that is, found errors, warnings and information messages) are shown in the Problems view. If you want to view, for example, the information messages, you expand the Infos node.

   

3. Double-click an entry in the Problems view.

   The Natural editor for this type of object is invoked and the corresponding line is selected. One of the following NATstyle markers is shown for each problematic line:

   Marker	Type
   	Error
   	Warning
   	Information

   In addition to the information in the Problems view and the NATstyle markers in the editors, the icon of each node in the Navigator view or Natural Navigator view for which a NATstyle violation has been reported contains a corresponding decoration.

4. Change the code as appropriate.

   Notes:

   1. The error message "No NATstyle results, parser ended" means that the checked Natural object contains a parser error. Before it is possible to check a Natural object with NATstyle, you have to correct all parser errors.
   2. The source header cannot be modified. When a line in the source header is selected, specify the appropriate information (for example, the programming mode) in the properties for that object.
   3. The line number given for a map can be found on the List page of the map editor.
   4. For DDMs, only general messages are provided which always refer to line 1.
   5. There are messages for which an editor cannot be invoked, for example, "NATdoc library documentation (library.html) missing" which refers to the contents of a library.

Clearing the NATstyle Violations

When you correct your sources, any previously detected NATstyle violations are not automatically removed. This includes the entries in the Problems view, the NATstyle markers in the editors, and the decorations in the Navigator view or Natural Navigator view. If you want to remove the NATstyle violations, for example, for a specific library, you can clear them as described below.

Note:
The Check Code with NATstyle command automatically updates the existing NATstyle markers in the editors, the decorations in the Navigator view, and the entries in the Problems view.

To clear the NATstyle violations

1. In the Navigator view or in the Natural Navigator view, select the project, library or source file for which you want to clear the NATstyle violations.

2. Invoke the context menu and choose NATstyle > Clear NATstyle Violations.

Working with Result Files

The following topics are covered below:

• Saving the Result of a NATstyle Check to a File

• Loading a NATstyle Result File

Saving the Result of a NATstyle Check to a File

You can write the result of a NATstyle check to an XML file. The result always applies to the entire project. In this case, no information is written to the Problems view, no decorations are applied in the Navigator view or Natural Navigator view, and no NATstyle markers are set in the editors.

When you save the results to the XML file, all Natural object types as specified in the NATstyle preferences are checked. Any previously generated NATstyle information in the Problems view is disregarded. Therefore, it is not necessary to invoke the Check Code with NATstyle command prior to saving the results.

Note:
The Save Result XML command does not change or remove any already existing information in the Problems view, decorations in the Navigator view or Natural Navigator view, or NATstyle markers in the editors.

To save the result of a NATstyle check to a file

1. In the Navigator view or in the Natural Navigator view, select the project for which you want to save the results.

2. Invoke the context menu and choose NATstyle > Save Result XML.

   A dialog box appears, providing the file name NATstyleResult.xml as a proposal.

3. Specify a file name.

   It is recommended that you store the result file in the project for which it is created. This is helpful, if you later want to load the result file for this project.

4. Choose the Save button to create the NATstyle result file.

Loading a NATstyle Result File

You can load a previously saved NATstyle result file. This updates the existing NATstyle information in the Problems view, the decorations in the Navigator view or Natural Navigator view, and the NATstyle markers in any previously opened editors.

To load a NATstyle result file

1. In the Navigator view or in the Natural Navigator view, select the project for which you want to load the result file.

2. Invoke the context menu and choose NATstyle > Load Result XML.

   A dialog box appears showing the root directory of the selected project.

3. Select the result file which has been created for this project.

4. Choose the Open button.

Invoking NATstyle from Outside Eclipse

You can invoke NATstyle without having to invoke Eclipse. To do so, you invoke the class com.softwareag.naturalone.natural.natstyle with certain command line parameters.

For example, when you invoke NATstyle from within a batch file, the command line parameters can be specified as follows:

"%JAVAPATH%\bin\java.exe" -cp %CLASSPATH% 
com.softwareag.naturalone.natural.natstyle.NATstyle -projectpath %PROJECTPATH% 
-rootfolder -o %OUT%\NATstyleResult.xml >%OUT%\NATstyleGeneration.log

Note:
Make sure to specify the above information in a single line.

It is important that the following classes can be found in your class path:

com.softwareag.naturalone.natural.auxiliary
com.softwareag.naturalone.natural.common
com.softwareag.naturalone.natural.parser

The following command line parameters are available:

Overview of NATstyle Rules, Error Messages and Solutions

Rules for the following types of checks can be defined in the NATstyle preferences:

• Source Check

• Source Header Check

• Parser Check

• Error Check

• Resource Check

• Library Check

The rule names in the tables below are the names that are used in the Configuration group box of the NATstyle preferences.

Source Check

NATstyle provides the following rules for checking Natural sources:

Source Header Check

NATstyle provides the following rules for checking the Natural source header:

Parser Check

NATstyle provides the following rules for checks on parser level:

Error Check

NATstyle provides the following rules for checking error message files:

Resource Check

NATstyle provides the following rules for checking Natural resources:

Library Check

NATstyle provides the following rules for checking Natural libraries:

DTDs Used by NATstyle

The following topics are covered below:

• Structure of the Configuration File

• Structure of a NATstyle Result File

Structure of the Configuration File

The following DTD defines the structure of the configuration file:

<!ELEMENT naturalStyleCheck (packages?, checks+)>
<!ATTLIST naturalStyleCheck version CDATA #IMPLIED>
<!ELEMENT packages (package+)>

<!ELEMENT package  EMPTY>
<!ATTLIST package  url      CDATA #REQUIRED>

<!ELEMENT checks   (check+)>
<!ATTLIST checks   type     (source|header|parser|error
                            |resource|library) #REQUIRED>

<!ELEMENT check    (property*)>
<!ATTLIST check    class    CDATA #REQUIRED
                   name     CDATA #IMPLIED
                   severity (error|info|warning) #REQUIRED
                   disabled (true|false) #IMPLIED>

<!ELEMENT property EMPTY>
<!ATTLIST property value    CDATA #REQUIRED
                   name     CDATA #REQUIRED>

The elements of the DTD are described in the following table:

An implementation class can be specified for more than one check. It can be used, for example, if more then one "Regular expression to each source line" check is to be performed with different settings. The following document shows part of the default configuration file:

<?xml version="1.0" encoding=" utf-8"?>
<naturalStyleCheck version="1.0">
  <checks type="source">
    <check class="CheckLineLength" name="Line length" severity="warning">
      <property name="max" value="72"/>
      <property name="exclude" value="D3"/>
    </check>
    <check class="CheckWhiteSpace" name="Whitespace" severity="info">
      <property name="noTab" value="false"/>
      <property name="exclude" value="D3T"/>
    </check>
    <check class="CheckTabs" name="Tab character" severity="info"/>
    <check class="CheckHasLineNumbers" name="Line numbers" severity="warning"/>
    <check class="CheckEmptyLine" name="Empty lines" severity="info">
      <property name="exclude" value="D3T"/>
    </check>
    <check class="CheckRegExLine" name="Regular expression to each source line"
                                  severity="warning" disabled="true">
      <property name="exclude" value=""/>
      <property name="regex" value=""/>
    </check>
    <check class="CheckRegExSource" name="Regular expression to test source"
                                    severity="warning" disabled="true">
      <property name="exclude" value=""/>
      <property name="regex" value=""/>
    </check>
    <check class="CheckNewlineAtEndOfFile" name="Newline at end of file missing"
                                           severity="info">
      <property name="exclude" value="D"/>
    </check>
  </checks>
...
</naturalStyleCheck>

For more information on NATstyle configuration files, see NATstyle in Setting the Preferences.

Structure of a NATstyle Result File

The following DTD defines the structure of the generated result files:

<!ELEMENT NATstyle (fatal*, file*)>
<!ATTLIST NATstyle  version  CDATA #REQUIRED>
<!ELEMENT fatal EMPTY>
<!ATTLIST fatal     class    CDATA #REQUIRED
                    message  CDATA #REQUIRED
                    name     CDATA #IMPLIED>
<!ELEMENT file (error*, fatal*)>
<!ATTLIST file      type     (lib|err|res|src) #REQUIRED
                    location CDATA #REQUIRED>
<!ELEMENT error EMPTY>
<!ATTLIST error     class    CDATA #REQUIRED
                    message  CDATA #REQUIRED
                    severity (error|info|warning) #REQUIRED
                    name     CDATA #IMPLIED
                    line     CDATA #IMPLIED>

The elements of the DTD are described in the following table:

The following is an example of a generated result file:

<?xml version="1.0" encoding="UTF-8"?>
<NATstyle version="1.0">

<file type="src" location="P:\SYSEXPG\Natural-Libraries\SYSEXPG\Programs\CNOTX04.NSP">
  <error severity="warning" line="11" message="Unreferenced search field: CITY."
    class="com.softwareag.naturalone.natural.natstyle.check.src.parser.CheckUnusedSearchFields"
    name="Unused Search Fields"/>
  <error severity="warning" message="NATdoc missing."
    class="com.softwareag.naturalone.natural.natstyle.check.src.parser.CheckNATdocSource" 
    name="NATdoc Source"/>
  <error severity="warning" line="20" message="Variable BONUS not fully qualified as INCOME.BONUS."
    class="com.softwareag.naturalone.natural.natstyle.check.src.parser.CheckFullQualifiedVariable"
    name="Fully qualified variables."/>
</file>

<file type="src" location="P:\SYSEXPG\Natural-Libraries\SYSEXPG\Programs\COMPRX03.NSP">
  <error severity="info" line="29" message="Not structed correctly."
    class="com.softwareag.naturalone.natural.natstyle.check.src.header.CheckStruct" name="Struct"/>
  <error severity="warning" line="10" message="Unreferenced search field: CITY."
    class="com.softwareag.naturalone.natural.natstyle.check.src.parser.CheckUnusedSearchFields"
    name="Unused Search Fields"/>
  <error severity="warning" message="NATdoc missing."
    class="com.softwareag.naturalone.natural.natstyle.check.src.parser.CheckNATdocSource" 
    name="NATdoc Source"/>
</file>

</NATstyle>

www.softwareag.com

Copyright © 2009-2016 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT