/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying

   file LICENSE.rst or https://cmake.org/licensing for details.  */

#include "cmInstallCommandArguments.h"

#include <algorithm>

#include <functional>

#include <utility>

#include <cm/string_view>

#include <cmext/string_view>

#include "cmCMakePath.h"

#include "cmGeneratorExpression.h"

#include "cmMakefile.h"

#include "cmMessageType.h"

#include "cmPolicies.h"

#include "cmRange.h"

#include "cmStringAlgorithms.h"

#include "cmSystemTools.h"

// Table of valid permissions.

char const* cmInstallCommandArguments::PermissionsTable[] = {

  "OWNER_READ",    "OWNER_WRITE",   "OWNER_EXECUTE", "GROUP_READ",

  "GROUP_WRITE",   "GROUP_EXECUTE", "WORLD_READ",    "WORLD_WRITE",

  "WORLD_EXECUTE", "SETUID",        "SETGID",        nullptr

};

std::string const cmInstallCommandArguments::EmptyString;

cmInstallCommandArguments::cmInstallCommandArguments(

  std::string defaultComponent, cmMakefile& makefile)

  : DefaultComponentName(std::move(defaultComponent))

{

  std::function<ArgumentParser::Continue(cm::string_view)> normalizeDest;

  switch (makefile.GetPolicyStatus(cmPolicies::CMP0177)) {

    case cmPolicies::OLD:

      normalizeDest = [this](cm::string_view arg) -> ArgumentParser::Continue {

        this->Destination = std::string(arg.begin(), arg.end());

        return ArgumentParser::Continue::No;

      };

      break;

    case cmPolicies::WARN:

      normalizeDest =

        [this, &makefile](cm::string_view arg) -> ArgumentParser::Continue {

        this->Destination = std::string(arg.begin(), arg.end());

        // We can't be certain if a warning is appropriate if there are any

        // generator expressions

        if (cmGeneratorExpression::Find(arg) == cm::string_view::npos &&

            arg != cmCMakePath(arg).Normal().String()) {

          makefile.IssueMessage(

            MessageType::AUTHOR_WARNING,

            cmPolicies::GetPolicyWarning(cmPolicies::CMP0177));

        }

        return ArgumentParser::Continue::No;

      };

      break;

    case cmPolicies::NEW:

      normalizeDest = [this](cm::string_view arg) -> ArgumentParser::Continue {

        if (cmGeneratorExpression::Find(arg) == cm::string_view::npos) {

          this->Destination = cmCMakePath(arg).Normal().String();

        } else {

          this->Destination =

            cmStrCat("$<PATH:CMAKE_PATH,NORMALIZE,", arg, '>');

        }

        return ArgumentParser::Continue::No;

      };

      break;

  }

  this->Bind("DESTINATION"_s, normalizeDest);

  this->Bind("COMPONENT"_s, this->Component);

  this->Bind("NAMELINK_COMPONENT"_s, this->NamelinkComponent);

  this->Bind("EXCLUDE_FROM_ALL"_s, this->ExcludeFromAll);

  this->Bind("RENAME"_s, this->Rename);

  this->Bind("PERMISSIONS"_s, this->Permissions);

  this->Bind("CONFIGURATIONS"_s, this->Configurations);

  this->Bind("OPTIONAL"_s, this->Optional);

  this->Bind("NAMELINK_ONLY"_s, this->NamelinkOnly);

  this->Bind("NAMELINK_SKIP"_s, this->NamelinkSkip);

  this->Bind("TYPE"_s, this->Type);

}

std::string const& cmInstallCommandArguments::GetDestination() const

{

  if (!this->DestinationString.empty()) {

    return this->DestinationString;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetDestination();

  }

  return EmptyString;

}

std::string const& cmInstallCommandArguments::GetComponent() const

{

  if (!this->Component.empty()) {

    return this->Component;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetComponent();

  }

  if (!this->DefaultComponentName.empty()) {

    return this->DefaultComponentName;

  }

  static std::string unspecifiedComponent = "Unspecified";

  return unspecifiedComponent;

}

std::string const& cmInstallCommandArguments::GetNamelinkComponent() const

{

  if (!this->NamelinkComponent.empty()) {

    return this->NamelinkComponent;

  }

  return this->GetComponent();

}

std::string const& cmInstallCommandArguments::GetRename() const

{

  if (!this->Rename.empty()) {

    return this->Rename;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetRename();

  }

  return EmptyString;

}

std::string const& cmInstallCommandArguments::GetPermissions() const

{

  if (!this->PermissionsString.empty()) {

    return this->PermissionsString;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetPermissions();

  }

  return EmptyString;

}

bool cmInstallCommandArguments::GetOptional() const

{

  if (this->Optional) {

    return true;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetOptional();

  }

  return false;

}

bool cmInstallCommandArguments::GetExcludeFromAll() const

{

  if (this->ExcludeFromAll) {

    return true;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetExcludeFromAll();

  }

  return false;

}

bool cmInstallCommandArguments::GetNamelinkOnly() const

{

  if (this->NamelinkOnly) {

    return true;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetNamelinkOnly();

  }

  return false;

}

bool cmInstallCommandArguments::GetNamelinkSkip() const

{

  if (this->NamelinkSkip) {

    return true;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetNamelinkSkip();

  }

  return false;

}

bool cmInstallCommandArguments::HasNamelinkComponent() const

{

  if (!this->NamelinkComponent.empty()) {

    return true;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->HasNamelinkComponent();

  }

  return false;

}

std::string const& cmInstallCommandArguments::GetType() const

{

  return this->Type;

}

std::string const& cmInstallCommandArguments::GetDefaultComponent() const

{

  return this->DefaultComponentName;

}

std::vector<std::string> const& cmInstallCommandArguments::GetConfigurations()

  const

{

  if (!this->Configurations.empty()) {

    return this->Configurations;

  }

  if (this->GenericArguments) {

    return this->GenericArguments->GetConfigurations();

  }

  return this->Configurations;

}

bool cmInstallCommandArguments::Finalize()

{

  if (!this->CheckPermissions()) {

    return false;

  }

  this->DestinationString = this->Destination;

  cmSystemTools::ConvertToUnixSlashes(this->DestinationString);

  return true;

}

bool cmInstallCommandArguments::CheckPermissions()

{

  this->PermissionsString.clear();

  return std::all_of(this->Permissions.begin(), this->Permissions.end(),

                     [this](std::string const& perm) -> bool {

                       return cmInstallCommandArguments::CheckPermissions(

                         perm, this->PermissionsString);

                     });

}

bool cmInstallCommandArguments::CheckPermissions(

  std::string const& onePermission, std::string& permissions)

{

  // Check the permission against the table.

  for (char const** valid = cmInstallCommandArguments::PermissionsTable;

       *valid; ++valid) {

    if (onePermission == *valid) {

      // This is a valid permission.

      permissions += " ";

      permissions += onePermission;

      return true;

    }

  }

  // This is not a valid permission.

  return false;

}

cmInstallCommandIncludesArgument::cmInstallCommandIncludesArgument() = default;

std::vector<std::string> const&

cmInstallCommandIncludesArgument::GetIncludeDirs() const

{

  return this->IncludeDirs;

}

void cmInstallCommandIncludesArgument::Parse(

  std::vector<std::string> const* args, std::vector<std::string>*)

{

  if (args->empty()) {

    return;

  }

  for (std::string dir : cmMakeRange(*args).advance(1)) {

    cmSystemTools::ConvertToUnixSlashes(dir);

    this->IncludeDirs.push_back(std::move(dir));

  }

}

cmInstallCommandFileSetArguments::cmInstallCommandFileSetArguments(

  std::string defaultComponent, cmMakefile& makefile)

  : cmInstallCommandArguments(std::move(defaultComponent), makefile)

{

  this->Bind("FILE_SET"_s, this->FileSet);

}

void cmInstallCommandFileSetArguments::Parse(

  std::vector<std::string> args, std::vector<std::string>* unconsumedArgs)

{

  args.insert(args.begin(), "FILE_SET");

  this->cmInstallCommandArguments::Parse(args, unconsumedArgs);

}