qgsprojutils.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprojutils.h
                             -------------------
    begin                : March 2019
    copyright            : (C) 2019 by 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 QGSPROJUTILS_H
#define QGSPROJUTILS_H
 
#include "qgsconfig.h"
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdatumtransform.h"
 
#include <QStringList>
#include <QtGlobal>
 
#if !defined( USE_THREAD_LOCAL ) || defined( Q_OS_WIN )
#include <QThreadStorage>
#endif
 
#ifndef SIP_RUN
struct PJconsts;
typedef struct PJconsts PJ;
#endif

class CORE_EXPORT QgsProjUtils
{
  public:
    static int projVersionMajor();

    static int projVersionMinor();

    static QString epsgRegistryVersion();

    static QDate epsgRegistryDate();

    static QString esriDatabaseVersion();

    static QDate esriDatabaseDate();

    static QString ignfDatabaseVersion();

    static QDate ignfDatabaseDate();

    static QStringList searchPaths();
 
#ifndef SIP_RUN

    enum IdentifyFlag
    {
      FlagMatchBoundCrsToUnderlyingSourceCrs = 1 << 0, 
    };
    Q_DECLARE_FLAGS( IdentifyFlags, IdentifyFlag )
 
    
    struct ProjPJDeleter
    {
        void CORE_EXPORT operator()( PJ *object ) const;
    };

    using proj_pj_unique_ptr = std::unique_ptr< PJ, ProjPJDeleter >;

    static bool usesAngularUnit( const QString &projDef );
 
    //TODO - remove when proj 6.1 is minimum supported version, and replace with proj_normalize_for_visualization

    static bool axisOrderIsSwapped( const PJ *crs );

    static bool isDynamic( const PJ *crs );

    static proj_pj_unique_ptr crsToHorizontalCrs( const PJ *crs );

    static proj_pj_unique_ptr crsToVerticalCrs( const PJ *crs );

    static bool hasVerticalAxis( const PJ *crs );

    static proj_pj_unique_ptr unboundCrs( const PJ *crs );

    static proj_pj_unique_ptr crsToDatumEnsemble( const PJ *crs );

    static proj_pj_unique_ptr createCompoundCrs( const PJ *horizontalCrs, const PJ *verticalCrs, QStringList *errors = nullptr );

    static bool identifyCrs( const PJ *crs, QString &authName, QString &authCode, IdentifyFlags flags = IdentifyFlags() );

    static bool coordinateOperationIsAvailable( const QString &projDef );

    static QList< QgsDatumTransform::GridDetails > gridsUsed( const QString &proj );

    static void proj_logger( void *user_data, int level, const char *message );

    static void proj_collecting_logger( void *user_data, int level, const char *message );

    static void proj_silent_logger( void *user_data, int level, const char *message );
 
#if 0 // not possible in current Proj 6 API

    static QStringList nonAvailableGrids( const QString &projDef );
#endif
#endif
};
 
#ifndef SIP_RUN
 
struct pj_ctx;
typedef struct pj_ctx PJ_CONTEXT;

class CORE_EXPORT QgsProjContext
{
  public:
    QgsProjContext();
    ~QgsProjContext();

    static PJ_CONTEXT *get();
 
  private:
    PJ_CONTEXT *mContext = nullptr;

#if defined( USE_THREAD_LOCAL ) && !defined( Q_OS_WIN )
    static thread_local QgsProjContext sProjContext;
#else
    static QThreadStorage< QgsProjContext * > sProjContext;
#endif
};

class CORE_EXPORT QgsScopedProjSilentLogger
{
  public:
    QgsScopedProjSilentLogger();

    ~QgsScopedProjSilentLogger();
};
 

class CORE_EXPORT QgsScopedProjCollectingLogger
{
  public:
    QgsScopedProjCollectingLogger();

    ~QgsScopedProjCollectingLogger();

    QStringList errors() const { return mProjErrors; }
 
  private:
    QStringList mProjErrors;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProjUtils::IdentifyFlags )
#endif
#endif // QGSPROJUTILS_H