qgscoordinatereferencesystem.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatereferencesystem.h

                             -------------------
    begin                : 2007
    copyright            : (C) 2007 by Gary E. Sherman
    email                : [email protected]
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSCOORDINATEREFERENCESYSTEM_H
#define QGSCOORDINATEREFERENCESYSTEM_H

//Standard includes
#include "qgis_core.h"
#include <ostream>

//qt includes
#include <QString>
#include <QMap>
#include <QHash>
#include <QReadWriteLock>
#include <QExplicitlySharedDataPointer>
#include <QObject>

//qgis includes
#include "qgis_sip.h"
#include "qgsunittypes.h"
#include "qgsrectangle.h"
#include "qgssqliteutils.h"

class QDomNode;
class QDomDocument;
class QgsCoordinateReferenceSystemPrivate;

#if PROJ_VERSION_MAJOR>=6
#ifndef SIP_RUN
struct PJconsts;
typedef struct PJconsts PJ;

#if PROJ_VERSION_MAJOR>=8
struct pj_ctx;
typedef struct pj_ctx PJ_CONTEXT;
#else
struct projCtx_t;
typedef struct projCtx_t PJ_CONTEXT;
#endif
#endif
#endif

// forward declaration for sqlite3
typedef struct sqlite3 sqlite3 SIP_SKIP;

#ifdef DEBUG
typedef struct OGRSpatialReferenceHS *OGRSpatialReferenceH SIP_SKIP;
#else
typedef void *OGRSpatialReferenceH SIP_SKIP;
#endif

class QgsCoordinateReferenceSystem;
typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SKIP;

class CORE_EXPORT QgsCoordinateReferenceSystem
{
    Q_GADGET

    Q_PROPERTY( QgsUnitTypes::DistanceUnit mapUnits READ mapUnits )
    Q_PROPERTY( bool isGeographic READ isGeographic )

  public:

    enum CrsType
    {
      InternalCrsId,  
      PostgisCrsId,   
      EpsgCrsId       
    };

    enum Format
    {
      FormatWkt = 0, 
      FormatProj, 
    };

    QgsCoordinateReferenceSystem();

    ~QgsCoordinateReferenceSystem();

    // TODO QGIS 4: remove "POSTGIS" and "INTERNAL"

    explicit QgsCoordinateReferenceSystem( const QString &definition );

    // TODO QGIS 4: remove type and always use EPSG code

    Q_DECL_DEPRECATED explicit QgsCoordinateReferenceSystem( long id, CrsType type = PostgisCrsId ) SIP_DEPRECATED;

    QgsCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &srs );

    QgsCoordinateReferenceSystem &operator=( const QgsCoordinateReferenceSystem &srs );

    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }

    static QList< long > validSrsIds();

    // static creators

    static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs );

    Q_INVOKABLE static QgsCoordinateReferenceSystem fromEpsgId( long epsg );

    Q_DECL_DEPRECATED static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ) SIP_DEPRECATED;

    static QgsCoordinateReferenceSystem fromProj( const QString &proj );

    static QgsCoordinateReferenceSystem fromWkt( const QString &wkt );

    static QgsCoordinateReferenceSystem fromSrsId( long srsId );

    // Misc helper functions -----------------------

    // TODO QGIS 4: remove type and always use EPSG code, rename to createFromEpsg

    Q_DECL_DEPRECATED bool createFromId( long id, CrsType type = PostgisCrsId ) SIP_DEPRECATED;

    // TODO QGIS 4: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())

    bool createFromOgcWmsCrs( const QString &crs );

    // TODO QGIS 4: remove unless really necessary - let's use EPSG codes instead

    Q_DECL_DEPRECATED bool createFromSrid( long srid ) SIP_DEPRECATED;

    bool createFromWkt( const QString &wkt );

    bool createFromSrsId( long srsId );

    Q_DECL_DEPRECATED bool createFromProj4( const QString &projString ) SIP_DEPRECATED;

#ifndef SIP_RUN
    bool createFromProj( const QString &projString, bool identify = true );
#else
    bool createFromProj( const QString &projString );
#endif

    bool createFromString( const QString &definition );

    // TODO QGIS 4: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend

    bool createFromUserInput( const QString &definition );

    Q_DECL_DEPRECATED static void setupESRIWktFix() SIP_DEPRECATED;

    bool isValid() const;

    void validate();

    // TODO QGIS 4: seems completely obsolete now (only compares proj4 - already done in createFromProj4)

    Q_DECL_DEPRECATED long findMatchingProj() SIP_DEPRECATED;

    bool operator==( const QgsCoordinateReferenceSystem &srs ) const;

    bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

    bool readXml( const QDomNode &node );

    bool writeXml( QDomNode &node, QDomDocument &doc ) const;


    static void setCustomCrsValidation( CUSTOM_CRS_VALIDATION f ) SIP_SKIP;

    static CUSTOM_CRS_VALIDATION customCrsValidation() SIP_SKIP;

    // Accessors -----------------------------------

    long srsid() const;

    // TODO QGIS 4: remove unless really necessary - let's use EPSG codes instead

    long postgisSrid() const;

    QString authid() const;

    QString description() const;

    enum IdentifierType
    {
      ShortString, 
      MediumString, 
      FullString, 
    };

    QString userFriendlyIdentifier( IdentifierType type = MediumString ) const;

    QString projectionAcronym() const;

    QString ellipsoidAcronym() const;

    enum WktVariant
    {
      WKT1_GDAL, 
      WKT1_ESRI, 
      WKT2_2015, 
      WKT2_2015_SIMPLIFIED, 
      WKT2_2018, 
      WKT2_2018_SIMPLIFIED, 
      WKT2_2019 = WKT2_2018, 
      WKT2_2019_SIMPLIFIED = WKT2_2018_SIMPLIFIED, 

      WKT_PREFERRED = WKT2_2019, 
      WKT_PREFERRED_SIMPLIFIED = WKT2_2019_SIMPLIFIED, 
      WKT_PREFERRED_GDAL = WKT2_2019, 
    };

    QString toWkt( WktVariant variant = WKT1_GDAL, bool multiline = false, int indentationWidth = 4 ) const;

    Q_DECL_DEPRECATED QString toProj4() const SIP_DEPRECATED;

    QString toProj() const;

    bool isGeographic() const;

    bool hasAxisInverted() const;

    QgsUnitTypes::DistanceUnit mapUnits() const;

    QgsRectangle bounds() const;

    // Mutators -----------------------------------

    void setValidationHint( const QString &html );

    QString validationHint();

    static int syncDatabase();

    long saveAsUserCrs( const QString &name, Format nativeFormat = FormatWkt );

    QString geographicCrsAuthId() const;

#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = sipCpp->isValid() ? QStringLiteral( "<QgsCoordinateReferenceSystem: %1>" ).arg( !sipCpp->authid().isEmpty() ? sipCpp->authid() : sipCpp->toWkt( QgsCoordinateReferenceSystem::WKT_PREFERRED ) )
                        : QStringLiteral( "<QgsCoordinateReferenceSystem: invalid>" );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif

#ifndef SIP_RUN
#if PROJ_VERSION_MAJOR>=6

    PJ *projObject() const;
#endif
#endif

    Q_DECL_DEPRECATED static QStringList recentProjections() SIP_DEPRECATED;

    static QList< QgsCoordinateReferenceSystem > recentCoordinateReferenceSystems();

    static void pushRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs );

#ifndef SIP_RUN

    static void invalidateCache( bool disableCache = false );
#else

    static void invalidateCache( bool disableCache SIP_PYARGREMOVE = false );
#endif

    // Mutators -----------------------------------
    // We don't want to expose these to the public api since they won't create
    // a fully valid crs. Programmers should use the createFrom* methods rather
  private:

    static QString projFromSrsId( int srsId );

    void setProjString( const QString &projString );

    bool setWktString( const QString &wkt, bool allowProjFallback = true );

    void debugPrint();

    typedef QMap<QString, QString> RecordMap;

    RecordMap getRecord( const QString &sql );

    static int openDatabase( const QString &path, sqlite3_database_unique_ptr &database, bool readonly = true );

    void setMapUnits();

    long getRecordCount();

#if PROJ_VERSION_MAJOR>=6
    bool loadFromAuthCode( const QString &auth, const QString &code );

    static QList< long > userSrsIds();

    long matchToUserCrs() const;
#endif

    bool loadFromDatabase( const QString &db, const QString &expression, const QString &value );

    bool createFromWktInternal( const QString &wkt, const QString &description );

#if PROJ_VERSION_MAJOR<6 // not used for proj >= 6.0
    static bool loadIds( QHash<int, QString> &wkts );
    static bool loadWkts( QHash<int, QString> &wkts, const char *filename );

    static bool syncDatumTransform( const QString &dbPath );
#endif

    QExplicitlySharedDataPointer<QgsCoordinateReferenceSystemPrivate> d;

    QString mValidationHint;

#if PROJ_VERSION_MAJOR>=6
    friend class QgsProjContext;

    // Only meant to be called by QgsProjContext::~QgsProjContext()
    static void removeFromCacheObjectsBelongingToCurrentThread( PJ_CONTEXT *pj_context );
#endif

    static CUSTOM_CRS_VALIDATION sCustomSrsValidation;

    // cache

    static bool sDisableSrIdCache;
    static bool sDisableOgcCache;
    static bool sDisableProjCache;
    static bool sDisableWktCache;
    static bool sDisableSrsIdCache;
    static bool sDisableStringCache;

    // for tests
    static const QHash< QString, QgsCoordinateReferenceSystem > &stringCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &projCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &ogcCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &wktCache();
    static const QHash< long, QgsCoordinateReferenceSystem > &srsIdCache();
    static const QHash< long, QgsCoordinateReferenceSystem > &srIdCache();

    friend class TestQgsCoordinateReferenceSystem;
    friend class QgsPostgresProvider;

    bool createFromPostgisSrid( const long id );
};

Q_DECLARE_METATYPE( QgsCoordinateReferenceSystem )

#ifndef SIP_RUN
inline std::ostream &operator << ( std::ostream &os, const QgsCoordinateReferenceSystem &r )
{
  QString mySummary( QStringLiteral( "\n\tSpatial Reference System:" ) );
  mySummary += QLatin1String( "\n\t\tDescription : " );
  if ( !r.description().isNull() )
  {
    mySummary += r.description();
  }
  else
  {
    mySummary += QLatin1String( "Undefined" );
  }
  mySummary += QLatin1String( "\n\t\tProjection  : " );
  if ( !r.projectionAcronym().isNull() )
  {
    mySummary += r.projectionAcronym();
  }
  else
  {
    mySummary += QLatin1String( "Undefined" );
  }

  mySummary += QLatin1String( "\n\t\tEllipsoid   : " );
  if ( !r.ellipsoidAcronym().isNull() )
  {
    mySummary += r.ellipsoidAcronym();
  }
  else
  {
    mySummary += QLatin1String( "Undefined" );
  }

  mySummary += QLatin1String( "\n\t\tProjString  : " );
  if ( !r.toProj().isNull() )
  {
    mySummary += r.toProj();
  }
  else
  {
    mySummary += QLatin1String( "Undefined" );
  }
  // Using streams we need to use local 8 Bit
  return os << mySummary.toLocal8Bit().data() << std::endl;
}
#endif

#endif // QGSCOORDINATEREFERENCESYSTEM_H