All files / src/rules unused_variables.ts

92.96% Statements 251/270
85.55% Branches 77/90
100% Functions 18/18
92.96% Lines 251/270

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 2701x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 18830x 18830x 18830x 18830x 18830x 18830x 1x 291x 291x 291x 291x 347x 186x 33x 33x 186x 314x 314x 291x 291x 315x     315x 384x 216x 216x 179x 179x 216x 216x 384x 99x 291x 291x 291x 291x 291x 291x 323x 323x 291x 1x 9470x 9470x 9470x 9470x 9470x 9470x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 28190x 9470x 9470x 8898x 8898x 9470x 9470x 216x 216x     216x 9470x 9470x 329x 329x 329x 9470x 9470x 392x 51x 392x 20x 20x 321x 321x 321x 392x 30x 30x 291x 291x 291x 291x 291x 392x 82x 82x 209x 209x 392x 262x 208x 262x 32x     32x 32x 32x 2x 2x 32x 262x 207x 207x 207x 9470x 9470x 972x 972x 518x 518x 518x 315x 315x 518x 972x 972x 731x 731x 972x 9470x 9470x 1212x 1212x 1212x     1212x 1212x 921x 921x 1212x 1212x 922x 922x 595x 595x 595x 595x   595x 595x 595x 595x 248x 248x 248x 347x 595x 595x 922x 1212x 9470x 9470x 291x 291x 291x 135x 135x   135x 5x 5x 130x 130x 135x 3x 135x 1x 1x 126x 126x 126x 126x 126x 126x 126x 291x 291x 291x 9470x 9470x 127x     127x 127x 127x 2x 2x 125x 125x 127x 752x 12x 12x 752x 125x 125x 752x 113x 113x 113x 9470x 9470x 130x 130x     130x 130x     130x 130x     130x 130x 130x 130x 9470x 9470x 126x 126x 2x 2x 124x 124x 126x   126x 82x 82x 42x 42x 9470x
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} from "../abap/2_statements/statements/_statement";
import {ReferenceType} from "../abap/5_syntax/_reference";
 
 
export class UnusedVariablesConf extends BasicRuleConfig {
  /** skip specific names, case insensitive
   * @uniqueItems true
  */
  public skipNames?: string[] = [];
}
 
class WorkArea {
  private readonly workarea: {id: TypedIdentifier, count: number}[] = [];
 
  public push(id: TypedIdentifier, count = 1) {
    for (const w of this.workarea) {
      if (id.equals(w.id)) {
        return;
      }
    }
    this.workarea.push({id, count});
  }
 
  public removeIfExists(id: Identifier | undefined): void {
    if (id === undefined) {
      return;
    }
    for (let i = 0; i < this.workarea.length; i++) {
      if (id.equals(this.workarea[i].id)) {
        this.workarea[i].count--;
        if (this.workarea[i].count === 0) {
          this.workarea.splice(i, 1);
        }
        return;
      }
    }
  }
 
  public get() {
    return this.workarea;
  }
 
  public count(): number {
    return this.workarea.length;
  }
}
 
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 syntax errors. Errors found in INCLUDES are reported for the main program.`,
      tags: [RuleTag.Quickfix],
      pragma: "##NEEDED",
      pseudoComment: "EC NEEDED",
    };
  }
 
  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 [];
    }
 
    // 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();
    const top = syntax.spaghetti.getTop();
    this.buildWorkarea(top, obj);
 
    if (this.workarea.count() === 0) {
      return this.buildIssues(obj); // exit early if all types 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 types 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 (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[] = [];
 
    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;
      }
 
      const statement = this.findStatement(w.id);
      if (statement?.getPragmas().map(t => t.getStr()).includes(this.getMetadata().pragma + "")) {
        continue;
      } else if (this.suppressedbyPseudo(statement, w.id, obj)) {
        continue;
      }
 
      const name = w.id.getName();
      const message = "Variable \"" + name.toLowerCase() + "\" not used";
 
      const fix = this.buildFix(w.id, obj);
      ret.push(Issue.atIdentifier(w.id, message, this.getMetadata().key, this.conf.severity, fix));
    }
 
    return ret;
  }
 
  private suppressedbyPseudo(statement: StatementNode | undefined, v: TypedIdentifier, obj: ABAPObject): boolean {
    if (statement === undefined) {
      return false;
    }
 
    const file = obj.getABAPFileByName(v.getFilename());
    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 findStatement(v: TypedIdentifier): StatementNode | undefined {
    const file = this.reg.getFileByName(v.getFilename());
    if (file === undefined) {
      return undefined;
    }
    const object = this.reg.findObjectForFile(file);
    if (!(object instanceof ABAPObject)) {
      return undefined;
    }
    const abapfile = object.getABAPFileByName(v.getFilename());
    if (abapfile === undefined) {
      return undefined;
    }
 
    const statement = EditHelper.findStatement(v.getToken(), abapfile);
    return statement;
  }
 
  private buildFix(v: TypedIdentifier, obj: ABAPObject): IEdit | undefined {
    const file = obj.getABAPFileByName(v.getFilename());
    if (file === undefined) {
      return undefined;
    }
 
    const statement = EditHelper.findStatement(v.getToken(), file);
    if (statement === undefined) {
      return undefined;
    } else if (statement.get() instanceof Statements.Data) {
      return EditHelper.deleteStatement(file, statement);
    }
    return undefined;
  }
}