project.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2022 KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2022 CERN
 *
 * 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
 */
#ifndef PROJECT_H_
#define PROJECT_H_
 
#include <map>
#include <vector>
#include <kiid.h>
#include <wx_filename.h>
#include <wx/string.h>
#include <core/typeinfo.h>
 
#define PROJECT_VAR_NAME wxT( "KIPRJMOD" )
 
#define NAMELESS_PROJECT _( "untitled" )
 
class wxConfigBase;
class PARAM_CFG;
class FP_LIB_TABLE;
class SYMBOL_LIBS;
class SEARCH_STACK;
class S3D_CACHE;
class KIWAY;
class SYMBOL_LIB_TABLE;
class FILENAME_RESOLVER;
class PROJECT_FILE;
class PROJECT_LOCAL_SETTINGS;
 
 
class PROJECT
{
public:
 class _ELEM
 {
 public:
 virtual ~_ELEM() {}
 
 virtual KICAD_T Type() = 0; // Sanity-checking for returned values.
 };
 
 PROJECT();
 virtual ~PROJECT();
 
 //-----<Cross Module API>----------------------------------------------------
 
 virtual bool TextVarResolver( wxString* aToken ) const;
 
 virtual std::map<wxString, wxString>& GetTextVars() const;
 
 virtual const wxString GetProjectFullName() const;
 
 virtual const wxString GetProjectPath() const;
 
 virtual const wxString GetProjectName() const;
 
 virtual bool IsNullProject() const;
 
 virtual bool IsReadOnly() const { return m_readOnly || IsNullProject(); }
 
 virtual void SetReadOnly( bool aReadOnly = true ) { m_readOnly = aReadOnly; }
 
 virtual const wxString GetSheetName( const KIID& aSheetID );
 
 virtual const wxString FootprintLibTblName() const;
 
 virtual const wxString SymbolLibTableName() const;
 
 void PinLibrary( const wxString& aLibrary, bool isSymbolLibrary );
 void UnpinLibrary( const wxString& aLibrary, bool isSymbolLibrary );
 
 virtual PROJECT_FILE& GetProjectFile() const
 {
 wxASSERT( m_projectFile );
 return *m_projectFile;
 }
 
 virtual PROJECT_LOCAL_SETTINGS& GetLocalSettings() const
 {
 wxASSERT( m_localSettings );
 return *m_localSettings;
 }
 
 enum RSTRING_T
 {
 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
 };
 
 virtual const wxString& GetRString( RSTRING_T aStringId );
 
 virtual void SetRString( RSTRING_T aStringId, const wxString& aString );
 
 enum ELEM_T
 {
 ELEM_FPTBL,
 
 ELEM_SCH_SYMBOL_LIBS,
 ELEM_SCH_SEARCH_STACK,
 ELEM_3DCACHE,
 ELEM_SYMBOL_LIB_TABLE,
 
 ELEM_COUNT
 };
 
 virtual _ELEM* GetElem( ELEM_T aIndex );
 virtual void SetElem( ELEM_T aIndex, _ELEM* aElem );
 
 virtual void ElemsClear();
 
 void Clear() // inline not virtual
 {
 ElemsClear();
 
 for( unsigned i = 0; i<RSTRING_COUNT; ++i )
 SetRString( RSTRING_T( i ), wxEmptyString );
 }
 
 virtual const wxString AbsolutePath( const wxString& aFileName ) const;
 
 virtual FP_LIB_TABLE* PcbFootprintLibs( KIWAY& aKiway );
 
 // These are the non-virtual DATA LOAD ON DEMAND members. They load project related
 // data on demand, and do so typically into m_elems[] at a particular index using
 // SetElem() & GetElem(). That is, they wrap SetElem() and GetElem().
 // To get the data to reload on demand, first SetProjectFullName(),
 // then call SetElem( ELEM_T, NULL ) from client code.
 
 // non-virtuals resident in PCBNEW link image(s). By being non-virtual, these
 // functions can get linked into the KIFACE that needs them, and only there.
 // In fact, the other KIFACEs don't even know they exist.
#if defined( PCBNEW ) || defined( CVPCB )
 FP_LIB_TABLE* PcbFootprintLibs();
 
 S3D_CACHE* Get3DCacheManager( bool updateProjDir = false );
 
 void Cleanup3DCache();
 
 FILENAME_RESOLVER* Get3DFilenameResolver();
#endif
 
 
#if defined( EESCHEMA )
 // These are all prefaced with "Sch"
 SYMBOL_LIBS* SchLibs();
 
 SEARCH_STACK* SchSearchS();
 
 SYMBOL_LIB_TABLE* SchSymbolLibTable();
 
 FILENAME_RESOLVER* Get3DFilenameResolver() { return nullptr; }
#endif
 
private:
 friend class SETTINGS_MANAGER; // so that SM can set project path
 friend class TEST_NETLISTS_FIXTURE; // TODO(JE) make this not required
 
 virtual void setProjectFullName( const wxString& aFullPathAndName );
 
 virtual void setProjectFile( PROJECT_FILE* aFile )
 {
 m_projectFile = aFile;
 }
 
 virtual void setLocalSettings( PROJECT_LOCAL_SETTINGS* aSettings )
 {
 m_localSettings = aSettings;
 }
 
 const wxString libTableName( const wxString& aLibTableName ) const;
 
 wxFileName m_project_name; 
 wxString m_pro_date_and_time;
 
 bool m_readOnly;
 
 PROJECT_FILE* m_projectFile;
 
 PROJECT_LOCAL_SETTINGS* m_localSettings;
 
 std::map<KIID, wxString> m_sheetNames;
 
 wxString m_rstrings[RSTRING_COUNT];
 
 _ELEM* m_elems[ELEM_COUNT];
};
 
 
#endif // PROJECT_H_