Introduce AbstractAssemblyStack interface

Co-authored-by: Alexander Arlt <[email protected]>
Co-authored-by: r0qs <[email protected]>

Author: 3 people

libevmasm/AbstractAssemblyStack.h

@@ -0,0 +1,54 @@
+/*
+	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/>.
+*/
+// SPDX-License-Identifier: GPL-3.0
+
+#pragma once
+
+#include <libevmasm/LinkerObject.h>
+
+#include <libsolutil/Common.h>
+#include <libsolutil/JSON.h>
+
+#include <string>
+#include <vector>
+
+namespace solidity::evmasm
+{
+
+class AbstractAssemblyStack
+{
+public:
+	virtual ~AbstractAssemblyStack() {}
+
+	virtual LinkerObject const& object(std::string const& _contractName) const = 0;
+	virtual LinkerObject const& runtimeObject(std::string const& _contractName) const = 0;
+
+	virtual std::string const* sourceMapping(std::string const& _contractName) const = 0;
+	virtual std::string const* runtimeSourceMapping(std::string const& _contractName) const = 0;
+
+	virtual Json::Value assemblyJSON(std::string const& _contractName) const = 0;
+	virtual std::string assemblyString(std::string const& _contractName, StringMap const& _sourceCodes) const = 0;
+
+	virtual std::string const filesystemFriendlyName(std::string const& _contractName) const = 0;
+
+	virtual std::vector<std::string> contractNames() const = 0;
+	virtual std::vector<std::string> sourceNames() const = 0;
+
+	virtual bool compilationSuccessful() const = 0;
+};
+
+} // namespace solidity::evmasm

libevmasm/CMakeLists.txt

@@ -1,4 +1,5 @@
 set(sources
+	AbstractAssemblyStack.h
 	Assembly.cpp
 	Assembly.h
 	AssemblyItem.cpp

libsolidity/interface/CompilerStack.cpp

@@ -74,7 +74,6 @@
 #include <liblangutil/SemVerHandler.h>
 #include <liblangutil/SourceReferenceFormatter.h>
 
-#include <libevmasm/Exceptions.h>
 
 #include <libsolutil/SwarmHash.h>
 #include <libsolutil/IpfsHash.h>

libsolidity/interface/CompilerStack.h

@@ -41,6 +41,7 @@
 #include <liblangutil/EVMVersion.h>
 #include <liblangutil/SourceLocation.h>
 
+#include <libevmasm/AbstractAssemblyStack.h>
 #include <libevmasm/LinkerObject.h>
 
 #include <libsolutil/Common.h>
@@ -91,7 +92,7 @@ class Analysis;
  * It holds state and can be used to either step through the compilation stages (and abort e.g.
  * before compilation to bytecode) or run the whole compilation in one call.
  */
-class CompilerStack: public langutil::CharStreamProvider
+class CompilerStack: public langutil::CharStreamProvider, public evmasm::AbstractAssemblyStack
 {
 public:
 	/// Noncopyable.
@@ -123,7 +124,7 @@ class CompilerStack: public langutil::CharStreamProvider
 		/// Regular compilation from Solidity source files.
 		Solidity,
 		/// Compilation from an imported Solidity AST.
-		SolidityAST
+		SolidityAST,
 	};
 
 	/// Creates a new compiler stack.
@@ -139,6 +140,8 @@ class CompilerStack: public langutil::CharStreamProvider
 	/// @returns the current state.
 	State state() const { return m_stackState; }
 
+	virtual bool compilationSuccessful() const override { return m_stackState >= CompilationSuccessful; }
+
 	/// Resets the compiler to an empty state. Unless @a _keepSettings is set to true,
 	/// all settings are reset as well.
 	void reset(bool _keepSettings = false);
@@ -234,7 +237,7 @@ class CompilerStack: public langutil::CharStreamProvider
 	bool compile(State _stopAfter = State::CompilationSuccessful);
 
 	/// @returns the list of sources (paths) used
-	std::vector<std::string> sourceNames() const;
+	virtual std::vector<std::string> sourceNames() const override;
 
 	/// @returns a mapping assigning each source name its index inside the vector returned
 	/// by sourceNames().
@@ -255,13 +258,13 @@ class CompilerStack: public langutil::CharStreamProvider
 	std::vector<std::string> const& unhandledSMTLib2Queries() const { return m_unhandledSMTLib2Queries; }
 
 	/// @returns a list of the contract names in the sources.
-	std::vector<std::string> contractNames() const;
+	virtual std::vector<std::string> contractNames() const override;
 
 	/// @returns the name of the last contract. If _sourceName is defined the last contract of that source will be returned.
 	std::string const lastContractName(std::optional<std::string> const& _sourceName = std::nullopt) const;
 
 	/// @returns either the contract's name or a mixture of its name and source file, sanitized for filesystem use
-	std::string const filesystemFriendlyName(std::string const& _contractName) const;
+	virtual std::string const filesystemFriendlyName(std::string const& _contractName) const override;
 
 	/// @returns the IR representation of a contract.
 	std::string const& yulIR(std::string const& _contractName) const;
@@ -276,10 +279,10 @@ class CompilerStack: public langutil::CharStreamProvider
 	Json::Value const& yulIROptimizedAst(std::string const& _contractName) const;
 
 	/// @returns the assembled object for a contract.
-	evmasm::LinkerObject const& object(std::string const& _contractName) const;
+	virtual evmasm::LinkerObject const& object(std::string const& _contractName) const override;
 
 	/// @returns the runtime object for the contract.
-	evmasm::LinkerObject const& runtimeObject(std::string const& _contractName) const;
+	virtual evmasm::LinkerObject const& runtimeObject(std::string const& _contractName) const override;
 
 	/// @returns normal contract assembly items
 	evmasm::AssemblyItems const* assemblyItems(std::string const& _contractName) const;
@@ -293,21 +296,21 @@ class CompilerStack: public langutil::CharStreamProvider
 
 	/// @returns the string that provides a mapping between bytecode and sourcecode or a nullptr
 	/// if the contract does not (yet) have bytecode.
-	std::string const* sourceMapping(std::string const& _contractName) const;
+	virtual std::string const* sourceMapping(std::string const& _contractName) const override;
 
 	/// @returns the string that provides a mapping between runtime bytecode and sourcecode.
 	/// if the contract does not (yet) have bytecode.
-	std::string const* runtimeSourceMapping(std::string const& _contractName) const;
+	virtual std::string const* runtimeSourceMapping(std::string const& _contractName) const override;
 
 	/// @return a verbose text representation of the assembly.
 	/// @arg _sourceCodes is the map of input files to source code strings
 	/// Prerequisite: Successful compilation.
-	std::string assemblyString(std::string const& _contractName, StringMap const& _sourceCodes = StringMap()) const;
+	virtual std::string assemblyString(std::string const& _contractName, StringMap const& _sourceCodes = StringMap()) const override;
 
 	/// @returns a JSON representation of the assembly.
 	/// @arg _sourceCodes is the map of input files to source code strings
 	/// Prerequisite: Successful compilation.
-	Json::Value assemblyJSON(std::string const& _contractName) const;
+	virtual Json::Value assemblyJSON(std::string const& _contractName) const override;
 
 	/// @returns a JSON representing the contract ABI.
 	/// Prerequisite: Successful call to parse or compile.