Add file extensions for babel import formats

qgis · Aug 2, 2021 · ebd7d0c · ebd7d0c
1 parent 3ee1f2b
commit ebd7d0c
Show file tree

Hide file tree

Showing 6 changed files with 172 additions and 147 deletions.
diff --git a/python/core/auto_generated/gps/qgsbabelformat.sip.in b/python/core/auto_generated/gps/qgsbabelformat.sip.in
@@ -93,7 +93,8 @@ A babel format capable of converting input files to GPX files.
 %End
   public:
 
-    QgsBabelSimpleImportFormat( const QString &format, const QString &description, Qgis::BabelFormatCapabilities capabilities );
+    QgsBabelSimpleImportFormat( const QString &format, const QString &description, Qgis::BabelFormatCapabilities capabilities,
+                                const QStringList extensions = QStringList() );
 %Docstring
 Constructor for QgsBabelSimpleImportFormat.
 
@@ -103,11 +104,19 @@ The ``description`` argument specified a descriptive name for the format.
 
 The ``capabilities`` argument must reflect whether the format is capable of handling
 waypoints, routes and/or tracks.
+
+The optional ``extensions`` argument can be used to populate a list of known file
+extensions for the format (e.g. "csv", "txt").
 %End
 
     QString description() const;
 %Docstring
 Returns the friendly description for the format.
+%End
+
+    QStringList extensions() const;
+%Docstring
+Returns the list of known extensions for the format, e.g. "csv", "txt".
 %End
 
      virtual QStringList importCommand( const QString &babel,

diff --git a/scripts/dump_babel_formats.py b/scripts/dump_babel_formats.py
@@ -81,8 +81,11 @@ def process_lines(lines):
                 capabilities.append('Qgis::BabelFormatCapability::Routes')
             if read_tracks:
                 capabilities.append('Qgis::BabelFormatCapability::Tracks')
+            capabilities_string = ' | '.join(capabilities)
+
+            extensions_string = '{' + ', '.join([f'QStringLiteral( "{ext.strip()}" )' for ext in extensions if ext.strip()]) + '}'
             format_out[
-                name] = f"""mImporters[QStringLiteral( "{name}" )] = new QgsBabelSimpleImportFormat( QStringLiteral( "{name}" ), QStringLiteral( "{description}" ), {' | '.join(capabilities)} );"""
+                name] = f'mImporters[QStringLiteral( "{name}" )] = new QgsBabelSimpleImportFormat( QStringLiteral( "{name}" ), QStringLiteral( "{description}" ), {capabilities_string}, {extensions_string} );'
 
     for format_name in sorted(format_out.keys(), key=lambda x: x.lower()):
         print(format_out[format_name])

diff --git a/src/core/gps/qgsbabelformat.cpp b/src/core/gps/qgsbabelformat.cpp
@@ -64,9 +64,10 @@ Qgis::BabelFormatCapabilities QgsAbstractBabelFormat::capabilities() const
 //
 
 QgsBabelSimpleImportFormat::QgsBabelSimpleImportFormat( const QString &format, const QString &description,
-    Qgis::BabelFormatCapabilities capabilities )
+    Qgis::BabelFormatCapabilities capabilities, const QStringList extensions )
   : QgsAbstractBabelFormat( format )
   , mDescription( description )
+  , mExtensions( extensions )
 {
   mCapabilities = capabilities;
   mCapabilities |= Qgis::BabelFormatCapability::Import;

diff --git a/src/core/gps/qgsbabelformat.h b/src/core/gps/qgsbabelformat.h
@@ -115,20 +115,30 @@ class CORE_EXPORT QgsBabelSimpleImportFormat : public QgsAbstractBabelFormat
      *
      * The \a capabilities argument must reflect whether the format is capable of handling
      * waypoints, routes and/or tracks.
+     *
+     * The optional \a extensions argument can be used to populate a list of known file
+     * extensions for the format (e.g. "csv", "txt").
      */
-    QgsBabelSimpleImportFormat( const QString &format, const QString &description, Qgis::BabelFormatCapabilities capabilities );
+    QgsBabelSimpleImportFormat( const QString &format, const QString &description, Qgis::BabelFormatCapabilities capabilities,
+                                const QStringList extensions = QStringList() );
 
     /**
      * Returns the friendly description for the format.
      */
     QString description() const { return mDescription; }
 
+    /**
+     * Returns the list of known extensions for the format, e.g. "csv", "txt".
+     */
+    QStringList extensions() const { return mExtensions; }
+
     QStringList importCommand( const QString &babel,
                                Qgis::GpsFeatureType featureType,
                                const QString &input,
                                const QString &output ) const override;
   private:
     QString mDescription;
+    QStringList mExtensions;
 };
 
 #endif