QoreURL.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreURL.h
 
    Network functions and macros
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2024 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_QOREURL_H
 
#define _QORE_QOREURL_H
 
#define QURL_KEEP_BRACKETS (1 << 0)
#define QURL_DECODE        (1 << 1)
#define QURL_DECODE_PATH   (1 << 2)
#define QURL_MAINTAIN_CASE (1 << 3)
#define QURL_DECODE_ANY    (QURL_DECODE | QURL_DECODE_PATH)
 
class QoreURL {
public:
 
    DLLEXPORT QoreURL();
 
 
    DLLEXPORT QoreURL(const char* url);
 
 
    DLLEXPORT QoreURL(const QoreString* url);
 
 
    DLLEXPORT QoreURL(const char* url, bool keep_brackets);
 
 
    DLLEXPORT QoreURL(const QoreString* url, bool keep_brackets);
 
 
    DLLEXPORT QoreURL(const QoreString* url, bool keep_brackets, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreURL(const char* url, int options);
 
 
    DLLEXPORT QoreURL(const QoreString& url, int options = 0);
 
 
    DLLEXPORT QoreURL(const std::string& url, int options = 0);
 
 
    DLLEXPORT QoreURL(ExceptionSink* xsink, const char* url, int options);
 
 
    DLLEXPORT QoreURL(ExceptionSink* xsink, const QoreString& url, int options = 0);
 
 
    DLLEXPORT QoreURL(ExceptionSink* xsink, const std::string& url, int options = 0);
 
    DLLEXPORT ~QoreURL();
 
 
    DLLEXPORT int parse(const char* url);
 
 
    DLLEXPORT int parse(const QoreString* url);
 
 
    DLLEXPORT int parse(const char* url, bool keep_brackets);
 
 
    DLLEXPORT int parse(const QoreString* url, bool keep_brackets);
 
 
    DLLEXPORT int parse(const QoreString* url, bool keep_brackets, ExceptionSink* xsink);
 
 
    DLLEXPORT int parse(const char* url, int options);
 
 
    DLLEXPORT int parse(const QoreString& url, int options = 0);
 
 
    DLLEXPORT int parse(const std::string& url, int options = 0);
 
 
    DLLEXPORT int parse(ExceptionSink* xsink, const char* url, int options = 0);
 
 
    DLLEXPORT int parse(ExceptionSink* xsink, const QoreString& url, int options = 0);
 
 
    DLLEXPORT int parse(ExceptionSink* xsink, const std::string& url, int options = 0);
 
 
    DLLEXPORT bool isValid() const;
 
 
    DLLEXPORT QoreHashNode* getHash();
 
 
    DLLEXPORT const QoreString* getHost() const;
 
 
    DLLEXPORT const QoreString* getUserName() const;
 
 
    DLLEXPORT const QoreString* getPassword() const;
 
 
    DLLEXPORT const QoreString* getPath() const;
 
    DLLEXPORT const QoreString* getProtocol() const;
 
 
    DLLEXPORT int getPort() const;
 
    // the "take" methods return the char*  pointers for the data
    // the caller owns the memory
 
 
    DLLEXPORT char* take_path();
 
 
    DLLEXPORT char* take_username();
 
 
    DLLEXPORT char* take_password();
 
 
    DLLEXPORT char* take_host();
 
private:
    hashdecl qore_url_private* priv;
 
    DLLLOCAL void zero();
    DLLLOCAL void reset();
    DLLLOCAL void parseIntern(const char* url, ExceptionSink* xsink);
 
    DLLLOCAL QoreURL(const QoreURL&);
 
    DLLLOCAL QoreURL& operator=(const QoreURL&);
};
 
#endif