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