aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/interface/InterfaceHandler.h
blob: d4f2eaf4fd427bddd481e452f838750b99e12698 (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
/*
    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
 * Takes the parsed AST and produces the Natspec
 * documentation and the ABI interface
 * https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format
 *
 * Can generally deal with JSON files
 */

#pragma once

#include <string>
#include <memory>
#include <json/json.h>

namespace dev
{
namespace solidity
{

// Forward declarations
class ContractDefinition;
struct DocTag;
enum class DocumentationType: uint8_t;

enum class DocTagType: uint8_t
{
    None = 0,
    Dev,
    Notice,
    Param,
    Return,
    Author,
    Title
};

enum class CommentOwner
{
    Contract,
    Function
};

class InterfaceHandler
{
public:
    /// Get the given type of documentation
    /// @param _contractDef The contract definition
    /// @param _type        The type of the documentation. Can be one of the
    ///                     types provided by @c DocumentationType
    /// @return             A JSON representation of provided type
    static Json::Value documentation(
        ContractDefinition const& _contractDef,
        DocumentationType _type
    );
    /// Get the ABI Interface of the contract
    /// @param _contractDef The contract definition
    /// @return             A JSONrepresentation of the contract's ABI Interface
    static Json::Value abiInterface(ContractDefinition const& _contractDef);
    /// Get the User documentation of the contract
    /// @param _contractDef The contract definition
    /// @return             A JSON representation of the contract's user documentation
    static Json::Value userDocumentation(ContractDefinition const& _contractDef);
    /// Genereates the Developer's documentation of the contract
    /// @param _contractDef The contract definition
    /// @return             A JSON representation
    ///                     of the contract's developer documentation
    static Json::Value devDocumentation(ContractDefinition const& _contractDef);

private:
    /// @returns concatenation of all content under the given tag name.
    static std::string extractDoc(std::multimap<std::string, DocTag> const& _tags, std::string const& _name);
};

} //solidity NS
} // dev NS