/*

  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

/**

 * @author Lefteris <lefteris@ethdev.com>

 * @date 2014, 2015

 * Parses a given docstring into pieces introduced by tags.

 */

#pragma once

#include <libsolidity/ast/ASTAnnotations.h>

#include <liblangutil/SourceLocation.h>

#include <string>

namespace solidity::langutil

{

class ErrorReporter;

}

namespace solidity::frontend

{

class StructuredDocumentation;

class DocStringParser

{

public:

  /// @param _documentedNode the node whose documentation is parsed.

  DocStringParser(StructuredDocumentation const& _documentedNode, langutil::ErrorReporter& _errorReporter):

    m_node(_documentedNode),

    m_errorReporter(_errorReporter)

  {}

  std::multimap<std::string, DocTag> parse();

private:

  using iter = std::string::const_iterator;

  iter parseDocTagLine(iter _pos, iter _end, bool _appending);

  iter parseDocTagParam(iter _pos, iter _end);

  /// Parses the doc tag named @a _tag, adds it to m_docTags and returns the position

  /// after the tag.

  iter parseDocTag(iter _pos, iter _end, std::string const& _tag);

  /// Creates and inserts a new tag and adjusts m_lastTag.

  void newTag(std::string const& _tagName);

  StructuredDocumentation const& m_node;

  langutil::ErrorReporter& m_errorReporter;

  /// Mapping tag name -> content.

  std::multimap<std::string, DocTag> m_docTags;

  DocTag* m_lastTag = nullptr;

};

}