Merging r50625 through r51896 from trunk into soc-2011-tomato
[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
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 #include "BLI_fileops_types.h"
44
45 /* for size_t (needed on windows) */
46 #include <stddef.h>
47
48 struct gzFile;
49
50 /* Common */
51
52 int    BLI_exists(const char *path);
53 int    BLI_copy(const char *path, const char *to);
54 int    BLI_rename(const char *from, const char *to);
55 int    BLI_delete(const char *path, int dir, int recursive);
56 int    BLI_move(const char *path, const char *to);
57 int    BLI_create_symlink(const char *path, const char *to);
58 int    BLI_stat(const char *path, struct stat *buffer);
59
60 /* Directories */
61
62 struct direntry;
63
64 int    BLI_is_dir(const char *path);
65 int    BLI_is_file(const char *path);
66 void   BLI_dir_create_recursive(const char *dir);
67 double BLI_dir_free_space(const char *dir);
68 char  *BLI_current_working_dir(char *dir, const size_t maxlen);
69
70 unsigned int BLI_dir_contents(const char *dir, struct direntry **filelist);
71
72 /* Files */
73
74 FILE  *BLI_fopen(const char *filename, const char *mode);
75 void  *BLI_gzopen(const char *filename, const char *mode);
76 int    BLI_open(const char *filename, int oflag, int pmode);
77
78 int    BLI_file_is_writable(const char *file);
79 int    BLI_file_touch(const char *file);
80
81 int    BLI_file_gzip(const char *from, const char *to);
82 char  *BLI_file_ungzip_to_mem(const char *from_file, int *size_r);
83
84 size_t BLI_file_descriptor_size(int file);
85 size_t BLI_file_size(const char *file);
86
87 /* compare if one was last modified before the other */
88 int    BLI_file_older(const char *file1, const char *file2);
89
90 /* read ascii file as lines, empty list if reading fails */
91 struct LinkNode *BLI_file_read_as_lines(const char *file);
92 void   BLI_file_free_lines(struct LinkNode *lines);
93
94 /* this weirdo pops up in two places ... */
95 #if !defined(WIN32)
96 #  ifndef O_BINARY
97 #    define O_BINARY 0
98 #  endif
99 #else
100 void BLI_get_short_name(char short_name[256], const char *filename);
101 #endif
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif
108