mirror of
https://github.com/cookiengineer/audacity
synced 2025-07-19 14:17:41 +02:00
3bb04245c5
... Strong, meaning that the file at the specified path is created or modified only if all write operations complete without exceptions, barring one very unlikely possibility that a final file rename fails, but even in that case the output is successfully written to some path. This commit does not add throws, but changes the type thrown to a subclass of AudacityException, so that GuardedCall will cause the user to see an error dialog in all cases. Duplicated logic for making temporary files and backups is now all in one place, the class XMLWriter. There may be more new GuardedCalls than necessary -- the catch-all for the event loop, AudacityApp::OnExceptionInMainLoop, might be trusted instead in some cases -- but they are sufficient.
123 lines
3.5 KiB
C++
123 lines
3.5 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
Audacity(R) is copyright (c) 1999-2010 Audacity Team.
|
|
License: GPL v2. See License.txt.
|
|
|
|
AutoRecovery.h
|
|
|
|
*******************************************************************/
|
|
|
|
#ifndef __AUDACITY_AUTORECOVERY__
|
|
#define __AUDACITY_AUTORECOVERY__
|
|
|
|
#include "Project.h"
|
|
|
|
#include "xml/XMLTagHandler.h"
|
|
#include "xml/XMLWriter.h"
|
|
|
|
#include <wx/debug.h>
|
|
#include <wx/dynarray.h>
|
|
#include <wx/ffile.h>
|
|
#include <wx/hashmap.h>
|
|
#include <wx/mstream.h>
|
|
|
|
//
|
|
// Show auto recovery dialog if there are projects to recover. Should be
|
|
// called once at Audacity startup.
|
|
//
|
|
// This function possibly opens NEW project windows while it recovers all
|
|
// projects. If so, it will re-use *pproj, if != NULL and set it to NULL.
|
|
//
|
|
// Returns: True, if the start of Audacity should continue as normal
|
|
// False if Audacity should be quit immediately
|
|
//
|
|
// The didRecoverAnything param is strictly for a return value.
|
|
// Any value passed in is ignored.
|
|
//
|
|
bool ShowAutoRecoveryDialogIfNeeded(AudacityProject** pproj,
|
|
bool *didRecoverAnything);
|
|
|
|
//
|
|
// XML Handler for a <recordingrecovery> tag
|
|
//
|
|
class RecordingRecoveryHandler final : public XMLTagHandler
|
|
{
|
|
public:
|
|
RecordingRecoveryHandler(AudacityProject* proj);
|
|
bool HandleXMLTag(const wxChar *tag, const wxChar **attrs) override;
|
|
void HandleXMLEndTag(const wxChar *tag) override;
|
|
XMLTagHandler *HandleXMLChild(const wxChar *tag) override;
|
|
|
|
// This class only knows reading tags
|
|
|
|
private:
|
|
|
|
int FindTrack() const;
|
|
|
|
AudacityProject* mProject;
|
|
int mChannel;
|
|
int mNumChannels;
|
|
int mAutoSaveIdent;
|
|
};
|
|
|
|
///
|
|
/// AutoSaveFile
|
|
///
|
|
|
|
// Should be plain ASCII
|
|
#define AutoSaveIdent "<?xml autosave>"
|
|
|
|
WX_DECLARE_STRING_HASH_MAP_WITH_DECL(short, NameMap, class AUDACITY_DLL_API);
|
|
WX_DECLARE_HASH_MAP_WITH_DECL(short, wxString, wxIntegerHash, wxIntegerEqual, IdMap, class AUDACITY_DLL_API);
|
|
WX_DECLARE_OBJARRAY_WITH_DECL(IdMap, IdMapArray, class AUDACITY_DLL_API);
|
|
|
|
// This class's overrides do NOT throw AudacityException.
|
|
class AUDACITY_DLL_API AutoSaveFile final : public XMLWriter
|
|
{
|
|
public:
|
|
|
|
AutoSaveFile(size_t allocSize = 1024 * 1024);
|
|
virtual ~AutoSaveFile();
|
|
|
|
void StartTag(const wxString & name) override;
|
|
void EndTag(const wxString & name) override;
|
|
|
|
void WriteAttr(const wxString & name, const wxString &value) override;
|
|
void WriteAttr(const wxString & name, const wxChar *value) override;
|
|
|
|
void WriteAttr(const wxString & name, int value) override;
|
|
void WriteAttr(const wxString & name, bool value) override;
|
|
void WriteAttr(const wxString & name, long value) override;
|
|
void WriteAttr(const wxString & name, long long value) override;
|
|
void WriteAttr(const wxString & name, size_t value) override;
|
|
void WriteAttr(const wxString & name, float value, int digits = -1) override;
|
|
void WriteAttr(const wxString & name, double value, int digits = -1) override;
|
|
|
|
void WriteData(const wxString & value) override;
|
|
void Write(const wxString & data) override;
|
|
|
|
// Non-override functions
|
|
void WriteSubTree(const AutoSaveFile & value);
|
|
|
|
bool Write(wxFFile & file) const;
|
|
bool Append(wxFFile & file) const;
|
|
|
|
bool IsEmpty() const;
|
|
|
|
bool Decode(const wxString & fileName);
|
|
|
|
private:
|
|
void WriteName(const wxString & name);
|
|
void CheckSpace(wxMemoryOutputStream & buf);
|
|
|
|
private:
|
|
wxMemoryOutputStream mBuffer;
|
|
wxMemoryOutputStream mDict;
|
|
NameMap mNames;
|
|
size_t mAllocSize;
|
|
};
|
|
|
|
|
|
#endif
|