project.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
#ifndef PROJECT_H_
#define PROJECT_H_

#include <array>
#include <map>
#include <mutex>
#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" )
 
struct HISTORY_FILE_DATA;
class DESIGN_BLOCK_LIBRARY_ADAPTER;
class LEGACY_SYMBOL_LIBS;
class SEARCH_STACK;
class S3D_CACHE;
class KIWAY;
class FILENAME_RESOLVER;
class FOOTPRINT_LIBRARY_ADAPTER;
class PROJECT_FILE;
class PROJECT_LOCAL_SETTINGS;
class LOCKFILE;
 

class KICOMMON_API PROJECT
{
public:
    enum class ELEM
    {
        LEGACY_SYMBOL_LIBS,
        SCH_SEARCH_STACK,
        S3DCACHE,
        SEARCH_STACK,
 
        SCHEMATIC,
        BOARD,
 
        COUNT
    };

    class KICOMMON_API _ELEM
    {
    public:
        virtual ~_ELEM() {}
 
        virtual PROJECT::ELEM ProjectElementType() = 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 void ApplyTextVars( const std::map<wxString, wxString>& aVarsMap );
 
    int  GetTextVarsTicker() const { return m_textVarsTicker; }
    void IncrementTextVarsTicker() { m_textVarsTicker++; }
 
    int  GetNetclassesTicker() const { return m_netclassesTicker; }
    void IncrementNetclassesTicker() { m_netclassesTicker++; }

    virtual const wxString GetProjectFullName() const;

    virtual const wxString GetProjectPath() const;

    virtual const wxString GetProjectDirectory() 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 bool IsLockOverrideGranted() const { return m_lockOverrideGranted; }
 
    virtual void SetLockOverrideGranted( bool aGranted = true ) { m_lockOverrideGranted = aGranted; }

    virtual const wxString GetSheetName( const KIID& aSheetID );

    virtual const wxString FootprintLibTblName() const;

    virtual const wxString SymbolLibTableName() const;

    virtual const wxString DesignBlockLibTblName() const;
 
    enum LIB_TYPE_T
    {
        SYMBOL_LIB,
        FOOTPRINT_LIB,
        DESIGN_BLOCK_LIB,
 
        LIB_TYPE_COUNT
    };
 
    void PinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType );
    void UnpinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType );
 
    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_PATH,
        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 );

    virtual _ELEM* GetElem( PROJECT::ELEM aIndex );
    virtual void   SetElem( PROJECT::ELEM aIndex, _ELEM* aElem );

    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 FOOTPRINT_LIBRARY_ADAPTER* FootprintLibAdapter( KIWAY& aKiway );

    virtual DESIGN_BLOCK_LIBRARY_ADAPTER* DesignBlockLibs();
 
    void SetProjectLock( LOCKFILE* aLockFile );
 
    LOCKFILE* GetProjectLock() const;

    void SaveToHistory( const wxString& aProjectPath, std::vector<HISTORY_FILE_DATA>& aFileData );
 
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 elemsClear();

    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;
 
private:
    wxFileName      m_project_name;         
 
    bool            m_readOnly;             
    bool            m_lockOverrideGranted;  
    int             m_textVarsTicker;       
    int             m_netclassesTicker;     

    PROJECT_FILE*            m_projectFile;

    PROJECT_LOCAL_SETTINGS*  m_localSettings;
 
    std::map<KIID, wxString> m_sheetNames;

    std::array<wxString,RSTRING_COUNT> m_rstrings;

    std::array<_ELEM*,static_cast<unsigned int>( PROJECT::ELEM::COUNT )> m_elems;

    std::unique_ptr<LOCKFILE> m_project_lock;

    std::mutex m_designBlockLibsMutex;
};
 
 
#endif  // PROJECT_H_