/*

  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

#pragma once

#include <libsolidity/experimental/ast/TypeSystem.h>

#include <cstdint>

#include <memory>

#include <vector>

namespace solidity::frontend

{

class SourceUnit;

class ASTNode;

}

namespace solidity::langutil

{

class ErrorReporter;

}

namespace solidity::frontend::experimental

{

class TypeSystem;

class Analysis;

namespace detail

{

template<typename Step>

struct AnnotationFetcher

{

  Analysis& analysis;

  typename Step::Annotation& get(ASTNode const& _node);

  typename Step::GlobalAnnotation& get();

};

template<typename Step>

struct ConstAnnotationFetcher

{

  Analysis const& analysis;

  typename Step::Annotation const& get(ASTNode const& _node) const;

  typename Step::GlobalAnnotation const& get() const;

};

}

class Analysis

{

  struct AnnotationContainer;

  struct GlobalAnnotationContainer;

public:

  Analysis(langutil::ErrorReporter& _errorReporter, uint64_t _maxAstId);

  Analysis(Analysis const&) = delete;

  ~Analysis();

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

  bool check(std::vector<std::shared_ptr<SourceUnit const>> const& _sourceUnits);

  langutil::ErrorReporter& errorReporter() { return m_errorReporter; }

  uint64_t maxAstId() const { return m_maxAstId; }

  TypeSystem& typeSystem() { return m_typeSystem; }

  TypeSystem const& typeSystem() const { return m_typeSystem; }

  template<typename Step>

  typename Step::Annotation& annotation(ASTNode const& _node)

  {

    return detail::AnnotationFetcher<Step>{*this}.get(_node);

  }

solidity::frontend::experimental::TypeInference::Annotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeInference>(solidity::frontend::ASTNode const&)

Line

Count

Source

80

1.39k

  {

81

1.39k

    return detail::AnnotationFetcher<Step>{*this}.get(_node);

82

1.39k

  }

solidity::frontend::experimental::TypeClassRegistration::Annotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeClassRegistration>(solidity::frontend::ASTNode const&)

Line

Count

Source

80

98

  {

81

98

    return detail::AnnotationFetcher<Step>{*this}.get(_node);

82

98

  }

solidity::frontend::experimental::TypeRegistration::Annotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeRegistration>(solidity::frontend::ASTNode const&)

Line

Count

Source

80

703

  {

81

703

    return detail::AnnotationFetcher<Step>{*this}.get(_node);

82

703

  }

  template<typename Step>

  typename Step::Annotation const& annotation(ASTNode const& _node) const

  {

    return detail::ConstAnnotationFetcher<Step>{*this}.get(_node);

  }

Unexecuted instantiation: solidity::frontend::experimental::TypeInference::Annotation const& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeInference>(solidity::frontend::ASTNode const&) const

Unexecuted instantiation: solidity::frontend::experimental::TypeRegistration::Annotation const& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeRegistration>(solidity::frontend::ASTNode const&) const

Unexecuted instantiation: solidity::frontend::experimental::TypeClassRegistration::Annotation const& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeClassRegistration>(solidity::frontend::ASTNode const&) const

  template<typename Step>

  typename Step::GlobalAnnotation& annotation()

  {

    return detail::AnnotationFetcher<Step>{*this}.get();

  }

solidity::frontend::experimental::FunctionDependencyAnalysis::GlobalAnnotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::FunctionDependencyAnalysis>()

Line

Count

Source

92

95

  {

93

95

    return detail::AnnotationFetcher<Step>{*this}.get();

94

95

  }

solidity::frontend::experimental::TypeInference::GlobalAnnotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeInference>()

Line

Count

Source

92

2.76k

  {

93

2.76k

    return detail::AnnotationFetcher<Step>{*this}.get();

94

2.76k

  }

solidity::frontend::experimental::TypeRegistration::GlobalAnnotation& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeRegistration>()

Line

Count

Source

92

10

  {

93

10

    return detail::AnnotationFetcher<Step>{*this}.get();

94

10

  }

  template<typename Step>

  typename Step::GlobalAnnotation const& annotation() const

  {

    return detail::ConstAnnotationFetcher<Step>{*this}.get();

  }

Unexecuted instantiation: solidity::frontend::experimental::TypeRegistration::GlobalAnnotation const& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeRegistration>() const

Unexecuted instantiation: solidity::frontend::experimental::TypeInference::GlobalAnnotation const& solidity::frontend::experimental::Analysis::annotation<solidity::frontend::experimental::TypeInference>() const

  AnnotationContainer& annotationContainer(ASTNode const& _node);

  AnnotationContainer const& annotationContainer(ASTNode const& _node) const;

  GlobalAnnotationContainer& annotationContainer() { return *m_globalAnnotation; }

  GlobalAnnotationContainer const& annotationContainer() const { return *m_globalAnnotation; }

private:

  langutil::ErrorReporter& m_errorReporter;

  TypeSystem m_typeSystem;

  uint64_t m_maxAstId = 0;

  std::unique_ptr<AnnotationContainer[]> m_annotations;

  std::unique_ptr<GlobalAnnotationContainer> m_globalAnnotation;

};

}