FileSystemUtils.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
 
#if defined(FILE_SYSTEM_UTILS_ENABLED)
 
#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_FILESYSTEM_FILESYSTEMUTILS_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_FILESYSTEM_FILESYSTEMUTILS_H_
 
#include <string>
#include <vector>
 
namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace filesystem {
 
using Permissions = uint32_t;
 
enum PermBits : Permissions {
    NO_PERM = 0000,
 
    // Owner permissions
    OWNER_ALL = 0700,
    OWNER_READ = 0400,
    OWNER_WRITE = 0200,
    OWNER_EXEC = 0100,
 
    // Group permissions
    GROUP_ALL = 0070,
    GROUP_READ = 0040,
    GROUP_WRITE = 0020,
    GROUP_EXEC = 0010,
 
    // Everyone else's permissions
    OTHERS_ALL = 0007,
    OTHERS_READ = 0004,
    OTHERS_WRITE = 0002,
    OTHERS_EXEC = 0001
};
 
extern const Permissions DEFAULT_DIRECTORY_PERMISSIONS;
extern const Permissions DEFAULT_FILE_PERMISSIONS;
 
enum class FileType { REGULAR_FILE, DIRECTORY, ALL };
 
bool changePermissions(const std::string& path, Permissions perms);
 
bool exists(const std::string& path);
 
std::string currentDirectory();
 
bool makeDirectory(const std::string& path, Permissions perms = DEFAULT_DIRECTORY_PERMISSIONS);
 
std::vector<std::string> list(const std::string& path, FileType type = FileType::ALL);
 
bool move(const std::string& source, const std::string& destination);
 
std::string basenameOf(const std::string& path);
 
std::string parentDirNameOf(const std::string& path);
 
bool removeAll(const std::string& path);
 
size_t sizeOf(const std::string& path);
 
size_t availableSpace(const std::string& path);
 
bool pathContainsPrefix(const std::string& path, const std::string& prefix);
 
}  // namespace filesystem
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK
 
#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_FILESYSTEM_FILESYSTEMUTILS_H_
 
#endif  // FILE_SYSTEM_UTILS_ENABLED