/** Provides classes for working with locations. */

overlay[local]

module;

import files.FileSystem

/**

* A location as given by a file, a start line, a start column,

* an end line, and an end column.

*

* For more information about locations see [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).

*/

class Location extends @location_default {

/** Gets the file for this location. */

File getFile() { locations_default(this, result, _, _, _, _) }

/** Gets the 1-based line number (inclusive) where this location starts. */

int getStartLine() { locations_default(this, _, result, _, _, _) }

/** Gets the 1-based column number (inclusive) where this location starts. */

int getStartColumn() { locations_default(this, _, _, result, _, _) }

/** Gets the 1-based line number (inclusive) where this location ends. */

int getEndLine() { locations_default(this, _, _, _, result, _) }

/** Gets the 1-based column number (inclusive) where this location ends. */

int getEndColumn() { locations_default(this, _, _, _, _, result) }

/** Gets the number of lines covered by this location. */

int getNumLines() { result = this.getEndLine() - this.getStartLine() + 1 }

/** Gets a textual representation of this element. */

cached

string toString() {

exists(string filepath, int startline, int startcolumn, int endline, int endcolumn |

this.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn) and

result = filepath + "@" + startline + ":" + startcolumn + ":" + endline + ":" + endcolumn

)

}

/**

* Holds if this element is at the specified location.

* The location spans column `startcolumn` of line `startline` to

* column `endcolumn` of line `endline` in file `filepath`.

* For more information, see

* [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).

*/

predicate hasLocationInfo(

string filepath, int startline, int startcolumn, int endline, int endcolumn

) {

exists(File f |

locations_default(this, f, startline, startcolumn, endline, endcolumn) and

filepath = f.getAbsolutePath()

)

}

}