Java, Javascript, Csharp: Restrict definitions predicates

Only expose definition-use relation itself, and getEncodedFile.

Author: jcreedcmu

csharp/ql/src/definitions.qll

@@ -6,7 +6,7 @@
 import csharp
 
 /** An element with an associated definition. */
-abstract class Use extends @type_mention_parent {
+abstract private class Use extends @type_mention_parent {
   /**
    * Holds if this element is at the specified location.
    * The location spans column `startcolumn` of line `startline` to
@@ -46,7 +46,7 @@ abstract class Use extends @type_mention_parent {
 }
 
 /** A method call/access. */
-class MethodUse extends Use, QualifiableExpr {
+private class MethodUse extends Use, QualifiableExpr {
   MethodUse() {
     this instanceof MethodCall or
     this instanceof MethodAccess
@@ -90,7 +90,7 @@ class MethodUse extends Use, QualifiableExpr {
 }
 
 /** An access. */
-class AccessUse extends Access, Use {
+private class AccessUse extends Access, Use {
   AccessUse() {
     not this.getTarget().(Parameter).getCallable() instanceof Accessor and
     not this = any(LocalVariableDeclAndInitExpr d).getLValue() and
@@ -136,7 +136,7 @@ class AccessUse extends Access, Use {
 }
 
 /** A type mention. */
-class TypeMentionUse extends Use, TypeMention {
+private class TypeMentionUse extends Use, TypeMention {
   TypeMentionUse() {
     // In type mentions such as `T[]`, `T?`, `T*`, and `(S, T)`, we only want
     // uses for the nested type mentions

java/ql/src/definitions.qll

@@ -14,7 +14,7 @@ import java
  * the location may be slightly inaccurate and include such whitespace,
  * but it should suffice for the purpose of avoiding overlapping definitions.
  */
-class LocationOverridingMethodAccess extends MethodAccess {
+private class LocationOverridingMethodAccess extends MethodAccess {
   override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
     exists(MemberRefExpr e | e.getReferencedCallable() = getMethod() |
       exists(int elRef, int ecRef | e.hasLocationInfo(path, _, _, elRef, ecRef) |
@@ -73,7 +73,7 @@ class LocationOverridingMethodAccess extends MethodAccess {
  * Restricts the location of a type access to exclude
  * the type arguments and qualifier, if any.
  */
-class LocationOverridingTypeAccess extends TypeAccess {
+private class LocationOverridingTypeAccess extends TypeAccess {
   override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
     exists(int slSuper, int scSuper, int elSuper, int ecSuper |
       super.hasLocationInfo(path, slSuper, scSuper, elSuper, ecSuper)
@@ -112,7 +112,7 @@ class LocationOverridingTypeAccess extends TypeAccess {
  * Restricts the location of a field access to the name of the accessed field only,
  * excluding its qualifier.
  */
-class LocationOverridingFieldAccess extends FieldAccess {
+private class LocationOverridingFieldAccess extends FieldAccess {
   override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
     super.hasLocationInfo(path, _, _, el, ec) and
     sl = el and
@@ -124,7 +124,7 @@ class LocationOverridingFieldAccess extends FieldAccess {
  * Restricts the location of a single-type-import declaration to the name of the imported type only,
  * excluding the `import` keyword and the package name.
  */
-class LocationOverridingImportType extends ImportType {
+private class LocationOverridingImportType extends ImportType {
   override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
     exists(int slSuper, int scSuper, int elSuper, int ecSuper |
       super.hasLocationInfo(path, slSuper, scSuper, elSuper, ecSuper)
@@ -141,7 +141,7 @@ class LocationOverridingImportType extends ImportType {
  * Restricts the location of a single-static-import declaration to the name of the imported member(s) only,
  * excluding the `import` keyword and the package name.
  */
-class LocationOverridingImportStaticTypeMember extends ImportStaticTypeMember {
+private class LocationOverridingImportStaticTypeMember extends ImportStaticTypeMember {
   override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
     exists(int slSuper, int scSuper, int elSuper, int ecSuper |
       super.hasLocationInfo(path, slSuper, scSuper, elSuper, ecSuper)
@@ -154,7 +154,7 @@ class LocationOverridingImportStaticTypeMember extends ImportStaticTypeMember {
   }
 }
 
-Element definition(Element e, string kind) {
+private Element definition(Element e, string kind) {
   e.(MethodAccess).getMethod().getSourceDeclaration() = result and
   kind = "M" and
   not result instanceof InitializerMethod
@@ -173,14 +173,14 @@ Element definition(Element e, string kind) {
   e.(ImportStaticTypeMember).getAMemberImport() = result and kind = "I"
 }
 
-predicate dummyVarAccess(VarAccess va) {
+private predicate dummyVarAccess(VarAccess va) {
   exists(AssignExpr ae, InitializerMethod im |
     ae.getDest() = va and
     ae.getParent() = im.getBody().getAChild()
   )
 }
 
-predicate dummyTypeAccess(TypeAccess ta) {
+private predicate dummyTypeAccess(TypeAccess ta) {
   exists(FunctionalExpr e |
     e.getAnonymousClass().getClassInstanceExpr().getTypeName() = ta.getParent*()
   )

javascript/ql/src/definitions.qll

@@ -15,7 +15,7 @@ private import Declarations.Declarations
  * For example, in the expression `f(x)`, `f` has kind `"M"` while
  * `x` has kind `"V"`.
  */
-string refKind(RefExpr r) {
+private string refKind(RefExpr r) {
   if exists(InvokeExpr invk | r = invk.getCallee().getUnderlyingReference())
   then result = "M"
   else result = "V"
@@ -24,7 +24,7 @@ string refKind(RefExpr r) {
 /**
  * Gets a class, function or object literal `va` may refer to.
  */
-ASTNode lookupDef(VarAccess va) {
+private ASTNode lookupDef(VarAccess va) {
   exists(AbstractValue av | av = va.analyze().getAValue() |
     result = av.(AbstractClass).getClass() or
     result = av.(AbstractFunction).getFunction() or
@@ -36,7 +36,7 @@ ASTNode lookupDef(VarAccess va) {
  * Holds if `va` is of kind `kind` and `def` is the unique class,
  * function or object literal it refers to.
  */
-predicate variableDefLookup(VarAccess va, ASTNode def, string kind) {
+private predicate variableDefLookup(VarAccess va, ASTNode def, string kind) {
   count(lookupDef(va)) = 1 and
   def = lookupDef(va) and
   kind = refKind(va)
@@ -50,7 +50,7 @@ predicate variableDefLookup(VarAccess va, ASTNode def, string kind) {
  * expression of `y` is a variable access `x` of kind `"V"` that refers to
  * the declaration `x = 42`.
  */
-predicate variableDeclLookup(VarAccess va, VarDecl decl, string kind) {
+private predicate variableDeclLookup(VarAccess va, VarDecl decl, string kind) {
   // restrict to declarations in same file to avoid accidentally picking up
   // unrelated global definitions
   decl = firstRefInTopLevel(va.getVariable(), Decl(), va.getTopLevel()) and
@@ -65,7 +65,7 @@ predicate variableDeclLookup(VarAccess va, VarDecl decl, string kind) {
  * For example, in the statement `var a = require("./a")`, the path expression
  * `"./a"` imports a module `a` in the same folder.
  */
-predicate importLookup(ASTNode path, Module target, string kind) {
+private predicate importLookup(ASTNode path, Module target, string kind) {
   kind = "I" and
   (
     exists(Import i |
@@ -83,7 +83,7 @@ predicate importLookup(ASTNode path, Module target, string kind) {
 /**
  * Gets a node that may write the property read by `prn`.
  */
-ASTNode getAWrite(DataFlow::PropRead prn) {
+private ASTNode getAWrite(DataFlow::PropRead prn) {
   exists(DataFlow::AnalyzedNode base, DefiniteAbstractValue baseVal, string propName |
     base = prn.getBase() and
     propName = prn.getPropertyName() and
@@ -111,7 +111,7 @@ ASTNode getAWrite(DataFlow::PropRead prn) {
  * only such property write. Parameter `kind` is always bound to `"M"`
  * at the moment.
  */
-predicate propertyLookup(Expr prop, ASTNode write, string kind) {
+private predicate propertyLookup(Expr prop, ASTNode write, string kind) {
   exists(DataFlow::PropRead prn | prop = prn.getPropertyNameExpr() |
     count(getAWrite(prn)) = 1 and
     write = getAWrite(prn) and
@@ -122,7 +122,7 @@ predicate propertyLookup(Expr prop, ASTNode write, string kind) {
 /**
  * Holds if `ref` is an identifier that refers to a type declared at `decl`.
  */
-predicate typeLookup(ASTNode ref, ASTNode decl, string kind) {
+private predicate typeLookup(ASTNode ref, ASTNode decl, string kind) {
   exists(TypeAccess typeAccess |
     ref = typeAccess.getIdentifier() and
     decl = typeAccess.getTypeName().getADefinition() and
@@ -133,7 +133,7 @@ predicate typeLookup(ASTNode ref, ASTNode decl, string kind) {
 /**
  * Holds if `ref` is the callee name of an invocation of `decl`.
  */
-predicate typedInvokeLookup(ASTNode ref, ASTNode decl, string kind) {
+private predicate typedInvokeLookup(ASTNode ref, ASTNode decl, string kind) {
   not variableDefLookup(ref, decl, _) and
   not propertyLookup(ref, decl, _) and
   exists(InvokeExpr invoke, Expr callee |
@@ -147,7 +147,7 @@ predicate typedInvokeLookup(ASTNode ref, ASTNode decl, string kind) {
 /**
  * Holds if `ref` is a JSDoc type annotation referring to a class defined at `decl`.
  */
-predicate jsdocTypeLookup(JSDocNamedTypeExpr ref, ASTNode decl, string kind) {
+private predicate jsdocTypeLookup(JSDocNamedTypeExpr ref, ASTNode decl, string kind) {
   decl = ref.getClass().getAstNode() and
   kind = "T"
 }