BLI_storage: Split text/binary version of mem-from-file funcs
[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
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /* for size_t (needed on windows) */
44 #include <stddef.h>
45
46 #include <limits.h>  /* for PATH_MAX */
47
48 #include "BLI_compiler_attrs.h"
49
50 #ifndef PATH_MAX
51 #  define PATH_MAX 4096
52 #endif
53
54
55 /* Common */
56
57 int    BLI_exists(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
58 int    BLI_copy(const char *path, const char *to) ATTR_NONNULL();
59 int    BLI_rename(const char *from, const char *to) ATTR_NONNULL();
60 int    BLI_delete(const char *path, bool dir, bool recursive) ATTR_NONNULL();
61 #if 0  /* Unused */
62 int    BLI_move(const char *path, const char *to) ATTR_NONNULL();
63 int    BLI_create_symlink(const char *path, const char *to) ATTR_NONNULL();
64 #endif
65
66 /* keep in sync with the definition of struct direntry in BLI_fileops_types.h */
67 #ifdef WIN32
68 #  if defined(_MSC_VER) || defined(__MINGW64__)
69 typedef struct _stat64 BLI_stat_t;
70 #  elif defined(__MINGW32__)
71 typedef struct _stati64 BLI_stat_t;
72 #  else
73 typedef struct _stat BLI_stat_t;
74 #  endif
75 #else
76 typedef struct stat BLI_stat_t;
77 #endif
78
79 int    BLI_stat(const char *path, BLI_stat_t *buffer) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
80 #ifdef WIN32
81 int    BLI_wstat(const wchar_t *path, BLI_stat_t *buffer);
82 #endif
83
84 /* Directories */
85
86 struct direntry;
87
88 bool   BLI_is_dir(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
89 bool   BLI_is_file(const char *path) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
90 bool   BLI_dir_create_recursive(const char *dir) ATTR_NONNULL();
91 double BLI_dir_free_space(const char *dir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
92 char  *BLI_current_working_dir(char *dir, const size_t maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
93
94 /* Filelist */
95
96 unsigned int BLI_filelist_dir_contents(const char *dir, struct direntry **r_filelist);
97 void BLI_filelist_entry_duplicate(struct direntry *dst, const struct direntry *src);
98 void BLI_filelist_duplicate(
99         struct direntry **dest_filelist, struct direntry * const src_filelist, const unsigned int nrentries);
100 void BLI_filelist_entry_free(struct direntry *entry);
101 void BLI_filelist_free(struct direntry *filelist, const unsigned int nrentries);
102
103 void BLI_filelist_entry_size_to_string(const struct stat *st, const uint64_t sz, const bool compact, char r_size[]);
104 void BLI_filelist_entry_mode_to_string(
105         const struct stat *st, const bool compact, char r_mode1[], char r_mode2[], char r_mode3[]);
106 void BLI_filelist_entry_owner_to_string(const struct stat *st, const bool compact, char r_owner[]);
107 void BLI_filelist_entry_datetime_to_string(
108         const struct stat *st, const int64_t ts, const bool compact, char r_time[], char r_date[]);
109
110 /* Files */
111
112 FILE  *BLI_fopen(const char *filename, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
113 void  *BLI_gzopen(const char *filename, const char *mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
114 int    BLI_open(const char *filename, int oflag, int pmode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
115 int    BLI_access(const char *filename, int mode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
116
117 bool   BLI_file_is_writable(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
118 bool   BLI_file_touch(const char *file) ATTR_NONNULL();
119
120 #if 0  /* UNUSED */
121 int    BLI_file_gzip(const char *from, const char *to) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
122 #endif
123 char  *BLI_file_ungzip_to_mem(const char *from_file, int *r_size) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
124
125 size_t BLI_file_descriptor_size(int file) ATTR_WARN_UNUSED_RESULT;
126 size_t BLI_file_size(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
127
128 /* compare if one was last modified before the other */
129 bool   BLI_file_older(const char *file1, const char *file2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
130
131 /* read ascii file as lines, empty list if reading fails */
132 struct LinkNode *BLI_file_read_as_lines(const char *file) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
133 void  *BLI_file_read_text_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size);
134 void  *BLI_file_read_binary_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size);
135 void   BLI_file_free_lines(struct LinkNode *lines);
136
137 /* this weirdo pops up in two places ... */
138 #if !defined(WIN32)
139 #  ifndef O_BINARY
140 #    define O_BINARY 0
141 #  endif
142 #else
143 void BLI_get_short_name(char short_name[256], const char *filename);
144 #endif
145
146 #ifdef __cplusplus
147 }
148 #endif
149
150 #endif  /* __BLI_FILEOPS_H__ */