path: root/test/libsolidity/SolidityParser.cpp

/*
    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/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Unit tests for the solidity parser.
 */

#include <string>
#include <memory>
#include <libsolidity/parsing/Scanner.h>
#include <libsolidity/parsing/Parser.h>
#include <libsolidity/interface/ErrorReporter.h>
#include <test/Options.h>
#include <test/libsolidity/ErrorCheck.h>

using namespace std;

namespace dev
{
namespace solidity
{
namespace test
{

namespace
{
ASTPointer<ContractDefinition> parseText(std::string const& _source, ErrorList& _errors)
{
    ErrorReporter errorReporter(_errors);
    ASTPointer<SourceUnit> sourceUnit = Parser(errorReporter).parse(std::make_shared<Scanner>(CharStream(_source)));
    if (!sourceUnit)
        return ASTPointer<ContractDefinition>();
    for (ASTPointer<ASTNode> const& node: sourceUnit->nodes())
        if (ASTPointer<ContractDefinition> contract = dynamic_pointer_cast<ContractDefinition>(node))
            return contract;
    BOOST_FAIL("No contract found in source.");
    return ASTPointer<ContractDefinition>();
}

bool successParse(std::string const& _source)
{
    ErrorList errors;
    try
    {
        auto sourceUnit = parseText(_source, errors);
        if (!sourceUnit)
            return false;
    }
    catch (FatalError const& /*_exception*/)
    {
        if (Error::containsErrorOfType(errors, Error::Type::ParserError))
            return false;
    }
    if (Error::containsErrorOfType(errors, Error::Type::ParserError))
        return false;

    BOOST_CHECK(Error::containsOnlyWarnings(errors));
    return true;
}

Error getError(std::string const& _source)
{
    ErrorList errors;
    try
    {
        parseText(_source, errors);
    }
    catch (FatalError const& /*_exception*/)
    {
        // no-op
    }
    Error const* error = Error::containsErrorOfType(errors, Error::Type::ParserError);
    BOOST_REQUIRE(error);
    return *error;
}

void checkFunctionNatspec(
    FunctionDefinition const* _function,
    std::string const& _expectedDoc
)
{
    auto doc = _function->documentation();
    BOOST_CHECK_MESSAGE(doc != nullptr, "Function does not have Natspec Doc as expected");
    BOOST_CHECK_EQUAL(*doc, _expectedDoc);
}

}

#define CHECK_PARSE_ERROR(source, substring) \
do \
{\
    Error err = getError((source)); \
    BOOST_CHECK(searchErrorMessage(err, (substring))); \
}\
while(0)


BOOST_AUTO_TEST_SUITE(SolidityParser)

BOOST_AUTO_TEST_CASE(smoke_test)
{
    char const* text = R"(
        contract test {
            uint256 stateVariable1;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(missing_variable_name_in_declaration)
{
    char const* text = R"(
        contract test {
            uint256 ;
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(empty_function)
{
    char const* text = R"(
        contract test {
        uint256 stateVar;
            function functionName(bytes20 arg1, address addr) constant
                returns (int id)
            { }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(no_function_params)
{
    char const* text = R"(
        contract test {
            uint256 stateVar;
            function functionName() {}
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(single_function_param)
{
    char const* text = R"(
        contract test {
            uint256 stateVar;
            function functionName(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(single_function_param_trailing_comma)
{
    char const* text = R"(
        contract test {
            function(uint a,) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(single_return_param_trailing_comma)
{
    char const* text = R"(
        contract test {
            function() returns (uint a,) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(single_modifier_arg_trailing_comma)
{
    char const* text = R"(
        contract test {
            modifier modTest(uint a,) { _; }
            function(uint a) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(single_event_arg_trailing_comma)
{
    char const* text = R"(
        contract test {
            event Test(uint a,);
            function(uint a) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(multiple_function_param_trailing_comma)
{
    char const* text = R"(
        contract test {
            function(uint a, uint b,) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(multiple_return_param_trailing_comma)
{
    char const* text = R"(
        contract test {
            function() returns (uint a, uint b,) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(multiple_modifier_arg_trailing_comma)
{
    char const* text = R"(
        contract test {
            modifier modTest(uint a, uint b,) { _; }
            function(uint a) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(multiple_event_arg_trailing_comma)
{
    char const* text = R"(
        contract test {
            event Test(uint a, uint b,);
            function(uint a) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma in parameter list.");
}

BOOST_AUTO_TEST_CASE(function_no_body)
{
    char const* text = R"(
        contract test {
            function functionName(bytes32 input) returns (bytes32 out);
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(missing_parameter_name_in_named_args)
{
    char const* text = R"(
        contract test {
            function a(uint a, uint b, uint c) returns (uint r) { r = a * 100 + b * 10 + c * 1; }
            function b() returns (uint r) { r = a({: 1, : 2, : 3}); }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(missing_argument_in_named_args)
{
    char const* text = R"(
        contract test {
            function a(uint a, uint b, uint c) returns (uint r) { r = a * 100 + b * 10 + c * 1; }
            function b() returns (uint r) { r = a({a: , b: , c: }); }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected primary expression");
}

BOOST_AUTO_TEST_CASE(trailing_comma_in_named_args)
{
    char const* text = R"(
        contract test {
            function a(uint a, uint b, uint c) returns (uint r) { r = a * 100 + b * 10 + c * 1; }
            function b() returns (uint r) { r = a({a: 1, b: 2, c: 3, }); }
        }
    )";
    CHECK_PARSE_ERROR(text, "Unexpected trailing comma");
}

BOOST_AUTO_TEST_CASE(two_exact_functions)
{
    char const* text = R"(
        contract test {
            function fun(uint a) returns(uint r) { return a; }
            function fun(uint a) returns(uint r) { return a; }
        }
    )";
    // with support of overloaded functions, during parsing,
    // we can't determine whether they match exactly, however
    // it will throw DeclarationError in following stage.
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(overloaded_functions)
{
    char const* text = R"(
        contract test {
            function fun(uint a) returns(uint r) { return a; }
            function fun(uint a, uint b) returns(uint r) { return a + b; }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_natspec_documentation)
{
    char const* text = R"(
        contract test {
            uint256 stateVar;
            /// This is a test function
            function functionName(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    FunctionDefinition const* function = nullptr;
    auto functions = contract->definedFunctions();

    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is a test function");
}

BOOST_AUTO_TEST_CASE(function_normal_comments)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            uint256 stateVar;
            // We won't see this comment
            function functionName(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();
    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    BOOST_CHECK_MESSAGE(function->documentation() == nullptr,
                        "Should not have gotten a Natspecc comment for this function");
}

BOOST_AUTO_TEST_CASE(multiple_functions_natspec_documentation)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            uint256 stateVar;
            /// This is test function 1
            function functionName1(bytes32 input) returns (bytes32 out) {}
            /// This is test function 2
            function functionName2(bytes32 input) returns (bytes32 out) {}
            // nothing to see here
            function functionName3(bytes32 input) returns (bytes32 out) {}
            /// This is test function 4
            function functionName4(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();

    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is test function 1");

    BOOST_REQUIRE_MESSAGE(function = functions.at(1), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is test function 2");

    BOOST_REQUIRE_MESSAGE(function = functions.at(2), "Failed to retrieve function");
    BOOST_CHECK_MESSAGE(function->documentation() == nullptr,
                        "Should not have gotten natspec comment for functionName3()");

    BOOST_REQUIRE_MESSAGE(function = functions.at(3), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is test function 4");
}

BOOST_AUTO_TEST_CASE(multiline_function_documentation)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            uint256 stateVar;
            /// This is a test function
            /// and it has 2 lines
            function functionName1(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();
    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is a test function\n"
                         " and it has 2 lines");
}

BOOST_AUTO_TEST_CASE(natspec_comment_in_function_body)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            /// fun1 description
            function fun1(uint256 a) {
                var b;
                /// I should not interfere with actual natspec comments
                uint256 c;
                mapping(address=>bytes32) d;
                bytes7 name = "Solidity";
            }
            /// This is a test function
            /// and it has 2 lines
            function fun(bytes32 input) returns (bytes32 out) {}
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();

    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    checkFunctionNatspec(function, "fun1 description");

    BOOST_REQUIRE_MESSAGE(function = functions.at(1), "Failed to retrieve function");
    checkFunctionNatspec(function, "This is a test function\n"
                         " and it has 2 lines");
}

BOOST_AUTO_TEST_CASE(natspec_docstring_between_keyword_and_signature)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            uint256 stateVar;
            function ///I am in the wrong place
            fun1(uint256 a) {
                var b;
                /// I should not interfere with actual natspec comments
                uint256 c;
                mapping(address=>bytes32) d;
                bytes7 name = "Solidity";
            }
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();

    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    BOOST_CHECK_MESSAGE(!function->documentation(),
                        "Shouldn't get natspec docstring for this function");
}

BOOST_AUTO_TEST_CASE(natspec_docstring_after_signature)
{
    FunctionDefinition const* function = nullptr;
    char const* text = R"(
        contract test {
            uint256 stateVar;
            function fun1(uint256 a) {
                /// I should have been above the function signature
                var b;
                /// I should not interfere with actual natspec comments
                uint256 c;
                mapping(address=>bytes32) d;
                bytes7 name = "Solidity";
            }
        }
    )";
    BOOST_CHECK(successParse(text));
    ErrorList errors;
    ASTPointer<ContractDefinition> contract = parseText(text, errors);
    auto functions = contract->definedFunctions();

    BOOST_REQUIRE_MESSAGE(function = functions.at(0), "Failed to retrieve function");
    BOOST_CHECK_MESSAGE(!function->documentation(),
                        "Shouldn't get natspec docstring for this function");
}

BOOST_AUTO_TEST_CASE(struct_definition)
{
    char const* text = R"(
        contract test {
            uint256 stateVar;
            struct MyStructName {
                address addr;
                uint256 count;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(mapping)
{
    char const* text = R"(
        contract test {
            mapping(address => bytes32) names;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(mapping_in_struct)
{
    char const* text = R"(
        contract test {
            struct test_struct {
                address addr;
                uint256 count;
                mapping(bytes32 => test_struct) self_reference;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(mapping_to_mapping_in_struct)
{
    char const* text = R"(
        contract test {
            struct test_struct {
                address addr;
                mapping (uint64 => mapping (bytes32 => uint)) complex_mapping;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(variable_definition)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                var b;
                uint256 c;
                mapping(address=>bytes32) d;
                customtype varname;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(variable_definition_with_initialization)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                var b = 2;
                uint256 c = 0x87;
                mapping(address=>bytes32) d;
                bytes7 name = "Solidity";
                customtype varname;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(variable_definition_in_function_parameter)
{
    char const* text = R"(
        contract test {
            function fun(var a) {}
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected explicit type name");
}

BOOST_AUTO_TEST_CASE(variable_definition_in_mapping)
{
    char const* text = R"(
        contract test {
            function fun() {
                mapping(var=>bytes32) d;
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected elementary type name for mapping key type");
}

BOOST_AUTO_TEST_CASE(variable_definition_in_function_return)
{
    char const* text = R"(
        contract test {
            function fun() returns(var d) {
                return 1;
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected explicit type name");
}

BOOST_AUTO_TEST_CASE(operator_expression)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                uint256 x = (1 + 4) || false && (1 - 12) + -9;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(complex_expression)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                uint256 x = (1 + 4).member(++67)[a/=9] || true;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(exp_expression)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                uint256 x = 3 ** a;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(while_loop)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                while (true) { uint256 x = 1; break; continue; } x = 9;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(for_loop_vardef_initexpr)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                for (uint256 i = 0; i < 10; i++) {
                    uint256 x = i; break; continue;
                }
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(for_loop_simple_initexpr)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                uint256 i =0;
                for (i = 0; i < 10; i++) {
                    uint256 x = i; break; continue;
                }
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(for_loop_simple_noexpr)
{
    char const* text = R"(
        contract test {
                function fun(uint256 a) {
                    uint256 i =0;
                    for (;;) {
                        uint256 x = i; break; continue;
                    }
                }
            }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(for_loop_single_stmt_body)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                uint256 i = 0;
                for (i = 0; i < 10; i++)
                    continue;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(if_statement)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) {
                if (a >= 8) { return 2; } else { var b = 7; }
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(else_if_statement)
{
    char const* text = R"(
        contract test {
            function fun(uint256 a) returns (address b) {
                if (a < 0) b = 0x67; else if (a == 0) b = 0x12; else b = 0x78;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(statement_starting_with_type_conversion)
{
    char const* text = R"(
        contract test {
            function fun() {
                uint64(2);
                uint64[7](3);
                uint64[](3);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(type_conversion_to_dynamic_array)
{
    char const* text = R"(
        contract test {
            function fun() {
                var x = uint64[](3);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(import_directive)
{
    char const* text = R"(
        import "abc";
        contract test {
            function fun() {
                uint64(2);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(multiple_contracts)
{
    char const* text = R"(
        contract test {
            function fun() {
                uint64(2);
            }
        }
        contract test2 {
            function fun() {
                uint64(2);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(multiple_contracts_and_imports)
{
    char const* text = R"(
        import "abc";
        contract test {
            function fun() {
                uint64(2);
            }
        }
        import "def";
        contract test2 {
            function fun() {
                uint64(2);
            }
        }
        import "ghi";
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(contract_inheritance)
{
    char const* text = R"(
        contract base {
            function fun() {
                uint64(2);
            }
        }
        contract derived is base {
            function fun() {
                uint64(2);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(contract_multiple_inheritance)
{
    char const* text = R"(
        contract base {
            function fun() {
                uint64(2);
            }
        }
        contract derived is base, nonExisting {
            function fun() {
                uint64(2);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(contract_multiple_inheritance_with_arguments)
{
    char const* text = R"(
        contract base {
            function fun() {
                uint64(2);
            }
        }
        contract derived is base(2), nonExisting("abc", "def", base.fun()) {
            function fun() {
                uint64(2);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(placeholder_in_function_context)
{
    char const* text = R"(
        contract c {
            function fun() returns (uint r) {
                var _ = 8;
                return _ + 1;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(modifier)
{
    char const* text = R"(
        contract c {
            modifier mod { if (msg.sender == 0) _; }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(modifier_without_semicolon)
{
    char const* text = R"(
        contract c {
            modifier mod { if (msg.sender == 0) _ }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token Semicolon got");
}

BOOST_AUTO_TEST_CASE(modifier_arguments)
{
    char const* text = R"(
        contract c {
            modifier mod(address a) { if (msg.sender == a) _; }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(modifier_invocation)
{
    char const* text = R"(
        contract c {
            modifier mod1(uint a) { if (msg.sender == a) _; }
            modifier mod2 { if (msg.sender == 2) _; }
            function f() mod1(7) mod2 { }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(fallback_function)
{
    char const* text = R"(
        contract c {
            function() { }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(event)
{
    char const* text = R"(
        contract c {
            event e();
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(event_arguments)
{
    char const* text = R"(
        contract c {
            event e(uint a, bytes32 s);
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(event_arguments_indexed)
{
    char const* text = R"(
        contract c {
            event e(uint a, bytes32 indexed s, bool indexed b);
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(event_with_no_argument_list_fails)
{
    char const* text = R"(
        contract c {
            event e;
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token LParen got 'Semicolon'");
}

BOOST_AUTO_TEST_CASE(visibility_specifiers)
{
    char const* text = R"(
        contract c {
            uint private a;
            uint internal b;
            uint public c;
            uint d;
            function f() {}
            function f_priv() private {}
            function f_public() public {}
            function f_internal() internal {}
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(multiple_visibility_specifiers)
{
    char const* text = R"(
        contract c {
            uint private internal a;
        })";
    CHECK_PARSE_ERROR(text, "Visibility already specified as \"private\".");
    text = R"(
        contract c {
            function f() private external {}
        })";
    CHECK_PARSE_ERROR(text, "Visibility already specified as \"private\".");
}

BOOST_AUTO_TEST_CASE(multiple_statemutability_specifiers)
{
    char const* text = R"(
        contract c {
            function f() payable payable {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"payable\".");
    text = R"(
        contract c {
            function f() constant constant {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"view\".");
    text = R"(
        contract c {
            function f() constant view {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"view\".");
    text = R"(
        contract c {
            function f() payable constant {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"payable\".");
    text = R"(
        contract c {
            function f() pure payable {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"pure\".");
    text = R"(
        contract c {
            function f() pure constant {}
        })";
    CHECK_PARSE_ERROR(text, "State mutability already specified as \"pure\".");
}

BOOST_AUTO_TEST_CASE(literal_constants_with_ether_subdenominations)
{
    char const* text = R"(
        contract c {
            function c ()
            {
                 a = 1 wei;
                 b = 2 szabo;
                 c = 3 finney;
                 b = 4 ether;
            }
            uint256 a;
            uint256 b;
            uint256 c;
            uint256 d;
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(literal_constants_with_ether_subdenominations_in_expressions)
{
    char const* text = R"(
        contract c {
            function c ()
            {
                 a = 1 wei * 100 wei + 7 szabo - 3;
            }
            uint256 a;
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(enum_valid_declaration)
{
    char const* text = R"(
        contract c {
            enum validEnum { Value1, Value2, Value3, Value4 }
            function c ()
            {
                a = foo.Value3;
            }
            uint256 a;
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(empty_enum_declaration)
{
    char const* text = R"(
        contract c {
            enum foo { }
        })";
    CHECK_PARSE_ERROR(text, "enum with no members is not allowed");
}

BOOST_AUTO_TEST_CASE(malformed_enum_declaration)
{
    char const* text = R"(
        contract c {
            enum foo { WARNING,}
        })";
    CHECK_PARSE_ERROR(text, "Expected Identifier after");
}

BOOST_AUTO_TEST_CASE(external_function)
{
    char const* text = R"(
        contract c {
            function x() external {}
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(external_variable)
{
    char const* text = R"(
        contract c {
            uint external x;
        })";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(arrays_in_storage)
{
    char const* text = R"(
        contract c {
            uint[10] a;
            uint[] a2;
            struct x { uint[2**20] b; y[0] c; }
            struct y { uint d; mapping(uint=>x)[] e; }
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(arrays_in_events)
{
    char const* text = R"(
        contract c {
            event e(uint[10] a, bytes7[8] indexed b, c[3] x);
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(arrays_in_expressions)
{
    char const* text = R"(
        contract c {
            function f() { c[10] a = 7; uint8[10 * 2] x; }
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(multi_arrays)
{
    char const* text = R"(
        contract c {
            mapping(uint => mapping(uint => int8)[8][][9])[] x;
        })";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(constant_is_keyword)
{
    char const* text = R"(
        contract Foo {
            uint constant = 4;
    })";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(keyword_is_reserved)
{
    auto keywords = {
        "abstract",
        "after",
        "case",
        "catch",
        "default",
        "final",
        "in",
        "inline",
        "let",
        "match",
        "null",
        "of",
        "relocatable",
        "static",
        "switch",
        "try",
        "type",
        "typeof"
    };

    for (const auto& keyword: keywords)
    {
        auto text = std::string("contract ") + keyword + " {}";
        CHECK_PARSE_ERROR(text.c_str(), "Expected identifier");
    }
}

BOOST_AUTO_TEST_CASE(var_array)
{
    char const* text = R"(
        contract Foo {
            function f() { var[] a; }
    })";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(location_specifiers_for_params)
{
    char const* text = R"(
        contract Foo {
            function f(uint[] storage constant x, uint[] memory y) { }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(location_specifiers_for_locals)
{
    char const* text = R"(
        contract Foo {
            function f() {
                uint[] storage x;
                uint[] memory y;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(location_specifiers_for_state)
{
    char const* text = R"(
        contract Foo {
            uint[] memory x;
    })";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(location_specifiers_with_var)
{
    char const* text = R"(
        contract Foo {
            function f() { var memory x; }
    })";
    CHECK_PARSE_ERROR(text, "Location specifier needs explicit type name");
}

BOOST_AUTO_TEST_CASE(empty_comment)
{
    char const* text = R"(
        //
        contract test
        {}
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(comment_end_with_double_star)
{
    char const* text = R"(
        contract C1 {
        /**
         **/
        }
        contract C2 {}
    )";
    BOOST_CHECK(successParse(text));
}


BOOST_AUTO_TEST_CASE(library_simple)
{
    char const* text = R"(
        library Lib {
            function f() { }
        }
    )";
    BOOST_CHECK(successParse(text));
}


BOOST_AUTO_TEST_CASE(local_const_variable)
{
    char const* text = R"(
        contract Foo {
            function localConst() returns (uint ret)
            {
                uint constant local = 4;
                return local;
            }
    })";
    CHECK_PARSE_ERROR(text, "Expected token Semicolon");
}

BOOST_AUTO_TEST_CASE(multi_variable_declaration)
{
    char const* text = R"(
        contract C {
            function f() {
                var (a,b,c) = g();
                var (d) = 2;
                var (,e) = 3;
                var (f,) = 4;
                var (x,,) = g();
                var (,y,) = g();
                var () = g();
                var (,,) = g();
            }
            function g() returns (uint, uint, uint) {}
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(tuples)
{
    char const* text = R"(
        contract C {
            function f() {
                uint a = (1);
                var (b,) = (1,);
                var (c,d) = (1, 2 + a);
                var (e,) = (1, 2, b);
                (a) = 3;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(tuples_without_commas)
{
    char const* text = R"(
        contract C {
            function f() {
                var a = (2 2);
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token Comma");
}

BOOST_AUTO_TEST_CASE(member_access_parser_ambiguity)
{
    char const* text = R"(
        contract C {
            struct S { uint a; uint b; uint[][][] c; }
            function f() {
                C.S x;
                C.S memory y;
                C.S[10] memory z;
                C.S[10](x);
                x.a = 2;
                x.c[1][2][3] = 9;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(using_for)
{
    char const* text = R"(
        contract C {
            struct s { uint a; }
            using LibraryName for uint;
            using Library2 for *;
            using Lib for s;
            function f() {
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(complex_import)
{
    char const* text = R"(
        import "abc" as x;
        import * as x from "abc";
        import {a as b, c as d, f} from "def";
        contract x {}
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(from_is_not_keyword)
{
    // "from" is not a keyword although it is used as a keyword in import directives.
    char const* text = R"(
        contract from {
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(inline_array_declaration)
{
    char const* text = R"(
        contract c {
            uint[] a;
            function f() returns (uint, uint) {
                a = [1,2,3];
                return (a[3], [2,3,4][0]);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}


BOOST_AUTO_TEST_CASE(inline_array_empty_cells_check_lvalue)
{
    char const* text = R"(
        contract c {
            uint[] a;
            function f() returns (uint) {
                a = [,2,3];
                return (a[0]);
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected expression");
}

BOOST_AUTO_TEST_CASE(inline_array_empty_cells_check_without_lvalue)
{
    char const* text = R"(
        contract c {
            uint[] a;
            function f() returns (uint, uint) {
                return ([3, ,4][0]);
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected expression");
}

BOOST_AUTO_TEST_CASE(conditional_true_false_literal)
{
    char const* text = R"(
        contract A {
            function f() {
                uint x = true ? 1 : 0;
                uint y = false ? 0 : 1;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(conditional_with_constants)
{
    char const* text = R"(
        contract A {
            function f() {
                uint x = 3 > 0 ? 3 : 0;
                uint y = (3 > 0) ? 3 : 0;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(conditional_with_variables)
{
    char const* text = R"(
        contract A {
            function f() {
                uint x = 3;
                uint y = 1;
                uint z = (x > y) ? x : y;
                uint w = x > y ? x : y;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(conditional_multiple)
{
    char const* text = R"(
        contract A {
            function f() {
                uint x = 3 < 0 ? 2 > 1 ? 2 : 1 : 7 > 2 ? 7 : 6;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(conditional_with_assignment)
{
    char const* text = R"(
        contract A {
            function f() {
                uint y = 1;
                uint x = 3 < 0 ? x = 3 : 6;
                true ? x = 3 : 4;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(recursion_depth1)
{
    string text("contract C { bytes");
    for (size_t i = 0; i < 30000; i++)
        text += "[";
    CHECK_PARSE_ERROR(text.c_str(), "Maximum recursion depth reached during parsing");
}

BOOST_AUTO_TEST_CASE(recursion_depth2)
{
    string text("contract C { function f() {");
    for (size_t i = 0; i < 30000; i++)
        text += "{";
    CHECK_PARSE_ERROR(text, "Maximum recursion depth reached during parsing");
}

BOOST_AUTO_TEST_CASE(recursion_depth3)
{
    string text("contract C { function f() { uint x = f(");
    for (size_t i = 0; i < 30000; i++)
        text += "(";
    CHECK_PARSE_ERROR(text, "Maximum recursion depth reached during parsing");
}

BOOST_AUTO_TEST_CASE(recursion_depth4)
{
    string text("contract C { function f() { uint a;");
    for (size_t i = 0; i < 30000; i++)
        text += "(";
    text += "a";
    for (size_t i = 0; i < 30000; i++)
        text += "++)";
    text += "}}";
    CHECK_PARSE_ERROR(text, "Maximum recursion depth reached during parsing");
}

BOOST_AUTO_TEST_CASE(declaring_fixed_and_ufixed_variables)
{
    char const* text = R"(
        contract A {
            fixed40x40 storeMe;
            function f(ufixed x, fixed32x32 y) {
                ufixed8x8 a;
                fixed b;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(declaring_fixed_literal_variables)
{
    char const* text = R"(
        contract A {
            fixed40x40 pi = 3.14;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(no_double_radix_in_fixed_literal)
{
    char const* text = R"(
        contract A {
            fixed40x40 pi = 3.14.15;
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token Semicolon");
}

BOOST_AUTO_TEST_CASE(invalid_fixed_conversion_leading_zeroes_check)
{
    char const* text = R"(
        contract test {
            function f() {
                fixed a = 1.0x2;
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected primary expression");
}

BOOST_AUTO_TEST_CASE(payable_accessor)
{
    char const* text = R"(
        contract test {
            uint payable x;
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected identifier");
}

BOOST_AUTO_TEST_CASE(function_type_in_expression)
{
    char const* text = R"(
        contract test {
            function f(uint x, uint y) returns (uint a) {}
            function g() {
                function (uint, uint) internal returns (uint) f1 = f;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_type_as_storage_variable)
{
    char const* text = R"(
        contract test {
            function (uint, uint) internal returns (uint) f1;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_type_as_storage_variable_with_modifiers)
{
    char const* text = R"(
        contract test {
            function (uint, uint) modifier1() returns (uint) f1;
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token LBrace");
}

BOOST_AUTO_TEST_CASE(function_type_as_storage_variable_with_assignment)
{
    char const* text = R"(
        contract test {
            function f(uint x, uint y) returns (uint a) {}
            function (uint, uint) internal returns (uint) f1 = f;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_type_in_struct)
{
    char const* text = R"(
        contract test {
            struct S {
                function (uint x, uint y) internal returns (uint a) f;
                function (uint, uint) external returns (uint) g;
                uint d;
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_type_as_parameter)
{
    char const* text = R"(
        contract test {
            function f(function(uint) external returns (uint) g) internal returns (uint a) {
                return g(1);
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(calling_function)
{
    char const* text = R"(
        contract test {
            function f() {
                function() returns(function() returns(function() returns(function() returns(uint)))) x;
                uint y;
                y = x()()()();
            }
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(mapping_and_array_of_functions)
{
    char const* text = R"(
        contract test {
            mapping (address => function() internal returns (uint)) a;
            mapping (address => function() external) b;
            mapping (address => function() external[]) c;
            function() external[] d;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(function_type_state_variable)
{
    char const* text = R"(
        contract test {
            function() x;
            function() y = x;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(scientific_notation)
{
    char const* text = R"(
        contract test {
            uint256 a = 2e10;
            uint256 b = 2E10;
            uint256 c = 200e-2;
            uint256 d = 2E10 wei;
            uint256 e = 2.5e10;
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(interface)
{
    char const* text = R"(
        interface Interface {
            function f();
        }
    )";
    BOOST_CHECK(successParse(text));
}

BOOST_AUTO_TEST_CASE(newInvalidTypeName)
{
    char const* text = R"(
        contract C {
            function f() {
                new var;
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected explicit type name");
}

BOOST_AUTO_TEST_CASE(emitWithoutEvent)
{
    char const* text = R"(
        contract C {
            event A();
            function f() {
                emit A;
            }
        }
    )";
    CHECK_PARSE_ERROR(text, "Expected token LParen got 'Semicolon'");
}

BOOST_AUTO_TEST_SUITE_END()

}
}
} // end namespaces