project_rescue.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Chris Pavlina <[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 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 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 _LIB_CACHE_RESCUE_H_
#define _LIB_CACHE_RESCUE_H_
 
/* This code handles the case where an old schematic was made before
 * various changes were made, either to KiCad or to the libraries, and
 * the project needs to be recovered. The function of note is a member
 * of SCH_EDIT_FRAME, defined thus:
 *
 * bool SCH_EDIT_FRAME::RescueProject( bool aSilentIfNone );
 *
 * When this is called, a list of problematic symbols is compiled. If
 * this list is empty, then the function displays a notification and returns
 * (if aSilentIfNone is true, the notification is silenced).
 */
 
#include <wx/string.h>
 
#include <lib_symbol.h>
#include <libraries/legacy_symbol_library.h>
#include <sch_io/kicad_legacy/sch_io_kicad_legacy.h>
#include <class_draw_panel_gal.h>
 
 
class LIB_SYMBOL;
class SCH_SYMBOL;
class RESCUER;
class SCH_EDIT_FRAME;
class SCH_IO_KICAD_LEGACY;
class SCH_SHEET_PATH;
class SCHEMATIC;
 
 
enum RESCUE_TYPE
{
    RESCUE_CONFLICT,
    RESCUE_CASE,
};
 
 
class RESCUE_CANDIDATE
{
public:
    RESCUE_CANDIDATE( const wxString& aRequestedName, const wxString& aNewName,
                      LIB_SYMBOL* aLibCandidate, int aUnit, int aBodyStyle ) :
            m_requested_name( aRequestedName ),
            m_new_name( aNewName ),
            m_lib_candidate( aLibCandidate ),
            m_unit( aUnit ),
            m_bodyStyle( aBodyStyle )
    {}
 
    virtual ~RESCUE_CANDIDATE() {}

    virtual wxString GetRequestedName() const { return m_requested_name; }

    virtual wxString GetNewName() const { return m_new_name; }

    virtual LIB_SYMBOL* GetCacheCandidate() const { return nullptr; }

    virtual LIB_SYMBOL* GetLibCandidate() const { return m_lib_candidate; }
 
    int GetUnit() const { return m_unit; }
    int GetBodyStyle() const { return m_bodyStyle; }

    virtual wxString GetActionDescription() const = 0;

    virtual bool PerformAction( RESCUER* aRescuer ) = 0;
 
protected:
    wxString    m_requested_name;
    wxString    m_new_name;
    LIB_SYMBOL* m_lib_candidate;
    int         m_unit;
    int         m_bodyStyle;
};
 
 
class RESCUE_CASE_CANDIDATE : public RESCUE_CANDIDATE
{
public:
    static void FindRescues( RESCUER& aRescuer, boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates );

    RESCUE_CASE_CANDIDATE( const wxString& aRequestedName, const wxString& aNewName,
                           LIB_SYMBOL* aLibCandidate, int aUnit = 0, int aBodyStyle = 0 );
 
    RESCUE_CASE_CANDIDATE()  :
            RESCUE_CANDIDATE( wxEmptyString, wxEmptyString, nullptr, 0, 0 )
    {}
 
    virtual wxString GetActionDescription() const override;
 
    virtual bool PerformAction( RESCUER* aRescuer ) override;
};
 
 
class RESCUE_CACHE_CANDIDATE: public RESCUE_CANDIDATE
{
    LIB_SYMBOL* m_cache_candidate;
 
public:
    static void FindRescues( RESCUER& aRescuer, boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates );

    RESCUE_CACHE_CANDIDATE( const wxString& aRequestedName, const wxString& aNewName,
                            LIB_SYMBOL* aCacheCandidate, LIB_SYMBOL* aLibCandidate,
                            int aUnit = 0, int aBodyStyle = 0 ) :
            RESCUE_CANDIDATE( aRequestedName, aNewName, aLibCandidate, aUnit, aBodyStyle ),
            m_cache_candidate( aCacheCandidate )
    {}
 
    RESCUE_CACHE_CANDIDATE() :
            RESCUE_CANDIDATE( wxEmptyString, wxEmptyString, nullptr, 0, 0 ),
            m_cache_candidate( nullptr )
    {}
 
    virtual LIB_SYMBOL* GetCacheCandidate() const override { return m_cache_candidate; }
 
    virtual wxString GetActionDescription() const override;
 
    virtual bool PerformAction( RESCUER* aRescuer ) override;
};
 
 
class RESCUE_SYMBOL_LIB_TABLE_CANDIDATE : public RESCUE_CANDIDATE
{
public:
    static void FindRescues( RESCUER& aRescuer, boost::ptr_vector<RESCUE_CANDIDATE>& aCandidates );

    RESCUE_SYMBOL_LIB_TABLE_CANDIDATE( const LIB_ID& aRequestedId, const LIB_ID& aNewId,
                                       LIB_SYMBOL* aCacheCandidate, LIB_SYMBOL* aLibCandidate,
                                       int aUnit = 0, int aBodyStyle = 0 );
 
    RESCUE_SYMBOL_LIB_TABLE_CANDIDATE();
 
    virtual LIB_SYMBOL* GetCacheCandidate() const override { return m_cache_candidate; }
 
    virtual wxString GetActionDescription() const override;
 
    virtual bool PerformAction( RESCUER* aRescuer ) override;
 
private:
    LIB_ID m_requested_id;
    LIB_ID m_new_id;
    LIB_SYMBOL* m_cache_candidate;
};
 
 
class RESCUE_LOG
{
public:
    SCH_SYMBOL*  symbol;
    wxString     old_name;
    wxString     new_name;
};
 
 
class RESCUER
{
public:
    RESCUER( PROJECT& aProject, SCHEMATIC* aSchematic, SCH_SHEET_PATH* aCurrentSheet,
             EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType );
 
    virtual ~RESCUER() = default;

    virtual bool WriteRescueLibrary( wxWindow *aParent ) = 0;
 
    virtual void OpenRescueLibrary() = 0;

    virtual void FindCandidates() = 0;
 
    virtual void AddSymbol( LIB_SYMBOL* aNewSymbol ) = 0;

    virtual void InvokeDialog( wxWindow* aParent, bool aAskShowAgain ) = 0;

    void RemoveDuplicates();

    size_t GetCandidateCount() { return m_all_candidates.size(); }

    size_t GetChosenCandidateCount() { return m_chosen_candidates.size(); }

    std::vector<SCH_SYMBOL*>* GetSymbols() { return &m_symbols; }

    PROJECT* GetPrj() { return m_prj; }
 
    SCHEMATIC* Schematic() { return m_schematic; }

    void LogRescue( SCH_SYMBOL *aSymbol, const wxString& aOldName, const wxString& aNewName );

    bool DoRescues();

    void UndoRescues();
 
    static bool RescueProject( wxWindow* aParent, RESCUER& aRescuer, bool aRunningOnDemand );
 
protected:
    friend class DIALOG_RESCUE_EACH;
 
    std::vector<SCH_SYMBOL*>     m_symbols;
    PROJECT*                     m_prj;
    SCHEMATIC*                   m_schematic;
    EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType;
    SCH_SHEET_PATH*              m_currentSheet;
 
    boost::ptr_vector<RESCUE_CANDIDATE> m_all_candidates;
    std::vector<RESCUE_CANDIDATE*>      m_chosen_candidates;
 
    std::vector<RESCUE_LOG>             m_rescue_log;
};
 
 
class LEGACY_RESCUER : public RESCUER
{
public:
    LEGACY_RESCUER( PROJECT& aProject, SCHEMATIC* aSchematic, SCH_SHEET_PATH* aCurrentSheet,
                    EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType ) :
        RESCUER( aProject, aSchematic, aCurrentSheet, aGalBackEndType )
    {
    }
 
    virtual ~LEGACY_RESCUER() = default;
 
    virtual void FindCandidates() override;
 
    virtual void InvokeDialog( wxWindow* aParent, bool aAskShowAgain ) override;
 
    virtual void OpenRescueLibrary() override;
 
    virtual bool WriteRescueLibrary( wxWindow *aParent ) override;
 
    virtual void AddSymbol( LIB_SYMBOL* aNewSymbol ) override;
 
private:
    std::unique_ptr<LEGACY_SYMBOL_LIB> m_rescue_lib;
};
 
 
class SYMBOL_LIB_TABLE_RESCUER : public RESCUER
{
public:
    SYMBOL_LIB_TABLE_RESCUER( PROJECT& aProject, SCHEMATIC* aSchematic,
                              SCH_SHEET_PATH* aCurrentSheet,
                              EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType );
 
    virtual ~SYMBOL_LIB_TABLE_RESCUER() = default;
 
    virtual void FindCandidates() override;
 
    virtual void InvokeDialog( wxWindow* aParent, bool aAskShowAgain ) override;
 
    virtual void OpenRescueLibrary() override;
 
    virtual bool WriteRescueLibrary( wxWindow* aParent ) override;
 
    virtual void AddSymbol( LIB_SYMBOL* aNewSymbol ) override;
 
private:
    std::vector<std::unique_ptr<LIB_SYMBOL>>     m_rescueLibSymbols;
    std::unique_ptr<std::map<std::string, UTF8>> m_properties;   
};
 
#endif // _LIB_CACHE_RESCUE_H_