Merge remote-tracking branch 'origin/master' into blender2.8
[blender.git] / source / blender / blenlib / BLI_fileops.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file BLI_fileops.h
29  *  \ingroup bli
30  *  \brief File and directory operations.
31  * */
32
33 #ifndef __BLI_FILEOPS_H__
34 #define __BLI_FILEOPS_H__
35
36 #include <stdio.h>
37 #include <sys/stat.h>
38 #include <stdint.h>
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /* for size_t (needed on windows) */
45 #include <stddef.h>
46
47 #include <limits.h>  /* for PATH_MAX */
48
49 #include "BLI_compiler_attrs.h"
50
51 #ifndef PATH_MAX
52 #  define PATH_MAX 4096
53 #endif
54
55
56 /* Common */
57
58 int    BLI_exists(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
59 int    BLI_copy(const char *path, const char *to) ATTR_NONNULL();
60 int    BLI_rename(const char *from, const char *to) ATTR_NONNULL();
61 int    BLI_delete(const char *path, bool dir, bool recursive) ATTR_NONNULL();
62 #if 0  /* Unused */
63 int    BLI_move(const char *path, const char *to) ATTR_NONNULL();
64 int    BLI_create_symlink(const char *path, const char *to) ATTR_NONNULL();
65 #endif
66
67 /* keep in sync with the definition of struct direntry in BLI_fileops_types.h */
68 #ifdef WIN32
69 #  if defined(_MSC_VER)
70 typedef struct _stat64 BLI_stat_t;
71 #  else
72 typedef struct _stat BLI_stat_t;
73 #  endif
74 #else
75 typedef struct stat BLI_stat_t;
76 #endif
77
78 int    BLI_stat(const char *path, BLI_stat_t *buffer) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
79 #ifdef WIN32
80 int    BLI_wstat(const wchar_t *path, BLI_stat_t *buffer);
81 #endif
82
83 /* Directories */
84
85 struct direntry;
86
87 bool   BLI_is_dir(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
88 bool   BLI_is_file(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
89 bool   BLI_dir_create_recursive(const char *dir) ATTR_NONNULL();
90 double BLI_dir_free_space(const char *dir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
91 char  *BLI_current_working_dir(char *dir, const size_t maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
92
93 /* Filelist */
94
95 unsigned int BLI_filelist_dir_contents(const char *dir, struct direntry **r_filelist);
96 void BLI_filelist_entry_duplicate(struct direntry *dst, const struct direntry *src);
97 void BLI_filelist_duplicate(
98         struct direntry **dest_filelist, struct direntry * const src_filelist, const unsigned int nrentries);
99 void BLI_filelist_entry_free(struct direntry *entry);
100 void BLI_filelist_free(struct direntry *filelist, const unsigned int nrentries);
101
102 void BLI_filelist_entry_size_to_string(const struct stat *st, const uint64_t sz, const bool compact, char r_size[]);
103 void BLI_filelist_entry_mode_to_string(
104         const struct stat *st, const bool compact, char r_mode1[], char r_mode2[], char r_mode3[]);
105 void BLI_filelist_entry_owner_to_string(const struct stat *st, const bool compact, char r_owner[]);
106 void BLI_filelist_entry_datetime_to_string(
107         const struct stat *st, const int64_t ts, const bool compact, char r_time[], char r_date[]);
108
109 /* Files */
110
111 FILE  *BLI_fopen(const char *filename, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
112 void  *BLI_gzopen(const char *filename, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
113 int    BLI_open(const char *filename, int oflag, int pmode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
114 int    BLI_access(const char *filename, int mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
115
116 bool   BLI_file_is_writable(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
117 bool   BLI_file_touch(const char *file) ATTR_NONNULL();
118
119 #if 0  /* UNUSED */
120 int    BLI_file_gzip(const char *from, const char *to) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
121 #endif
122 char  *BLI_file_ungzip_to_mem(const char *from_file, int *r_size) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
123
124 size_t BLI_file_descriptor_size(int file) ATTR_WARN_UNUSED_RESULT;
125 size_t BLI_file_size(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
126
127 /* compare if one was last modified before the other */
128 bool   BLI_file_older(const char *file1, const char *file2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
129
130 /* read ascii file as lines, empty list if reading fails */
131 struct LinkNode *BLI_file_read_as_lines(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
132 void  *BLI_file_read_text_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size);
133 void  *BLI_file_read_binary_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size);
134 void   BLI_file_free_lines(struct LinkNode *lines);
135
136 /* this weirdo pops up in two places ... */
137 #if !defined(WIN32)
138 #  ifndef O_BINARY
139 #    define O_BINARY 0
140 #  endif
141 #else
142 void BLI_get_short_name(char short_name[256], const char *filename);
143 #endif
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif  /* __BLI_FILEOPS_H__ */