aboutsummaryrefslogtreecommitdiffstats
path: root/composer/e-composer-header-table.h
blob: b3150c409a3289dfa10bfe9afbb5fe1540982188 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>  
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 */

#ifndef E_COMPOSER_HEADER_TABLE_H
#define E_COMPOSER_HEADER_TABLE_H

#include "e-composer-common.h"

#include <libedataserver/e-account.h>
#include <libedataserver/e-account-list.h>
#include <libebook/e-destination.h>
#include <e-util/e-signature.h>
#include <e-util/e-signature-list.h>

#include "e-composer-header.h"

/* Standard GObject macros */
#define E_TYPE_COMPOSER_HEADER_TABLE \
    (e_composer_header_table_get_type ())
#define E_COMPOSER_HEADER_TABLE(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_COMPOSER_HEADER_TABLE, EComposerHeaderTable))
#define E_COMPOSER_HEADER_TABLE_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_COMPOSER_HEADER_TABLE, EComposerHeaderTableClass))
#define E_IS_COMPOSER_HEADER_TABLE(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_COMPOSER_HEADER_TABLE))
#define E_IS_COMPOSER_HEADER_TABLE_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_COMPOSER_HEADER_TABLE))
#define E_COMPOSER_HEADER_TABLE_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_COMPOSER_HEADER_TABLE, EComposerHeaderTableClass))

G_BEGIN_DECLS

typedef struct _EComposerHeaderTable EComposerHeaderTable;
typedef struct _EComposerHeaderTableClass EComposerHeaderTableClass;
typedef struct _EComposerHeaderTablePrivate EComposerHeaderTablePrivate;

/* Headers, listed in the order they should appear in the table. */
typedef enum {
    E_COMPOSER_HEADER_FROM,
    E_COMPOSER_HEADER_REPLY_TO,
    E_COMPOSER_HEADER_TO,
    E_COMPOSER_HEADER_CC,
    E_COMPOSER_HEADER_BCC,
    E_COMPOSER_HEADER_POST_TO,
    E_COMPOSER_HEADER_SUBJECT,
    E_COMPOSER_NUM_HEADERS
} EComposerHeaderType;

struct _EComposerHeaderTable {
    GtkTable parent;
    EComposerHeaderTablePrivate *priv;
};

struct _EComposerHeaderTableClass {
    GtkTableClass parent_class;
};

GType       e_composer_header_table_get_type (void);
GtkWidget * e_composer_header_table_new (void);
EComposerHeader * e_composer_header_table_get_header
                        (EComposerHeaderTable *table,
                         EComposerHeaderType type);
gboolean    e_composer_header_table_get_header_sensitive
                        (EComposerHeaderTable *table,
                         EComposerHeaderType type);
void        e_composer_header_table_set_header_sensitive
                        (EComposerHeaderTable *table,
                         EComposerHeaderType type,
                         gboolean sensitive);
gboolean    e_composer_header_table_get_header_visible
                        (EComposerHeaderTable *table,
                         EComposerHeaderType type);
void        e_composer_header_table_set_header_visible
                        (EComposerHeaderTable *table,
                         EComposerHeaderType type,
                         gboolean visible);
EAccount *  e_composer_header_table_get_account
                        (EComposerHeaderTable *table);
gboolean    e_composer_header_table_set_account
                        (EComposerHeaderTable *table,
                         EAccount *account);
EAccountList *  e_composer_header_table_get_account_list
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_account_list
                        (EComposerHeaderTable *table,
                         EAccountList *account_list);
const gchar *   e_composer_header_table_get_account_name
                        (EComposerHeaderTable *table);
gboolean    e_composer_header_table_set_account_name
                        (EComposerHeaderTable *table,
                         const gchar *account_name);
EDestination ** e_composer_header_table_get_destinations
                        (EComposerHeaderTable *table);
EDestination ** e_composer_header_table_get_destinations_bcc
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_destinations_bcc
                        (EComposerHeaderTable *table,
                         EDestination **destinations);
EDestination ** e_composer_header_table_get_destinations_cc
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_destinations_cc
                        (EComposerHeaderTable *table,
                         EDestination **destinations);
EDestination ** e_composer_header_table_get_destinations_to
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_destinations_to
                        (EComposerHeaderTable *table,
                         EDestination **destinations);
GList *     e_composer_header_table_get_post_to
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_post_to_base
                        (EComposerHeaderTable *table,
                         const gchar *base_url,
                         const gchar *post_to);
void        e_composer_header_table_set_post_to_list
                        (EComposerHeaderTable *table,
                         GList *folder_list);
const gchar *   e_composer_header_table_get_reply_to
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_reply_to
                        (EComposerHeaderTable *table,
                         const gchar *reply_to);
ESignature *    e_composer_header_table_get_signature
                        (EComposerHeaderTable *table);
gboolean    e_composer_header_table_set_signature
                        (EComposerHeaderTable *table,
                         ESignature *signature);
ESignatureList *e_composer_header_table_get_signature_list
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_signature_list
                        (EComposerHeaderTable *table,
                         ESignatureList *signature_list);
const gchar *   e_composer_header_table_get_subject
                        (EComposerHeaderTable *table);
void        e_composer_header_table_set_subject
                        (EComposerHeaderTable *table,
                         const gchar *subject);

G_END_DECLS

#endif /* E_COMPOSER_HEADER_TABLE_H */
a id='n633' href='#n633'>633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
/*
    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 Lefteris Karapetsas <lefteris@ethdev.com>
 * @date 2014
 * Unit tests for the solidity compiler JSON Interface output.
 */

#include <test/Options.h>
#include <string>
#include <libdevcore/JSON.h>
#include <libsolidity/interface/CompilerStack.h>
#include <libsolidity/interface/Exceptions.h>
#include <libdevcore/Exceptions.h>

namespace dev
{
namespace solidity
{
namespace test
{

class DocumentationChecker
{
public:
    DocumentationChecker(): m_compilerStack() {}

    void checkNatspec(
        std::string const& _code,
        std::string const& _contractName,
        std::string const& _expectedDocumentationString,
        bool _userDocumentation
    )
    {
        m_compilerStack.reset(false);
        m_compilerStack.addSource("", "pragma solidity >=0.0;\n" + _code);
        m_compilerStack.setEVMVersion(dev::test::Options::get().evmVersion());
        BOOST_REQUIRE_MESSAGE(m_compilerStack.parseAndAnalyze(), "Parsing contract failed");

        Json::Value generatedDocumentation;
        if (_userDocumentation)
            generatedDocumentation = m_compilerStack.natspecUser(_contractName);
        else
            generatedDocumentation = m_compilerStack.natspecDev(_contractName);
        Json::Value expectedDocumentation;
        jsonParseStrict(_expectedDocumentationString, expectedDocumentation);
        BOOST_CHECK_MESSAGE(
            expectedDocumentation == generatedDocumentation,
            "Expected:\n" << expectedDocumentation.toStyledString() <<
            "\n but got:\n" << generatedDocumentation.toStyledString()
        );
    }

    void expectNatspecError(std::string const& _code)
    {
        m_compilerStack.reset(false);
        m_compilerStack.addSource("", "pragma solidity >=0.0;\n" + _code);
        m_compilerStack.setEVMVersion(dev::test::Options::get().evmVersion());
        BOOST_CHECK(!m_compilerStack.parseAndAnalyze());
        BOOST_REQUIRE(Error::containsErrorOfType(m_compilerStack.errors(), Error::Type::DocstringParsingError));
    }

private:
    CompilerStack m_compilerStack;
};

BOOST_FIXTURE_TEST_SUITE(SolidityNatspecJSON, DocumentationChecker)

BOOST_AUTO_TEST_CASE(user_basic_test)
{
    char const* sourceCode = R"(
        contract test {
            /// @notice Multiplies `a` by 7
            function mul(uint a) public returns(uint d) { return a * 7; }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \"notice\": \"Multiplies `a` by 7\"}"
    "}}";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_and_user_basic_test)
{
    char const* sourceCode = R"(
        contract test {
            /// @notice Multiplies `a` by 7
            /// @dev Multiplies a number by 7
            function mul(uint a) public returns (uint d) { return a * 7; }
        }
    )";

    char const* devNatspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7\"\n"
    "        }\n"
    "    }\n"
    "}}";

    char const* userNatspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \"notice\": \"Multiplies `a` by 7\"}"
    "}}";

    checkNatspec(sourceCode, "test", devNatspec, false);
    checkNatspec(sourceCode, "test", userNatspec, true);
}

BOOST_AUTO_TEST_CASE(user_multiline_comment)
{
    char const* sourceCode = R"(
        contract test {
            /// @notice Multiplies `a` by 7
            /// and then adds `b`
            function mul_and_add(uint a, uint256 b) public returns (uint256 d) {
                return (a * 7) + b;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul_and_add(uint256,uint256)\":{ \"notice\": \"Multiplies `a` by 7 and then adds `b`\"}"
    "}}";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(user_multiple_functions)
{
    char const* sourceCode = R"(
        contract test {
            /// @notice Multiplies `a` by 7 and then adds `b`
            function mul_and_add(uint a, uint256 b) public returns (uint256 d) {
                return (a * 7) + b;
            }

            /// @notice Divides `input` by `div`
            function divide(uint input, uint div) public returns (uint d) {
                return input / div;
            }

            /// @notice Subtracts 3 from `input`
            function sub(int input) public returns (int d) {
                return input - 3;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul_and_add(uint256,uint256)\":{ \"notice\": \"Multiplies `a` by 7 and then adds `b`\"},"
    "    \"divide(uint256,uint256)\":{ \"notice\": \"Divides `input` by `div`\"},"
    "    \"sub(int256)\":{ \"notice\": \"Subtracts 3 from `input`\"}"
    "}}";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(user_empty_contract)
{
    char const* sourceCode = R"(
        contract test { }
    )";

    char const* natspec = "{\"methods\":{} }";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_and_user_no_doc)
{
    char const* sourceCode = R"(
        contract test {
            function mul(uint a) public returns (uint d) {
                return a * 7;
            }
            function sub(int input) public returns (int d) {
                return input - 3;
            }
        }
    )";

    char const* devNatspec = "{\"methods\":{}}";
    char const* userNatspec = "{\"methods\":{}}";

    checkNatspec(sourceCode, "test", devNatspec, false);
    checkNatspec(sourceCode, "test", userNatspec, true);
}

BOOST_AUTO_TEST_CASE(dev_desc_after_nl)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev
            /// Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param second Documentation for the second parameter
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiple_params)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param second Documentation for the second parameter
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiple_params_mixed_whitespace)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev  Multiplies a number by 7 and adds second parameter\n"
    "  /// @param    a Documentation for the first parameter\n"
    "  /// @param    second          Documentation for the second parameter\n"
    "  function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_mutiline_param_description)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter starts here.
            /// Since it's a really complicated parameter we need 2 lines
            /// @param second Documentation for the second parameter
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiple_functions)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param second Documentation for the second parameter
            function mul(uint a, uint second) public returns (uint d) {
                return a * 7 + second;
            }
            /// @dev Divides 2 numbers
            /// @param input Documentation for the input parameter
            /// @param div Documentation for the div parameter
            function divide(uint input, uint div) public returns (uint d) {
                return input / div;
            }
            /// @dev Subtracts 3 from `input`
            /// @param input Documentation for the input parameter
            function sub(int input) public returns (int d) {
                return input - 3;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    },\n"
    "    \"divide(uint256,uint256)\":{ \n"
    "        \"details\": \"Divides 2 numbers\",\n"
    "        \"params\": {\n"
    "            \"input\": \"Documentation for the input parameter\",\n"
    "            \"div\": \"Documentation for the div parameter\"\n"
    "        }\n"
    "    },\n"
    "    \"sub(int256)\":{ \n"
    "        \"details\": \"Subtracts 3 from `input`\",\n"
    "        \"params\": {\n"
    "            \"input\": \"Documentation for the input parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_return)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter starts here.
            /// Since it's a really complicated parameter we need 2 lines
            /// @param second Documentation for the second parameter
            /// @return The result of the multiplication
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}
BOOST_AUTO_TEST_CASE(dev_return_desc_after_nl)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter starts here.
            /// Since it's a really complicated parameter we need 2 lines
            /// @param second Documentation for the second parameter
            /// @return
            /// The result of the multiplication
            function mul(uint a, uint second) public returns (uint d) {
                return a * 7 + second;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}


BOOST_AUTO_TEST_CASE(dev_multiline_return)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter starts here.
            /// Since it's a really complicated parameter we need 2 lines
            /// @param second Documentation for the second parameter
            /// @return The result of the multiplication
            /// and cookies with nutella
            function mul(uint a, uint second) public returns (uint d) {
                return a * 7 + second;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication and cookies with nutella\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiline_comment)
{
    char const* sourceCode = R"(
        contract test {
            /**
             * @dev Multiplies a number by 7 and adds second parameter
             * @param a Documentation for the first parameter starts here.
             * Since it's a really complicated parameter we need 2 lines
             * @param second Documentation for the second parameter
             * @return The result of the multiplication
             * and cookies with nutella
             */
            function mul(uint a, uint second) public returns (uint d) {
                return a * 7 + second;
            }
        }
    )";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication and cookies with nutella\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_contract_no_doc)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Mul function
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\"\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_contract_doc)
{
    char const* sourceCode = R"(
        /// @author Lefteris
        /// @title Just a test contract
        contract test {
            /// @dev Mul function
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "    \"author\": \"Lefteris\","
    "    \"title\": \"Just a test contract\","
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\"\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_author_at_function)
{
    char const* sourceCode = R"(
        /// @author Lefteris
        /// @title Just a test contract
        contract test {
            /// @dev Mul function
            /// @author John Doe
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    char const* natspec = "{"
    "    \"author\": \"Lefteris\","
    "    \"title\": \"Just a test contract\","
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\",\n"
    "            \"author\": \"John Doe\",\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, "test", natspec, false);
}

BOOST_AUTO_TEST_CASE(natspec_notice_without_tag)
{
    char const* sourceCode = R"(
        contract test {
            /// I do something awesome
            function mul(uint a) public returns (uint d) { return a * 7; }
        }
    )";


    char const* natspec = R"ABCDEF(
    {
       "methods" : {
          "mul(uint256)" : {
             "notice" : "I do something awesome"
          }
       }
    }
    )ABCDEF";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(natspec_multiline_notice_without_tag)
{
    char const* sourceCode = R"(
        contract test {
            /// I do something awesome
            /// which requires two lines to explain
            function mul(uint a) public returns (uint d) { return a * 7; }
        }
    )";

    char const* natspec = R"ABCDEF(
    {
       "methods" : {
          "mul(uint256)" : {
             "notice" : "I do something awesome which requires two lines to explain"
          }
       }
    }
    )ABCDEF";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(empty_comment)
{
    char const* sourceCode = R"(
        //
        contract test
        {}
    )";
    char const* natspec = R"ABCDEF(
    {
       "methods" : {}
    }
    )ABCDEF";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_title_at_function_error)
{
    char const* sourceCode = R"(
        /// @author Lefteris
        /// @title Just a test contract
        contract test {
            /// @dev Mul function
            /// @title I really should not be here
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    expectNatspecError(sourceCode);
}

BOOST_AUTO_TEST_CASE(dev_documenting_nonexistent_param)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param not_existing Documentation for the second parameter
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    expectNatspecError(sourceCode);
}

BOOST_AUTO_TEST_CASE(dev_documenting_no_paramname)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    expectNatspecError(sourceCode);
}

BOOST_AUTO_TEST_CASE(dev_documenting_no_paramname_end)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param se
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    expectNatspecError(sourceCode);
}

BOOST_AUTO_TEST_CASE(dev_documenting_no_param_description)
{
    char const* sourceCode = R"(
        contract test {
            /// @dev Multiplies a number by 7 and adds second parameter
            /// @param a Documentation for the first parameter
            /// @param second
            function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
        }
    )";

    expectNatspecError(sourceCode);
}

BOOST_AUTO_TEST_CASE(user_constructor)
{
    char const *sourceCode = R"(
        contract test {
            /// @notice this is a really nice constructor
            constructor(uint a, uint second) public { }
        }
    )";

    char const *natspec = R"ABCDEF({
    "methods" : {
        "constructor" : "this is a really nice constructor"
    }
    })ABCDEF";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(user_constructor_and_function)
{
    char const *sourceCode = R"(
        contract test {
            /// @notice this is a really nice constructor
            constructor(uint a, uint second) public { }
            /// another multiplier
            function mul(uint a, uint second) public returns(uint d) { return a * 7 + second; }
        }
    )";

    char const *natspec = R"ABCDEF({
    "methods" : {
        "mul(uint256,uint256)" : {
            "notice" : "another multiplier"
        },
        "constructor" : "this is a really nice constructor"
    }
    })ABCDEF";

    checkNatspec(sourceCode, "test", natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_constructor)