476 lines
19 KiB
C++
476 lines
19 KiB
C++
/***********************************************************/
|
|
/* wxEeschemaStruct.h: */
|
|
/***********************************************************/
|
|
|
|
#ifndef WX_EESCHEMA_STRUCT_H
|
|
#define WX_EESCHEMA_STRUCT_H
|
|
|
|
#include "wxstruct.h"
|
|
#include "param_config.h"
|
|
#include "class_undoredo_container.h"
|
|
|
|
|
|
class WinEDA_LibeditFrame;
|
|
class WinEDA_ViewlibFrame;
|
|
class SCH_SCREEN;
|
|
class DRAWSEGMENT;
|
|
class DrawPickedStruct;
|
|
class SCH_ITEM;
|
|
class SCH_NO_CONNECT;
|
|
class CMP_LIBRARY;
|
|
class LIB_COMPONENT;
|
|
class CMP_LIB_ENTRY;
|
|
class LIB_DRAW_ITEM;
|
|
class EDA_BaseStruct;
|
|
class SCH_BUS_ENTRY;
|
|
class SCH_GLOBALLABEL;
|
|
class SCH_TEXT;
|
|
class SCH_SHEET;
|
|
class SCH_SHEET_PATH;
|
|
class SCH_SHEET_PIN;
|
|
class SCH_COMPONENT;
|
|
class SCH_FIELD;
|
|
class LIB_PIN;
|
|
class SCH_JUNCTION;
|
|
|
|
/* enum used in RotationMiroir() */
|
|
enum fl_rot_cmp
|
|
{
|
|
CMP_NORMAL, // Normal orientation, no rotation or mirror
|
|
CMP_ROTATE_CLOCKWISE, // Rotate -90
|
|
CMP_ROTATE_COUNTERCLOCKWISE, // Rotate +90
|
|
CMP_ORIENT_0, // No rotation and no mirror id CMP_NORMAL
|
|
CMP_ORIENT_90, // Rotate 90, no mirror
|
|
CMP_ORIENT_180, // Rotate 180, no mirror
|
|
CMP_ORIENT_270, // Rotate -90, no mirror
|
|
CMP_MIROIR_X = 0x100, // Mirror around X axis
|
|
CMP_MIROIR_Y = 0x200 // Mirror around Y axis
|
|
};
|
|
|
|
/**
|
|
* Schematic editor (EESchema) main window.
|
|
*/
|
|
class WinEDA_SchematicFrame : public WinEDA_DrawFrame
|
|
{
|
|
public:
|
|
WinEDAChoiceBox* m_SelPartBox;
|
|
SCH_SHEET_PATH* m_CurrentSheet; ///< which sheet we are presently working on.
|
|
int m_Multiflag;
|
|
int m_NetlistFormat;
|
|
bool m_ShowAllPins;
|
|
wxPoint m_OldPos;
|
|
WinEDA_LibeditFrame* m_LibeditFrame;
|
|
WinEDA_ViewlibFrame* m_ViewlibFrame;
|
|
wxString m_UserLibraryPath;
|
|
wxArrayString m_ComponentLibFiles;
|
|
|
|
|
|
private:
|
|
wxString m_DefaultSchematicFileName;
|
|
SCH_FIELD* m_CurrentField;
|
|
int m_TextFieldSize;
|
|
bool m_ShowGrid;
|
|
PARAM_CFG_ARRAY m_projectFileParams;
|
|
PARAM_CFG_ARRAY m_configSettings;
|
|
|
|
|
|
public:
|
|
WinEDA_SchematicFrame( wxWindow* father,
|
|
const wxString& title,
|
|
const wxPoint& pos, const wxSize& size,
|
|
long style = KICAD_DEFAULT_DRAWFRAME_STYLE );
|
|
|
|
~WinEDA_SchematicFrame();
|
|
|
|
void OnCloseWindow( wxCloseEvent& Event );
|
|
void Process_Special_Functions( wxCommandEvent& event );
|
|
void Process_Config( wxCommandEvent& event );
|
|
|
|
void GeneralControle( wxDC* DC, wxPoint MousePositionInPixels );
|
|
|
|
PARAM_CFG_ARRAY& GetProjectFileParameters( void );
|
|
void SaveProjectFile( wxWindow* displayframe );
|
|
bool LoadProjectFile( const wxString& CfgFileName, bool ForceRereadConfig );
|
|
|
|
PARAM_CFG_ARRAY& GetConfigurationSettings( void );
|
|
void LoadSettings();
|
|
void SaveSettings();
|
|
|
|
void RedrawActiveWindow( wxDC* DC, bool EraseBg );
|
|
|
|
void CreateScreens();
|
|
void ReCreateHToolbar();
|
|
void ReCreateVToolbar();
|
|
void ReCreateOptToolbar();
|
|
void ReCreateMenuBar();
|
|
void OnHotKey( wxDC* DC,
|
|
int hotkey,
|
|
EDA_BaseStruct* DrawStruct );
|
|
|
|
SCH_FIELD* GetCurrentField() { return m_CurrentField; }
|
|
|
|
void SetCurrentField( SCH_FIELD* aCurrentField )
|
|
{
|
|
m_CurrentField = aCurrentField;
|
|
}
|
|
|
|
|
|
SCH_SHEET_PATH* GetSheet();
|
|
|
|
SCH_SCREEN* GetScreen() const;
|
|
|
|
BASE_SCREEN* GetBaseScreen() const;
|
|
|
|
virtual wxString GetScreenDesc();
|
|
|
|
void InstallConfigFrame( const wxPoint& pos );
|
|
|
|
void OnLeftClick( wxDC* DC, const wxPoint& MousePos );
|
|
void OnLeftDClick( wxDC* DC, const wxPoint& MousePos );
|
|
bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu );
|
|
void OnSelectOptionToolbar( wxCommandEvent& event );
|
|
int BestZoom();
|
|
|
|
SCH_ITEM* SchematicGeneralLocateAndDisplay( bool IncludePin = TRUE );
|
|
SCH_ITEM* SchematicGeneralLocateAndDisplay( const wxPoint& refpoint,
|
|
bool IncludePin );
|
|
|
|
/**
|
|
* Function FillFootprintFieldForAllInstancesofComponent
|
|
* searches for component "aReference", and places a Footprint in
|
|
* Footprint field
|
|
* @param aReference = reference of the component to initialize
|
|
* @param aFootPrint = new value for the filed Footprint component
|
|
* @param aSetVisible = true to have the field visible, false to set the
|
|
* invisible flag
|
|
* @return true if the given component is found
|
|
* Note:
|
|
* the component is searched in the whole schematic, and because some
|
|
* components have more than one instance (multiple parts per package
|
|
* components) the search is not stopped when a reference is found
|
|
* (all instances must be found).
|
|
*/
|
|
bool FillFootprintFieldForAllInstancesofComponent( const wxString& aReference,
|
|
const wxString& aFootPrint,
|
|
bool aSetVisible );
|
|
|
|
SCH_ITEM* FindComponentAndItem( const wxString& component_reference,
|
|
bool Find_in_hierarchy,
|
|
int SearchType,
|
|
const wxString& text_to_find,
|
|
bool mouseWarp );
|
|
|
|
/* Cross probing with pcbnew */
|
|
void SendMessageToPCBNEW( EDA_BaseStruct* objectToSync,
|
|
SCH_COMPONENT* LibItem );
|
|
|
|
/* netlist generation */
|
|
void BuildNetListBase();
|
|
|
|
/**
|
|
* Function DeleteAnnotation
|
|
* Remove current component annotations
|
|
* @param aCurrentSheetOnly : if false: remove all annotations, else
|
|
* remove annotation relative to the current
|
|
* sheet only
|
|
* @param aRedraw : true to refresh display
|
|
*/
|
|
void DeleteAnnotation( bool aCurrentSheetOnly, bool aRedraw );
|
|
|
|
// Functions used for hierarchy handling
|
|
void InstallPreviousSheet();
|
|
void InstallNextScreen( SCH_SHEET* Sheet );
|
|
|
|
/** Function GetUniqueFilenameForCurrentSheet
|
|
* @return a filename that can be used in plot and print functions
|
|
* for the current screen and sheet path.
|
|
* This filename is unique and must be used instead of the screen filename
|
|
* (or screen filename) when one must creates file for each sheet in the
|
|
* hierarchy. because in complex hierarchies a sheet and a SCH_SCREEN is
|
|
* used more than once
|
|
* Name is <root sheet filename>-<sheet path>
|
|
* and has no extension.
|
|
* However if filename is too long name is <sheet filename>-<sheet number>
|
|
*/
|
|
wxString GetUniqueFilenameForCurrentSheet();
|
|
|
|
/**
|
|
* Function SetSheetNumberAndCount
|
|
* Set the m_ScreenNumber and m_NumberOfScreen members for screens
|
|
* must be called after a delete or add sheet command, and when entering
|
|
* a sheet
|
|
*/
|
|
void SetSheetNumberAndCount();
|
|
|
|
// Plot functions:
|
|
void ToPlot_PS( wxCommandEvent& event );
|
|
void ToPlot_HPGL( wxCommandEvent& event );
|
|
void ToPlot_DXF( wxCommandEvent& event );
|
|
void ToPostProcess( wxCommandEvent& event );
|
|
|
|
// read and save files
|
|
void Save_File( wxCommandEvent& event );
|
|
void SaveProject();
|
|
int LoadOneEEProject( const wxString& FileName, bool IsNew );
|
|
bool LoadOneEEFile( SCH_SCREEN* screen,
|
|
const wxString& FullFileName );
|
|
bool ReadInputStuffFile();
|
|
|
|
/**
|
|
* Function ProcessStuffFile
|
|
* gets footprint info from each line in the Stuff File by Ref Desg
|
|
* @param aFilename The file to read from.
|
|
* @param aSetFielsAttributeToVisible = true to set the footprint field
|
|
flag to visible
|
|
* @return bool - true if success, else true.
|
|
*/
|
|
bool ProcessStuffFile( FILE* aFilename,
|
|
bool aSetFielsAttributeToVisible );
|
|
|
|
bool SaveEEFile( SCH_SCREEN* screen, int FileSave );
|
|
SCH_SCREEN* CreateNewScreen( SCH_SCREEN* OldScreen, int TimeStamp );
|
|
|
|
// General search:
|
|
|
|
/**
|
|
* Function FindSchematicItem
|
|
* finds a string in the schematic.
|
|
* @param pattern The text to search for, either in value, reference or
|
|
* elsewhere.
|
|
* @param SearchType: 0 => Search is made in current sheet
|
|
* 1 => the whole hierarchy
|
|
* 2 => or for the next item
|
|
* @param mouseWarp If true, then move the mouse cursor to the item.
|
|
*/
|
|
SCH_ITEM* FindSchematicItem( const wxString& pattern,
|
|
int SearchType,
|
|
bool mouseWarp = true );
|
|
|
|
SCH_ITEM* FindMarker( int SearchType );
|
|
|
|
private:
|
|
void Process_Move_Item( SCH_ITEM* DrawStruct, wxDC* DC );
|
|
void OnExit( wxCommandEvent& event );
|
|
void OnAnnotate( wxCommandEvent& event );
|
|
void OnErc( wxCommandEvent& event );
|
|
void OnCreateNetlist( wxCommandEvent& event );
|
|
void OnCreateBillOfMaterials( wxCommandEvent& event );
|
|
void OnFindItems( wxCommandEvent& event );
|
|
void OnLoadFile( wxCommandEvent& event );
|
|
void OnLoadStuffFile( wxCommandEvent& event );
|
|
void OnNewProject( wxCommandEvent& event );
|
|
void OnLoadProject( wxCommandEvent& event );
|
|
void OnOpenPcbnew( wxCommandEvent& event );
|
|
void OnOpenCvpcb( wxCommandEvent& event );
|
|
void OnOpenLibraryViewer( wxCommandEvent& event );
|
|
void OnOpenLibraryEditor( wxCommandEvent& event );
|
|
void OnSetOptions( wxCommandEvent& event );
|
|
|
|
/* User interface update event handlers. */
|
|
void OnUpdateBlockSelected( wxUpdateUIEvent& event );
|
|
void OnUpdatePaste( wxUpdateUIEvent& event );
|
|
void OnUpdateSchematicUndo( wxUpdateUIEvent& event );
|
|
void OnUpdateSchematicRedo( wxUpdateUIEvent& event );
|
|
void OnUpdateGrid( wxUpdateUIEvent& event );
|
|
void OnUpdateUnits( wxUpdateUIEvent& event );
|
|
void OnUpdateSelectCursor( wxUpdateUIEvent& event );
|
|
void OnUpdateHiddenPins( wxUpdateUIEvent& event );
|
|
void OnUpdateBusOrientation( wxUpdateUIEvent& event );
|
|
|
|
// Bus Entry
|
|
SCH_BUS_ENTRY* CreateBusEntry( wxDC* DC, int entry_type );
|
|
void SetBusEntryShape( wxDC* DC,
|
|
SCH_BUS_ENTRY* BusEntry,
|
|
int entry_type );
|
|
int GetBusEntryShape( SCH_BUS_ENTRY* BusEntry );
|
|
void StartMoveBusEntry( SCH_BUS_ENTRY* DrawLibItem,
|
|
wxDC* DC );
|
|
|
|
// NoConnect
|
|
SCH_NO_CONNECT* CreateNewNoConnectStruct( wxDC* DC );
|
|
|
|
// Junction
|
|
SCH_JUNCTION* CreateNewJunctionStruct( wxDC* DC,
|
|
const wxPoint& pos,
|
|
bool PutInUndoList = FALSE );
|
|
|
|
// Text ,label, glabel
|
|
SCH_TEXT* CreateNewText( wxDC* DC, int type );
|
|
void EditSchematicText( SCH_TEXT* TextStruct );
|
|
void ChangeTextOrient( SCH_TEXT* TextStruct, wxDC* DC );
|
|
void StartMoveTexte( SCH_TEXT* TextStruct, wxDC* DC );
|
|
void ConvertTextType( SCH_TEXT* Text, wxDC* DC, int newtype );
|
|
|
|
// Wire, Bus
|
|
void BeginSegment( wxDC* DC, int type );
|
|
void EndSegment( wxDC* DC );
|
|
void DeleteCurrentSegment( wxDC* DC );
|
|
void DeleteConnection( bool DeleteFullConnection );
|
|
|
|
// graphic lines
|
|
void Delete_Segment_Edge( DRAWSEGMENT* Segment, wxDC* DC );
|
|
void Drawing_SetNewWidth( DRAWSEGMENT* DrawSegm, wxDC* DC );
|
|
void Delete_Drawings_All_Layer( DRAWSEGMENT* Segment, wxDC* DC );
|
|
DRAWSEGMENT* Begin_Edge( DRAWSEGMENT* Segment, wxDC* DC );
|
|
|
|
// Hierarchical Sheet & PinSheet
|
|
void InstallHierarchyFrame( wxDC* DC, wxPoint& pos );
|
|
SCH_SHEET* CreateSheet( wxDC* DC );
|
|
void ReSizeSheet( SCH_SHEET* Sheet, wxDC* DC );
|
|
|
|
/**
|
|
* Use the component viewer to select component to import into schematic.
|
|
*/
|
|
wxString SelectFromLibBrowser( void );
|
|
|
|
public:
|
|
bool EditSheet( SCH_SHEET* Sheet, wxDC* DC );
|
|
|
|
/** Function UpdateSheetNumberAndDate
|
|
* Set a sheet number, the sheet count for sheets in the whole schematic
|
|
* and update the date in all screens
|
|
*/
|
|
void UpdateSheetNumberAndDate();
|
|
|
|
private:
|
|
void StartMoveSheet( SCH_SHEET* sheet, wxDC* DC );
|
|
SCH_SHEET_PIN* Create_PinSheet( SCH_SHEET* Sheet, wxDC* DC );
|
|
int Edit_PinSheet( SCH_SHEET_PIN* SheetLabel, wxDC* DC );
|
|
void StartMove_PinSheet( SCH_SHEET_PIN* SheetLabel,
|
|
wxDC* DC );
|
|
void Place_PinSheet( SCH_SHEET_PIN* SheetLabel,
|
|
wxDC* DC );
|
|
SCH_SHEET_PIN* Import_PinSheet( SCH_SHEET* Sheet, wxDC* DC );
|
|
|
|
public:
|
|
void DeleteSheetLabel( bool aRedraw,
|
|
SCH_SHEET_PIN* aSheetLabelToDel );
|
|
|
|
private:
|
|
|
|
// Component
|
|
SCH_COMPONENT* Load_Component( wxDC* DC,
|
|
const wxString& libname,
|
|
wxArrayString& List,
|
|
bool UseLibBrowser );
|
|
void StartMovePart( SCH_COMPONENT* DrawLibItem, wxDC* DC );
|
|
|
|
public:
|
|
void CmpRotationMiroir( SCH_COMPONENT* DrawComponent,
|
|
wxDC* DC, int type_rotate );
|
|
|
|
private:
|
|
void SelPartUnit( SCH_COMPONENT* DrawComponent,
|
|
int unit, wxDC* DC );
|
|
void ConvertPart( SCH_COMPONENT* DrawComponent, wxDC* DC );
|
|
void SetInitCmp( SCH_COMPONENT* DrawComponent, wxDC* DC );
|
|
void EditComponentReference( SCH_COMPONENT* DrawLibItem,
|
|
wxDC* DC );
|
|
void EditComponentValue( SCH_COMPONENT* DrawLibItem, wxDC* DC );
|
|
void EditComponentFootprint( SCH_COMPONENT* DrawLibItem,
|
|
wxDC* DC );
|
|
void StartMoveCmpField( SCH_FIELD* Field, wxDC* DC );
|
|
void EditCmpFieldText( SCH_FIELD* Field, wxDC* DC );
|
|
void RotateCmpField( SCH_FIELD* Field, wxDC* DC );
|
|
|
|
void PasteListOfItems( wxDC* DC );
|
|
|
|
/* Undo - redo */
|
|
public:
|
|
|
|
/** Function SaveCopyInUndoList.
|
|
* Creates a new entry in undo list of commands.
|
|
* add a picker to handle aItemToCopy
|
|
* @param aItemToCopy = the schematic item modified by the command to undo
|
|
* @param aTypeCommand = command type (see enum UndoRedoOpType)
|
|
* @param aTransformPoint = the reference point of the transformation,
|
|
* for commands like move
|
|
*/
|
|
void SaveCopyInUndoList( SCH_ITEM* aItemToCopy,
|
|
UndoRedoOpType aTypeCommand,
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) );
|
|
|
|
/** Function SaveCopyInUndoList (overloaded).
|
|
* Creates a new entry in undo list of commands.
|
|
* add a list of pickers to handle a list of items
|
|
* @param aItemsList = the list of items modified by the command to undo
|
|
* @param aTypeCommand = command type (see enum UndoRedoOpType)
|
|
* @param aTransformPoint = the reference point of the transformation,
|
|
* for commands like move
|
|
*/
|
|
void SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList,
|
|
UndoRedoOpType aTypeCommand,
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) );
|
|
|
|
private:
|
|
/** Function PutDataInPreviousState()
|
|
* Used in undo or redo command.
|
|
* Put data pointed by List in the previous state, i.e. the state
|
|
* memorized by List
|
|
* @param aList = a PICKED_ITEMS_LIST pointer to the list of items to
|
|
* undo/redo
|
|
* @param aRedoCommand = a bool: true for redo, false for undo
|
|
*/
|
|
void PutDataInPreviousState( PICKED_ITEMS_LIST* aList, bool aRedoCommand );
|
|
|
|
/** Function GetSchematicFromRedoList
|
|
* Redo the last edition:
|
|
* - Save the current schematic in Undo list
|
|
* - Get an old version of the schematic from Redo list
|
|
* @return none
|
|
*/
|
|
void GetSchematicFromRedoList(wxCommandEvent& event);
|
|
|
|
/** Function GetSchematicFromUndoList
|
|
* Undo the last edition:
|
|
* - Save the current schematic in Redo list
|
|
* - Get an old version of the schematic from Undo list
|
|
* @return none
|
|
*/
|
|
void GetSchematicFromUndoList(wxCommandEvent& event);
|
|
|
|
|
|
public:
|
|
void Key( wxDC* DC, int hotkey, EDA_BaseStruct* DrawStruct );
|
|
|
|
/* Block operations. */
|
|
int ReturnBlockCommand( int key );
|
|
void InitBlockPasteInfos();
|
|
void HandleBlockPlace( wxDC* DC );
|
|
int HandleBlockEnd( wxDC* DC );
|
|
void HandleBlockEndByPopUp( int Command, wxDC* DC );
|
|
|
|
void RepeatDrawItem( wxDC* DC );
|
|
|
|
void TestDanglingEnds( SCH_ITEM* DrawList, wxDC* DC );
|
|
LIB_PIN* LocatePinEnd( SCH_ITEM* DrawList, const wxPoint& pos );
|
|
|
|
// ERC:
|
|
/**
|
|
* Function CheckAnnotate
|
|
* Check errors relatives to annotation:
|
|
* components not annotated
|
|
* components having the same reference (duplicates)
|
|
* for multiple parts per package components :
|
|
* part number > number of parts
|
|
* different values between parts
|
|
* @return errors count
|
|
* @param aMessageList = a wxArrayString to store messages. If NULL,
|
|
* they are displayed in a wxMessageBox
|
|
* @param aOneSheetOnly : true = search is made only in the current sheet
|
|
* false = search in whole hierarchy (usual search).
|
|
*/
|
|
int CheckAnnotate( wxArrayString * aMessageList, bool aOneSheetOnly );
|
|
|
|
/**
|
|
* Load component libraries defined in project file.
|
|
*/
|
|
void LoadLibraries( void );
|
|
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
|
|
#endif // WX_EESCHEMA_STRUCT_H
|