402 lines
12 KiB
C++
402 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2017 KiCad Developers, see CHANGELOG.TXT for contributors.
|
|
* @author Kristoffer Ödmark
|
|
*
|
|
* 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, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include <wx/clipbrd.h>
|
|
|
|
#include <build_version.h>
|
|
#include <class_board.h>
|
|
#include <class_track.h>
|
|
#include <class_drawsegment.h>
|
|
#include <class_pcb_text.h>
|
|
#include <class_text_mod.h>
|
|
#include <common.h>
|
|
#include <netinfo.h>
|
|
#include <pcb_parser.h>
|
|
|
|
#include <kicad_plugin.h>
|
|
#include <kicad_clipboard.h>
|
|
|
|
CLIPBOARD_IO::CLIPBOARD_IO():
|
|
PCB_IO( CTL_STD_LAYER_NAMES ),
|
|
m_formatter(),
|
|
m_parser( new CLIPBOARD_PARSER() )
|
|
{
|
|
m_out = &m_formatter;
|
|
}
|
|
|
|
|
|
CLIPBOARD_IO::~CLIPBOARD_IO()
|
|
{
|
|
delete m_parser;
|
|
}
|
|
|
|
|
|
STRING_FORMATTER* CLIPBOARD_IO::GetFormatter()
|
|
{
|
|
return &m_formatter;
|
|
}
|
|
|
|
|
|
void CLIPBOARD_IO::SetBoard( BOARD* aBoard )
|
|
{
|
|
m_board = aBoard;
|
|
}
|
|
|
|
|
|
void CLIPBOARD_IO::SaveSelection( const PCBNEW_SELECTION& aSelected, bool isModEdit )
|
|
{
|
|
VECTOR2I refPoint( 0, 0 );
|
|
|
|
// dont even start if the selection is empty
|
|
if( aSelected.Empty() )
|
|
return;
|
|
|
|
if( aSelected.HasReferencePoint() )
|
|
refPoint = aSelected.GetReferencePoint();
|
|
|
|
// Prepare net mapping that assures that net codes saved in a file are consecutive integers
|
|
m_mapping->SetBoard( m_board );
|
|
|
|
if( aSelected.Size() == 1 && aSelected.Front()->Type() == PCB_MODULE_T )
|
|
{
|
|
// make the module safe to transfer to other pcbs
|
|
const MODULE* mod = static_cast<MODULE*>( aSelected.Front() );
|
|
// Do not modify existing board
|
|
MODULE newModule( *mod );
|
|
|
|
for( D_PAD* pad : newModule.Pads() )
|
|
pad->SetNetCode( 0 );
|
|
|
|
// locked means "locked in place"; copied items therefore can't be locked
|
|
newModule.SetLocked( false );
|
|
|
|
// locate the reference point at (0, 0) in the copied items
|
|
newModule.Move( wxPoint( -refPoint.x, -refPoint.y ) );
|
|
|
|
Format( static_cast<BOARD_ITEM*>( &newModule ) );
|
|
}
|
|
else if( isModEdit )
|
|
{
|
|
MODULE partialModule( m_board );
|
|
|
|
for( const EDA_ITEM* item : aSelected )
|
|
{
|
|
BOARD_ITEM* clone = static_cast<BOARD_ITEM*>( item->Clone() );
|
|
|
|
// Do not add reference/value - convert them to the common type
|
|
if( TEXTE_MODULE* text = dyn_cast<TEXTE_MODULE*>( clone ) )
|
|
text->SetType( TEXTE_MODULE::TEXT_is_DIVERS );
|
|
|
|
// If it is only a module, clear the nets from the pads
|
|
if( D_PAD* pad = dyn_cast<D_PAD*>( clone ) )
|
|
pad->SetNetCode( 0 );
|
|
|
|
// Add the pad to the new module before moving to ensure the local coords are correct
|
|
partialModule.Add( clone );
|
|
|
|
// locate the reference point at (0, 0) in the copied items
|
|
clone->Move( (wxPoint) -refPoint );
|
|
}
|
|
|
|
// Set the new relative internal local coordinates of copied items
|
|
MODULE* editedModule = m_board->Modules().front();
|
|
wxPoint moveVector = partialModule.GetPosition() + editedModule->GetPosition();
|
|
|
|
partialModule.MoveAnchorPosition( moveVector );
|
|
|
|
Format( &partialModule, 0 );
|
|
}
|
|
else
|
|
{
|
|
// we will fake being a .kicad_pcb to get the full parser kicking
|
|
// This means we also need layers and nets
|
|
LOCALE_IO io;
|
|
|
|
m_formatter.Print( 0, "(kicad_pcb (version %d) (host pcbnew %s)\n",
|
|
SEXPR_BOARD_FILE_VERSION,
|
|
m_formatter.Quotew( GetBuildVersion() ).c_str() );
|
|
|
|
m_formatter.Print( 0, "\n" );
|
|
|
|
formatBoardLayers( m_board );
|
|
formatNetInformation( m_board );
|
|
|
|
m_formatter.Print( 0, "\n" );
|
|
|
|
for( EDA_ITEM* i : aSelected )
|
|
{
|
|
BOARD_ITEM* item = static_cast<BOARD_ITEM*>( i );
|
|
BOARD_ITEM* copy = nullptr;
|
|
|
|
if( item->Type() == PCB_MODULE_EDGE_T )
|
|
{
|
|
// Convert to PCB_LINE_T
|
|
copy = (BOARD_ITEM*) reinterpret_cast<DRAWSEGMENT*>( item )->Clone();
|
|
copy->SetLayer( item->GetLayer() );
|
|
}
|
|
else if( item->Type() == PCB_MODULE_TEXT_T )
|
|
{
|
|
// Convert to PCB_TEXT_T
|
|
MODULE* mod = static_cast<MODULE*>( item->GetParent() );
|
|
TEXTE_MODULE* mod_text = static_cast<TEXTE_MODULE*>( item );
|
|
TEXTE_PCB* pcb_text = new TEXTE_PCB( m_board );
|
|
|
|
if( mod_text->GetText() == "${VALUE}" )
|
|
pcb_text->SetText( mod->GetValue() );
|
|
else if( mod_text->GetText() == "${REFERENCE}" )
|
|
pcb_text->SetText( mod->GetReference() );
|
|
else
|
|
pcb_text->CopyText( *mod_text );
|
|
|
|
pcb_text->SetEffects( *mod_text );
|
|
pcb_text->SetLayer( mod_text->GetLayer() );
|
|
copy = pcb_text;
|
|
}
|
|
else if( item->Type() == PCB_PAD_T )
|
|
{
|
|
// Create a parent to own the copied pad
|
|
MODULE* mod = new MODULE( m_board );
|
|
D_PAD* pad = (D_PAD*) item->Clone();
|
|
|
|
mod->SetPosition( pad->GetPosition() );
|
|
pad->SetPos0( wxPoint() );
|
|
mod->Add( pad );
|
|
copy = mod;
|
|
}
|
|
else if( item->Type() == PCB_MODULE_ZONE_AREA_T )
|
|
{
|
|
// Convert to PCB_ZONE_AREA_T
|
|
ZONE_CONTAINER* zone = new ZONE_CONTAINER( m_board );
|
|
zone->InitDataFromSrcInCopyCtor( *static_cast<ZONE_CONTAINER*>( item ) );
|
|
copy = zone;
|
|
}
|
|
else if( item->Type() == PCB_GROUP_T )
|
|
{
|
|
copy = static_cast<GROUP*>( item )->DeepClone();
|
|
}
|
|
else
|
|
{
|
|
copy = static_cast<BOARD_ITEM*>( item->Clone() );
|
|
}
|
|
|
|
auto prepItem = [&]( BOARD_ITEM* titem ) {
|
|
// locked means "locked in place"; copied items therefore can't be locked
|
|
if( MODULE* module = dyn_cast<MODULE*>( titem ) )
|
|
module->SetLocked( false );
|
|
else if( TRACK* track = dyn_cast<TRACK*>( titem ) )
|
|
track->SetLocked( false );
|
|
};
|
|
|
|
if( copy )
|
|
{
|
|
prepItem( copy );
|
|
|
|
// locate the reference point at (0, 0) in the copied items
|
|
copy->Move( (wxPoint) -refPoint );
|
|
|
|
Format( copy, 1 );
|
|
|
|
if( copy->Type() == PCB_GROUP_T )
|
|
{
|
|
static_cast<GROUP*>( copy )->RunOnDescendants( prepItem );
|
|
static_cast<GROUP*>( copy )->RunOnDescendants( [&]( BOARD_ITEM* titem ) {
|
|
Format( titem, 1 );
|
|
} );
|
|
}
|
|
|
|
delete copy;
|
|
}
|
|
}
|
|
m_formatter.Print( 0, "\n)" );
|
|
}
|
|
|
|
// These are placed at the end to minimize the open time of the clipboard
|
|
auto clipboard = wxTheClipboard;
|
|
wxClipboardLocker clipboardLock( clipboard );
|
|
|
|
if( !clipboardLock || !clipboard->IsOpened() )
|
|
return;
|
|
|
|
clipboard->SetData( new wxTextDataObject(
|
|
wxString( m_formatter.GetString().c_str(), wxConvUTF8 ) ) );
|
|
|
|
clipboard->Flush();
|
|
|
|
#ifndef __WXOSX__
|
|
// This section exists to return the clipboard data, ensuring it has fully
|
|
// been processed by the system clipboard. This appears to be needed for
|
|
// extremely large clipboard copies on asynchronous linux clipboard managers
|
|
// such as KDE's Klipper. However, a read back of the data on OSX before the
|
|
// clipboard is closed seems to cause an ASAN error (heap-buffer-overflow)
|
|
// since it uses the cached version of the clipboard data and not the system
|
|
// clipboard data.
|
|
{
|
|
wxTextDataObject data;
|
|
clipboard->GetData( data );
|
|
( void )data.GetText(); // Keep unused variable
|
|
}
|
|
#endif
|
|
}
|
|
|
|
|
|
BOARD_ITEM* CLIPBOARD_IO::Parse()
|
|
{
|
|
BOARD_ITEM* item;
|
|
wxString result;
|
|
|
|
auto clipboard = wxTheClipboard;
|
|
wxClipboardLocker clipboardLock( clipboard );
|
|
|
|
if( !clipboardLock )
|
|
return nullptr;
|
|
|
|
|
|
if( clipboard->IsSupported( wxDF_TEXT ) )
|
|
{
|
|
wxTextDataObject data;
|
|
clipboard->GetData( data );
|
|
result = data.GetText();
|
|
}
|
|
|
|
try
|
|
{
|
|
item = PCB_IO::Parse( result );
|
|
}
|
|
catch (...)
|
|
{
|
|
item = nullptr;
|
|
}
|
|
|
|
return item;
|
|
}
|
|
|
|
|
|
void CLIPBOARD_IO::Save( const wxString& aFileName, BOARD* aBoard,
|
|
const PROPERTIES* aProperties )
|
|
{
|
|
init( aProperties );
|
|
|
|
m_board = aBoard; // after init()
|
|
|
|
// Prepare net mapping that assures that net codes saved in a file are consecutive integers
|
|
m_mapping->SetBoard( aBoard );
|
|
|
|
STRING_FORMATTER formatter;
|
|
|
|
m_out = &formatter;
|
|
|
|
m_out->Print( 0, "(kicad_pcb (version %d) (host pcbnew %s)\n", SEXPR_BOARD_FILE_VERSION,
|
|
formatter.Quotew( GetBuildVersion() ).c_str() );
|
|
|
|
Format( aBoard, 1 );
|
|
|
|
m_out->Print( 0, ")\n" );
|
|
|
|
auto clipboard = wxTheClipboard;
|
|
wxClipboardLocker clipboardLock( clipboard );
|
|
|
|
if( !clipboardLock )
|
|
return;
|
|
|
|
clipboard->SetData( new wxTextDataObject(
|
|
wxString( m_formatter.GetString().c_str(), wxConvUTF8 ) ) );
|
|
clipboard->Flush();
|
|
|
|
// This section exists to return the clipboard data, ensuring it has fully
|
|
// been processed by the system clipboard. This appears to be needed for
|
|
// extremely large clipboard copies on asynchronous linux clipboard managers
|
|
// such as KDE's Klipper
|
|
{
|
|
wxTextDataObject data;
|
|
clipboard->GetData( data );
|
|
( void )data.GetText(); // Keep unused variable
|
|
}
|
|
}
|
|
|
|
|
|
BOARD* CLIPBOARD_IO::Load( const wxString& aFileName,
|
|
BOARD* aAppendToMe, const PROPERTIES* aProperties )
|
|
{
|
|
std::string result;
|
|
|
|
auto clipboard = wxTheClipboard;
|
|
wxClipboardLocker clipboardLock( clipboard );
|
|
|
|
if( !clipboardLock )
|
|
return nullptr;
|
|
|
|
if( clipboard->IsSupported( wxDF_TEXT ) )
|
|
{
|
|
wxTextDataObject data;
|
|
clipboard->GetData( data );
|
|
|
|
result = data.GetText().mb_str();
|
|
}
|
|
|
|
STRING_LINE_READER reader(result, wxT( "clipboard" ) );
|
|
|
|
init( aProperties );
|
|
|
|
m_parser->SetLineReader( &reader );
|
|
m_parser->SetBoard( aAppendToMe );
|
|
|
|
BOARD_ITEM* item;
|
|
BOARD* board;
|
|
|
|
try
|
|
{
|
|
item = m_parser->Parse();
|
|
}
|
|
catch( const FUTURE_FORMAT_ERROR& )
|
|
{
|
|
// Don't wrap a FUTURE_FORMAT_ERROR in another
|
|
throw;
|
|
}
|
|
catch( const PARSE_ERROR& parse_error )
|
|
{
|
|
if( m_parser->IsTooRecent() )
|
|
throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
|
|
else
|
|
throw;
|
|
}
|
|
|
|
if( item->Type() != PCB_T )
|
|
{
|
|
// The parser loaded something that was valid, but wasn't a board.
|
|
THROW_PARSE_ERROR( _( "Clipboard content is not KiCad compatible" ),
|
|
m_parser->CurSource(), m_parser->CurLine(),
|
|
m_parser->CurLineNumber(), m_parser->CurOffset() );
|
|
}
|
|
else
|
|
{
|
|
board = dynamic_cast<BOARD*>( item );
|
|
}
|
|
|
|
// Give the filename to the board if it's new
|
|
if( board && !aAppendToMe )
|
|
board->SetFileName( aFileName );
|
|
|
|
return board;
|
|
}
|