net.sourceforge.pmd.cpd.TokenEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-core Show documentation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available. Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

There is a newer version: 7.5.0-metrics

Show newest version

/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.cpd;

import net.sourceforge.pmd.lang.document.FileId;

public class TokenEntry implements Comparable {

    private static final int EOF = 0;

    private final FileId fileId;
    private final int beginLine;
    private final int beginColumn;
    private final int endColumn;
    private final int endLine;
    private int index;
    private int identifier;
    private int hashCode;

    /** constructor for EOF entries. */
    TokenEntry(FileId fileId, int line, int column) {
        assert isOk(line) && isOk(column) : "Coordinates are 1-based";
        this.identifier = EOF;
        this.fileId = fileId;
        this.beginLine = line;
        this.beginColumn = column;
        this.endLine = line;
        this.endColumn = column;
    }

    TokenEntry(int imageId, FileId fileId, int beginLine, int beginColumn, int endLine, int endColumn, int index) {
        assert isOk(beginLine) && isOk(beginColumn) && isOk(endLine) && isOk(endColumn) : "Coordinates are 1-based";
        assert imageId != EOF;
        this.fileId = fileId;
        this.beginLine = beginLine;
        this.beginColumn = beginColumn;
        this.endLine = endLine;
        this.endColumn = endColumn;
        this.identifier = imageId;
        this.index = index;
    }

    public boolean isEof() {
        return this.identifier == EOF;
    }

    private boolean isOk(int coord) {
        return coord >= 1;
    }


    FileId getFileId() {
        return fileId;
    }


    /** The line number where this token starts. */
    public int getBeginLine() {
        return beginLine;
    }

    /** The line number where this token ends. */
    public int getEndLine() {
        return endLine;
    }

    /** The column number where this token starts, inclusive. */
    public int getBeginColumn() {
        return beginColumn;
    }

    /** The column number where this token ends, exclusive. */
    public int getEndColumn() {
        return endColumn;
    }

    int getIdentifier() {
        return this.identifier;
    }

    int getIndex() {
        return this.index;
    }

    @Override
    public int hashCode() {
        return hashCode;
    }

    void setHashCode(int hashCode) {
        this.hashCode = hashCode;
    }

    @SuppressWarnings("PMD.CompareObjectsWithEquals")
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        } else if (!(o instanceof TokenEntry)) {
            return false;
        }
        TokenEntry other = (TokenEntry) o;
        if (other.isEof() != this.isEof()) {
            return false;
        } else if (this.isEof()) {
            return other.getFileId().equals(this.getFileId());
        }
        return other.hashCode == hashCode;
    }

    @Override
    public int compareTo(TokenEntry other) {
        return getIndex() - other.getIndex();
    }

    final void setImageIdentifier(int identifier) {
        this.identifier = identifier;
    }

    public String getImage(Tokens tokens) {
        if (this.isEof()) {
            return "EOF";
        }
        String image = tokens.imageFromId(this.identifier);
        return image == null ? "--unknown--" : image;
    }

    @Override
    public String toString() {
        if (this.isEof()) {
            return "EOF";
        }
        return Integer.toString(identifier);
    }

}