dialog_database_lib_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 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 KICAD_DIALOG_DATABASE_LIB_SETTINGS_H
#define KICAD_DIALOG_DATABASE_LIB_SETTINGS_H
 
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
#include <database/database_connection.h>
#include <database/database_lib_settings.h>
#include <sch_io/database/sch_io_database.h>
#include <widgets/field_warning_icon.h>
#include <widgets/wx_debounced_action.h>
#include "dialog_database_lib_settings_base.h"
 
class DB_LIB_PREVIEW_PANEL;
class SYMBOL_LIBRARY_ADAPTER;
 

class DIALOG_DATABASE_LIB_SETTINGS : public DIALOG_DATABASE_LIB_SETTINGS_BASE
{
public:
    DIALOG_DATABASE_LIB_SETTINGS( wxWindow* aParent, const wxString& aDblPath, SYMBOL_LIBRARY_ADAPTER* aLibs,
                                  const wxString& aDefaultDir = wxEmptyString );
 
    ~DIALOG_DATABASE_LIB_SETTINGS() override;
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;

    const wxString& GetSettingsPath() const { return m_path; }
 
protected:
    void OnSettingChanged( wxCommandEvent& aEvent ) override;
    void OnSettingSpinChanged( wxSpinEvent& aEvent ) override;
    void OnSourceTypeChanged( wxCommandEvent& aEvent ) override;
    void OnSourceChanged( wxCommandEvent& aEvent ) override;
    void OnSourceSpinChanged( wxSpinEvent& aEvent ) override;
    void OnInsertDriver( wxCommandEvent& aEvent ) override;
    void OnTestConnection( wxCommandEvent& aEvent ) override;
    void OnManageDataSources( wxCommandEvent& aEvent ) override;
 
    void OnLibrarySelected( wxCommandEvent& aEvent ) override;
    void OnAddLibrary( wxCommandEvent& aEvent ) override;
    void OnDuplicateLibrary( wxCommandEvent& aEvent ) override;
    void OnMoveLibraryUp( wxCommandEvent& aEvent ) override;
    void OnMoveLibraryDown( wxCommandEvent& aEvent ) override;
    void OnRemoveLibrary( wxCommandEvent& aEvent ) override;
    void OnLibraryChanged( wxCommandEvent& aEvent ) override;
    void OnTableChanged( wxCommandEvent& aEvent ) override;
 
    void OnFieldCellChanged( wxGridEvent& aEvent ) override;
    void OnAddField( wxCommandEvent& aEvent ) override;
    void OnMoveFieldUp( wxCommandEvent& aEvent ) override;
    void OnMoveFieldDown( wxCommandEvent& aEvent ) override;
    void OnRemoveField( wxCommandEvent& aEvent ) override;
    void OnAddUnmappedColumns( wxCommandEvent& aEvent ) override;
 
    void OnDataLabelRightClick( wxGridEvent& aEvent ) override;
    void OnDataCellSelected( wxGridEvent& aEvent ) override;
 
    void onSplitterIdle( wxIdleEvent& aEvent );
 
private:
    struct COLUMN_ROLE
    {
        wxComboBox*           combo;
        std::string&          ( *value )( DATABASE_LIB_TABLE& );
        bool                  optional;
        wxString              label;
        const char*           autofillId; 
        std::vector<wxString> terms;      
    };
 
    void storeSource();

    void loadDataSources();

    void updateDsnDriver();
 
    void updateSourceControls();

    struct CONNECT_JOB
    {
        DIALOG_DATABASE_LIB_SETTINGS*        owner = nullptr;
        std::unique_ptr<DATABASE_CONNECTION> conn;
        std::vector<std::string>             tables;
        bool                                 connected = false;
    };

    void connect();

    void cancelConnect();
 
    void onConnectFinished( const std::shared_ptr<CONNECT_JOB>& aJob );

    void refreshTables();
 
    void loadLibraryList();
    void loadLibrary();
    void storeLibrary();
    void moveLibrary( int aDelta );
    void loadFields();
    void swapFields( DATABASE_LIB_TABLE& aLib, int aRow, int aOther );
    void loadDataGrid();

    void updateSymbolExample();

    void updateDataLabels();
 
    void loadColumnChoices();

    void markUserRole( const COLUMN_ROLE& aRole, const std::string& aValue );

    bool ensureSample( const std::string& aTable );

    void updateTableWarning();

    void updateColumnWarnings();

    wxArrayString previewIssues( SCH_IO_DATABASE::PREVIEW_ISSUE::FIELD aField ) const;

    bool validateLibraries();

    wxString cwdDir() const;

    bool chooseSavePath();

    void updateAutofillStyle();

    void updateLibraryListHints();

    std::string settingsSnapshot();
 
    enum class CLOSE_ACTION
    {
        DISCARD, 
        STAY,    
        SAVED    
    };

    CLOSE_ACTION confirmClose();
 
    void onCancel( wxCommandEvent& aEvent );
    void onCloseWindow( wxCloseEvent& aEvent );

    void autofillTable();

    void autofillColumns();
 
    const std::vector<std::string>& columnsFor( const std::string& aTable );
 
    DATABASE_LIB_TABLE* currentLibrary();

    const DATABASE_FIELD_MAPPING* fieldForColumn( const std::string& aColumn );

    void markDirty();

    void showInfo( const wxString& aMessage, int aIcon );
    void updatePreview();

    void setConnectionStatus( const wxString& aText, bool aError, const wxString& aDetails = wxEmptyString );
 
    wxString                               m_path;
    wxString                               m_defaultDir;
    SYMBOL_LIBRARY_ADAPTER*                m_libs;
    std::unique_ptr<DATABASE_LIB_SETTINGS> m_settings;
    std::unique_ptr<DATABASE_CONNECTION>   m_conn;
    std::shared_ptr<CONNECT_JOB>           m_connectJob;
    DB_LIB_PREVIEW_PANEL*                  m_preview;
    std::vector<COLUMN_ROLE>               m_roles;

    int  m_currentLibrary;

    bool m_loading;

    bool m_unnamed;

    bool m_flagMissing;

    bool m_canSave;

    WX_DEBOUNCED_ACTION m_previewDebounce;

    wxString m_tableError;

    SCH_IO_DATABASE::PREVIEW_ISSUES m_previewIssues;
 
    FIELD_WARNING_ICON*              m_tableIcon;
    std::vector<FIELD_WARNING_ICON*> m_roleIcons; 

    DATABASE_SOURCE m_keyringLogin;

    std::string                        m_autoTable;
    std::map<wxComboBox*, std::string> m_autoRoles;
    std::map<std::string, std::string> m_autoFields;

    std::set<wxComboBox*> m_userRoles;

    std::map<std::string, std::string> m_newChoices;
 
    std::vector<DATABASE_CONNECTION::DATA_SOURCE>   m_dataSources;
    std::vector<std::string>                        m_tables;
    std::map<std::string, std::vector<std::string>> m_columns;

    std::string                           m_sampleTable;
    std::vector<std::string>              m_sampleColumns;
    std::vector<DATABASE_CONNECTION::ROW> m_sampleRows;
    std::map<std::string, size_t>         m_sampleRepeats;

    std::string m_cleanSnapshot;
};
 
#endif //KICAD_DIALOG_DATABASE_LIB_SETTINGS_H