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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*
* 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>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace XBMCAddon
{
namespace xbmcvfs
{
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
//
/// \defgroup python_xbmcvfs Library - xbmcvfs
/// @{
/// @brief **Virtual file system functions on Kodi.**
///
/// Offers classes and functions offers acces to the Virtual File Server
/// (VFS) which you can use to manipulate files and folders.
//
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.copy(source, destination) }
///-------------------------------------------------------------------------
/// Copy file to destination, returns true/false.
///
/// @param source file to copy.
/// @param destination destination file
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.copy(source, destination)
/// ..
/// ~~~~~~~~~~~~~
///
copy(...);
#else
bool copy(const String& strSource, const String& strDestnation);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.delete(file) }
///-------------------------------------------------------------------------
/// @brief Delete a file
///
/// @param file File to delete
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// xbmcvfs.delete(file)
/// ..
/// ~~~~~~~~~~~~~
///
deleteFile(...);
#else
bool deleteFile(const String& file);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.rename(file, newFileName) }
///-------------------------------------------------------------------------
/// @brief Rename a file
///
/// @param file File to rename
/// @param newFileName New filename, including the full path
/// @return True if successed
///
/// @note Moving files between different filesystem (eg. local to nfs://) is not possible on
/// all platforms. You may have to do it manually by using the copy and deleteFile functions.
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.rename(file,newFileName)
/// ..
/// ~~~~~~~~~~~~~
///
rename(...);
#else
bool rename(const String& file, const String& newFile);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.exists(path) }
///-------------------------------------------------------------------------
/// @brief Check for a file or folder existance
///
/// @param path File or folder (folder must end with
/// slash or backslash)
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.exists(path)
/// ..
/// ~~~~~~~~~~~~~
///
exists(...);
#else
bool exists(const String& path);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.mkdir(path) }
///-------------------------------------------------------------------------
/// Create a folder.
///
/// @param path Folder to create
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.mkdir(path)
/// ..
/// ~~~~~~~~~~~~~
///
mkdir(...);
#else
bool mkdir(const String& path);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.mkdirs(path) }
///-------------------------------------------------------------------------
/// Make all directories along the path
///
/// Create folder(s) - it will create all folders in the path.
///
/// @param path Folders to create
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.mkdirs(path)
/// ..
/// ~~~~~~~~~~~~~
///
mkdirs(...);
#else
bool mkdirs(const String& path);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.rmdir(path) }
///-------------------------------------------------------------------------
/// Remove a folder.
///
/// @param path Folder to remove
/// @return True if successed
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// success = xbmcvfs.rmdir(path)
/// ..
/// ~~~~~~~~~~~~~
///
rmdir(...);
#else
bool rmdir(const String& path, bool force = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcvfs
/// @brief \python_func{ xbmcvfs.listdir(path) }
///-------------------------------------------------------------------------
/// Lists content of a folder.
///
/// @param path Folder to get list from
/// @return Directory content list
///
///
/// ------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dirs, files = xbmcvfs.listdir(path)
/// ..
/// ~~~~~~~~~~~~~
///
listdir(...);
#else
Tuple<std::vector<String>, std::vector<String> > listdir(const String& path);
#endif
//@}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
