Skip to content

C++: Document the three predicates for array size #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dave-bartolomeo merged 2 commits into from
Sep 11, 2018
Merged

C++: Document the three predicates for array size #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d956bf9
C++: Document the three predicates for array size
jbj Sep 11, 2018
4304a4e
C++: Fix docs copy-paste error
jbj Sep 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions cpp/ql/src/semmle/code/cpp/Type.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,15 +904,25 @@ class ArrayType extends DerivedType {
ArrayType() { derivedtypes(underlyingElement(this),_,4,_) }

predicate hasArraySize() { arraysizes(underlyingElement(this),_,_,_) }

/**
* Gets the number of elements in this array. Only has a result for arrays declared to be of a
* constant size. See `getByteSize` for getting the number of bytes.
*/
int getArraySize() { arraysizes(underlyingElement(this),result,_,_) }

/**
* Gets the byte size of this array. Only has a result for arrays declared to be of a constant
* size. See `getArraySize` for getting the number of elements.
*/
int getByteSize() { arraysizes(underlyingElement(this),_,result,_) }

override int getAlignment() { arraysizes(underlyingElement(this), _, _, result) }

/**
* Gets the size of this array (only valid for arrays declared to be of a constant
* size, will fail for all others).
* Gets the byte size of this array. Only has a result for arrays declared to be of a constant
* size. This predicate is a synonym for `getByteSize`. See `getArraySize` for getting the number
* of elements.
*/
override int getSize() {
result = this.getByteSize()
Expand Down