/*

  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

/**

 * Yul code and data object container.

 */

#pragma once

#include <libyul/ASTForward.h>

#include <libyul/AsmPrinter.h>

#include <libevmasm/SubAssemblyID.h>

#include <liblangutil/CharStreamProvider.h>

#include <liblangutil/DebugInfoSelection.h>

#include <libsolutil/Common.h>

#include <libsolutil/JSON.h>

#include <memory>

#include <set>

#include <limits>

namespace solidity::yul

{

class Dialect;

struct AsmAnalysisInfo;

using SourceNameMap = std::map<unsigned, std::shared_ptr<std::string const>>;

class Object;

/**

 * Generic base class for both Yul objects and Yul data.

 */

struct ObjectNode

{

  virtual ~ObjectNode() = default;

  /// Name of the object.

  /// Can be empty since .yul files can also just contain code, without explicitly placing it in an object.

  std::string name;

  virtual std::string toString(

    langutil::DebugInfoSelection const& _debugInfoSelection,

    langutil::CharStreamProvider const* _soliditySourceProvider

  ) const = 0;

  virtual Json toJson() const = 0;

};

/**

 * Named data in Yul objects.

 */

struct Data: public ObjectNode

{

  Data(std::string _name, bytes _data): data(std::move(_data)) { name = _name; }

  bytes data;

  std::string toString(

    langutil::DebugInfoSelection const& _debugInfoSelection,

    langutil::CharStreamProvider const* _soliditySourceProvider

  ) const override;

  Json toJson() const override;

};

struct ObjectDebugData

{

  std::optional<SourceNameMap> sourceNames = {};

  std::string formatUseSrcComment() const;

};

/**

 * Yul code and data object container.

 */

class Object: public ObjectNode

{

public:

  /// @returns a (parseable) string representation.

  std::string toString(

    langutil::DebugInfoSelection const& _debugInfoSelection = langutil::DebugInfoSelection::Default(),

    langutil::CharStreamProvider const* _soliditySourceProvider = nullptr

  ) const override;

  /// @returns a compact JSON representation of the AST.

  Json toJson() const override;

  /// Summarizes the structure of the subtree rooted at a given object,

  /// in particular the paths that can be used from within to refer to nested nodes (objects and data).

  struct Structure

  {

    /// The name of the object

    std::string objectName;

    /// Available dot-separated paths to nested objects (relative to current object).

    std::set<std::string> objectPaths;

    /// Available dot-separated paths to nested data entries (relative to current object).

    std::set<std::string> dataPaths;

    /// Checks if a path is available.

    bool contains(std::string const& _path) const { return containsObject(_path) || containsData(_path); }

    /// Checks if a path is available and leads to an object.

    bool containsObject(std::string const& _path) const { return objectPaths.count(_path) > 0; }

    /// Checks if a path is available and leads to a data entry.

    bool containsData(std::string const& _path) const { return dataPaths.count(_path) > 0; }

    std::set<std::string> topLevelSubObjectNames() const;

  };

  /// @returns the set of names of data objects accessible from within the code of

  /// this object, including the name of object itself

  /// Handles all names containing dots as reserved identifiers, not accessible as data.

  Structure summarizeStructure() const;

  /// @returns vector of subIDs if possible to reach subobject with @a _qualifiedName, throws otherwise

  /// For "B.C" should return vector of two values if success (subId of B and subId of C in B).

  /// In object "A" if called for "A.B" will return only one value (subId for B)

  /// will return empty vector for @a _qualifiedName that equals to object name.

  /// Example:

  /// A1{ B2{ C3, D3 }, E2{ F3{ G4, K4, H4{ I5 } } } }

  /// pathToSubObject("A1.E2.F3.H4") == {1, 0, 2}

  /// pathToSubObject("E2.F3.H4") == {1, 0, 2}

  /// pathToSubObject("A1.E2") == {1}

  /// The path must not lead to a @a Data object (will throw in that case).

  std::vector<evmasm::SubAssemblyID> pathToSubObject(std::string_view _qualifiedName) const;

  std::shared_ptr<AST const> code() const;

  void setCode(std::shared_ptr<AST const> const& _ast, std::shared_ptr<yul::AsmAnalysisInfo> = nullptr);

  bool hasCode() const;

  /// sub id for object if it is subobject of another object, max value / empty if it is not subobject

  evmasm::SubAssemblyID subId{};

  std::vector<std::shared_ptr<ObjectNode>> subObjects;

  std::map<std::string, size_t, std::less<>> subIndexByName;

  std::shared_ptr<yul::AsmAnalysisInfo> analysisInfo;

  std::shared_ptr<ObjectDebugData const> debugData;

  /// Collects names of all Solidity source units present in the debug data

  /// of the Yul object (including sub-objects) and their assigned indices.

  /// @param _indices map that will be filled with source indices of the current Yul object & its sub-objects.

  void collectSourceIndices(std::map<std::string, unsigned>& _indices) const;

  /// @returns true, if the range of source indices starts at zero and is contiguous, false otherwise.

  bool hasContiguousSourceIndices() const;

  /// @returns the name of the special metadata data object.

  static std::string metadataName() { return ".metadata"; }

  Dialect const* dialect() const;

private:

  std::shared_ptr<AST const> m_code;

};

}