Package convex.core.lang.ops

Class Special<T extends ACell>

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.lang.AOp<T>

convex.core.lang.ops.Special<T>

Type Parameters:

T - Type of special value

All Implemented Interfaces:

IValidated, IWriteable

public class Special<T extends ACell>
extends AOp<T>

Op representing special Symbols like *address* and *caller*

Field Summary

Fields

Modifier and Type	Field	Description
static final Symbol[]	SYMBOLS

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Method Summary

Modifier and Type	Method	Description
static final Special<?>	create(int opCode)	Creates special Op for the given opCode
int	encodeRaw(byte[] bs, int pos)	Writes the raw data for this Op to the specified bytebuffer.
Context	execute(Context ctx)	Executes this op with the given context.
static <R extends ACell> Special<R>	forSymbol(Symbol sym)	Gets the special Op for a given Symbol, or null if not found
static <R extends ACell> Special<R>	get(String string)
int	getRefCount()	Gets the number of Refs contained within this Cell.
byte	opCode()	Returns the opcode for this op
boolean	print(BlobBuilder bb, long limit)	Prints this Object to a readable String Representation.
static <T extends ACell> AOp<T>	read(Blob b, int pos)
Special<T>	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.lang.AOp

encode, equals, estimatedEncodingSize, getTag, getType, isCanonical, isCVMValue, isDataValue, toCanonical

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, getRef, hashCode, isEmbedded, toCVMString, toString, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SYMBOLS

public static final Symbol[] SYMBOLS

Method Details

create

public static final Special<?> create(int opCode)

Creates special Op for the given opCode

Parameters:

opCode - Special opcode

Returns:

Special instance, or null if not found

execute

public Context execute(Context ctx)

Description copied from class: AOp

Executes this op with the given context. Must preserve depth unless an exceptional is returned.

Specified by:

execute in class AOp<T extends ACell>

Parameters:

ctx - Initial Context

Returns:

The updated Context after executing this operation

opCode

public byte opCode()

Description copied from class: AOp

Returns the opcode for this op

Specified by:

opCode in class AOp<T extends ACell>

Returns:

Opcode as a byte

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: AOp

Writes the raw data for this Op to the specified bytebuffer. Assumes Op tag and opcode already written.

Specified by:

encodeRaw in class AOp<T extends ACell>

Parameters:

bs - Byte array to write to

pos - Position to write in byte array

Returns:

The updated position

updateRefs

public Special<T> updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Specified by:

updateRefs in class AOp<T extends ACell>

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell

print

public boolean print(BlobBuilder bb,
 long limit)

Description copied from class: AObject

Prints this Object to a readable String Representation. SECURITY: Must halt and return false in O(1) time when limit of printing is exceeded otherwise DoS attacks may be possible.

Specified by:

print in class AObject

Parameters:

bb - BlobBuilder to append to. May be partially written if print limit exceeded

limit - Limit of printing in string bytes

Returns:

True if fully printed within limit, false otherwise

forSymbol

public static <R extends ACell> Special<R> forSymbol(Symbol sym)

Gets the special Op for a given Symbol, or null if not found

Type Parameters:

R - Result type

Parameters:

sym - Symbol to look up

Returns:

Special Op or null

get

public static <R extends ACell> Special<R> get(String string)

read

public static <T extends ACell> AOp<T> read(Blob b,
 int pos)
                                     throws BadFormatException

Throws:

BadFormatException