dali-toolkit/internal/visuals/visual-url.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
   2 #define DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 #include <string>
  21
  22 namespace Dali
  23 {
  24 namespace Toolkit
  25 {
  26 namespace Internal
  27 {
  28 class VisualUrl
  29 {
  30 public:
  31   /**
  32    * The type of the URL based on the string contents
  33    */
  34   enum Type
  35   {
  36     REGULAR_IMAGE,
  37     N_PATCH,
  38     SVG,
  39     GIF,
  40     WEBP,
  41     JSON,
  42     TVG
  43   };
  44
  45   enum ProtocolType
  46   {
  47     LOCAL,   ///< file in local file system
  48     TEXTURE, ///< texture uploaded to texture manager
  49     REMOTE,  ///< remote image
  50     BUFFER   ///< encoded image buffer
  51   };
  52
  53   /**
  54    * Default Constructor.
  55    * Resulting URL is not valid
  56    */
  57   VisualUrl();
  58
  59   /**
  60    * Default Destructor.
  61    * Delete an external texture if if protocolType is TEXTURE.
  62    */
  63   ~VisualUrl();
  64
  65   /**
  66    * Constructor.
  67    * Determines type of visual and whether the url is local or remote
  68    * Notify that it is using an external texture if if protocolType is TEXTURE.
  69    *
  70    * @param[in] url The URL to store and resolve
  71    */
  72   VisualUrl(const std::string& url);
  73
  74   /**
  75    * Copy constructor
  76    * @param[in] url The VisualUrl to copy
  77    */
  78   VisualUrl(const VisualUrl& url);
  79
  80   /**
  81    * Assignment operator
  82    * @param[in] url The VisualUrl to copy
  83    */
  84   VisualUrl& operator=(const VisualUrl& url);
  85
  86   /**
  87    * Get the full URL
  88    * @return The url
  89    */
  90   const std::string& GetUrl() const;
  91
  92   /**
  93    * Get the hash value of full URL
  94    * @return The hash value of url
  95    */
  96   const std::uint64_t& GetUrlHash() const;
  97
  98   /**
  99    * Get the visual type of the URL
 100    * @return The visual type of the URL
 101    */
 102   Type GetType() const;
 103
 104   /**
 105    * Is the URL is local to the device, or remote?
 106    * @return the location of the resource
 107    */
 108   ProtocolType GetProtocolType() const;
 109
 110   /**
 111    * Is the URL valid?
 112    * @return true if the URL has length
 113    */
 114   bool IsValid() const;
 115
 116   /**
 117    * @return true if the location is LOCAL, i.e. is loadable from local file system
 118    */
 119   bool IsLocalResource() const;
 120
 121   /**
 122    * @return true if the location is BUFFER, i.e. may contain EncodedImageBuffer
 123    */
 124   bool IsBufferResource() const;
 125
 126   /**
 127    * @return the location part of the url
 128    */
 129   std::string GetLocation() const;
 130
 131   /**
 132    * Helper to create a URL of type TEXTURE
 133    * @param location the location of the texture
 134    * @return the Url
 135    */
 136   static std::string CreateTextureUrl(const std::string& location);
 137
 138   /**
 139    * Helper to create a URL of type BUFFER
 140    * @param location the location of the texture
 141    * @return the Url
 142    */
 143   static std::string CreateBufferUrl(const std::string& location);
 144
 145   /**
 146    * Helper to get a ProtocolType from url
 147    * @param url the url of the texture
 148    * @return the protocol type
 149    */
 150   static VisualUrl::ProtocolType GetProtocolType(const std::string& url);
 151
 152   /**
 153    * Helper to get a location from url
 154    * @param url the location of the texture
 155    * @return the location
 156    */
 157   static std::string GetLocation(const std::string& url);
 158
 159 private:
 160   std::string  mUrl;
 161   Type         mType;
 162   ProtocolType mLocation;
 163
 164   mutable std::uint64_t mUrlHash;
 165 };
 166
 167 } // namespace Internal
 168
 169 } // namespace Toolkit
 170
 171 } // namespace Dali
 172
 173 #endif /* DALI_TOOLKIT_INTERNAL_VISUAL_URL_H */