hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-02 04:05:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation for type signature members

Browse Source
This commit is contained in:
Philip Ginsbach
2022-10-21 13:07:37 +01:00
parent 471a596dfb
commit 0dc7123ded
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/codeql/ql-language-reference/signatures.rst
View File

@@ -40,10 +40,11 @@ Type signatures
===============
Type signatures declare module parameters that will be substituted with types when the module is instantiated.
Type signatures are used to specify supertypes and are the simplest category of signatures.
Type signatures may specify supertypes and required member predicates (in addition to those member predicates that are
implied by the supertypes).
The substitution of type signatures relies on structural typing. That is, types do not have to be explicitly defined as
implementing a type signature - they just need to have the specified (transitive) supertypes.
implementing a type signature - they just need to have the specified (transitive) supertypes and member predicates.
In detail, a type signature definition consists of:
@@ -52,7 +53,8 @@ In detail, a type signature definition consists of:
#. The name of the type signature. This is an `identifier <https://codeql.github.com/docs/ql-language-reference/ql-language-specification/#identifiers>`_
starting with a uppercase letter.
#. Optionally, the keyword ``extends`` followed by a list of types, separated by commas.
#. A semicolon ``;``.
#. Either a semicolon ``;`` or a list of predicate signatures enclosed in braces.
The ``signature`` keyword is omitted for these contained signatures.
For example:
@@ -60,6 +62,10 @@ For example:
signature class ExtendsInt extends int;
signature class CanBePrinted {
string toString();
}
Module signatures
=================