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

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

#pragma once

#include "cmConfigure.h" // IWYU pragma: keep

#include <ostream>

#include <string>

#include <vector>

#include <cm/string_view>

class cmScriptGeneratorIndent

{

public:

  cmScriptGeneratorIndent() = default;

  cmScriptGeneratorIndent(int level)

    : Level(level)

  {

  }

  void Write(std::ostream& os) const

  {

    for (int i = 0; i < this->Level; ++i) {

      os << " ";

    }

  }

  cmScriptGeneratorIndent Next(int step = 2) const

  {

    return { this->Level + step };

  }

private:

  int Level = 0;

};

inline std::ostream& operator<<(std::ostream& os,

                                cmScriptGeneratorIndent indent)

{

  indent.Write(os);

  return os;

}

class cmScriptGeneratorQuoted

{

public:

  cmScriptGeneratorQuoted(cm::string_view value, int bracket_length)

    : Value(value)

    , BracketLength(bracket_length)

  {

  }

  std::string str() const;

  operator std::string() const { return str(); }

private:

  friend std::ostream& operator<<(std::ostream& os,

                                  cmScriptGeneratorQuoted const& self);

  cm::string_view Value;

  int BracketLength;

};

/** \class cmScriptGenerator

 * \brief Support class for generating install and test scripts.

 *

 */

class cmScriptGenerator

{

public:

  cmScriptGenerator(std::string config_var,

                    std::vector<std::string> configurations);

  virtual ~cmScriptGenerator();

  cmScriptGenerator(cmScriptGenerator const&) = delete;

  cmScriptGenerator& operator=(cmScriptGenerator const&) = delete;

  void Generate(std::ostream& os, std::string const& config,

                std::vector<std::string> const& configurationTypes);

  static cmScriptGeneratorQuoted Quote(cm::string_view value);

  static std::string CreateConfigTest(std::string const& configVar,

                                      std::string const& config);

  static std::string CreateConfigTest(std::string const& configVar,

                                      std::vector<std::string> const& configs);

protected:

  using Indent = cmScriptGeneratorIndent;

  virtual void GenerateScript(std::ostream& os);

  virtual void GenerateScriptConfigs(std::ostream& os, Indent indent);

  virtual void GenerateScriptActions(std::ostream& os, Indent indent);

  virtual void GenerateScriptForConfig(std::ostream& os,

                                       std::string const& config,

                                       Indent indent);

  virtual void GenerateScriptNoConfig(std::ostream&, Indent) {}

  virtual bool NeedsScriptNoConfig() const { return false; }

  // Test if this generator does something for a given configuration.

  bool GeneratesForConfig(std::string const&);

  std::string CreateConfigTest(std::string const& config);

  std::string CreateConfigTest(std::vector<std::string> const& configs);

  std::string CreateComponentTest(std::string const& component);

  // Information shared by most generator types.

  std::string RuntimeConfigVariable;

  std::vector<std::string> const Configurations;

  // Information used during generation.

  std::string ConfigurationName;

  std::vector<std::string> const* ConfigurationTypes = nullptr;

  // True if the subclass needs to generate an explicit rule for each

  // configuration.  False if the subclass only generates one rule for

  // all enabled configurations.

  bool ActionsPerConfig = false;

private:

  void GenerateScriptActionsOnce(std::ostream& os, Indent indent);

  void GenerateScriptActionsPerConfig(std::ostream& os, Indent indent);

};