ProjectFileIO::BackupProject Class Reference

#include <ProjectFileIO.h>

Public Member Functions
	BackupProject (ProjectFileIO &projectFileIO, const FilePath &path)
	Rename project file at path, and any auxiliary files, to backup path names. More...
bool	IsOk ()
	Returns false if the renaming in the constructor failed. More...
void	Discard ()
	if !IsOk() do nothing; else remove backup files More...
	~BackupProject ()
	if !IsOk() do nothing; else if Discard() was not called, undo the renaming More...

Private Attributes
FilePath	mPath
FilePath	mSafety

Detailed Description

Definition at line 190 of file ProjectFileIO.h.

Constructor & Destructor Documentation

BackupProject()

ProjectFileIO::BackupProject::BackupProject	(	ProjectFileIO &	projectFileIO,
		const FilePath &	path
	)

Rename project file at path, and any auxiliary files, to backup path names.

Definition at line 1371 of file ProjectFileIO.cpp.

{
   auto safety = SafetyFileName(path);
   if (!projectFileIO.MoveProject(path, safety))
      return;
 
   mPath = path;
   mSafety = safety;
}

References ProjectFileIO::MoveProject(), mPath, mSafety, and ProjectFileIO::SafetyFileName().

Here is the call graph for this function:

~BackupProject()

ProjectFileIO::BackupProject::~BackupProject

(

)

if !IsOk() do nothing; else if Discard() was not called, undo the renaming

Definition at line 1391 of file ProjectFileIO.cpp.

{
   if (!mPath.empty()) {
      if (!mSafety.empty()) {
         // Failed; restore from safety files
         auto suffixes = AuxiliaryFileSuffixes();
         suffixes.push_back({});
         for (const auto &suffix : suffixes) {
            auto path = mPath + suffix;
            if (wxFileExists(path))
               wxRemoveFile(path);
            wxRenameFile(mSafety + suffix, mPath + suffix);
         }
      }
   }
}

References ProjectFileIO::AuxiliaryFileSuffixes().

Here is the call graph for this function:

Member Function Documentation

Discard()

void ProjectFileIO::BackupProject::Discard

(

)

if !IsOk() do nothing; else remove backup files

Definition at line 1382 of file ProjectFileIO.cpp.

{
   if (!mPath.empty()) {
      // Succeeded; don't need the safety files
      RemoveProject(mSafety);
      mSafety.clear();
   }
}

References ProjectFileIO::RemoveProject().

Here is the call graph for this function:

IsOk()

bool ProjectFileIO::BackupProject::IsOk ( )

inline

Returns false if the renaming in the constructor failed.

Definition at line 195 of file ProjectFileIO.h.

{ return !mPath.empty(); }

Member Data Documentation

mPath

FilePath ProjectFileIO::BackupProject::mPath

private

Definition at line 201 of file ProjectFileIO.h.

Referenced by BackupProject().

mSafety

FilePath ProjectFileIO::BackupProject::mSafety

private

Definition at line 201 of file ProjectFileIO.h.

Referenced by BackupProject().

---

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

• ProjectFileIO.h
• ProjectFileIO.cpp