sch_io_database.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Jon Evans <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SCH_IO_DATABASE_H_
#define SCH_IO_DATABASE_H_
 
#include <database/database_connection.h>
#include <sch_io/sch_io.h>
#include <sch_io/sch_io_mgr.h>
#include <wildcards_and_files_ext.h>
#include <atomic>
#include <condition_variable>
#include <mutex>
#include <optional>
#include <shared_mutex>
#include <thread>
#include <unordered_set>
 
 
class LIB_ID;
class LIBRARY_MANAGER_ADAPTER;
class DATABASE_LIB_SETTINGS;
struct DATABASE_LIB_TABLE;
 

class SCH_IO_DATABASE : public SCH_IO
{
    friend class SCH_IO_DATABASE_CYCLE_DETECTION_FIXTURE;
 
public:
 
    SCH_IO_DATABASE();
    virtual ~SCH_IO_DATABASE();
 
    const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
    {
        return IO_BASE::IO_FILE_DESC( _HKI( "KiCad database library files" ),
                                      { FILEEXT::DatabaseLibraryFileExtension } );
    }
 
    int GetModifyHash() const override { return m_modifyHash; }
 
    void EnumerateSymbolLib( wxArrayString&    aSymbolNameList,
                             const wxString&   aLibraryPath,
                             const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
                             const wxString&           aLibraryPath,
                             const std::map<std::string, UTF8>*         aProperties = nullptr ) override;
 
    void CheckLibrary( const wxString& aLibraryPath,
                       const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
                            const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    bool SupportsSubLibraries() const override { return true; }
 
    void GetSubLibraryNames( std::vector<wxString>& aNames ) override;
 
    void GetAvailableSymbolFields( std::vector<wxString>& aNames ) override;
 
    void GetDefaultSymbolFields( std::vector<wxString>& aNames ) override;
 
    // Database libraries can never be written using the symbol editing API
    bool IsLibraryWritable( const wxString& aLibraryPath ) override { return false; }
 
    void SetLibraryManagerAdapter( SYMBOL_LIBRARY_ADAPTER* aAdapter ) override
    {
        m_adapter = aAdapter;
    }
 
    bool SupportsConfigurationDialog() const override { return true; }
 
    DIALOG_SHIM* CreateConfigurationDialog( wxWindow* aParent, const wxString& aLibraryPath ) override;
 
    DATABASE_LIB_SETTINGS* Settings() const { return m_settings.get(); }

    static wxString SymbolNameForRow( const DATABASE_LIB_TABLE& aTable, bool aGloballyUniqueKeys,
                                      const DATABASE_CONNECTION::ROW& aRow, std::string* aRawKey = nullptr );

    static std::unique_ptr<DATABASE_CONNECTION> CreateConnection( const DATABASE_LIB_SETTINGS& aSettings,
                                                                  bool aConnectNow = true,
                                                                  const wxString& aBaseDir = wxEmptyString );

    struct PREVIEW_ISSUE
    {
        enum class FIELD
        {
            KEY,          
            REPEATED_KEY, 
            SYMBOLS,      
            PIN_MAP       
        };
 
        FIELD    field;
        wxString message;
    };
 
    using PREVIEW_ISSUES = std::vector<PREVIEW_ISSUE>;

    static std::vector<std::unique_ptr<LIB_SYMBOL>>
    BuildPreviewSymbols( SYMBOL_LIBRARY_ADAPTER* aLibs, const DATABASE_LIB_TABLE& aTable, bool aGloballyUniqueKeys,
                         const std::vector<DATABASE_CONNECTION::ROW>& aRows, PREVIEW_ISSUES* aIssues );
 
private:
    typedef std::vector<std::pair<const DATABASE_LIB_TABLE*, std::vector<DATABASE_CONNECTION::ROW>>> TABLE_RESULT_LIST;
 
    void cacheLib();
 
    size_t computeSignature( const TABLE_RESULT_LIST& aTableResults ) const;
 
    bool  materializeCache( const TABLE_RESULT_LIST& aTableResults,
                            std::map<wxString, std::unique_ptr<LIB_SYMBOL>>& aSymbolCache,
                            std::map<wxString, std::pair<std::string, std::string>>& aSanitizedNameMap );
 
    void ensureSettings( const wxString& aSettingsPath );
 
    void ensureConnection();
 
    void connect();
 
    std::unique_ptr<LIB_SYMBOL> loadSymbolFromRow( const wxString& aSymbolName,
                                                   const DATABASE_LIB_TABLE& aTable,
                                                   const DATABASE_CONNECTION::ROW& aRow );
 
    static std::optional<bool> boolFromAny( const std::any& aVal );

    LIB_SYMBOL* resolveSourceSymbol( const LIB_ID& aId );

    void reportIssue( PREVIEW_ISSUE::FIELD aField, const wxString& aMessage, SEVERITY aSeverity ) const;

    bool m_previewMode = false;

    PREVIEW_ISSUES* m_previewIssues = nullptr;
 
    SYMBOL_LIBRARY_ADAPTER* m_adapter;
 
    std::unique_ptr<DATABASE_LIB_SETTINGS> m_settings;

    std::unique_ptr<DATABASE_CONNECTION> m_conn;
 
    std::set<wxString> m_customFields;
 
    std::set<wxString> m_defaultShownFields;
 
    std::map<wxString, std::unique_ptr<LIB_SYMBOL>> m_nameToSymbolcache;
    std::map<wxString, std::pair<std::string, std::string>> m_sanitizedNameMap;
 
    long long m_cacheTimestamp;

    std::atomic<bool> m_cachePopulated{ false };
 
    int m_modifyHash = 0;

    size_t m_cacheSignature;

    static thread_local std::unordered_set<wxString> s_inProgressLoads;

    bool m_inCacheLib = false;
 
    void startBackgroundRefresh();
    void stopBackgroundRefresh();
    void backgroundRefreshWorker();
 
    std::thread             m_refreshThread;
    std::atomic<bool>       m_refreshRunning{ false };
    std::condition_variable m_refreshCV;
    std::mutex              m_refreshMutex;
    std::shared_mutex       m_cacheMutex;
    std::mutex              m_symbolLoadMutex;
 
    wxString m_lastError;
};
 
#endif //SCH_IO_DATABASE_H_