project_rescue.cpp File Reference

#include <sch_draw_panel.h>
#include <symbol_library.h>
#include <confirm.h>
#include <connection_graph.h>
#include <invoke_sch_dialog.h>
#include <kiway.h>
#include <symbol_viewer_frame.h>
#include <project_rescue.h>
#include <sch_symbol.h>
#include <sch_sheet.h>
#include <sch_edit_frame.h>
#include <schematic.h>
#include <symbol_lib_table.h>
#include <wildcards_and_files_ext.h>
#include <cctype>
#include <map>

Go to the source code of this file.

Typedefs
typedef std::pair< SCH_SYMBOL *, wxString >	SYMBOL_NAME_PAIR

Functions
static bool	sort_by_libid (const SCH_SYMBOL *ref, SCH_SYMBOL *cmp)
static void	getSymbols (SCHEMATIC *aSchematic, std::vector< SCH_SYMBOL * > &aSymbols)
	Fill a vector with all of the project's symbols, to ease iterating over them. More...
static LIB_SYMBOL *	findSymbol (const wxString &aName, SYMBOL_LIBS *aLibs, bool aCached)
	Search the libraries for the first symbol with a given name. More...
static wxFileName	GetRescueLibraryFileName (SCHEMATIC *aSchematic)

Typedef Documentation

SYMBOL_NAME_PAIR

typedef std::pair<SCH_SYMBOL*, wxString> SYMBOL_NAME_PAIR

Definition at line 44 of file project_rescue.cpp.

Function Documentation

findSymbol()

static LIB_SYMBOL* findSymbol ( const wxString &  aName, SYMBOL_LIBS *  aLibs, bool  aCached  )

static

Search the libraries for the first symbol with a given name.

Parameters

aName	- name to search for
aLibs	- the loaded SYMBOL_LIBS
aCached	- whether we are looking for the cached symbol

Definition at line 89 of file project_rescue.cpp.

{
    LIB_SYMBOL *symbol = nullptr;
    // wxString new_name = LIB_ID::FixIllegalChars( aName, false );

    for( SYMBOL_LIB& each_lib : *aLibs )
    {
        if( aCached && !each_lib.IsCache() )
            continue;

        if( !aCached && each_lib.IsCache() )
            continue;

        symbol = each_lib.FindSymbol( aName );

        if( symbol )
            break;
    }

    return symbol;
}

Referenced by RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

GetRescueLibraryFileName()

static wxFileName GetRescueLibraryFileName ( SCHEMATIC *  aSchematic )

static

Definition at line 112 of file project_rescue.cpp.

{
    wxFileName fn = aSchematic->GetFileName();
    fn.SetName( fn.GetName() + wxT( "-rescue" ) );
    fn.SetExt( LegacySymbolLibFileExtension );
    return fn;
}

References SCHEMATIC::GetFileName(), and LegacySymbolLibFileExtension.

Referenced by SYMBOL_LIB_TABLE_RESCUER::AddSymbol(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), LEGACY_RESCUER::OpenRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

getSymbols()

static void getSymbols ( SCHEMATIC *  aSchematic, std::vector< SCH_SYMBOL * > &  aSymbols  )

static

Fill a vector with all of the project's symbols, to ease iterating over them.

The list is sorted by LIB_ID, therefore symbols using the same library symbol are grouped, allowing later faster calculations (one library search by group of symbols)

Parameters

aSymbols

is a vector that will take the symbols.

Definition at line 63 of file project_rescue.cpp.

{
    SCH_SCREENS screens( aSchematic->Root() );

    // Get the full list
    for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
    {
        for( auto aItem : screen->Items().OfType( SCH_SYMBOL_T ) )
            aSymbols.push_back( static_cast<SCH_SYMBOL*>( aItem ) );
    }

    if( aSymbols.empty() )
        return;

    // sort aSymbols by lib symbol. symbols will be grouped by same lib symbol.
    std::sort( aSymbols.begin(), aSymbols.end(), sort_by_libid );
}

References SCHEMATIC::Root(), SCH_SYMBOL_T, and sort_by_libid().

Referenced by RESCUER::RESCUER().

sort_by_libid()

static bool sort_by_libid ( const SCH_SYMBOL *  ref, SCH_SYMBOL *  cmp  )

static

Definition at line 48 of file project_rescue.cpp.

{
    return ref->GetLibId() < cmp->GetLibId();
}

References SCH_SYMBOL::GetLibId().

Referenced by getSymbols().