Fix cics extract #2463

chacebot · 2024-09-04T17:26:20Z

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

TestCICSExtract.java
Test required args against compiler

Checklist:

Each of my commits contains one meaningful change
I have performed rebase of my branch on top of the development
I have performed a self-review of my own code
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have checked my code and corrected any misspellings

chacebot · 2024-09-09T16:23:30Z

Drafted to wait for #2464

…cats

… unit tests

chacebot · 2024-09-11T19:00:09Z

@slavek-kucera

server/engine/src/main/antlr4/org/eclipse/lsp/cobol/implicitDialects/cics/CICSParser.g4

...main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSExtractOptionsUtility.java

…hanges to receive and allocate

…dded in missed duplicate options, length required only with SET

…ies found that are not the first or are not the same token type as the first to remove redundancy with checkDuplicates

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java

...main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSExtractOptionsUtility.java

slavek-kucera · 2024-09-17T08:44:56Z

...java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSReceiveOptionsCheckUtility.java

+    checkHasMutuallyExclusiveOptions("INTO or SET", ctx.INTO(), ctx.SET());
+    if (!ctx.SET().isEmpty())
+      checkHasExactlyOneOption("LENGTH or FLENGTH", ctx, ctx.cics_length_flength());
+    checkHasMutuallyExclusiveOptions("MAXLENGTH or MAXFLENGTH", ctx.cics_maxlength());


I think there should be checkCicsMaxlength function, that internally calls checkHasMutuallyExclusiveOptions("...", ctx.MAXLENGTH(), ctx.MAXDLENGTH())

This approach allows the use of getClass() that you mentioned above. Will try it out and change the generic List<E> to be a List<TerminalNode>

@chacebot, see how I did it here: 1e19608

slavek-kucera · 2024-09-17T08:46:30Z

...java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSReceiveOptionsCheckUtility.java

-    if (ctx.FROM().isEmpty()) checkHasIllegalOptions(ctx.LENGTH(), "LENGTH");
-    if (ctx.TERMINAL().isEmpty()) checkHasIllegalOptions(ctx.INPARTN(), "INPARTN");
+    if (ctx.FROM().isEmpty()) checkHasIllegalOptions(ctx.LENGTH(), "LENGTH without FROM");
+    checkHasMutuallyExclusiveOptions("INTO or SET", ctx.cics_into_set());


Something similar here, I'd expect checkIntoSet(ctx.cics_into_set()) and then in it, length check + checkHasMutuallyExclusiveOptions("...", ctx.get(0).INTO(), ctx.get(0).SET())

or maybe the forEach approach as in the ISSUE command.

…ckExactOption

…pper case

...main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSExtractOptionsUtility.java

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java

mm-broadcom · 2024-09-19T12:31:53Z

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java

+
+    // Only raise error if this validates mutual exclusivity and is not an artifact of duplicate
+    // options
+    if (!nodes.stream()


I thought we were not allowed to use Stream due to it being Java 9?

mm-broadcom · 2024-09-19T12:32:07Z

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java

+
+    List<TerminalNode> children = new ArrayList<>();
+
+    Stream.of(rules)


More use of Stream

mm-broadcom · 2024-09-19T12:35:53Z

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java

+   * @param rules Lists of TerminalNode to iterate through
+   * @return Number of TerminalNode instances found
+   */
+  protected int checkHasMutuallyExclusiveOptions(String options, List<TerminalNode>... rules) {


No generic and check for class? What about if we want to enforce sets of ParserRuleContext variables inconjunction with TerminalNodes as well?

I had the best of both worlds set up, but the PRs are going slowly. See my commit here: development...mm-broadcom:che-che4z-lsp-for-cobol:CICS-WEB-Command-Fix-V2#diff-50eac5e66277f894df3f0b69a3d008dfc1aa9d9f0460c5c3c1b5ff41898af1f7R203

@mm-broadcom - We kinda landed on the idea of using a custom checkXYZContext() for all custom context's in the CheckXYZOptionsCheckUtility subclasses where we "unpack" each context manually for mutual exclusivity. However, checkHasExactlyOneOption() persists the usage of mixed type passing for both TerminalNodes and ParserRuleContexts

adds mutually exclusive options checking

chacebot marked this pull request as draft September 9, 2024 16:22

chacebot added 21 commits September 11, 2024 08:49

update: revert allocate antlr parser rule because it works

edbb03f

chore: removed commented out lines

edc2b22

update: added order flexibility to sub command and removed string con…

a6e136a

…cats

update: refactor duplicate checking to be automated

b84365c

chore: remove unused imports

7acdcd5

update: cleaned up warning severity param passing

81f28e6

update: revised from feedback

c2999b9

update: consolidate single static map for special severities

3646468

update: added automated check for duplicate context groups

1e37c9f

update: refactored to check duplicate tokens with a map reference

51a6127

update: converted map to set for found entries

6527ad3

update: cleaned up checkDuplicates

c3896dd

update: further simplified response handler checking

baa4600

update: simplified list parameter

5385075

chore: remove erroneous boolean

ca6e60a

chore: clean up return types and excess locals

1bac033

update: modified cics extract parser rules for completeness and added…

14c15ec

… unit tests

update: started implementation of rule context processing

b9054f0

update: added rule context checking

d311694

update: change options checker for new simple implementation

164062d

chore: restore file from rebase

78d7a66

chacebot force-pushed the fix-cics-extract branch from 81e3d55 to 78d7a66 Compare September 11, 2024 13:25

chacebot marked this pull request as ready for review September 11, 2024 13:25

slavek-kucera reviewed Sep 12, 2024

View reviewed changes

chacebot added 3 commits September 13, 2024 12:51

update: add exclusive and singular checks with tests

19bebfd

chore: corrected documentation

51f3dbd

fix: missing PARTN option for RECEIEVE propagate new checkExclusive c…

0404f9d

…hanges to receive and allocate

chacebot added 6 commits September 13, 2024 16:31

fix: mandatory check updates after more compiler tests

9f4ecda

fix: unit tests for new required input

23ff24a

fix: made modifications from findings after extra compiler testing: a…

08175a3

…dded in missed duplicate options, length required only with SET

update: improve mutually exclusive check to flag an error on all entr…

cd92aab

…ies found that are not the first or are not the same token type as the first to remove redundancy with checkDuplicates

chore: labeling corrections for consolidated group naming

379caaf

update: change checkHasMutuallyExclusive to match on option token only

e483a73

slavek-kucera reviewed Sep 17, 2024

View reviewed changes

chacebot added 6 commits September 17, 2024 11:40

update: added helper methods for subgroup contexts and refactored che…

62ade78

…ckExactOption

update: consolidated using checkMutuallyExclusive

f5926f6

fix: ensuring upper case comparison for options entered in not full u…

430f48d

…pper case

chore: make generic rule type parsing consistent

4d78046

chore: remove unused import

94afa56

update: add REALM and REALMLEN to tmLanguage

d2eb65b

slavek-kucera reviewed Sep 18, 2024

View reviewed changes

...main/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSExtractOptionsUtility.java Outdated Show resolved Hide resolved

slavek-kucera reviewed Sep 18, 2024

View reviewed changes

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java Outdated Show resolved Hide resolved

slavek-kucera reviewed Sep 18, 2024

View reviewed changes

...in/java/org/eclipse/lsp/cobol/implicitDialects/cics/utility/CICSOptionsCheckBaseUtility.java Outdated Show resolved Hide resolved

chacebot added 3 commits September 18, 2024 11:03

update:add base class check

28fb221

fix: updated spelling in test case

5055426

update: cleaned up loops with streams and consolidated common code

8fbc59e

slavek-kucera approved these changes Sep 19, 2024

View reviewed changes

update: further consolidation of list rules streaming

03416e1

slavek-kucera merged commit 2494159 into eclipse-che4z:development Sep 19, 2024
17 checks passed

mm-broadcom reviewed Sep 19, 2024

View reviewed changes

ap891843 pushed a commit that referenced this pull request Mar 14, 2025

feat: Support for CICS EXTRACT statement (#2463)

dd6d7ea

adds mutually exclusive options checking

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cics extract #2463

Fix cics extract #2463

chacebot commented Sep 4, 2024

chacebot commented Sep 9, 2024

chacebot commented Sep 11, 2024

slavek-kucera Sep 17, 2024

chacebot Sep 17, 2024

mm-broadcom Sep 17, 2024

slavek-kucera Sep 17, 2024 •

edited

Loading

mm-broadcom Sep 19, 2024

mm-broadcom Sep 19, 2024

mm-broadcom Sep 19, 2024 •

edited

Loading

chacebot Sep 19, 2024


		List<TerminalNode> children = new ArrayList<>();

		Stream.of(rules)

Fix cics extract #2463

Fix cics extract #2463

Conversation

chacebot commented Sep 4, 2024

How Has This Been Tested?

Checklist:

chacebot commented Sep 9, 2024

chacebot commented Sep 11, 2024

slavek-kucera Sep 17, 2024

Choose a reason for hiding this comment

chacebot Sep 17, 2024

Choose a reason for hiding this comment

mm-broadcom Sep 17, 2024

Choose a reason for hiding this comment

slavek-kucera Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

mm-broadcom Sep 19, 2024

Choose a reason for hiding this comment

mm-broadcom Sep 19, 2024

Choose a reason for hiding this comment

mm-broadcom Sep 19, 2024 • edited Loading

Choose a reason for hiding this comment

chacebot Sep 19, 2024

Choose a reason for hiding this comment

slavek-kucera Sep 17, 2024 •

edited

Loading

mm-broadcom Sep 19, 2024 •

edited

Loading