607 lines
18 KiB
C++
607 lines
18 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 1992-2012 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, 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 <fctsys.h>
|
|
#include <class_drawpanel.h>
|
|
#include <macros.h>
|
|
|
|
#include <pcbnew.h>
|
|
#include <wxPcbStruct.h>
|
|
|
|
#include <class_board.h>
|
|
#include <class_track.h>
|
|
#include <class_drawsegment.h>
|
|
#include <class_pcb_text.h>
|
|
#include <class_mire.h>
|
|
#include <class_module.h>
|
|
#include <class_dimension.h>
|
|
#include <class_zone.h>
|
|
|
|
|
|
/* Functions to undo and redo edit commands.
|
|
* commands to undo are stored in CurrentScreen->m_UndoList
|
|
* commands to redo are stored in CurrentScreen->m_RedoList
|
|
*
|
|
* m_UndoList and m_RedoList handle a std::vector of PICKED_ITEMS_LIST
|
|
* Each PICKED_ITEMS_LIST handle a std::vector of pickers (class ITEM_PICKER),
|
|
* that store the list of schematic items that are concerned by the command to undo or redo
|
|
* and is created for each command to undo (handle also a command to redo).
|
|
* each picker has a pointer pointing to an item to undo or redo (in fact: deleted, added or
|
|
* modified),
|
|
* and has a pointer to a copy of this item, when this item has been modified
|
|
* (the old values of parameters are therefore saved)
|
|
*
|
|
* there are 3 cases:
|
|
* - delete item(s) command
|
|
* - change item(s) command
|
|
* - add item(s) command
|
|
* and 3 cases for block:
|
|
* - move list of items
|
|
* - mirror (Y) list of items
|
|
* - Flip list of items
|
|
*
|
|
* Undo command
|
|
* - delete item(s) command:
|
|
* => deleted items are moved in undo list
|
|
*
|
|
* - change item(s) command
|
|
* => A copy of item(s) is made (a DrawPickedStruct list of wrappers)
|
|
* the .m_Link member of each wrapper points the modified item.
|
|
* the .m_Item member of each wrapper points the old copy of this item.
|
|
*
|
|
* - add item(s) command
|
|
* =>A list of item(s) is made. The .m_Item member of each wrapper points the new item.
|
|
*
|
|
* Redo command
|
|
* - delete item(s) old command:
|
|
* => deleted items are moved in EEDrawList list, and in
|
|
*
|
|
* - change item(s) command
|
|
* => the copy of item(s) is moved in Undo list
|
|
*
|
|
* - add item(s) command
|
|
* => The list of item(s) is used to create a deleted list in undo list(same as a delete
|
|
* command)
|
|
*
|
|
* Some block operations that change items can be undone without memorize items, just the
|
|
* coordinates of the transform:
|
|
* move list of items (undo/redo is made by moving with the opposite move vector)
|
|
* mirror (Y) and flip list of items (undo/redo is made by mirror or flip items)
|
|
* so they are handled specifically.
|
|
*
|
|
*/
|
|
|
|
|
|
/**
|
|
* Function TestForExistingItem
|
|
* test if aItem exists somewhere in lists of items
|
|
* This is a function used by PutDataInPreviousState to be sure an item was not deleted
|
|
* since an undo or redo.
|
|
* This could be possible:
|
|
* - if a call to SaveCopyInUndoList was forgotten in Pcbnew
|
|
* - in zones outlines, when a change in one zone merges this zone with an other
|
|
* This function avoids a Pcbnew crash
|
|
* Before using this function to test existence of items,
|
|
* it must be called with aItem = NULL to prepare the list
|
|
* @param aPcb = board to test
|
|
* @param aItem = item to find
|
|
* = NULL to build the list of existing items
|
|
*/
|
|
static bool TestForExistingItem( BOARD* aPcb, BOARD_ITEM* aItem )
|
|
{
|
|
static std::vector<BOARD_ITEM*> itemsList;
|
|
|
|
if( aItem == NULL ) // Build list
|
|
{
|
|
// Count items to store in itemsList:
|
|
int icnt = 0;
|
|
BOARD_ITEM* item;
|
|
|
|
// Count tracks:
|
|
for( item = aPcb->m_Track; item != NULL; item = item->Next() )
|
|
icnt++;
|
|
|
|
// Count modules:
|
|
for( item = aPcb->m_Modules; item != NULL; item = item->Next() )
|
|
icnt++;
|
|
|
|
// Count drawings
|
|
for( item = aPcb->m_Drawings; item != NULL; item = item->Next() )
|
|
icnt++;
|
|
|
|
// Count zones outlines
|
|
icnt += aPcb->GetAreaCount();
|
|
|
|
// Count zones segm (now obsolete):
|
|
for( item = aPcb->m_Zone; item != NULL; item = item->Next() )
|
|
icnt++;
|
|
|
|
// Build candidate list:
|
|
itemsList.clear();
|
|
itemsList.reserve(icnt);
|
|
|
|
// Store items in list:
|
|
// Append tracks:
|
|
for( item = aPcb->m_Track; item != NULL; item = item->Next() )
|
|
itemsList.push_back( item );
|
|
|
|
// Append modules:
|
|
for( item = aPcb->m_Modules; item != NULL; item = item->Next() )
|
|
itemsList.push_back( item );
|
|
|
|
// Append drawings
|
|
for( item = aPcb->m_Drawings; item != NULL; item = item->Next() )
|
|
itemsList.push_back( item );
|
|
|
|
// Append zones outlines
|
|
for( int ii = 0; ii < aPcb->GetAreaCount(); ii++ )
|
|
itemsList.push_back( aPcb->GetArea( ii ) );
|
|
|
|
// Append zones segm:
|
|
for( item = aPcb->m_Zone; item != NULL; item = item->Next() )
|
|
itemsList.push_back( item );
|
|
|
|
// Sort list
|
|
std::sort( itemsList.begin(), itemsList.end() );
|
|
return false;
|
|
}
|
|
|
|
// search in list:
|
|
return std::binary_search( itemsList.begin(), itemsList.end(), aItem );
|
|
}
|
|
|
|
|
|
void SwapData( BOARD_ITEM* aItem, BOARD_ITEM* aImage )
|
|
{
|
|
if( aItem == NULL || aImage == NULL )
|
|
{
|
|
wxMessageBox( wxT( "SwapData error: NULL pointer" ) );
|
|
return;
|
|
}
|
|
|
|
// Swap layers:
|
|
if( aItem->Type() != PCB_MODULE_T && aItem->Type() != PCB_ZONE_AREA_T )
|
|
{
|
|
// These items have a global swap function.
|
|
LAYER_NUM layer, layerimg;
|
|
layer = aItem->GetLayer();
|
|
layerimg = aImage->GetLayer();
|
|
aItem->SetLayer( layerimg );
|
|
aImage->SetLayer( layer );
|
|
}
|
|
|
|
switch( aItem->Type() )
|
|
{
|
|
case PCB_MODULE_T:
|
|
{
|
|
MODULE* tmp = (MODULE*) aImage->Clone();
|
|
( (MODULE*) aImage )->Copy( (MODULE*) aItem );
|
|
( (MODULE*) aItem )->Copy( tmp );
|
|
delete tmp;
|
|
}
|
|
break;
|
|
|
|
case PCB_ZONE_AREA_T:
|
|
{
|
|
ZONE_CONTAINER* tmp = (ZONE_CONTAINER*) aImage->Clone();
|
|
( (ZONE_CONTAINER*) aImage )->Copy( (ZONE_CONTAINER*) aItem );
|
|
( (ZONE_CONTAINER*) aItem )->Copy( tmp );
|
|
delete tmp;
|
|
}
|
|
break;
|
|
|
|
case PCB_LINE_T:
|
|
#if 0
|
|
EXCHG( ( (DRAWSEGMENT*) aItem )->m_Start, ( (DRAWSEGMENT*) aImage )->m_Start );
|
|
EXCHG( ( (DRAWSEGMENT*) aItem )->m_End, ( (DRAWSEGMENT*) aImage )->m_End );
|
|
EXCHG( ( (DRAWSEGMENT*) aItem )->m_Width, ( (DRAWSEGMENT*) aImage )->m_Width );
|
|
EXCHG( ( (DRAWSEGMENT*) aItem )->m_Shape, ( (DRAWSEGMENT*) aImage )->m_Shape );
|
|
#else
|
|
{
|
|
DRAWSEGMENT tmp = *(DRAWSEGMENT*) aImage;
|
|
*aImage = *aItem;
|
|
*aItem = tmp;
|
|
}
|
|
#endif
|
|
break;
|
|
|
|
case PCB_TRACE_T:
|
|
case PCB_VIA_T:
|
|
{
|
|
TRACK* track = (TRACK*) aItem;
|
|
TRACK* image = (TRACK*) aImage;
|
|
|
|
// swap start, end, width and shape for track and image.
|
|
wxPoint exchp = track->GetStart();
|
|
track->SetStart( image->GetStart() );
|
|
image->SetStart( exchp );
|
|
exchp = track->GetEnd();
|
|
track->SetEnd( image->GetEnd() );
|
|
image->SetEnd( exchp );
|
|
|
|
int atmp = track->GetWidth();
|
|
track->SetWidth( image->GetWidth() );
|
|
image->SetWidth( atmp );
|
|
atmp = track->GetShape();
|
|
track->SetShape( image->GetShape() );
|
|
image->SetShape( atmp );
|
|
|
|
atmp = track->GetDrillValue();
|
|
|
|
if( track->IsDrillDefault() )
|
|
atmp = -1;
|
|
|
|
int itmp = image->GetDrillValue();
|
|
|
|
if( image->IsDrillDefault() )
|
|
itmp = -1;
|
|
|
|
EXCHG(itmp, atmp );
|
|
|
|
if( atmp > 0 )
|
|
track->SetDrill( atmp );
|
|
else
|
|
track->SetDrillDefault();
|
|
|
|
if( itmp > 0 )
|
|
image->SetDrill( itmp );
|
|
else
|
|
image->SetDrillDefault();
|
|
}
|
|
break;
|
|
|
|
case PCB_TEXT_T:
|
|
std::swap( *((TEXTE_PCB*)aItem), *((TEXTE_PCB*)aImage) );
|
|
break;
|
|
|
|
case PCB_TARGET_T:
|
|
( (PCB_TARGET*) aItem )->Exchg( (PCB_TARGET*) aImage );
|
|
break;
|
|
|
|
case PCB_DIMENSION_T:
|
|
std::swap( *((DIMENSION*)aItem), *((DIMENSION*)aImage) );
|
|
break;
|
|
|
|
case PCB_ZONE_T:
|
|
default:
|
|
wxMessageBox( wxT( "SwapData() error: unexpected type" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::SaveCopyInUndoList( BOARD_ITEM* aItem,
|
|
UNDO_REDO_T aCommandType,
|
|
const wxPoint& aTransformPoint )
|
|
{
|
|
if( aItem == NULL ) // Nothing to save
|
|
return;
|
|
|
|
PICKED_ITEMS_LIST* commandToUndo = new PICKED_ITEMS_LIST();
|
|
|
|
commandToUndo->m_TransformPoint = aTransformPoint;
|
|
|
|
ITEM_PICKER itemWrapper( aItem, aCommandType );
|
|
|
|
switch( aCommandType )
|
|
{
|
|
case UR_CHANGED: // Create a copy of item
|
|
if( itemWrapper.GetLink() == NULL ) // When not null, the copy is already done
|
|
itemWrapper.SetLink( aItem->Clone() );
|
|
commandToUndo->PushItem( itemWrapper );
|
|
break;
|
|
|
|
case UR_NEW:
|
|
case UR_DELETED:
|
|
#ifdef USE_WX_OVERLAY
|
|
// Avoid to redraw when autoplacing
|
|
if( aItem->Type() == PCB_MODULE_T )
|
|
if( ((MODULE*)aItem)->GetFlags() & MODULE_to_PLACE )
|
|
break;
|
|
m_canvas->Refresh();
|
|
#endif
|
|
case UR_MOVED:
|
|
case UR_FLIPPED:
|
|
case UR_ROTATED:
|
|
case UR_ROTATED_CLOCKWISE:
|
|
commandToUndo->PushItem( itemWrapper );
|
|
break;
|
|
|
|
default:
|
|
{
|
|
wxString msg;
|
|
msg.Printf( wxT( "SaveCopyInUndoList() error (unknown code %X)" ), aCommandType );
|
|
wxMessageBox( msg );
|
|
}
|
|
break;
|
|
}
|
|
|
|
if( commandToUndo->GetCount() )
|
|
{
|
|
/* Save the copy in undo list */
|
|
GetScreen()->PushCommandToUndoList( commandToUndo );
|
|
|
|
/* Clear redo list, because after new save there is no redo to do */
|
|
GetScreen()->ClearUndoORRedoList( GetScreen()->m_RedoList );
|
|
}
|
|
else
|
|
{
|
|
delete commandToUndo;
|
|
}
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList,
|
|
UNDO_REDO_T aTypeCommand,
|
|
const wxPoint& aTransformPoint )
|
|
{
|
|
PICKED_ITEMS_LIST* commandToUndo = new PICKED_ITEMS_LIST();
|
|
|
|
commandToUndo->m_TransformPoint = aTransformPoint;
|
|
|
|
// Copy picker list:
|
|
commandToUndo->CopyList( aItemsList );
|
|
|
|
// Verify list, and creates data if needed
|
|
for( unsigned ii = 0; ii < commandToUndo->GetCount(); ii++ )
|
|
{
|
|
BOARD_ITEM* item = (BOARD_ITEM*) commandToUndo->GetPickedItem( ii );
|
|
UNDO_REDO_T command = commandToUndo->GetPickedItemStatus( ii );
|
|
|
|
if( command == UR_UNSPECIFIED )
|
|
{
|
|
command = aTypeCommand;
|
|
commandToUndo->SetPickedItemStatus( command, ii );
|
|
}
|
|
|
|
wxASSERT( item );
|
|
|
|
switch( command )
|
|
{
|
|
case UR_CHANGED:
|
|
|
|
/* If needed, create a copy of item, and put in undo list
|
|
* in the picker, as link
|
|
* If this link is not null, the copy is already done
|
|
*/
|
|
if( commandToUndo->GetPickedItemLink( ii ) == NULL )
|
|
commandToUndo->SetPickedItemLink( item->Clone(), ii );
|
|
break;
|
|
|
|
case UR_MOVED:
|
|
case UR_ROTATED:
|
|
case UR_ROTATED_CLOCKWISE:
|
|
case UR_FLIPPED:
|
|
case UR_NEW:
|
|
case UR_DELETED:
|
|
break;
|
|
|
|
default:
|
|
{
|
|
wxString msg;
|
|
msg.Printf( wxT( "SaveCopyInUndoList() error (unknown code %X)" ), command );
|
|
wxMessageBox( msg );
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
}
|
|
|
|
if( commandToUndo->GetCount() )
|
|
{
|
|
/* Save the copy in undo list */
|
|
GetScreen()->PushCommandToUndoList( commandToUndo );
|
|
|
|
/* Clear redo list, because after a new command one cannot redo a command */
|
|
GetScreen()->ClearUndoORRedoList( GetScreen()->m_RedoList );
|
|
}
|
|
else // Should not occur
|
|
{
|
|
delete commandToUndo;
|
|
}
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::PutDataInPreviousState( PICKED_ITEMS_LIST* aList, bool aRedoCommand,
|
|
bool aRebuildRatsnet )
|
|
{
|
|
BOARD_ITEM* item;
|
|
bool not_found = false;
|
|
bool reBuild_ratsnest = false;
|
|
|
|
// Undo in the reverse order of list creation: (this can allow stacked changes
|
|
// like the same item can be changes and deleted in the same complex command
|
|
|
|
bool build_item_list = true; // if true the list of existing items must be rebuilt
|
|
|
|
for( int ii = aList->GetCount()-1; ii >= 0 ; ii-- )
|
|
{
|
|
item = (BOARD_ITEM*) aList->GetPickedItem( ii );
|
|
wxASSERT( item );
|
|
|
|
/* Test for existence of item on board.
|
|
* It could be deleted, and no more on board:
|
|
* - if a call to SaveCopyInUndoList was forgotten in Pcbnew
|
|
* - in zones outlines, when a change in one zone merges this zone with an other
|
|
* This test avoids a Pcbnew crash
|
|
* Obviously, this test is not made for deleted items
|
|
*/
|
|
UNDO_REDO_T status = aList->GetPickedItemStatus( ii );
|
|
|
|
if( status != UR_DELETED )
|
|
{
|
|
if( build_item_list )
|
|
// Build list of existing items, for integrity test
|
|
TestForExistingItem( GetBoard(), NULL );
|
|
|
|
build_item_list = false;
|
|
|
|
if( !TestForExistingItem( GetBoard(), item ) )
|
|
{
|
|
// Remove this non existent item
|
|
aList->RemovePicker( ii );
|
|
ii++; // the current item was removed, ii points now the next item
|
|
// decrement it because it will be incremented later
|
|
not_found = true;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
item->ClearFlags();
|
|
|
|
// see if we must rebuild ratsnets and pointers lists
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_T:
|
|
case PCB_ZONE_AREA_T:
|
|
case PCB_TRACE_T:
|
|
case PCB_VIA_T:
|
|
reBuild_ratsnest = true;
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
switch( aList->GetPickedItemStatus( ii ) )
|
|
{
|
|
case UR_CHANGED: /* Exchange old and new data for each item */
|
|
{
|
|
BOARD_ITEM* image = (BOARD_ITEM*) aList->GetPickedItemLink( ii );
|
|
SwapData( item, image );
|
|
}
|
|
break;
|
|
|
|
case UR_NEW: /* new items are deleted */
|
|
aList->SetPickedItemStatus( UR_DELETED, ii );
|
|
GetBoard()->Remove( item );
|
|
break;
|
|
|
|
case UR_DELETED: /* deleted items are put in List, as new items */
|
|
aList->SetPickedItemStatus( UR_NEW, ii );
|
|
GetBoard()->Add( item );
|
|
build_item_list = true;
|
|
break;
|
|
|
|
case UR_MOVED:
|
|
item->Move( aRedoCommand ? aList->m_TransformPoint : -aList->m_TransformPoint );
|
|
break;
|
|
|
|
case UR_ROTATED:
|
|
item->Rotate( aList->m_TransformPoint, aRedoCommand ? 900 : -900 );
|
|
break;
|
|
|
|
case UR_ROTATED_CLOCKWISE:
|
|
item->Rotate( aList->m_TransformPoint, aRedoCommand ? -900 : 900 );
|
|
break;
|
|
|
|
case UR_FLIPPED:
|
|
item->Flip( aList->m_TransformPoint );
|
|
break;
|
|
|
|
default:
|
|
{
|
|
wxString msg;
|
|
msg.Printf( wxT( "PutDataInPreviousState() error (unknown code %X)" ),
|
|
aList->GetPickedItemStatus( ii ) );
|
|
wxMessageBox( msg );
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( not_found )
|
|
wxMessageBox( wxT( "Incomplete undo/redo operation: some items not found" ) );
|
|
|
|
// Rebuild pointers and ratsnest that can be changed.
|
|
if( reBuild_ratsnest && aRebuildRatsnet )
|
|
Compile_Ratsnest( NULL, true );
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::GetBoardFromUndoList( wxCommandEvent& event )
|
|
{
|
|
if( GetScreen()->GetUndoCommandCount() <= 0 )
|
|
return;
|
|
|
|
/* Get the old list */
|
|
PICKED_ITEMS_LIST* List = GetScreen()->PopCommandFromUndoList();
|
|
/* Undo the command */
|
|
PutDataInPreviousState( List, false );
|
|
|
|
/* Put the old list in RedoList */
|
|
List->ReversePickersListOrder();
|
|
GetScreen()->PushCommandToRedoList( List );
|
|
|
|
OnModify();
|
|
m_canvas->Refresh();
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::GetBoardFromRedoList( wxCommandEvent& event )
|
|
{
|
|
if( GetScreen()->GetRedoCommandCount() == 0 )
|
|
return;
|
|
|
|
|
|
/* Get the old list */
|
|
PICKED_ITEMS_LIST* List = GetScreen()->PopCommandFromRedoList();
|
|
|
|
/* Redo the command: */
|
|
PutDataInPreviousState( List, true );
|
|
|
|
/* Put the old list in UndoList */
|
|
List->ReversePickersListOrder();
|
|
GetScreen()->PushCommandToUndoList( List );
|
|
|
|
OnModify();
|
|
m_canvas->Refresh();
|
|
}
|
|
|
|
|
|
void PCB_SCREEN::ClearUndoORRedoList( UNDO_REDO_CONTAINER& aList, int aItemCount )
|
|
{
|
|
if( aItemCount == 0 )
|
|
return;
|
|
|
|
unsigned icnt = aList.m_CommandsList.size();
|
|
|
|
if( aItemCount > 0 )
|
|
icnt = aItemCount;
|
|
|
|
for( unsigned ii = 0; ii < icnt; ii++ )
|
|
{
|
|
if( aList.m_CommandsList.size() == 0 )
|
|
break;
|
|
|
|
PICKED_ITEMS_LIST* curr_cmd = aList.m_CommandsList[0];
|
|
aList.m_CommandsList.erase( aList.m_CommandsList.begin() );
|
|
|
|
curr_cmd->ClearListAndDeleteItems();
|
|
delete curr_cmd; // Delete command
|
|
}
|
|
}
|