@cpp.js/package-gdal 1.0.0-beta.20

package/dist/prebuilt/iOS-iphonesimulator/include/gdalsubdatasetinfo.h

@@ -0,0 +1,120 @@
+/***************************************************************************
+  gdal_subdatasetinfo.h - GDALSubdatasetInfo
+
+ ---------------------
+ begin                : 21.7.2023
+ copyright            : (C) 2023 by Alessndro Pasotti
+ email                : elpaso@itopen.it
+ ***************************************************************************
+ *                                                                         *
+ * 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.
+ *                                                                         *
+ ***************************************************************************/
+#ifndef GDALSUBDATASETINFO_H
+#define GDALSUBDATASETINFO_H
+
+#include "cpl_port.h"
+#include <string>
+
+/**
+ * The GDALSubdatasetInfo abstract class provides methods to extract and
+ * manipulate subdataset information from a file name that contains subdataset
+ * information.
+ *
+ * Drivers offering this functionality must override the parseFileName() method.
+ */
+struct CPL_DLL GDALSubdatasetInfo
+{
+
+  public:
+    /**
+     * @brief Construct a GDALSubdatasetInfo object from a subdataset file descriptor.
+     * @param fileName          The subdataset file name descriptor.
+     */
+    GDALSubdatasetInfo(const std::string &fileName);
+
+    virtual ~GDALSubdatasetInfo() = default;
+
+    /**
+ * @brief Returns the unquoted and unescaped path component of the complete file descriptor
+ *        stripping any subdataset, prefix and additional information.
+ * @return                      The path to the file
+ * @since                       GDAL 3.8
+ */
+    std::string GetPathComponent() const;
+
+    /**
+ * @brief Replaces the path component of the complete file descriptor
+ *        by keeping the subdataset and any other component unaltered.
+ *        The returned string must be freed with CPLFree()
+ * @param newPathName           New path name with no subdataset information.
+ * @note                        This method does not check if the subdataset actually exists.
+ * @return                      The original file name with the old path component replaced by newPathName.
+ * @since                       GDAL 3.8
+ */
+    std::string ModifyPathComponent(const std::string &newPathName) const;
+
+    /**
+ * @brief Returns the subdataset component of the file name.
+ *
+ * @return                      The subdataset name
+ * @since                       GDAL 3.8
+ */
+    std::string GetSubdatasetComponent() const;
+
+    //! @cond Doxygen_Suppress
+  protected:
+    /**
+     * This method is called once to parse the fileName and populate the member variables.
+     * It must be reimplemented by concrete derived classes.
+     */
+    virtual void parseFileName() = 0;
+
+    /**
+     * Adds double quotes to paths and escape double quotes inside the path.
+     */
+    static std::string quote(const std::string &path);
+
+    /**
+     * Removes double quotes and unescape double quotes.
+     */
+    static std::string unquote(const std::string &path);
+
+    //! The original unparsed complete file name passed to the constructor (e.g. GPKG:/path/to/file.gpkg:layer_name)
+    std::string m_fileName;
+    //! The unmodified path component of the file name (e.g. "\"C:\path\to\file.gpkg\"", "/path/to/file.gpkg")
+    std::string m_pathComponent;
+    //! The unquoted and unescaped path component of the file name (e.g. "C:\path\to\file.gpkg", "/path/to/file.gpkg")
+    std::string m_cleanedPathComponent;
+    //! The subdataset component (e.g. layer_name)
+    std::string m_subdatasetComponent;
+    //! The driver prefix component (e.g. GPKG)
+    std::string m_driverPrefixComponent;
+    //! If the path is enclosed in double quotes.
+    bool m_isQuoted = false;
+
+  private:
+    mutable bool m_initialized = false;
+
+    void init() const;
+
+    //! @endcond
+};
+
+#endif  // GDALSUBDATASETINFO_H