hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-23 12:16:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

wait with deprecating Container::getURL()

Browse Source
This commit is contained in:
erik-krogh
2023-06-07 22:35:11 +02:00
parent a4ef8619c6
commit 2241350d32
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
cpp/ql/lib/semmle/code/cpp/File.qll
View File

@@ -34,6 +34,14 @@ class Container extends Locatable, @container {
*/ */
string getAbsolutePath() { none() } // overridden by subclasses string getAbsolutePath() { none() } // overridden by subclasses
/**
* DEPRECATED: Use `getLocation` instead.
* Gets a URL representing the location of this container.
*
* For more information see [Providing URLs](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/#providing-urls).
*/
deprecated string getURL() { none() } // overridden by subclasses
/** /**
* Gets the relative path of this file or folder from the root folder of the * Gets the relative path of this file or folder from the root folder of the
* analyzed source location. The relative path of the root folder itself is * analyzed source location. The relative path of the root folder itself is
@@ -175,6 +183,12 @@ class Folder extends Container, @folder {
} }
override string getAPrimaryQlClass() { result = "Folder" } override string getAPrimaryQlClass() { result = "Folder" }
/**
* DEPRECATED: Use `getLocation` instead.
* Gets the URL of this folder.
*/
deprecated override string getURL() { result = "file://" + this.getAbsolutePath() + ":0:0:0:0" }
} }
/** /**
@@ -199,6 +213,12 @@ class File extends Container, @file {
result.hasLocationInfo(_, 0, 0, 0, 0) result.hasLocationInfo(_, 0, 0, 0, 0)
} }
/**
* DEPRECATED: Use `getLocation` instead.
* Gets the URL of this file.
*/
deprecated override string getURL() { result = "file://" + this.getAbsolutePath() + ":0:0:0:0" }
/** Holds if this file was compiled as C (at any point). */ /** Holds if this file was compiled as C (at any point). */
predicate compiledAsC() { fileannotations(underlyingElement(this), 1, "compiled as c", "1") } predicate compiledAsC() { fileannotations(underlyingElement(this), 1, "compiled as c", "1") }