All files / src/rules unused_variables.ts

92.59% Statements 200/216
81.82% Branches 54/66
100% Functions 13/13
92.59% Lines 200/216

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 2161x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 15392x 15392x 15392x 15392x 15392x 15392x 1x 7740x 7740x 7740x 7740x 7740x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 23018x 7740x 7740x 7346x 7346x 7740x 7740x 139x 139x     139x 7740x 7740x 230x 230x 230x 7740x 7740x 260x 20x 260x 11x 11x 229x 229x 229x 260x 14x 14x 215x 215x 215x 215x 215x 260x 100x 100x 33x 23x 23x 23x 33x 100x 23x 23x 77x 77x 215x 215x 215x 7740x 7740x 855x 855x 855x     855x 855x 641x 641x 855x 855x 640x 640x 855x 855x 855x 7740x 7740x 641x 641x 641x 641x 372x 372x     372x 372x 372x 100x 100x 372x 272x 272x 272x 104x 104x 104x 104x 3x 104x 1x 1x 100x 100x 100x 100x 372x 641x 641x 641x 7740x 7740x 101x     101x 101x 101x 2x 2x 99x 99x 101x 617x 1x 1x 617x 99x 99x 617x 98x 98x 98x 7740x 7740x 264x 264x 264x 24x 264x 240x 240x 264x 7740x 7740x 104x 104x     104x 104x     104x 104x     104x 104x 104x 104x 7740x 7740x 100x 100x 2x 2x 98x 98x 100x   100x   98x 98x 98x 100x 7740x
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} from "../objects";
import {ISpaghettiScopeNode} from "../abap/5_syntax/_spaghetti_scope";
import {References} from "../lsp/references";
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";
 
export class UnusedVariablesConf extends BasicRuleConfig {
  /** skip specific names, case insensitive
   * @uniqueItems true
  */
  public skipNames: string[] = [];
}
 
export class UnusedVariables implements IRule {
  private conf = new UnusedVariablesConf();
  private reg: IRegistry;
 
  public getMetadata(): IRuleMetadata {
    return {
      key: "unused_variables",
      title: "Unused variables",
      shortDescription: `Checks for unused variables and constants`,
      extendedInformation: `WARNING: slow
 
      Experimental, might give false positives. 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.`,
      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 [];
    }
 
    const results = this.traverse(syntax.spaghetti.getTop(), obj);
 
    // remove duplicates, quick and dirty
    const deduplicated: Issue[] = [];
    for (const result of results) {
      let cont = false;
      for (const d of deduplicated) {
        if (result.getStart().equals(d.getStart())) {
          cont = true;
          break;
        }
      }
      if (cont === true) {
        continue;
      }
      deduplicated.push(result);
    }
 
    return deduplicated;
  }
 
  private traverse(node: ISpaghettiScopeNode, obj: ABAPObject): Issue[] {
    const ret: Issue[] = [];
 
    if (node.getIdentifier().stype === ScopeType.OpenSQL) {
      return [];
    }
 
    if (node.getIdentifier().stype !== ScopeType.BuiltIn) {
      ret.push(...this.checkNode(node, obj));
    }
 
    for (const c of node.getChildren()) {
      ret.push(...this.traverse(c, obj));
    }
 
    return ret;
  }
 
  private checkNode(node: ISpaghettiScopeNode, obj: ABAPObject): Issue[] {
    const ret: Issue[] = [];
 
    const vars = node.getData().vars;
    for (const name in vars) {
      if (this.conf.skipNames?.length > 0
          && this.conf.skipNames.some((a) => a.toUpperCase() === name)) {
        continue;
      }
      if (name === "ME"
          || name === "SUPER"
          || vars[name].getMeta().includes(IdentifierMeta.EventParameter)) {
        // todo, workaround for "me" and "super", these should somehow be typed to built-in
        continue;
      } else if ((obj.containsFile(vars[name].getFilename())
            || node.getIdentifier().stype === ScopeType.Program
            || node.getIdentifier().stype === ScopeType.Form)
          && this.isUsed(vars[name], node) === false) {
        const message = "Variable \"" + name.toLowerCase() + "\" not used";
 
        const statement = this.findStatement(vars[name]);
        if (statement?.getPragmas().map(t => t.getStr()).includes(this.getMetadata().pragma + "")) {
          continue;
        } else if (this.suppressedbyPseudo(statement, vars[name], obj)) {
          continue;
        }
 
        const fix = this.buildFix(vars[name], obj);
        ret.push(Issue.atIdentifier(vars[name], 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 isUsed(id: TypedIdentifier, node: ISpaghettiScopeNode): boolean {
    const isInline = id.getMeta().includes(IdentifierMeta.InlineDefinition);
    const found = new References(this.reg).search(id, node, true, isInline === false);
    if (isInline === true) {
      return found.length > 2; // inline definitions are always written to
    } else {
      return found.length > 1;
    }
  }
 
  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.FunctionModule) {
      return undefined; // function module parameters are not part of the code
    } else {
      return EditHelper.deleteStatement(file, statement);
    }
  }
}