QGIS API Documentation  2.99.0-Master (3450a9f)
qgis.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgis.cpp
3 
4  -------------------
5  begin : 2007
6  copyright : (C) 2007 by Gary E. Sherman
7  email : [email protected]
8 ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 #include "qgis.h"
19 #ifndef QGSVERSION
20 #include "qgsversion.h"
21 #endif
22 #include <QCoreApplication>
23 #include <QColor>
24 #include <QDate>
25 #include <QTime>
26 #include <QLocale>
27 #include <QDateTime>
28 #include "qgsconfig.h"
29 #include "qgslogger.h"
30 #include "geometry/qgswkbtypes.h"
31 
32 #include <ogr_api.h>
33 
34 // Version constants
35 //
36 
37 // Version string
38 const QString Qgis::QGIS_VERSION( QStringLiteral( VERSION ) );
39 
40 // development version
41 const char *Qgis::QGIS_DEV_VERSION = QGSVERSION;
42 
43 // Version number used for comparing versions using the
44 // "Check QGIS Version" function
45 const int Qgis::QGIS_VERSION_INT = VERSION_INT;
46 
47 // Release name
48 const QString Qgis::QGIS_RELEASE_NAME( QStringLiteral( RELEASE_NAME ) );
49 
50 const QString GEOPROJ4 = QStringLiteral( "+proj=longlat +datum=WGS84 +no_defs" );
51 
52 const QString GEOWKT =
53  "GEOGCS[\"WGS 84\", "
54  " DATUM[\"WGS_1984\", "
55  " SPHEROID[\"WGS 84\",6378137,298.257223563, "
56  " AUTHORITY[\"EPSG\",7030]], "
57  " TOWGS84[0,0,0,0,0,0,0], "
58  " AUTHORITY[\"EPSG\",6326]], "
59  " PRIMEM[\"Greenwich\",0,AUTHORITY[\"EPSG\",8901]], "
60  " UNIT[\"DMSH\",0.0174532925199433,AUTHORITY[\"EPSG\",9108]], "
61  " AXIS[\"Lat\",NORTH], "
62  " AXIS[\"Long\",EAST], "
63  " AUTHORITY[\"EPSG\",4326]]";
64 
65 const QString PROJECT_SCALES =
66  "1:1000000,1:500000,1:250000,1:100000,1:50000,1:25000,"
67  "1:10000,1:5000,1:2500,1:1000,1:500";
68 
69 const QString GEO_EPSG_CRS_AUTHID = QStringLiteral( "EPSG:4326" );
70 
71 const QString GEO_NONE = QStringLiteral( "NONE" );
72 
73 const double Qgis::DEFAULT_SEARCH_RADIUS_MM = 2.;
74 
75 const float Qgis::DEFAULT_MAPTOPIXEL_THRESHOLD = 1.0f;
76 
77 const QColor Qgis::DEFAULT_HIGHLIGHT_COLOR = QColor( 255, 0, 0, 128 );
78 
79 const double Qgis::DEFAULT_HIGHLIGHT_BUFFER_MM = 0.5;
80 
81 const double Qgis::DEFAULT_HIGHLIGHT_MIN_WIDTH_MM = 1.0;
82 
83 const double Qgis::SCALE_PRECISION = 0.9999999999;
84 
85 const double Qgis::DEFAULT_Z_COORDINATE = 0.0;
86 
87 double qgsPermissiveToDouble( QString string, bool &ok )
88 {
89  //remove any thousands separators
90  string.remove( QLocale::system().groupSeparator() );
91  return QLocale::system().toDouble( string, &ok );
92 }
93 
94 int qgsPermissiveToInt( QString string, bool &ok )
95 {
96  //remove any thousands separators
97  string.remove( QLocale::system().groupSeparator() );
98  return QLocale::system().toInt( string, &ok );
99 }
100 
101 void *qgsMalloc( size_t size )
102 {
103  if ( size == 0 || long( size ) < 0 )
104  {
105  QgsDebugMsg( QString( "Negative or zero size %1." ).arg( size ) );
106  return nullptr;
107  }
108  void *p = malloc( size );
109  if ( !p )
110  {
111  QgsDebugMsg( QString( "Allocation of %1 bytes failed." ).arg( size ) );
112  }
113  return p;
114 }
115 
116 void *qgsCalloc( size_t nmemb, size_t size )
117 {
118  if ( nmemb == 0 || long( nmemb ) < 0 || size == 0 || long( size ) < 0 )
119  {
120  QgsDebugMsg( QString( "Negative or zero nmemb %1 or size %2." ).arg( nmemb ).arg( size ) );
121  return nullptr;
122  }
123  void *p = qgsMalloc( nmemb * size );
124  if ( p )
125  {
126  memset( p, 0, nmemb * size );
127  }
128  return p;
129 }
130 
131 void qgsFree( void *ptr )
132 {
133  free( ptr );
134 }
135 
136 bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs )
137 {
138  // invalid < NULL < any value
139  if ( !lhs.isValid() )
140  return rhs.isValid();
141  else if ( lhs.isNull() )
142  return rhs.isValid() && !rhs.isNull();
143  else if ( !rhs.isValid() || rhs.isNull() )
144  return false;
145 
146  switch ( lhs.type() )
147  {
148  case QVariant::Int:
149  return lhs.toInt() < rhs.toInt();
150  case QVariant::UInt:
151  return lhs.toUInt() < rhs.toUInt();
152  case QVariant::LongLong:
153  return lhs.toLongLong() < rhs.toLongLong();
154  case QVariant::ULongLong:
155  return lhs.toULongLong() < rhs.toULongLong();
156  case QVariant::Double:
157  return lhs.toDouble() < rhs.toDouble();
158  case QVariant::Char:
159  return lhs.toChar() < rhs.toChar();
160  case QVariant::Date:
161  return lhs.toDate() < rhs.toDate();
162  case QVariant::Time:
163  return lhs.toTime() < rhs.toTime();
164  case QVariant::DateTime:
165  return lhs.toDateTime() < rhs.toDateTime();
166  case QVariant::Bool:
167  return lhs.toBool() < rhs.toBool();
168 
169  case QVariant::List:
170  {
171  const QList<QVariant> &lhsl = lhs.toList();
172  const QList<QVariant> &rhsl = rhs.toList();
173 
174  int i, n = qMin( lhsl.size(), rhsl.size() );
175  for ( i = 0; i < n && lhsl[i].type() == rhsl[i].type() && lhsl[i].isNull() == rhsl[i].isNull() && lhsl[i] == rhsl[i]; i++ )
176  ;
177 
178  if ( i == n )
179  return lhsl.size() < rhsl.size();
180  else
181  return qgsVariantLessThan( lhsl[i], rhsl[i] );
182  }
183 
184  case QVariant::StringList:
185  {
186  const QStringList &lhsl = lhs.toStringList();
187  const QStringList &rhsl = rhs.toStringList();
188 
189  int i, n = qMin( lhsl.size(), rhsl.size() );
190  for ( i = 0; i < n && lhsl[i] == rhsl[i]; i++ )
191  ;
192 
193  if ( i == n )
194  return lhsl.size() < rhsl.size();
195  else
196  return lhsl[i] < rhsl[i];
197  }
198 
199  default:
200  return QString::localeAwareCompare( lhs.toString(), rhs.toString() ) < 0;
201  }
202 }
203 
204 bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs )
205 {
206  return ! qgsVariantLessThan( lhs, rhs );
207 }
208 
209 QString qgsVsiPrefix( const QString &path )
210 {
211  if ( path.startsWith( QLatin1String( "/vsizip/" ), Qt::CaseInsensitive ) ||
212  path.endsWith( QLatin1String( ".zip" ), Qt::CaseInsensitive ) )
213  return QStringLiteral( "/vsizip/" );
214  else if ( path.startsWith( QLatin1String( "/vsitar/" ), Qt::CaseInsensitive ) ||
215  path.endsWith( QLatin1String( ".tar" ), Qt::CaseInsensitive ) ||
216  path.endsWith( QLatin1String( ".tar.gz" ), Qt::CaseInsensitive ) ||
217  path.endsWith( QLatin1String( ".tgz" ), Qt::CaseInsensitive ) )
218  return QStringLiteral( "/vsitar/" );
219  else if ( path.startsWith( QLatin1String( "/vsigzip/" ), Qt::CaseInsensitive ) ||
220  path.endsWith( QLatin1String( ".gz" ), Qt::CaseInsensitive ) )
221  return QStringLiteral( "/vsigzip/" );
222  else
223  return QLatin1String( "" );
224 }
225 
226 uint qHash( const QVariant &variant )
227 {
228  if ( !variant.isValid() || variant.isNull() )
229  return -1;
230 
231  switch ( variant.type() )
232  {
233  case QVariant::Int:
234  return qHash( variant.toInt() );
235  case QVariant::UInt:
236  return qHash( variant.toUInt() );
237  case QVariant::Bool:
238  return qHash( variant.toBool() );
239  case QVariant::Double:
240  return qHash( variant.toDouble() );
241  case QVariant::LongLong:
242  return qHash( variant.toLongLong() );
243  case QVariant::ULongLong:
244  return qHash( variant.toULongLong() );
245  case QVariant::String:
246  return qHash( variant.toString() );
247  case QVariant::Char:
248  return qHash( variant.toChar() );
249  case QVariant::List:
250  return qHash( variant.toList() );
251  case QVariant::StringList:
252  return qHash( variant.toStringList() );
253  case QVariant::ByteArray:
254  return qHash( variant.toByteArray() );
255  case QVariant::Date:
256  return qHash( variant.toDate() );
257  case QVariant::Time:
258  return qHash( variant.toTime() );
259  case QVariant::DateTime:
260  return qHash( variant.toDateTime() );
261  case QVariant::Url:
262  case QVariant::Locale:
263  case QVariant::RegExp:
264  return qHash( variant.toString() );
265  default:
266  return -1;
267  }
268 
269  return -1;
270 }
static const QString QGIS_VERSION
Version string.
Definition: qgis.h:47
static const char * QGIS_DEV_VERSION
The development version.
Definition: qgis.h:53
void * qgsMalloc(size_t size)
Allocates size bytes and returns a pointer to the allocated memory.
Definition: qgis.cpp:101
#define QgsDebugMsg(str)
Definition: qgslogger.h:36
double qgsPermissiveToDouble(QString string, bool &ok)
Converts a string to a double in a permissive way, e.g., allowing for incorrect numbers of digits bet...
Definition: qgis.cpp:87
void * qgsCalloc(size_t nmemb, size_t size)
Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the alloc...
Definition: qgis.cpp:116
static const QColor DEFAULT_HIGHLIGHT_COLOR
Default highlight color.
Definition: qgis.h:101
bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
Definition: qgis.cpp:204
static const int QGIS_VERSION_INT
Version number used for comparing versions using the "Check QGIS Version" function.
Definition: qgis.h:49
int qgsPermissiveToInt(QString string, bool &ok)
Converts a string to an integer in a permissive way, e.g., allowing for incorrect numbers of digits b...
Definition: qgis.cpp:94
bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
Definition: qgis.cpp:136
const QString GEO_NONE
Constant that holds the string representation for "No ellips/No CRS".
Definition: qgis.cpp:71
static const double DEFAULT_Z_COORDINATE
Default Z coordinate value for 2.5d geometry This value have to be assigned to the Z coordinate for t...
Definition: qgis.h:120
const QString GEOPROJ4
PROJ4 string that represents a geographic coord sys.
Definition: qgis.cpp:50
static const double DEFAULT_SEARCH_RADIUS_MM
Identify search radius in mm.
Definition: qgis.h:93
const QString GEO_EPSG_CRS_AUTHID
Geographic coord sys from EPSG authority.
Definition: qgis.cpp:69
const QString GEOWKT
Wkt string that represents a geographic coord sys.
Definition: qgis.cpp:52
uint qHash(const QVariant &variant)
Hash for QVariant.
Definition: qgis.cpp:226
static const float DEFAULT_MAPTOPIXEL_THRESHOLD
Default threshold between map coordinates and device coordinates for map2pixel simplification.
Definition: qgis.h:96
static const QString QGIS_RELEASE_NAME
Release name.
Definition: qgis.h:51
const QString PROJECT_SCALES
Definition: qgis.cpp:65
QString qgsVsiPrefix(const QString &path)
Definition: qgis.cpp:209
static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM
Default highlight line/stroke minimum width in mm.
Definition: qgis.h:109
static const double DEFAULT_HIGHLIGHT_BUFFER_MM
Default highlight buffer in mm.
Definition: qgis.h:105
void qgsFree(void *ptr)
Frees the memory space pointed to by ptr.
Definition: qgis.cpp:131
static const double SCALE_PRECISION
Fudge factor used to compare two scales.
Definition: qgis.h:115