Simple local history manager built on libgit2. More...

#include <local_history.h>

Static Public Member Functions
static bool	Init (const wxString &aProjectPath)
	Initialize the local history repository for the given project path.

static bool	CommitSnapshot (const std::vector< wxString > &aFiles, const wxString &aTitle)
	Commit the given files to the local history repository.

static bool	CommitFullProjectSnapshot (const wxString &aProjectPath, const wxString &aTitle)
	Commit a snapshot of the entire project directory (excluding the .history directory and ignored transient files) to the local history repository.

static void	RegisterSaver (const std::function< void(const wxString &, std::vector< wxString > &)> &aSaver)
	Register a saver callback invoked during autosave history commits.

static bool	RunRegisteredSaversAndCommit (const wxString &aProjectPath, const wxString &aTitle)
	Run all registered savers and, if any staged changes differ from HEAD, create a commit.

static void	NoteFileChange (const wxString &aFile)
	Record that a file has been modified and should be included in the next snapshot.

static bool	CommitPending ()
	Commit any pending modified files to the history repository.

static bool	HistoryExists (const wxString &aProjectPath)
	Return true if history exists for the project.

static bool	TagSave (const wxString &aProjectPath, const wxString &aFileType)
	Tag a manual save in the local history repository.

static bool	CommitDuplicateOfLastSave (const wxString &aProjectPath, const wxString &aFileType, const wxString &aMessage)
	Create a new commit duplicating the tree pointed to by Last_Save_<fileType> and move the Last_Save_<fileType> tag to the new commit (used when user discards changes).

static bool	EnforceSizeLimit (const wxString &aProjectPath, size_t aMaxBytes)
	Enforce total size limit by rebuilding trimmed history keeping newest commits whose cumulative unique blob sizes fit within limit.

static bool	HeadNewerThanLastSave (const wxString &aProjectPath)
	Return true if the autosave data is newer than the last manual save.

static wxString	GetHeadHash (const wxString &aProjectPath)
	Return the current head commit hash.

static bool	RestoreCommit (const wxString &aProjectPath, const wxString &aHash)
	Restore the project files to the state recorded by the given commit hash.

static void	ShowRestoreDialog (const wxString &aProjectPath, wxWindow *aParent)
	Show a dialog allowing the user to choose a snapshot to restore.

Detailed Description

Simple local history manager built on libgit2.

Stores history for project files in a hidden .history git repository within the project directory.

Definition at line 35 of file local_history.h.

Member Function Documentation

◆ CommitDuplicateOfLastSave()

bool LOCAL_HISTORY::CommitDuplicateOfLastSave	(	const wxString &	aProjectPath,
		const wxString &	aFileType,
		const wxString &	aMessage )

static

Create a new commit duplicating the tree pointed to by Last_Save_<fileType> and move the Last_Save_<fileType> tag to the new commit (used when user discards changes).

Definition at line 579 of file local_history.cpp.

References HISTORY_LOCK_MANAGER::GetRepository(), HISTORY_LOCK_MANAGER::IsLocked(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::canCloseWindow(), and SCH_EDIT_FRAME::canCloseWindow().