qgis.h

Go to the documentation of this file.

/***************************************************************************
                          qgis.h - QGIS namespace
                             -------------------
    begin                : Sat Jun 30 2002
    copyright            : (C) 2002 by Gary E.Sherman
    email                : sherman at mrcc.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 QGIS_H
#define QGIS_H
 
 
#include <QMetaEnum>
#include <cfloat>
#include <memory>
#include <cmath>
 
#include "qgstolerance.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#ifdef SIP_RUN
% ModuleHeaderCode
#include <qgis.h>
% End
 
% ModuleCode
int QgisEvent = QEvent::User + 1;
% End
#endif
 
enum class QgsMapLayerType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayer, LayerType ) : int
  {
  VectorLayer,
  RasterLayer,
  PluginLayer,
  MeshLayer,      
  VectorTileLayer, 
  AnnotationLayer, 
  PointCloudLayer, 
};
 
 
class CORE_EXPORT Qgis
{
    Q_GADGET
  public:
 
    static QString version();
 
    static int versionInt();
 
    static QString releaseName();
 
    static const char *QGIS_DEV_VERSION;
 
    static QString devVersion();
 
    // Enumerations
    //
 
    enum MessageLevel
    {
      Info = 0, 
      Warning = 1, 
      Critical = 2, 
      Success = 3, 
      NoLevel = 4, 
    };
    Q_ENUM( MessageLevel )
 
    
    enum class DataType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, DataType ) : int
      {
      UnknownDataType = 0, 
      Byte = 1, 
      UInt16 = 2, 
      Int16 = 3, 
      UInt32 = 4, 
      Int32 = 5, 
      Float32 = 6, 
      Float64 = 7, 
      CInt16 = 8, 
      CInt32 = 9, 
      CFloat32 = 10, 
      CFloat64 = 11, 
      ARGB32 = 12, 
      ARGB32_Premultiplied = 13 
    };
    Q_ENUM( DataType )
 
    
    enum class PythonMacroMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, PythonMacroMode ) : int
      {
      Never = 0, 
      Ask = 1, 
      SessionOnly = 2, 
      Always = 3, 
      NotForThisSession, 
    };
    Q_ENUM( PythonMacroMode )
 
    
    enum class FeatureCountState SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorDataProvider, FeatureCountState ) : int
      {
      Uncounted = -2, 
      UnknownCount = -1, 
    };
    Q_ENUM( FeatureCountState )
 
    
    enum class SymbolType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsSymbol, SymbolType ) : int
      {
      Marker, 
      Line, 
      Fill, 
      Hybrid 
    };
    Q_ENUM( SymbolType )
 
    
    enum class ScaleMethod SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsSymbol, ScaleMethod ) : int
      {
      ScaleArea,     
      ScaleDiameter  
    };
    Q_ENUM( ScaleMethod )
 
    
    enum class SymbolRenderHint SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsSymbol, RenderHint ) : int
      {
      DynamicRotation = 2, 
    };
    Q_ENUM( SymbolRenderHint )
    Q_DECLARE_FLAGS( SymbolRenderHints, SymbolRenderHint ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsSymbol, RenderHints )
 
 
    enum class SymbolFlag : int
    {
      RendererShouldUseSymbolLevels = 1 << 0, 
    };
    Q_ENUM( SymbolFlag )
    Q_DECLARE_FLAGS( SymbolFlags, SymbolFlag )
 
    
    enum class SymbolPreviewFlag SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsSymbol, PreviewFlag ) : int
      {
      FlagIncludeCrosshairsForMarkerSymbols = 1 << 0, 
    };
    Q_ENUM( SymbolPreviewFlag )
    Q_DECLARE_FLAGS( SymbolPreviewFlags, SymbolPreviewFlag ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsSymbol, SymbolPreviewFlags )
 
    enum class SymbolLayerFlag : int
    {
      DisableFeatureClipping = 1 << 0, 
    };
    Q_ENUM( SymbolLayerFlag )
    Q_DECLARE_FLAGS( SymbolLayerFlags, SymbolLayerFlag )
 
    
    enum class BrowserItemType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsDataItem, Type ) : int
      {
      Collection, 
      Directory, 
      Layer, 
      Error, 
      Favorites, 
      Project, 
      Custom, 
      Fields, 
      Field, 
    };
    Q_ENUM( BrowserItemType )
 
    
    enum class BrowserItemState SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsDataItem, State ) : int
      {
      NotPopulated, 
      Populating, 
      Populated, 
    };
    Q_ENUM( BrowserItemState )
 
    
    enum class BrowserItemCapability SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsDataItem, Capability ) : int
      {
      NoCapabilities = 0, 
      SetCrs = 1 << 0, 
      Fertile = 1 << 1, 
      Fast = 1 << 2, 
      Collapse = 1 << 3, 
      Rename = 1 << 4, 
      Delete = 1 << 5, 
      ItemRepresentsFile = 1 << 6, 
    };
    Q_ENUM( BrowserItemCapability )
    Q_DECLARE_FLAGS( BrowserItemCapabilities, BrowserItemCapability ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsDataItem, Capabilities )
 
    enum class BrowserLayerType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLayerItem, LayerType ) : int
      {
      NoType, 
      Vector, 
      Raster, 
      Point, 
      Line, 
      Polygon, 
      TableLayer, 
      Database, 
      Table, 
      Plugin, 
      Mesh, 
      VectorTile, 
      PointCloud 
    };
    Q_ENUM( BrowserLayerType )
 
    
    enum class BrowserDirectoryMonitoring : int
    {
      Default, 
      NeverMonitor, 
      AlwaysMonitor, 
    };
    Q_ENUM( BrowserDirectoryMonitoring )
 
    
    enum class HttpMethod : int
    {
      Get = 0, 
      Post = 1 
    };
    Q_ENUM( HttpMethod )
 
    
    enum class VectorExportResult SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorLayerExporter, ExportError ) : int
      {
      Success SIP_MONKEYPATCH_COMPAT_NAME( NoError ) = 0, 
      ErrorCreatingDataSource SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateDataSource ), 
      ErrorCreatingLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrCreateLayer ), 
      ErrorAttributeTypeUnsupported SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeTypeUnsupported ), 
      ErrorAttributeCreationFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrAttributeCreationFailed ), 
      ErrorProjectingFeatures SIP_MONKEYPATCH_COMPAT_NAME( ErrProjection ), 
      ErrorFeatureWriteFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrFeatureWriteFailed ), 
      ErrorInvalidLayer SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidLayer ), 
      ErrorInvalidProvider SIP_MONKEYPATCH_COMPAT_NAME( ErrInvalidProvider ), 
      ErrorProviderUnsupportedFeature SIP_MONKEYPATCH_COMPAT_NAME( ErrProviderUnsupportedFeature ), 
      ErrorConnectionFailed SIP_MONKEYPATCH_COMPAT_NAME( ErrConnectionFailed ), 
      UserCanceled SIP_MONKEYPATCH_COMPAT_NAME( ErrUserCanceled ), 
    };
    Q_ENUM( VectorExportResult )
 
    
    enum class SqlLayerDefinitionCapability : int
    {
      SubsetStringFilter = 1 << 1,  
      GeometryColumn = 1 << 2,      
      PrimaryKeys = 1 << 3,         
      UnstableFeatureIds = 1 << 4   
    };
    Q_ENUM( SqlLayerDefinitionCapability )
    Q_DECLARE_FLAGS( SqlLayerDefinitionCapabilities, SqlLayerDefinitionCapability )
 
    
    enum class SqlKeywordCategory : int
    {
      Keyword,      
      Constant,     
      Function,     
      Geospatial,   
      Operator,     
      Math,         
      Aggregate,    
      String,       
      Identifier    
    };
    Q_ENUM( SqlKeywordCategory )
 
    
    enum class DriveType : int
    {
      Unknown, 
      Invalid, 
      Removable, 
      Fixed, 
      Remote, 
      CdRom, 
      RamDisk, 
    };
    Q_ENUM( DriveType )
 
    
    enum class ActionStart SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsNetworkContentFetcherRegistry, FetchingMode ) : int
      {
      Deferred SIP_MONKEYPATCH_COMPAT_NAME( DownloadLater ), 
      Immediate SIP_MONKEYPATCH_COMPAT_NAME( DownloadImmediately ), 
    };
    Q_ENUM( ActionStart )
 
    
    enum class UnplacedLabelVisibility : int
    {
      FollowEngineSetting, 
      NeverShow, 
    };
    Q_ENUM( UnplacedLabelVisibility )
 
    
    enum class SublayerQueryFlag : int
    {
      FastScan = 1 << 0, 
      ResolveGeometryType = 1 << 1, 
      CountFeatures = 1 << 2, 
      IncludeSystemTables = 1 << 3, 
    };
    Q_DECLARE_FLAGS( SublayerQueryFlags, SublayerQueryFlag )
    Q_ENUM( SublayerQueryFlag )
 
    
    enum class SublayerFlag : int
    {
      SystemTable = 1 << 0, 
    };
    Q_DECLARE_FLAGS( SublayerFlags, SublayerFlag )
    Q_ENUM( SublayerFlag )
 
    
    enum class RasterPipeInterfaceRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterPipe, Role ) : int
      {
      Unknown SIP_MONKEYPATCH_COMPAT_NAME( UnknownRole ) = 0, 
      Provider SIP_MONKEYPATCH_COMPAT_NAME( ProviderRole ) = 1, 
      Renderer SIP_MONKEYPATCH_COMPAT_NAME( RendererRole ) = 2, 
      Brightness SIP_MONKEYPATCH_COMPAT_NAME( BrightnessRole ) = 3, 
      Resampler SIP_MONKEYPATCH_COMPAT_NAME( ResamplerRole ) = 4, 
      Projector SIP_MONKEYPATCH_COMPAT_NAME( ProjectorRole ) = 5, 
      Nuller SIP_MONKEYPATCH_COMPAT_NAME( NullerRole ) = 6, 
      HueSaturation SIP_MONKEYPATCH_COMPAT_NAME( HueSaturationRole ) = 7, 
    };
    Q_ENUM( RasterPipeInterfaceRole )
 
    
    enum class RasterResamplingStage SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterPipe, ResamplingStage ) : int
      {
      ResampleFilter,
      Provider
    };
    Q_ENUM( RasterResamplingStage )
 
    
    enum class MeshEditingErrorType : int
    {
      NoError, 
      InvalidFace, 
      TooManyVerticesInFace, 
      FlatFace, 
      UniqueSharedVertex, 
      InvalidVertex, 
      ManifoldFace, 
    };
    Q_ENUM( MeshEditingErrorType )
 
    
    enum class FilePathType : int
    {
      Absolute, 
      Relative, 
    };
    Q_ENUM( FilePathType )
 
    
    enum class SublayerPromptMode : int
    {
      AlwaysAsk, 
      AskExcludingRasterBands, 
      NeverAskSkip, 
      NeverAskLoadAll, 
    };
    Q_ENUM( SublayerPromptMode )
 
    
    enum class SelectBehavior SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorLayer, SelectBehavior ) : int
      {
      SetSelection, 
      AddToSelection, 
      IntersectSelection, 
      RemoveFromSelection, 
    };
    Q_ENUM( SelectBehavior )
 
    
    enum class VectorEditResult SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorLayer, EditResult ) : int
      {
      Success = 0, 
      EmptyGeometry = 1, 
      EditFailed = 2, 
      FetchFeatureFailed = 3, 
      InvalidLayer = 4, 
    };
    Q_ENUM( VectorEditResult )
 
    
    enum class VertexMarkerType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsSymbolLayerUtils, VertexMarkerType ) : int
      {
      SemiTransparentCircle, 
      Cross, 
      NoMarker, 
    };
    Q_ENUM( VertexMarkerType )
 
    
    enum class ContentStatus : int
    {
      NotStarted, 
      Running, 
      Finished, 
      Failed, 
      Canceled, 
    };
    Q_ENUM( ContentStatus )
 
    
    enum class BabelFormatCapability : int
    {
      Import = 1 << 0, 
      Export = 1 << 1, 
      Waypoints = 1 << 2, 
      Routes = 1 << 3, 
      Tracks = 1 << 4, 
    };
    Q_DECLARE_FLAGS( BabelFormatCapabilities, BabelFormatCapability )
    Q_ENUM( BabelFormatCapability )
 
    
    enum class BabelCommandFlag : int
    {
      QuoteFilePaths = 1 << 0, 
    };
    Q_DECLARE_FLAGS( BabelCommandFlags, BabelCommandFlag )
    Q_ENUM( BabelCommandFlag )
 
    
    enum class GpsFeatureType : int
    {
      Waypoint, 
      Route, 
      Track, 
    };
    Q_ENUM( GpsFeatureType )
 
    
    enum class GeometryOperationResult SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, OperationResult ) : int
      {
      Success = 0, 
      NothingHappened = 1000, 
      InvalidBaseGeometry, 
      InvalidInputGeometryType, 
      SelectionIsEmpty, 
      SelectionIsGreaterThanOne, 
      GeometryEngineError, 
      LayerNotEditable, 
      /* Add part issues */
      AddPartSelectedGeometryNotFound, 
      AddPartNotMultiGeometry, 
      /* Add ring issues*/
      AddRingNotClosed, 
      AddRingNotValid, 
      AddRingCrossesExistingRings, 
      AddRingNotInExistingFeature, 
      /* Split features */
      SplitCannotSplitPoint, 
    };
    Q_ENUM( GeometryOperationResult )
 
    
    enum class GeometryValidityFlag SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, ValidityFlag ) : int
      {
      AllowSelfTouchingHoles SIP_MONKEYPATCH_COMPAT_NAME( FlagAllowSelfTouchingHoles ) = 1 << 0, 
    };
    Q_DECLARE_FLAGS( GeometryValidityFlags, GeometryValidityFlag ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsGeometry, ValidityFlags )
    Q_ENUM( GeometryValidityFlag )
 
    
    enum class GeometryValidationEngine SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, ValidationMethod ) : int
      {
      QgisInternal SIP_MONKEYPATCH_COMPAT_NAME( ValidatorQgisInternal ), 
      Geos SIP_MONKEYPATCH_COMPAT_NAME( ValidatorGeos ), 
    };
    Q_ENUM( GeometryValidationEngine )
 
    
    enum class BufferSide SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, BufferSide ) : int
      {
      Left SIP_MONKEYPATCH_COMPAT_NAME( SideLeft ) = 0, 
      Right SIP_MONKEYPATCH_COMPAT_NAME( SideRight ), 
    };
    Q_ENUM( BufferSide )
 
    
    enum class EndCapStyle SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, EndCapStyle ) : int
      {
      Round SIP_MONKEYPATCH_COMPAT_NAME( CapRound ) = 1, 
      Flat SIP_MONKEYPATCH_COMPAT_NAME( CapFlat ), 
      Square SIP_MONKEYPATCH_COMPAT_NAME( CapSquare ), 
    };
    Q_ENUM( EndCapStyle )
 
    
    enum class JoinStyle SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsGeometry, JoinStyle ) : int
      {
      Round SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleRound ) = 1, 
      Miter SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleMiter ), 
      Bevel SIP_MONKEYPATCH_COMPAT_NAME( JoinStyleBevel ), 
    };
    Q_ENUM( JoinStyle )
 
    
    enum class SpatialFilterType : int
    {
      NoFilter, 
      BoundingBox, 
      DistanceWithin, 
    };
    Q_ENUM( SpatialFilterType )
 
    
    enum class FileOperationFlag : int
    {
      IncludeMetadataFile = 1 << 0, 
      IncludeStyleFile = 1 << 1, 
    };
    Q_DECLARE_FLAGS( FileOperationFlags, FileOperationFlag )
    Q_ENUM( FileOperationFlag )
 
    
    enum class MapLayerProperty : int
    {
      UsersCannotToggleEditing = 1 << 0, 
    };
    Q_DECLARE_FLAGS( MapLayerProperties, MapLayerProperty )
    Q_ENUM( MapLayerProperty )
 
    
    enum class AnnotationItemFlag : int
    {
      ScaleDependentBoundingBox = 1 << 0, 
    };
    Q_DECLARE_FLAGS( AnnotationItemFlags, AnnotationItemFlag )
    Q_ENUM( AnnotationItemFlag )
 
    
    enum class AnnotationItemGuiFlag : int
    {
      FlagNoCreationTools = 1 << 0,  
    };
    Q_DECLARE_FLAGS( AnnotationItemGuiFlags, AnnotationItemGuiFlag )
    Q_ENUM( AnnotationItemGuiFlag )
 
    
    enum class AnnotationItemNodeType : int
    {
      VertexHandle, 
    };
    Q_ENUM( AnnotationItemNodeType )
 
    
    enum class AnnotationItemEditOperationResult : int
    {
      Success, 
      Invalid, 
      ItemCleared, 
    };
    Q_ENUM( AnnotationItemEditOperationResult )
 
    
    enum class VectorTemporalMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorLayerTemporalProperties, TemporalMode ) : int
      {
      FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0, 
      FeatureDateTimeInstantFromField SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeInstantFromField ), 
      FeatureDateTimeStartAndEndFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromFields ), 
      FeatureDateTimeStartAndDurationFromFields SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndDurationFromFields ), 
      FeatureDateTimeStartAndEndFromExpressions SIP_MONKEYPATCH_COMPAT_NAME( ModeFeatureDateTimeStartAndEndFromExpressions ), 
      RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ), 
    };
    Q_ENUM( VectorTemporalMode )
 
    
    enum class VectorTemporalLimitMode : int
    {
      IncludeBeginExcludeEnd = 0, 
      IncludeBeginIncludeEnd, 
    };
    Q_ENUM( VectorTemporalLimitMode )
 
    
    enum class VectorDataProviderTemporalMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVectorDataProviderTemporalCapabilities, TemporalMode ) : int
      {
      HasFixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ProviderHasFixedTemporalRange ) = 0, 
      StoresFeatureDateTimeInstantInField SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeInstantInField ), 
      StoresFeatureDateTimeStartAndEndInSeparateFields SIP_MONKEYPATCH_COMPAT_NAME( ProviderStoresFeatureDateTimeStartAndEndInSeparateFields ), 
    };
    Q_ENUM( VectorDataProviderTemporalMode )
 
    
    enum class RasterTemporalMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterLayerTemporalProperties, TemporalMode ) : int
      {
      FixedTemporalRange SIP_MONKEYPATCH_COMPAT_NAME( ModeFixedTemporalRange ) = 0, 
      TemporalRangeFromDataProvider SIP_MONKEYPATCH_COMPAT_NAME( ModeTemporalRangeFromDataProvider ) = 1, 
      RedrawLayerOnly SIP_MONKEYPATCH_COMPAT_NAME( ModeRedrawLayerOnly ) = 2, 
    };
    Q_ENUM( RasterTemporalMode )
 
    
    enum class TemporalIntervalMatchMethod SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterDataProviderTemporalCapabilities, IntervalHandlingMethod ) : int
      {
      MatchUsingWholeRange, 
      MatchExactUsingStartOfRange, 
      MatchExactUsingEndOfRange, 
      FindClosestMatchToStartOfRange, 
      FindClosestMatchToEndOfRange 
    };
    Q_ENUM( TemporalIntervalMatchMethod )
 
    
    enum class TransformDirection SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsCoordinateTransform, TransformDirection ) : int
      {
      Forward SIP_MONKEYPATCH_COMPAT_NAME( ForwardTransform ), 
      Reverse SIP_MONKEYPATCH_COMPAT_NAME( ReverseTransform ) 
    };
    Q_ENUM( TransformDirection )
 
    
    enum class MapSettingsFlag SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapSettings, Flag ) : int
      {
      Antialiasing             = 0x01,  
      DrawEditingInfo          = 0x02,  
      ForceVectorOutput        = 0x04,  
      UseAdvancedEffects       = 0x08,  
      DrawLabeling             = 0x10,  
      UseRenderingOptimization = 0x20,  
      DrawSelection            = 0x40,  
      DrawSymbolBounds         = 0x80,  
      RenderMapTile            = 0x100, 
      RenderPartialOutput      = 0x200, 
      RenderPreviewJob         = 0x400, 
      RenderBlocking           = 0x800, 
      LosslessImageRendering   = 0x1000, 
      Render3DMap              = 0x2000, 
    };
    Q_DECLARE_FLAGS( MapSettingsFlags, MapSettingsFlag ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsMapSettings, Flags )
    Q_ENUM( MapSettingsFlag )
 
    
    enum class RenderContextFlag SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRenderContext, Flag ) : int
      {
      DrawEditingInfo          = 0x01,  
      ForceVectorOutput        = 0x02,  
      UseAdvancedEffects       = 0x04,  
      UseRenderingOptimization = 0x08,  
      DrawSelection            = 0x10,  
      DrawSymbolBounds         = 0x20,  
      RenderMapTile            = 0x40,  
      Antialiasing             = 0x80,  
      RenderPartialOutput      = 0x100, 
      RenderPreviewJob         = 0x200, 
      RenderBlocking           = 0x400, 
      RenderSymbolPreview      = 0x800, 
      LosslessImageRendering   = 0x1000, 
      ApplyScalingWorkaroundForTextRendering = 0x2000, 
      Render3DMap              = 0x4000, 
      ApplyClipAfterReprojection = 0x8000, 
      RenderingSubSymbol       = 0x10000, 
    };
    Q_DECLARE_FLAGS( RenderContextFlags, RenderContextFlag ) SIP_MONKEYPATCH_FLAGS_UNNEST( QgsRenderContext, Flags )
    Q_ENUM( RenderContextFlag )
 
    // refs for below dox: https://github.com/qgis/QGIS/pull/1286#issuecomment-39806854
    // https://github.com/qgis/QGIS/pull/8573#issuecomment-445585826
 
    
    enum class TextRenderFormat SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRenderContext, TextRenderFormat ) : int
      {
      AlwaysOutlines SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysOutlines ), 
      AlwaysText SIP_MONKEYPATCH_COMPAT_NAME( TextFormatAlwaysText ), 
    };
    Q_ENUM( TextRenderFormat )
 
    
    enum class RenderSubcomponentProperty : int
    {
      Generic, 
      ShadowOffset, 
      BlurSize, 
      GlowSpread, 
    };
    Q_ENUM( RenderSubcomponentProperty )
 
    
    enum class VertexType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsVertexId, VertexType ) : int
      {
      Segment SIP_MONKEYPATCH_COMPAT_NAME( SegmentVertex ) = 1, 
      Curve SIP_MONKEYPATCH_COMPAT_NAME( CurveVertex ) = 2, 
    };
    Q_ENUM( VertexType )
 
    
    static const double DEFAULT_SEARCH_RADIUS_MM;
 
    static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
 
    static const QColor DEFAULT_HIGHLIGHT_COLOR;
 
    static const double DEFAULT_HIGHLIGHT_BUFFER_MM;
 
    static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM;
 
    static const double SCALE_PRECISION;
 
    static const double DEFAULT_Z_COORDINATE;
 
    static const double DEFAULT_M_COORDINATE;
 
    static const double UI_SCALE_FACTOR;
 
    static const double DEFAULT_SNAP_TOLERANCE;
 
    static const QgsTolerance::UnitType DEFAULT_SNAP_UNITS;
 
    static QString defaultProjectScales();
 
    static int geosVersionInt();
 
    static int geosVersionMajor();
 
    static int geosVersionMinor();
 
    static int geosVersionPatch();
 
    static QString geosVersion();
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolRenderHints )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolPreviewFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolLayerFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::BrowserItemCapabilities )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SublayerQueryFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SublayerFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SqlLayerDefinitionCapabilities )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::BabelFormatCapabilities )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::BabelCommandFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::GeometryValidityFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::FileOperationFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::AnnotationItemFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::AnnotationItemGuiFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::MapSettingsFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::RenderContextFlags )
 
 
// hack to workaround warnings when casting void pointers
// retrieved from QLibrary::resolve to function pointers.
// It's assumed that this works on all systems supporting
// QLibrary
#define cast_to_fptr(f) f
 
 
// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
template<class Object> class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude=rule-of-three
{
  public:
 
    explicit QgsSignalBlocker( Object * object )
      : mObject( object )
      , mPreviousState( object->blockSignals( true ) )
    {}
 
    ~QgsSignalBlocker()
    {
      mObject->blockSignals( mPreviousState );
    }
 
    Object *operator->() { return mObject; }
 
  private:
 
    Object *mObject = nullptr;
    bool mPreviousState;
 
};
 
// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
template<class Object> inline QgsSignalBlocker<Object> whileBlocking( Object *object ) SIP_SKIP SIP_SKIP
{
  return QgsSignalBlocker<Object>( object );
}
 
CORE_EXPORT uint qHash( const QVariant &variant );
 
inline QString qgsDoubleToString( double a, int precision = 17 )
{
  QString str = QString::number( a, 'f', precision );
  if ( precision )
  {
    if ( str.contains( QLatin1Char( '.' ) ) )
    {
      // remove ending 0s
      int idx = str.length() - 1;
      while ( str.at( idx ) == '0' && idx > 1 )
      {
        idx--;
      }
      if ( idx < str.length() - 1 )
        str.truncate( str.at( idx ) == '.' ? idx : idx + 1 );
    }
  }
  // avoid printing -0
  // see https://bugreports.qt.io/browse/QTBUG-71439
  if ( str == QLatin1String( "-0" ) )
  {
    return QLatin1String( "0" );
  }
  return str;
}
 
inline bool qgsNanCompatibleEquals( double a, double b )
{
  const bool aIsNan = std::isnan( a );
  const bool bIsNan = std::isnan( b );
  if ( aIsNan || bIsNan )
    return aIsNan && bIsNan;
 
  return a == b;
}
 
inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * std::numeric_limits<double>::epsilon() )
{
  const bool aIsNan = std::isnan( a );
  const bool bIsNan = std::isnan( b );
  if ( aIsNan || bIsNan )
    return aIsNan && bIsNan;
 
  const double diff = a - b;
  return diff > -epsilon && diff <= epsilon;
}
 
inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON )
{
  const bool aIsNan = std::isnan( a );
  const bool bIsNan = std::isnan( b );
  if ( aIsNan || bIsNan )
    return aIsNan && bIsNan;
 
  const float diff = a - b;
  return diff > -epsilon && diff <= epsilon;
}
 
inline bool qgsDoubleNearSig( double a, double b, int significantDigits = 10 )
{
  const bool aIsNan = std::isnan( a );
  const bool bIsNan = std::isnan( b );
  if ( aIsNan || bIsNan )
    return aIsNan && bIsNan;
 
  // The most simple would be to print numbers as %.xe and compare as strings
  // but that is probably too costly
  // Then the fastest would be to set some bits directly, but little/big endian
  // has to be considered (maybe TODO)
  // Is there a better way?
  int aexp, bexp;
  const double ar = std::frexp( a, &aexp );
  const double br = std::frexp( b, &bexp );
 
  return aexp == bexp &&
         std::round( ar * std::pow( 10.0, significantDigits ) ) == std::round( br * std::pow( 10.0, significantDigits ) );
}
 
inline double qgsRound( double number, int places )
{
  const double m = ( number < 0.0 ) ? -1.0 : 1.0;
  const double scaleFactor = std::pow( 10.0, places );
  return ( std::round( number * m * scaleFactor ) / scaleFactor ) * m;
}
 
 
#ifndef SIP_RUN
 
 
namespace qgis
{
 
  template<typename To, typename From> inline To down_cast( From *f )
  {
    static_assert(
      ( std::is_base_of<From,
        typename std::remove_pointer<To>::type>::value ),
      "target type not derived from source type" );
    Q_ASSERT( f == nullptr || dynamic_cast<To>( f ) != nullptr );
    return static_cast<To>( f );
  }
 
  template<class T>
  QSet<T> listToSet( const QList<T> &list )
  {
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
    return list.toSet();
#else
    return QSet<T>( list.begin(), list.end() );
#endif
  }
 
  template<class T>
  QList<T> setToList( const QSet<T> &set )
  {
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
    return set.toList();
#else
    return QList<T>( set.begin(), set.end() );
#endif
  }
}
 
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
namespace std
{
  template<> struct hash<QString>
  {
    std::size_t operator()( const QString &s ) const noexcept
    {
      return ( size_t ) qHash( s );
    }
  };
}
#endif
 
#endif
 
template<class T> const QMap<T, QString> qgsEnumMap() SIP_SKIP
{
  const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
  Q_ASSERT( metaEnum.isValid() );
  QMap<T, QString> enumMap;
  for ( int idx = 0; idx < metaEnum.keyCount(); ++idx )
  {
    const char *enumKey = metaEnum.key( idx );
    enumMap.insert( static_cast<T>( metaEnum.keyToValue( enumKey ) ), QString( enumKey ) );
  }
  return enumMap;
}
 
template<class T> QString qgsEnumValueToKey( const T &value ) SIP_SKIP
{
  const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
  Q_ASSERT( metaEnum.isValid() );
  return QString::fromUtf8( metaEnum.valueToKey( static_cast<int>( value ) ) );
}
 
template<class T> T qgsEnumKeyToValue( const QString &key, const T &defaultValue, bool tryValueAsKey = true ) SIP_SKIP
{
  const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
  Q_ASSERT( metaEnum.isValid() );
  bool ok = false;
  T v = static_cast<T>( metaEnum.keyToValue( key.toUtf8().data(), &ok ) );
  if ( ok )
  {
    return v;
  }
  else
  {
    // if conversion has failed, try with conversion from int value
    if ( tryValueAsKey )
    {
      bool canConvert = false;
      const int intValue = key.toInt( &canConvert );
      if ( canConvert && metaEnum.valueToKey( intValue ) )
      {
        return static_cast<T>( intValue );
      }
    }
  }
  return defaultValue;
}
 
template<class T> QString qgsFlagValueToKeys( const T &value ) SIP_SKIP
{
  const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
  Q_ASSERT( metaEnum.isValid() );
  return QString::fromUtf8( metaEnum.valueToKeys( static_cast<int>( value ) ) );
}
 
template<class T> T qgsFlagKeysToValue( const QString &keys, const T &defaultValue ) SIP_SKIP
{
  const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
  Q_ASSERT( metaEnum.isValid() );
  bool ok = false;
  T v = static_cast<T>( metaEnum.keysToValue( keys.toUtf8().constData(), &ok ) );
  if ( ok )
    return v;
  else
    return defaultValue;
}
 
 
CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
 
CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );
 
CORE_EXPORT qlonglong qgsPermissiveToLongLong( QString string, bool &ok );
 
CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
 
CORE_EXPORT bool qgsVariantEqual( const QVariant &lhs, const QVariant &rhs );
 
CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
 
inline bool operator> ( const QVariant &v1, const QVariant &v2 )
{
  return qgsVariantGreaterThan( v1, v2 );
}
 
inline bool operator< ( const QVariant &v1, const QVariant &v2 )
{
  return qgsVariantLessThan( v1, v2 );
}
#endif
 
 
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
 
template<> CORE_EXPORT bool qMapLessThanKey<QVariantList>( const QVariantList &key1, const QVariantList &key2 ) SIP_SKIP;
#endif
 
CORE_EXPORT QString qgsVsiPrefix( const QString &path );
 
void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP;
 
void CORE_EXPORT *qgsCalloc( size_t nmemb, size_t size ) SIP_SKIP;
 
void CORE_EXPORT qgsFree( void *ptr ) SIP_SKIP;
 
#ifndef SIP_RUN
 
#ifdef _MSC_VER
#define CONSTLATIN1STRING inline const QLatin1String
#else
#define CONSTLATIN1STRING constexpr QLatin1String
#endif
 
class ScopedIntIncrementor
{
  public:
 
    ScopedIntIncrementor( int *variable )
      : mVariable( variable )
    {
      ( *mVariable )++;
    }
 
    ScopedIntIncrementor( const ScopedIntIncrementor &other ) = delete;
    ScopedIntIncrementor &operator=( const ScopedIntIncrementor &other ) = delete;
 
    void release()
    {
      if ( mVariable )
        ( *mVariable )--;
 
      mVariable = nullptr;
    }
 
    ~ScopedIntIncrementor()
    {
      release();
    }
 
  private:
    int *mVariable = nullptr;
};
 
CONSTLATIN1STRING geoWkt()
{
  return QLatin1String(
           R"""(GEOGCRS["WGS 84",DATUM["World Geodetic System 1984",ELLIPSOID["WGS 84",6378137,298.257223563,LENGTHUNIT["metre",1]]],PRIMEM["Greenwich",0,ANGLEUNIT["degree",0.0174532925199433]],CS[ellipsoidal,2],AXIS["geodetic latitude (Lat)",north,ORDER[1],ANGLEUNIT["degree",0.0174532925199433]],AXIS["geodetic longitude (Lon)",east,ORDER[2],ANGLEUNIT["degree",0.0174532925199433]],USAGE[SCOPE["unknown"],AREA["World"],BBOX[-90,-180,90,180]],ID["EPSG",4326]] )"""
         );
}
 
CONSTLATIN1STRING geoProj4()
{
  return QLatin1String( "+proj=longlat +datum=WGS84 +no_defs" );
}
 
CONSTLATIN1STRING geoEpsgCrsAuthId()
{
  return QLatin1String( "EPSG:4326" );
}
 
CONSTLATIN1STRING geoNone()
{
  return QLatin1String( "NONE" );
}
 
 
const int PREVIEW_JOB_DELAY_MS = 250;
 
const int MAXIMUM_LAYER_PREVIEW_TIME_MS = 250;
 
 
#endif
 
const long GEOSRID = 4326;
 
const long GEOCRS_ID = 3452;
 
const long GEO_EPSG_CRS_ID = 4326;
 
const int USER_CRS_START_ID = 100000;
 
//
// Constants for point symbols
//
 
const double DEFAULT_POINT_SIZE = 2.0;
const double DEFAULT_LINE_WIDTH = 0.26;
 
const double DEFAULT_SEGMENT_EPSILON = 1e-8;
 
typedef QMap<QString, QString> QgsStringMap SIP_SKIP;
 
typedef unsigned long long qgssize;
 
#ifndef SIP_RUN
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || defined(__clang__)
 
#define Q_NOWARN_DEPRECATED_PUSH \
  _Pragma("GCC diagnostic push") \
  _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"");
#define Q_NOWARN_DEPRECATED_POP \
  _Pragma("GCC diagnostic pop");
#define Q_NOWARN_UNREACHABLE_PUSH
#define Q_NOWARN_UNREACHABLE_POP
 
#elif defined(_MSC_VER)
 
#define Q_NOWARN_DEPRECATED_PUSH \
  __pragma(warning(push)) \
  __pragma(warning(disable:4996))
#define Q_NOWARN_DEPRECATED_POP \
  __pragma(warning(pop))
#define Q_NOWARN_UNREACHABLE_PUSH \
  __pragma(warning(push)) \
  __pragma(warning(disable:4702))
#define Q_NOWARN_UNREACHABLE_POP \
  __pragma(warning(pop))
 
#else
 
#define Q_NOWARN_DEPRECATED_PUSH
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_UNREACHABLE_PUSH
#define Q_NOWARN_UNREACHABLE_POP
 
#endif
#endif
 
#ifndef QGISEXTERN
#ifdef Q_OS_WIN
#  define QGISEXTERN extern "C" __declspec( dllexport )
#else
#  if defined(__GNUC__) || defined(__clang__)
#    define QGISEXTERN extern "C" __attribute__ ((visibility ("default")))
#  else
#    define QGISEXTERN extern "C"
#  endif
#endif
#endif
#endif
 
#if __cplusplus >= 201500
#define FALLTHROUGH [[fallthrough]];
#elif defined(__clang__)
#define FALLTHROUGH [[clang::fallthrough]];
#elif defined(__GNUC__) && __GNUC__ >= 7
#define FALLTHROUGH [[gnu::fallthrough]];
#else
#define FALLTHROUGH
#endif
 
// see https://infektor.net/posts/2017-01-19-using-cpp17-attributes-today.html#using-the-nodiscard-attribute
#if __cplusplus >= 201703L
#define NODISCARD [[nodiscard]]
#elif defined(__clang__)
#define NODISCARD [[nodiscard]]
#elif defined(_MSC_VER)
#define NODISCARD // no support
#elif defined(__has_cpp_attribute)
#if __has_cpp_attribute(nodiscard)
#define NODISCARD [[nodiscard]]
#elif __has_cpp_attribute(gnu::warn_unused_result)
#define NODISCARD [[gnu::warn_unused_result]]
#else
#define NODISCARD Q_REQUIRED_RESULT
#endif
#else
#define NODISCARD Q_REQUIRED_RESULT
#endif
 
#if __cplusplus >= 201703L
#define MAYBE_UNUSED [[maybe_unused]]
#elif defined(__clang__)
#define MAYBE_UNUSED [[maybe_unused]]
#elif defined(_MSC_VER)
#define MAYBE_UNUSED // no support
#elif defined(__has_cpp_attribute)
#if __has_cpp_attribute(gnu::unused)
#define MAYBE_UNUSED [[gnu::unused]]
#else
#define MAYBE_UNUSED
#endif
#else
#define MAYBE_UNUSED
#endif
 
#ifndef FINAL
#define FINAL final
#endif
 
#ifndef SIP_RUN
#ifdef _MSC_VER
#define BUILTIN_UNREACHABLE \
  __assume(false);
#elif defined(__GNUC__) && !defined(__clang__)
// Workaround a GCC bug where a -Wreturn-type warning is emitted in constructs
// like:
// switch( mVariableThatCanOnlyBeXorY )
// {
//    case X:
//        return "foo";
//    case Y:
//        return "foo";
// }
// See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=87951
#define BUILTIN_UNREACHABLE \
  __builtin_unreachable();
#else
#define BUILTIN_UNREACHABLE
#endif
#endif // SIP_RUN
 
#ifdef SIP_RUN
 
QString CORE_EXPORT geoWkt();
 
QString CORE_EXPORT geoProj4();
 
QString CORE_EXPORT geoEpsgCrsAuthId();
 
QString CORE_EXPORT geoNone();
 
#endif