FWD » Core Development » Base Language

<?xml version="1.0"?>

<!-- 

/*

** Module   : annotations.xml

** Abstract : analyzes Progress source trees and leaves information behind

**            to ease conversion later

**

** Copyright (c) 2005-2013, Golden Code Development Corporation.

** ALL RIGHTS RESERVED. Use is subject to license terms.

**

**           Golden Code Development Corporation

**                      CONFIDENTIAL

**

** _#_ _I_ __Date__ __JPRM__ ________________Description_________________

** 001 GES 20050721   @21753 Added a header to an already working version  

**                           which supports the following:

**                           1. variable name conversion and wrapper class

**                              determination

**                           2. determination of the correct Java method

**                              name for the length builtin function

**                              depending on parameters

**                           3. user-defined function name conversion

**                           4. user-defined procedure name conversion

**                           5. cross-references for procedure definitions

**                              and their matching define_parameter stmts

**                           6. recording loop increments

**                           7. mark variable definitions for promotion

**                              to a class member (instead of being 

**                              local)

**                           8. mark return statements as to whether

**                              they are being executed from a function

**                              or a procedure

**                           9. detect non-integral/non-constant case 

**                              statements for conversion to 

**                              if/elseif/else form instead of a switch

**                           10. stream cross-references (refs to defs)

**                           11. stream name conversion

**                           12. reorder put_field children and certain

**                               children of kw_through in an input_thru,

**                               output_thru, input_output_thru

**                           13. cross-reference seek function parm to

**                               the correct stream def

**                           14. mark the first init of a stream such

**                               that an extra close can be avoided

**                           15. rewrite COMMAND_TOKENS children to merge

**                               into the least number of tokens (which

**                               reassembles the commands the way that

**                               Progress executes them, versus how we

**                               lex them)

**                           16. convert assignment style language stmts

**                               to method call friendly form

**                           17. remove unnecessary nodes or unreachable

**                               from the tree

** 002 GES 20050728   @21901 Added support for format string processing.

** 003 GES 20050729   @21916 Added processing for extent().

** 004 GES 20050731   @21929 Added processing for shared resource

**                           definitions (variables and streams).

** 005 SIY 20050808   @22043 Added processing of the LEAVE inside CASE

**                           statement. This processing is then moved into

**                           labeling.rules. Unreachable code removal is 

**                           moved into remove_unreachable.rules.

** 006 GES 20050815   @22137 Modified processing for the return stmt,

**                           save off return types in functions and to

**                           remove the error keyword when it is bogus.

**                           Added support for generic label name

**                           conversion and cross-referencing. Changed

**                           previous "labeling" to "leave_fixups".

**                           Refactored some rulesets into separate

**                           files to modularize and simplify maint.

** 007 GES 20050816   @22141 Added support for block properties and

**                           transactions.  Also refactored more content

**                           into modular rules files.

** 008 SIY 20050818   @22165 Changes necessary to help properly collect

**                           name mappings.

** 009 GES 20050907   @22595 Moved function processing and assignment

**                           style stmt rewriting to separate files.

** 010 GES 20050919   @22790 Moved all remaining rule sets to external

**                           files and added new rule sets for record

**                           scoping.

** 011 GES 20051013   @23069 Added support for index selection and where/

**                           by clause processing.

** 012 SIY 20051024   @23093 Added frame scoping rule set into list.

** 013 GES 20051025   @23121 Added where clause processing.

** 014 GES 20051102   @23188 Added screen buffer processing.

** 015 SIY 20051103   @23187 Added naming rule set.

** 016 GES 20051103   @23225 Added record field expansion processing.

** 017 GES 20051107   @23270 Added sorting and rewriting of UI related

**                           tree structures.

** 018 GES 20051114   @23325 Added assign stmt bracketing.

** 019 GES 20051116   @23351 Added buffer name conflict resolution.

** 020 GES 20051119   @23408 Added validation preparation.

** 021 GES 20051119   @23428 Moved validation core to seperate rule set

**                           and put implicit field validation processing

**                           in the prep step.

** 022 GES 20051122   @23441 Added embedded attribute assign rewrite.

** 023 GES 20051123   @23444 Added implicit array field expansion.

** 024 GES 20051123   @23447 Added when clause and embedded assignment

**                           processing.

** 025 GES 20051127   @23517 Dynamic UI field index support.

** 026 ECF 20051127   @23522 Added preselect processing. Encapsulated in

**                           preselect_prep.rules, preselect_post.rules.

** 027 ECF 20051129   @23583 Added query_associations.rules. Used during

**                           database annotations to associate define and

**                           open query statements.

** 028 ECF 20051207   @23766 Moved command_tokens back to fixups phase.

**                           Added database_general ruleset.

** 029 ECF 20060107   @23873 Added accumulate ruleset. Supports ACCUMULATE

**                           family of features.

** 030 ECF 20060118   @23992 Removed break_groups.rules. Replaced with

**                           presort.rules.

** 031 GES 20060201   @24177 Moved Progress procedure/function to Java

**                           class/method name mapping collection here

**                           from core conversion.

** 032 ECF 20060206   @24317 Swapped order of record_field_expansion and

**                           database_general rulesets. This dependency

**                           was introduced by the addition of fieldname

**                           annotation to database_general.

** 033 ECF 20060219   @24695 Added client where clause support. Added two

**                           new rulesets: where_clause_prep2 and

**                           where_clause_post2.

** 034 ECF 20060228   @24826 Added field-level validation support. Added

**                           validation_post ruleset.

** 035 GES 20060301   @24844 Made persistence of the AST, unconditional.

**                           All access to fileMatch can be removed over

**                           time from the included rules. Once all refs

**                           are gone, the var can be deleted here. It

**                           is completely vestigal now.

** 036 GES 20060306   @24913 Added customer specific prep step.

** 037 GES 20060311   @24978 Moved variable scope promotion near the end

**                           so that client side where clauses can be

**                           detected as promotion triggers.

** 038 SIY 20060313   @25007 Added second unreachable removal step.

** 039 GES 20060313   @25042 Moved file index for name collection into a

**                           top level global var to allow it to properly

**                           increment.

** 040 GES 20060313   @25045 Read name caching data back in to allow an

**                           incremental conversion of files rather than

**                           forcing all files to be converted at once.

** 041 GES 20060319   @25107 Added parameter signature collection.

** 042 NVS 20060320   @25152 Added another rule set, validate_post2.

** 043 GES 20060404   @25341 Added text clause reparenting.

** 044 ECF 20060409   @25440 Moved buffer_name_conflicts to earlier in the

**                           pipeline. Various downstream annotations

**                           rulesets needed to be aware of the changes

**                           made by this ruleset.

** 045 GES 20060411   @25466 Moved return_statements to follow

**                           block_properties since unlabeled next

**                           can be converted to a return when not 

**                           enclosed in a loop.

** 046 NVS 20060503   @25973 Added another rule set, frame_title.

** 047 GES 20060507   @26005 Added copying of VIEW-AS from the schema.

** 048 ECF 20060627   @27632 Added where_clause_normalize ruleset.

** 049 ECF 20060730   @28246 Added adaptive_query ruleset. Also made

**                           queryNum a global variable so that the

**                           query naming function which uses it could be

**                           moved to a public function library within the

**                           database_general ruleset.

** 050 ECF 20060812   @28682 Added where_clause_pre_prep.rules. Yet

**                           another where clause preprocessing step.

** 051 ECF 20060915   @29637 Added temp_table_buffers.rules. Associates

**                           temp-table buffers with their backing temp

**                           table definition.

** 052 ECF 20060925   @29907 Moved accumulate rules after block_properties

**                           to accommodate new dependency. Accumulute

**                           rules relies on 'transLevel' annotation added

**                           to inner_block node by block_properties.

** 053 GES 20070221   @32204 Support fixups for named events.

** 054 ECF 20070821   @34911 Added support for temporary silent error

**                           mode. This allows query substitution parms to

**                           be processed safely during initialization of

**                           a query. Added query_subst_silent.rules.

** 055 ECF 20070906   @34988 Added database_late.rules. Persistence

**                           related annotations with dependencies on

**                           earlier annotations.

** 056 GES 20080403   @37802 Added scope_promotion_fields and

**                           cross_namespace_conflicts.

** 057 GES 20080623   @38943 Changed ruleset names for clarity.

** 058 GES 20080722   @39161 Split file system cfg into a separate import

**                           XML file. Simplified the name_map.xml format.

**                           Added copying of the name map to the build

**                           area so it will get JAR'd up automatically.

** 059 GES 20080814   @39421 Added unmanaged_enclosing_blocks rule-set.

** 060 GES 20080903   @39684 Moved loop_control to follow block_properties

**                           which it is now dependent upon.

** 061 GES 20080905   @39725 Added deferred_logical_evaluation rules.

** 062 GES 20080930   @39968 Added variable_definitions_undo rules.

** 063 GES 20090816   @43657 Added output_parameters.rules.

** 064 CA  20100121   @44544 Added support for merging the manually maintained

**                           cfg/name_map_merge.xml file with the main 

**                           name_map.xml.

** 065 SVL 20100606   @44903 Added support for using statements like

**                           "run some-merged-function.p.".

** 066 GES 20100819          Eliminated unnecessary var.

** 067 EVL 20121102          Adding quoteReplacement() usage to support multi

**                           OS conversion support. Fixing the filename file

**                           separator value for map creation in Windows OS

**                           conversion environment.

** 068 CA  20130119          Collect the return types for each function 

**                           in a separate map definition.

*/

 -->

<cfg>

   <!-- Makes decisions needed by multiple downstream rules.  The results

        are stored as annotations so that they will be easily available

        later. -->

   <!-- register worker objects -->

   <worker class="com.goldencode.p2j.uast.ProgressPatternWorker"

           namespace="prog" />

   <worker class="com.goldencode.p2j.convert.ExpressionConversionWorker"

           namespace="ecw" />

   <worker class="com.goldencode.p2j.pattern.TemplateWorker"

           namespace="tw" />

   <worker class="com.goldencode.p2j.xml.XmlPatternWorker" 

           namespace="xml" />

   <worker class="com.goldencode.p2j.convert.NameMappingWorker" 

           namespace="nmap" />

   <!-- expression libraries -->

   <include name="common-progress" />

   <include name="annotations/name_map_helpers" />

   <!-- variables -->

   <variable name="xmlRoot"   type="com.goldencode.p2j.xml.XmlAst" />

   <variable name="xmlAst"    type="com.goldencode.p2j.xml.XmlAst" />

   <variable name="xmlfile"   type="java.lang.String" />

   <variable name="outroot"   type="java.lang.String" />

   <variable name="pkgroot"   type="java.lang.String" />

   <variable name="outfile"   type="java.lang.String" />

   <variable name="cachefile" type="java.lang.String" />

   <variable name="queryNum"  type="java.lang.Integer" />

   <variable name="mergeRoot"  type="com.goldencode.p2j.xml.XmlAst" />

   <variable name="mergeIndex" type="com.goldencode.p2j.xml.XmlAst" />

   <variable name="mergefile"  type="java.lang.String" />

   <variable name="jname"      type="java.lang.String" />

   <variable name="pname"      type="java.lang.String" />

   <variable name="mergeMap"   type="java.util.Map" />

   <variable name="ftypesByName" type="java.util.Map" />

   <variable name="iter"       type="java.util.Iterator" />

   <!-- pipeline of rule-sets to process -->

   <!-- global initialization (once per pipeline) -->

   <init-rules>

      <rule>xmlfile = "name_map.xml"</rule>

      <rule>cachefile = "name_map.cache"</rule>

      <rule>mergefile = getConfigParameter("name_map_merge")</rule>

      <rule>ftypesByName = create("java.util.HashMap")</rule>

      <!-- name mapping must cross all files so it initialized once for the

           entire pipeline -->

      <rule>exists(xmlfile, true)

         <!-- read our cached name mapping file and initialize our data

              structures -->

         <rule>nmap.restoreMappings(cachefile)</rule>

         <rule>xmlRoot = xml.parse(xmlfile, false, null)</rule>

         <!-- find the name-map node -->

         <rule>

            xmlAst = xmlRoot.getImmediateChild(xml.element_node, null)

         </rule>

         <!-- initialize our project-wide XML name mapping file -->

         <rule on="false">

            xmlRoot = xml.createAst(xml.document_node, '#document', null)

         </rule>

         <rule on="false">

            xmlAst = xml.createAst(xml.element_node, "name-map", xmlRoot)

         </rule>

         <!-- initialize the directory import file for file system cfg -->

         <rule on="false">execLib("init_file_sys_cfg")</rule>

      </rule>

   </init-rules>

   <!-- collect all user-function definitions into a map and save its

        return type -->

   <rule-set>

      <variable name="cls"   type="java.lang.String" />

      <variable name="fname" type="java.lang.String" />

      <variable name="ftype" type="java.lang.Integer" />"

      <walk-rules>

         <rule>evalLib("function_defs")

            <action>fname = getNoteString("name")</action>

            <action>ftype = #(int) getNoteLong("type")</action>

            <rule>ftypesByName.containsKey(fname) and

                  !ftype.equals(#(java.lang.String) ftypesByName.get(fname))

               <action>

                  printfln("WARNING: Duplicate function definition %s with different returns types: %s and %s",

                           fname,

                           ftype,

                           ftypesByName.get(fname))

               </action>

            </rule>

            <action>cls = execLib("get_function_return_class", ftype)</action>

            <action>ftypesByName.put(fname, cls)</action>

         </rule>

      </walk-rules>

      <post-rules>

         <rule>printfln("%s", ftypesByName.toString())</rule>

      </post-rules>

   </rule-set>

   <!-- main processing (once per tree) -->

   <!-- should be first in this file so that unreachable nodes aren't

        further processed downstream -->

   <!-- first pass: process dead THEN/ELSE blocks -->

   <!-- do this few times to reach deeply nested blocks -->

   <rule-set name="annotations/remove_unreachable" />

   <rule-set name="annotations/remove_unreachable" />

   <rule-set name="annotations/remove_unreachable" />

   <rule-set name="annotations/remove_unreachable" />

   <rule-set name="annotations/remove_unreachable" />

   <rule-set name="annotations/remove_unreachable" />

   <!-- second pass, finally remove unreachable code -->

   <rule-set name="annotations/remove_unreachable2" />

   <!-- customer-specific tree rewriting -->

   <rule-set name="customer_specific_annotations_prep" optional="true" />

   <!-- generate names for class/package/etc. -->

   <rule-set name="annotations/naming" />

   <!-- these next two rulesets are order dependent since label_manufacturing

        creates new label_def nodes which then must be processed by the

        label_xref ruleset (which cross-references label and label_def nodes)

        -->

   <rule-set name="annotations/label_manufacturing" />

   <rule-set name="annotations/label_xref" />

   <!-- these next two rulesets are order dependent since var_defs

        detects unreferenced vars and hides them -->

   <rule-set name="annotations/variable_definitions" />

   <rule-set name="annotations/variable_definitions_undo" />

   <rule-set name="annotations/functions" />

   <rule-set name="annotations/procedures" />      

   <rule-set name="annotations/case_statements" />

   <rule-set name="annotations/input_output" />

   <rule-set name="annotations/assignment_style_stmt_rewriting" />

   <rule-set name="annotations/embedded_attribute_assign_rewrite" />

   <rule-set name="annotations/format_string" />

   <rule-set name="annotations/shared_resources" />

   <rule-set name="annotations/named_events" />

   <!-- database support: this next group of rule sets is order dependent -->

   <rule-set name="annotations/record_field_expansion" />

   <rule-set name="annotations/database_general" />

   <rule-set name="annotations/array_expansion" />

   <rule-set name="annotations/implicit_where_clause" />

   <rule-set name="annotations/record_scoping_prep" />

   <rule-set name="annotations/record_scoping" />

   <rule-set name="annotations/record_scoping_post" />

   <rule-set name="annotations/buffer_name_conflicts" />

   <rule-set name="annotations/temp_table_buffers" />

   <rule-set name="annotations/index_selection" />

   <rule-set name="annotations/preselect_prep" />

   <rule-set name="annotations/where_clause_normalize" />

   <rule-set name="annotations/where_clause_pre_prep" />

   <rule-set name="annotations/where_clause_prep" />

   <rule-set name="annotations/where_clause_prep2" />

   <rule-set name="annotations/where_clause" />

   <rule-set name="annotations/where_clause_post" />

   <rule-set name="annotations/where_clause_post2" />

   <rule-set name="annotations/query_subst_silent" />

   <rule-set name="annotations/preselect_post" />

   <rule-set name="annotations/query_associations" />

   <rule-set name="annotations/database_late" />

   <rule-set name="annotations/assign_bracketing" />

   <rule-set name="annotations/output_parameters" />

   <!-- UI support: this next group of rule sets is order dependent -->

   <rule-set name="annotations/trigger_prep" />

   <rule-set name="annotations/set_update_embedded_assignments" />

   <rule-set name="annotations/text_clause_reparenting" />

   <rule-set name="annotations/copy_view_as_from_schema" />

   <rule-set name="annotations/frame_scoping" />

   <rule-set name="annotations/frame_title" />

   <rule-set name="annotations/screen_buffer" />

   <rule-set name="annotations/validation_prep" />

   <rule-set name="annotations/validation" />

   <rule-set name="annotations/validation_post" />

   <rule-set name="annotations/validation_post2" />

   <rule-set name="annotations/when_rewriting" />

   <rule-set name="annotations/dynamic_ui_indexes" />

   <rule-set name="annotations/deferred_logical_evaluation" />

   <rule-set name="annotations/presort" />

   <rule-set name="annotations/block_properties" />

   <rule-set name="annotations/accumulate" />

   <rule-set name="annotations/return_statements" />

   <rule-set name="annotations/scope_promotion" />

   <rule-set name="annotations/scope_promotion_fields" />

   <rule-set name="annotations/cross_namespace_conflicts" />

   <rule-set name="annotations/sorting" />

   <rule-set name="annotations/cleanup" />

   <!-- rules that rely upon annotations in block_properties -->

   <rule-set name="annotations/loop_control" />

   <rule-set name="annotations/adaptive_query" />

   <rule-set name="annotations/unmanaged_enclosing_blocks" />

   <!-- this must be at the end (in the following order) -->

   <rule-set name="annotations/collect_parameters" />

   <rule-set name="annotations/collect_names" />

   <!-- persist -->

   <rule-set>

      <post-rules>

         <rule>persist()</rule>

      </post-rules>

   </rule-set>   

   <!-- global termination (once per pipeline) -->

   <post-rules>

      <!-- go through the merge file and check for collisions; since the 

           name_map may have been read from a cache, we must do this against 

           the entire name_map file -->

      <rule>mergefile != null and exists(mergefile, true)

         <!-- read the merge file and save it into a map -->

         <action>mergeRoot = xml.parse(mergefile, false, null)</action>

         <action>

            mergeIndex = mergeRoot.getImmediateChild(xml.element_node, null)

         </action>

         <action>

            printfln("Reading name map merge file %s", 

                     mergefile.substring(getConfigParameter("P2J_HOME")

                              .length()))

         </action>

         <action>mergeMap = create("java.util.HashMap")</action>

         <!-- read all the children of the name-map node -->

         <action>mergeIndex = mergeIndex.getFirstChild()</action>

         <while>mergeIndex != null

            <rule>mergeIndex.type == xml.element_node and

                  mergeIndex.text.equals("class-mapping")

               <action>

                  jname = xml.getAttributeValue(mergeIndex, "jname")

               </action>

               <action>

                  pname = fixupFileName(xml.getAttributeValue(mergeIndex, "pname"))

               </action>

               <action>mergeMap.put(pname, jname)</action>

            </rule>

            <rule>mergeIndex = mergeIndex.getNextSibling()</rule>

         </while>

         <action>

            mergeIndex = xmlRoot.getImmediateChild(xml.element_node, null)

         </action>

         <!-- read all the children of the name-map node -->

         <action>mergeIndex = mergeIndex.getFirstChild()</action>

         <while>mergeIndex != null

            <rule>mergeIndex.type == xml.element_node and

                  mergeIndex.text.equals("class-mapping")

               <action>

                  jname = xml.getAttributeValue(mergeIndex, "jname")

               </action>

               <action>

                  pname = fixupFileName(xml.getAttributeValue(mergeIndex, "pname"))

               </action>

               <rule>mergeMap.containsKey(pname)

                  <action>

                     printfln(

          "WARNING: Can't add merged mapping %s to %s - already mapped to %s",

                              pname,

                              mergeMap.get(pname),

                              jname)

                  </action>

                  <action>mergeMap.remove(pname)</action>

               </rule>

            </rule>

            <rule>mergeIndex = mergeIndex.getNextSibling()</rule>

         </while>

         <!-- map the remainder merged nodes -->

         <action>iter = mergeMap.keySet().iterator()</action>

         <while>iter.hasNext()

            <action>pname = iter.next()</action>

            <action>jname = mergeMap.get(pname)</action>

            <action>

               printfln("Adding merged mapping %s to %s", pname, jname)

            </action>

            <!-- required in order to use the statements like

                 "run some-merged-function.p." -->

            <action>nmap.addMapping(pname, jname)</action>

            <!-- required in order to use the statements like

                 "s = "some-merged-function.p". run value(s)." -->

            <action>

               execLib("createMappingNode",

                       xmlAst,

                       "class-mapping",

                       pname,

                       jname)

            </action>

         </while>

      </rule>

      <!-- persist our project-wide name mapping XML file -->

      <rule>xml.persistTarget(xmlRoot, xmlfile, false)</rule>

      <!-- copy our name mapping XML file into the proper project location -->

      <rule>outroot = getConfigParameter("output-root")</rule>

      <rule>pkgroot = getConfigParameter("pkgroot")</rule>

      <rule>

         outfile = sprintf("%s%s%s%s%s",

                           outroot,

                           fileSep,

                           pkgroot.replaceAll("\.", quoteReplacement(fileSep)),

                           fileSep,

                           xmlfile)

      </rule>

      <rule>println(outfile)</rule>

      <rule>copyFile(xmlfile, outfile, true, true)</rule>

      <!-- persist our project-wide name mapping cache file -->

      <rule>nmap.saveMappings("name_map.cache")</rule>

   </post-rules>

</cfg>