solidity/libsolidity/LValue.h

197 lines
6.5 KiB
C
Raw Normal View History

2015-02-25 14:14:22 +00:00
/*
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 Christian <c@ethdev.com>
* @date 2015
* LValues for use in the expresison compiler.
*/
#pragma once
#include <memory>
#include <libevmasm/SourceLocation.h>
2015-02-25 19:27:55 +00:00
#include <libsolidity/ArrayUtils.h>
2015-02-25 14:14:22 +00:00
namespace dev
{
namespace solidity
{
class Declaration;
class Type;
2015-02-25 19:27:55 +00:00
class ArrayType;
2015-02-25 14:14:22 +00:00
class CompilerContext;
/**
* Abstract class used to retrieve, delete and store data in lvalues/variables.
*/
class LValue
{
protected:
2015-02-25 19:27:55 +00:00
LValue(CompilerContext& _compilerContext, Type const& _dataType):
2015-02-25 14:14:22 +00:00
m_context(_compilerContext), m_dataType(_dataType) {}
public:
2015-03-03 16:55:28 +00:00
/// @returns the number of stack slots occupied by the lvalue reference
virtual unsigned sizeOnStack() const { return 1; }
2015-02-25 14:14:22 +00:00
/// Copies the value of the current lvalue to the top of the stack and, if @a _remove is true,
/// also removes the reference from the stack.
/// @a _location source location of the current expression, used for error reporting.
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const = 0;
/// Moves a value from the stack to the lvalue. Removes the value if @a _move is true.
/// @a _location is the source location of the expression that caused this operation.
/// Stack pre: value [lvalue_ref]
2015-02-25 15:00:23 +00:00
/// Stack post: if !_move: value_of(lvalue_ref)
2015-02-25 14:14:22 +00:00
virtual void storeValue(Type const& _sourceType,
SourceLocation const& _location = SourceLocation(), bool _move = false) const = 0;
2015-02-25 19:27:55 +00:00
/// Stores zero in the lvalue. Removes the reference from the stack if @a _removeReference is true.
2015-02-25 14:14:22 +00:00
/// @a _location is the source location of the requested operation
2015-02-25 19:27:55 +00:00
virtual void setToZero(
2015-03-05 14:41:39 +00:00
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const = 0;
2015-02-25 14:14:22 +00:00
protected:
CompilerContext& m_context;
2015-02-25 19:27:55 +00:00
Type const& m_dataType;
2015-02-25 14:14:22 +00:00
};
/**
* Local variable that is completely stored on the stack.
*/
class StackVariable: public LValue
{
public:
2015-02-25 19:27:55 +00:00
StackVariable(CompilerContext& _compilerContext, Declaration const& _declaration);
2015-02-25 14:14:22 +00:00
2015-03-03 16:55:28 +00:00
virtual unsigned sizeOnStack() const override { return 0; }
2015-02-25 14:14:22 +00:00
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const override;
2015-03-05 14:41:39 +00:00
virtual void storeValue(
Type const& _sourceType,
SourceLocation const& _location = SourceLocation(),
bool _move = false
) const override;
2015-02-25 19:27:55 +00:00
virtual void setToZero(
2015-03-05 14:41:39 +00:00
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const override;
2015-02-25 14:14:22 +00:00
private:
2015-08-31 16:44:29 +00:00
/// Base stack offset (@see CompilerContext::baseStackOffsetOfVariable) of the local variable.
2015-02-25 14:14:22 +00:00
unsigned m_baseStackOffset;
/// Number of stack elements occupied by the value (not the reference).
unsigned m_size;
};
/**
* Reference to some item in memory.
*/
class MemoryItem: public LValue
{
public:
2015-06-30 09:54:51 +00:00
MemoryItem(CompilerContext& _compilerContext, Type const& _type, bool _padded = true);
virtual unsigned sizeOnStack() const override { return 1; }
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const override;
virtual void storeValue(
Type const& _sourceType,
SourceLocation const& _location = SourceLocation(),
bool _move = false
) const override;
virtual void setToZero(
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const override;
private:
/// Special flag to deal with byte array elements.
bool m_padded = false;
};
2015-02-25 14:14:22 +00:00
/**
* Reference to some item in storage. On the stack this is <storage key> <offset_inside_value>,
* where 0 <= offset_inside_value < 32 and an offset of i means that the value is multiplied
* by 2**i before storing it.
2015-02-25 14:14:22 +00:00
*/
class StorageItem: public LValue
{
public:
/// Constructs the LValue and pushes the location of @a _declaration onto the stack.
2015-02-25 19:27:55 +00:00
StorageItem(CompilerContext& _compilerContext, Declaration const& _declaration);
2015-02-25 14:14:22 +00:00
/// Constructs the LValue and assumes that the storage reference is already on the stack.
2015-02-25 19:27:55 +00:00
StorageItem(CompilerContext& _compilerContext, Type const& _type);
2015-06-08 10:13:44 +00:00
virtual unsigned sizeOnStack() const override { return 2; }
2015-02-25 14:14:22 +00:00
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const override;
2015-03-05 14:41:39 +00:00
virtual void storeValue(
Type const& _sourceType,
SourceLocation const& _location = SourceLocation(),
bool _move = false
) const override;
2015-02-25 19:27:55 +00:00
virtual void setToZero(
2015-03-05 14:41:39 +00:00
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const override;
2015-02-25 14:14:22 +00:00
};
2015-03-03 16:55:28 +00:00
/**
* Reference to a single byte inside a storage byte array.
* Stack: <storage_ref> <byte_number>
*/
class StorageByteArrayElement: public LValue
{
public:
/// Constructs the LValue and assumes that the storage reference is already on the stack.
StorageByteArrayElement(CompilerContext& _compilerContext);
virtual unsigned sizeOnStack() const override { return 2; }
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const override;
2015-03-05 14:41:39 +00:00
virtual void storeValue(
Type const& _sourceType,
SourceLocation const& _location = SourceLocation(),
bool _move = false
) const override;
2015-03-03 16:55:28 +00:00
virtual void setToZero(
2015-03-05 14:41:39 +00:00
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const override;
2015-03-03 16:55:28 +00:00
};
2015-02-25 19:27:55 +00:00
/**
* Reference to the "length" member of a dynamically-sized array. This is an LValue with special
* semantics since assignments to it might reduce its length and thus arrays members have to be
* deleted.
*/
class StorageArrayLength: public LValue
{
public:
/// Constructs the LValue, assumes that the reference to the array head is already on the stack.
StorageArrayLength(CompilerContext& _compilerContext, ArrayType const& _arrayType);
virtual void retrieveValue(SourceLocation const& _location, bool _remove = false) const override;
2015-03-05 14:41:39 +00:00
virtual void storeValue(
Type const& _sourceType,
SourceLocation const& _location = SourceLocation(),
bool _move = false
) const override;
2015-02-25 19:27:55 +00:00
virtual void setToZero(
2015-03-05 14:41:39 +00:00
SourceLocation const& _location = SourceLocation(),
bool _removeReference = true
) const override;
2015-02-25 19:27:55 +00:00
private:
ArrayType const& m_arrayType;
};
2015-02-25 14:14:22 +00:00
}
}