2014-10-13 16:22:15 +00:00
/*
2014-10-16 12:08:54 +00:00
This file is part of cpp - ethereum .
2014-10-13 16:22:15 +00:00
2014-10-16 12:08:54 +00:00
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 .
2014-10-13 16:22:15 +00:00
2014-10-16 12:08:54 +00:00
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 .
2014-10-13 16:22:15 +00:00
2014-10-16 12:08:54 +00:00
You should have received a copy of the GNU General Public License
along with cpp - ethereum . If not , see < http : //www.gnu.org/licenses/>.
2014-10-13 16:22:15 +00:00
*/
/**
* @ author Christian < c @ ethdev . com >
* @ date 2014
* Solidity data types
*/
# pragma once
# include <memory>
# include <string>
2014-11-20 09:19:43 +00:00
# include <map>
2014-10-13 16:22:15 +00:00
# include <boost/noncopyable.hpp>
2014-10-20 10:41:56 +00:00
# include <libdevcore/Common.h>
2014-11-05 13:20:56 +00:00
# include <libsolidity/Exceptions.h>
2014-10-20 12:00:37 +00:00
# include <libsolidity/ASTForward.h>
2014-10-13 16:22:15 +00:00
# include <libsolidity/Token.h>
2014-10-16 12:08:54 +00:00
namespace dev
{
namespace solidity
{
2014-10-13 16:22:15 +00:00
2014-12-09 17:46:18 +00:00
// @todo realMxN, dynamic strings, text, arrays
2014-10-13 16:22:15 +00:00
2014-11-20 09:19:43 +00:00
class Type ; // forward
2014-12-12 15:49:26 +00:00
class FunctionType ; // forward
2014-11-25 13:43:23 +00:00
using TypePointer = std : : shared_ptr < Type const > ;
2015-01-29 15:39:30 +00:00
using FunctionTypePointer = std : : shared_ptr < FunctionType const > ;
2014-11-25 13:43:23 +00:00
using TypePointers = std : : vector < TypePointer > ;
2014-11-20 09:19:43 +00:00
/**
* List of members of a type .
*/
class MemberList
{
public :
using MemberMap = std : : map < std : : string , TypePointer > ;
MemberList ( ) { }
explicit MemberList ( MemberMap const & _members ) : m_memberTypes ( _members ) { }
TypePointer getMemberType ( std : : string const & _name ) const
{
auto it = m_memberTypes . find ( _name ) ;
2014-11-25 13:43:23 +00:00
return it ! = m_memberTypes . end ( ) ? it - > second : TypePointer ( ) ;
2014-11-20 09:19:43 +00:00
}
MemberMap : : const_iterator begin ( ) const { return m_memberTypes . begin ( ) ; }
MemberMap : : const_iterator end ( ) const { return m_memberTypes . end ( ) ; }
private :
MemberMap m_memberTypes ;
} ;
2014-10-28 15:51:26 +00:00
/**
* Abstract base class that forms the root of the type hierarchy .
*/
2015-01-06 17:55:31 +00:00
class Type : private boost : : noncopyable , public std : : enable_shared_from_this < Type >
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 12:08:54 +00:00
enum class Category
{
2015-01-22 00:02:38 +00:00
INTEGER , INTEGER_CONSTANT , BOOL , REAL , STRING , CONTRACT , STRUCT , FUNCTION , MAPPING , VOID , TYPE , MODIFIER , MAGIC
2014-10-13 16:22:15 +00:00
} ;
2014-10-23 15:06:12 +00:00
///@{
///@name Factory functions
/// Factory functions that convert an AST @ref TypeName to a Type.
2014-12-18 17:53:43 +00:00
static TypePointer fromElementaryTypeName ( Token : : Value _typeToken ) ;
static TypePointer fromUserDefinedTypeName ( UserDefinedTypeName const & _typeName ) ;
static TypePointer fromMapping ( Mapping const & _typeName ) ;
static TypePointer fromFunction ( FunctionDefinition const & _function ) ;
2014-10-23 15:06:12 +00:00
/// @}
2014-10-13 16:22:15 +00:00
2014-11-04 12:24:35 +00:00
/// Auto-detect the proper type for a literal. @returns an empty pointer if the literal does
/// not fit any type.
2014-12-18 17:53:43 +00:00
static TypePointer forLiteral ( Literal const & _literal ) ;
/// @returns a pointer to _a or _b if the other is implicitly convertible to it or nullptr otherwise
static TypePointer commonType ( TypePointer const & _a , TypePointer const & _b ) ;
2014-10-13 16:22:15 +00:00
virtual Category getCategory ( ) const = 0 ;
2014-10-20 10:41:56 +00:00
virtual bool isImplicitlyConvertibleTo ( Type const & _other ) const { return * this = = _other ; }
2014-10-20 11:02:06 +00:00
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const
2014-10-16 12:08:54 +00:00
{
return isImplicitlyConvertibleTo ( _convertTo ) ;
}
2015-01-06 18:08:24 +00:00
/// @returns the resulting type of applying the given unary operator or an empty pointer if
/// this is not possible.
/// The default implementation does not allow any unary operator.
virtual TypePointer unaryOperatorResult ( Token : : Value ) const { return TypePointer ( ) ; }
2015-01-06 17:55:31 +00:00
/// @returns the resulting type of applying the given binary operator or an empty pointer if
/// this is not possible.
/// The default implementation allows comparison operators if a common type exists
virtual TypePointer binaryOperatorResult ( Token : : Value _operator , TypePointer const & _other ) const
{
return Token : : isCompareOp ( _operator ) ? commonType ( shared_from_this ( ) , _other ) : TypePointer ( ) ;
}
2014-10-16 15:57:27 +00:00
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const { return getCategory ( ) = = _other . getCategory ( ) ; }
virtual bool operator ! = ( Type const & _other ) const { return ! this - > operator = = ( _other ) ; }
2014-10-30 17:15:25 +00:00
/// @returns number of bytes used by this type when encoded for CALL, or 0 if the encoding
2015-01-08 23:58:32 +00:00
/// is not a simple big-endian encoding or the type cannot be stored in calldata.
/// Note that irrespective of this size, each calldata element is padded to a multiple of 32 bytes.
2014-10-30 17:15:25 +00:00
virtual unsigned getCalldataEncodedSize ( ) const { return 0 ; }
2014-11-07 01:06:37 +00:00
/// @returns number of bytes required to hold this value in storage.
/// For dynamically "allocated" types, it returns the size of the statically allocated head,
virtual u256 getStorageSize ( ) const { return 1 ; }
2014-11-20 17:33:23 +00:00
/// Returns true if the type can be stored in storage.
virtual bool canBeStored ( ) const { return true ; }
2014-11-10 16:31:09 +00:00
/// Returns false if the type cannot live outside the storage, i.e. if it includes some mapping.
virtual bool canLiveOutsideStorage ( ) const { return true ; }
2014-11-21 18:14:56 +00:00
/// Returns true if the type can be stored as a value (as opposed to a reference) on the stack,
/// i.e. it behaves differently in lvalue context and in value context.
virtual bool isValueType ( ) const { return false ; }
2014-11-25 17:23:39 +00:00
virtual unsigned getSizeOnStack ( ) const { return 1 ; }
2015-02-06 12:42:51 +00:00
/// @returns the real type of some types, like e.g: IntegerConstant
virtual TypePointer getRealType ( ) const { return TypePointer ( ) ; }
2014-10-30 17:15:25 +00:00
2014-11-20 09:19:43 +00:00
/// Returns the list of all members of this type. Default implementation: no members.
virtual MemberList const & getMembers ( ) const { return EmptyMemberList ; }
/// Convenience method, returns the type of the given named member or an empty pointer if no such member exists.
2014-11-25 13:43:23 +00:00
TypePointer getMemberType ( std : : string const & _name ) const { return getMembers ( ) . getMemberType ( _name ) ; }
2014-11-20 09:19:43 +00:00
2014-10-16 15:57:27 +00:00
virtual std : : string toString ( ) const = 0 ;
2014-12-19 10:31:17 +00:00
virtual u256 literalValue ( Literal const * ) const
2014-11-05 13:20:56 +00:00
{
BOOST_THROW_EXCEPTION ( InternalCompilerError ( ) < < errinfo_comment ( " Literal value requested "
2015-02-06 12:42:51 +00:00
" for type without literals. " ) ) ;
2014-11-05 13:20:56 +00:00
}
2014-11-20 09:19:43 +00:00
protected :
/// Convenience object used when returning an empty member list.
static const MemberList EmptyMemberList ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* Any kind of integer type including hash and address .
*/
2014-10-16 21:49:45 +00:00
class IntegerType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 12:08:54 +00:00
enum class Modifier
{
2014-10-13 16:22:15 +00:00
UNSIGNED , SIGNED , HASH , ADDRESS
} ;
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : INTEGER ; }
2014-10-13 16:22:15 +00:00
explicit IntegerType ( int _bits , Modifier _modifier = Modifier : : UNSIGNED ) ;
virtual bool isImplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2014-10-20 11:02:06 +00:00
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2015-01-06 18:08:24 +00:00
virtual TypePointer unaryOperatorResult ( Token : : Value _operator ) const override ;
2015-01-06 17:55:31 +00:00
virtual TypePointer binaryOperatorResult ( Token : : Value _operator , TypePointer const & _other ) const override ;
2014-10-13 16:22:15 +00:00
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-11-20 17:33:23 +00:00
virtual unsigned getCalldataEncodedSize ( ) const override { return m_bits / 8 ; }
2014-11-21 18:14:56 +00:00
virtual bool isValueType ( ) const override { return true ; }
virtual MemberList const & getMembers ( ) const { return isAddress ( ) ? AddressMemberList : EmptyMemberList ; }
2014-10-30 17:15:25 +00:00
2014-10-16 15:57:27 +00:00
virtual std : : string toString ( ) const override ;
2015-02-06 12:42:51 +00:00
virtual TypePointer getRealType ( ) const { return std : : make_shared < IntegerType > ( m_bits , m_modifier ) ; }
2014-10-16 15:57:27 +00:00
2014-10-13 16:22:15 +00:00
int getNumBits ( ) const { return m_bits ; }
bool isHash ( ) const { return m_modifier = = Modifier : : HASH | | m_modifier = = Modifier : : ADDRESS ; }
bool isAddress ( ) const { return m_modifier = = Modifier : : ADDRESS ; }
2015-01-13 10:18:08 +00:00
bool isSigned ( ) const { return m_modifier = = Modifier : : SIGNED ; }
2014-10-20 12:00:37 +00:00
2015-01-07 21:54:56 +00:00
static const MemberList AddressMemberList ;
2014-10-13 16:22:15 +00:00
private :
int m_bits ;
Modifier m_modifier ;
} ;
2014-12-19 10:31:17 +00:00
/**
* Integer constants either literals or computed . Example expressions : 2 , 2 + 10 , ~ 10.
* There is one distinct type per value .
*/
class IntegerConstantType : public Type
{
public :
virtual Category getCategory ( ) const override { return Category : : INTEGER_CONSTANT ; }
static std : : shared_ptr < IntegerConstantType const > fromLiteral ( std : : string const & _literal ) ;
explicit IntegerConstantType ( bigint _value ) : m_value ( _value ) { }
virtual bool isImplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
virtual TypePointer unaryOperatorResult ( Token : : Value _operator ) const override ;
virtual TypePointer binaryOperatorResult ( Token : : Value _operator , TypePointer const & _other ) const override ;
virtual bool operator = = ( Type const & _other ) const override ;
virtual bool canBeStored ( ) const override { return false ; }
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
virtual unsigned getSizeOnStack ( ) const override { return 1 ; }
virtual std : : string toString ( ) const override ;
virtual u256 literalValue ( Literal const * _literal ) const override ;
2015-02-06 12:42:51 +00:00
virtual TypePointer getRealType ( ) const override ;
2014-12-19 10:31:17 +00:00
/// @returns the smallest integer type that can hold the value or an empty pointer if not possible.
std : : shared_ptr < IntegerType const > getIntegerType ( ) const ;
private :
bigint m_value ;
} ;
2014-12-09 17:46:18 +00:00
/**
* String type with fixed length , up to 32 bytes .
*/
class StaticStringType : public Type
{
public :
virtual Category getCategory ( ) const override { return Category : : STRING ; }
/// @returns the smallest string type for the given literal or an empty pointer
/// if no type fits.
static std : : shared_ptr < StaticStringType > smallestTypeForLiteral ( std : : string const & _literal ) ;
2015-01-23 16:36:12 +00:00
explicit StaticStringType ( int _bytes ) ;
2014-12-09 17:46:18 +00:00
virtual bool isImplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2015-01-23 16:36:12 +00:00
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2014-12-09 17:46:18 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
virtual unsigned getCalldataEncodedSize ( ) const override { return m_bytes ; }
virtual bool isValueType ( ) const override { return true ; }
virtual std : : string toString ( ) const override { return " string " + dev : : toString ( m_bytes ) ; }
2014-12-19 10:31:17 +00:00
virtual u256 literalValue ( Literal const * _literal ) const override ;
2015-02-06 15:27:41 +00:00
virtual TypePointer getRealType ( ) const override { return std : : make_shared < StaticStringType > ( m_bytes ) ; }
2014-12-09 17:46:18 +00:00
int getNumBytes ( ) const { return m_bytes ; }
private :
int m_bytes ;
} ;
2014-10-28 15:51:26 +00:00
/**
* The boolean type .
*/
2014-10-16 21:49:45 +00:00
class BoolType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-12-11 13:12:49 +00:00
BoolType ( ) { }
2014-10-13 16:22:15 +00:00
virtual Category getCategory ( ) const { return Category : : BOOL ; }
2014-10-20 11:02:06 +00:00
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2015-01-14 12:52:03 +00:00
virtual TypePointer unaryOperatorResult ( Token : : Value _operator ) const override ;
2015-01-06 17:55:31 +00:00
virtual TypePointer binaryOperatorResult ( Token : : Value _operator , TypePointer const & _other ) const override ;
2014-10-20 10:41:56 +00:00
2014-10-30 17:15:25 +00:00
virtual unsigned getCalldataEncodedSize ( ) const { return 1 ; }
2014-11-21 18:14:56 +00:00
virtual bool isValueType ( ) const override { return true ; }
2014-10-30 17:15:25 +00:00
2014-10-16 15:57:27 +00:00
virtual std : : string toString ( ) const override { return " bool " ; }
2014-12-19 10:31:17 +00:00
virtual u256 literalValue ( Literal const * _literal ) const override ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* The type of a contract instance , there is one distinct type for each contract definition .
*/
2014-10-16 21:49:45 +00:00
class ContractType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : CONTRACT ; }
2015-01-27 13:32:59 +00:00
explicit ContractType ( ContractDefinition const & _contract , bool _super = false ) :
m_contract ( _contract ) , m_super ( _super ) { }
2015-01-07 21:54:56 +00:00
/// Contracts can be implicitly converted to super classes and to addresses.
virtual bool isImplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
/// Contracts can be converted to themselves and to integers.
2014-11-20 17:33:23 +00:00
virtual bool isExplicitlyConvertibleTo ( Type const & _convertTo ) const override ;
2015-01-14 12:52:03 +00:00
virtual TypePointer unaryOperatorResult ( Token : : Value _operator ) const override ;
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-12-04 18:38:24 +00:00
virtual bool isValueType ( ) const override { return true ; }
2014-11-20 17:33:23 +00:00
virtual std : : string toString ( ) const override ;
2014-10-16 15:57:27 +00:00
2014-12-04 18:38:24 +00:00
virtual MemberList const & getMembers ( ) const override ;
2015-01-27 13:32:59 +00:00
bool isSuper ( ) const { return m_super ; }
2015-01-13 17:12:19 +00:00
ContractDefinition const & getContractDefinition ( ) const { return m_contract ; }
2014-12-12 15:49:26 +00:00
/// Returns the function type of the constructor. Note that the location part of the function type
/// is not used, as this type cannot be the type of a variable or expression.
2015-01-29 15:48:39 +00:00
FunctionTypePointer const & getConstructorType ( ) const ;
2014-12-12 15:49:26 +00:00
2015-01-07 21:54:56 +00:00
/// @returns the identifier of the function with the given name or Invalid256 if such a name does
/// not exist.
2015-01-08 16:18:31 +00:00
u256 getFunctionIdentifier ( std : : string const & _functionName ) const ;
2014-12-04 18:38:24 +00:00
2014-10-13 16:22:15 +00:00
private :
ContractDefinition const & m_contract ;
2015-01-27 13:32:59 +00:00
/// If true, it is the "super" type of the current contract, i.e. it contains only inherited
/// members.
bool m_super ;
2014-12-12 15:49:26 +00:00
/// Type of the constructor, @see getConstructorType. Lazily initialized.
2015-01-29 15:48:39 +00:00
mutable FunctionTypePointer m_constructorType ;
2014-12-04 18:38:24 +00:00
/// List of member types, will be lazy-initialized because of recursive references.
mutable std : : unique_ptr < MemberList > m_members ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* The type of a struct instance , there is one distinct type per struct definition .
*/
2014-10-16 21:49:45 +00:00
class StructType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : STRUCT ; }
2015-01-27 13:32:59 +00:00
explicit StructType ( StructDefinition const & _struct ) : m_struct ( _struct ) { }
2015-01-14 12:52:03 +00:00
virtual TypePointer unaryOperatorResult ( Token : : Value _operator ) const override ;
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-11-20 17:33:23 +00:00
virtual u256 getStorageSize ( ) const override ;
virtual bool canLiveOutsideStorage ( ) const override ;
2014-11-25 17:23:39 +00:00
virtual unsigned getSizeOnStack ( ) const override { return 1 ; /*@todo*/ }
2014-11-13 00:12:57 +00:00
virtual std : : string toString ( ) const override ;
2014-11-20 09:19:43 +00:00
virtual MemberList const & getMembers ( ) const override ;
u256 getStorageOffsetOfMember ( std : : string const & _name ) const ;
2014-10-16 15:57:27 +00:00
2014-10-13 16:22:15 +00:00
private :
StructDefinition const & m_struct ;
2014-11-20 09:19:43 +00:00
/// List of member types, will be lazy-initialized because of recursive references.
mutable std : : unique_ptr < MemberList > m_members ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
2014-11-25 13:43:23 +00:00
* The type of a function , identified by its ( return ) parameter types .
* @ todo the return parameters should also have names , i . e . return parameters should be a struct
* type .
2014-10-28 15:51:26 +00:00
*/
2014-10-16 21:49:45 +00:00
class FunctionType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-11-25 17:23:39 +00:00
/// The meaning of the value(s) on the stack referencing the function:
2015-01-12 11:47:37 +00:00
/// INTERNAL: jump tag, EXTERNAL: contract address + function identifier,
2014-12-10 22:01:40 +00:00
/// BARE: contract address (non-abi contract call)
2014-11-25 17:23:39 +00:00
/// OTHERS: special virtual function, nothing on the stack
2015-01-29 13:35:28 +00:00
/// @todo This documentation is outdated, and Location should rather be named "Type"
2015-01-13 17:12:19 +00:00
enum class Location { INTERNAL , EXTERNAL , CREATION , SEND ,
2015-01-12 11:47:37 +00:00
SHA3 , SUICIDE ,
ECRECOVER , SHA256 , RIPEMD160 ,
2015-01-29 13:35:28 +00:00
LOG0 , LOG1 , LOG2 , LOG3 , LOG4 , EVENT ,
2015-01-15 19:25:12 +00:00
SET_GAS , SET_VALUE , BLOCKHASH ,
2015-01-12 11:47:37 +00:00
BARE } ;
2014-11-25 17:23:39 +00:00
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : FUNCTION ; }
2014-12-04 18:38:24 +00:00
explicit FunctionType ( FunctionDefinition const & _function , bool _isInternal = true ) ;
2015-01-22 16:40:22 +00:00
explicit FunctionType ( VariableDeclaration const & _varDecl ) ;
2015-01-29 13:35:28 +00:00
explicit FunctionType ( EventDefinition const & _event ) ;
2015-01-12 12:29:16 +00:00
FunctionType ( strings const & _parameterTypes , strings const & _returnParameterTypes ,
2015-01-12 11:46:52 +00:00
Location _location = Location : : INTERNAL ) :
2015-01-12 12:29:16 +00:00
FunctionType ( parseElementaryTypeVector ( _parameterTypes ) , parseElementaryTypeVector ( _returnParameterTypes ) ,
_location ) { }
2014-11-25 17:23:39 +00:00
FunctionType ( TypePointers const & _parameterTypes , TypePointers const & _returnParameterTypes ,
2015-01-12 11:47:37 +00:00
Location _location = Location : : INTERNAL ,
2015-01-14 10:01:42 +00:00
bool _gasSet = false , bool _valueSet = false ) :
2014-11-25 17:23:39 +00:00
m_parameterTypes ( _parameterTypes ) , m_returnParameterTypes ( _returnParameterTypes ) ,
2015-01-14 10:01:42 +00:00
m_location ( _location ) , m_gasSet ( _gasSet ) , m_valueSet ( _valueSet ) { }
2014-10-13 16:22:15 +00:00
2014-11-25 13:43:23 +00:00
TypePointers const & getParameterTypes ( ) const { return m_parameterTypes ; }
2015-01-23 15:37:06 +00:00
std : : vector < std : : string > const & getParameterNames ( ) const { return m_parameterNames ; }
2015-01-29 15:39:30 +00:00
std : : vector < std : : string > const getParameterTypeNames ( ) const ;
2014-11-25 13:43:23 +00:00
TypePointers const & getReturnParameterTypes ( ) const { return m_returnParameterTypes ; }
2015-01-23 15:37:06 +00:00
std : : vector < std : : string > const & getReturnParameterNames ( ) const { return m_returnParameterNames ; }
2015-01-29 15:39:30 +00:00
std : : vector < std : : string > const getReturnParameterTypeNames ( ) const ;
2014-10-20 12:00:37 +00:00
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-11-13 00:12:57 +00:00
virtual std : : string toString ( ) const override ;
2014-11-20 17:33:23 +00:00
virtual bool canBeStored ( ) const override { return false ; }
virtual u256 getStorageSize ( ) const override { BOOST_THROW_EXCEPTION ( InternalCompilerError ( ) < < errinfo_comment ( " Storage size of non-storable function type requested. " ) ) ; }
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
2014-11-25 17:23:39 +00:00
virtual unsigned getSizeOnStack ( ) const override ;
2015-01-12 11:47:37 +00:00
virtual MemberList const & getMembers ( ) const override ;
2014-11-25 17:23:39 +00:00
2014-12-06 01:39:58 +00:00
Location const & getLocation ( ) const { return m_location ; }
2015-01-29 15:39:30 +00:00
/// @returns the canonical signature of this function type given the function name
/// If @a _name is not provided (empty string) then the @c m_declaration member of the
/// function type is used
std : : string getCanonicalSignature ( std : : string const & _name = " " ) const ;
2015-01-29 17:44:14 +00:00
Declaration const & getDeclaration ( ) const
{
solAssert ( m_declaration , " Requested declaration from a FunctionType that has none " ) ;
return * m_declaration ;
}
bool hasDeclaration ( ) const { return ! ! m_declaration ; }
2015-01-29 15:39:30 +00:00
bool isConstant ( ) const { return m_isConstant ; }
/// @return A shared pointer of an ASTString.
/// Can contain a nullptr in which case indicates absence of documentation
ASTPointer < ASTString > getDocumentation ( ) const ;
2014-10-20 10:41:56 +00:00
2015-01-12 11:47:37 +00:00
bool gasSet ( ) const { return m_gasSet ; }
bool valueSet ( ) const { return m_valueSet ; }
/// @returns a copy of this type, where gas or value are set manually. This will never set one
/// of the parameters to fals.
TypePointer copyAndSetGasOrValue ( bool _setGas , bool _setValue ) const ;
2014-10-13 16:22:15 +00:00
private :
2015-01-12 12:29:16 +00:00
static TypePointers parseElementaryTypeVector ( strings const & _types ) ;
2015-01-12 11:46:52 +00:00
2014-11-25 13:43:23 +00:00
TypePointers m_parameterTypes ;
TypePointers m_returnParameterTypes ;
2015-01-23 15:37:06 +00:00
std : : vector < std : : string > m_parameterNames ;
std : : vector < std : : string > m_returnParameterNames ;
2015-01-14 10:01:42 +00:00
Location const m_location ;
bool const m_gasSet = false ; ///< true iff the gas value to be used is on the stack
bool const m_valueSet = false ; ///< true iff the value to be sent is on the stack
2015-01-29 15:39:30 +00:00
bool m_isConstant ;
2015-01-12 11:47:37 +00:00
mutable std : : unique_ptr < MemberList > m_members ;
2015-01-29 15:39:30 +00:00
Declaration const * m_declaration = nullptr ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* The type of a mapping , there is one distinct type per key / value type pair .
*/
2014-10-16 21:49:45 +00:00
class MappingType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : MAPPING ; }
2014-11-25 13:43:23 +00:00
MappingType ( TypePointer const & _keyType , TypePointer const & _valueType ) :
2014-11-10 16:31:09 +00:00
m_keyType ( _keyType ) , m_valueType ( _valueType ) { }
2014-10-16 15:57:27 +00:00
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-11-13 00:12:57 +00:00
virtual std : : string toString ( ) const override ;
2014-11-20 17:33:23 +00:00
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
2014-10-20 10:41:56 +00:00
2014-12-12 15:49:26 +00:00
TypePointer const & getKeyType ( ) const { return m_keyType ; }
TypePointer const & getValueType ( ) const { return m_valueType ; }
2014-11-13 00:12:57 +00:00
2014-10-13 16:22:15 +00:00
private :
2014-11-25 13:43:23 +00:00
TypePointer m_keyType ;
TypePointer m_valueType ;
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* The void type , can only be implicitly used as the type that is returned by functions without
* return parameters .
*/
2014-10-16 21:49:45 +00:00
class VoidType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : VOID ; }
2014-10-13 16:22:15 +00:00
VoidType ( ) { }
2014-10-20 10:41:56 +00:00
2015-01-06 17:55:31 +00:00
virtual TypePointer binaryOperatorResult ( Token : : Value , TypePointer const & ) const override { return TypePointer ( ) ; }
2014-10-16 15:57:27 +00:00
virtual std : : string toString ( ) const override { return " void " ; }
2014-11-20 17:33:23 +00:00
virtual bool canBeStored ( ) const override { return false ; }
virtual u256 getStorageSize ( ) const override { BOOST_THROW_EXCEPTION ( InternalCompilerError ( ) < < errinfo_comment ( " Storage size of non-storable void type requested. " ) ) ; }
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
2014-11-25 17:23:39 +00:00
virtual unsigned getSizeOnStack ( ) const override { return 0 ; }
2014-10-13 16:22:15 +00:00
} ;
2014-10-28 15:51:26 +00:00
/**
* The type of a type reference . The type of " uint32 " when used in " a = uint32(2) " is an example
* of a TypeType .
*/
2014-10-16 21:49:45 +00:00
class TypeType : public Type
2014-10-13 16:22:15 +00:00
{
public :
2014-10-16 15:57:27 +00:00
virtual Category getCategory ( ) const override { return Category : : TYPE ; }
2015-01-27 13:32:59 +00:00
explicit TypeType ( TypePointer const & _actualType , ContractDefinition const * _currentContract = nullptr ) :
2015-01-19 18:18:34 +00:00
m_actualType ( _actualType ) , m_currentContract ( _currentContract ) { }
2014-11-25 13:43:23 +00:00
TypePointer const & getActualType ( ) const { return m_actualType ; }
2014-10-13 16:22:15 +00:00
2015-01-06 17:55:31 +00:00
virtual TypePointer binaryOperatorResult ( Token : : Value , TypePointer const & ) const override { return TypePointer ( ) ; }
2014-10-20 10:41:56 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
2014-11-20 17:33:23 +00:00
virtual bool canBeStored ( ) const override { return false ; }
virtual u256 getStorageSize ( ) const override { BOOST_THROW_EXCEPTION ( InternalCompilerError ( ) < < errinfo_comment ( " Storage size of non-storable type type requested. " ) ) ; }
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
2015-01-28 17:19:01 +00:00
virtual unsigned getSizeOnStack ( ) const override { return 0 ; }
2014-10-16 15:57:27 +00:00
virtual std : : string toString ( ) const override { return " type( " + m_actualType - > toString ( ) + " ) " ; }
2015-01-19 18:18:34 +00:00
virtual MemberList const & getMembers ( ) const override ;
2014-10-16 15:57:27 +00:00
2014-10-13 16:22:15 +00:00
private :
2014-11-25 13:43:23 +00:00
TypePointer m_actualType ;
2015-01-19 18:18:34 +00:00
/// Context in which this type is used (influences visibility etc.), can be nullptr.
ContractDefinition const * m_currentContract ;
/// List of member types, will be lazy-initialized because of recursive references.
mutable std : : unique_ptr < MemberList > m_members ;
2014-10-13 16:22:15 +00:00
} ;
2015-01-22 00:02:38 +00:00
/**
* The type of a function modifier . Not used for anything for now .
*/
class ModifierType : public Type
{
public :
virtual Category getCategory ( ) const override { return Category : : MODIFIER ; }
explicit ModifierType ( ModifierDefinition const & _modifier ) ;
virtual TypePointer binaryOperatorResult ( Token : : Value , TypePointer const & ) const override { return TypePointer ( ) ; }
virtual bool canBeStored ( ) const override { return false ; }
virtual u256 getStorageSize ( ) const override { BOOST_THROW_EXCEPTION ( InternalCompilerError ( ) < < errinfo_comment ( " Storage size of non-storable type type requested. " ) ) ; }
virtual bool canLiveOutsideStorage ( ) const override { return false ; }
2015-01-28 17:19:01 +00:00
virtual unsigned getSizeOnStack ( ) const override { return 0 ; }
2015-01-22 00:02:38 +00:00
virtual bool operator = = ( Type const & _other ) const override ;
virtual std : : string toString ( ) const override ;
private :
TypePointers m_parameterTypes ;
} ;
2014-11-24 12:23:58 +00:00
/**
* Special type for magic variables ( block , msg , tx ) , similar to a struct but without any reference
* ( it always references a global singleton by name ) .
*/
class MagicType : public Type
{
public :
2014-11-26 12:19:17 +00:00
enum class Kind { BLOCK , MSG , TX } ;
2014-11-24 12:23:58 +00:00
virtual Category getCategory ( ) const override { return Category : : MAGIC ; }
2015-01-27 13:32:59 +00:00
explicit MagicType ( Kind _kind ) ;
2015-01-06 17:55:31 +00:00
virtual TypePointer binaryOperatorResult ( Token : : Value , TypePointer const & ) const override
{
return TypePointer ( ) ;
}
2014-11-24 12:23:58 +00:00
virtual bool operator = = ( Type const & _other ) const ;
virtual bool canBeStored ( ) const override { return false ; }
virtual bool canLiveOutsideStorage ( ) const override { return true ; }
2014-11-25 17:23:39 +00:00
virtual unsigned getSizeOnStack ( ) const override { return 0 ; }
2014-11-24 12:23:58 +00:00
virtual MemberList const & getMembers ( ) const override { return m_members ; }
virtual std : : string toString ( ) const override ;
private :
Kind m_kind ;
MemberList m_members ;
} ;
2014-10-16 12:08:54 +00:00
}
}