All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
BinaryNode.h
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
BinaryNode.h
Qore Programming Language
Copyright 2003 - 2013 David Nichols
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _QORE_BINARYNODE_H
#define _QORE_BINARYNODE_H
#include <qore/AbstractQoreNode.h>
class BinaryNode : public SimpleValueQoreNode {
private:
void *ptr;
qore_size_t len;
// not yet implemented
DLLLOCAL BinaryNode(const BinaryNode&);
DLLLOCAL BinaryNode& operator=(const BinaryNode&);
protected:
DLLEXPORT virtual ~BinaryNode();
DLLLOCAL void checkOffset(qore_offset_t& offset) const;
DLLLOCAL void checkOffset(qore_offset_t& offset, qore_offset_t& num) const;
public:
DLLEXPORT BinaryNode(void *p = 0, qore_size_t size = 0);
DLLEXPORT virtual bool getAsBoolImpl() const;
DLLEXPORT virtual int getAsString(QoreString &str, int foff, class ExceptionSink *xsink) const;
DLLEXPORT virtual QoreString *getAsString(bool &del, int foff, class ExceptionSink *xsink) const;
DLLEXPORT virtual class AbstractQoreNode *realCopy() const;
DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const;
DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const;
DLLEXPORT virtual const char *getTypeName() const;
DLLLOCAL virtual AbstractQoreNode *parseInit(LocalVar *oflag, int pflag, int &lvids, const QoreTypeInfo *&typeInfo);
DLLEXPORT int compare(const BinaryNode *obj) const;
DLLEXPORT qore_size_t size() const;
DLLEXPORT bool empty() const;
DLLEXPORT BinaryNode *copy() const;
DLLEXPORT const void *getPtr() const;
DLLEXPORT void append(const void *nptr, qore_size_t size);
DLLEXPORT void append(const BinaryNode *b);
DLLEXPORT void append(const BinaryNode &b);
DLLEXPORT void prepend(const void *nptr, qore_size_t size);
DLLEXPORT void *giveBuffer();
DLLEXPORT int preallocate(qore_size_t size);
DLLEXPORT int setSize(qore_size_t size);
DLLEXPORT void splice(qore_offset_t offset, qore_offset_t length, BinaryNode* extract = 0);
DLLEXPORT void splice(qore_offset_t offset, qore_offset_t length, const void* data, qore_size_t data_len, BinaryNode* extract = 0);
DLLEXPORT int substr(BinaryNode& b, qore_offset_t offset) const;
DLLEXPORT int substr(BinaryNode& b, qore_offset_t offset, qore_offset_t length) const;
DLLEXPORT void clear();
DLLLOCAL static const char *getStaticTypeName() {
return "binary";
}
DLLLOCAL static qore_type_t getStaticTypeCode() {
return NT_BINARY;
}
};
typedef SimpleRefHolder<BinaryNode> BinaryNodeHolder;
#endif // _QORE_BINARYNODE_H
NT_BINARY
const qore_type_t NT_BINARY
type value for BinaryNode
Definition: node_types.h:41
BinaryNode::compare
DLLEXPORT int compare(const BinaryNode *obj) const
returns 0 = equal, 1 = not equal
BinaryNode::is_equal_hard
virtual DLLEXPORT bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality
BinaryNode::size
DLLEXPORT qore_size_t size() const
returns the number of bytes in the object
AbstractQoreNode
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:47
BinaryNode::prepend
DLLEXPORT void prepend(const void *nptr, qore_size_t size)
resizes the object and prepends a copy of the data passed to the beginning of the object ...
qore_size_t
size_t qore_size_t
used for sizes (same range as a pointer)
Definition: common.h:62
qore_offset_t
long qore_offset_t
used for offsets that could be negative
Definition: common.h:65
BinaryNode::is_equal_soft
virtual DLLEXPORT bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality
BinaryNode::realCopy
virtual DLLEXPORT class AbstractQoreNode * realCopy() const
returns a copy of the object; the caller owns the reference count
BinaryNode::preallocate
DLLEXPORT int preallocate(qore_size_t size)
pre-allocates a buffer of a certain size
qore_type_t
signed short qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode) ...
Definition: common.h:59
QoreString
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:42
BinaryNode::splice
DLLEXPORT void splice(qore_offset_t offset, qore_offset_t length, BinaryNode *extract=0)
removes &quot;length&quot; characters from the binary data starting at position &quot;offset&quot;
BinaryNode::setSize
DLLEXPORT int setSize(qore_size_t size)
sets the buffer size after preallocation
BinaryNode::~BinaryNode
virtual DLLEXPORT ~BinaryNode()
frees and memory owned by the object
BinaryNode::parseInit
virtual DLLLOCAL AbstractQoreNode * parseInit(LocalVar *oflag, int pflag, int &lvids, const QoreTypeInfo *&typeInfo)
returns the type information
BinaryNode::empty
DLLEXPORT bool empty() const
returns true if empty
BinaryNode::clear
DLLEXPORT void clear()
frees any managed memory and sets the size to 0
ExceptionSink
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:35
SimpleRefHolder
manages a reference count of a pointer to a class that takes a simple &quot;deref()&quot; call with no argument...
Definition: ReferenceHolder.h:103
BinaryNode::substr
DLLEXPORT int substr(BinaryNode &b, qore_offset_t offset) const
copies data to the BinaryNode argument starting with byte position &quot;offset&quot;
BinaryNode::giveBuffer
DLLEXPORT void * giveBuffer()
returns the data being managed and leaves this object empty
BinaryNode::getTypeName
virtual DLLEXPORT const char * getTypeName() const
returns the type name as a c string
BinaryNode::getStaticTypeName
static DLLLOCAL const char * getStaticTypeName()
returns the type name (useful in templates)
Definition: BinaryNode.h:202
BinaryNode::getStaticTypeCode
static DLLLOCAL qore_type_t getStaticTypeCode()
returns the type code (useful in templates)
Definition: BinaryNode.h:207
SimpleValueQoreNode
base class for simple value types
Definition: AbstractQoreNode.h:417
BinaryNode::getAsBoolImpl
virtual DLLEXPORT bool getAsBoolImpl() const
returns false unless perl-boolean-evaluation is enabled, in which case it returns false only when emp...
BinaryNode::copy
DLLEXPORT BinaryNode * copy() const
returns a copy of the object
BinaryNode::getAsString
virtual DLLEXPORT int getAsString(QoreString &str, int foff, class ExceptionSink *xsink) const
concatenate the verbose string representation of the value to an existing QoreString ...
BinaryNode::getPtr
DLLEXPORT const void * getPtr() const
returns the pointer to the data
BinaryNode::append
DLLEXPORT void append(const void *nptr, qore_size_t size)
resizes the object and appends a copy of the data passed to the object
BinaryNode
holds arbitrary binary data
Definition: BinaryNode.h:33