kicad/eeschema/annotate.cpp

201 lines
5.7 KiB
C++
Raw Normal View History

/**
* @file annotate.cpp
* @brief Component annotation.
*/
2007-05-06 16:03:28 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2017 KiCad Developers, see change_log.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 <algorithm>
#include <fctsys.h>
#include <class_drawpanel.h>
#include <confirm.h>
2018-01-30 10:49:51 +00:00
#include <sch_edit_frame.h>
2016-02-15 20:16:54 +00:00
#include <sch_reference_list.h>
#include <class_library.h>
void SCH_EDIT_FRAME::DeleteAnnotation( bool aCurrentSheetOnly )
{
2008-04-21 06:34:56 +00:00
if( aCurrentSheetOnly )
{
2016-02-15 20:22:45 +00:00
SCH_SCREEN* screen = GetScreen();
wxCHECK_RET( screen != NULL, wxT( "Attempt to clear annotation of a NULL screen." ) );
screen->ClearAnnotation( m_CurrentSheet );
}
else
{
2016-02-15 20:22:45 +00:00
SCH_SCREENS ScreenList;
ScreenList.ClearAnnotation();
2008-04-21 06:34:56 +00:00
}
// Update the references for the sheet that is currently being displayed.
2016-02-15 20:17:51 +00:00
m_CurrentSheet->UpdateAllScreenReferences();
GetCanvas()->Refresh();
OnModify();
}
2007-09-20 21:06:49 +00:00
void SCH_EDIT_FRAME::AnnotateComponents( bool aAnnotateSchematic,
ANNOTATE_ORDER_T aSortOption,
ANNOTATE_OPTION_T aAlgoOption,
bool aResetAnnotation,
bool aRepairTimestamps,
bool aLockUnits )
2007-05-06 16:03:28 +00:00
{
SCH_REFERENCE_LIST references;
2007-09-20 21:06:49 +00:00
SCH_SCREENS screens;
// Build the sheet list.
SCH_SHEET_LIST sheets( g_RootSheet );
// Map of locked components
SCH_MULTI_UNIT_REFERENCE_MAP lockedComponents;
// Test for and replace duplicate time stamps in components and sheets. Duplicate
// time stamps can happen with old schematics, schematic conversions, or manual
// editing of files.
if( aRepairTimestamps )
{
int count = screens.ReplaceDuplicateTimeStamps();
if( count )
{
wxString msg;
msg.Printf( _( "%d duplicate time stamps were found and replaced." ), count );
DisplayInfoMessage( NULL, msg );
}
}
// If units must be locked, collect all the sets that must be annotated together.
if( aLockUnits )
{
if( aAnnotateSchematic )
{
sheets.GetMultiUnitComponents( lockedComponents );
}
else
{
m_CurrentSheet->GetMultiUnitComponents( lockedComponents );
}
}
// If it is an annotation for all the components, reset previous annotation.
if( aResetAnnotation )
DeleteAnnotation( !aAnnotateSchematic );
2007-09-20 21:06:49 +00:00
// Set sheet number and number of sheets.
SetSheetNumberAndCount();
2007-09-20 21:06:49 +00:00
// Build component list
if( aAnnotateSchematic )
{
sheets.GetComponents( references );
2007-09-20 21:06:49 +00:00
}
else
{
m_CurrentSheet->GetComponents( references );
}
2007-09-20 21:06:49 +00:00
// Break full components reference in name (prefix) and number:
// example: IC1 become IC, and 1
references.SplitReferences();
switch( aSortOption )
2008-04-21 14:03:20 +00:00
{
default:
case SORT_BY_X_POSITION:
references.SortByXCoordinate();
2008-04-21 14:03:20 +00:00
break;
2007-09-20 21:06:49 +00:00
case SORT_BY_Y_POSITION:
references.SortByYCoordinate();
2008-04-21 14:03:20 +00:00
break;
}
2008-04-21 14:03:20 +00:00
bool useSheetNum = false;
int idStep = 100;
switch( aAlgoOption )
{
default:
case INCREMENTAL_BY_REF:
break;
case SHEET_NUMBER_X_100:
useSheetNum = true;
break;
case SHEET_NUMBER_X_1000:
useSheetNum = true;
idStep = 1000;
2008-04-21 14:03:20 +00:00
break;
}
2007-09-20 21:06:49 +00:00
// Recalculate and update reference numbers in schematic
references.Annotate( useSheetNum, idStep, lockedComponents );
references.UpdateAnnotation();
2007-09-20 21:06:49 +00:00
wxArrayString errors;
2007-05-06 16:03:28 +00:00
// Final control (just in case ... ).
if( CheckAnnotate( &errors, !aAnnotateSchematic ) )
{
wxString msg;
for( size_t i = 0; i < errors.GetCount(); i++ )
msg += errors[i];
// wxLogWarning is a cheap and dirty way to dump a potentially long list of
// strings to a dialog that can be saved to a file. This should be replaced
// by a more elegant solution.
wxLogWarning( msg );
}
OnModify();
// Update on screen references, that can be modified by previous calculations:
2016-02-15 20:17:51 +00:00
m_CurrentSheet->UpdateAllScreenReferences();
SetSheetNumberAndCount();
2007-09-20 21:06:49 +00:00
m_canvas->Refresh( true );
2007-05-06 16:03:28 +00:00
}
int SCH_EDIT_FRAME::CheckAnnotate( wxArrayString* aMessageList, bool aOneSheetOnly )
2007-05-06 16:03:28 +00:00
{
// build the screen list
SCH_SHEET_LIST sheetList( g_RootSheet );
SCH_REFERENCE_LIST componentsList;
2007-09-20 21:06:49 +00:00
// Build the list of components
if( !aOneSheetOnly )
sheetList.GetComponents( componentsList );
2007-09-20 21:06:49 +00:00
else
m_CurrentSheet->GetComponents( componentsList );
return componentsList.CheckAnnotation( aMessageList );
2007-05-06 16:03:28 +00:00
}