src/plugins/litehtml_viewer/litehtml/url.h

   1 // Copyright (C) 2020-2021 Primate Labs Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //    * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //    * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //    * Neither the names of the copyright holders nor the names of their
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 #ifndef LITEHTML_URL_H__
  31 #define LITEHTML_URL_H__
  32
  33 #include <ostream>
  34
  35 #include "os_types.h"
  36
  37 // https://datatracker.ietf.org/doc/html/rfc3986
  38
  39 namespace litehtml {
  40
  41 class url {
  42 public:
  43     url() = default;
  44
  45     explicit url(const string& str);
  46
  47     url(const string& scheme,
  48         const string& authority,
  49         const string& path,
  50         const string& query,
  51         const string& fragment);
  52
  53     const string& str() const
  54     {
  55         return str_;
  56     }
  57
  58     const string& scheme() const
  59     {
  60         return scheme_;
  61     }
  62
  63     bool has_scheme() const
  64     {
  65         return !scheme_.empty();
  66     }
  67
  68     const string& authority() const
  69     {
  70         return authority_;
  71     }
  72
  73     bool has_authority() const
  74     {
  75         return !authority_.empty();
  76     }
  77
  78     const string& path() const
  79     {
  80         return path_;
  81     }
  82
  83     bool has_path() const
  84     {
  85         return !path_.empty();
  86     }
  87
  88     const string& query() const
  89     {
  90         return query_;
  91     }
  92
  93     bool has_query() const
  94     {
  95         return !query_.empty();
  96     }
  97
  98     const string& fragment() const
  99     {
 100         return fragment_;
 101     }
 102
 103     bool has_fragment() const
 104     {
 105         return !fragment_.empty();
 106     }
 107
 108 protected:
 109     string str_;
 110
 111     // Assume URLs are relative by default.  See RFC 3986 Section 4.3 for
 112     // information on which URLs are considered relative and which URLs are
 113     // considered absolute:
 114     //
 115     //   https://datatracker.ietf.org/doc/html/rfc3986#section-4.3
 116
 117     bool absolute_ = false;
 118
 119     string scheme_;
 120
 121     string authority_;
 122
 123     string path_;
 124
 125     string query_;
 126
 127     string fragment_;
 128 };
 129
 130 // Returns a URL that is resolved from the reference URL that might be
 131 // relative to the base URL.  For example, given <https://www.twitter.com/> as
 132 // the base URL and </foo> as the relative URL, resolve() will return the URL
 133 // <https://www.twitter.com/foo>.
 134
 135 url resolve(const url& base, const url& reference);
 136
 137 } // namespace litehtml
 138
 139 #endif // LITEHTML_URL_H__