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
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "AddonClass.h"
#include "LanguageHook.h"
#include "filesystem/File.h"
namespace XBMCAddon
{
namespace xbmcvfs
{
//
/// \defgroup python_stat Stat
/// \ingroup python_xbmcvfs
/// @{
/// @brief **Get file or file system status.**
///
/// \python_class{ xbmcvfs.Stat(path) }
///
/// These class return information about a file. Execute (search) permission
/// is required on all of the directories in path that lead to the file.
///
/// @param path [string] file or folder
///
///
/// ------------------------------------------------------------------------
/// @python_v12 New function added
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// st = xbmcvfs.Stat(path)
/// modified = st.st_mtime()
/// ..
/// ~~~~~~~~~~~~~
//
class Stat : public AddonClass
{
struct __stat64 st;
public:
Stat(const String& path)
{
DelayedCallGuard dg;
XFILE::CFile::Stat(path, &st);
}
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_mode() }
/// To get file protection.
///
/// @return st_mode
///
st_mode();
#else
inline long long st_mode() { return st.st_mode; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_ino() }
/// To get inode number.
///
/// @return st_ino
///
st_ino();
#else
inline long long st_ino() { return st.st_ino; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_dev() }
/// To get ID of device containing file.
///
/// The st_dev field describes the device on which this file resides.
///
/// @return st_dev
///
st_dev();
#else
inline long long st_dev() { return st.st_dev; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_nlink() }
/// To get number of hard links.
///
/// @return st_nlink
///
st_nlink();
#else
inline long long st_nlink() { return st.st_nlink; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_uid() }
/// To get user ID of owner.
///
/// @return st_uid
///
st_uid();
#else
inline long long st_uid() { return st.st_uid; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_gid() }
/// To get group ID of owner.
///
/// @return st_gid
///
st_gid();
#else
inline long long st_gid() { return st.st_gid; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_size() }
/// To get total size, in bytes.
///
/// The st_size field gives the size of the file (if it is a regular file
/// or a symbolic link) in bytes. The size of a symbolic link (only on
/// Linux and Mac OS X) is the length of the pathname it contains, without
/// a terminating null byte.
///
/// @return st_size
///
st_size();
#else
inline long long st_size() { return st.st_size; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_atime() }
/// To get time of last access.
///
/// @return st_atime
///
st_atime();
#else
inline long long atime() { return st.st_atime; }; //names st_atime/st_mtime/st_ctime are used by sys/stat.h
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_mtime() }
/// To get time of last modification.
///
/// @return st_mtime
///
st_mtime();
#else
inline long long mtime() { return st.st_mtime; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_stat
/// @brief \python_func{ st_ctime() }
/// To get time of last status change.
///
/// @return st_ctime
///
st_ctime();
#else
inline long long ctime() { return st.st_ctime; }
#endif
};
/// @}
}
}
|