cmake: Remove force from IssueMessage API

The force parameter is ugly and makes the method harder to reason about
(issues the message ... but maybe it doesn't ... but then again you can
force it).  It is a violation of

 https://en.wikipedia.org/wiki/Interface_segregation_principle

and is the kind of thing described in a recent blog here:

 http://code.joejag.com/2016/anti-if-the-missing-patterns.html

 "Any time you see this you actually have two methods bundled into one.
  That boolean represents an opportunity to name a concept in your code."
This commit is contained in:
Stephen Kelly 2016-06-09 09:57:47 +02:00
parent 54c65d5fb2
commit 23f87e8157
5 changed files with 15 additions and 18 deletions

View File

@ -105,8 +105,8 @@ cmMakefile::~cmMakefile()
cmDeleteAll(this->EvaluationFiles); cmDeleteAll(this->EvaluationFiles);
} }
void cmMakefile::IssueMessage(cmake::MessageType t, std::string const& text, void cmMakefile::IssueMessage(cmake::MessageType t,
bool force) const std::string const& text) const
{ {
// Collect context information. // Collect context information.
if (!this->ExecutionStatusStack.empty()) { if (!this->ExecutionStatusStack.empty()) {
@ -114,7 +114,7 @@ void cmMakefile::IssueMessage(cmake::MessageType t, std::string const& text,
this->ExecutionStatusStack.back()->SetNestedError(true); this->ExecutionStatusStack.back()->SetNestedError(true);
} }
} }
this->GetCMakeInstance()->IssueMessage(t, text, this->GetBacktrace(), force); this->GetCMakeInstance()->IssueMessage(t, text, this->GetBacktrace());
} }
cmStringRange cmMakefile::GetIncludeDirectoriesEntries() const cmStringRange cmMakefile::GetIncludeDirectoriesEntries() const

View File

@ -715,8 +715,7 @@ public:
cmMakefile* Makefile; cmMakefile* Makefile;
}; };
void IssueMessage(cmake::MessageType t, std::string const& text, void IssueMessage(cmake::MessageType t, std::string const& text) const;
bool force = false) const;
/** Set whether or not to report a CMP0000 violation. */ /** Set whether or not to report a CMP0000 violation. */
void SetCheckCMP0000(bool b) { this->CheckCMP0000 = b; } void SetCheckCMP0000(bool b) { this->CheckCMP0000 = b; }

View File

@ -63,8 +63,9 @@ bool cmMessageCommand::InitialPass(std::vector<std::string> const& args,
std::string message = cmJoin(cmMakeRange(i, args.end()), std::string()); std::string message = cmJoin(cmMakeRange(i, args.end()), std::string());
if (type != cmake::MESSAGE) { if (type != cmake::MESSAGE) {
// we've overriden the message type, above, so force IssueMessage to use it // we've overriden the message type, above, so display it directly
this->Makefile->IssueMessage(type, message, true); cmake* cm = this->Makefile->GetCMakeInstance();
cm->DisplayMessage(type, message, this->Makefile->GetBacktrace());
} else { } else {
if (status) { if (status) {
this->Makefile->DisplayStatus(message.c_str(), -1); this->Makefile->DisplayStatus(message.c_str(), -1);

View File

@ -2294,16 +2294,14 @@ void displayMessage(cmake::MessageType t, std::ostringstream& msg)
} }
void cmake::IssueMessage(cmake::MessageType t, std::string const& text, void cmake::IssueMessage(cmake::MessageType t, std::string const& text,
cmListFileBacktrace const& backtrace, cmListFileBacktrace const& backtrace) const
bool force) const
{ {
if (!force) { bool force = false;
// override the message type, if needed, for warnings and errors // override the message type, if needed, for warnings and errors
cmake::MessageType override = this->ConvertMessageType(t); cmake::MessageType override = this->ConvertMessageType(t);
if (override != t) { if (override != t) {
t = override; t = override;
force = true; force = true;
}
} }
if (!force && !this->IsMessageTypeVisible(t)) { if (!force && !this->IsMessageTypeVisible(t)) {

View File

@ -381,8 +381,7 @@ public:
/** Display a message to the user. */ /** Display a message to the user. */
void IssueMessage( void IssueMessage(
cmake::MessageType t, std::string const& text, cmake::MessageType t, std::string const& text,
cmListFileBacktrace const& backtrace = cmListFileBacktrace(), cmListFileBacktrace const& backtrace = cmListFileBacktrace()) const;
bool force = false) const;
void DisplayMessage(cmake::MessageType t, std::string const& text, void DisplayMessage(cmake::MessageType t, std::string const& text,
cmListFileBacktrace const& backtrace) const; cmListFileBacktrace const& backtrace) const;