CPP: QLDoc enhancements by geoffw0 · Pull Request #2309 · github/codeql

geoffw0 · 2019-11-13T10:44:19Z

This is Zem's PR [CPP-418] QLDoc enhancements with some additional fixes:

fixed merge conflicts, including significant changes to qldoc in TypedefType.qll
addressed remaining unresolved comments
added a couple of missed backticks

… figure out how to describe unknown and erroneous types.)

…erations and built-in operations.

…sorted complex number operations, where surface syntax could not be determined.

…vined.

assorted complex/imaginary arithmetic operations.

…builtin_offsetof.

similar to array initializers.

geoffw0 · 2019-11-13T10:45:32Z

 */
 abstract class Assignment extends Operation {
-  /** Gets the lvalue of this assignment. */
+  /** Gets the *lvalue* of this assignment. */


Can anyone remember whether we decided to keep this formatting (*lvalue*)?

We decided against formatting code with asterisks, but I think in this case it's meant to denote italics because lvalue is not an English word. Allows writing italics with single asterisks (bold is double asterisks), but it's more consistent if we stick to underscores, changing this to _lvalue_.

I've done a search-and-replace to change *lvalue* into _lvalue_ (and similarly for *rvalue* etc).

jbj

I'm not done -- I'll continue reviewing later.

jbj · 2019-11-13T15:41:43Z

I should be clear that none of my comments so far are blocking for this PR.

jbj · 2019-11-14T11:01:14Z

@@ -7,6 +7,9 @@ abstract class UnaryLogicalOperation extends UnaryOperation { }

 /**
 * A C/C++ logical not expression.


Suggested change

* A C/C++ logical not expression.

* A C/C++ logical NOT expression.

for consistency

I'm not sure I agree with this one. Do we capitalize 'not' anywhere else?

The changes right below in the same file change "and" to "AND" and "or" to "OR". The same changes are in BitwiseOperation.qll, although bitwise NOT is called complement there.

Which would you prefer? I can make a quick follow-up PR to make this consistent either way.

I prefer NOT because it's consistent with AND/OR and because everyone will understand it.

Co-Authored-By: Jonas Jensen <jbj@github.com>

geoffw0 · 2019-11-14T15:27:49Z

All comments addressed. I'm on holiday tomorrow so ideally this wants to be merged this evening. I'll keep an eye on it.

zlaski-semmle and others added 22 commits November 12, 2019 16:47

[CPP-418] Initial modifications to Type.qll. To be continued.

f54e0d0

[CPP-418] Add descriptions for QL classes in Type.qll. (Still need to…

1f35f4b

… figure out how to describe unknown and erroneous types.)

[CPP-418] Add QLDoc entries for typedef types, user types, bitwise op…

b0a9348

…erations and built-in operations.

[CPP-418] Logical and comparison operators; reformat built-ins.

3fdf84d

[CPP-418] Address @geoffw0's review comments.

e328e78

[CPP-418] Add concrete syntax for arithmetic operation, EXCEPT for as…

113481d

…sorted complex number operations, where surface syntax could not be determined.

[CPP-418] Some assignments and call expressions. Some could not be di…

ecb700c

…vined.

[CPP-418] Tweak vector initializer syntax.

8965561

[CPP-418] Some more complex numbers, vectors.

f255977

[CPP-418] Merge detritus.

09f538a

[CPP-418] Fill in examples for ErroneousType, UnknownType, and

e647dc3

assorted complex/imaginary arithmetic operations.

[CPP-418] Calls, casts, assignments and other goodness.

98eca47

[CPP-418] Typo.

1f337e9

[CPP-418] Expressions.

e2d5a82

[CPP-418] Address review comments.

6eac51d

[CPP-418] Update references to BuiltInOperationBuiltInOffsetOf and __…

faf4342

…builtin_offsetof.

Address further review comments.

2baa748

[CPP-418] Reformat.

20e28b8

[CPP-418] Literals.

d0069fc

[CPP-418] Mention that GNU vector initializers are syntactically

5cc92b7

similar to array initializers.

CPP: Resolve remaining comments from the original PR.

a5d2fbd

CPP: Backticks.

93b4985

geoffw0 added the C++ label Nov 13, 2019

geoffw0 requested a review from a team as a code owner November 13, 2019 10:44

geoffw0 commented Nov 13, 2019

View reviewed changes

geoffw0 mentioned this pull request Nov 13, 2019

[CPP-418] QLDoc enhancements #1864

Closed

geoffw0 added 2 commits November 13, 2019 12:34

CPP: Fix bad merge.

86bea78

CPP: Autoformat.

abcf9e0

jbj reviewed Nov 13, 2019

View reviewed changes

Comment thread cpp/ql/src/semmle/code/cpp/Type.qll

Comment thread cpp/ql/src/semmle/code/cpp/Type.qll

Comment thread cpp/ql/src/semmle/code/cpp/Type.qll Outdated

Comment thread cpp/ql/src/semmle/code/cpp/Type.qll Outdated

Comment thread cpp/ql/src/semmle/code/cpp/Type.qll Outdated

CPP: Improve the UnknwonType example as suggested.

44ffb60

geoffw0 mentioned this pull request Nov 13, 2019

CPP: Add a quick test of ErroneousType. #2315

Merged

jbj reviewed Nov 14, 2019

View reviewed changes

geoffw0 and others added 22 commits November 14, 2019 11:22

Update cpp/ql/src/semmle/code/cpp/Type.qll

9755985

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/Type.qll

7d2babd

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/Type.qll

90909d2

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/Type.qll

b3bda42

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/Type.qll

238918c

Co-Authored-By: Jonas Jensen <jbj@github.com>

CPP: Lesser than -> Less than.

01b2519

Update cpp/ql/src/semmle/code/cpp/exprs/Expr.qll

25db900

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/Expr.qll

0f2a2cb

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/Expr.qll

79a000d

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/Cast.qll

b1dfc60

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/Assignment.qll

acefadd

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

877e9ba

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

d8aeedf

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

fe5bd42

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

6262cee

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

82c6ff0

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

f96cffa

Co-Authored-By: Jonas Jensen <jbj@github.com>

CPP: Delete 'compiler-generated'.

8b30baf

CPP: Delete parenthesized comment.

0bb37c1

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

45cc6c4

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

6724632

Co-Authored-By: Jonas Jensen <jbj@github.com>

Update cpp/ql/src/semmle/code/cpp/exprs/BuiltInOperations.qll

beb3602

Co-Authored-By: Jonas Jensen <jbj@github.com>

geoffw0 mentioned this pull request Nov 14, 2019

CPP: Add a quick test of RoutineType. #2328

Merged

CPP: Add example code for RoutineType.

f2b7af7

jbj approved these changes Nov 14, 2019

View reviewed changes

jbj merged commit 73d9cc2 into github:master Nov 15, 2019

		@@ -7,6 +7,9 @@ abstract class UnaryLogicalOperation extends UnaryOperation { }

		/**
		* A C/C++ logical not expression.

Conversation

geoffw0 commented Nov 13, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jbj commented Nov 13, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geoffw0 commented Nov 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants