11/** Provides classes for working with locations and program elements that have locations. */
22
33import javascript
4+ private import internal.Locations
45
56/**
67 * A location as given by a file, a start line, a start column,
78 * an end line, and an end column.
89 *
10+ * This class is restricted to locations created by the extractor.
11+ *
912 * For more information about locations see [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
1013 */
11- class Location extends @location {
14+ class DbLocation extends TDbLocation {
1215 /** Gets the file for this location. */
13- File getFile ( ) { locations_default ( this , result , _, _, _, _) }
16+ File getFile ( ) { dbLocationInfo ( this , result , _, _, _, _) }
1417
1518 /** Gets the 1-based line number (inclusive) where this location starts. */
16- int getStartLine ( ) { locations_default ( this , _, result , _, _, _) }
19+ int getStartLine ( ) { dbLocationInfo ( this , _, result , _, _, _) }
1720
1821 /** Gets the 1-based column number (inclusive) where this location starts. */
19- int getStartColumn ( ) { locations_default ( this , _, _, result , _, _) }
22+ int getStartColumn ( ) { dbLocationInfo ( this , _, _, result , _, _) }
2023
2124 /** Gets the 1-based line number (inclusive) where this location ends. */
22- int getEndLine ( ) { locations_default ( this , _, _, _, result , _) }
25+ int getEndLine ( ) { dbLocationInfo ( this , _, _, _, result , _) }
2326
2427 /** Gets the 1-based column number (inclusive) where this location ends. */
25- int getEndColumn ( ) { locations_default ( this , _, _, _, _, result ) }
28+ int getEndColumn ( ) { dbLocationInfo ( this , _, _, _, _, result ) }
2629
2730 /** Gets the number of lines covered by this location. */
2831 int getNumLines ( ) { result = this .getEndLine ( ) - this .getStartLine ( ) + 1 }
2932
3033 /** Holds if this location starts before location `that`. */
3134 pragma [ inline]
32- predicate startsBefore ( Location that ) {
35+ predicate startsBefore ( DbLocation that ) {
3336 exists ( File f , int sl1 , int sc1 , int sl2 , int sc2 |
34- locations_default ( this , f , sl1 , sc1 , _, _) and
35- locations_default ( that , f , sl2 , sc2 , _, _)
37+ dbLocationInfo ( this , f , sl1 , sc1 , _, _) and
38+ dbLocationInfo ( that , f , sl2 , sc2 , _, _)
3639 |
3740 sl1 < sl2
3841 or
@@ -42,10 +45,10 @@ class Location extends @location {
4245
4346 /** Holds if this location ends after location `that`. */
4447 pragma [ inline]
45- predicate endsAfter ( Location that ) {
48+ predicate endsAfter ( DbLocation that ) {
4649 exists ( File f , int el1 , int ec1 , int el2 , int ec2 |
47- locations_default ( this , f , _, _, el1 , ec1 ) and
48- locations_default ( that , f , _, _, el2 , ec2 )
50+ dbLocationInfo ( this , f , _, _, el1 , ec1 ) and
51+ dbLocationInfo ( that , f , _, _, el2 , ec2 )
4952 |
5053 el1 > el2
5154 or
@@ -57,10 +60,10 @@ class Location extends @location {
5760 * Holds if this location contains location `that`, meaning that it starts
5861 * before and ends after it.
5962 */
60- predicate contains ( Location that ) { this .startsBefore ( that ) and this .endsAfter ( that ) }
63+ predicate contains ( DbLocation that ) { this .startsBefore ( that ) and this .endsAfter ( that ) }
6164
6265 /** Holds if this location is empty. */
63- predicate isEmpty ( ) { exists ( int l , int c | locations_default ( this , _, l , c , l , c - 1 ) ) }
66+ predicate isEmpty ( ) { exists ( int l , int c | dbLocationInfo ( this , _, l , c , l , c - 1 ) ) }
6467
6568 /** Gets a textual representation of this element. */
6669 string toString ( ) { result = this .getFile ( ) .getBaseName ( ) + ":" + this .getStartLine ( ) .toString ( ) }
@@ -76,22 +79,21 @@ class Location extends @location {
7679 string filepath , int startline , int startcolumn , int endline , int endcolumn
7780 ) {
7881 exists ( File f |
79- locations_default ( this , f , startline , startcolumn , endline , endcolumn ) and
82+ dbLocationInfo ( this , f , startline , startcolumn , endline , endcolumn ) and
8083 filepath = f .getAbsolutePath ( )
8184 )
8285 }
8386}
8487
88+ final class Location = LocationImpl ;
89+
8590/** A program element with a location. */
8691class Locatable extends @locatable {
8792 /** Gets the file this program element comes from. */
8893 File getFile ( ) { result = this .getLocation ( ) .getFile ( ) }
8994
9095 /** Gets this element's location. */
91- Location getLocation ( ) {
92- // overridden by subclasses
93- none ( )
94- }
96+ final DbLocation getLocation ( ) { result = getLocatableLocation ( this ) }
9597
9698 /**
9799 * Gets the line on which this element starts.
@@ -142,16 +144,3 @@ class Locatable extends @locatable {
142144 */
143145 string getAPrimaryQlClass ( ) { result = "???" }
144146}
145-
146- /**
147- * A `File`, considered as a `Locatable`.
148- *
149- * For reasons of backwards compatibility, @file is a subtype of @locatable. This class exists to
150- * provide an override of `Locatable.getLocation()` for @files, since it would otherwise default
151- * to `none()`, which is unhelpful.
152- */
153- private class FileLocatable extends File , Locatable {
154- override Location getLocation ( ) { result = File .super .getLocation ( ) }
155-
156- override string toString ( ) { result = File .super .toString ( ) }
157- }
0 commit comments