BinaryNode.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
  BinaryNode.h

  Qore Programming Language

  Copyright (C) 2003 - 2014 David Nichols

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.

  Note that the Qore library is released under a choice of three open-source
  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
  information.
*/

#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