FWD » Core Development » Database

**     DDF 20221123          Added nested_find.rules

   <!-- annotate nested find in for each -->

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

<?xml version="1.0"?>

<!-- 

/*

** Module   : nested_find.rules

** Abstract : annotation for nested find in for each

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** _#_ _I_ __Date__ __JPRM__ ____________________________Description_____________________________

** 001 DDF 20221123          Created initial version. Creates annotation

**                           for nested FIND in FOR EACH.

*/

 -->

<!--

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

-->

<rule-set input="tree">

   <worker class="com.goldencode.p2j.uast.ProgressPatternWorker" namespace="prog" />

   <variable name="walkAst" type="com.goldencode.ast.Aast" />

   <variable name="forEachStack" type="java.util.Stack" />

   <init-rules>

      <rule> forEachStack = create("java.util.Stack") </rule>

   </init-rules>

   <walk-rules>

      <!-- add for each schemaname to the stack -->

      <rule>type == prog.KW_FOR and this.descendant(1, prog.KW_EACH) and 

            this.nextSibling.type == prog.BLOCK

         <action>walkAst = this.getImmediateChild(prog.record_phrase, null).getChildAt(0)</action>

         <action>forEachStack.push(walkAst.getAnnotation("schemaname"))</action>

      </rule>

   </walk-rules>

   <ascent-rules>

      <!-- if find has any of the specified descendants,

           add an annotation when the stack is not empty -->

      <rule>type == prog.KW_FIND

         <rule>this.descendant(1, prog.KW_FIRST) or

               this.descendant(1, prog.KW_LAST) or

               this.descendant(1, prog.KW_NEXT) or

               this.descendant(1, prog.KW_PREV) or

               this.descendant(1, prog.KW_CURRENT) or

               this.downPath("RECORD_PHRASE/KW_WHERE")

            <rule>forEachStack.size() > 0

               <action>putNote("nested_find", true)</action>

            </rule>

         </rule>

      </rule>

      <!-- pop elements from the stack-->

      <rule>type == prog.BLOCK and 

            this.prevSibling != null and 

            this.prevSibling.type == prog.KW_FOR and

            this.prevSibling.descendant(1, prog.KW_EACH)

         <action>forEachStack.pop()</action>

      </rule>

   </ascent-rules>

</rule-set>

** 029 DDF 20221123          Added helper functions for checking nested_find annotation 

**                           and classifying types of nested finds.

      <!-- check if annotation "nested_find" is present  -->

      <function name="nested_find">

         <parameter name="target"        type="com.goldencode.ast.Aast" />

         <return    name="isNestedFind"  type="java.lang.Boolean" />

         <rule>isNestedFind = false</rule>

         <rule>target.isAnnotation("nested_find")

               <action>isNestedFind = true</action>

       	 </rule>

      </function>

      <!-- classify type of nested find -->

      <function name="type_nested_find_classify">

         <parameter name="target"        type="com.goldencode.ast.Aast" />

         <return    name="findType"      type="java.lang.String" />

         <rule>target.getImmediateChild(prog.KW_FIRST, null) != null

            <action>findType = "FIRST"</action>

         </rule>

         <rule>target.getImmediateChild(prog.KW_LAST, null) != null

            <action>findType = "LAST"</action>

         </rule>

         <rule>target.getImmediateChild(prog.KW_NEXT, null) != null

            <action>findType = "NEXT"</action>

         </rule>

         <rule>target.getImmediateChild(prog.KW_PREV, null) != null

            <action>findType = "PREV"</action>

         </rule>

         <rule>target.getImmediateChild(prog.KW_CURRENT, null) != null

            <action>findType = "CURRENT"</action>

         </rule>

         <rule>this.downPath("RECORD_PHRASE/KW_WHERE")

            <action>findType = "WHERE"</action>

         </rule>

      </function>

** 037 DDF 20221123          Added nested find report. 

   <report

      condition="evalLib("nested_find", this)"

      dumpType="parser"

      multiplexExpr="execLib("type_nested_find_classify", this)"

      title="FOR EACH Nested FIND"

      tags="Database"/>