You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/customizing-library-models-for-cpp.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,7 @@ The first five values identify the callable (in this case a free function) to be
93
93
94
94
- The first value ``"boost::asio"`` is the namespace name.
95
95
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
96
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
96
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method. For a free function, this should be ``False``.
97
97
- The fourth value ``"read_until"`` is the function name.
98
98
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``read_until``.
99
99
@@ -129,7 +129,7 @@ The first five values identify the callable (in this case a free function) to be
129
129
130
130
- The first value ``"boost::asio"`` is the namespace name.
131
131
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
132
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
132
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method. For a free function, this should be ``False``.
133
133
- The fourth value ``"write"`` is the function name.
134
134
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``write``.
135
135
@@ -166,7 +166,7 @@ The first five values identify the callable (in this case free function) to be m
166
166
167
167
- The first value ``"boost::asio"`` is the namespace name.
168
168
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
169
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method. For a free function, this should be ``False``.
169
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method. For a free function, this should be ``False``.
170
170
- The fourth value ``"buffer"`` is the function name.
171
171
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``buffer``.
172
172
@@ -208,7 +208,7 @@ The first five values identify the callable (in this case a free function) to be
208
208
209
209
- The first value ``""`` is the namespace name.
210
210
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
211
-
- The third value ``False`` is a flag that indicates whether or not the barrier also applies to all overrides of the method. For a free function, this should be ``False``.
211
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method. For a free function, this should be ``False``.
212
212
- The fourth value ``"mysql_real_escape_string"`` is the function name.
213
213
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.
214
214
@@ -248,7 +248,7 @@ The first five values identify the callable (in this case a free function) to be
248
248
249
249
- The first value ``""`` is the namespace name.
250
250
- The second value ``""`` is the name of the type (class) that contains the method. Because we're modeling a free function, the type is left blank.
251
-
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to all overrides of the method. For a free function, this should be ``False``.
251
+
- The third value ``False`` is a flag that indicates whether or not the model guard also applies to all overrides of the method. For a free function, this should be ``False``.
252
252
- The fourth value ``"is_safe"`` is the function name.
253
253
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name.
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/customizing-library-models-for-csharp.rst
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,7 +98,7 @@ The first five values identify the callable (in this case a method) to be modele
98
98
99
99
- The first value ``System.Data.SqlClient`` is the namespace name.
100
100
- The second value ``SqlCommand`` is the name of the class (type) that contains the method.
101
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to all overrides of the method.
101
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
102
102
- The fourth value ``SqlCommand`` is the method name. Constructors are named after the class.
103
103
- The fifth value ``(System.String,System.Data.SqlClient.SqlConnection)`` is the method input type signature. The type names must be fully qualified.
104
104
@@ -138,7 +138,7 @@ The first five values identify the callable (in this case a method) to be modele
138
138
139
139
- The first value ``System.Net.Sockets`` is the namespace name.
140
140
- The second value ``TcpClient`` is the name of the class (type) that contains the source.
141
-
- The third value ``False`` is a flag that indicates whether or not the source also applies to all overrides of the method.
141
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
142
142
- The fourth value ``GetStream`` is the method name.
143
143
- The fifth value ``()`` is the method input type signature.
144
144
@@ -182,7 +182,7 @@ These are the same for both of the rows above as we are adding two summaries for
182
182
183
183
- The first value ``System`` is the namespace name.
184
184
- The second value ``String`` is the class (type) name.
185
-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
185
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
186
186
- The fourth value ``Concat`` is the method name.
187
187
- The fifth value ``(System.Object,System.Object)`` is the method input type signature.
188
188
@@ -238,7 +238,7 @@ These are the same for both of the rows above as we are adding two summaries for
238
238
239
239
- The first value ``System`` is the namespace name.
240
240
- The second value ``String`` is the class (type) name.
241
-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
241
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
242
242
- The fourth value ``Trim`` is the method name.
243
243
- The fifth value ``()`` is the method input type signature.
244
244
@@ -282,7 +282,7 @@ These are the same for both of the rows above as we are adding two summaries for
282
282
283
283
- The first value ``System.Linq`` is the namespace name.
284
284
- The second value ``Enumerable`` is the class (type) name.
285
-
- The third value ``False`` is a flag that indicates whether or not the summary also applies to all overrides of the method.
285
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
286
286
- The fourth value ``Select<TSource,TResult>`` is the method name, along with the type parameters for the method. The names of the generic type parameters provided in the model must match the names of the generic type parameters in the method signature in the source code.
287
287
- The fifth value ``(System.Collections.Generic.IEnumerable<TSource>,System.Func<TSource,TResult>)`` is the method input type signature. The generics in the signature must match the generics in the method signature in the source code.
288
288
@@ -339,7 +339,7 @@ The first five values identify the callable (in this case the getter of a proper
339
339
340
340
- The first value ``System.Web`` is the namespace name.
341
341
- The second value ``HttpRequest`` is the class (type) name.
342
-
- The third value ``False`` is a flag that indicates whether or not the barrier also applies to all overrides of the method.
342
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to all overrides of the method.
343
343
- The fourth value ``get_RawUrl`` is the method name. Getter and setter methods are named ``get_<name>`` and ``set_<name>`` respectively.
344
344
- The fifth value ``()`` is the method input type signature.
345
345
@@ -381,7 +381,7 @@ The first five values identify the callable (in this case the getter of a proper
381
381
382
382
- The first value ``System`` is the namespace name.
383
383
- The second value ``Uri`` is the class (type) name.
384
-
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to all overrides of the method.
384
+
- The third value ``False`` is a flag that indicates whether or not the model guard also applies to all overrides of the method.
385
385
- The fourth value ``get_IsAbsoluteUri`` is the method name. Getter and setter methods are named ``get_<name>`` and ``set_<name>`` respectively.
386
386
- The fifth value ``()`` is the method input type signature.
Copy file name to clipboardExpand all lines: docs/codeql/codeql-language-guides/customizing-library-models-for-go.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,7 +98,7 @@ The first five values identify the function (in this case a method) to be modele
98
98
99
99
- The first value ``database/sql`` is the package name.
100
100
- The second value ``DB`` is the name of the type that the method is associated with.
101
-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
101
+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
102
102
- The fourth value ``Prepare`` is the method name.
103
103
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
104
104
@@ -139,7 +139,7 @@ The first five values identify the function to be modeled as a source.
139
139
140
140
- The first value ``net/http`` is the package name.
141
141
- The second value ``Request`` is the type name, since the function is a method of the ``Request`` type.
142
-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
142
+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
143
143
- The fourth value ``FormValue`` is the function name.
144
144
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
145
145
@@ -182,7 +182,7 @@ The first five values identify the function to be modeled as a summary.
182
182
183
183
- The first value ``slices`` is the package name.
184
184
- The second value ``""`` is left blank, since the function is not a method of a type.
185
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
185
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
186
186
- The fourth value ``Max`` is the function name.
187
187
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
188
188
@@ -227,7 +227,7 @@ The first five values identify the function to be modeled as a summary.
227
227
228
228
- The first value ``slices`` is the package name.
229
229
- The second value ``""`` is left blank, since the function is not a method of a type.
230
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
230
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
231
231
- The fourth value ``Max`` is the function name.
232
232
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
233
233
@@ -274,7 +274,7 @@ These are the same for both of the rows above as we are adding two summaries for
274
274
275
275
- The first value ``strings`` is the package name.
276
276
- The second value ``""`` is left blank, since the function is not a method of a type.
277
-
- The third value ``False`` is a flag that indicates whether or not the sink also applies to subtypes. This has no effect for non-method functions.
277
+
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
278
278
- The fourth value ``Join`` is the function name.
279
279
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
280
280
@@ -329,7 +329,7 @@ The first five values identify the function (in this case a method) to be modele
329
329
330
330
- The first value ``net/url`` is the package name.
331
331
- The second value ``URL`` is the receiver type.
332
-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
332
+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This includes when the subtype embeds the given type, so that the method or field is promoted to be a method or field of the subtype. For interface methods it also includes types which implement the interface type.
333
333
- The fourth value ``Hostname`` is the method name.
334
334
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
335
335
@@ -370,7 +370,7 @@ The first five values identify the function to be modeled as a barrier.
370
370
371
371
- The first value ``group:beego`` is the package group name. The ``group:`` prefix indicates that this is a package group, which is used to match multiple package paths that refer to the same package.
372
372
- The second value ``""`` is left blank since the function is not a method of a type.
373
-
- The third value ``True`` is a flag that indicates whether or not the barrier also applies to subtypes. This has no effect for non-method functions.
373
+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
374
374
- The fourth value ``Htmlquote`` is the function name.
375
375
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string.
376
376
@@ -411,7 +411,7 @@ The first five values identify the function to be modeled as a barrier guard.
411
411
412
412
- The first value ``example.com/example`` is the package name.
413
413
- The second value ``""`` is left blank since the function is not a method of a type.
414
-
- The third value ``False`` is a flag that indicates whether or not the barrier guard also applies to subtypes. This has no effect for non-method functions.
414
+
- The third value ``False`` is a flag that indicates whether or not the model guard also applies to subtypes. This has no effect for non-method functions.
415
415
- The fourth value ``IsSafe`` is the function name.
416
416
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string.
417
417
@@ -450,7 +450,7 @@ The first five values identify the field to be modeled as a source.
450
450
451
451
- The first value ``net/http`` is the package name.
452
452
- The second value ``Request`` is the name of the type that the field is associated with.
453
-
- The third value ``True`` is a flag that indicates whether or not the sink also applies to subtypes. For fields this means when the field is accessed as a promoted field in another type.
453
+
- The third value ``True`` is a flag that indicates whether or not the model also applies to subtypes. For fields this means when the field is accessed as a promoted field in another type.
454
454
- The fourth value ``Body`` is the field name.
455
455
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
0 commit comments