summaryrefslogtreecommitdiff
path: root/zen/recycler.h
blob: 3df7fda244f0199566bbe117e51e547e9f88d9bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl-3.0        *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved        *
// **************************************************************************

#ifndef RECYCLER_H_INCLUDED_18345067341545
#define RECYCLER_H_INCLUDED_18345067341545

#include <vector>
#include <functional>
#include "file_error.h"


namespace zen
{
/*
--------------------
|Recycle Bin Access|
--------------------

Windows
-------
-> Recycler API always available: during runtime either SHFileOperation or IFileOperation (since Vista) will be dynamically selected
-> COM needs to be initialized before calling any of these functions! CoInitializeEx/CoUninitialize

Linux
-----
Compiler flags: `pkg-config --cflags gio-2.0`
Linker   flags: `pkg-config --libs gio-2.0`

Already included in package "gtk+-2.0"!
*/



//move a file or folder to Recycle Bin (deletes permanently if recycler is not available) -> crappy semantics, but we have no choice thanks to Windows' design
bool recycleOrDelete(const Zstring& itemPath); //throw FileError, return "true" if file/dir was actually deleted


#ifdef ZEN_WIN
//Win XP: can take a long time if recycle bin is full and drive is slow!!! => buffer result!
//Vista and later: dirPath must exist for a valid check!
bool recycleBinExists(const Zstring& dirPath, const std::function<void ()>& onUpdateGui); //throw FileError

void recycleOrDelete(const std::vector<Zstring>& filePaths, //throw FileError, return "true" if file/dir was actually deleted
                     const std::function<void (const std::wstring& displayPath)>& onRecycleItem); //optional; currentItem may be empty
#endif
}

#endif //RECYCLER_H_INCLUDED_18345067341545
bgstack15