Documentation.

libethereum/ExtVMFace.cpp

@@ -0,0 +1,38 @@
+/*
+	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 ExtVMFace.cpp
+ * @author Gav Wood <i@gavwood.com>
+ * @date 2014
+ */
+
+#include "ExtVMFace.h"
+
+using namespace std;
+using namespace eth;
+
+ExtVMFace::ExtVMFace(Address _myAddress, Address _caller, Address _origin, u256 _value, u256 _gasPrice, bytesConstRef _data, bytesConstRef _code, BlockInfo const& _previousBlock, BlockInfo const& _currentBlock):
+	myAddress(_myAddress),
+	caller(_caller),
+	origin(_origin),
+	value(_value),
+	gasPrice(_gasPrice),
+	data(_data),
+	code(_code),
+	previousBlock(_previousBlock),
+	currentBlock(_currentBlock)
+{}
+

libethereum/ExtVMFace.h

@@ -22,62 +22,59 @@
 #pragma once
 
 #include <libethcore/Common.h>
-#include "FeeStructure.h"
 #include "BlockInfo.h"
 
 namespace eth
 {
 
-struct Transaction;
+/**
-
+ * @brief A null implementation of the class for specifying VM externalities.
+ */
 class ExtVMFace
 {
 public:
+	/// Null constructor.
 	ExtVMFace() {}
 
-	ExtVMFace(BlockInfo const& _previousBlock, BlockInfo const& _currentBlock):
+	/// Full constructor.
-		previousBlock(_previousBlock),
+	ExtVMFace(Address _myAddress, Address _caller, Address _origin, u256 _value, u256 _gasPrice, bytesConstRef _data, bytesConstRef _code, BlockInfo const& _previousBlock, BlockInfo const& _currentBlock);
-		currentBlock(_currentBlock)
+
-	{}
-
-	ExtVMFace(Address _myAddress, Address _caller, Address _origin, u256 _value, u256 _gasPrice, bytesConstRef _data, bytesConstRef _code, BlockInfo const& _previousBlock, BlockInfo const& _currentBlock):
-		myAddress(_myAddress),
-		caller(_caller),
-		origin(_origin),
-		value(_value),
-		gasPrice(_gasPrice),
-		data(_data),
-		code(_code),
-		previousBlock(_previousBlock),
-		currentBlock(_currentBlock)
-	{}
-
-#pragma warning(push)
-#pragma warning(disable: 4100)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-parameter"
 
+	/// Get the code at the given location in code ROM.
 	byte getCode(u256 _n) const { return _n < code.size() ? code[(unsigned)_n] : 0; }
-	u256 store(u256 _n) { return 0; }
+
-	void setStore(u256 _n, u256 _v) {}
+	/// Read storage location.
-	u256 balance(Address _a) { return 0; }
+	u256 store(u256) { return 0; }
-	void subBalance(u256 _a) {}
+
-	u256 txCount(Address _a) { return 0; }
+	/// Write a value in storage.
-	void suicide(Address _a) {}
+	void setStore(u256, u256) {}
-	h160 create(u256 _endowment, u256* _gas, bytesConstRef _code, bytesConstRef _init) { return h160(); }
+
-	bool call(Address _receiveAddress, u256 _txValue, bytesConstRef _txData, u256* _gas, bytesRef _tx) { return false; }
+	/// Read address's balance.
-
+	u256 balance(Address) { return 0; }
-#pragma GCC diagnostic pop
+
-#pragma warning(pop)
+	/// Subtract amount from address's balance.
-
+	void subBalance(u256) {}
-	Address myAddress;
+
-	Address caller;
+	/// Determine address's TX count.
-	Address origin;
+	u256 txCount(Address) { return 0; }
-	u256 value;
+
-	u256 gasPrice;
+	/// Suicide the associated contract to the given address.
-	bytesConstRef data;
+	void suicide(Address) {}
-	bytesConstRef code;
+
-	BlockInfo previousBlock;					///< The current block's information.
+	/// Create a new contract.
+	h160 create(u256, u256*, bytesConstRef, bytesConstRef) { return h160(); }
+
+	/// Make a new message call.
+	bool call(Address, u256, bytesConstRef, u256*, bytesRef) { return false; }
+
+	Address myAddress;			///< Address associated with executing code (a contract, or contract-to-be).
+	Address caller;				///< Address which sent the message (either equal to origin or a contract).
+	Address origin;				///< Original transactor.
+	u256 value;					///< Value (in Wei) that was passed to this address.
+	u256 gasPrice;				///< Price of gas (that we already paid).
+	bytesConstRef data;			///< Current input data.
+	bytesConstRef code;			///< Current code that is executing.
+	BlockInfo previousBlock;	///< The previous block's information.
 	BlockInfo currentBlock;		///< The current block's information.
 };