Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 21787x 21787x 21787x 21787x 21787x 21787x 21787x 21787x 21787x 21787x 1x 10896x 10896x 10896x 10896x 10896x 10896x 32491x 32491x 32491x 32491x 32491x 32491x 32491x 32491x 32491x 32491x 32491x 10896x 10896x 10345x 10345x 10896x 10896x 258x 258x 258x 10896x 10896x 263x 263x 263x 49x 49x 49x 49x 49x 49x 49x 2x 2x 47x 47x 263x 263x 27x 27x 27x 27x 27x 27x 1x 1x 26x 26x 263x 263x 10896x 10896x 329x 257x 257x 72x 72x 329x 3x 3x 69x 69x 69x 69x 329x 4x 4x 4x 65x 65x 65x 10896x 10896x 10896x 10896x 88x 65x 65x 23x 23x 23x 4x 4x 19x 19x 19x 19x 4x 4x 19x 23x 15x 15x 15x 10896x 10896x 321x 95x 95x 95x 42x 42x 53x 53x 53x 95x 1x 1x 52x 52x 95x 24x 20x 20x 24x 24x 20x 20x 20x 20x 20x 20x 24x 95x 321x 321x 248x 248x 321x 10896x | import {Issue} from "../issue";
import {BasicRuleConfig} from "./_basic_rule_config";
import {IRegistry} from "../_iregistry";
import {Class, Interface} from "../objects";
import {IRule, IRuleMetadata} from "./_irule";
import {IObject} from "../objects/_iobject";
import {SyntaxLogic} from "../abap/5_syntax/syntax";
import {ISpaghettiScopeNode} from "../abap/5_syntax/_spaghetti_scope";
import {ReferenceType} from "../abap/5_syntax/_reference";
import {BuiltIn} from "../abap/5_syntax/_builtin";
import {ABAPObject} from "../objects/_abap_object";
export class CyclicOOConf extends BasicRuleConfig {
/** List of object names to skip, must be full upper case name
* @uniqueItems true
*/
public skip: string[] = [];
/** Skips shared memory enabled classes */
public skipSharedMemory: boolean = true;
/** Skip testclass inclues */
public skipTestclasses: boolean = true;
}
export class CyclicOO implements IRule {
private conf = new CyclicOOConf();
private reg: IRegistry;
private edges: { [from: string]: string[] } = {};
public getMetadata(): IRuleMetadata {
return {
key: "cyclic_oo",
title: "Cyclic OO",
shortDescription: `Finds cyclic/circular OO references`,
extendedInformation: `Runs for global INTF + CLAS objects
Objects must be without syntax errors for this rule to take effect
References in testclass includes are ignored`,
};
}
public getConfig() {
return this.conf;
}
public setConfig(conf: CyclicOOConf) {
this.conf = conf;
if (this.conf.skip === undefined) {
this.conf.skip = [];
}
}
public initialize(reg: IRegistry): IRule {
this.reg = reg;
this.edges = {};
for (const obj of this.reg.getObjectsByType("CLAS")) {
if (this.reg.isDependency(obj)) {
continue;
}
const name = obj.getName().toUpperCase();
if (!(obj instanceof Class)) {
continue;
} else if (this.conf.skip.indexOf(name) >= 0) {
continue;
} else if (this.conf.skipSharedMemory === true && obj.getClassDefinition()?.isSharedMemory === true) {
continue;
}
const run = new SyntaxLogic(this.reg, obj).run();
if (run.issues.length > 0) {
continue;
}
this.buildEdges(name, run.spaghetti.getTop());
}
for (const obj of this.reg.getObjectsByType("INTF")) {
if (this.reg.isDependency(obj)) {
continue;
}
const name = obj.getName().toUpperCase();
if (!(obj instanceof ABAPObject)) {
continue;
} else if (this.conf.skip.indexOf(name) >= 0) {
continue;
}
const run = new SyntaxLogic(this.reg, obj).run();
if (run.issues.length > 0) {
continue;
}
this.buildEdges(name, run.spaghetti.getTop());
}
return this;
}
public run(obj: IObject): readonly Issue[] {
if (!(obj instanceof Interface) && !(obj instanceof Class)) {
return [];
}
const id = obj.getIdentifier();
if (id === undefined) {
return [];
}
const previous: { [key: string]: boolean } = {};
previous[obj.getName()] = true;
const path = this.findCycle(obj.getName(), obj.getName(), previous);
if (path) {
const message = "Cyclic definition/usage: " + obj.getName() + " -> " + path;
return [Issue.atIdentifier(id, message, this.getMetadata().key, this.conf.severity)];
}
return [];
}
/////////////////////////////
private findCycle(source: string, current: string, previous: { [key: string]: boolean }): string | undefined {
if (this.edges[current] === undefined) {
return undefined;
}
for (const e of this.edges[current]) {
if (e === source) {
return e;
}
if (previous[e] === undefined) { // dont revisit vertices
previous[e] = true;
const found = this.findCycle(source, e, previous);
if (found) {
return e + " -> " + found;
}
}
}
return undefined;
}
private buildEdges(from: string, node: ISpaghettiScopeNode): void {
for (const r of node.getData().references) {
if (r.resolved === undefined
|| node.getIdentifier().filename === r.resolved.getFilename()
|| r.resolved.getFilename() === BuiltIn.filename) {
continue;
}
if (this.conf.skipTestclasses === true
&& ( r.position.getFilename().includes(".testclasses.")
|| r.resolved.getFilename().includes(".testclasses.") ) ) {
continue;
}
if (r.referenceType === ReferenceType.ObjectOrientedReference
&& r.extra?.ooName) {
if (this.edges[from] === undefined) {
this.edges[from] = [];
}
const name = r.extra.ooName.toUpperCase();
if (name !== from && this.edges[from].indexOf(name) < 0) {
const obj = this.reg.getObject("INTF", name) || this.reg.getObject("CLAS", name);
if (obj && this.reg.isDependency(obj)) {
continue;
}
this.edges[from].push(name);
}
}
}
for (const c of node.getChildren()) {
this.buildEdges(from, c);
}
}
} |