QoreStringNode.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreStringNode.h
 
    QoreStringNode Class Definition
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2023 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:
    QoreStringNode(QoreString* str) = delete;
    QoreStringNode& operator=(const QoreStringNode&) = delete;
 
    // note implemented; declared private here to probit them from being called
    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, size_t maxlinelen);
 
 
    DLLEXPORT QoreStringNode(char* nbuf, size_t nlen, size_t nallocated, const QoreEncoding* enc);
 
    DLLEXPORT QoreStringNode(const char* str, 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;
 
 
    DLLEXPORT QoreStringNode* regexSubst(QoreString& match, QoreString& subst, int opts, ExceptionSink* xsink) 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* parseBase64UrlToString(ExceptionSink* xsink) const;
 
 
    DLLEXPORT QoreStringNode* parseBase64UrlToString(const QoreEncoding* enc, ExceptionSink* xsink) const;
 
    DLLEXPORT QoreStringNode* stringRefSelf() const;
 
 
    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 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 int parseInit(QoreValue& val, QoreParseContext& parse_context);
 
    DLLLOCAL QoreStringNode(const char* str, const QoreEncoding* from, const QoreEncoding* to, ExceptionSink* xsink);
 
    DLLLOCAL QoreStringNode(struct qore_string_private* p);
};
 
class QoreStringNodeMaker : public QoreStringNode {
public:
    DLLEXPORT QoreStringNodeMaker(const char* fmt, ...);
 
private:
    QoreStringNodeMaker(const QoreStringNodeMaker& str) = delete;
    QoreStringNodeMaker& operator=(const QoreStringNodeMaker&) = delete;
};
 
extern QoreStringNode* NullString;
 
 
class QoreStringValueHelper {
public:
    DLLEXPORT QoreStringValueHelper(const QoreValue n);
 
 
    DLLEXPORT QoreStringValueHelper(const QoreValue n, const QoreEncoding* enc, ExceptionSink* xsink);
 
    DLLEXPORT ~QoreStringValueHelper();
 
 
    DLLEXPORT const QoreString* operator->();
 
 
    DLLEXPORT const QoreString* operator*();
 
 
    DLLEXPORT QoreString* giveString();
 
 
    DLLEXPORT char* giveBuffer();
 
    DLLEXPORT bool is_temp() const;
 
private:
    QoreString* str;
    bool del;
 
    QoreStringValueHelper(const QoreStringValueHelper&) = delete;
    QoreStringValueHelper& operator=(const QoreStringValueHelper&) = delete;
    void* operator new(size_t) = delete;
 
    DLLEXPORT void setup(ExceptionSink* xsink, const QoreValue n, const QoreEncoding* enc = nullptr);
};
 
 
class QoreStringNodeValueHelper {
public:
    DLLEXPORT QoreStringNodeValueHelper(const QoreValue n);
 
 
    DLLEXPORT QoreStringNodeValueHelper(const QoreValue n, const QoreEncoding* enc, ExceptionSink* xsink);
 
    DLLEXPORT ~QoreStringNodeValueHelper();
 
 
    DLLEXPORT const QoreStringNode* operator->();
 
 
    DLLEXPORT const QoreStringNode* operator*();
 
 
    DLLEXPORT QoreStringNode* getReferencedValue();
 
    DLLEXPORT bool is_temp() const;
 
private:
    QoreStringNode* str;
    bool del;
 
    QoreStringNodeValueHelper(const QoreStringNodeValueHelper&) = delete;
    QoreStringNodeValueHelper& operator=(const QoreStringNodeValueHelper&) = delete;
    void* operator new(size_t) = delete;
 
    DLLEXPORT void setup(ExceptionSink* xsink, const QoreValue n, const QoreEncoding* enc = nullptr);
};
 
#include <qore/ReferenceHolder.h>
 
 
typedef SimpleRefHolder<QoreStringNode> QoreStringNodeHolder;
 
extern QoreString NothingTypeString;
 
 
class QoreNodeAsStringHelper {
public:
    DLLEXPORT QoreNodeAsStringHelper(const AbstractQoreNode* n, int format_offset, ExceptionSink* xsink);
 
    DLLEXPORT QoreNodeAsStringHelper(const QoreValue n, int format_offset, ExceptionSink* xsink);
 
    DLLEXPORT ~QoreNodeAsStringHelper();
 
 
    DLLEXPORT const QoreString* operator->();
 
 
    DLLEXPORT const QoreString* operator*();
 
 
    DLLEXPORT QoreString* giveString();
 
private:
    QoreString* str;
    bool del;
 
    QoreNodeAsStringHelper(const QoreNodeAsStringHelper&) = delete;
    QoreNodeAsStringHelper& operator=(const QoreNodeAsStringHelper&) = delete;
    void* operator new(size_t) = delete;
};
 
#endif