8000 Merge pull request #19130 from paldepind/rust-type-alias-string · github/codeql@e2ed848 · GitHub
[go: up one dir, main page]
Skip to content

Commit e2ed848

Browse files
paldepindpaldepind
authored
Merge pull request #19130 from paldepind/rust-type-alias-string
Rust: Implement toString on type aliases and add docs
2 parents ed50343 + 533fdcf commit e2ed848

20 files changed

+105
-38
lines changed

‎rust/ql/.generated.list

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/.gitattributes

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/lib/codeql/rust/elements/GenericParamList.qll

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/lib/codeql/rust/elements/TypeAlias.qll

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/lib/codeql/rust/elements/internal/GenericParamListImpl.qll

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ module Impl {
1515

1616
// the following QLdoc is generated: if you need to edit it, do it in the schema file
1717
/**
18-
* A GenericParamList. For example:
18+
* A list of generic parameters. For example:
1919
* ```rust
20-
* todo!()
20+
* fn f<A, B>(a: A, b: B) {}
21+
* // ^^^^^^
22+
* type Foo<T1, T2> = (T1, T2);
23+
* // ^^^^^^^^
2124
* ```
2225
*/
2326
class GenericParamList extends Generated::GenericParamList {

‎rust/ql/lib/codeql/rust/elements/internal/TypeAliasImpl.qll

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// generated by codegen, remove this comment if you wish to edit this file
21
/**
32
* This module provides a hand-modifiable wrapper around the generated class `TypeAlias`.
43
*
@@ -12,11 +11,27 @@ private import codeql.rust.elements.internal.generated.TypeAlias
1211
* be referenced directly.
1312
*/
1413
module Impl {
14+
// the following QLdoc is generated: if you need to edit it, do it in the schema file
1515
/**
16-
* A TypeAlias. For example:
16+
* A type alias. For example:
1717
* ```rust
18-
* todo!()
18+
* type Point = (u8, u8);
19+
*
20+
* trait Trait {
21+
* type Output;
22+
* // ^^^^^^^^^^^
23+
* }
1924
* ```
2025
*/
21-
class TypeAlias extends Generated::TypeAlias { }
26+
class TypeAlias extends Generated::TypeAlias {
27+
override string toStringImpl() { result = concat(int i | | this.toStringPart(i) order by i) }
28+
29+
private string toStringPart(int index) {
30+
index = 0 and result = "type "
31+
or
32+
index = 1 and result = this.getName().getText()
33+
or
34+
index = 2 and result = this.getGenericParamList().toAbbreviatedString()
35+
}
36+
}
2237
}

‎rust/ql/lib/codeql/rust/elements/internal/generated/GenericParamList.qll

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/lib/codeql/rust/elements/internal/generated/Raw.qll

Lines changed: 12 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/lib/codeql/rust/elements/internal/generated/TypeAlias.qll

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/test/extractor-tests/generated/.generated_tests.list

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/test/extractor-tests/generated/GenericParamList/GenericParamList.expected

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
| gen_generic_param_list.rs:5:9:5:14 | <...> | getNumberOfGenericParams: | 2 |
2+
| gen_generic_param_list.rs:7:13:7:20 | <...> | getNumberOfGenericParams: | 2 |

‎rust/ql/test/extractor-tests/generated/GenericParamList/GenericParamList_getGenericParam.expected

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
| gen_generic_param_list.rs:5:9:5:14 | <...> | 0 | gen_generic_param_list.rs:5:10:5:10 | A |
2+
| gen_generic_param_list.rs:5:9:5:14 | <...> | 1 | gen_generic_param_list.rs:5:13:5:13 | B |
3+
| gen_generic_param_list.rs:7:13:7:20 | <...> | 0 | gen_generic_param_list.rs:7:14:7:15 | T1 |
4+
| gen_generic_param_list.rs:7:13:7:20 | <...> | 1 | gen_generic_param_list.rs:7:18:7:19 | T2 |

‎rust/ql/test/extractor-tests/generated/GenericParamList/gen_generic_param_list.rs

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/test/extractor-tests/generated/Trait/AssocItemList_getAssocItem.expected

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
| gen_trait.rs:4:20:8:1 | AssocItemList | 0 | gen_trait.rs:5:3:5:18 | TypeAlias |
2-
| gen_trait.rs:4:20:8:1 | AssocItemList | 1 | gen_trait.rs:6:3:6:20 | TypeAlias |
1+
| gen_trait.rs:4:20:8:1 | AssocItemList | 0 | gen_trait.rs:5:3:5:18 | type Frobinator |
2+
| gen_trait.rs:4:20:8:1 | AssocItemList | 1 | gen_trait.rs:6:3:6:20 | type Result |
33
| gen_trait.rs:4:20:8:1 | AssocItemList | 2 | gen_trait.rs:7:3:7:72 | fn frobinize_with |

‎rust/ql/test/extractor-tests/generated/TypeAlias/TypeAlias.expected

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
| gen_type_alias.rs:4:5:5:26 | type Point | hasExtendedCanonicalPath: | no | hasCrateOrigin: | no | getNumberOfAttrs: | 0 | hasGenericParamList: | no | isDefault: | no | hasName: | yes | hasTypeRepr: | yes | hasTypeBoundList: | no | hasVisibility: | no | hasWhereClause: | no |
2+
| gen_type_alias.rs:8:9:8:20 | type Output | hasExtendedCanonicalPath: | no | hasCrateOrigin: | no | getNumberOfAttrs: | 0 | hasGenericParamList: | no | isDefault: | no | hasName: | yes | hasTypeRepr: | no | hasTypeBoundList: | no | hasVisibility: | no | hasWhereClause: | no |

‎rust/ql/test/extractor-tests/generated/TypeAlias/TypeAlias_getName.expected

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
| gen_type_alias.rs:4:5:5:26 | type Point | gen_type_alias.rs:5:10:5:14 | Point |
2+
| gen_type_alias.rs:8:9:8:20 | type Output | gen_type_alias.rs:8:14:8:19 | Output |

‎rust/ql/test/extractor-tests/generated/TypeAlias/TypeAlias_getTypeRepr.expected

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
| gen_type_alias.rs:4:5:5:26 | type Point | gen_type_alias.rs:5:18:5:25 | TupleTypeRepr |

‎rust/ql/test/extractor-tests/generated/TypeAlias/gen_type_alias.rs

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rust/ql/test/library-tests/path-resolution/path-resolution.expected

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ resolvePath
131131
| main.rs:261:17:261:17 | C | main.rs:254:9:254:9 | C |
132132
| main.rs:274:16:274:16 | T | main.rs:268:7:268:7 | T |
133133
| main.rs:275:14:275:17 | Self | main.rs:266:5:276:5 | trait MyParamTrait |
134-
| main.rs:275:14:275:33 | ...::AssociatedType | main.rs:270:9:270:28 | TypeAlias |
134+
| main.rs:275:14:275:33 | ...::AssociatedType | main.rs:270:9:270:28 | type AssociatedType |
135135
| main.rs:284:13:284:17 | crate | main.rs:0:0:0:0 | Crate(main@0.0.1) |
136136
| main.rs:284:13:284:22 | ...::m13 | main.rs:279:1:292:1 | mod m13 |
137137
| main.rs:284:13:284:25 | ...::f | main.rs:280:5:280:17 | fn f |

‎rust/schema/annotations.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,9 +1123,12 @@ class _:
11231123
@annotate(GenericParamList)
11241124
class _:
11251125
"""
1126-
A GenericParamList. For example:
1126+
A list of generic parameters. For example:
11271127
```rust
1128-
todo!()
1128+
fn f<A, B>(a: A, b: B) {}
1129+
// ^^^^^^
1130+
type Foo<T1, T2> = (T1, T2);
1131+
// ^^^^^^^^
11291132
```
11301133
"""
11311134

@@ -1705,9 +1708,14 @@ class _:
17051708
@annotate(TypeAlias)
17061709
class _:
17071710
"""
1708-
A TypeAlias. For example:
1711+
A type alias. For example:
17091712
```rust
1710-
todo!()
1713+
type Point = (u8, u8);
1714+
1715+
trait Trait {
1716+
type Output;
1717+
// ^^^^^^^^^^^
1718+
}
17111719
```
17121720
"""
17131721

0 commit comments

Comments
 (0)
0