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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (C) 2005-2013 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include "AddonString.h"
#include "Tuple.h"
#include <vector>
namespace XBMCAddon
{
namespace xbmcvfs
{
/**
* copy(source, destination) -- copy file to destination, returns true/false.
*
* source : file to copy.\n
* destination : destination file
*
* example:
* - success = xbmcvfs.copy(source, destination)
*/
bool copy(const String& strSource, const String& strDestnation);
// delete a file
/**
* delete(file)
*
* file : file to delete
*
* example:
* - xbmcvfs.delete(file)
*/
bool deleteFile(const String& file);
/**
* rename(file, newFileName)
*
* file : file to rename\n
* newFileName : new filename, including the full path
*
* *Note, moving files between different filesystem (eg. local to nfs://) is not possible on\n
* all platforms. You may have to do it manually by using the copy and deleteFile functions.\n
*
* example:
* - success = xbmcvfs.rename(file,newFileName)
*/
// rename a file
bool rename(const String& file, const String& newFile);
/**
* exists(path)
*
* path : file or folder (folder must end with slash or backslash)
*
* example:
* - success = xbmcvfs.exists(path)
*/
// check for a file or folder existance, mimics Pythons os.path.exists()
bool exists(const String& path);
/**
* mkdir(path) -- Create a folder.
*
* path : folder
*
* example:
* - success = xbmcvfs.mkdir(path)
*/
// make a directory
bool mkdir(const String& path);
/**
* mkdirs(path) -- Create folder(s) - it will create all folders in the path.
*
* path : folder
*
* example:
* - success = xbmcvfs.mkdirs(path)
*/
// make all directories along the path
bool mkdirs(const String& path);
/**
* rmdir(path) -- Remove a folder.
*
* path : folder
*
* example:
* - success = xbmcvfs.rmdir(path)
*/
bool rmdir(const String& path, bool force = false);
/**
* listdir(path) -- lists content of a folder.
*
* path : folder
*
* example:
* - dirs, files = xbmcvfs.listdir(path)
*/
Tuple<std::vector<String>, std::vector<String> > listdir(const String& path);
}
}
|
