uri.hpp

Go to the documentation of this file.

#ifndef UPnPsdk_URI_HPP
#define UPnPsdk_URI_HPP
// Copyright (C) 2025+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
// Redistribution only with this Copyright remark. Last modified: 2026-03-15
#include <UPnPsdk/visibility.hpp>
#include <UPnPsdk/port.hpp>
#include <UPnPsdk/port_sock.hpp>
 
#include <string>
 
 
inline constexpr int HTTP_SUCCESS{1};
 
// Must not use ABSOLUTE, RELATIVE; already defined in Win32 for other meaning.
enum struct uriType {
    Absolute, 
    Relative 
};
 
enum struct pathType {
    ABS_PATH, 
    REL_PATH, 
    OPAQUE_PART 
};
 
struct token {
    const char* buff; 
    size_t size; 
};
 
struct hostport_type {
    token text; 
    sockaddr_storage IPaddress; 
};
 
struct uri_type {
    uriType type;
    token scheme;
    pathType path_type;
    token pathquery;
    token fragment;
    hostport_type hostport;
};
 
namespace UPnPsdk {
 
// Free functions
// ==============
UPnPsdk_VIS void remove_dot_segments(
    std::string& a_path);
 
 
// REF:_[A_practical_guide_to_URI_encoding_and_URI_decoding]
// (https://qqq.is/research/a-practical-guide-to-URI-encoding-and-URI-decoding)
UPnPsdk_VIS void
decode_esc_chars(std::string& a_encoded 
);
 
 
// CComponent
// ==========
class UPnPsdk_VIS CComponent {
  public:
    enum struct STATE {
        undef, 
        empty, 
        avail 
    };
 
    STATE state() const;
 
    const std::string& str() const;
 
  protected:
    STATE m_state{STATE::undef};
    DISABLE_MSVC_WARN_4251
    std::string m_component;
    ENABLE_MSVC_WARN
};
 
 
// class CScheme
// =============
class UPnPsdk_VIS CScheme : public CComponent {
  public:
    CScheme(std::string_view a_uri_sv 
    );
};
 
 
// Authority sub-component CUserinfo
// ------------------------=========
class UPnPsdk_VIS CUserinfo : public CComponent {
  public:
    CUserinfo(std::string_view a_uri_sv 
    );
};
 
 
// Authority sub-component CHost
// ------------------------=====
class UPnPsdk_VIS CHost : public CComponent {
  public:
    CHost(std::string_view a_uri_sv 
    );
};
 
 
// Authority sub-component CPort
// ------------------------=====
class UPnPsdk_VIS CPort : public CComponent {
  public:
    CPort(std::string_view a_uri_sv 
    );
};
 
 
// CAuthority
// ==========
class UPnPsdk_VIS CAuthority {
  public:
    CUserinfo userinfo;
    CHost host;
    CPort port;
 
    CAuthority(std::string_view a_uri_sv 
    );
    CComponent::STATE state() const;
 
    std::string str() const;
 
  private:
    using STATE = CComponent::STATE;
};
 
 
// CPath
// =====
class UPnPsdk_VIS CPath : public CComponent {
  public:
    CPath(std::string_view a_uri_sv 
    );
    void remove_dot_segments();
};
 
 
// CQuery
// ======
class UPnPsdk_VIS CQuery : public CComponent {
  public:
    CQuery(std::string_view a_uri_sv 
    );
};
 
 
// CFragment
// =========
class UPnPsdk_VIS CFragment : public CComponent {
  public:
    CFragment(std::string_view a_uri_sv 
    );
};
 
 
// Class CPrepUriStr
// =================
class UPnPsdk_VIS CPrepUriStr {
  public:
    CPrepUriStr(std::string& a_uriref_str 
    );
};
 
 
// Class CUriRef
// =============
class UPnPsdk_VIS CUriRef {
  private:
    using STATE = CComponent::STATE;
 
    // member classes
    // --------------
    // Next attribute must be declared first due to correct initialization of
    // the following five component member classes.
    CPrepUriStr prepare_uri_str;
 
  public:
    CScheme scheme;
    CAuthority authority;
    CPath path;
    CQuery query;
    CFragment fragment;
 
    // It is important that the argument 'a_uriref_str' is given by value. So
    // it is coppied to the stack and available for the lifetime of the
    // constructor and can be used as stable base for string_views.
    CUriRef(std::string a_uriref_str 
    );
 
    CComponent::STATE state() const;
 
    std::string str() const;
};
 
 
// Class CUri
// ==========
class UPnPsdk_VIS CUri {
  public:
    CUriRef base;
    CUriRef target;
 
    CUri(
        std::string a_uriref_str);
 
    // Setter
    // ------
    void operator=(
        std::string a_relref_str);
 
    // Getter
    // ------
    CComponent::STATE state() const;
 
    std::string str() const;
};
 
} // namespace UPnPsdk
 
 
UPnPsdk_VIS int parse_uri(
    const char* in,
    size_t max,
    uri_type* out);
 
#endif // UPnPsdk_URI_HPP