Skip to content

Cleanup some bits of code that trip up LGTM #3136

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

Jump to bottom
Merged
merged 6 commits into from
Oct 11, 2018
Merged

Cleanup some bits of code that trip up LGTM #3136

merged 6 commits into from
Oct 11, 2018

Conversation

tautschnig
Copy link
Collaborator

Issues reported by Semmle's LGTM (https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).

  • Each commit message has a non-empty body, explaining why the change was made.
  • My contribution is formatted in line with CODING_STANDARD.md.
  • n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

smowton
smowton approved these changes Oct 10, 2018
View reviewed changes
Copy link
Contributor

@smowton smowton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM's suggestions LGTM

martin-cs
martin-cs approved these changes Oct 10, 2018
View reviewed changes
Copy link
Collaborator

@martin-cs martin-cs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah; I'm in.

src/goto-cc/linker_script_merge.cpp
j.object.find("size-symbol") != j.object.end() &&
j.object.find("end-symbol") == j.object.end() &&
j["size-symbol"].is_string()));
})));
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... I think there might be a few other issues with this bit of code ...

src/util/sharing_map.h
std::function<void(const key_type &k, const mapped_type &m)> f) const
{
typedef std::pair<unsigned, const baset *> stack_itemt;

std::stack<stack_itemt> stack;
stack.push({depth, &n});
stack.push({start_depth, &n});
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really the only place it is used?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be one for @danpoe to comment on? It was a bit of a guess that this one should be the input argument, while other uses of depth would refer to the variable declared locally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good to me

thk123
thk123 reviewed Oct 11, 2018
View reviewed changes
jbmc/unit/solvers/refinement/string_constraint_instantiation/instantiate_not_contains.cpp
@@ -100,13 +100,13 @@ std::set<exprt> full_index_set(const array_string_exprt &s)
}

/// Create the cartesian product of two sets.
template<class T, class U>
std::set<std::pair<T, U>> product(const std::set<T> ts, const std::set<U> us)
template <class X, class Y>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ What's the logic here?

Copy link
Contributor

@hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue Oct 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Template parameter types get renamed to match the name of the parameters to the function, makes sense to me. X and Y are more common for this sort of thing. Though I agree this doesn't seem to be an objective improvement. According to the commit message we have a global t somewhere though, so that's probably the reason.

(Looked it up now, apparently we have a test that used tt and t as global names - I think we should probably just fix that test...)

Copy link
Contributor

@thk123 thk123 Oct 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The t in instantiate_not_contains.cpp should just be made static right - that would fix this? This tool is super neat though!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's upset that var t and template parameter T are only distinguished by case

hannes-steffenhagen-diffblue
hannes-steffenhagen-diffblue approved these changes Oct 11, 2018
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tautschnig
Remove useless const on POD return-type
aeae851 
Reported by Semmle's LGTM
(https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).
@tautschnig
Catch by const-reference
3d4fc4e 
Reported by Semmle's LGTM
(https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).
@tautschnig
Rename local variable t shadowing a global one.
bbf2b4d 
Renamed template parameters as the chosen name did make a lot of sense in the
specific context.

Reported by Semmle's LGTM
(https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).
@tautschnig
Do not pass non-POD by value
ae6a1f4 
Reported by Semmle's LGTM
(https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).
@tautschnig
Reformat all_of statements according to clang-format's rules
bdbaf40 
This is a whitespace-only change.
@tautschnig
Do not shadow parameter by inner declaration
a02dbfd 
Reported by Semmle's LGTM
(https://lgtm.com/projects/g/diffblue/cbmc/alerts/?mode=list).
allredj
allredj reviewed Oct 11, 2018
View reviewed changes
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passed Diffblue compatibility checks (cbmc commit: a02dbfd).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/87644740

@tautschnig tautschnig merged commit da12819 into diffblue:develop Oct 11, 2018
@tautschnig tautschnig deleted the lgtm-cleanup branch October 11, 2018 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kroening kroening kroening approved these changes

@martin-cs martin-cs martin-cs approved these changes

@cesaro cesaro Awaiting requested review from cesaro

@cristina-david cristina-david Awaiting requested review from cristina-david

@NathanJPhillips NathanJPhillips Awaiting requested review from NathanJPhillips

@peterschrammel peterschrammel Awaiting requested review from peterschrammel peterschrammel is a code owner

@pkesseli pkesseli Awaiting requested review from pkesseli

+5 more reviewers

@smowton smowton smowton approved these changes

@thk123 thk123 thk123 left review comments

@danpoe danpoe danpoe left review comments

@allredj allredj allredj left review comments

@hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@tautschnig @smowton @thk123 @kroening @martin-cs @danpoe @allredj @hannes-steffenhagen-diffblue