QoreStringNode.h

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

    QoreStringNode Class Definition

    Qore Programming Language

    Copyright (C) 2003 - 2018 Qore Technologies, s.r.o.

    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_QORESTRINGNODE_H

#define _QORE_QORESTRINGNODE_H

#include <qore/AbstractQoreNode.h>
#include <qore/QoreString.h>

#include <cstring>


class QoreStringNode : public SimpleValueQoreNode, public QoreString {
private:
    DLLLOCAL QoreStringNode(QoreString* str);

    DLLLOCAL QoreStringNode& operator=(const QoreStringNode&);

    DLLLOCAL virtual bool getAsBoolImpl() const;
    DLLLOCAL virtual int getAsIntImpl() const;
    DLLLOCAL virtual int64 getAsBigIntImpl() const;
    DLLLOCAL virtual double getAsFloatImpl() const;

protected:
    DLLEXPORT virtual ~QoreStringNode();

public:
    DLLEXPORT QoreStringNode();


    DLLEXPORT QoreStringNode(const char* str, const QoreEncoding* enc = QCS_DEFAULT);


    DLLEXPORT QoreStringNode(const QoreString& str);


    DLLEXPORT QoreStringNode(const QoreStringNode& str);


    DLLEXPORT QoreStringNode(const std::string& str, const QoreEncoding* enc = QCS_DEFAULT);

    // copies binary object and makes a base64-encoded string out of it
    DLLEXPORT QoreStringNode(const BinaryNode* b);

    DLLEXPORT QoreStringNode(const BinaryNode* bin, qore_size_t maxlinelen);


    DLLEXPORT QoreStringNode(char* nbuf, qore_size_t nlen, qore_size_t nallocated, const QoreEncoding* enc);

    DLLEXPORT QoreStringNode(const char* str, qore_size_t len, const QoreEncoding* new_qorecharset = QCS_DEFAULT);

    // creates a string from a single character
    DLLEXPORT QoreStringNode(char c);


    DLLEXPORT int getAsString(QoreString& str, int format_offset, ExceptionSink* xsink) const;


    DLLEXPORT QoreString* getAsString(bool& del, int format_offset, ExceptionSink* xsink) const;


    DLLEXPORT virtual QoreString* getStringRepresentation(bool& del) const;


    DLLEXPORT virtual void getStringRepresentation(QoreString& str) const;


    DLLEXPORT virtual DateTime* getDateTimeRepresentation(bool& del) const;


    DLLEXPORT virtual void getDateTimeRepresentation(DateTime& dt) const;

    DLLEXPORT virtual 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;


    DLLEXPORT QoreStringNode* convertEncoding(const QoreEncoding* nccs, ExceptionSink* xsink) const;


    DLLEXPORT QoreStringNode* substr(qore_offset_t offset, ExceptionSink* xsink) const;


    DLLEXPORT QoreStringNode* substr(qore_offset_t offset, qore_offset_t length, ExceptionSink* xsink) const;

    DLLEXPORT QoreStringNode* reverse() const;

    // copy function
    DLLEXPORT QoreStringNode* copy() const;

    DLLEXPORT static QoreStringNode* createAndConvertEncoding(const char* str, const QoreEncoding* from, const QoreEncoding* to, ExceptionSink* xsink);

    DLLEXPORT QoreStringNode* parseBase64ToString(ExceptionSink* xsink) const;


    DLLEXPORT QoreStringNode* parseBase64ToString(const QoreEncoding* enc, ExceptionSink* xsink) const;

    DLLEXPORT QoreStringNode* stringRefSelf() const;

    DLLLOCAL QoreStringNode(const char* str, const QoreEncoding* from, const QoreEncoding* to, ExceptionSink* xsink);


    DLLEXPORT QoreStringNode* extract(qore_offset_t offset, ExceptionSink* xsink);


    DLLEXPORT QoreStringNode* extract(qore_offset_t offset, qore_offset_t length, ExceptionSink* xsink);


    DLLEXPORT QoreStringNode* extract(qore_offset_t offset, qore_offset_t length, QoreValue strn, ExceptionSink* xsink);

    DLLLOCAL QoreStringNode(struct qore_string_private* p);

    DLLLOCAL static const char* getStaticTypeName() {
        return "string";
    }

    DLLLOCAL static qore_type_t getStaticTypeCode() {
        return NT_STRING;
    }

    static const qore_type_t TYPE = NT_STRING;

    DLLLOCAL virtual void parseInit(QoreValue& val, LocalVar* oflag, int pflag, int& lvids, const QoreTypeInfo*& typeInfo);
};

class QoreStringNodeMaker : public QoreStringNode {
private:
   DLLLOCAL QoreStringNodeMaker(const QoreStringNodeMaker& str);

   DLLLOCAL QoreStringNodeMaker& operator=(const QoreStringNodeMaker&);

public:
   DLLEXPORT QoreStringNodeMaker(const char* fmt, ...);
};

extern QoreStringNode* NullString;


class QoreStringValueHelper {
protected:
   QoreString* str;
   bool del;

   DLLLOCAL QoreStringValueHelper(const QoreStringValueHelper&); // not implemented

   DLLLOCAL QoreStringValueHelper& operator=(const QoreStringValueHelper&); // not implemented

   DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed

   DLLLOCAL void setup(ExceptionSink* xsink, const QoreValue n, const QoreEncoding* enc = 0);

public:
   DLLEXPORT QoreStringValueHelper(const QoreValue n);


   DLLEXPORT QoreStringValueHelper(const QoreValue n, const QoreEncoding* enc, ExceptionSink* xsink);

   DLLLOCAL ~QoreStringValueHelper() {
      if (del)
         delete str;
   }


   DLLLOCAL const QoreString* operator->() { return str; }


   DLLLOCAL const QoreString* operator*() { return str; }


   DLLLOCAL QoreString* giveString() {
      if (!str)
         return 0;
      if (!del)
         return str->copy();

      QoreString* rv = str;
      del = false;
      str = 0;
      return rv;
   }


   DLLLOCAL char* giveBuffer() {
      if (!str)
         return 0;
      if (!del)
         return strdup(str->getBuffer());
      char* rv = str->giveBuffer();
      delete str;
      del = false;
      str = 0;
      return rv;
   }

   DLLLOCAL bool is_temp() const {
      return del;
   }
};


class QoreStringNodeValueHelper {
private:
   QoreStringNode* str;
   bool del;

   DLLLOCAL QoreStringNodeValueHelper(const QoreStringNodeValueHelper&);

   DLLLOCAL QoreStringNodeValueHelper& operator=(const QoreStringNodeValueHelper&);

   DLLLOCAL void* operator new(size_t);

   DLLLOCAL void setup(ExceptionSink* xsink, const QoreValue n, const QoreEncoding* enc = 0);

public:
   DLLEXPORT QoreStringNodeValueHelper(const QoreValue n);


   DLLEXPORT QoreStringNodeValueHelper(const QoreValue n, const QoreEncoding* enc, ExceptionSink* xsink);

   DLLEXPORT ~QoreStringNodeValueHelper();


   DLLLOCAL const QoreStringNode* operator->() { return str; }


   DLLLOCAL const QoreStringNode* operator*() { return str; }


   DLLEXPORT QoreStringNode* getReferencedValue();

   DLLLOCAL bool is_temp() const {
      return del;
   }
};

#include <qore/ReferenceHolder.h>


typedef SimpleRefHolder<QoreStringNode> QoreStringNodeHolder;

extern QoreString NothingTypeString;


class QoreNodeAsStringHelper {
private:
   QoreString* str;
   bool del;

   DLLLOCAL QoreNodeAsStringHelper(const QoreNodeAsStringHelper&); // not implemented

   DLLLOCAL QoreNodeAsStringHelper& operator=(const QoreNodeAsStringHelper&); // not implemented

   DLLLOCAL void* operator new(size_t); // not implemented, make sure it is not new'ed

public:
   DLLEXPORT QoreNodeAsStringHelper(const AbstractQoreNode* n, int format_offset, ExceptionSink* xsink);

   DLLEXPORT QoreNodeAsStringHelper(const QoreValue n, int format_offset, ExceptionSink* xsink);

   DLLEXPORT ~QoreNodeAsStringHelper();


   DLLLOCAL const QoreString* operator->() { return str; }


   DLLLOCAL const QoreString* operator*() { return str; }


   DLLEXPORT QoreString* giveString();
};

#endif