You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
56 lines
1.9 KiB
56 lines
1.9 KiB
/*
|
|
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/>.
|
|
*/
|
|
|
|
/** @file NatspecHandler.h
|
|
* @author Lefteris Karapetsas <lefteris@ethdev.com>
|
|
* @date 2015
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#pragma warning(push)
|
|
#pragma warning(disable: 4100 4267)
|
|
#include <leveldb/db.h>
|
|
#pragma warning(pop)
|
|
#include <jsoncpp/json/json.h>
|
|
#include <libdevcore/FixedHash.h>
|
|
|
|
namespace ldb = leveldb;
|
|
|
|
class NatspecHandler
|
|
{
|
|
public:
|
|
NatspecHandler();
|
|
|
|
/// Stores locally in a levelDB a key value pair of contract code hash to natspec documentation
|
|
void add(dev::h256 const& _contractHash, std::string const& _doc);
|
|
/// Retrieves the natspec documentation as a string given a contract code hash
|
|
std::string retrieve(dev::h256 const& _contractHash) const;
|
|
|
|
/// Given a json natspec string, retrieve the user notice string
|
|
std::string getUserNotice(std::string const& json, std::string const& _methodName);
|
|
/// Given a contract code hash, retrieve the natspec documentation's user notice for that contract
|
|
/// @returns The user notice or an empty string if no natspec for the contract exists
|
|
/// or if the existing natspec does not document the @c _methodName
|
|
std::string getUserNotice(dev::h256 const& _contractHash, std::string const& _methodName);
|
|
|
|
private:
|
|
ldb::ReadOptions m_readOptions;
|
|
ldb::WriteOptions m_writeOptions;
|
|
ldb::DB* m_db;
|
|
Json::Reader m_reader;
|
|
};
|
|
|