PROJECT Class Reference

PROJECT holds 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_PART, 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_PART_LIBS, ELEM_SCH_SEARCH_STACK, ELEM_3DCACHE,   ELEM_SYMBOL_LIB_TABLE, ELEM_COUNT }
	Enum ELEM_T is the set of _ELEMs that a PROJECT can hold. More...

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

Private Member Functions
VTBL_ENTRY void	setProjectFullName (const wxString &aFullPathAndName)
	Sets the: 1) full directory, 2) basename, and 3) extension of the project. More...
VTBL_ENTRY void	setProjectFile (PROJECT_FILE *aFile)
	Sets the backing store file for this project Should only be called by SETTINGS_MANGER on load. More...
VTBL_ENTRY void	setLocalSettings (PROJECT_LOCAL_SETTINGS *aSettings)
	Sets 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
bool	m_readOnly
	True if the project is read-only: no project files will be written More...
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

PROJECT holds project specific data.

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

Definition at line 63 of file project.h.

Member Enumeration Documentation

ELEM_T

enum PROJECT::ELEM_T

Enum ELEM_T is the set of _ELEMs that a PROJECT can hold.

Enumerator
ELEM_FPTBL
ELEM_SCH_PART_LIBS
ELEM_SCH_SEARCH_STACK
ELEM_3DCACHE
ELEM_SYMBOL_LIB_TABLE
ELEM_COUNT

Definition at line 197 of file project.h.

    {
        ELEM_FPTBL,

        ELEM_SCH_PART_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_PART
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 156 of file project.h.

    {
        DOC_PATH,
        SCH_LIB_PATH,
        SCH_LIB_SELECT,         // eeschema/selpart.cpp
        SCH_LIBEDIT_CUR_LIB,
        SCH_LIBEDIT_CUR_PART,        // 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

(

)

Definition at line 60 of file project.cpp.

{
    ElemsClear();
}

References ElemsClear().

Member Function Documentation

AbsolutePath()

const wxString PROJECT::AbsolutePath

(

const wxString &

aFileName

)

const

Function AbsolutePath fixes 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 270 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 DIALOG_PLOT_SCHEMATIC::createPlotFileName(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::SaveEEFile(), SCH_EDIT_FRAME::SaveProject(), and WriteDRCReport().

Clear()

void PROJECT::Clear ( )

inline

Function Clear clears the _ELEMs and RSTRINGs.

Definition at line 231 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

(

)

Function ElemsClear deletes 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 ), NULL );
    }
}

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

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

FootprintLibTblName()

const wxString PROJECT::FootprintLibTblName

(

)

const

Function FootprintLibTblName returns the path and filename of this project's fp-lib-table, i.e.

the project specific one, not the global one.

Definition at line 146 of file project.cpp.

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

References libTableName().

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

GetElem()

PROJECT::_ELEM * PROJECT::GetElem

(

ELEM_T

aIndex

)

Typically wrapped somewhere else in a more meaningful function wrapper.

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: 1) cross module API, 2) 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 NULL;
}

References arrayDim(), m_elems, and NULL.

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

GetLocalSettings()

VTBL_ENTRY PROJECT_LOCAL_SETTINGS& PROJECT::GetLocalSettings ( ) const

inline

Definition at line 149 of file project.h.

    {
        wxASSERT( m_localSettings );
        return *m_localSettings;
    }

References m_localSettings.

Referenced by BOARD::GetVisibleElements(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LoadBoard(), 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(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_BASE_FRAME::SaveSettings(), BOARD::SetElementVisibility(), BOARD::SetVisibleLayers(), and SETTINGS_MANAGER::unloadProjectFile().

GetProjectFile()

VTBL_ENTRY PROJECT_FILE& PROJECT::GetProjectFile ( ) const

inline

Definition at line 143 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(), SCHEMATIC::ErcSettings(), PCB_EDIT_FRAME::GetLastPath(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), GetSheetName(), GetTextVars(), inheritNetclass(), DIALOG_CONFIG_EQUFILES::Init(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PART_LIBS::LibNamesAndPaths(), PCB_EDIT_FRAME::LoadProjectSettings(), 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(), 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

Function GetProjectFullName returns the full path and name of the project.

This is the same as the name of the *.pro file 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(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_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(), PART_LIBS::LoadAllLibraries(), SETTINGS_MANAGER::loadProjectFile(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::SaveProjectAs(), PCB_EDIT_FRAME::SaveProjectSettings(), setProjectFullName(), EDA_3D_VIEWER::takeScreenshot(), SETTINGS_MANAGER::UnloadProject(), and SETTINGS_MANAGER::unloadProjectFile().

GetProjectName()

const wxString PROJECT::GetProjectName

(

)

const

Function GetProjectName returns 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 SCH_ALTIUM_PLUGIN::getLibName(), SETTINGS_MANAGER::GetProjectBackupsPath(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), KICAD_MANAGER_CONTROL::SaveProjectAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), SETTINGS_MANAGER::TriggerBackupIfNeeded(), and FOOTPRINT_EDIT_FRAME::updateTitle().

GetProjectPath()

const wxString PROJECT::GetProjectPath

(

)

const

Function GetProjectPath returns the full path of the project.

This is the path of the *.pro file and will always be an absolute path, ending by a dir separator.

Definition at line 122 of file project.cpp.

{
    return m_project_name.GetPathWithSep();
}

References m_project_name.

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::ExportVRML_File(), FOOTPRINT_LIST::GetInstance(), SCH_ALTIUM_PLUGIN::getLibFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetProjectBackupsPath(), PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), NormalizePath(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SPICE_MODEL::onSelectLibrary(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDITOR_CONTROL::Paste(), PathIsInsideProject(), ResolveFile(), FILENAME_RESOLVER::SetProject(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SCH_EDIT_FRAME::WriteNetListFile(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GetRString()

const wxString & PROJECT::GetRString

(

RSTRING_T

aStringId

)

Function GetRString returns 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(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SaveOneSymbol(), and SYMBOL_EDIT_FRAME::SelectLibraryFromList().

GetSheetName()

const wxString PROJECT::GetSheetName

(

const KIID &

aSheetID

)

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

Definition at line 78 of file project.cpp.

{
    return GetProjectFile().m_TextVars;
}

References GetProjectFile(), and PROJECT_FILE::m_TextVars.

Referenced by NETLIST_EXPORTER_XML::makeDesignHeader(), PROPERTIES_FRAME::onScintillaCharAdded(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), BOARD::SynchronizeProperties(), TextVarResolver(), PANEL_TEXT_VARIABLES::TransferDataFromWindow(), and PANEL_TEXT_VARIABLES::TransferDataToWindow().

IsNullProject()

bool PROJECT::IsNullProject

(

)

const

Checks 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 a bull project

Definition at line 134 of file project.cpp.

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

References m_project_name.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), AskSaveBoardFileName(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), IsReadOnly(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::SaveProject(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

IsReadOnly()

VTBL_ENTRY bool PROJECT::IsReadOnly ( ) const

inline

Definition at line 122 of file project.h.

{ return m_readOnly || IsNullProject(); }

References IsNullProject(), and m_readOnly.

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().

Referenced by FootprintLibTblName(), and SymbolLibTableName().

PcbFootprintLibs()

FP_LIB_TABLE * PROJECT::PcbFootprintLibs

(

KIWAY &

aKiway

)

Return the table of footprint libraries.

Requires an active Kiway as this is fetched from pcbnew.

Definition at line 284 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( NULL, _( "Error loading project footprint library table" ),
                                 ioe.What() );
        }
        catch( ... )
        {
            DisplayErrorMessage( NULL, _( "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(), NULL, SetElem(), FP_LIB_TABLE::Type(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), GetFootprintLibraryTable(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), 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(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDITOR_TOOLS::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(), 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
	)

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(), TEST_NETLISTS_FIXTURE::loadSchematic(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), PcbFootprintLibs(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

setLocalSettings()

VTBL_ENTRY void PROJECT::setLocalSettings ( PROJECT_LOCAL_SETTINGS *  aSettings )

inlineprivate

Sets the local settings backing store.

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 328 of file project.h.

    {
        m_localSettings = aSettings;
    }

References m_localSettings.

setProjectFile()

VTBL_ENTRY void PROJECT::setProjectFile ( PROJECT_FILE *  aFile )

inlineprivate

Sets the backing store file for this project Should only be called by SETTINGS_MANGER on load.

Parameters

aFile

is a loaded PROJECT_FILE

Definition at line 319 of file project.h.

    {
        m_projectFile = aFile;
    }

References m_projectFile.

Referenced by SETTINGS_MANAGER::loadProjectFile().

setProjectFullName()

void PROJECT::setProjectFullName ( const wxString &  aFullPathAndName )

private

Sets the: 1) full directory, 2) basename, and 3) extension of the project.

This is the name of the *.pro file with full absolute path and it also defines the name of the project. The project name and the *.pro file names are exactly the same, providing the *.pro 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, PROJECT_VAR_NAME, ProjectFileExtension, TO_UTF8, and tracePathsAndFiles.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

SetReadOnly()

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

inline

Definition at line 124 of file project.h.

{ m_readOnly = aReadOnly; }

References m_readOnly.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::Save_File().

SetRString()

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

Function SetRString stores 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(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SaveOneSymbol(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), and SYMBOL_EDIT_FRAME::SetCurPart().

SymbolLibTableName()

const wxString PROJECT::SymbolLibTableName

(

)

const

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

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 65 of file project.h.

TEST_NETLISTS_FIXTURE

friend class TEST_NETLISTS_FIXTURE

friend

Definition at line 66 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 356 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 348 of file project.h.

Referenced by GetLocalSettings(), and setLocalSettings().

m_pro_date_and_time

wxString PROJECT::m_pro_date_and_time

private

Definition at line 339 of file project.h.

m_project_name

wxFileName PROJECT::m_project_name

private

<fullpath>/<basename>.pro

Definition at line 338 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 345 of file project.h.

Referenced by GetProjectFile(), and setProjectFile().

m_readOnly

bool PROJECT::m_readOnly

private

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

Definition at line 342 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 353 of file project.h.

Referenced by GetRString(), and SetRString().

m_sheetNames

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

private

Definition at line 350 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