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 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 288x 288x 288x 288x 168x 83x 40x 40x 83x 128x 128x 288x 288x 245x 145x 99x 99x 99x 145x 146x 288x 288x 28x 28x 288x 288x 308x 308x 288x 1x 29386x 29386x 29386x 29386x 29386x 29386x 1x 14705x 14705x 14705x 14705x 14705x 14705x 43936x 43936x 43936x 43936x 43936x 43936x 43936x 43936x 43936x 43936x 14705x 14705x 14120x 14120x 14705x 14705x 264x 264x 264x 14705x 14705x 288x 288x 288x 14705x 14705x 385x 80x 80x 305x 385x 314x 1775x 8x 8x 1775x 306x 297x 297x 297x 385x 9x 9x 288x 288x 288x 288x 385x 250x 250x 38x 385x 53x 33x 53x 19x 19x 19x 19x 53x 10x 10x 53x 28x 28x 28x 385x 29x 29x 29x 29x 29x 29x 29x 1x 29x 1x 1x 27x 27x 27x 27x 28x 28x 14705x 14705x 28x 28x 28x 28x 28x 28x 180x 1x 1x 180x 28x 28x 180x 27x 27x 27x 14705x 14705x 14705x 14705x 2634x 2634x 2075x 2075x 2634x 2634x 2039x 2039x 2634x 2634x 14705x 14705x 2075x 2075x 2075x 1009x 1009x 191x 191x 191x 191x 191x 191x 23x 23x 168x 168x 1009x 2075x 2075x 936x 245x 245x 936x 2075x 2075x 2075x 14705x 14705x 27x 6x 6x 21x 21x 14705x | import {Issue} from "../issue";
import {BasicRuleConfig} from "./_basic_rule_config";
import {IRegistry} from "../_iregistry";
import {IRule, IRuleMetadata, RuleTag} from "./_irule";
import {IObject} from "../objects/_iobject";
import {SyntaxLogic} from "../abap/5_syntax/syntax";
import {ABAPObject} from "../objects/_abap_object";
import {ScopeType} from "../abap/5_syntax/_scope_type";
import {TypedIdentifier} from "../abap/types/_typed_identifier";
import {ISpaghettiScopeNode} from "../abap/5_syntax/_spaghetti_scope";
import {EditHelper, IEdit} from "../edit_helper";
import {ReferenceType} from "../abap/5_syntax/_reference";
import {Identifier} from "../abap/4_file_information/_identifier";
import {ABAPFile} from "../abap/abap_file";
import {StatementNode} from "../abap/nodes";
import {Comment, Unknown} from "../abap/2_statements/statements/_statement";
class WorkArea {
private readonly workarea: TypedIdentifier[] = [];
public push(id: TypedIdentifier) {
for (const w of this.workarea) {
if (id.equals(w)) {
return;
}
}
this.workarea.push(id);
}
public removeIfExists(id: Identifier) {
for (let i = 0; i < this.workarea.length; i++) {
if (id.equals(this.workarea[i])) {
this.workarea.splice(i, 1);
return;
}
}
}
public get(): readonly TypedIdentifier[] {
return this.workarea;
}
public count(): number {
return this.workarea.length;
}
}
export class UnusedTypesConf extends BasicRuleConfig {
/** skip specific names, case insensitive
* @uniqueItems true
*/
public skipNames?: string[] = [];
}
export class UnusedTypes implements IRule {
private conf = new UnusedTypesConf();
private reg: IRegistry;
private workarea: WorkArea;
public getMetadata(): IRuleMetadata {
return {
key: "unused_types",
title: "Unused types",
shortDescription: `Checks for unused TYPE definitions`,
extendedInformation: `Unused types are not reported if the object contains parser or syntax errors.`,
tags: [RuleTag.Quickfix],
pragma: "##NEEDED",
pseudoComment: "EC NEEDED",
};
}
public getConfig() {
return this.conf;
}
public setConfig(conf: UnusedTypesConf) {
this.conf = conf;
if (this.conf.skipNames === undefined) {
this.conf.skipNames = [];
}
}
public initialize(reg: IRegistry) {
this.reg = reg;
return this;
}
public run(obj: IObject): Issue[] {
if (!(obj instanceof ABAPObject)) {
return [];
}
for (const file of obj.getABAPFiles()) {
for (const statement of file.getStatements()) {
if (statement.get() instanceof Unknown) {
return []; // contains parser errors
}
}
}
// dont report unused variables when there are syntax errors
const syntax = new SyntaxLogic(this.reg, obj).run();
if (syntax.issues.length > 0) {
return [];
}
this.workarea = new WorkArea();
this.traverse(syntax.spaghetti.getTop(), obj, true);
this.traverse(syntax.spaghetti.getTop(), obj, false);
if (this.workarea.count() === 0) {
return []; // exit early if all types are used in the current object
}
for (const o of this.reg.getObjects()) {
if (o === obj) {
continue;
} else if (o instanceof ABAPObject) {
if (this.reg.isDependency(o)) {
continue; // do not search in dependencies
}
const syntax = new SyntaxLogic(this.reg, o).run();
this.traverse(syntax.spaghetti.getTop(), o, false);
}
if (this.workarea.count() === 0) {
return []; // exit early if all types are used
}
}
// what is left is unused
const ret: Issue[] = [];
for (const t of this.workarea.get()) {
const message = "Type \"" + t.getName() + "\" not used";
const file = obj.getABAPFileByName(t.getFilename());
if (file === undefined) {
continue;
}
const statement = EditHelper.findStatement(t.getToken(), file);
if (statement === undefined) {
continue;
}
if (statement.getPragmas().some(t => t.getStr() === this.getMetadata().pragma)) {
continue;
} else if (this.suppressedbyPseudo(statement, file)) {
continue;
}
const fix = this.buildFix(file, statement);
ret.push(Issue.atIdentifier(t, message, this.getMetadata().key, this.conf.severity, fix));
}
return ret;
}
private suppressedbyPseudo(statement: StatementNode | undefined, file: ABAPFile): boolean {
if (statement === undefined) {
return false;
}
if (file === undefined) {
return false;
}
let next = false;
for (const s of file.getStatements()) {
if (next === true && s.get() instanceof Comment) {
return s.concatTokens().includes(this.getMetadata().pseudoComment + "");
}
if (s === statement) {
next = true;
}
}
return false;
}
////////////////////////////
private traverse(node: ISpaghettiScopeNode, obj: ABAPObject, add: boolean) {
if (node.getIdentifier().stype !== ScopeType.BuiltIn) {
this.checkNode(node, obj, add);
}
for (const c of node.getChildren()) {
this.traverse(c, obj, add);
}
}
private checkNode(node: ISpaghettiScopeNode, obj: ABAPObject, add: boolean) {
const ret: Issue[] = [];
if (add === true) {
const types = node.getData().types;
for (const name in types) {
const identifier = types[name];
if (obj.containsFile(identifier.getFilename()) === false) {
continue;
} else if (this.conf.skipNames
&& this.conf.skipNames.length > 0
&& this.conf.skipNames.some((a) => a.toUpperCase() === name)) {
continue;
} else if (name !== identifier.getName().toUpperCase()) {
continue; // may have aliases via interfaces
}
this.workarea.push(identifier);
}
}
for (const r of node.getData().references) {
if (r.referenceType === ReferenceType.TypeReference && r.resolved) {
this.workarea.removeIfExists(r.resolved);
}
}
return ret;
}
private buildFix(file: ABAPFile, statement: StatementNode): IEdit | undefined {
if (statement.concatTokens().toUpperCase().includes("BEGIN OF")) {
return undefined;
}
return EditHelper.deleteStatement(file, statement);
}
} |