SCRATCH_PROJECT Class Reference

Move-only RAII wrapper for "load a foreign PROJECT non-active and unload it on scope exit. More...

#include <scratch_doc.h>

Public Member Functions
	SCRATCH_PROJECT ()=default
	SCRATCH_PROJECT (SETTINGS_MANAGER &aMgr, const wxString &aDocOrProjectPath, bool aRequireProjectFile=false)
	~SCRATCH_PROJECT ()
	SCRATCH_PROJECT (const SCRATCH_PROJECT &)=delete
SCRATCH_PROJECT &	operator= (const SCRATCH_PROJECT &)=delete
	SCRATCH_PROJECT (SCRATCH_PROJECT &&aOther) noexcept
SCRATCH_PROJECT &	operator= (SCRATCH_PROJECT &&aOther) noexcept
PROJECT *	GetProject () const
bool	IsValid () const
	True iff the project loaded (or was already loaded).

Private Member Functions
void	release ()

Private Attributes
SETTINGS_MANAGER *	m_mgr = nullptr
PROJECT *	m_project = nullptr
bool	m_owned = false

Detailed Description

Move-only RAII wrapper for "load a foreign PROJECT non-active and unload it on scope exit.

" Project-only counterpart to SCRATCH_DOC (which adds a dependent document); use when only the project's settings are needed.

The aRequireProjectFile flag splits two real use cases. The diff/merge JOB handlers load from temp blobs that often have no sibling .kicad_pro, so they pass false and accept a SETTINGS_MANAGER defaults-only slot. The Import-Settings dialogs pass true because a missing .kicad_pro means there's no meaningful settings source to import from.

If the project was already loaded in the SETTINGS_MANAGER before the wrapper was constructed, the destructor leaves it alone so the slot belongs to whoever opened it first.

Definition at line 54 of file scratch_doc.h.

Constructor & Destructor Documentation

SCRATCH_PROJECT() [1/4]

SCRATCH_PROJECT::SCRATCH_PROJECT ( )

default

Referenced by operator=(), operator=(), SCRATCH_PROJECT(), and SCRATCH_PROJECT().

SCRATCH_PROJECT() [2/4]

SCRATCH_PROJECT::SCRATCH_PROJECT ( SETTINGS_MANAGER & aMgr, const wxString & aDocOrProjectPath, bool aRequireProjectFile = false )

inline

Definition at line 59 of file scratch_doc.h.

References SETTINGS_MANAGER::GetProject(), SETTINGS_MANAGER::LoadProject(), m_mgr, m_owned, m_project, FILEEXT::ProjectFileExtension, and release().

~SCRATCH_PROJECT()

SCRATCH_PROJECT::~SCRATCH_PROJECT ( )

inline

Definition at line 102 of file scratch_doc.h.

References release().

SCRATCH_PROJECT() [3/4]

SCRATCH_PROJECT::SCRATCH_PROJECT ( const SCRATCH_PROJECT & )

delete

References SCRATCH_PROJECT().

SCRATCH_PROJECT() [4/4]

SCRATCH_PROJECT::SCRATCH_PROJECT ( SCRATCH_PROJECT && aOther )

inlinenoexcept

Definition at line 107 of file scratch_doc.h.

References SCRATCH_PROJECT().

Member Function Documentation

GetProject()

PROJECT * SCRATCH_PROJECT::GetProject ( ) const

inline

Definition at line 123 of file scratch_doc.h.

References m_project.

Referenced by DIALOG_BOARD_SETUP::onAuxiliaryAction(), and DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction().

IsValid()

bool SCRATCH_PROJECT::IsValid ( ) const

inline

True iff the project loaded (or was already loaded).

False on parse failure or, when require-file was set, on missing .kicad_pro.

Definition at line 127 of file scratch_doc.h.

References m_project.

Referenced by DIALOG_BOARD_SETUP::onAuxiliaryAction(), and DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction().

operator=() [1/2]

SCRATCH_PROJECT & SCRATCH_PROJECT::operator= ( const SCRATCH_PROJECT & )

delete

References SCRATCH_PROJECT().

operator=() [2/2]

SCRATCH_PROJECT & SCRATCH_PROJECT::operator= ( SCRATCH_PROJECT && aOther )

inlinenoexcept

Definition at line 109 of file scratch_doc.h.

References m_mgr, m_owned, m_project, release(), and SCRATCH_PROJECT().

release()

void SCRATCH_PROJECT::release ( )

inlineprivate

Definition at line 130 of file scratch_doc.h.

References m_mgr, m_owned, and m_project.

Referenced by operator=(), SCRATCH_PROJECT(), and ~SCRATCH_PROJECT().

Member Data Documentation

m_mgr

SETTINGS_MANAGER* SCRATCH_PROJECT::m_mgr = nullptr

private

Definition at line 138 of file scratch_doc.h.

Referenced by operator=(), release(), and SCRATCH_PROJECT().

m_owned

bool SCRATCH_PROJECT::m_owned = false

private

Definition at line 140 of file scratch_doc.h.

Referenced by operator=(), release(), and SCRATCH_PROJECT().

m_project

PROJECT* SCRATCH_PROJECT::m_project = nullptr

private

Definition at line 139 of file scratch_doc.h.

Referenced by GetProject(), IsValid(), operator=(), release(), and SCRATCH_PROJECT().

---

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

• scratch_doc.h