/*
	This file is part of cpp-ethereum.

	cpp-ethereum 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.

	cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Lefteris <lefteris@ethdev.com>
 * @date 2014, 2015
 * Parses a given docstring into pieces introduced by tags.
 */

#pragma once

#include <string>
#include <libsolidity/interface/Exceptions.h>
#include <libsolidity/ast/ASTAnnotations.h>

namespace dev
{
namespace solidity
{

class DocStringParser
{
public:
	/// Parse the given @a _docString and stores the parsed components internally.
	/// @returns false on error and appends the error to @a _errors.
	bool parse(std::string const& _docString, ErrorList& _errors);

	std::multimap<std::string, DocTag> const& tags() const { return m_docTags; }

private:
	using iter = std::string::const_iterator;
	void resetUser();
	void resetDev();

	iter parseDocTagLine(iter _pos, iter _end, bool _appending);
	iter parseDocTagParam(iter _pos, iter _end);
	iter appendDocTagParam(iter _pos, iter _end);
	void parseDocString(std::string const& _string);
	iter appendDocTag(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);

	void appendError(std::string const& _description);

	/// Mapping tag name -> content.
	std::multimap<std::string, DocTag> m_docTags;
	DocTag* m_lastTag = nullptr;
	ErrorList* m_errors = nullptr;
	bool m_errorsOccurred = false;
};

} //solidity NS
} // dev NS
class='active' href='/~lantw44/cgit/freebsd-ports-graphics/log/java/eclipse-quantum'>log</a><a href='/~lantw44/cgit/freebsd-ports-graphics/tree/java/eclipse-quantum?id=63014058f5930eaa1e497f9e220f191415dd08db'>tree</a><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=63014058f5930eaa1e497f9e220f191415dd08db'>commit</a><a href='/~lantw44/cgit/freebsd-ports-graphics/diff/java/eclipse-quantum?id=63014058f5930eaa1e497f9e220f191415dd08db'>diff</a><a href='/~lantw44/cgit/freebsd-ports-graphics/stats/java/eclipse-quantum'>stats</a></td><td class='form'><form class='right' method='get' action='/~lantw44/cgit/freebsd-ports-graphics/log/java/eclipse-quantum'>
<input type='hidden' name='id' value='63014058f5930eaa1e497f9e220f191415dd08db'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/~lantw44/cgit/freebsd-ports-graphics/log/?id=63014058f5930eaa1e497f9e220f191415dd08db'>root</a>/<a href='/~lantw44/cgit/freebsd-ports-graphics/log/java?id=63014058f5930eaa1e497f9e220f191415dd08db'>java</a>/<a href='/~lantw44/cgit/freebsd-ports-graphics/log/java/eclipse-quantum?id=63014058f5930eaa1e497f9e220f191415dd08db'>eclipse-quantum</a></div><div class='content'><table class='list nowrap'><tr class='nohover'><th></th><th class='left'>Commit message (<a href='/~lantw44/cgit/freebsd-ports-graphics/log/java/eclipse-quantum?id=63014058f5930eaa1e497f9e220f191415dd08db&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th><th class='left'>Age</th><th class='left'>Files</th><th class='left'>Lines</th></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=e138cdf61db20fb68284b444c5a0909d23fb2a73'>. Update to 3.0.1.</a></td><td>glewis</td><td><span title='2006-01-21 01:05:47 +0800'>2006-01-21</span></td><td>3</td><td><span class='deletions'>-11</span>/<span class='insertions'>+18</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=f04c8ccc0e7a92cb60d7e1b3a9525e0f461d964b'>. Update to 3.0.0.</a></td><td>glewis</td><td><span title='2005-10-22 06:32:08 +0800'>2005-10-22</span></td><td>3</td><td><span class='deletions'>-135</span>/<span class='insertions'>+286</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=b69baf73f1d20c9f003aa57d91ebef85096ff229'>Change MAINTAINER from java@ to freebsd-eclipse@.</a></td><td>nork</td><td><span title='2005-08-28 23:29:51 +0800'>2005-08-28</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=e70528c3edef9097dec6fae59dd56aa250d9ff7e'>Bump PORTREVISION to chase the glib20 shared lib version change.</a></td><td>marcus</td><td><span title='2005-03-12 18:54:27 +0800'>2005-03-12</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/freebsd-ports-graphics/commit/java/eclipse-quantum?id=b204eefd9d12857a2e384c59753552fe8286fae5'>Bump PORTREVISIONS for all ports that depend on atk or pango to ease in the</a></td><td>marcus</td><td><span title='2004-11-08 06:37:47 +0800'>2004-11-08</span></td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>