/*
	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/>.
*/

#include <test/libyul/YulOptimizerTest.h>

#include <test/libsolidity/FormattedScope.h>

#include <test/Options.h>

#include <libyul/optimiser/BlockFlattener.h>
#include <libyul/optimiser/VarDeclPropagator.h>
#include <libyul/optimiser/Disambiguator.h>
#include <libyul/optimiser/CommonSubexpressionEliminator.h>
#include <libyul/optimiser/NameCollector.h>
#include <libyul/optimiser/ExpressionSplitter.h>
#include <libyul/optimiser/FunctionGrouper.h>
#include <libyul/optimiser/FunctionHoister.h>
#include <libyul/optimiser/ExpressionInliner.h>
#include <libyul/optimiser/FullInliner.h>
#include <libyul/optimiser/ForLoopInitRewriter.h>
#include <libyul/optimiser/MainFunction.h>
#include <libyul/optimiser/Rematerialiser.h>
#include <libyul/optimiser/ExpressionSimplifier.h>
#include <libyul/optimiser/UnusedPruner.h>
#include <libyul/optimiser/ExpressionJoiner.h>
#include <libyul/optimiser/SSATransform.h>
#include <libyul/optimiser/RedundantAssignEliminator.h>
#include <libyul/optimiser/Suite.h>
#include <libyul/AsmPrinter.h>
#include <libyul/AsmParser.h>
#include <libyul/AsmAnalysis.h>
#include <liblangutil/SourceReferenceFormatter.h>

#include <liblangutil/ErrorReporter.h>
#include <liblangutil/Scanner.h>

#include <boost/test/unit_test.hpp>
#include <boost/algorithm/string.hpp>

#include <fstream>

using namespace dev;
using namespace langutil;
using namespace yul;
using namespace yul::test;
using namespace dev::solidity;
using namespace dev::solidity::test;
using namespace std;

YulOptimizerTest::YulOptimizerTest(string const& _filename)
{
	boost::filesystem::path path(_filename);

	if (path.empty() || std::next(path.begin()) == path.end() || std::next(std::next(path.begin())) == path.end())
		BOOST_THROW_EXCEPTION(runtime_error("Filename path has to contain a directory: \"" + _filename + "\"."));
	m_optimizerStep = std::prev(std::prev(path.end()))->string();

	ifstream file(_filename);
	if (!file)
		BOOST_THROW_EXCEPTION(runtime_error("Cannot open test case: \"" + _filename + "\"."));
	file.exceptions(ios::badbit);

	string line;
	while (getline(file, line))
	{
		if (boost::algorithm::starts_with(line, "// ----"))
			break;
		if (m_source.empty() && boost::algorithm::starts_with(line, "// yul"))
			m_yul = true;
		m_source += line + "\n";
	}
	while (getline(file, line))
		if (boost::algorithm::starts_with(line, "// "))
			m_expectation += line.substr(3) + "\n";
		else
			m_expectation += line + "\n";
}

bool YulOptimizerTest::run(ostream& _stream, string const& _linePrefix, bool const _formatted)
{
	yul::AsmPrinter printer{m_yul};
	shared_ptr<Block> ast;
	shared_ptr<yul::AsmAnalysisInfo> analysisInfo;
	if (!parse(_stream, _linePrefix, _formatted))
		return false;

	if (m_optimizerStep == "disambiguator")
		disambiguate();
	else if (m_optimizerStep == "blockFlattener")
	{
		disambiguate();
		BlockFlattener{}(*m_ast);
	}
	else if (m_optimizerStep == "varDeclPropagator")
	{
		disambiguate();
		VarDeclPropagator{}(*m_ast);
	}
	else if (m_optimizerStep == "forLoopInitRewriter")
	{
		disambiguate();
		ForLoopInitRewriter{}(*m_ast);
	}
	else if (m_optimizerStep == "commonSubexpressionEliminator")
	{
		disambiguate();
		(CommonSubexpressionEliminator{})(*m_ast);
	}
	else if (m_optimizerStep == "expressionSplitter")
	{
		NameDispenser nameDispenser(*m_ast);
		ExpressionSplitter{nameDispenser}(*m_ast);
	}
	else if (m_optimizerStep == "expressionJoiner")
	{
		disambiguate();
		ExpressionJoiner::run(*m_ast);
	}
	else if (m_optimizerStep == "splitJoin")
	{
		disambiguate();
		NameDispenser nameDispenser(*m_ast);
		ExpressionSplitter{nameDispenser}(*m_ast);
		ExpressionJoiner::run(*m_ast);
		ExpressionJoiner::run(*m_ast);
	}
	else if (m_optimizerStep == "functionGrouper")
	{
		disambiguate();
		(FunctionGrouper{})(*m_ast);
	}
	else if (m_optimizerStep == "functionHoister")
	{
		disambiguate();
		(FunctionHoister{})(*m_ast);
	}
	else if (m_optimizerStep == "expressionInliner")
	{
		disambiguate();
		ExpressionInliner(*m_ast).run();
	}
	else if (m_optimizerStep == "fullInliner")
	{
		disambiguate();
		(FunctionHoister{})(*m_ast);
		(FunctionGrouper{})(*m_ast);
		NameDispenser nameDispenser(*m_ast);
		ExpressionSplitter{nameDispenser}(*m_ast);
		FullInliner(*m_ast, nameDispenser).run();
		ExpressionJoiner::run(*m_ast);
	}
	else if (m_optimizerStep == "mainFunction")
	{
		disambiguate();
		(FunctionGrouper{})(*m_ast);
		(MainFunction{})(*m_ast);
	}
	else if (m_optimizerStep == "rematerialiser")
	{
		disambiguate();
		(Rematerialiser{})(*m_ast);
	}
	else if (m_optimizerStep == "expressionSimplifier")
	{
		disambiguate();
		ExpressionSimplifier::run(*m_ast);
	}
	else if (m_optimizerStep == "fullSimplify")
	{
		disambiguate();
		NameDispenser nameDispenser(*m_ast);
		ExpressionSplitter{nameDispenser}(*m_ast);
		CommonSubexpressionEliminator{}(*m_ast);
		ExpressionSimplifier::run(*m_ast);
		UnusedPruner::runUntilStabilised(*m_ast);
		ExpressionJoiner::run(*m_ast);
		ExpressionJoiner::run(*m_ast);
	}
	else if (m_optimizerStep == "unusedPruner")
	{
		disambiguate();
		UnusedPruner::runUntilStabilised(*m_ast);
	}
	else if (m_optimizerStep == "ssaTransform")
	{
		disambiguate();
		NameDispenser nameDispenser(*m_ast);
		SSATransform::run(*m_ast, nameDispenser);
	}
	else if (m_optimizerStep == "redundantAssignEliminator")
	{
		disambiguate();
		RedundantAssignEliminator::run(*m_ast);
	}
	else if (m_optimizerStep == "ssaPlusCleanup")
	{
		disambiguate();
		NameDispenser nameDispenser(*m_ast);
		SSATransform::run(*m_ast, nameDispenser);
		RedundantAssignEliminator::run(*m_ast);
	}
	else if (m_optimizerStep == "fullSuite")
		OptimiserSuite::run(*m_ast, *m_analysisInfo);
	else
	{
		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Invalid optimizer step: " << m_optimizerStep << endl;
		return false;
	}

	m_obtainedResult = m_optimizerStep + "\n" + printer(*m_ast) + "\n";

	if (m_expectation != m_obtainedResult)
	{
		string nextIndentLevel = _linePrefix + "  ";
		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::CYAN}) << _linePrefix << "Expected result:" << endl;
		// TODO could compute a simple diff with highlighted lines
		printIndented(_stream, m_expectation, nextIndentLevel);
		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::CYAN}) << _linePrefix << "Obtained result:" << endl;
		printIndented(_stream, m_obtainedResult, nextIndentLevel);
		return false;
	}
	return true;
}

void YulOptimizerTest::printSource(ostream& _stream, string const& _linePrefix, bool const) const
{
	printIndented(_stream, m_source, _linePrefix);
}

void YulOptimizerTest::printUpdatedExpectations(ostream& _stream, string const& _linePrefix) const
{
	printIndented(_stream, m_obtainedResult, _linePrefix);
}

void YulOptimizerTest::printIndented(ostream& _stream, string const& _output, string const& _linePrefix) const
{
	stringstream output(_output);
	string line;
	while (getline(output, line))
		_stream << _linePrefix << line << endl;
}

bool YulOptimizerTest::parse(ostream& _stream, string const& _linePrefix, bool const _formatted)
{
	yul::AsmFlavour flavour = m_yul ? yul::AsmFlavour::Yul : yul::AsmFlavour::Strict;
	ErrorList errors;
	ErrorReporter errorReporter(errors);
	shared_ptr<Scanner> scanner = make_shared<Scanner>(CharStream(m_source, ""));
	m_ast = yul::Parser(errorReporter, flavour).parse(scanner, false);
	if (!m_ast || !errorReporter.errors().empty())
	{
		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Error parsing source." << endl;
		printErrors(_stream, errorReporter.errors(), *scanner);
		return false;
	}
	m_analysisInfo = make_shared<yul::AsmAnalysisInfo>();
	yul::AsmAnalyzer analyzer(
		*m_analysisInfo,
		errorReporter,
		dev::test::Options::get().evmVersion(),
		boost::none,
		flavour
	);
	if (!analyzer.analyze(*m_ast) || !errorReporter.errors().empty())
	{
		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Error analyzing source." << endl;
		printErrors(_stream, errorReporter.errors(), *scanner);
		return false;
	}
	return true;
}

void YulOptimizerTest::disambiguate()
{
	*m_ast = boost::get<Block>(Disambiguator(*m_analysisInfo)(*m_ast));
	m_analysisInfo.reset();
}

void YulOptimizerTest::printErrors(ostream& _stream, ErrorList const& _errors, Scanner const& _scanner)
{
	SourceReferenceFormatter formatter(_stream, [&](string const&) -> Scanner const& { return _scanner; });

	for (auto const& error: _errors)
		formatter.printExceptionInformation(
			*error,
			(error->type() == Error::Type::Warning) ? "Warning" : "Error"
		);
}
ons'>+0</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=bcd987f8cf8cb17c3357bc1ff57ef40ff2b78dbc'>- Update to 2.02</a></td><td>amdmi3</td><td><span title='2016-07-08 21:55:52 +0800'>2016-07-08</span></td><td>2</td><td><span class='deletions'>-4</span>/<span class='insertions'>+5</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=6126a9c5a826afdbe6ebfd5bf6d02c6e2be2a700'>Remove ${PORTSDIR}/ from dependencies, categories v, w, x, y, and z.</a></td><td>mat</td><td><span title='2016-04-01 22:33:55 +0800'>2016-04-01</span></td><td>1</td><td><span class='deletions'>-8</span>/<span class='insertions'>+8</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=9debac461b7729b783ca5a0f5e46461ddac07173'>Change the way Perl modules are installed, update the default Perl to 5.18.</a></td><td>mat</td><td><span title='2014-11-26 21:08:24 +0800'>2014-11-26</span></td><td>2</td><td><span class='deletions'>-10</span>/<span class='insertions'>+1</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=d05447e43fdb0c1ddf9274b37c9243a52c73926c'>- Update to 2.00</a></td><td>culot</td><td><span title='2014-05-26 22:25:53 +0800'>2014-05-26</span></td><td>3</td><td><span class='deletions'>-7</span>/<span class='insertions'>+7</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=46b9121f20b170c226e218ae76ad4380743fd05d'>- Update to 1.02 [1]</a></td><td>culot</td><td><span title='2014-02-20 21:03:00 +0800'>2014-02-20</span></td><td>2</td><td><span class='deletions'>-6</span>/<span class='insertions'>+6</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=9aec49a523bce54d62118e693327026367bd3834'>- stage support</a></td><td>az</td><td><span title='2014-01-05 21:05:56 +0800'>2014-01-05</span></td><td>3</td><td><span class='deletions'>-5</span>/<span class='insertions'>+3</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=e598d34341b62529b9ef63db27d571f9bcb8c766'>Add NO_STAGE all over the place in preparation for the staging support (cat: ...</a></td><td>bapt</td><td><span title='2013-09-21 07:36:50 +0800'>2013-09-21</span></td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=ef9826b1f58f70a0b9e405e663637faba89b9ca8'>- convert to the new perl5 framework</a></td><td>az</td><td><span title='2013-09-02 23:12:10 +0800'>2013-09-02</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+2</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=01951991e09ea6715a19242ae86a0fb9ae4e2c9c'>- Update to 0.09010 [1]</a></td><td>culot</td><td><span title='2012-10-26 20:31:47 +0800'>2012-10-26</span></td><td>2</td><td><span class='deletions'>-9</span>/<span class='insertions'>+8</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=3f7d0a4d131ce24d40b2b3bac122612bdf203109'>- Add TEST_DEPENDS</a></td><td>swills</td><td><span title='2012-04-12 10:06:12 +0800'>2012-04-12</span></td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=d5a90e4fb30a18818cf4275e81e098f77461aba3'>- Update to 0.09002</a></td><td>sunpoet</td><td><span title='2011-11-19 13:59:13 +0800'>2011-11-19</span></td><td>2</td><td><span class='deletions'>-5</span>/<span class='insertions'>+5</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=8231f2ffca881e7c1ade9aff8d8293c79d798a56'>- Update to 0.09000</a></td><td>culot</td><td><span title='2011-04-04 21:54:52 +0800'>2011-04-04</span></td><td>2</td><td><span class='deletions'>-4</span>/<span class='insertions'>+4</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=4ab972b7468e739167f0f48c87471c6c6b7da9e5'>- Get Rid MD5 support</a></td><td>miwi</td><td><span title='2011-03-19 20:38:54 +0800'>2011-03-19</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+0</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=6f60e64c277144899db439b04a4924ed3925ec89'>- Also remove them from pkg-plist lists not from me that crept in</a></td><td>pgollucci</td><td><span title='2010-11-24 14:19:46 +0800'>2010-11-24</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+0</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=3f438d363237af157da4ddaa5d1e4b26719ba86f'>- Update to 0.08002</a></td><td>wen</td><td><span title='2010-10-09 16:16:11 +0800'>2010-10-09</span></td><td>3</td><td><span class='deletions'>-17</span>/<span class='insertions'>+17</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=ec2365d99d9d29769ba7d77b8e112d375153395c'>- only 13% of the p5- ports embed @comment $FreeBSD$:</a></td><td>pgollucci</td><td><span title='2010-09-24 10:03:44 +0800'>2010-09-24</span></td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+0</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=8818a436dd79b3a932f8fc33787f6c6cf2839792'>- Update to 0.06000</a></td><td>wen</td><td><span title='2010-01-18 17:02:03 +0800'>2010-01-18</span></td><td>2</td><td><span class='deletions'>-4</span>/<span class='insertions'>+5</span></td></tr>
<tr><td class='commitgraph'>* </td><td><a href='/~lantw44/cgit/cgit.cgi/freebsd-ports-gnome/commit/www/p5-HTML-FormFu-Model-DBIC?id=5f8f6054241630e31d2bf18e6a3fe4c27d8f5f05'>- Update to 0.05000</a></td><td>pgollucci</td><td><span title='2009-06-20 00:29:04 +0800'>2009-06-20</span></td><td>2</td><td><span class='deletions'>-7</span>/<span class='insertions'>+10</span></td></tr>