lukechilds
/
ethminer
mirror of https://github.com/lukechilds/ethminer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #566 from LefterisJP/natspec_cpp11_enums 

Replacing old cstyle enums with c++11 enums in natspec
cl-refactor
chriseth 10 years ago
parent
65d35ed87d 8857a7a75e
commit
fd6eb8eded
7 changed files with 41 additions and 41 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      libsolidity/CompilerStack.cpp
  2. 4
      libsolidity/CompilerStack.h
  3. 38
      libsolidity/InterfaceHandler.cpp
  4. 20
      libsolidity/InterfaceHandler.h
  5. 6
      solc/main.cpp
  6. 2
      test/solidityJSONInterfaceTest.cpp
  7. 4
      test/solidityNatspecJSON.cpp

8
libsolidity/CompilerStack.cpp
View File

@ -84,7 +84,7 @@ void CompilerStack::streamAssembly(ostream& _outStream)
m_compiler->streamAssembly(_outStream);
}
std::string const& CompilerStack::getJsonDocumentation(enum DocumentationType _type)
std::string const& CompilerStack::getJsonDocumentation(DocumentationType _type)
{
if (!m_parseSuccessful)
BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("Parsing was not successful."));
@ -97,13 +97,13 @@ std::string const& CompilerStack::getJsonDocumentation(enum DocumentationType _t
switch (_type)
{
case NATSPEC_USER:
case DocumentationType::NATSPEC_USER:
createDocIfNotThere(m_userDocumentation);
return *m_userDocumentation;
case NATSPEC_DEV:
case DocumentationType::NATSPEC_DEV:
createDocIfNotThere(m_devDocumentation);
return *m_devDocumentation;
case ABI_INTERFACE:
case DocumentationType::ABI_INTERFACE:
createDocIfNotThere(m_interface);
return *m_interface;
}

4
libsolidity/CompilerStack.h
View File

@ -37,7 +37,7 @@ class Compiler;
class GlobalContext;
class InterfaceHandler;
enum DocumentationType: unsigned short
enum class DocumentationType: uint8_t
{
NATSPEC_USER = 1,
NATSPEC_DEV,
@ -74,7 +74,7 @@ public:
/// Prerequisite: Successful call to parse or compile.
/// @param type The type of the documentation to get.
/// Can be one of 3 types defined at @c documentation_type
std::string const& getJsonDocumentation(enum DocumentationType type);
std::string const& getJsonDocumentation(DocumentationType type);
/// Returns the previously used scanner, useful for counting lines during error reporting.
Scanner const& getScanner() const { return *m_scanner; }

38
libsolidity/InterfaceHandler.cpp
View File

@ -12,19 +12,19 @@ namespace solidity
InterfaceHandler::InterfaceHandler()
{
m_lastTag = DOCTAG_NONE;
m_lastTag = DocTagType::NONE;
}
std::unique_ptr<std::string> InterfaceHandler::getDocumentation(std::shared_ptr<ContractDefinition> _contractDef,
enum DocumentationType _type)
DocumentationType _type)
{
switch(_type)
{
case NATSPEC_USER:
case DocumentationType::NATSPEC_USER:
return getUserDocumentation(_contractDef);
case NATSPEC_DEV:
case DocumentationType::NATSPEC_DEV:
return getDevDocumentation(_contractDef);
case ABI_INTERFACE:
case DocumentationType::ABI_INTERFACE:
return getABIInterface(_contractDef);
}
@ -146,7 +146,7 @@ static inline std::string::const_iterator skipLineOrEOS(std::string::const_itera
std::string::const_iterator InterfaceHandler::parseDocTagLine(std::string::const_iterator _pos,
std::string::const_iterator _end,
std::string& _tagString,
enum DocTagType _tagType)
DocTagType _tagType)
{
auto nlPos = std::find(_pos, _end, '\n');
std::copy(_pos, nlPos, back_inserter(_tagString));
@ -170,7 +170,7 @@ std::string::const_iterator InterfaceHandler::parseDocTagParam(std::string::cons
auto paramDesc = std::string(currPos, nlPos);
m_params.push_back(std::make_pair(paramName, paramDesc));
m_lastTag = DOCTAG_PARAM;
m_lastTag = DocTagType::PARAM;
return skipLineOrEOS(nlPos, _end);
}
@ -197,14 +197,14 @@ std::string::const_iterator InterfaceHandler::parseDocTag(std::string::const_ite
{
// LTODO: need to check for @(start of a tag) between here and the end of line
// for all cases
if (m_lastTag == DOCTAG_NONE || _tag != "")
if (m_lastTag == DocTagType::NONE || _tag != "")
{
if (_tag == "dev")
return parseDocTagLine(_pos, _end, m_dev, DOCTAG_DEV);
return parseDocTagLine(_pos, _end, m_dev, DocTagType::DEV);
else if (_tag == "notice")
return parseDocTagLine(_pos, _end, m_notice, DOCTAG_NOTICE);
return parseDocTagLine(_pos, _end, m_notice, DocTagType::NOTICE);
else if (_tag == "return")
return parseDocTagLine(_pos, _end, m_return, DOCTAG_RETURN);
return parseDocTagLine(_pos, _end, m_return, DocTagType::RETURN);
else if (_tag == "param")
return parseDocTagParam(_pos, _end);
else
@ -222,16 +222,16 @@ std::string::const_iterator InterfaceHandler::appendDocTag(std::string::const_it
{
switch (m_lastTag)
{
case DOCTAG_DEV:
case DocTagType::DEV:
m_dev += " ";
return parseDocTagLine(_pos, _end, m_dev, DOCTAG_DEV);
case DOCTAG_NOTICE:
return parseDocTagLine(_pos, _end, m_dev, DocTagType::DEV);
case DocTagType::NOTICE:
m_notice += " ";
return parseDocTagLine(_pos, _end, m_notice, DOCTAG_NOTICE);
case DOCTAG_RETURN:
return parseDocTagLine(_pos, _end, m_notice, DocTagType::NOTICE);
case DocTagType::RETURN:
m_return += " ";
return parseDocTagLine(_pos, _end, m_return, DOCTAG_RETURN);
case DOCTAG_PARAM:
return parseDocTagLine(_pos, _end, m_return, DocTagType::RETURN);
case DocTagType::PARAM:
return appendDocTagParam(_pos, _end);
default:
BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Internal: Illegal documentation tag type"));
@ -267,7 +267,7 @@ void InterfaceHandler::parseDocString(std::string const& _string)
currPos = parseDocTag(tagNameEndPos + 1, end, std::string(tagPos + 1, tagNameEndPos));
}
else if (m_lastTag != DOCTAG_NONE) // continuation of the previous tag
else if (m_lastTag != DocTagType::NONE) // continuation of the previous tag
currPos = appendDocTag(currPos + 1, end);
else if (currPos != end) // skip the line if a newline was found
currPos = nlPos + 1;

20
libsolidity/InterfaceHandler.h
View File

@ -37,15 +37,15 @@ namespace solidity
// Forward declarations
class ContractDefinition;
enum DocumentationType: unsigned short;
enum class DocumentationType: uint8_t;
enum DocTagType
enum class DocTagType: uint8_t
{
DOCTAG_NONE = 0,
DOCTAG_DEV,
DOCTAG_NOTICE,
DOCTAG_PARAM,
DOCTAG_RETURN
NONE = 0,
DEV,
NOTICE,
PARAM,
RETURN
};
class InterfaceHandler
@ -60,7 +60,7 @@ public:
/// @return A unique pointer contained string with the json
/// representation of provided type
std::unique_ptr<std::string> getDocumentation(std::shared_ptr<ContractDefinition> _contractDef,
enum DocumentationType _type);
DocumentationType _type);
/// Get the ABI Interface of the contract
/// @param _contractDef The contract definition
/// @return A unique pointer contained string with the json
@ -84,7 +84,7 @@ private:
std::string::const_iterator parseDocTagLine(std::string::const_iterator _pos,
std::string::const_iterator _end,
std::string& _tagString,
enum DocTagType _tagType);
DocTagType _tagType);
std::string::const_iterator parseDocTagParam(std::string::const_iterator _pos,
std::string::const_iterator _end);
std::string::const_iterator appendDocTagParam(std::string::const_iterator _pos,
@ -99,7 +99,7 @@ private:
Json::StyledWriter m_writer;
// internal state
enum DocTagType m_lastTag;
DocTagType m_lastTag;
std::string m_notice;
std::string m_dev;
std::string m_return;

6
solc/main.cpp
View File

@ -135,9 +135,9 @@ int main(int argc, char** argv)
cout << "Opcodes:" << endl;
cout << eth::disassemble(compiler.getBytecode()) << endl;
cout << "Binary: " << toHex(compiler.getBytecode()) << endl;
cout << "Interface specification: " << compiler.getJsonDocumentation(ABI_INTERFACE) << endl;
cout << "Natspec user documentation: " << compiler.getJsonDocumentation(NATSPEC_USER) << endl;
cout << "Natspec developer documentation: " << compiler.getJsonDocumentation(NATSPEC_DEV) << endl;
cout << "Interface specification: " << compiler.getJsonDocumentation(DocumentationType::ABI_INTERFACE) << endl;
cout << "Natspec user documentation: " << compiler.getJsonDocumentation(DocumentationType::NATSPEC_USER) << endl;
cout << "Natspec developer documentation: " << compiler.getJsonDocumentation(DocumentationType::NATSPEC_DEV) << endl;
return 0;
}

2
test/solidityJSONInterfaceTest.cpp
View File

@ -50,7 +50,7 @@ public:
msg += *extra;
BOOST_FAIL(msg);
}
std::string generatedInterfaceString = m_compilerStack.getJsonDocumentation(ABI_INTERFACE);
std::string generatedInterfaceString = m_compilerStack.getJsonDocumentation(DocumentationType::ABI_INTERFACE);
Json::Value generatedInterface;
m_reader.parse(generatedInterfaceString, generatedInterface);
Json::Value expectedInterface;

4
test/solidityNatspecJSON.cpp
View File

@ -55,9 +55,9 @@ public:
}
if (_userDocumentation)
generatedDocumentationString = m_compilerStack.getJsonDocumentation(NATSPEC_USER);
generatedDocumentationString = m_compilerStack.getJsonDocumentation(DocumentationType::NATSPEC_USER);
else
generatedDocumentationString = m_compilerStack.getJsonDocumentation(NATSPEC_DEV);
generatedDocumentationString = m_compilerStack.getJsonDocumentation(DocumentationType::NATSPEC_DEV);
Json::Value generatedDocumentation;
m_reader.parse(generatedDocumentationString, generatedDocumentation);
Json::Value expectedDocumentation;

Write Preview
Loading…
Cancel
Save