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 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 29525x 29525x 29525x 29525x 29525x 29525x 29525x 29525x 1x 406x 406x 406x 406x 406x 535x 535x 78x 78x 457x 457x 406x 406x 489x 489x 489x 489x 340x 340x 286x 286x 340x 489x 406x 406x 406x 406x 406x 406x 448x 448x 406x 406x 1024x 1024x 1024x 406x 1x 14844x 14844x 14844x 14844x 14844x 14844x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 44323x 14844x 14844x 14120x 14120x 14844x 14844x 266x 266x 2x 2x 266x 14844x 14844x 430x 430x 430x 14844x 14844x 531x 80x 531x 21x 21x 430x 531x 440x 2224x 9x 9x 2224x 431x 421x 421x 421x 531x 15x 15x 406x 406x 406x 406x 406x 531x 101x 101x 305x 305x 531x 372x 300x 372x 42x 42x 42x 42x 7x 7x 42x 372x 298x 298x 298x 14844x 14844x 1432x 1432x 807x 807x 807x 489x 489x 807x 1432x 1432x 1085x 1085x 1432x 14844x 14844x 1698x 1698x 1698x 2x 2x 1696x 1698x 1292x 1292x 1696x 1698x 1309x 1309x 835x 835x 835x 835x 835x 1x 835x 834x 834x 834x 299x 299x 299x 535x 835x 835x 1309x 1698x 14844x 14844x 406x 406x 406x 406x 406x 406x 171x 171x 171x 5x 5x 166x 171x 145x 145x 166x 166x 166x 166x 166x 166x 166x 166x 652x 166x 166x 166x 166x 652x 166x 166x 171x 166x 7x 166x 1x 1x 166x 158x 158x 158x 158x 158x 158x 158x 406x 406x 406x 14844x 14844x 159x 159x 4x 4x 155x 155x 155x 159x 159x 14844x 14844x 145x 145x 145x 145x 145x 145x 14844x 14844x 158x 58x 58x 100x 100x 158x 3x 3x 97x 97x 14844x | 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, IdentifierMeta} from "../abap/types/_typed_identifier";
import {Interface, Program} from "../objects";
import {ISpaghettiScopeNode} from "../abap/5_syntax/_spaghetti_scope";
import {Identifier} from "../abap/4_file_information/_identifier";
import {EditHelper, IEdit} from "../edit_helper";
import {StatementNode} from "../abap/nodes/statement_node";
import * as Statements from "../abap/2_statements/statements";
import {Comment, Unknown} from "../abap/2_statements/statements/_statement";
import {ReferenceType} from "../abap/5_syntax/_reference";
import {ABAPFile} from "../abap/abap_file";
export class UnusedVariablesConf extends BasicRuleConfig {
/** skip specific names, case insensitive
* @uniqueItems true
*/
public skipNames?: string[] = [];
/** skip parameters from abstract methods */
public skipAbstract: boolean = false;
}
class WorkArea {
// keyed by filename + start position, this equals Identifier.equals()
private readonly workarea = new Map<string, {id: TypedIdentifier, count: number}>();
public push(id: TypedIdentifier, count = 1) {
const key = this.buildKey(id);
if (this.workarea.has(key)) {
return;
}
this.workarea.set(key, {id, count});
}
public removeIfExists(id: Identifier | undefined): void {
if (id === undefined) {
return;
}
const key = this.buildKey(id);
const found = this.workarea.get(key);
if (found !== undefined) {
found.count--;
if (found.count === 0) {
this.workarea.delete(key);
}
}
}
public get() {
return [...this.workarea.values()];
}
public count(): number {
return this.workarea.size;
}
private buildKey(id: Identifier): string {
const start = id.getStart();
return id.getFilename() + "," + start.getRow() + "," + start.getCol();
}
}
export class UnusedVariables implements IRule {
private conf = new UnusedVariablesConf();
private reg: IRegistry;
private workarea: WorkArea;
public getMetadata(): IRuleMetadata {
return {
key: "unused_variables",
title: "Unused variables",
shortDescription: `Checks for unused variables and constants`,
extendedInformation: `Skips event parameters.
Note that this currently does not work if the source code uses macros.
Unused variables are not reported if the object contains parser or syntax errors.
Errors found in INCLUDES are reported for the main program.`,
tags: [RuleTag.Quickfix],
pragma: "##NEEDED",
pseudoComment: "EC NEEDED",
badExample: `DATA: BEGIN OF blah1,
test TYPE string,
test2 TYPE string,
END OF blah1.`,
goodExample: `DATA: BEGIN OF blah2 ##NEEDED,
test TYPE string,
test2 TYPE string,
END OF blah2.`,
};
}
public getConfig() {
return this.conf;
}
public setConfig(conf: UnusedVariablesConf) {
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 [];
} else if (obj instanceof Interface) { // todo, how to handle interfaces?
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 []; // contains syntax errors
}
this.workarea = new WorkArea();
const top = syntax.spaghetti.getTop();
this.buildWorkarea(top, obj);
if (this.workarea.count() === 0) {
return this.buildIssues(obj); // exit early if all variables are used
}
this.findUses(top, obj);
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.findUses(syntax.spaghetti.getTop(), o);
if (this.workarea.count() === 0) {
return this.buildIssues(obj); // exit early if all variables are used
}
}
}
return this.buildIssues(obj);
}
private findUses(node: ISpaghettiScopeNode, obj: ABAPObject): void {
for (const r of node.getData().references) {
if (r.referenceType === ReferenceType.DataReadReference
|| r.referenceType === ReferenceType.DataWriteReference
|| r.referenceType === ReferenceType.TypeReference) {
this.workarea.removeIfExists(r.resolved);
}
}
for (const c of node.getChildren()) {
this.findUses(c, obj);
}
}
private buildWorkarea(node: ISpaghettiScopeNode, obj: ABAPObject): void {
const stype = node.getIdentifier().stype;
if (stype === ScopeType.OpenSQL) {
return;
}
for (const c of node.getChildren()) {
this.buildWorkarea(c, obj);
}
if (stype !== ScopeType.BuiltIn) {
const vars = node.getData().vars;
for (const name in vars) {
const meta = vars[name].getMeta();
if (this.conf.skipNames
&& this.conf.skipNames.length > 0
&& this.conf.skipNames.some((a) => a.toUpperCase() === name)) {
continue;
} else if (this.conf.skipAbstract === true && meta.includes(IdentifierMeta.Abstract)) {
continue;
} else if (name === "ME"
|| name === "SUPER"
|| meta.includes(IdentifierMeta.SelectionScreenTab)
|| meta.includes(IdentifierMeta.EventParameter)) {
// todo, workaround for "me" and "super", these should somehow be typed to built-in
continue;
}
const isInline = meta.includes(IdentifierMeta.InlineDefinition);
this.workarea.push(vars[name], isInline ? 2 : 1);
}
}
}
private buildIssues(obj: ABAPObject): Issue[] {
const ret: Issue[] = [];
const metadata = this.getMetadata();
const pragma = metadata.pragma + "";
const files = new Map<string, ABAPFile | undefined>();
for (const w of this.workarea.get()) {
const filename = w.id.getFilename();
if (this.reg.isFileDependency(filename) === true) {
continue;
} else if (obj instanceof Program === false && obj.containsFile(filename) === false) {
continue;
}
if (files.has(filename) === false) {
files.set(filename, this.findFile(filename));
}
const file = files.get(filename);
let statement: StatementNode | undefined = undefined;
let statementIndex = -1;
if (file !== undefined) {
const statements = file.getStatements();
const token = w.id.getToken();
for (let i = 0; i < statements.length; i++) {
if (statements[i].includesToken(token)) {
statement = statements[i];
statementIndex = i;
break;
}
}
}
if (statement !== undefined && file !== undefined) {
if (statement.getPragmas().some(t => t.getStr() === pragma)) {
continue;
} else if (this.suppressedbyPseudo(file, statementIndex, w.id, obj)) {
continue;
}
}
const name = w.id.getName();
const message = "Variable \"" + name.toLowerCase() + "\" not used";
const fix = this.buildFix(w.id, obj, statement);
ret.push(Issue.atIdentifier(w.id, message, metadata.key, this.conf.severity, fix));
}
return ret;
}
private suppressedbyPseudo(file: ABAPFile, statementIndex: number, v: TypedIdentifier, obj: ABAPObject): boolean {
// pseudo comments are only found in files belonging to the object itself, not in eg. includes
if (obj.getABAPFileByName(v.getFilename()) === undefined) {
return false;
}
const statements = file.getStatements();
const next = statements[statementIndex + 1];
return next?.get() instanceof Comment
&& next.concatTokens().includes(this.getMetadata().pseudoComment + "");
return false;
}
private findFile(filename: string): ABAPFile | undefined {
const file = this.reg.getFileByName(filename);
if (file === undefined) {
return undefined;
}
const object = this.reg.findObjectForFile(file);
if (!(object instanceof ABAPObject)) {
return undefined;
}
return object.getABAPFileByName(filename);
}
private buildFix(v: TypedIdentifier, obj: ABAPObject, statement: StatementNode | undefined): IEdit | undefined {
if (statement === undefined || !(statement.get() instanceof Statements.Data)) {
return undefined;
}
const file = obj.getABAPFileByName(v.getFilename());
if (file === undefined) {
return undefined;
}
return EditHelper.deleteStatement(file, statement);
}
} |