Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2021 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser;
import com.github.javaparser.ast.Node;
import java.util.Objects;
import static com.github.javaparser.utils.Utils.assertNotNull;
/**
* A position in a source file. Lines and columns start counting at 1.
*/
public class Position implements Comparable {
public final int line;
public final int column;
/**
* The first line -- note that it is 1-indexed (i.e. the first line is line 1, as opposed to 0)
*/
public static final int FIRST_LINE = 1;
/**
* The first column -- note that it is 1-indexed (i.e. the first column is column 1, as opposed to 0)
*/
public static final int FIRST_COLUMN = 1;
/**
* The first position in the file.
*/
public static final Position HOME = new Position(FIRST_LINE, FIRST_COLUMN);
/**
* Line numbers must be positive, thus
*/
public static final int ABSOLUTE_BEGIN_LINE = -1;
public static final int ABSOLUTE_END_LINE = -2;
/**
* TODO: Do we refer to the characters as columns,
* ...or the spaces between (thus also before/after) characters as columns?
*/
public Position(int line, int column) {
if (line < Position.ABSOLUTE_END_LINE) {
// TODO/FIXME: This doesn't read correctly due to use of the variable.
throw new IllegalArgumentException("Can't position at line " + line);
}
if (column < -1) {
// TODO: This allows/permits column 0, which seemingly contradicts first column being 1
// ... (see also nextLine() which indicates 1 being the first column of the next line)
// ... (see also valid() which requires a column > 0)
// TODO: Maybe we need an "ABSOLUTE_BEGIN_LINE" and "ABSOLUTE_END_LINE"?
throw new IllegalArgumentException("Can't position at column " + column);
}
this.line = line;
this.column = column;
}
/**
* Convenient factory method.
*
* @deprecated Use the constructor (e.g. {@code new Position(line, column)})
*/
@Deprecated
public static Position pos(int line, int column) {
return new Position(line, column);
}
/**
* @return Jump to the given column number, while retaining the current line number.
*/
public Position withColumn(int column) {
return new Position(this.line, column);
}
/**
* @return Jump to the given line number, while retaining the current column number.
*/
public Position withLine(int line) {
return new Position(line, this.column);
}
/**
* @return a position that is "characters" characters more to the right than this position.
*/
public Position right(int characters) {
return new Position(line, this.column + characters);
}
/**
* @return a position that is on the start of the next line from this position.
*/
public Position nextLine() {
return new Position(line + 1, FIRST_COLUMN);
}
/**
* Check if the position is usable.
* Does not know what it is pointing at, so it can't check if the position is after the end of the source.
*/
public boolean valid() {
// TODO / FIXME: Perhaps allow use of the "special" positions e.g. ABSOLUTE_BEGIN_LINE and ABSOLUTE_END_LINE...?
return line >= FIRST_LINE && column >= FIRST_COLUMN;
}
/**
* @see #valid()
* @return The inverse of {@link #valid()}
*/
public boolean invalid() {
return !valid();
}
/**
* @return If this position is valid, this.
* Otherwise, if the alternativePosition is valid, return that.
* Otherwise otherwise, just return this.
* TODO: Simplify/clarify.
*/
public Position orIfInvalid(Position alternativePosition) {
assertNotNull(alternativePosition);
// TODO: Why the || ?
// ... It seems that if both this and the alternative are invalid, then we return this..?
if (valid() || alternativePosition.invalid()) {
return this;
}
return alternativePosition;
}
public boolean isAfter(Position otherPosition) {
assertNotNull(otherPosition);
if (otherPosition.line == Position.ABSOLUTE_BEGIN_LINE) {
// FIXME: What if both positions are on the same line but different columns..?
return true;
}
if (line > otherPosition.line) {
return true;
} else if (line == otherPosition.line) {
return column > otherPosition.column;
}
return false;
}
public boolean isAfterOrEqual(Position otherPosition) {
assertNotNull(otherPosition);
return isAfter(otherPosition) || equals(otherPosition);
}
public boolean isBefore(Position otherPosition) {
assertNotNull(otherPosition);
if (otherPosition.line == Position.ABSOLUTE_END_LINE) {
// FIXME: What if both positions are on the same line but different columns..?
return true;
}
if (line < otherPosition.line) {
return true;
} else if (line == otherPosition.line) {
return column < otherPosition.column;
}
return false;
}
public boolean isBeforeOrEqual(Position otherPosition) {
assertNotNull(otherPosition);
return isBefore(otherPosition) || equals(otherPosition);
}
@Override
public int compareTo(Position otherPosition) {
assertNotNull(otherPosition);
if (isBefore(otherPosition)) {
return -1;
}
if (isAfter(otherPosition)) {
return 1;
}
return 0;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Position otherPosition = (Position) o;
return Objects.equals(line, otherPosition.line)
&& Objects.equals(column, otherPosition.column);
}
@Override
public int hashCode() {
return Objects.hash(line, column);
}
@Override
public String toString() {
return "(line " + line + ",col " + column + ")";
}
}
