holds arbitrary binary data More...

#include <BinaryNode.h>

Inheritance diagram for BinaryNode:

Collaboration diagram for BinaryNode:

Public Member Functions
DLLEXPORT	BinaryNode (void *p=0, size_t size=0)
	creates the object

DLLEXPORT void	append (const BinaryNode &b)
	resizes the object and appends a copy of the data passed to the object

DLLEXPORT void	append (const BinaryNode *b)
	resizes the object and appends a copy of the data passed to the object

DLLEXPORT void	append (const void *nptr, size_t size)
	resizes the object and appends a copy of the data passed to the object

DLLEXPORT BinaryNode *	binRefSelf () const

DLLEXPORT void	clear ()
	frees any managed memory and sets the size to 0

DLLEXPORT int	compare (const BinaryNode *obj) const
	returns 0 = equal, 1 = not equal

DLLEXPORT BinaryNode *	copy () const
	returns a copy of the object

DLLEXPORT bool	empty () const
	returns true if empty

virtual DLLEXPORT bool	getAsBoolImpl () const
	returns false unless perl-boolean-evaluation is enabled, in which case it returns false only when empty

virtual DLLEXPORT QoreString *	getAsString (bool &del, int foff, class ExceptionSink *xsink) const
	returns a QoreString giving the verbose string representation of the List (including all contained values for container types)

virtual DLLEXPORT int	getAsString (QoreString &str, int foff, class ExceptionSink *xsink) const
	concatenate the verbose string representation of the value to an existing QoreString

DLLEXPORT const void *	getPtr () const
	returns the pointer to the data

virtual DLLEXPORT const char *	getTypeName () const
	returns the type name as a c string

DLLEXPORT void *	giveBuffer ()
	returns the data being managed and leaves this object empty

virtual DLLEXPORT bool	is_equal_hard (const AbstractQoreNode v, ExceptionSink xsink) const
	tests for equality

virtual DLLEXPORT bool	is_equal_soft (const AbstractQoreNode v, ExceptionSink xsink) const
	tests for equality

virtual DLLLOCAL int	parseInit (QoreValue &val, QoreParseContext &parse_context)
	returns the type information

DLLEXPORT int	preallocate (size_t size)
	pre-allocates a buffer of a certain size

DLLEXPORT void	prepend (const void *nptr, size_t size)
	resizes the object and prepends a copy of the data passed to the beginning of the object

virtual DLLEXPORT class AbstractQoreNode *	realCopy () const
	returns a copy of the object; the caller owns the reference count

DLLEXPORT int	setSize (size_t size)
	sets the buffer size after preallocation

DLLEXPORT size_t	size () const
	returns the number of bytes in the object

DLLEXPORT void	splice (qore_offset_t offset, qore_offset_t length, BinaryNode *extract=0)
	removes "length" characters from the binary data starting at position "offset"

DLLEXPORT void	splice (qore_offset_t offset, qore_offset_t length, const void data, size_t data_len, BinaryNode extract=0)
	removes "length" characters from the binary data starting at position "offset" and replaces them with the data passed

DLLEXPORT int	substr (BinaryNode &b, qore_offset_t offset) const
	copies data to the BinaryNode argument starting with byte position "offset"

DLLEXPORT int	substr (BinaryNode &b, qore_offset_t offset, qore_offset_t length) const
	copies data to the BinaryNode argument starting with byte position "offset"

DLLEXPORT int	writeTo (size_t pos, const void *nptr, size_t size)
	writes the given data to the given location in the object

Public Member Functions inherited from SimpleValueQoreNode
DLLLOCAL	SimpleValueQoreNode (qore_type_t t, bool n_there_can_be_only_one=false)
	creates the object by assigning the type code and setting the "value" flag, unsetting the "needs_eval" flag, and setting "there_can_be_only_one"

Public Member Functions inherited from SimpleQoreNode
DLLLOCAL	SimpleQoreNode (const SimpleQoreNode &v)
	copy constructor

DLLLOCAL	SimpleQoreNode (qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one=false)
	constructor takes the type and value arguments

DLLEXPORT void	deref (ExceptionSink *xsink)
	decrements the reference count and deletes the object when references = 0

SimpleQoreNode &	operator= (const SimpleQoreNode &)=delete
	this function is not implemented

Public Member Functions inherited from AbstractQoreNode
DLLEXPORT	AbstractQoreNode (const AbstractQoreNode &v)
	copy constructor

DLLEXPORT	AbstractQoreNode (qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one=false, bool n_custom_reference_handlers=false)
	constructor takes the type

virtual DLLEXPORT void	customDeref (ExceptionSink *xsink)

virtual DLLEXPORT void	customRef () const
	special processing when the object's reference count transitions from 0-1

DLLEXPORT void	deref (ExceptionSink *xsink)
	decrements the reference count and calls derefImpl() if there_can_be_only_one is false, otherwise does nothing

virtual DLLEXPORT bool	derefImpl (ExceptionSink *xsink)
	decrements the reference count

DLLEXPORT QoreValue	eval (bool &needs_deref, ExceptionSink *xsink) const
	optionally evaluates the argument

DLLEXPORT QoreValue	eval (ExceptionSink *xsink) const
	evaluates the object and returns a value (or 0)

DLLEXPORT int64	getAsBigInt () const
	returns the 64-bit integer value of the object

virtual DLLLOCAL int64	getAsBigIntImpl () const
	default implementation, returns 0

DLLEXPORT bool	getAsBool () const
	returns the boolean value of the object

DLLEXPORT double	getAsFloat () const
	returns the float value of the object

virtual DLLLOCAL double	getAsFloatImpl () const
	default implementation, returns 0.0

DLLEXPORT int	getAsInt () const
	returns the integer value of the object

virtual DLLLOCAL int	getAsIntImpl () const
	default implementation, returns 0

virtual DLLEXPORT class DateTime *	getDateTimeRepresentation (bool &del) const
	returns the DateTime representation of this type (default implementation: returns ZeroDate, del = false)

virtual DLLEXPORT void	getDateTimeRepresentation (DateTime &dt) const
	assigns the date representation of a value to the DateTime reference passed, default implementation does nothing

virtual DLLEXPORT QoreString *	getStringRepresentation (bool &del) const
	returns the value of the type converted to a string, default implementation: returns the empty string

virtual DLLEXPORT void	getStringRepresentation (QoreString &str) const
	concatentates the value of the type to an existing QoreString reference, default implementation does nothing

DLLLOCAL qore_type_t	getType () const
	returns the data type

DLLLOCAL bool	is_value () const
	returns true if the node represents a value

DLLLOCAL bool	isReferenceCounted () const
	returns true if the object is reference-counted

DLLLOCAL bool	needs_eval () const
	returns true if the object needs evaluation to return a value, false if not

DLLLOCAL AbstractQoreNode &	operator= (const AbstractQoreNode &)
	this function is not implemented; it is here as a private function in order to prohibit it from being used

DLLEXPORT void	ref () const
	increments the reference count

DLLEXPORT AbstractQoreNode *	refSelf () const
	returns "this" with an incremented reference count

Public Member Functions inherited from QoreReferenceCounter
DLLEXPORT	QoreReferenceCounter ()
	Creates the reference counter object.

DLLEXPORT	QoreReferenceCounter (const QoreReferenceCounter &old)
	Creates a new object with a reference count of 1.

DLLEXPORT	~QoreReferenceCounter ()
	destroys the reference counter object

DLLEXPORT bool	is_unique () const
	Returns true if the reference count is 1.

DLLEXPORT bool	optRef ()
	Make a strong reference only if the object is valid.

DLLEXPORT int	reference_count () const
	Gets the reference count.

DLLEXPORT bool	ROdereference () const
	Atomically decrements the reference count.

DLLEXPORT void	ROreference () const
	Atomically increments the reference count.

Static Public Member Functions
static DLLLOCAL qore_type_t	getStaticTypeCode ()
	returns the type code (useful in templates)

static DLLLOCAL const char *	getStaticTypeName ()
	returns the type name (useful in templates)

Protected Member Functions
virtual DLLEXPORT	~BinaryNode ()
	frees and memory owned by the object

Protected Member Functions inherited from SimpleValueQoreNode
virtual DLLEXPORT QoreValue	evalImpl (bool &needs_deref, ExceptionSink *xsink) const
	should never be called for value types

Protected Member Functions inherited from AbstractQoreNode
virtual DLLEXPORT	~AbstractQoreNode ()
	default destructor does nothing

Additional Inherited Members
Protected Attributes inherited from AbstractQoreNode
bool	custom_reference_handlers: 1
	set to one for objects that need custom reference handlers

bool	needs_eval_flag: 1
	if this is true then the type can be evaluated

bool	there_can_be_only_one: 1
	if this is set to true, then reference counting is turned off for objects of this class

qore_type_t	type: 11
	the type of the object

bool	value: 1
	this is true for values, if false then either the type needs evaluation to produce a value or is a parse expression

Detailed Description

holds arbitrary binary data

this class is implemented simply as a pointer and a length indicator

Constructor & Destructor Documentation

◆ BinaryNode()

DLLEXPORT BinaryNode::BinaryNode	(	void *	p = 0,
		size_t	size = 0 )

creates the object

Parameters

p	a pointer to the memory, the BinaryNode object takes over ownership of this pointer
size	the byte length of the memory

References size().

Member Function Documentation

◆ binRefSelf()

DLLEXPORT BinaryNode * BinaryNode::binRefSelf ( ) const

Since: Qore 0.9

◆ copy()

DLLEXPORT BinaryNode * BinaryNode::copy ( ) const

returns a copy of the object

Returns: a copy of the current object

◆ getAsBoolImpl()

virtual DLLEXPORT bool BinaryNode::getAsBoolImpl ( ) const

virtual

returns false unless perl-boolean-evaluation is enabled, in which case it returns false only when empty

Returns: false unless perl-boolean-evaluation is enabled, in which case it returns false only when empty

Reimplemented from AbstractQoreNode.

◆ getAsString() [1/2]

virtual DLLEXPORT QoreString * BinaryNode::getAsString	(	bool &	del,
		int	foff,
		class ExceptionSink *	xsink ) const

virtual

returns a QoreString giving the verbose string representation of the List (including all contained values for container types)

used for n and N printf formatting

Parameters

del	if this is true when the function returns, then the returned QoreString pointer should be deleted, if false, then it must not be
foff	for multi-line formatting offset, -1 = no line breaks
xsink	if an error occurs, the Qore-language exception information will be added here NOTE: Use the QoreNodeAsStringHelper class (defined in QoreStringNode.h) instead of using this function directly

See also: QoreNodeAsStringHelper

Implements AbstractQoreNode.

◆ getAsString() [2/2]

virtual DLLEXPORT int BinaryNode::getAsString	(	QoreString &	str,
		int	foff,
		class ExceptionSink *	xsink ) const

virtual

concatenate the verbose string representation of the value to an existing QoreString

used for n and N printf formatting

Parameters

str	the string representation of the type will be concatenated to this QoreString reference
foff	for multi-line formatting offset, -1 = no line breaks
xsink	if an error occurs, the Qore-language exception information will be added here

Returns: -1 for exception raised, 0 = OK

Implements AbstractQoreNode.

◆ giveBuffer()

DLLEXPORT void * BinaryNode::giveBuffer ( )

returns the data being managed and leaves this object empty

Returns: the data being managed (leaves this object empty)

Note: it would be a grevious error to call this function on an object with a reference_count > 1 (i.e. is_unique() is false)

◆ is_equal_hard()

virtual DLLEXPORT bool BinaryNode::is_equal_hard	(	const AbstractQoreNode *	v,
		ExceptionSink *	xsink ) const

virtual

tests for equality

this function does not throw a Qore-language exception with the BinaryNode class

Parameters

v	the value to compare
xsink	is not used in this implementation of the function

Implements AbstractQoreNode.

References AbstractQoreNode::AbstractQoreNode().

◆ is_equal_soft()

virtual DLLEXPORT bool BinaryNode::is_equal_soft	(	const AbstractQoreNode *	v,
		ExceptionSink *	xsink ) const

virtual

tests for equality

this function does not throw a Qore-language exception with the BinaryNode class

Parameters

v	the value to compare
xsink	is not used in this implementation of the function

Implements AbstractQoreNode.

References AbstractQoreNode::AbstractQoreNode().

◆ preallocate()

DLLEXPORT int BinaryNode::preallocate ( size_t size )

pre-allocates a buffer of a certain size

This function can be used to write data directly to a new BinaryNode object. This call can be made more than once, subsequent calls will cause realloc() to be called on the buffer which can be used to extend the buffer size.

Parameters

size	the number of bytes to pre-allocate

Returns: 0 for OK, -1 for error (memory could not be allocated)

References size().

◆ realCopy()

virtual DLLEXPORT class AbstractQoreNode * BinaryNode::realCopy ( ) const

virtual

returns a copy of the object; the caller owns the reference count

Returns: a copy of the object; the caller owns the reference count

Implements AbstractQoreNode.

References AbstractQoreNode::AbstractQoreNode().

◆ setSize()

DLLEXPORT int BinaryNode::setSize ( size_t size )

sets the buffer size after preallocation

This function is designed to be used with BinaryNode::preallocate(). The size to be set must be less than the currently allocated size.

Parameters

size	the size of the BinaryNode to set

Returns: 0 for OK, -1 for error (size > current size)

References size().

◆ splice() [1/2]

DLLEXPORT void BinaryNode::splice	(	qore_offset_t	offset,
		qore_offset_t	length,
		BinaryNode *	extract = 0 )

removes "length" characters from the binary data starting at position "offset"

Parameters

offset	byte position to start (rest of the data is removed) (offset starts with 0, negative offset means that many positions from the end of the data)
length	the number of bytes to remove (negative length means all but that many bytes from the end of the data)
extract	if non-null, the data removed will be written to this argument

Since: Qore 0.8.8

◆ splice() [2/2]

DLLEXPORT void BinaryNode::splice	(	qore_offset_t	offset,
		qore_offset_t	length,
		const void *	data,
		size_t	data_len,
		BinaryNode *	extract = 0 )

removes "length" characters from the binary data starting at position "offset" and replaces them with the data passed

Parameters

offset	byte position to start (rest of the data is removed) (offset starts with 0, negative offset means that many positions from the end of the data)
length	the number of bytes to remove (negative length means all but that many bytes from the end of the data)
data	the data to insert at byte position "offset" after "length" characters are removed
data_len	the lenght of the data to insert
extract	if non-null, the data removed will be written to this argument

Since: Qore 0.8.8

◆ substr() [1/2]

DLLEXPORT int BinaryNode::substr	(	BinaryNode &	b,
		qore_offset_t	offset ) const

copies data to the BinaryNode argument starting with byte position "offset"

Parameters

b	the target for copying the data
offset	the offset in bytes from the beginning of the data (starting with 0)

Returns: 0 = OK, -1 = error (invalid offset)

Since: Qore 0.8.8

◆ substr() [2/2]

DLLEXPORT int BinaryNode::substr	(	BinaryNode &	b,
		qore_offset_t	offset,
		qore_offset_t	length ) const

copies data to the BinaryNode argument starting with byte position "offset"

Parameters

b	the target for copying the data
offset	the offset in bytes from the beginning of the data (starting with 0)
length	the number of bytes to copy

Returns: 0 = OK, -1 = error (invalid offset)

Since: Qore 0.8.8

◆ writeTo()

DLLEXPORT int BinaryNode::writeTo	(	size_t	pos,
		const void *	nptr,
		size_t	size )

writes the given data to the given location in the object

resizes the object if necessary

Parameters

pos	the byte position where to start writing
nptr	the data to copy to the object
size	the number of bytes to copy to the object

Returns: -1 if the resize failed (out of memory), 0 if OK

Since: Qore 1.12

References size().

The documentation for this class was generated from the following file:

include/qore/BinaryNode.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinaryNode()

Member Function Documentation

◆ binRefSelf()

◆ copy()

◆ getAsBoolImpl()

◆ getAsString() [1/2]

◆ getAsString() [2/2]

◆ giveBuffer()

◆ is_equal_hard()

◆ is_equal_soft()

◆ preallocate()

◆ realCopy()

◆ setSize()

◆ splice() [1/2]

◆ splice() [2/2]

◆ substr() [1/2]

◆ substr() [2/2]

◆ writeTo()