214 lines
7.1 KiB
C
214 lines
7.1 KiB
C
#ifndef AWS_COMMON_FILE_H
|
|
#define AWS_COMMON_FILE_H
|
|
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
#include <aws/common/byte_buf.h>
|
|
#include <aws/common/common.h>
|
|
#include <aws/common/platform.h>
|
|
#include <stdio.h>
|
|
|
|
AWS_PUSH_SANE_WARNING_LEVEL
|
|
|
|
#ifdef AWS_OS_WINDOWS
|
|
# define AWS_PATH_DELIM '\\'
|
|
# define AWS_PATH_DELIM_STR "\\"
|
|
#else
|
|
# define AWS_PATH_DELIM '/'
|
|
# define AWS_PATH_DELIM_STR "/"
|
|
#endif
|
|
|
|
struct aws_string;
|
|
struct aws_directory_iterator;
|
|
|
|
enum aws_file_type {
|
|
AWS_FILE_TYPE_FILE = 1,
|
|
AWS_FILE_TYPE_SYM_LINK = 2,
|
|
AWS_FILE_TYPE_DIRECTORY = 4,
|
|
};
|
|
|
|
struct aws_directory_entry {
|
|
/**
|
|
* Absolute path to the entry from the current process root.
|
|
*/
|
|
struct aws_byte_cursor path;
|
|
/**
|
|
* Path to the entry relative to the current working directory.
|
|
*/
|
|
struct aws_byte_cursor relative_path;
|
|
/**
|
|
* Bit-field of enum aws_file_type
|
|
*/
|
|
int file_type;
|
|
/**
|
|
* Size of the file on disk.
|
|
*/
|
|
int64_t file_size;
|
|
};
|
|
|
|
/**
|
|
* Invoked during calls to aws_directory_traverse() as an entry is encountered. entry will contain
|
|
* the parsed directory entry info.
|
|
*
|
|
* Return true to continue the traversal, or alternatively, if you have a reason to abort the traversal, return false.
|
|
*/
|
|
typedef bool(aws_on_directory_entry)(const struct aws_directory_entry *entry, void *user_data);
|
|
|
|
AWS_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* Deprecated - Use aws_fopen_safe() instead, avoid const char * in public APIs.
|
|
* Opens file at file_path using mode. Returns the FILE pointer if successful.
|
|
* Otherwise, aws_last_error() will contain the error that occurred
|
|
*/
|
|
AWS_COMMON_API FILE *aws_fopen(const char *file_path, const char *mode);
|
|
|
|
/**
|
|
* Opens file at file_path using mode. Returns the FILE pointer if successful.
|
|
* Otherwise, aws_last_error() will contain the error that occurred
|
|
*/
|
|
AWS_COMMON_API FILE *aws_fopen_safe(const struct aws_string *file_path, const struct aws_string *mode);
|
|
|
|
/**
|
|
* Creates a directory if it doesn't currently exist. If the directory already exists, it's ignored and assumed
|
|
* successful.
|
|
*
|
|
* Returns AWS_OP_SUCCESS on success. Otherwise, check aws_last_error().
|
|
*/
|
|
AWS_COMMON_API int aws_directory_create(const struct aws_string *dir_path);
|
|
/**
|
|
* Returns true if the directory currently exists. Otherwise, it returns false.
|
|
*/
|
|
AWS_COMMON_API bool aws_directory_exists(const struct aws_string *dir_path);
|
|
/**
|
|
* Deletes a directory. If the directory is not empty, this will fail unless the recursive parameter is set to true.
|
|
* If recursive is true then the entire directory and all of its contents will be deleted. If it is set to false,
|
|
* the directory will be deleted only if it is empty. Returns AWS_OP_SUCCESS if the operation was successful. Otherwise,
|
|
* aws_last_error() will contain the error that occurred. If the directory doesn't exist, AWS_OP_SUCCESS is still
|
|
* returned.
|
|
*/
|
|
AWS_COMMON_API int aws_directory_delete(const struct aws_string *dir_path, bool recursive);
|
|
/**
|
|
* Deletes a file. Returns AWS_OP_SUCCESS if the operation was successful. Otherwise,
|
|
* aws_last_error() will contain the error that occurred. If the file doesn't exist, AWS_OP_SUCCESS is still returned.
|
|
*/
|
|
AWS_COMMON_API int aws_file_delete(const struct aws_string *file_path);
|
|
|
|
/**
|
|
* Moves directory at from to to.
|
|
* Returns AWS_OP_SUCCESS if the operation was successful. Otherwise,
|
|
* aws_last_error() will contain the error that occurred.
|
|
*/
|
|
AWS_COMMON_API int aws_directory_or_file_move(const struct aws_string *from, const struct aws_string *to);
|
|
|
|
/**
|
|
* Traverse a directory starting at path.
|
|
*
|
|
* If you want the traversal to recurse the entire directory, pass recursive as true. Passing false for this parameter
|
|
* will only iterate the contents of the directory, but will not descend into any directories it encounters.
|
|
*
|
|
* If recursive is set to true, the traversal is performed post-order, depth-first
|
|
* (for practical reasons such as deleting a directory that contains subdirectories or files).
|
|
*
|
|
* returns AWS_OP_SUCCESS(0) on success.
|
|
*/
|
|
AWS_COMMON_API int aws_directory_traverse(
|
|
struct aws_allocator *allocator,
|
|
const struct aws_string *path,
|
|
bool recursive,
|
|
aws_on_directory_entry *on_entry,
|
|
void *user_data);
|
|
|
|
/**
|
|
* Creates a read-only iterator of a directory starting at path. If path is invalid or there's any other error
|
|
* condition, NULL will be returned. Call aws_last_error() for the exact error in that case.
|
|
*/
|
|
AWS_COMMON_API struct aws_directory_iterator *aws_directory_entry_iterator_new(
|
|
struct aws_allocator *allocator,
|
|
const struct aws_string *path);
|
|
|
|
/**
|
|
* Moves the iterator to the next entry. Returns AWS_OP_SUCCESS if another entry is available, or AWS_OP_ERR with
|
|
* AWS_ERROR_LIST_EMPTY as the value for aws_last_error() if no more entries are available.
|
|
*/
|
|
AWS_COMMON_API int aws_directory_entry_iterator_next(struct aws_directory_iterator *iterator);
|
|
|
|
/**
|
|
* Moves the iterator to the previous entry. Returns AWS_OP_SUCCESS if another entry is available, or AWS_OP_ERR with
|
|
* AWS_ERROR_LIST_EMPTY as the value for aws_last_error() if no more entries are available.
|
|
*/
|
|
AWS_COMMON_API int aws_directory_entry_iterator_previous(struct aws_directory_iterator *iterator);
|
|
|
|
/**
|
|
* Cleanup and deallocate iterator
|
|
*/
|
|
AWS_COMMON_API void aws_directory_entry_iterator_destroy(struct aws_directory_iterator *iterator);
|
|
|
|
/**
|
|
* Gets the aws_directory_entry value for iterator at the current position. Returns NULL if the iterator contains no
|
|
* entries.
|
|
*/
|
|
AWS_COMMON_API const struct aws_directory_entry *aws_directory_entry_iterator_get_value(
|
|
const struct aws_directory_iterator *iterator);
|
|
|
|
/**
|
|
* Returns true iff the character is a directory separator on ANY supported platform.
|
|
*/
|
|
AWS_COMMON_API
|
|
bool aws_is_any_directory_separator(char value);
|
|
|
|
/**
|
|
* Returns the directory separator used by the local platform
|
|
*/
|
|
AWS_COMMON_API
|
|
char aws_get_platform_directory_separator(void);
|
|
|
|
/**
|
|
* Normalizes the path by replacing any directory separator with the local platform's directory separator.
|
|
* @param path path to normalize. Must be writeable.
|
|
*/
|
|
AWS_COMMON_API
|
|
void aws_normalize_directory_separator(struct aws_byte_buf *path);
|
|
|
|
/**
|
|
* Returns the current user's home directory.
|
|
*/
|
|
AWS_COMMON_API
|
|
struct aws_string *aws_get_home_directory(struct aws_allocator *allocator);
|
|
|
|
/**
|
|
* Returns true if a file or path exists, otherwise, false.
|
|
*/
|
|
AWS_COMMON_API
|
|
bool aws_path_exists(const struct aws_string *path);
|
|
|
|
/*
|
|
* Wrapper for highest-resolution platform-dependent seek implementation.
|
|
* Maps to:
|
|
*
|
|
* _fseeki64() on windows
|
|
* fseeko() on linux
|
|
*
|
|
* whence can either be SEEK_SET or SEEK_END
|
|
*
|
|
* Returns AWS_OP_SUCCESS, or AWS_OP_ERR (after an error has been raised).
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_fseek(FILE *file, int64_t offset, int whence);
|
|
|
|
/*
|
|
* Wrapper for os-specific file length query. We can't use fseek(END, 0)
|
|
* because support for it is not technically required.
|
|
*
|
|
* Unix flavors call fstat, while Windows variants use GetFileSize on a
|
|
* HANDLE queried from the libc FILE pointer.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_file_get_length(FILE *file, int64_t *length);
|
|
|
|
AWS_EXTERN_C_END
|
|
AWS_POP_SANE_WARNING_LEVEL
|
|
|
|
#endif /* AWS_COMMON_FILE_H */
|