PROJECT Class Reference

Container for project specific data. More...

#include <project.h>

Classes
class	_ELEM
	A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives. More...

Public Types
enum	RSTRING_T {   DOC_PATH, SCH_LIB_PATH, SCH_LIB_SELECT, SCH_LIBEDIT_CUR_LIB,   SCH_LIBEDIT_CUR_SYMBOL, VIEWER_3D_PATH, VIEWER_3D_FILTER_INDEX, PCB_LIB_NICKNAME,   PCB_FOOTPRINT, PCB_FOOTPRINT_EDITOR_FP_NAME, PCB_FOOTPRINT_EDITOR_LIB_NICKNAME, PCB_FOOTPRINT_VIEWER_FP_NAME,   PCB_FOOTPRINT_VIEWER_LIB_NICKNAME, RSTRING_COUNT }
	Retain a number of project specific wxStrings, enumerated here: More...
enum	ELEM_T {   ELEM_FPTBL, ELEM_SCH_SYMBOL_LIBS, ELEM_SCH_SEARCH_STACK, ELEM_3DCACHE,   ELEM_SYMBOL_LIB_TABLE, ELEM_COUNT }
	The set of #_ELEMs that a PROJECT can hold. More...

Public Member Functions
	PROJECT ()
virtual	~PROJECT ()
virtual bool	TextVarResolver (wxString *aToken) const
virtual std::map< wxString, wxString > &	GetTextVars () const
virtual const wxString	GetProjectFullName () const
	Return the full path and name of the project. More...
virtual const wxString	GetProjectPath () const
	Return the full path of the project. More...
virtual const wxString	GetProjectName () const
	Return the short name of the project. More...
virtual bool	IsNullProject () const
	Check if this project is a null project (i.e. More...
virtual bool	IsReadOnly () const
virtual void	SetReadOnly (bool aReadOnly=true)
virtual const wxString	GetSheetName (const KIID &aSheetID)
	Return the name of the sheet identified by the given UUID. More...
virtual const wxString	FootprintLibTblName () const
	Returns the path and filename of this project's footprint library table. More...
virtual const wxString	SymbolLibTableName () const
	Return the path and file name of this projects symbol library table. More...
virtual PROJECT_FILE &	GetProjectFile () const
virtual PROJECT_LOCAL_SETTINGS &	GetLocalSettings () const
virtual const wxString &	GetRString (RSTRING_T aStringId)
	Return a "retained string", which is any session and project specific string identified in enum RSTRING_T. More...
virtual void	SetRString (RSTRING_T aStringId, const wxString &aString)
	Store a "retained string", which is any session and project specific string identified in enum RSTRING_T. More...
virtual _ELEM *	GetElem (ELEM_T aIndex)
	Get and set the elements for this project. More...
virtual void	SetElem (ELEM_T aIndex, _ELEM *aElem)
virtual void	ElemsClear ()
	Delete all the _ELEMs and set their pointers to NULL. More...
void	Clear ()
	Clear the _ELEMs and RSTRINGs. More...
virtual const wxString	AbsolutePath (const wxString &aFileName) const
	Fix up aFileName if it is relative to the project's directory to be an absolute path and filename. More...
virtual FP_LIB_TABLE *	PcbFootprintLibs (KIWAY &aKiway)
	Return the table of footprint libraries. More...

Private Member Functions
virtual void	setProjectFullName (const wxString &aFullPathAndName)
	Set the full directory, basename, and extension of the project. More...
virtual void	setProjectFile (PROJECT_FILE *aFile)
	Set the backing store file for this project. More...
virtual void	setLocalSettings (PROJECT_LOCAL_SETTINGS *aSettings)
	Set the local settings backing store. More...
const wxString	libTableName (const wxString &aLibTableName) const
	Return the full path and file name of the project specific library table aLibTableName. More...

Private Attributes
wxFileName	m_project_name
	<fullpath>/<basename>.pro More...
wxString	m_pro_date_and_time
	True if the project is read-only: no project files will be written. More...
bool	m_readOnly
PROJECT_FILE *	m_projectFile
	Backing store for project data – owned by SETTINGS_MANAGER. More...
PROJECT_LOCAL_SETTINGS *	m_localSettings
	Backing store for project local settings – owned by SETTINGS_MANAGER. More...
std::map< KIID, wxString >	m_sheetNames
wxString	m_rstrings [RSTRING_COUNT]
_ELEM *	m_elems [ELEM_COUNT]

Friends
class	SETTINGS_MANAGER
class	TEST_NETLISTS_FIXTURE

Detailed Description

Container for project specific data.

Because it is in the neutral program top, which is not linked to by subsidiary DSOs, any functions in this interface must be virtual.

Definition at line 62 of file project.h.

Member Enumeration Documentation

ELEM_T

enum PROJECT::ELEM_T

The set of #_ELEMs that a PROJECT can hold.

Enumerator
ELEM_FPTBL
ELEM_SCH_SYMBOL_LIBS
ELEM_SCH_SEARCH_STACK
ELEM_3DCACHE
ELEM_SYMBOL_LIB_TABLE
ELEM_COUNT

Definition at line 200 of file project.h.

    {
        ELEM_FPTBL,

        ELEM_SCH_SYMBOL_LIBS,
        ELEM_SCH_SEARCH_STACK,
        ELEM_3DCACHE,
        ELEM_SYMBOL_LIB_TABLE,

        ELEM_COUNT
    };

RSTRING_T

enum PROJECT::RSTRING_T

Retain a number of project specific wxStrings, enumerated here:

Enumerator
DOC_PATH
SCH_LIB_PATH
SCH_LIB_SELECT
SCH_LIBEDIT_CUR_LIB
SCH_LIBEDIT_CUR_SYMBOL
VIEWER_3D_PATH
VIEWER_3D_FILTER_INDEX
PCB_LIB_NICKNAME
PCB_FOOTPRINT
PCB_FOOTPRINT_EDITOR_FP_NAME
PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
PCB_FOOTPRINT_VIEWER_FP_NAME
PCB_FOOTPRINT_VIEWER_LIB_NICKNAME
RSTRING_COUNT

Definition at line 158 of file project.h.

    {
        DOC_PATH,
        SCH_LIB_PATH,
        SCH_LIB_SELECT,               // eeschema/selpart.cpp
        SCH_LIBEDIT_CUR_LIB,
        SCH_LIBEDIT_CUR_SYMBOL,       // eeschema/libeditframe.cpp

        VIEWER_3D_PATH,
        VIEWER_3D_FILTER_INDEX,

        PCB_LIB_NICKNAME,
        PCB_FOOTPRINT,
        PCB_FOOTPRINT_EDITOR_FP_NAME,
        PCB_FOOTPRINT_EDITOR_LIB_NICKNAME,
        PCB_FOOTPRINT_VIEWER_FP_NAME,
        PCB_FOOTPRINT_VIEWER_LIB_NICKNAME,

        RSTRING_COUNT
    };

Constructor & Destructor Documentation

PROJECT()

PROJECT::PROJECT

(

)

Definition at line 40 of file project.cpp.

                 :
        m_readOnly( false ),
        m_projectFile( nullptr ),
        m_localSettings( nullptr )
{
    memset( m_elems, 0, sizeof( m_elems ) );
}

References m_elems.

~PROJECT()

PROJECT::~PROJECT ( )

virtual

Definition at line 60 of file project.cpp.

{
    ElemsClear();
}

References ElemsClear().

Member Function Documentation

AbsolutePath()

const wxString PROJECT::AbsolutePath ( const wxString &  aFileName ) const

virtual

Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.

This intends to overcome the now missing chdir() into the project directory.

Definition at line 269 of file project.cpp.

{
    wxFileName fn = aFileName;

    if( !fn.IsAbsolute() )
    {
        wxString pro_dir = wxPathOnly( GetProjectFullName() );
        fn.Normalize( wxPATH_NORM_ALL, pro_dir );
    }

    return fn.GetFullPath();
}

References GetProjectFullName().

Referenced by PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DIALOG_SPICE_MODEL::loadLibrary(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SPICE_MODEL::onSelectLibrary(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveSchematicFile(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SIM_PLOT_FRAME::updateTitle(), and WriteDRCReport().

Clear()

void PROJECT::Clear ( )

inline

Clear the _ELEMs and RSTRINGs.

Definition at line 235 of file project.h.

    {
        ElemsClear();

        for( unsigned i = 0; i<RSTRING_COUNT;  ++i )
            SetRString( RSTRING_T( i ), wxEmptyString );
    }

References ElemsClear(), RSTRING_COUNT, and SetRString().

Referenced by setProjectFullName().

ElemsClear()

void PROJECT::ElemsClear ( )

virtual

Delete all the _ELEMs and set their pointers to NULL.

Definition at line 49 of file project.cpp.

{
    // careful here, this should work, but the virtual destructor may not
    // be in the same link image as PROJECT.
    for( unsigned i = 0;  i < arrayDim( m_elems );  ++i )
    {
        SetElem( ELEM_T( i ), nullptr );
    }
}

References arrayDim(), m_elems, and SetElem().

Referenced by Clear(), and ~PROJECT().

FootprintLibTblName()

const wxString PROJECT::FootprintLibTblName ( ) const

virtual

Returns the path and filename of this project's footprint library table.

This project specific footprint library table not the global one.

Definition at line 146 of file project.cpp.

{
    return libTableName( "fp-lib-table" );
}

References libTableName().

Referenced by InvokePcbLibTableEditor(), PCB_EDIT_FRAME::OpenProjectFiles(), and PcbFootprintLibs().

GetElem()

PROJECT::_ELEM * PROJECT::GetElem ( ELEM_T  aIndex )

virtual

Get and set the elements for this project.

This is a cross module API, therefore the #_ELEM destructor is virtual and can point to a destructor function in another link image. Be careful that that program module is resident at time of destruction.

Summary: -#) cross module API. -#) PROJECT knows nothing about #_ELEM objects except how to delete them and set and get pointers to them.

Definition at line 246 of file project.cpp.

{
    // This is virtual, so implement it out of line
    if( unsigned( aIndex ) < arrayDim( m_elems ) )
    {
        return m_elems[aIndex];
    }

    return nullptr;
}

References arrayDim(), and m_elems.

Referenced by PcbFootprintLibs(), and LEGACY_RESCUER::WriteRescueLibrary().

GetLocalSettings()

virtual PROJECT_LOCAL_SETTINGS& PROJECT::GetLocalSettings ( ) const

inlinevirtual

Definition at line 151 of file project.h.

    {
        wxASSERT( m_localSettings );
        return *m_localSettings;
    }

References m_localSettings.

Referenced by BOARD::GetVisibleElements(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowState(), PCB_EDIT_FRAME::onBoardLoaded(), KICAD_MANAGER_FRAME::OnIdle(), PCB_EDIT_FRAME::OpenProjectFiles(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectCopy(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_BASE_FRAME::SaveSettings(), BOARD::SetElementVisibility(), BOARD::SetVisibleLayers(), and SETTINGS_MANAGER::unloadProjectFile().

GetProjectFile()

virtual PROJECT_FILE& PROJECT::GetProjectFile ( ) const

inlinevirtual

Definition at line 145 of file project.h.

    {
        wxASSERT( m_projectFile );
        return *m_projectFile;
    }

References m_projectFile.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), CVPCB_MAINFRAME::buildEquivalenceList(), BOARD::ClearProject(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_EDIT_FRAME::doCloseWindow(), SCHEMATIC::ErcSettings(), PCB_EDIT_FRAME::GetLastPath(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), GetSheetName(), GetTextVars(), inheritNetclass(), DIALOG_CONFIG_EQUFILES::Init(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), SYMBOL_LIBS::LibNamesAndPaths(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_ITEM::NetClass(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_CONFIG_EQUFILES::OnOkClick(), PCB_EDIT_FRAME::OpenProjectFiles(), SCHEMATIC::Reset(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), SIM_PLOT_FRAME::SaveSettings(), PCB_EDIT_FRAME::SetLastPath(), SCHEMATIC::SetProject(), BOARD::SetProject(), SCHEMATIC::Settings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and BOARD::SynchronizeNetsAndNetClasses().

GetProjectFullName()

const wxString PROJECT::GetProjectFullName ( ) const

virtual

Return the full path and name of the project.

This is the same as the name of the project file (.pro prior to version 6 and .kicad_prj from version 6 onwards) and will always be an absolute path.

Definition at line 116 of file project.cpp.

{
    return m_project_name.GetFullPath();
}

References m_project_name.

Referenced by AbsolutePath(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), SCH_EDIT_FRAME::doCloseWindow(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), TEST_NETLISTS_FIXTURE::getNetlistFileName(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDITOR_CONTROL::ImportFPAssignments(), libTableName(), SYMBOL_LIBS::LoadAllLibraries(), SETTINGS_MANAGER::loadProjectFile(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::SaveProjectAs(), PCB_EDIT_FRAME::SaveProjectSettings(), setProjectFullName(), EDA_3D_VIEWER_FRAME::takeScreenshot(), SETTINGS_MANAGER::UnloadProject(), SETTINGS_MANAGER::unloadProjectFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().

GetProjectName()

const wxString PROJECT::GetProjectName ( ) const

virtual

Return the short name of the project.

This is the file name without extension or path.

Definition at line 128 of file project.cpp.

{
    return m_project_name.GetName();
}

References m_project_name.

Referenced by SIM_PLOT_FRAME::canCloseWindow(), SIM_PLOT_FRAME::getDefaultFilename(), SCH_ALTIUM_PLUGIN::getLibName(), SETTINGS_MANAGER::GetProjectBackupsPath(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCHEMATIC::ResolveTextVar(), KICAD_MANAGER_CONTROL::SaveProjectAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and SETTINGS_MANAGER::TriggerBackupIfNeeded().

GetProjectPath()

const wxString PROJECT::GetProjectPath ( ) const

virtual

Return the full path of the project.

This is the path of the project file and will always be an absolute path, ending with a path separator.

Definition at line 122 of file project.cpp.

{
    return m_project_name.GetPathWithSep();
}

References m_project_name.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PCB_BASE_EDIT_FRAME::createNewLibrary(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), KICAD_MANAGER_CONTROL::Execute(), FOOTPRINT_LIST::GetInstance(), SCH_ALTIUM_PLUGIN::getLibFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetProjectBackupsPath(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), NormalizePath(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SPICE_MODEL::onSelectLibrary(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), SCH_EDITOR_CONTROL::Paste(), PathIsInsideProject(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), ResolveFile(), FILENAME_RESOLVER::SetProject(), SCH_EDIT_FRAME::WriteNetListFile(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GetRString()

const wxString & PROJECT::GetRString ( RSTRING_T  aStringId )

virtual

Return a "retained string", which is any session and project specific string identified in enum RSTRING_T.

Retained strings are not written to disk, and are therefore good only for the current session.

Definition at line 227 of file project.cpp.

{
    unsigned ndx = unsigned( aIndex );

    if( ndx < arrayDim( m_rstrings ) )
    {
        return m_rstrings[ndx];
    }
    else
    {
        static wxString no_cookie_for_you;

        wxASSERT( 0 );      // bad index

        return no_cookie_for_you;
    }
}

References arrayDim(), and m_rstrings.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), and SYMBOL_EDIT_FRAME::SelectLibraryFromList().

GetSheetName()

const wxString PROJECT::GetSheetName ( const KIID &  aSheetID )

virtual

Return the name of the sheet identified by the given UUID.

Definition at line 197 of file project.cpp.

{
    if( m_sheetNames.empty() )
    {
        for( auto pair : GetProjectFile().GetSheets() )
            m_sheetNames[pair.first] = pair.second;
    }

    if( m_sheetNames.count( aSheetID ) )
        return m_sheetNames.at( aSheetID );
    else
        return aSheetID.AsString();
}

References KIID::AsString(), GetProjectFile(), PROJECT_FILE::GetSheets(), and m_sheetNames.

GetTextVars()

std::map< wxString, wxString > & PROJECT::GetTextVars ( ) const

virtual

Definition at line 78 of file project.cpp.

{
    return GetProjectFile().m_TextVars;
}

References GetProjectFile(), and PROJECT_FILE::m_TextVars.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), NETLIST_EXPORTER_XML::makeDesignHeader(), PROPERTIES_FRAME::onScintillaCharAdded(), SCH_ALTIUM_PLUGIN::ParseParameter(), BOARD::SynchronizeProperties(), TextVarResolver(), PANEL_TEXT_VARIABLES::TransferDataFromWindow(), and PANEL_TEXT_VARIABLES::TransferDataToWindow().

IsNullProject()

bool PROJECT::IsNullProject ( ) const

virtual

Check if this project is a null project (i.e.

the default project object created when no real project is open).

The null project still presents all the same project interface, but is not backed by any files, so saving it makes no sense.

Returns

true if this is an empty project.

Definition at line 134 of file project.cpp.

{
    return m_project_name.GetName().IsEmpty();
}

References m_project_name.

Referenced by AskSaveBoardFileName(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), IsReadOnly(), EDA_DRAW_FRAME::LibraryFileBrowser(), SYMBOL_LIBS::LoadAllLibraries(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

IsReadOnly()

virtual bool PROJECT::IsReadOnly ( ) const

inlinevirtual

Definition at line 124 of file project.h.

{ return m_readOnly || IsNullProject(); }

References IsNullProject(), and m_readOnly.

Referenced by DIALOG_BOARD_SETUP::OnPageChange().

libTableName()

const wxString PROJECT::libTableName ( const wxString &  aLibTableName ) const

private

Return the full path and file name of the project specific library table aLibTableName.

Definition at line 152 of file project.cpp.

{
    wxFileName  fn = GetProjectFullName();
    wxString    path = fn.GetPath();

    // if there's no path to the project name, or the name as a whole is bogus or its not
    // write-able then use a template file.
    if( !fn.GetDirCount() || !fn.IsOk() || !wxFileName::IsDirWritable( path ) )
    {
        // return a template filename now.

        // this next line is likely a problem now, since it relies on an
        // application title which is no longer constant or known.  This next line needs
        // to be re-thought out.

#ifndef __WXMAC__
        fn.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
#else
        // don't pollute home folder, temp folder seems to be more appropriate
        fn.AssignDir( wxStandardPaths::Get().GetTempDir() );
#endif

#if defined( __WINDOWS__ )
        fn.AppendDir( wxT( "kicad" ) );
#endif

        /*
         * The library table name used when no project file is passed to the appropriate
         * code.  This is used temporarily to store the project specific library table
         * until the project file being edited is saved.  It is then moved to the correct
         * file in the folder where the project file is saved.
         */
        fn.SetName( "prj-" + aLibTableName );
    }
    else    // normal path.
    {
        fn.SetName( aLibTableName );
    }

    fn.ClearExt();

    return fn.GetFullPath();
}

References GetProjectFullName(), and path.

Referenced by FootprintLibTblName(), and SymbolLibTableName().

PcbFootprintLibs()

FP_LIB_TABLE * PROJECT::PcbFootprintLibs ( KIWAY &  aKiway )

virtual

Return the table of footprint libraries.

Requires an active Kiway as this is fetched from Pcbnew.

Definition at line 283 of file project.cpp.

{
    // This is a lazy loading function, it loads the project specific table when
    // that table is asked for, not before.

    FP_LIB_TABLE* tbl = (FP_LIB_TABLE*) GetElem( ELEM_FPTBL );

    if( tbl )
    {
        wxASSERT( tbl->Type() == FP_LIB_TABLE_T );
    }
    else
    {
        try
        {
            // Build a new project specific FP_LIB_TABLE with the global table as a fallback.
            // ~FP_LIB_TABLE() will not touch the fallback table, so multiple projects may
            // stack this way, all using the same global fallback table.
            KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );

            tbl = (FP_LIB_TABLE*) kiface->IfaceOrAddress( KIFACE_NEW_FOOTPRINT_TABLE );
            tbl->Load( FootprintLibTblName() );

            SetElem( ELEM_FPTBL, tbl );
        }
        catch( const IO_ERROR& ioe )
        {
            DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ),
                                 ioe.What() );
        }
        catch( ... )
        {
            DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ) );
        }
    }

    return tbl;
}

References _, DisplayErrorMessage(), ELEM_FPTBL, KIWAY::FACE_PCB, FootprintLibTblName(), FP_LIB_TABLE_T, GetElem(), kiface, KIWAY::KiFACE(), KIFACE_NEW_FOOTPRINT_TABLE, LIB_TABLE::Load(), SetElem(), FP_LIB_TABLE::Type(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), InvokePcbLibTableEditor(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_SELECT_WIDGET::Load(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), PCB_BASE_EDIT_FRAME::selectLibTable(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and FOOTPRINT_EDIT_FRAME::UpdateTitle().

SetElem()

void PROJECT::SetElem ( ELEM_T  aIndex, _ELEM *  aElem  )

virtual

Definition at line 258 of file project.cpp.

{
    // This is virtual, so implement it out of line
    if( unsigned( aIndex ) < arrayDim( m_elems ) )
    {
        delete m_elems[aIndex];
        m_elems[aIndex] = aElem;
    }
}

References arrayDim(), and m_elems.

Referenced by ElemsClear(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), TEST_NETLISTS_FIXTURE::loadSchematic(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), PcbFootprintLibs(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

setLocalSettings()

virtual void PROJECT::setLocalSettings ( PROJECT_LOCAL_SETTINGS *  aSettings )

inlineprivatevirtual

Set the local settings backing store.

This should only be called by SETTINGS_MANAGER on load.

Parameters

aSettings

is the local settings object (may or may not exist on disk at this point)

Definition at line 332 of file project.h.

    {
        m_localSettings = aSettings;
    }

References m_localSettings.

setProjectFile()

virtual void PROJECT::setProjectFile ( PROJECT_FILE *  aFile )

inlineprivatevirtual

Set the backing store file for this project.

This should only be called by #SETTINGS_MANGER on load.

Parameters

aFile

is a loaded PROJECT_FILE.

Definition at line 320 of file project.h.

    {
        m_projectFile = aFile;
    }

References m_projectFile.

Referenced by SETTINGS_MANAGER::loadProjectFile().

setProjectFullName()

void PROJECT::setProjectFullName ( const wxString &  aFullPathAndName )

privatevirtual

Set the full directory, basename, and extension of the project.

This is the name of the project file with full absolute path and it also defines the name of the project. The project name and the project file names are exactly the same, providing the project filename is absolute.

Definition at line 84 of file project.cpp.

{
    // Compare paths, rather than inodes, to be less surprising to the user.
    // Create a temporary wxFileName to normalize the path
    wxFileName candidate_path( aFullPathAndName );

    // Edge transitions only.  This is what clears the project
    // data using the Clear() function.
    if( m_project_name.GetFullPath() != candidate_path.GetFullPath() )
    {
        Clear();            // clear the data when the project changes.

        wxLogTrace( tracePathsAndFiles, "%s: old:'%s' new:'%s'", __func__,
                    TO_UTF8( GetProjectFullName() ), TO_UTF8( aFullPathAndName ) );

        m_project_name = aFullPathAndName;

        wxASSERT( m_project_name.IsAbsolute() );

        wxASSERT( m_project_name.GetExt() == ProjectFileExtension );

        // until multiple projects are in play, set an environment variable for the
        // the project pointer.
        {
            wxString path = m_project_name.GetPath();

            wxSetEnv( PROJECT_VAR_NAME, path );
        }
    }
}

References Clear(), GetProjectFullName(), m_project_name, path, PROJECT_VAR_NAME, ProjectFileExtension, TO_UTF8, and tracePathsAndFiles.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

SetReadOnly()

virtual void PROJECT::SetReadOnly ( bool  aReadOnly = true )

inlinevirtual

Definition at line 126 of file project.h.

{ m_readOnly = aReadOnly; }

References m_readOnly.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().

SetRString()

void PROJECT::SetRString ( RSTRING_T  aStringId, const wxString &  aString  )

virtual

Store a "retained string", which is any session and project specific string identified in enum RSTRING_T.

Retained strings are not written to disk, and are therefore good only for the current session.

Definition at line 212 of file project.cpp.

{
    unsigned ndx = unsigned( aIndex );

    if( ndx < arrayDim( m_rstrings ) )
    {
        m_rstrings[ndx] = aString;
    }
    else
    {
        wxASSERT( 0 );      // bad index
    }
}

References arrayDim(), and m_rstrings.

Referenced by Clear(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SYMBOL_EDIT_FRAME::GetCurLib(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

SymbolLibTableName()

const wxString PROJECT::SymbolLibTableName ( ) const

virtual

Return the path and file name of this projects symbol library table.

Definition at line 140 of file project.cpp.

{
    return libTableName( "sym-lib-table" );
}

References libTableName().

TextVarResolver()

bool PROJECT::TextVarResolver ( wxString *  aToken ) const

virtual

Definition at line 66 of file project.cpp.

{
    if( GetTextVars().count( *aToken ) > 0 )
    {
        *aToken = GetTextVars().at( *aToken );
        return true;
    }

    return false;
}

References GetTextVars().

Referenced by ExpandTextVars(), and KIwxExpandEnvVars().

Friends And Related Function Documentation

SETTINGS_MANAGER

friend class SETTINGS_MANAGER

friend

Definition at line 301 of file project.h.

TEST_NETLISTS_FIXTURE

friend class TEST_NETLISTS_FIXTURE

friend

Definition at line 302 of file project.h.

Member Data Documentation

m_elems

_ELEM* PROJECT::m_elems[ELEM_COUNT]

private

See also

this::Elem() and enum ELEM_T.

Definition at line 360 of file project.h.

Referenced by ElemsClear(), GetElem(), PROJECT(), and SetElem().

m_localSettings

PROJECT_LOCAL_SETTINGS* PROJECT::m_localSettings

private

Backing store for project local settings – owned by SETTINGS_MANAGER.

Definition at line 352 of file project.h.

Referenced by GetLocalSettings(), and setLocalSettings().

m_pro_date_and_time

wxString PROJECT::m_pro_date_and_time

private

True if the project is read-only: no project files will be written.

Definition at line 343 of file project.h.

m_project_name

wxFileName PROJECT::m_project_name

private

<fullpath>/<basename>.pro

Definition at line 342 of file project.h.

Referenced by GetProjectFullName(), GetProjectName(), GetProjectPath(), IsNullProject(), and setProjectFullName().

m_projectFile

PROJECT_FILE* PROJECT::m_projectFile

private

Backing store for project data – owned by SETTINGS_MANAGER.

Definition at line 349 of file project.h.

Referenced by GetProjectFile(), and setProjectFile().

m_readOnly

bool PROJECT::m_readOnly

private

Definition at line 346 of file project.h.

Referenced by IsReadOnly(), and SetReadOnly().

m_rstrings

wxString PROJECT::m_rstrings[RSTRING_COUNT]

private

See also

this::SetRString(), GetRString(), and enum RSTRING_T.

Definition at line 357 of file project.h.

Referenced by GetRString(), and SetRString().

m_sheetNames

std::map<KIID, wxString> PROJECT::m_sheetNames

private

Definition at line 354 of file project.h.

Referenced by GetSheetName().

---

The documentation for this class was generated from the following files:

• project.h
• project.cpp
• pcb_base_frame.cpp