pcb_control.cpp File Reference

#include <tools/edit_tool.h>
#include <tools/board_inspection_tool.h>
#include <router/router_tool.h>
#include <pgm_base.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_control.h>
#include <tools/pcb_picker_tool.h>
#include <tools/pcb_selection_tool.h>
#include <tools/board_reannotate_tool.h>
#include <3d_viewer/eda_3d_viewer_frame.h>
#include <board_commit.h>
#include <board.h>
#include <board_design_settings.h>
#include <board_item.h>
#include <dialogs/dialog_paste_special.h>
#include <pcb_dimension.h>
#include <footprint.h>
#include <pcb_group.h>
#include <pcb_textbox.h>
#include <pcb_track.h>
#include <wildcards_and_files_ext.h>
#include <zone.h>
#include <fp_shape.h>
#include <fp_textbox.h>
#include <confirm.h>
#include <connectivity/connectivity_data.h>
#include <core/kicad_algo.h>
#include <kicad_clipboard.h>
#include <origin_viewitem.h>
#include <pcb_edit_frame.h>
#include <pcb_painter.h>
#include <string_utf8_map.h>
#include <settings/color_settings.h>
#include <tool/tool_manager.h>
#include <footprint_edit_frame.h>
#include <widgets/wx_progress_reporters.h>
#include <widgets/wx_infobar.h>
#include <wx/hyperlink.h>

Go to the source code of this file.

Macros
#define	ALPHA_MIN   0.20
#define	ALPHA_MAX   1.00
#define	ALPHA_STEP   0.05
#define	HITTEST_THRESHOLD_PIXELS   5

Functions
bool	AskLoadBoardFileName (PCB_EDIT_FRAME *aParent, int *aCtl, wxString *aFileName, bool aKicadFilesOnly=false)
	Show a wxFileDialog asking for a BOARD filename to open. More...
IO_MGR::PCB_FILE_T	plugin_type (const wxString &aFileName, int aCtl)
template<class T >
void	Flip (T &aValue)
static void	pasteFootprintItemsToFootprintEditor (FOOTPRINT *aClipFootprint, BOARD *aBoard, std::vector< BOARD_ITEM * > &aPastedItems)
template<typename T >
static void	moveUnflaggedItems (std::deque< T > &aList, std::vector< BOARD_ITEM * > &aTarget, bool aIsNew)
static void	moveUnflaggedItems (ZONES &aList, std::vector< BOARD_ITEM * > &aTarget, bool aIsNew)

Macro Definition Documentation

ALPHA_MAX

#define ALPHA_MAX   1.00

Definition at line 444 of file pcb_control.cpp.

ALPHA_MIN

#define ALPHA_MIN   0.20

Definition at line 443 of file pcb_control.cpp.

ALPHA_STEP

#define ALPHA_STEP   0.05

Definition at line 445 of file pcb_control.cpp.

HITTEST_THRESHOLD_PIXELS

#define HITTEST_THRESHOLD_PIXELS   5

Definition at line 561 of file pcb_control.cpp.

Function Documentation

AskLoadBoardFileName()

bool AskLoadBoardFileName	(	PCB_EDIT_FRAME *	aParent,
		int *	aCtl,
		wxString *	aFileName,
		bool	aKicadFilesOnly
	)

Show a wxFileDialog asking for a BOARD filename to open.

Parameters

aParent	is a wxFrame passed to wxFileDialog.
aCtl	is where to put the OpenProjectFiles() control bits.
aFileName	on entry is a probable choice, on return is the chosen filename.
aKicadFilesOnly	true to list KiCad pcb files plugins only, false to list import plugins.

Returns

true if chosen, else false if user aborted.

Definition at line 90 of file pcbnew/files.cpp.

{
 // This is a subset of all PLUGINs which are trusted to be able to
 // load a BOARD. User may occasionally use the wrong plugin to load a
 // *.brd file (since both legacy and eagle use *.brd extension),
 // but eventually *.kicad_pcb will be more common than legacy *.brd files.
 
 // clang-format off
 static const struct
 {
 const wxString& filter;
 IO_MGR::PCB_FILE_T pluginType;
 } loaders[] =
 {
 // Current Kicad board files.
 { PcbFileWildcard(), IO_MGR::KICAD_SEXP },
 
 // Old Kicad board files.
 { LegacyPcbFileWildcard(), IO_MGR::LEGACY },
 
 // Import Altium Circuit Maker board files.
 { AltiumCircuitMakerPcbFileWildcard(), IO_MGR::ALTIUM_CIRCUIT_MAKER },
 
 // Import Altium Circuit Studio board files.
 { AltiumCircuitStudioPcbFileWildcard(), IO_MGR::ALTIUM_CIRCUIT_STUDIO },
 
 // Import Altium Designer board files.
 { AltiumDesignerPcbFileWildcard(), IO_MGR::ALTIUM_DESIGNER },
 
 // Import Cadstar PCB Archive board files.
 { CadstarPcbArchiveFileWildcard(), IO_MGR::CADSTAR_PCB_ARCHIVE },
 
 // Import Eagle board files.
 { EaglePcbFileWildcard(), IO_MGR::EAGLE },
 
 // Import PCAD board files.
 { PCadPcbFileWildcard(), IO_MGR::PCAD },
 
 // Import Fabmaster board files.
 { FabmasterPcbFileWildcard(), IO_MGR::FABMASTER },
 };
 // clang-format on
 
 wxFileName fileName( *aFileName );
 wxString fileFilters;
 
 if( aKicadFilesOnly )
 {
 std::vector<std::string> fileExtensions;
 
 for( unsigned ii = 0; ii < 2; ++ii )
 {
 if( !fileFilters.IsEmpty() )
 fileFilters += wxChar( '|' );
 
 fileFilters += wxGetTranslation( loaders[ii].filter );
 
 PLUGIN::RELEASER plugin( IO_MGR::PluginFind( loaders[ii].pluginType ) );
 wxCHECK( plugin, false );
 fileExtensions.push_back( plugin->GetFileExtension().ToStdString() );
 }
 
 fileFilters = _( "All KiCad Board Files" ) + AddFileExtListToFilter( fileExtensions )
 + wxT( "|" ) + fileFilters;
 }
 else
 {
 wxString allWildcards;
 
 for( unsigned ii = 2; ii < arrayDim( loaders ); ++ii )
 {
 if( !fileFilters.IsEmpty() )
 fileFilters += wxChar( '|' );
 
 fileFilters += wxGetTranslation( loaders[ii].filter );
 
 PLUGIN::RELEASER plugin( IO_MGR::PluginFind( loaders[ii].pluginType ) );
 wxCHECK( plugin, false );
 allWildcards += wxT( "*." ) + formatWildcardExt( plugin->GetFileExtension() ) +
 wxT( ";" );
 }
 
 fileFilters = _( "All supported formats" ) + wxT( "|" ) + allWildcards + wxT( "|" ) +
 fileFilters;
 }
 
 
 wxString path;
 wxString name;
 
 if( fileName.FileExists() )
 {
 path = fileName.GetPath();
 name = fileName.GetFullName();
 }
 else
 {
 path = aParent->GetMruPath();
 
 if( path.IsEmpty() )
 path = PATHS::GetDefaultUserProjectsPath();
 // leave name empty
 }
 
 wxFileDialog dlg( aParent,
 aKicadFilesOnly ? _( "Open Board File" ) : _( "Import Non KiCad Board File" ),
 path, name, fileFilters, wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 // For import option, if Eagle (*.brd files), tell OpenProjectFiles() to use Eagle plugin.
 // It's the only special case because of the duplicate use of the *.brd file extension.
 // Other cases are clear because of unique file extensions.
 *aCtl = aKicadFilesOnly ? 0 : KICTL_EAGLE_BRD;
 *aFileName = dlg.GetPath();
 aParent->SetMruPath( wxFileName( dlg.GetPath() ).GetPath() );
 return true;
 }
 else
 {
 return false;
 }
}

References _, AddFileExtListToFilter(), IO_MGR::ALTIUM_CIRCUIT_MAKER, IO_MGR::ALTIUM_CIRCUIT_STUDIO, IO_MGR::ALTIUM_DESIGNER, AltiumCircuitMakerPcbFileWildcard(), AltiumCircuitStudioPcbFileWildcard(), AltiumDesignerPcbFileWildcard(), arrayDim(), IO_MGR::CADSTAR_PCB_ARCHIVE, CadstarPcbArchiveFileWildcard(), IO_MGR::EAGLE, EaglePcbFileWildcard(), IO_MGR::FABMASTER, FabmasterPcbFileWildcard(), filter, formatWildcardExt(), PATHS::GetDefaultUserProjectsPath(), PLUGIN::GetFileExtension(), EDA_BASE_FRAME::GetMruPath(), IO_MGR::KICAD_SEXP, KICTL_EAGLE_BRD, IO_MGR::LEGACY, LegacyPcbFileWildcard(), name, path, IO_MGR::PCAD, PCadPcbFileWildcard(), PcbFileWildcard(), IO_MGR::PluginFind(), and EDA_BASE_FRAME::SetMruPath().

Referenced by PCB_CONTROL::AppendBoardFromFile(), PCB_EDIT_FRAME::Files_io_from_id(), and PCB_EDIT_FRAME::OnFileHistory().

Flip()

template<class T >

void Flip

(

T &

aValue

)

Definition at line 140 of file pcb_control.cpp.

{
 aValue = !aValue;
}

Referenced by PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

moveUnflaggedItems() [1/2]

template<typename T >

static void moveUnflaggedItems ( std::deque< T > &  aList, std::vector< BOARD_ITEM * > &  aTarget, bool  aIsNew  )

static

Definition at line 1024 of file pcb_control.cpp.

{
 std::copy_if( aList.begin(), aList.end(), std::back_inserter( aTarget ),
 [aIsNew]( T aItem )
 {
 bool doCopy = ( aItem->GetFlags() & SKIP_STRUCT ) == 0;
 
 aItem->ClearFlags( SKIP_STRUCT );
 aItem->SetFlags( aIsNew ? IS_NEW : 0 );
 
 return doCopy;
 } );
 
 if( aIsNew )
 aList.clear();
}

Referenced by PCB_CONTROL::placeBoardItems().

moveUnflaggedItems() [2/2]

static void moveUnflaggedItems ( ZONES &  aList, std::vector< BOARD_ITEM * > &  aTarget, bool  aIsNew  )

static

Definition at line 1043 of file pcb_control.cpp.

{
 if( aList.size() == 0 )
 return;
 
 auto obj = aList.front();
 int idx = 0;
 
 if( aIsNew )
 {
 obj = aList.back();
 aList.pop_back();
 }
 
 for( ; obj ; )
 {
 if( obj->HasFlag( SKIP_STRUCT ) )
 obj->ClearFlags( SKIP_STRUCT );
 else
 aTarget.push_back( obj );
 
 if( aIsNew )
 {
 if( aList.size() )
 {
 obj = aList.back();
 aList.pop_back();
 }
 else
 {
 obj = nullptr;
 }
 }
 else
 {
 obj = idx < int(aList.size()-1) ? aList[++idx] : nullptr;
 }
 }
}

References SKIP_STRUCT.

pasteFootprintItemsToFootprintEditor()

static void pasteFootprintItemsToFootprintEditor ( FOOTPRINT *  aClipFootprint, BOARD *  aBoard, std::vector< BOARD_ITEM * > &  aPastedItems  )

static

Definition at line 665 of file pcb_control.cpp.

{
 FOOTPRINT* editorFootprint = aBoard->GetFirstFootprint();
 
 aClipFootprint->SetParent( aBoard );
 
 for( PAD* pad : aClipFootprint->Pads() )
 {
 pad->SetParent( editorFootprint );
 aPastedItems.push_back( pad );
 }
 
 aClipFootprint->Pads().clear();
 
 // Not all graphic items can be added to the current footprint:
 // Reference and value are already existing in the current footprint, and
 // must be unique.
 // So they will be skipped
 for( BOARD_ITEM* item : aClipFootprint->GraphicalItems() )
 {
 if( item->Type() == PCB_FP_SHAPE_T || item->Type() == PCB_FP_TEXTBOX_T )
 {
 FP_SHAPE* shape = static_cast<FP_SHAPE*>( item );
 
 shape->SetParent( nullptr );
 shape->SetLocalCoord();
 }
 else if( item->Type() == PCB_FP_TEXT_T )
 {
 FP_TEXT* text = static_cast<FP_TEXT*>( item );
 
 if( text->GetType() != FP_TEXT::TEXT_is_DIVERS )
 continue;
 
 text->SetTextAngle( text->GetTextAngle() + aClipFootprint->GetOrientation() );
 
 text->SetParent( nullptr );
 text->SetLocalCoord();
 }
 
 item->SetParent( editorFootprint );
 aPastedItems.push_back( item );
 }
 
 aClipFootprint->GraphicalItems().clear();
 
 for( FP_ZONE* zone : aClipFootprint->Zones() )
 {
 zone->SetParent( editorFootprint );
 aPastedItems.push_back( zone );
 }
 
 aClipFootprint->Zones().clear();
 
 for( PCB_GROUP* group : aClipFootprint->Groups() )
 {
 group->SetParent( editorFootprint );
 aPastedItems.push_back( group );
 }
 
 aClipFootprint->Groups().clear();
}

References BOARD::GetFirstFootprint(), FOOTPRINT::GetOrientation(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), pad, FOOTPRINT::Pads(), PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, FP_SHAPE::SetLocalCoord(), EDA_ITEM::SetParent(), text, FP_TEXT::TEXT_is_DIVERS, and FOOTPRINT::Zones().

Referenced by PCB_CONTROL::Paste().

plugin_type()

IO_MGR::PCB_FILE_T plugin_type	(	const wxString &	aFileName,
		int	aCtl
	)

Definition at line 486 of file pcbnew/files.cpp.

{
 IO_MGR::PCB_FILE_T pluginType;
 
 wxFileName fn = aFileName;
 
 // Note: file extensions are expected to be in lower case.
 // This is not always true, especially when importing files, so the string
 // comparisons are case insensitive to try to find the suitable plugin.
 
 if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::LEGACY ) ) == 0 )
 {
 wxFileInputStream input( aFileName );
 bool is_legacy = true;
 
 if(input.IsOk() && !input.Eof() )
 {
 wxTextInputStream text( input );
 wxString line = text.ReadLine();
 
 if( !line.StartsWith( wxT( "PCBNEW" ) ) )
 is_legacy = false;
 }
 
 // both legacy and eagle share a common file extension.
 pluginType = ( aCtl & KICTL_EAGLE_BRD ) || !is_legacy ? IO_MGR::EAGLE : IO_MGR::LEGACY;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::PCAD ) ) == 0 )
 {
 pluginType = IO_MGR::PCAD;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::ALTIUM_DESIGNER ) ) == 0 )
 {
 pluginType = IO_MGR::ALTIUM_DESIGNER;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::ALTIUM_CIRCUIT_STUDIO ) ) == 0 )
 {
 pluginType = IO_MGR::ALTIUM_CIRCUIT_STUDIO;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::ALTIUM_CIRCUIT_MAKER ) ) == 0 )
 {
 pluginType = IO_MGR::ALTIUM_CIRCUIT_MAKER;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::CADSTAR_PCB_ARCHIVE ) ) == 0 )
 {
 pluginType = IO_MGR::CADSTAR_PCB_ARCHIVE;
 }
 else if( fn.GetExt().CmpNoCase( IO_MGR::GetFileExtension( IO_MGR::FABMASTER ) ) == 0 )
 {
 pluginType = IO_MGR::FABMASTER;
 }
 else
 {
 pluginType = IO_MGR::KICAD_SEXP;
 }
 
 return pluginType;
}

References IO_MGR::ALTIUM_CIRCUIT_MAKER, IO_MGR::ALTIUM_CIRCUIT_STUDIO, IO_MGR::ALTIUM_DESIGNER, IO_MGR::CADSTAR_PCB_ARCHIVE, IO_MGR::EAGLE, IO_MGR::FABMASTER, IO_MGR::GetFileExtension(), IO_MGR::KICAD_SEXP, KICTL_EAGLE_BRD, IO_MGR::LEGACY, IO_MGR::PCAD, and text.

Referenced by PCB_CONTROL::AppendBoardFromFile(), PCB_CONTROL::DdAppendBoard(), and PCB_EDIT_FRAME::OpenProjectFiles().