123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
- file Copyright.txt or https://cmake.org/licensing for details. */
- #include "cmSetPropertyCommand.h"
- #include <sstream>
- #include "cmGlobalGenerator.h"
- #include "cmInstalledFile.h"
- #include "cmMakefile.h"
- #include "cmProperty.h"
- #include "cmSourceFile.h"
- #include "cmState.h"
- #include "cmSystemTools.h"
- #include "cmTarget.h"
- #include "cmTest.h"
- #include "cmake.h"
- class cmExecutionStatus;
- cmSetPropertyCommand::cmSetPropertyCommand()
- {
- this->AppendMode = false;
- this->AppendAsString = false;
- this->Remove = true;
- }
- bool cmSetPropertyCommand::InitialPass(std::vector<std::string> const& args,
- cmExecutionStatus&)
- {
- if (args.size() < 2) {
- this->SetError("called with incorrect number of arguments");
- return false;
- }
- // Get the scope on which to set the property.
- std::vector<std::string>::const_iterator arg = args.begin();
- cmProperty::ScopeType scope;
- if (*arg == "GLOBAL") {
- scope = cmProperty::GLOBAL;
- } else if (*arg == "DIRECTORY") {
- scope = cmProperty::DIRECTORY;
- } else if (*arg == "TARGET") {
- scope = cmProperty::TARGET;
- } else if (*arg == "SOURCE") {
- scope = cmProperty::SOURCE_FILE;
- } else if (*arg == "TEST") {
- scope = cmProperty::TEST;
- } else if (*arg == "CACHE") {
- scope = cmProperty::CACHE;
- } else if (*arg == "INSTALL") {
- scope = cmProperty::INSTALL;
- } else {
- std::ostringstream e;
- e << "given invalid scope " << *arg << ". "
- << "Valid scopes are GLOBAL, DIRECTORY, "
- "TARGET, SOURCE, TEST, CACHE, INSTALL.";
- this->SetError(e.str());
- return false;
- }
- // Parse the rest of the arguments up to the values.
- enum Doing
- {
- DoingNone,
- DoingNames,
- DoingProperty,
- DoingValues
- };
- Doing doing = DoingNames;
- const char* sep = "";
- for (++arg; arg != args.end(); ++arg) {
- if (*arg == "PROPERTY") {
- doing = DoingProperty;
- } else if (*arg == "APPEND") {
- doing = DoingNone;
- this->AppendMode = true;
- this->Remove = false;
- this->AppendAsString = false;
- } else if (*arg == "APPEND_STRING") {
- doing = DoingNone;
- this->AppendMode = true;
- this->Remove = false;
- this->AppendAsString = true;
- } else if (doing == DoingNames) {
- this->Names.insert(*arg);
- } else if (doing == DoingProperty) {
- this->PropertyName = *arg;
- doing = DoingValues;
- } else if (doing == DoingValues) {
- this->PropertyValue += sep;
- sep = ";";
- this->PropertyValue += *arg;
- this->Remove = false;
- } else {
- std::ostringstream e;
- e << "given invalid argument \"" << *arg << "\".";
- this->SetError(e.str());
- return false;
- }
- }
- // Make sure a property name was found.
- if (this->PropertyName.empty()) {
- this->SetError("not given a PROPERTY <name> argument.");
- return false;
- }
- // Dispatch property setting.
- switch (scope) {
- case cmProperty::GLOBAL:
- return this->HandleGlobalMode();
- case cmProperty::DIRECTORY:
- return this->HandleDirectoryMode();
- case cmProperty::TARGET:
- return this->HandleTargetMode();
- case cmProperty::SOURCE_FILE:
- return this->HandleSourceMode();
- case cmProperty::TEST:
- return this->HandleTestMode();
- case cmProperty::CACHE:
- return this->HandleCacheMode();
- case cmProperty::INSTALL:
- return this->HandleInstallMode();
- case cmProperty::VARIABLE:
- case cmProperty::CACHED_VARIABLE:
- break; // should never happen
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleGlobalMode()
- {
- if (!this->Names.empty()) {
- this->SetError("given names for GLOBAL scope.");
- return false;
- }
- // Set or append the property.
- cmake* cm = this->Makefile->GetCMakeInstance();
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- value = nullptr;
- }
- if (this->AppendMode) {
- cm->AppendProperty(name, value ? value : "", this->AppendAsString);
- } else {
- cm->SetProperty(name, value);
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleDirectoryMode()
- {
- if (this->Names.size() > 1) {
- this->SetError("allows at most one name for DIRECTORY scope.");
- return false;
- }
- // Default to the current directory.
- cmMakefile* mf = this->Makefile;
- // Lookup the directory if given.
- if (!this->Names.empty()) {
- // Construct the directory name. Interpret relative paths with
- // respect to the current directory.
- std::string dir = *this->Names.begin();
- if (!cmSystemTools::FileIsFullPath(dir)) {
- dir = this->Makefile->GetCurrentSourceDirectory();
- dir += "/";
- dir += *this->Names.begin();
- }
- // The local generators are associated with collapsed paths.
- dir = cmSystemTools::CollapseFullPath(dir);
- mf = this->Makefile->GetGlobalGenerator()->FindMakefile(dir);
- if (!mf) {
- // Could not find the directory.
- this->SetError(
- "DIRECTORY scope provided but requested directory was not found. "
- "This could be because the directory argument was invalid or, "
- "it is valid but has not been processed yet.");
- return false;
- }
- }
- // Set or append the property.
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- value = nullptr;
- }
- if (this->AppendMode) {
- mf->AppendProperty(name, value ? value : "", this->AppendAsString);
- } else {
- mf->SetProperty(name, value);
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleTargetMode()
- {
- for (std::string const& name : this->Names) {
- if (this->Makefile->IsAlias(name)) {
- this->SetError("can not be used on an ALIAS target.");
- return false;
- }
- if (cmTarget* target = this->Makefile->FindTargetToUse(name)) {
- // Handle the current target.
- if (!this->HandleTarget(target)) {
- return false;
- }
- } else {
- std::ostringstream e;
- e << "could not find TARGET " << name
- << ". Perhaps it has not yet been created.";
- this->SetError(e.str());
- return false;
- }
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleTarget(cmTarget* target)
- {
- // Set or append the property.
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- value = nullptr;
- }
- if (this->AppendMode) {
- target->AppendProperty(name, value, this->AppendAsString);
- } else {
- target->SetProperty(name, value);
- }
- // Check the resulting value.
- target->CheckProperty(name, this->Makefile);
- return true;
- }
- bool cmSetPropertyCommand::HandleSourceMode()
- {
- for (std::string const& name : this->Names) {
- // Get the source file.
- if (cmSourceFile* sf = this->Makefile->GetOrCreateSource(name)) {
- if (!this->HandleSource(sf)) {
- return false;
- }
- } else {
- std::ostringstream e;
- e << "given SOURCE name that could not be found or created: " << name;
- this->SetError(e.str());
- return false;
- }
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleSource(cmSourceFile* sf)
- {
- // Set or append the property.
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- value = nullptr;
- }
- if (this->AppendMode) {
- sf->AppendProperty(name, value, this->AppendAsString);
- } else {
- sf->SetProperty(name, value);
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleTestMode()
- {
- // Look for tests with all names given.
- std::set<std::string>::iterator next;
- for (std::set<std::string>::iterator ni = this->Names.begin();
- ni != this->Names.end(); ni = next) {
- next = ni;
- ++next;
- if (cmTest* test = this->Makefile->GetTest(*ni)) {
- if (this->HandleTest(test)) {
- this->Names.erase(ni);
- } else {
- return false;
- }
- }
- }
- // Names that are still left were not found.
- if (!this->Names.empty()) {
- std::ostringstream e;
- e << "given TEST names that do not exist:\n";
- for (std::string const& name : this->Names) {
- e << " " << name << "\n";
- }
- this->SetError(e.str());
- return false;
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleTest(cmTest* test)
- {
- // Set or append the property.
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- value = nullptr;
- }
- if (this->AppendMode) {
- test->AppendProperty(name, value, this->AppendAsString);
- } else {
- test->SetProperty(name, value);
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleCacheMode()
- {
- if (this->PropertyName == "ADVANCED") {
- if (!this->Remove && !cmSystemTools::IsOn(this->PropertyValue.c_str()) &&
- !cmSystemTools::IsOff(this->PropertyValue.c_str())) {
- std::ostringstream e;
- e << "given non-boolean value \"" << this->PropertyValue
- << "\" for CACHE property \"ADVANCED\". ";
- this->SetError(e.str());
- return false;
- }
- } else if (this->PropertyName == "TYPE") {
- if (!cmState::IsCacheEntryType(this->PropertyValue)) {
- std::ostringstream e;
- e << "given invalid CACHE entry TYPE \"" << this->PropertyValue << "\"";
- this->SetError(e.str());
- return false;
- }
- } else if (this->PropertyName != "HELPSTRING" &&
- this->PropertyName != "STRINGS" &&
- this->PropertyName != "VALUE") {
- std::ostringstream e;
- e << "given invalid CACHE property " << this->PropertyName << ". "
- << "Settable CACHE properties are: "
- << "ADVANCED, HELPSTRING, STRINGS, TYPE, and VALUE.";
- this->SetError(e.str());
- return false;
- }
- for (std::string const& name : this->Names) {
- // Get the source file.
- cmMakefile* mf = this->GetMakefile();
- cmake* cm = mf->GetCMakeInstance();
- const char* existingValue = cm->GetState()->GetCacheEntryValue(name);
- if (existingValue) {
- if (!this->HandleCacheEntry(name)) {
- return false;
- }
- } else {
- std::ostringstream e;
- e << "could not find CACHE variable " << name
- << ". Perhaps it has not yet been created.";
- this->SetError(e.str());
- return false;
- }
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleCacheEntry(std::string const& cacheKey)
- {
- // Set or append the property.
- std::string const& name = this->PropertyName;
- const char* value = this->PropertyValue.c_str();
- cmState* state = this->Makefile->GetState();
- if (this->Remove) {
- state->RemoveCacheEntryProperty(cacheKey, name);
- }
- if (this->AppendMode) {
- state->AppendCacheEntryProperty(cacheKey, name, value,
- this->AppendAsString);
- } else {
- state->SetCacheEntryProperty(cacheKey, name, value);
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleInstallMode()
- {
- cmake* cm = this->Makefile->GetCMakeInstance();
- for (std::string const& name : this->Names) {
- if (cmInstalledFile* file =
- cm->GetOrCreateInstalledFile(this->Makefile, name)) {
- if (!this->HandleInstall(file)) {
- return false;
- }
- } else {
- std::ostringstream e;
- e << "given INSTALL name that could not be found or created: " << name;
- this->SetError(e.str());
- return false;
- }
- }
- return true;
- }
- bool cmSetPropertyCommand::HandleInstall(cmInstalledFile* file)
- {
- // Set or append the property.
- std::string const& name = this->PropertyName;
- cmMakefile* mf = this->Makefile;
- const char* value = this->PropertyValue.c_str();
- if (this->Remove) {
- file->RemoveProperty(name);
- } else if (this->AppendMode) {
- file->AppendProperty(mf, name, value, this->AppendAsString);
- } else {
- file->SetProperty(mf, name, value);
- }
- return true;
- }
|