-
Notifications
You must be signed in to change notification settings - Fork 70
/
downport.ts
3318 lines (2825 loc) · 128 KB
/
downport.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable max-len */
import * as Statements from "../abap/2_statements/statements";
import * as Expressions from "../abap/2_statements/expressions";
import * as Structures from "../abap/3_structures/structures";
import {BasicRuleConfig} from "./_basic_rule_config";
import {Issue} from "../issue";
import {IRule, IRuleMetadata, RuleTag} from "./_irule";
import {Unknown} from "../abap/2_statements/statements/_statement";
import {ExpressionNode, StatementNode, TokenNode} from "../abap/nodes";
import {IEdit, EditHelper} from "../edit_helper";
import {Position} from "../position";
import {VirtualPosition} from "../virtual_position";
import {ABAPFile} from "../abap/abap_file";
import {IRegistry} from "../_iregistry";
import {IObject} from "../objects/_iobject";
import {ABAPObject} from "../objects/_abap_object";
import {Version} from "../version";
import {Registry} from "../registry";
import {SyntaxLogic} from "../abap/5_syntax/syntax";
import {ISpaghettiScopeNode, ISyntaxResult} from "../abap/5_syntax/_spaghetti_scope";
import {ReferenceType} from "../abap/5_syntax/_reference";
import {IClassDefinition} from "../abap/types/_class_definition";
import {TypedIdentifier} from "../abap/types/_typed_identifier";
import {AnyType, ObjectReferenceType, StructureType, TableType, VoidType} from "../abap/types/basic";
import {Config} from "../config";
import {AbstractToken} from "../abap/1_lexer/tokens/abstract_token";
import {At, ParenLeftW, WAt, WParenLeftW, WParenRight, WParenRightW} from "../abap/1_lexer/tokens";
import {IncludeGraph} from "../utils/include_graph";
import {Program} from "../objects";
import {BuiltIn} from "../abap/5_syntax/_builtin";
import {ScopeType} from "../abap/5_syntax/_scope_type";
import {ElseIf} from "../abap/2_statements/statements";
import * as crypto from "crypto";
// todo: refactor each sub-rule to new classes?
// todo: add configuration
export class DownportConf extends BasicRuleConfig {
}
class SkipToNextFile extends Error {
public issue: Issue;
public constructor(issue: Issue) {
super();
this.issue = issue;
}
}
class SpagHelper {
private readonly spag: ISpaghettiScopeNode;
public constructor(spag: ISpaghettiScopeNode) {
this.spag = spag;
}
public renameVariable(oldName: string, pos: Position, lowFile: ABAPFile, newName: string) {
let fix: IEdit | undefined = undefined;
const references = this.findReferences(oldName, pos);
references.sort((a, b) => {
if (a.start.equals(b.start)) {
return 0;
}
return a.start.isAfter(b.start) ? 1 : -1;
});
for (const r of references) {
const replace = EditHelper.replaceRange(lowFile, r.start, r.end, newName);
if (fix === undefined) {
fix = replace;
} else {
fix = EditHelper.merge(replace, fix);
}
}
return fix;
}
private findReferences(name: string, pos: Position): {start: Position, end: Position}[] {
const positions: {start: Position, end: Position}[] = [];
function has(element: {start: Position, end: Position}): boolean {
return positions.some(a => a.start.equals(element.start));
}
for (const r of this.spag.getData().references) {
if (r.resolved?.getName() === name && r.resolved?.getStart().equals(pos)) {
const sub = {
start: r.position.getStart(),
end: r.position.getEnd(),
};
if (has(sub) === false) {
positions.push(sub);
}
}
}
for (const child of this.spag.getChildren()) {
const subPositions = new SpagHelper(child).findReferences(name, pos);
for (const sub of subPositions) {
if (has(sub) === false) {
positions.push(sub);
}
}
}
return positions;
}
public findRecursiveDuplicate(name: string, skip: Position): TypedIdentifier | undefined {
const found = this.spag.findVariable(name);
if (found?.getStart().equals(skip) === false) {
return found;
}
for (const child of this.spag?.getChildren() || []) {
const sub = new SpagHelper(child).findRecursiveDuplicate(name, skip);
if (sub) {
return sub;
}
}
return undefined;
}
public isDuplicateName(name: string, pos: Position) {
let parent = this.spag.getParent();
while (parent?.getIdentifier().stype === ScopeType.Let
|| parent?.getIdentifier().stype === ScopeType.For) {
parent = parent.getParent();
}
if (parent === undefined) {
return undefined;
}
return new SpagHelper(parent).findRecursiveDuplicate(name, pos) !== undefined;
}
}
export class Downport implements IRule {
private lowReg: IRegistry;
private highReg: IRegistry;
private conf = new DownportConf();
private counter: number;
private graph: IncludeGraph | undefined;
public getMetadata(): IRuleMetadata {
return {
key: "downport",
title: "Downport statement",
shortDescription: `Downport functionality`,
extendedInformation: `Much like the 'commented_code' rule this rule loops through unknown statements and tries parsing with
a higher level language version. If successful, various rules are applied to downport the statement.
Target downport version is always v702, thus rule is only enabled if target version is v702.
Current rules:
* NEW transformed to CREATE OBJECT, opposite of https://rules.abaplint.org/use_new/
* DATA() definitions are outlined, opposite of https://rules.abaplint.org/prefer_inline/
* FIELD-SYMBOL() definitions are outlined
* CONV is outlined
* COND is outlined
* REDUCE is outlined
* SWITCH is outlined
* FILTER is outlined
* APPEND expression is outlined
* INSERT expression is outlined
* EMPTY KEY is changed to DEFAULT KEY, opposite of DEFAULT KEY in https://rules.abaplint.org/avoid_use/
* CAST changed to ?=
* LOOP AT method_call( ) is outlined
* VALUE # with structure fields
* VALUE # with internal table lines
* Table Expressions are outlined
* SELECT INTO @DATA definitions are outlined
* Some occurrences of string template formatting option ALPHA changed to function module call
* SELECT/INSERT/MODIFY/DELETE/UPDATE "," in field list removed, "@" in source/targets removed
* PARTIALLY IMPLEMENTED removed, it can be quick fixed via rule implement_methods
* RAISE EXCEPTION ... MESSAGE
* Moving with +=, -=, /=, *=, &&= is expanded
* line_exists and line_index is downported to READ TABLE
* ENUMs, but does not nessesarily give the correct type and value
* MESSAGE with non simple source
Only one transformation is applied to a statement at a time, so multiple steps might be required to do the full downport.
Make sure to test the downported code, it might not always be completely correct.`,
tags: [RuleTag.Downport, RuleTag.Quickfix],
};
}
public getConfig() {
return this.conf;
}
public setConfig(conf: DownportConf): void {
this.conf = conf;
}
public initialize(reg: IRegistry) {
this.lowReg = reg;
const version = this.lowReg.getConfig().getVersion();
if (version === Version.v702 || version === Version.OpenABAP) {
this.initHighReg();
}
return this;
}
private listMainForInclude(filename: string | undefined) {
if (filename === undefined) {
return [];
}
// only initialize this.graph if needed
if (this.graph === undefined) {
this.graph = new IncludeGraph(this.lowReg);
}
return this.graph.listMainForInclude(filename);
}
private containsError(highObj: ABAPObject): boolean {
for (const file of highObj.getABAPFiles()) {
for (const statement of file.getStatements()) {
if (statement.get() instanceof Unknown) {
return true; // contains parser errors
}
}
if (file.getStructure() === undefined) {
return true;
}
}
return false;
}
public run(lowObj: IObject): Issue[] {
const ret: Issue[] = [];
this.counter = 1;
const version = this.lowReg.getConfig().getVersion();
if (version !== Version.v702 && version !== Version.OpenABAP) {
return ret;
} else if (!(lowObj instanceof ABAPObject)) {
return ret;
}
const highObj = this.highReg.getObject(lowObj.getType(), lowObj.getName());
if (highObj === undefined || !(highObj instanceof ABAPObject)) {
return ret;
}
let highSyntaxObj = highObj;
if (this.containsError(highObj)) {
return ret;
}
// for includes do the syntax check via a main program
if (lowObj instanceof Program && lowObj.isInclude()) {
const mains = this.listMainForInclude(lowObj.getMainABAPFile()?.getFilename());
if (mains.length <= 0) {
return [];
}
const f = this.highReg.getFileByName(mains[0]);
if (f === undefined) {
return [];
}
highSyntaxObj = this.highReg.findObjectForFile(f) as ABAPObject;
}
for (const lowFile of lowObj.getABAPFiles()) {
let highSyntax: ISyntaxResult | undefined = undefined;
const highFile = highObj.getABAPFileByName(lowFile.getFilename());
if (highFile === undefined) {
continue;
}
const lowStatements = lowFile.getStatements();
const highStatements = highFile.getStatements();
if (lowStatements.length !== highStatements.length) {
// after applying a fix, there might be more statements in lowFile
// should highReg be initialized again?
/*
const message = "Internal Error: Statement lengths does not match";
ret.push(Issue.atStatement(lowFile, lowStatements[0], message, this.getMetadata().key));
*/
// hmm, add some way to disable lazyUnknown() in statement_parser.ts
// alternatively explicit enable it in vscode, its only relevant when a user is
// actively editing the files
continue;
}
if (highSyntax === undefined) {
highSyntax = new SyntaxLogic(this.highReg, highSyntaxObj).run();
}
let containsUnknown = false;
for (let i = 0; i < lowStatements.length; i++) {
const low = lowStatements[i];
const high = highStatements[i];
if ((low.get() instanceof Unknown && !(high.get() instanceof Unknown))
|| high.findFirstExpression(Expressions.InlineData)) {
containsUnknown = true;
try {
const issue = this.checkStatement(low, high, lowFile, highSyntax, highFile);
if (issue) {
ret.push(issue);
}
} catch (e) {
if (e instanceof SkipToNextFile) {
ret.push(e.issue);
break;
} else {
throw e;
}
}
}
}
if (ret.length === 0 && containsUnknown) {
// this is a hack in order not to change too many unit tests
for (let i = 0; i < lowStatements.length; i++) {
const high = highStatements[i];
if (high.get() instanceof Statements.Data) {
const issue = this.anonymousTableType(high, lowFile, highSyntax);
if (issue) {
ret.push(issue);
}
}
}
}
if (ret.length === 0 && lowFile.getRaw().includes(" xsdbool(")) {
for (let i = 0; i < lowStatements.length; i++) {
const high = highStatements[i];
const issue = this.replaceXsdBool(high, lowFile, highSyntax);
if (issue) {
ret.push(issue);
}
}
}
}
return ret;
}
////////////////////
/** clones the orginal repository into highReg, and parses it with higher language version */
private initHighReg() {
// use default configuration, ie. default target version
const highConfig = Config.getDefault().get();
const lowConfig = this.lowReg.getConfig().get();
highConfig.syntax.errorNamespace = lowConfig.syntax.errorNamespace;
highConfig.syntax.globalConstants = lowConfig.syntax.globalConstants;
highConfig.syntax.globalMacros = lowConfig.syntax.globalMacros;
this.highReg = new Registry();
for (const o of this.lowReg.getObjects()) {
for (const f of o.getFiles()) {
if (this.lowReg.isDependency(o) === true) {
this.highReg.addDependency(f);
} else {
this.highReg.addFile(f);
}
}
}
this.highReg.parse();
}
/** applies one rule at a time, multiple iterations are required to transform complex statements */
private checkStatement(low: StatementNode, high: StatementNode, lowFile: ABAPFile,
highSyntax: ISyntaxResult, highFile: ABAPFile): Issue | undefined {
if (low.getFirstToken().getStart() instanceof VirtualPosition) {
return undefined;
}
// downport XSDBOOL() early, as it is valid 702 syntax
/*
let found = this.replaceXsdBool(high, lowFile, highSyntax);
if (found) {
return found;
}
*/
let found = this.downportEnum(low, high, lowFile, highSyntax, highFile);
if (found) {
return found;
}
found = this.partiallyImplemented(high, lowFile);
if (found) {
return found;
}
found = this.raiseException(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.emptyKey(low, high, lowFile);
if (found) {
return found;
}
found = this.stringTemplateAlpha(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.moveWithOperator(low, high, lowFile);
if (found) {
return found;
}
found = this.moveWithSimpleValue(low, high, lowFile);
if (found) {
return found;
}
found = this.assignWithTable(low, high, lowFile);
if (found) {
return found;
}
found = this.assignComponent(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportRefSimple(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportCorrespondingSimple(high, lowFile);
if (found) {
return found;
}
found = this.downportRef(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportLoopGroup(high, lowFile, highSyntax, highFile);
if (found) {
return found;
}
found = this.callFunctionParameterSimple(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.moveWithTableTarget(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportSelectInline(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportSelectExistence(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportSQLExtras(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineLoopInput(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineLoopTarget(high, lowFile, highSyntax);
if (found) {
return found;
}
let skipValue = false;
let skipReduce = false;
const valueBody = high.findFirstExpression(Expressions.ValueBody);
const reduceBody = high.findFirstExpression(Expressions.ReduceBody);
if (valueBody && reduceBody) {
const valueToken = valueBody.getFirstToken();
const reduceToken = reduceBody.getFirstToken();
if (valueToken.getStart().isBefore(reduceToken.getStart())) {
skipReduce = true;
} else {
skipValue = true;
}
}
if (skipValue !== true) {
found = this.outlineValue(low, high, lowFile, highSyntax);
if (found) {
return found;
}
}
if (skipReduce !== true) {
found = this.outlineReduce(low, high, lowFile, highSyntax);
if (found) {
return found;
}
}
found = this.outlineCorresponding(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportSelectFields(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineSwitch(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineFilter(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineCast(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineConv(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineCond(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineCatchSimple(high, lowFile);
if (found) {
return found;
}
found = this.outlineGetReferenceSimple(high, lowFile);
if (found) {
return found;
}
found = this.outlineDataSimple(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineData(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.outlineFS(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.newToCreateObject(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceLineFunctions(high, lowFile, highSyntax, highFile);
if (found) {
return found;
}
found = this.getReference(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceContains(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceMethodConditional(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceTableExpression(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceAppendExpression(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.replaceInsertExpression(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportMessageSource(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportMessage(high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportReadTable(high, lowFile, highSyntax);
if (found) {
return found;
}
return undefined;
}
//////////////////////////////////////////
/** removes @'s */
private downportSQLExtras(low: StatementNode, high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
}
if (!(high.get() instanceof Statements.Select)
&& !(high.get() instanceof Statements.SelectLoop)
&& !(high.get() instanceof Statements.UpdateDatabase)
&& !(high.get() instanceof Statements.ModifyDatabase)
&& !(high.get() instanceof Statements.DeleteDatabase)
&& !(high.get() instanceof Statements.InsertDatabase)) {
return undefined;
}
let fix: IEdit | undefined = undefined;
const addFix = (token: AbstractToken) => {
const add = EditHelper.deleteToken(lowFile, token);
if (fix === undefined) {
fix = add;
} else {
fix = EditHelper.merge(fix, add);
}
};
const candidates = [high.findAllExpressionsRecursive(Expressions.SQLTarget),
high.findAllExpressionsRecursive(Expressions.SQLSource),
high.findAllExpressionsRecursive(Expressions.SQLSourceNoSpace),
high.findAllExpressionsRecursive(Expressions.SQLSourceSimple)].flat();
for (const c of candidates.reverse()) {
if (c.getFirstToken() instanceof WAt
|| c.getFirstToken() instanceof At) {
const tokens = c.getAllTokens();
if (tokens[1] instanceof ParenLeftW && tokens[tokens.length - 1] instanceof WParenRightW) {
const source = c.findDirectExpression(Expressions.Source);
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const fix1 = EditHelper.insertAt(lowFile, high.getStart(), `DATA(${uniqueName}) = ${source?.concatTokens()}.\n`);
const fix2 = EditHelper.replaceRange(lowFile, c.getFirstToken().getStart(), c.getLastToken().getEnd(), "@" + uniqueName);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, low.getFirstToken(), "SQL, outline complex @", this.getMetadata().key, this.conf.severity, fix);
} else {
addFix(c.getFirstToken());
}
}
}
for (const fieldList of high.findAllExpressionsMulti([Expressions.SQLFieldList, Expressions.SQLFieldListLoop], true)) {
for (const token of fieldList.getDirectTokens()) {
if (token.getStr() === ",") {
addFix(token);
}
}
}
if (fix !== undefined) {
return Issue.atToken(lowFile, low.getFirstToken(), "SQL, remove @ and ,", this.getMetadata().key, this.conf.severity, fix);
}
for (const c of high.findAllExpressionsRecursive(Expressions.SQLIn)) {
const children = c.getChildren();
const first = children[1];
if (!(first.get() instanceof WParenLeftW)) {
continue;
}
const last = children[children.length - 1];
if (last.get() instanceof WParenRightW || last.get() instanceof WParenRight) {
const firstEnd = first.getFirstToken().getEnd();
const endDelete = new Position(firstEnd.getRow(), firstEnd.getCol() + 1);
const fix1 = EditHelper.deleteRange(lowFile, firstEnd, endDelete);
const lastStart = last.getFirstToken().getStart();
const startDelete = new Position(lastStart.getRow(), lastStart.getCol() - 1);
const fix2 = EditHelper.deleteRange(lowFile, startDelete, lastStart);
fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, low.getFirstToken(), "SQL, remove spaces", this.getMetadata().key, this.conf.severity, fix);
}
}
return undefined;
}
private downportSelectExistence(low: StatementNode, high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
} else if (!(high.get() instanceof Statements.Select)) {
return undefined;
}
const fieldList = high.findFirstExpression(Expressions.SQLFieldList);
if (fieldList?.concatTokens().toUpperCase() !== "@ABAP_TRUE") {
return undefined;
}
const fieldName = high.findFirstExpression(Expressions.SQLCond)?.findFirstExpression(Expressions.SQLFieldName)?.concatTokens();
if (fieldName === undefined) {
return undefined;
}
const into = high.findFirstExpression(Expressions.SQLIntoStructure);
if (into === undefined) {
return undefined;
}
const intoName = into.findFirstExpression(Expressions.SQLTarget)?.findFirstExpression(Expressions.Target)?.concatTokens();
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const fix1 = EditHelper.replaceRange(lowFile, fieldList.getFirstToken().getStart(), fieldList.getLastToken().getEnd(), fieldName);
const fix2 = EditHelper.replaceRange(lowFile, into?.getFirstToken().getStart(), into?.getLastToken().getEnd(), `INTO @DATA(${uniqueName})`);
let fix = EditHelper.merge(fix2, fix1);
const fix3 = EditHelper.insertAt(lowFile, high.getLastToken().getEnd(), `\nCLEAR ${intoName}.\nIF sy-subrc = 0.\n ${intoName} = abap_true.\nENDIF.`);
fix = EditHelper.merge(fix, fix3);
return Issue.atToken(lowFile, low.getFirstToken(), "SQL, refactor existence check", this.getMetadata().key, this.conf.severity, fix);
}
private downportSelectInline(low: StatementNode, high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
} else if (!(high.get() instanceof Statements.Select) && !(high.get() instanceof Statements.SelectLoop)) {
return undefined;
}
// as first step outline the @DATA, note that void types are okay, as long the field names are specified
let found = this.downportSelectSingleInline(low, high, lowFile, highSyntax);
if (found) {
return found;
}
found = this.downportSelectTableInline(low, high, lowFile, highSyntax);
if (found) {
return found;
}
return undefined;
}
private downportSelectFields(low: StatementNode, high: StatementNode, lowFile: ABAPFile, _highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
} else if (!(high.get() instanceof Statements.Select)) {
return undefined;
}
const fields = high.findFirstExpression(Expressions.SQLFields);
if (fields === undefined) {
return undefined;
}
const code = fields.getLastChild()?.concatTokens();
if (code === undefined) {
return undefined;
}
const fix1 = EditHelper.deleteRange(lowFile, fields.getFirstToken().getStart(), fields.getLastToken().getEnd());
const fix2 = EditHelper.insertAt(lowFile, high.getFirstToken().getEnd(), " " + code);
const fix = EditHelper.merge(fix1, fix2);
return Issue.atToken(lowFile, fields.getFirstToken(), "Replace FIELDS", this.getMetadata().key, this.conf.severity, fix);
}
private downportSelectSingleInline(low: StatementNode, high: StatementNode,
lowFile: ABAPFile, _highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
}
const targets = high.findFirstExpression(Expressions.SQLIntoStructure)?.findDirectExpressions(Expressions.SQLTarget) || [];
if (targets.length !== 1) {
return undefined;
}
const inlineData = targets[0].findFirstExpression(Expressions.InlineData);
if (inlineData === undefined) {
return undefined;
}
const sqlFrom = high.findAllExpressions(Expressions.SQLFromSource);
if (sqlFrom.length !== 1) {
return undefined;
}
const tableName = sqlFrom[0].findDirectExpression(Expressions.DatabaseTable)?.concatTokens();
if (tableName === undefined) {
return undefined;
}
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
let fieldList = high.findFirstExpression(Expressions.SQLFieldList);
if (fieldList === undefined) {
fieldList = high.findFirstExpression(Expressions.SQLFieldListLoop);
}
if (fieldList === undefined) {
return undefined;
}
let fieldDefinition = "";
const fields = fieldList.findAllExpressions(Expressions.SQLFieldName);
const name = inlineData.findFirstExpression(Expressions.TargetField)?.concatTokens() || "error";
if (fields.length === 1) {
fieldDefinition = `DATA ${name} TYPE ${tableName}-${fields[0].concatTokens()}.`;
} else if (fieldList.concatTokens() === "*") {
fieldDefinition = `DATA ${name} TYPE ${tableName}.`;
} else if (fieldList.concatTokens().toUpperCase() === "COUNT( * )") {
fieldDefinition = `DATA ${name} TYPE i.`;
} else if (fieldList.concatTokens().toUpperCase() === "@ABAP_TRUE"
|| fieldList.concatTokens().toUpperCase() === "@ABAP_FALSE") {
fieldDefinition = `DATA ${name} TYPE abap_bool.`;
} else if (fieldList.getChildren().length === 1 && fieldList.getChildren()[0].get() instanceof Expressions.SQLAggregation) {
const c = fieldList.getChildren()[0];
if (c instanceof ExpressionNode) {
const concat = c.findFirstExpression(Expressions.SQLArithmetics)?.concatTokens();
fieldDefinition = `DATA ${name} TYPE ${tableName}-${concat}.`;
}
} else {
for (const f of fields) {
const fieldName = f.concatTokens();
fieldDefinition += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
}
fieldDefinition = `DATA: BEGIN OF ${name},
${fieldDefinition}${indentation} END OF ${name}.`;
}
const fix1 = EditHelper.insertAt(lowFile, high.getStart(), `${fieldDefinition}
${indentation}`);
const fix2 = EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, inlineData.getFirstToken(), "Outline SELECT @DATA", this.getMetadata().key, this.conf.severity, fix);
}
private downportSelectTableInline(low: StatementNode, high: StatementNode,
lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(low.get() instanceof Unknown)) {
return undefined;
}
const targets = high.findFirstExpression(Expressions.SQLIntoTable)?.findDirectExpressions(Expressions.SQLTarget) || [];
if (targets.length !== 1) {
return undefined;
}
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
const inlineData = targets[0].findFirstExpression(Expressions.InlineData);
if (inlineData === undefined) {
return undefined;
}
const sqlFrom = high.findAllExpressions(Expressions.SQLFromSource);
if (sqlFrom.length === 0) {
return Issue.atToken(lowFile, high.getFirstToken(), "Error outlining, sqlFrom not found", this.getMetadata().key, this.conf.severity);
}
let tableName = sqlFrom[0].findDirectExpression(Expressions.DatabaseTable)?.concatTokens();
if (tableName === undefined) {
return undefined;
}
const fieldList = high.findFirstExpression(Expressions.SQLFieldList);
if (fieldList === undefined) {
return undefined;
}
let fieldDefinitions = "";
for (const f of fieldList.findAllExpressions(Expressions.SQLFieldName)) {
let fieldName = f.concatTokens();
if (fieldName.includes("~")) {
const split = fieldName.split("~");
tableName = split[0];
fieldName = split[1];
}
fieldDefinitions += indentation + " " + fieldName + " TYPE " + tableName + "-" + fieldName + ",\n";
}
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const name = inlineData.findFirstExpression(Expressions.TargetField)?.concatTokens() || "error";
let fix1 = EditHelper.insertAt(lowFile, high.getStart(), `TYPES: BEGIN OF ${uniqueName},
${fieldDefinitions}${indentation} END OF ${uniqueName}.
${indentation}DATA ${name} TYPE STANDARD TABLE OF ${uniqueName} WITH DEFAULT KEY.
${indentation}`);
if (fieldDefinitions === "") {
fix1 = EditHelper.insertAt(lowFile, high.getStart(), `DATA ${name} TYPE STANDARD TABLE OF ${tableName} WITH DEFAULT KEY.
${indentation}`);
}
const fix2 = EditHelper.replaceRange(lowFile, inlineData.getFirstToken().getStart(), inlineData.getLastToken().getEnd(), name);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, inlineData.getFirstToken(), "Outline SELECT @DATA", this.getMetadata().key, this.conf.severity, fix);
}
// the anonymous type minght be used in inferred type statements, define it so it can be referred
private anonymousTableType(high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(high.get() instanceof Statements.Data)) {
return undefined;
}
const tt = high.findFirstExpression(Expressions.TypeTable);
if (tt === undefined) {
return undefined;
}
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const code = `TYPES ${uniqueName} ${tt.concatTokens()}.\n`;
const fix1 = EditHelper.insertAt(lowFile, high.getStart(), code);
const fix2 = EditHelper.replaceRange(lowFile, tt.getFirstToken().getStart(), tt.getLastToken().getEnd(), "TYPE " + uniqueName);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, high.getFirstToken(), "Add type for table definition", this.getMetadata().key, this.conf.severity, fix);
}
private downportMessage(high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(high.get() instanceof Statements.Message)) {
return undefined;
}
const foundWith = high.findExpressionAfterToken("WITH");
if (foundWith === undefined) {
return undefined;
}
const likeSource = high.findExpressionAfterToken("LIKE");
for (const s of high.findAllExpressions(Expressions.Source)) {
if (s === likeSource) {
continue;
} else if (s.getChildren().length === 1 && s.getFirstChild()?.get() instanceof Expressions.Constant) {
continue;
} else if (s.getChildren().length === 1 && s.getFirstChild()?.get() instanceof Expressions.FieldChain) {
continue;
}
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
const firstToken = high.getFirstToken();
const code = `DATA(${uniqueName}) = ${s.concatTokens()}.\n${indentation}`;
const fix1 = EditHelper.insertAt(lowFile, firstToken.getStart(), code);
const fix2 = EditHelper.replaceRange(lowFile, s.getFirstToken().getStart(), s.getLastToken().getEnd(), uniqueName);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, high.getFirstToken(), "Refactor MESSAGE WITH source", this.getMetadata().key, this.conf.severity, fix);
}
return undefined;
}
private replaceAppendExpression(high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {
if (!(high.get() instanceof Statements.Append)) {
return undefined;
}
const children = high.getChildren();
if (children[1].get() instanceof Expressions.Source) {
const source = children[1];
const target = high.findDirectExpression(Expressions.Target);
if (target === undefined) {
return undefined;
}
const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
const firstToken = high.getFirstToken();
const fix1 = EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${target?.concatTokens()}.
${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
const fix2 = EditHelper.replaceRange(lowFile, source.getFirstToken().getStart(), source.getLastToken().getEnd(), uniqueName);
const fix = EditHelper.merge(fix2, fix1);
return Issue.atToken(lowFile, high.getFirstToken(), "Outline APPEND source expression", this.getMetadata().key, this.conf.severity, fix);
}
return undefined;
}
private downportReadTable(high: StatementNode, lowFile: ABAPFile, highSyntax: ISyntaxResult): Issue | undefined {