File indexing completed on 2024-04-21 04:40:31

 /* This file is part of the KDE project
    Copyright (C) 2003 Daniel Molkentin <molkentin@kde.org>
    Copyright (C) 2003 Joseph Wenninger <jowenn@kde.org>
    Copyright (C) 2003-2015 Jarosław Staniek <staniek@kde.org>
    Copyright (C) 2012 Dimitrios T. Tanis <dimitrios.tanis@kdemail.net>
 
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this program; see the file COPYING.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KDB_DRIVER_MANAGER_H
 #define KDB_DRIVER_MANAGER_H
 
 #include <QString>
 #include <QCoreApplication>
 
 #include "kdb_export.h"
 
 class KDbResult;
 class KDbResultable;
 class KDbDriver;
 class KDbDriverMetaData;
 
 //! A driver manager for finding and loading driver plugins.
 class KDB_EXPORT KDbDriverManager
 {
     Q_DECLARE_TR_FUNCTIONS(KDbDriverManager)
 public:
     KDbDriverManager();
     virtual ~KDbDriverManager();
 
     //! @return result of the recent operation.
     KDbResult result() const;
 
     //! @return KDbResultable object for the recent operation.
     //! It adds serverResultName() in addition to the result().
     KDbResultable* resultable() const;
 
     /*! @return information (metadata) about driver with ID @a id.
       The lookup is case insensitive.
       The metadata object is owned by KDb internals and is not deleted after
       this KDbDriverManager object is deleted.
       @a nullptr is returned if the metadata has not been found.
       On error status can be obtained using result().
 
       @see driver(const QString& id) for information about duplicated drivers. */
     const KDbDriverMetaData* driverMetaData(const QString &id);
 
     /*! Tries to load db driver with ID @a id.
       The lookup is case insensitive.
       @return driver object or @a nullptr on error.
       On error status can be obtained using result().
       The driver object is owned by KDb internals and is not deleted after
       this KDbDriverManager object is deleted.
 
       @note If more than one driver with the same ID found on the search path, first
       located driver is selected. All other drivers for this ID are skip with a warning
       "Driver with ID '...' already found at (path) -- skipping another at (path).
       The warning can be suppressed by setting a KDB_NO_DUPLICATED_DRIVER_WARNINGS
       environment variable. */
     KDbDriver* driver(const QString& id);
 
     /*! returns list of available drivers IDs.
       That drivers can be loaded by first use of driver() method. */
     QStringList driverIds();
 
     /**
      * Returns list of driver IDs for @a mimeType MIME type
      *
      * IDs of drivers for file-based databases are only returned.
      * Empty list is returned if no driver has been found for the type or if the type is invalid.
      * Driver supports the supplied MIME type if it is specified as supported in the driver's
      * metadata. If a MIME type alias is supplied, proper type for this alias is resolved and driver
      * IDs for that type are returned. Similarly, if proper MIME type is supplied, IDs are returned
      * for drivers that support any alias for this type.
      *
      * The lookup is case insensitive.
      */
     QStringList driverIdsForMimeType(const QString& mimeType);
 
     /*! @return HTML-formatted message about possible problems encountered.
      It can be displayed in a 'details' section of a GUI message if an error encountered.
      Currently the message contains a list of incompatible db drivers.
      Can be used in code that finds driver depending on file format. */
 //! @todo make it just QStringList
     QString possibleProblemsMessage() const;
 
     /*! @return true if there is at least one server-based database driver installed. */
     bool hasDatabaseServerDrivers();
 
 private:
     Q_DISABLE_COPY(KDbDriverManager)
 };
 
 #endif