Merge pull request github#6536 from github/igfoo/getPrimaryQlClasses

All languages: Add getPrimaryQlClasses()

Author: igfoo

cpp/change-notes/2021-08-23-getPrimaryQlClasses.md

@@ -0,0 +1,2 @@
+lgtm,codescanning
+* Added `Element.getPrimaryQlClasses()` predicate, which gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

cpp/ql/lib/semmle/code/cpp/Element.qll

@@ -58,6 +58,11 @@ class ElementBase extends @element {
   /** DEPRECATED: use `getAPrimaryQlClass` instead. */
   deprecated string getCanonicalQLClass() { result = this.getAPrimaryQlClass() }
 
+  /**
+   * Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.
+   */
+  final string getPrimaryQlClasses() { result = concat(getAPrimaryQlClass(), ",") }
+
   /**
    * Gets the name of a primary CodeQL class to which this element belongs.
    *

csharp/change-notes/2021-08-23-getPrimaryQlClasses.md

@@ -0,0 +1,2 @@
+lgtm,codescanning
+* Added `Element.getPrimaryQlClasses()` predicate, which gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

csharp/ql/lib/semmle/code/cil/ConsistencyChecks.qll

@@ -670,7 +670,7 @@ class MissingCilDeclaration extends ConsistencyViolation, MissingCSharpCheck {
   override string getMessage() {
     result =
       "Cannot locate CIL for " + getDeclaration().toStringWithTypes() + " of class " +
-        getDeclaration().getAPrimaryQlClass()
+        getDeclaration().getPrimaryQlClasses()
   }
 
   override string toString() { result = getDeclaration().toStringWithTypes() }

csharp/ql/lib/semmle/code/csharp/PrintAst.qll

@@ -61,7 +61,7 @@ private predicate isNotNeeded(Element e) {
  * Retrieves the canonical QL class(es) for entity `el`
  */
 private string getQlClass(Element el) {
-  result = "[" + concat(el.getAPrimaryQlClass(), ",") + "] "
+  result = "[" + el.getPrimaryQlClasses() + "] "
   // Alternative implementation -- do not delete. It is useful for QL class discovery.
   // result = "["+ concat(el.getAQlClass(), ",") + "] "
 }

csharp/ql/lib/semmle/code/dotnet/Element.qll

@@ -40,6 +40,11 @@ class Element extends @dotnet_element {
   /** Gets the full textual representation of this element, including type information. */
   string toStringWithTypes() { result = this.toString() }
 
+  /**
+   * Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.
+   */
+  final string getPrimaryQlClasses() { result = concat(getAPrimaryQlClass(), ",") }
+
   /**
    * Gets the name of a primary CodeQL class to which this element belongs.
    *

csharp/ql/test/library-tests/generics/ConsistencyChecks.ql

@@ -6,4 +6,4 @@ import semmle.code.csharp.commons.ConsistencyChecks
 
 from Element e, string m
 where consistencyFailure(e, m)
-select e, "Element class " + e.getAPrimaryQlClass() + " has consistency check failed: " + m
+select e, "Element class " + e.getPrimaryQlClasses() + " has consistency check failed: " + m

java/change-notes/2021-08-23-getPrimaryQlClasses.md

@@ -0,0 +1,2 @@
+lgtm,codescanning
+* Added `Top.getPrimaryQlClasses()` predicate, which gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

java/ql/lib/semmle/code/Location.qll

@@ -100,6 +100,11 @@ class Top extends @top {
   cached
   string toString() { hasName(this, result) }
 
+  /**
+   * Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.
+   */
+  final string getPrimaryQlClasses() { result = concat(getAPrimaryQlClass(), ",") }
+
   /**
    * Gets the name of a primary CodeQL class to which this element belongs.
    *

java/ql/lib/semmle/code/java/PrintAst.qll

@@ -89,7 +89,7 @@ private predicate duplicateMetadata(Field f) {
  * Retrieves the canonical QL class(es) for entity `el`
  */
 private string getQlClass(Top el) {
-  result = "[" + concat(el.getAPrimaryQlClass(), ",") + "] "
+  result = "[" + el.getPrimaryQlClasses() + "] "
   // Alternative implementation -- do not delete. It is useful for QL class discovery.
   // result = "[" + concat(el.getAQlClass(), ",") + "] "
 }