qgsogrutils.h

Go to the documentation of this file.

/***************************************************************************
                             qgsogrutils.h
                             -------------
    begin                : February 2016
    copyright            : (C) 2016 Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSOGRUTILS_H
#define QGSOGRUTILS_H
 
 
#include <cpl_conv.h>
#include <cpl_string.h>
#include <gdal.h>
#include <gdalwarper.h>
#include <ogr_api.h>
 
#include "qgis_core.h"
#include "qgsfeature.h"
#include "qgsvectordataprovider.h"
 
#define SIP_NO_FILE
 
class QgsCoordinateReferenceSystem;
class QgsFieldDomain;
 
class QTextCodec;
class QgsWeakRelation;
 
namespace gdal
{

  struct OGRDataSourceDeleter
  {
      void CORE_EXPORT operator()( OGRDataSourceH source ) const;
  };

  struct OGRGeometryDeleter
  {
      void CORE_EXPORT operator()( OGRGeometryH geometry ) const;
  };

  struct OGRFldDeleter
  {
      void CORE_EXPORT operator()( OGRFieldDefnH definition ) const;
  };

  struct OGRFeatureDeleter
  {
      void CORE_EXPORT operator()( OGRFeatureH feature ) const;
  };

  struct GDALDatasetCloser
  {
      void CORE_EXPORT operator()( GDALDatasetH datasource ) const;
  };

  struct GDALWarpOptionsDeleter
  {
      void CORE_EXPORT operator()( GDALWarpOptions *options ) const;
  };
 
#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 6, 0 )

  struct GDALRelationshipDeleter
  {
      void CORE_EXPORT operator()( GDALRelationshipH relationship ) const;
  };
#endif

  using ogr_datasource_unique_ptr = std::unique_ptr< std::remove_pointer<OGRDataSourceH>::type, OGRDataSourceDeleter >;

  using ogr_geometry_unique_ptr = std::unique_ptr< std::remove_pointer<OGRGeometryH>::type, OGRGeometryDeleter >;

  using ogr_field_def_unique_ptr = std::unique_ptr< std::remove_pointer<OGRFieldDefnH>::type, OGRFldDeleter >;

  using ogr_feature_unique_ptr = std::unique_ptr< std::remove_pointer<OGRFeatureH>::type, OGRFeatureDeleter >;

  using dataset_unique_ptr = std::unique_ptr< std::remove_pointer<GDALDatasetH>::type, GDALDatasetCloser >;

  void CORE_EXPORT fast_delete_and_close( dataset_unique_ptr &dataset, GDALDriverH driver, const QString &path );

  using warp_options_unique_ptr = std::unique_ptr< GDALWarpOptions, GDALWarpOptionsDeleter >;
 
#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 6, 0 )

  using relationship_unique_ptr = std::unique_ptr< std::remove_pointer<GDALRelationshipH>::type, GDALRelationshipDeleter >;
#endif
} //namespace gdal

class CORE_EXPORT QgsOgrUtils
{
  public:
    static QVariant OGRFieldtoVariant( const OGRField *value, OGRFieldType type );

    static std::unique_ptr<OGRField> variantToOGRField( const QVariant &value, OGRFieldType type );

    static int OGRTZFlagFromQt( const QDateTime &datetime );

    static QgsFeature readOgrFeature( OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding );

    static QgsFields readOgrFields( OGRFeatureH ogrFet, QTextCodec *encoding );

    static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok = nullptr );

    static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsField &field, int attIndex, QTextCodec *encoding, bool *ok = nullptr );

    static bool readOgrFeatureAttributes( OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding );

    static bool readOgrFeatureGeometry( OGRFeatureH ogrFet, QgsFeature &feature );

    static QgsGeometry ogrGeometryToQgsGeometry( OGRGeometryH geom );

    static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding );

    static QgsFields stringToFields( const QString &string, QTextCodec *encoding );

    static QStringList cStringListToQStringList( const char *const *stringList );

    static Qgis::WkbType ogrGeometryTypeToQgsWkbType( OGRwkbGeometryType ogrGeomType );

    static OGRwkbGeometryType qgsWkbTypeToOgrGeometryType( Qgis::WkbType wkbType, bool approx = false );

    static QString OGRSpatialReferenceToWkt( OGRSpatialReferenceH srs );

    static QgsCoordinateReferenceSystem OGRSpatialReferenceToCrs( OGRSpatialReferenceH srs );

    static OGRSpatialReferenceH crsToOGRSpatialReference( const QgsCoordinateReferenceSystem &crs );

    static QString readShapefileEncoding( const QString &path );

    static QString readShapefileEncodingFromCpg( const QString &path );

    static QString readShapefileEncodingFromLdid( const QString &path );

    static QVariantMap parseStyleString( const QString &string );

    static std::unique_ptr< QgsSymbol > symbolFromStyleString( const QString &string, Qgis::SymbolType type ) SIP_FACTORY;

    static void ogrFieldTypeToQVariantType( OGRFieldType ogrType, OGRFieldSubType ogrSubType, QMetaType::Type &variantType, QMetaType::Type &variantSubType ) SIP_SKIP;

    static void variantTypeToOgrFieldType( QMetaType::Type variantType, OGRFieldType &ogrType, OGRFieldSubType &ogrSubType ) SIP_SKIP;

    static QVariant stringToVariant( OGRFieldType type, OGRFieldSubType subType, const QString &string ) SIP_SKIP;

    static QList<QgsVectorDataProvider::NativeType> nativeFieldTypesForDriver( GDALDriverH driver ) SIP_SKIP;
 
#ifndef SIP_RUN
#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 3, 0 )

    static std::unique_ptr< QgsFieldDomain > convertFieldDomain( OGRFieldDomainH domain );

    static OGRFieldDomainH convertFieldDomain( const QgsFieldDomain *domain );
#endif
#endif
 
#ifndef SIP_RUN
#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 6, 0 )

    static QgsWeakRelation convertRelationship( GDALRelationshipH relationship, const QString &datasetUri );

    static gdal::relationship_unique_ptr convertRelationship( const QgsWeakRelation &relation, QString &error );
#endif
#endif

    static int listStyles( GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause );

    static bool styleExists( GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, const QString &styleId, QString &errorCause );

    static QString getStyleById( GDALDatasetH hDS, const QString &styleId, QString &errCause );

    static bool saveStyle(
      GDALDatasetH hDS,
      const QString &layerName,
      const QString &geomColumn,
      const QString &qmlStyle,
      const QString &sldStyle,
      const QString &styleName,
      const QString &styleDescription,
      const QString &uiFileContent,
      bool useAsDefault,
      QString &errCause
    );

    static bool deleteStyleById( GDALDatasetH hDS, const QString &styleId, QString &errCause );

    static QString loadStoredStyle( GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, QString &styleName, QString &errCause );
};
 
#endif // QGSOGRUTILS_H