/*

  This file is part of solidity.

  solidity is free software: you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  solidity is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License

  along with solidity.  If not, see <http://www.gnu.org/licenses/>.

*/

// SPDX-License-Identifier: GPL-3.0

/**

 * Handles selections of debug info components.

 */

#pragma once

#include <map>

#include <optional>

#include <ostream>

#include <string>

#include <string_view>

#include <vector>

namespace solidity::langutil

{

/**

 * Represents a set of flags corresponding to components of debug info selected for some purpose.

 *

 * Provides extra functionality for enumerating the components and serializing/deserializing the

 * selection to/from a comma-separated string.

 */

struct DebugInfoSelection

{

  static DebugInfoSelection const All(bool _value = true) noexcept;

  static DebugInfoSelection const None() noexcept { return All(false); }

  static DebugInfoSelection const Only(bool DebugInfoSelection::* _member) noexcept;

  static DebugInfoSelection const Default() noexcept { return AllExceptExperimental(); }

  static DebugInfoSelection const AllExcept(std::vector<bool DebugInfoSelection::*> const& _members) noexcept;

  static DebugInfoSelection const AllExceptExperimental() noexcept { return AllExcept({&DebugInfoSelection::ethdebug}); }

  static std::optional<DebugInfoSelection> fromString(std::string_view _input);

  static std::optional<DebugInfoSelection> fromComponents(

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

    bool _acceptWildcards = false

  );

  bool enable(std::string const& _component);

  bool all() const noexcept;

  bool any() const noexcept;

  bool none() const noexcept { return !any(); }

  bool only(bool DebugInfoSelection::* _member) const noexcept { return *this == Only(_member); }

  DebugInfoSelection& operator&=(DebugInfoSelection const& _other);

  DebugInfoSelection& operator|=(DebugInfoSelection const& _other);

  DebugInfoSelection operator&(DebugInfoSelection _other) const noexcept;

  DebugInfoSelection operator|(DebugInfoSelection _other) const noexcept;

  bool operator!=(DebugInfoSelection const& _other) const noexcept { return !(*this == _other); }

  bool operator==(DebugInfoSelection const& _other) const noexcept;

  friend std::ostream& operator<<(std::ostream& _stream, DebugInfoSelection const& _selection);

  static auto const& componentMap()

  {

    static std::map<std::string, bool DebugInfoSelection::*> const components = {

      {"location", &DebugInfoSelection::location},

      {"snippet", &DebugInfoSelection::snippet},

      {"ast-id", &DebugInfoSelection::astID},

      {"ethdebug", &DebugInfoSelection::ethdebug},

    };

    return components;

  }

  std::vector<std::string> selectedNames() const

  {

    std::vector<std::string> result;

    for (auto const& component: componentMap())

      if (this->*(component.second))

        result.push_back(component.first);

    return result;

  }

  bool location = false; ///< Include source location. E.g. `@src 3:50:100`

  bool snippet = false;  ///< Include source code snippet next to location. E.g. `@src 3:50:100 "contract C {..."`

  bool astID = false;    ///< Include ID of the Solidity AST node. E.g. `@ast-id 15`

  bool ethdebug = false; ///< Include ethdebug related debug information.

};

std::ostream& operator<<(std::ostream& _stream, DebugInfoSelection const& _selection);

}