Skip to content

chore: add [[nodiscard]] attribute to relevant methods for better optimization and added std::move where needed #299

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
Daan Timmer (daantimmer) merged 1 commit into from
Mar 10, 2026
Merged

chore: add [[nodiscard]] attribute to relevant methods for better optimization and added std::move where needed #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
98 changes: 49 additions & 49 deletions cucumber_cpp/library/query/Query.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ namespace cucumber_cpp::library::query
{
struct Lineage
{
std::string GetUniqueFeatureName() const;
std::string GetScenarioAndOrRuleName() const;
[[nodiscard]] std::string GetUniqueFeatureName() const;
[[nodiscard]] std::string GetScenarioAndOrRuleName() const;

std::shared_ptr<const cucumber::messages::gherkin_document> gherkinDocument;
std::shared_ptr<const cucumber::messages::feature> feature;
Expand All @@ -65,44 +65,44 @@ namespace cucumber_cpp::library::query

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::gherkin_document> gherkinDocument)
{
lineage.gherkinDocument = gherkinDocument;
return std::move(lineage);
lineage.gherkinDocument = std::move(gherkinDocument);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::feature> feature)
{
lineage.feature = feature;
return std::move(lineage);
lineage.feature = std::move(feature);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::rule> rule)
{
lineage.rule = rule;
return std::move(lineage);
lineage.rule = std::move(rule);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::scenario> scenario)
{
lineage.scenario = scenario;
return std::move(lineage);
lineage.scenario = std::move(scenario);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::examples> examples)
{
lineage.examples = examples;
return std::move(lineage);
lineage.examples = std::move(examples);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::shared_ptr<const cucumber::messages::table_row> tableRow)
{
lineage.tableRow = tableRow;
return std::move(lineage);
lineage.tableRow = std::move(tableRow);
return lineage;
}

friend Lineage operator+(Lineage lineage, std::uint32_t featureIndex)
{
lineage.featureIndex = featureIndex;
return std::move(lineage);
return lineage;
}
};

Expand All @@ -117,61 +117,61 @@ namespace cucumber_cpp::library::query
{
explicit Query(util::Broadcaster& broadcaster);

auto GetPickles() const
[[nodiscard]] auto GetPickles() const
{
return pickleById | std::views::values;
}

const Lineage& FindLineageByPickle(const cucumber::messages::pickle& pickle) const;
const Lineage& FindLineageByUri(const std::string&) const;
[[nodiscard]] const Lineage& FindLineageByPickle(const cucumber::messages::pickle& pickle) const;
[[nodiscard]] const Lineage& FindLineageByUri(const std::string&) const;

const cucumber::messages::parameter_type& FindParameterTypeById(const std::string& id) const;
const cucumber::messages::parameter_type& FindParameterTypeByName(const std::string& name) const;
bool ContainsParameterTypeByName(const std::string& name) const;
[[nodiscard]] const cucumber::messages::parameter_type& FindParameterTypeById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::parameter_type& FindParameterTypeByName(const std::string& name) const;
[[nodiscard]] bool ContainsParameterTypeByName(const std::string& name) const;

const cucumber::messages::test_case& FindTestCaseBy(const cucumber::messages::test_case_started& testCaseStarted) const;
const cucumber::messages::test_case& FindTestCaseById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::test_case& FindTestCaseBy(const cucumber::messages::test_case_started& testCaseStarted) const;
[[nodiscard]] const cucumber::messages::test_case& FindTestCaseById(const std::string& id) const;

const cucumber::messages::pickle& FindPickleBy(const cucumber::messages::test_case_started& testCaseStarted) const;
const cucumber::messages::pickle& FindPickleById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::pickle& FindPickleBy(const cucumber::messages::test_case_started& testCaseStarted) const;
[[nodiscard]] const cucumber::messages::pickle& FindPickleById(const std::string& id) const;

const cucumber::messages::pickle_step* FindPickleStepBy(const cucumber::messages::test_step& testStep) const;
const cucumber::messages::pickle_step& FindPickleStepById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::pickle_step* FindPickleStepBy(const cucumber::messages::test_step& testStep) const;
[[nodiscard]] const cucumber::messages::pickle_step& FindPickleStepById(const std::string& id) const;

const cucumber::messages::test_step& FindTestStepBy(const cucumber::messages::test_step_finished& testStepFinished) const;
[[nodiscard]] const cucumber::messages::test_step& FindTestStepBy(const cucumber::messages::test_step_finished& testStepFinished) const;

const cucumber::messages::step& FindStepBy(const cucumber::messages::pickle_step& pickleStep) const;
[[nodiscard]] const cucumber::messages::step& FindStepBy(const cucumber::messages::pickle_step& pickleStep) const;

const cucumber::messages::step_definition& FindStepDefinitionById(const std::string& id) const;
std::list<const cucumber::messages::step_definition*> FindStepDefinitionsById(const cucumber::messages::test_step& testStep) const;
[[nodiscard]] const cucumber::messages::step_definition& FindStepDefinitionById(const std::string& id) const;
[[nodiscard]] std::list<const cucumber::messages::step_definition*> FindStepDefinitionsById(const cucumber::messages::test_step& testStep) const;

const cucumber::messages::hook& FindHookById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::hook& FindHookById(const std::string& id) const;

std::optional<cucumber::messages::location> FindLocationOf(const cucumber::messages::pickle& pickle) const;
[[nodiscard]] std::optional<cucumber::messages::location> FindLocationOf(const cucumber::messages::pickle& pickle) const;

const cucumber::messages::test_case_started& FindTestCaseStartedById(const std::string& id) const;
[[nodiscard]] const cucumber::messages::test_case_started& FindTestCaseStartedById(const std::string& id) const;

const std::map<std::string, cucumber::messages::step_definition, std::less<>>& StepDefinitions() const;
const std::map<std::string, cucumber::messages::test_case_started, std::less<>>& TestCaseStarted() const;
const std::map<std::string, cucumber::messages::test_case_finished, std::less<>>& TestCaseFinishedByTestCaseStartedId() const;
[[nodiscard]] const std::map<std::string, cucumber::messages::step_definition, std::less<>>& StepDefinitions() const;
[[nodiscard]] const std::map<std::string, cucumber::messages::test_case_started, std::less<>>& TestCaseStarted() const;
[[nodiscard]] const std::map<std::string, cucumber::messages::test_case_finished, std::less<>>& TestCaseFinishedByTestCaseStartedId() const;

std::size_t CountTestCasesStarted() const;
[[nodiscard]] std::size_t CountTestCasesStarted() const;

std::map<cucumber::messages::test_step_result_status, std::size_t, std::less<>> CountMostSevereTestStepResultStatus() const;
std::optional<const cucumber::messages::test_step_result*> FindMostSevereTestStepResultBy(const cucumber::messages::test_case_started& testCaseStarted) const;
std::optional<const cucumber::messages::test_step_result*> FindMostSevereTestStepResultBy(const cucumber::messages::test_case_finished& testCaseFinished) const;
[[nodiscard]] std::map<cucumber::messages::test_step_result_status, std::size_t, std::less<>> CountMostSevereTestStepResultStatus() const;
[[nodiscard]] std::optional<const cucumber::messages::test_step_result*> FindMostSevereTestStepResultBy(const cucumber::messages::test_case_started& testCaseStarted) const;
[[nodiscard]] std::optional<const cucumber::messages::test_step_result*> FindMostSevereTestStepResultBy(const cucumber::messages::test_case_finished& testCaseFinished) const;

std::list<const cucumber::messages::test_case_started*> FindAllTestCaseStarted() const;
std::list<std::pair<const cucumber::messages::test_step_finished*, const cucumber::messages::test_step*>> FindTestStepFinishedAndTestStepBy(const cucumber::messages::test_case_started& testCaseStarted) const;
[[nodiscard]] std::list<const cucumber::messages::test_case_started*> FindAllTestCaseStarted() const;
[[nodiscard]] std::list<std::pair<const cucumber::messages::test_step_finished*, const cucumber::messages::test_step*>> FindTestStepFinishedAndTestStepBy(const cucumber::messages::test_case_started& testCaseStarted) const;

const cucumber::messages::test_run_started& FindTestRunStarted() const;
cucumber::messages::duration FindTestRunDuration() const;
[[nodiscard]] const cucumber::messages::test_run_started& FindTestRunStarted() const;
[[nodiscard]] cucumber::messages::duration FindTestRunDuration() const;

cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_started& testCaseStarted) const;
cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_finished& testCaseFinished) const;
cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_started& testCaseStarted, const cucumber::messages::test_case_finished& testCaseFinished) const;
[[nodiscard]] cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_started& testCaseStarted) const;
[[nodiscard]] cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_finished& testCaseFinished) const;
[[nodiscard]] cucumber::messages::duration FindTestCaseDurationBy(const cucumber::messages::test_case_started& testCaseStarted, const cucumber::messages::test_case_finished& testCaseFinished) const;

cucumber::messages::duration FindTestStepDurationByTestStepId(const std::string& testStepId) const;
[[nodiscard]] cucumber::messages::duration FindTestStepDurationByTestStepId(const std::string& testStepId) const;

private:
void operator+=(const cucumber::messages::envelope& envelope);
Expand Down
Loading