Skip to content

Commit 35abbe0

Browse files
committed
python/javascript/ruby: mark internal predicates
1 parent 3dca309 commit 35abbe0

File tree

6 files changed

+33
-2
lines changed

6 files changed

+33
-2
lines changed

javascript/ql/lib/semmle/javascript/dataflow/internal/BarrierGuards.qll

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ module ExternalBarrierGuard {
6060

6161
/**
6262
* Gets a barrier guard node of the given `kind` defined via models-as-data.
63+
*
64+
* This only provides external barrier nodes defined as guards. To get all externally defined barrer nodes,
65+
* use `ModelOutput::barrierNode(node, kind)`.
66+
*
67+
* INTERNAL: Do not use.
6368
*/
6469
DataFlow::Node getAnExternalBarrierNode(string kind) {
6570
result = MakeStateBarrierGuard<string, BarrierGuard>::getABarrierNode(kind)

javascript/ql/lib/semmle/javascript/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -848,11 +848,15 @@ module ModelOutput {
848848

849849
/**
850850
* Holds if an external model contributed `barrier` with the given `kind`.
851+
*
852+
* INTERNAL: Do not use.
851853
*/
852854
API::Node getABarrierNode(string kind) { result = getABarrierNode(kind, _) }
853855

854856
/**
855857
* Holds if an external model contributed `barrier-guard` with the given `kind` and `branch`.
858+
*
859+
* INTERNAL: Do not use.
856860
*/
857861
API::Node getABarrierGuardNode(string kind, boolean branch) {
858862
result = getABarrierGuardNode(kind, branch, _)

python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,14 @@ module ExternalBarrierGuard {
649649
)
650650
}
651651

652-
/** Gets a node that is an external barrier of the given kind. */
652+
/**
653+
* Gets a node that is an external barrier of the given kind.
654+
*
655+
* This only provides external barrier nodes defined as guards. To get all externally defined barrer nodes,
656+
* use `ModelOutput::barrierNode(node, kind)`.
657+
*
658+
* INTERNAL: Do not use.
659+
*/
653660
ExprNode getAnExternalBarrierNode(string kind) {
654661
result = ParameterizedBarrierGuard<string, guardCheck/4>::getABarrierNode(kind)
655662
}

python/ql/lib/semmle/python/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -848,11 +848,15 @@ module ModelOutput {
848848

849849
/**
850850
* Holds if an external model contributed `barrier` with the given `kind`.
851+
*
852+
* INTERNAL: Do not use.
851853
*/
852854
API::Node getABarrierNode(string kind) { result = getABarrierNode(kind, _) }
853855

854856
/**
855857
* Holds if an external model contributed `barrier-guard` with the given `kind` and `branch`.
858+
*
859+
* INTERNAL: Do not use.
856860
*/
857861
API::Node getABarrierGuardNode(string kind, boolean branch) {
858862
result = getABarrierGuardNode(kind, branch, _)

ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowPublic.qll

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1000,7 +1000,14 @@ module ExternalBarrierGuard {
10001000
)
10011001
}
10021002

1003-
/** Gets a node that is an external barrier of the given kind. */
1003+
/**
1004+
* Gets a node that is an external barrier of the given kind.
1005+
*
1006+
* This only provides external barrier nodes defined as guards. To get all externally defined barrer nodes,
1007+
* use `ModelOutput::barrierNode(node, kind)`.
1008+
*
1009+
* INTERNAL: Do not use.
1010+
*/
10041011
ExprNode getAnExternalBarrierNode(string kind) {
10051012
result = ParameterizedBarrierGuard<string, guardCheck/4>::getABarrierNode(kind)
10061013
}

ruby/ql/lib/codeql/ruby/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -848,11 +848,15 @@ module ModelOutput {
848848

849849
/**
850850
* Holds if an external model contributed `barrier` with the given `kind`.
851+
*
852+
* INTERNAL: Do not use.
851853
*/
852854
API::Node getABarrierNode(string kind) { result = getABarrierNode(kind, _) }
853855

854856
/**
855857
* Holds if an external model contributed `barrier-guard` with the given `kind` and `branch`.
858+
*
859+
* INTERNAL: Do not use.
856860
*/
857861
API::Node getABarrierGuardNode(string kind, boolean branch) {
858862
result = getABarrierGuardNode(kind, branch, _)

0 commit comments

Comments
 (0)