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
|
/* Copyright (C) 2007-2009 The Android Open Source Project
**
** This software is licensed under the terms of the GNU General Public
** License version 2, as published by the Free Software Foundation, and
** may be copied, distributed, and modified under those terms.
**
** 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.
*/
#ifndef _ANDROID_UTILS_PATH_H
#define _ANDROID_UTILS_PATH_H
#include <android/utils/system.h>
#include <stdint.h> /* for uint64_t */
/** MISC FILE AND DIRECTORY HANDLING
**/
/* O_BINARY is required in the MS C library to avoid opening file
* in text mode (the default, ahhhhh)
*/
#if !defined(_WIN32) && !defined(O_BINARY)
# define O_BINARY 0
#endif
/* define PATH_SEP as a string containing the directory separateor */
#ifdef _WIN32
# define PATH_SEP "\\"
#else
# define PATH_SEP "/"
#endif
/* get MAX_PATH, note that PATH_MAX is set to 260 on Windows for
* stupid backwards-compatibility reason, though any 32-bit version
* of the OS handles much much longer paths
*/
#ifdef _WIN32
# undef MAX_PATH
# define MAX_PATH 1024
# undef PATH_MAX
# define PATH_MAX MAX_PATH
#else
# include <limits.h>
# define MAX_PATH PATH_MAX
#endif
/* checks that a given file exists */
extern ABool path_exists( const char* path );
/* checks that a path points to a regular file */
extern ABool path_is_regular( const char* path );
/* checks that a path points to a directory */
extern ABool path_is_dir( const char* path );
/* checks that one can read/write a given (regular) file */
extern ABool path_can_read( const char* path );
extern ABool path_can_write( const char* path );
/* try to make a directory */
extern APosixStatus path_mkdir( const char* path, int mode );
/* ensure that a given directory exists, create it if not,
0 on success, -1 on error */
extern APosixStatus path_mkdir_if_needed( const char* path, int mode );
/* return the size of a given file in '*psize'. returns 0 on
* success, -1 on failure (error code in errno) */
extern APosixStatus path_get_size( const char* path, uint64_t *psize );
/* path_parent() can be used to return the n-level parent of a given directory
* this understands . and .. when encountered in the input path.
*
* the returned string must be freed by the caller.
*/
extern char* path_parent( const char* path, int levels );
/** OTHER FILE UTILITIES
**
** path_empty_file() creates an empty file at a given path location.
** if the file already exists, it is truncated without warning
**
** path_copy_file() copies one file into another.
**
** unlink_file() is equivalent to unlink() on Unix, on Windows,
** it will handle the case where _unlink() fails because the file is
** read-only by trying to change its access rights then calling _unlink()
** again.
**
** these functions return 0 on success, and -1 on error
**
** load_text_file() reads a file into a heap-allocated memory block,
** and appends a 0 to it. the caller must free it
**/
/* creates an empty file at a given location. If the file already
* exists, it is truncated without warning. returns 0 on success,
* or -1 on failure.
*/
extern APosixStatus path_empty_file( const char* path );
/* copies on file into another one. 0 on success, -1 on failure
* (error code in errno). Does not work on directories */
extern APosixStatus path_copy_file( const char* dest, const char* source );
/* unlink/delete a given file. Note that on Win32, this will
* fail if the program has an opened handle to the file
*/
extern APosixStatus path_delete_file( const char* path );
/* try to load a given file into a heap-allocated block.
* if 'pSize' is not NULL, this will set the file's size in '*pSize'
* note that this actually zero-terminates the file for convenience.
* In case of failure, NULL is returned and the error code is in errno
*/
extern void* path_load_file( const char* path, size_t *pSize );
/* */
#endif /* _ANDROID_UTILS_PATH_H */
|
