refs #354, initial cleanup of cfg entries samples / code before adding new functionality

* fixed styles such as copyright headers
* use text stream instead of qDebug() for output
* int instead of qint
* misc. smaller tweaks
* extended the JSON example (special chars). JSON might be used to "cache" the FSX entries

src/blacksim/fscommon/aircraftcfgentries.cpp

@@ -98,5 +98,5 @@ namespace BlackSim
             }
         }
 
-    }
+    } // namespace
 } // namespace

src/blacksim/fscommon/aircraftcfgentries.h

@@ -49,7 +49,7 @@ namespace BlackSim
              * \param atcModel
              * \param atcParkingCode
              */
-            CAircraftCfgEntries(const QString &filePath, qint32 index, const QString &title, const QString &atcType, const QString &atcModel, const QString &atcParkingCode);
+            CAircraftCfgEntries(const QString &filePath, int index, const QString &title, const QString &atcType, const QString &atcModel, const QString &atcParkingCode);
 
             //! Filepath
             QString getFilePath() const { return this->m_filePath; }
@@ -58,7 +58,7 @@ namespace BlackSim
             QString getTitle() const { return this->m_title; }
 
             //! Index
-            qint32 getIndex() const { return this->m_index; }
+            int getIndex() const { return this->m_index; }
 
             //! ATC model
             QString getAtcModel() const { return this->m_atcModel; }
@@ -76,7 +76,7 @@ namespace BlackSim
             void setTitle(const QString &title) { this->m_title = title; }
 
             //! Index
-            void setIndex(const qint32 index) { this->m_index = index; }
+            void setIndex(int index) { this->m_index = index; }
 
             //! ATC model
             void setAtcModel(const QString &atcModel) { this->m_atcModel = atcModel; }
@@ -99,7 +99,7 @@ namespace BlackSim
 
         private:
             BLACK_ENABLE_TUPLE_CONVERSION(CAircraftCfgEntries)
-            qint32 m_index;     //!< current index in given config
+            int m_index;        //!< current index in given config
             QString m_filePath; //!< file path of aircraft.cfg
             QString m_title;    //!< Title in aircraft.cfg
             QString m_atcType;  //!< ATC type

src/blacksim/fscommon/aircraftcfgentrieslist.cpp

@@ -28,22 +28,31 @@ namespace BlackSim
         /*
          * Model for title
          */
-        bool CAircraftCfgEntriesList::containsModeWithTitle(const QString &title, Qt::CaseSensitivity caseSensitivity)
+        bool CAircraftCfgEntriesList::containsModelWithTitle(const QString &title, Qt::CaseSensitivity caseSensitivity)
         {
             return this->containsBy([ = ](const CAircraftCfgEntries & entries) -> bool
             { return title.compare(entries.getTitle(), caseSensitivity) == 0; });
         }
 
+        /*
+         * Models for title
+         */
+        CAircraftCfgEntriesList CAircraftCfgEntriesList::findByTitle(const QString &title, Qt::CaseSensitivity caseSensitivity)
+        {
+            return this->findBy([ = ](const CAircraftCfgEntries & entries) -> bool
+            { return title.compare(entries.getTitle(), caseSensitivity) == 0; });
+        }
+
         /*
          * Read all entrities in given directory
          */
-        qint32 CAircraftCfgEntriesList::read(const QString &directory)
+        int CAircraftCfgEntriesList::read(const QString &directory)
         {
             // set directory with name filters, get aircraft.cfg and sub directories
             QDir dir(directory, "aircraft.cfg", QDir::Name, QDir::Files | QDir::AllDirs);
             if (!dir.exists()) return 0; // can happen if there are shortcuts or linked dirs not available
 
-            qint32 counter = 0;
+            int counter = 0;
             QString currentDir = dir.absolutePath();
 
             // Dirs last is crucial,since I will break recursion on "aircraft.cfg" level

src/blacksim/fscommon/aircraftcfgentrieslist.h

@@ -28,12 +28,6 @@ namespace BlackSim
         //! Utility, providing FSX aircraft.cfg entries
         class CAircraftCfgEntriesList : public BlackMisc::CSequence<CAircraftCfgEntries>
         {
-        private:
-            QString m_rootDirectory; //!< root directory reading aircraft.cfg files
-            bool m_readForDirectory; //!< valid read for given directory
-
-            //! Read all entries in one directory
-            qint32 read(const QString &directory);
 
         public:
 
@@ -41,7 +35,7 @@ namespace BlackSim
             CAircraftCfgEntriesList(const QString &rootDirectory = "") : m_rootDirectory(rootDirectory), m_readForDirectory(false) {}
 
             //! Read all aircraft.cfg files starting from root directory
-            qint32 read()
+            int read()
             {
                 if (this->m_readForDirectory) return this->size();
 
@@ -75,7 +69,10 @@ namespace BlackSim
             QString getRootDirectory() const {  return this->m_rootDirectory; }
 
             //! Contains model with title?
-            bool containsModeWithTitle(const QString &title, Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive);
+            bool containsModelWithTitle(const QString &title, Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive);
+
+            //! Find by title
+            CAircraftCfgEntriesList findByTitle(const QString &title, Qt::CaseSensitivity caseSensitivity);
 
             //! \copydoc CValueObject::toQVariant
             virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
@@ -92,9 +89,17 @@ namespace BlackSim
 
             //! Register metadata
             static void registerMetadata();
+
+        private:
+            QString m_rootDirectory; //!< root directory reading aircraft.cfg files
+            bool m_readForDirectory; //!< valid read for given directory
+
+            //! Read all entries in one directory
+            int read(const QString &directory);
+
         };
-    }
-}
+    } // namespace
+} // namespace
 
 Q_DECLARE_METATYPE(BlackSim::FsCommon::CAircraftCfgEntriesList)
 Q_DECLARE_METATYPE(BlackMisc::CCollection<BlackSim::FsCommon::CAircraftCfgEntries>)

src/blacksim/fscommon/aircraftindexer.h

@@ -1,3 +1,14 @@
+/* Copyright (C) 2013
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \file
+
 #ifndef BLACKSIM_FSCOMMON_AIRCRAFTINDEXER_H
 #define BLACKSIM_FSCOMMON_AIRCRAFTINDEXER_H
 
@@ -9,19 +20,13 @@ namespace BlackSim
 {
     namespace FsCommon
     {
-        /*!
-         * \brief Indexer for all modelsThe CAircraftIndexer class
-         */
+        //! Indexer for all models
+        //! \sa CAircraftCfgEntries
+        //! \sa CAircraftCfgEntriesList
         class CAircraftIndexer : QObject
         {
             Q_OBJECT
 
-        private:
-            //! Constructor
-            CAircraftIndexer(QObject *parent = nullptr);
-
-            CAircraftCfgEntriesList m_entries; //!< all entries
-
         signals:
             //! Number of entries read
             void entriesRead(int number);
@@ -40,7 +45,12 @@ namespace BlackSim
             //! Read in background
             static QFuture<int> readInBackground(const QString directory = "");
 
+        private:
+            //! Constructor
+            CAircraftIndexer(QObject *parent = nullptr);
+
+            CAircraftCfgEntriesList m_entries; //!< all entries
         };
-    }
-}
+    } // namespace
+} // namespace
 #endif // guard

src/blacksim/fscommon/vpilotmodelmappings.h

@@ -19,9 +19,7 @@ namespace BlackSim
 {
     namespace FsCommon
     {
-        /*!
-         * Model mappings
-         */
+        //! Model mappings
         class CVPilotModelMappings : public ISimulatorModelMappings
         {
         public: