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