e443a853324e64c02c90b8f0cf0978d1cad0af98
[blender.git] / source / blender / blenlib / BLI_storage.h
1 /* $Id$ 
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef BLI_STORAGE_H
30 #define BLI_STORAGE_H
31
32 /* NOTE: these have to be defined before including unistd.h! */
33 #ifndef __APPLE__
34 #ifndef WIN32
35 #ifndef _LARGEFILE_SOURCE
36 #define _LARGEFILE_SOURCE
37 #define _LARGEFILE64_SOURCE
38 #define _FILE_OFFSET_BITS 64
39 #endif
40 #endif
41 #endif
42
43 #ifdef WIN32
44 /* for size_t, only needed on win32 for some reason */
45 #include <stddef.h>
46 #endif
47
48 struct direntry;
49
50
51 void   BLI_adddirstrings(void);
52 void   BLI_builddir(char *dirname, char *relname);
53 int    BLI_compare(struct direntry *entry1, struct direntry *entry2);
54
55 size_t BLI_filesize(int file);
56 size_t BLI_filepathsize(const char *path);
57 double BLI_diskfree(char *dir);
58 char *BLI_getwdN(char *dir);
59
60 unsigned int BLI_getdir(char *dirname, struct direntry **filelist);
61 /**
62  * @attention Do not confuse with BLI_exists
63  */
64 int    BLI_exist(char *name);
65 /**
66          * Read a file as ASCII lines. An empty list is
67          * returned if the file cannot be opened or read.
68          * 
69          * @attention The returned list should be free'd with
70          * BLI_free_file_lines.
71          * 
72          * @param name The name of the file to read.
73          * @retval A list of strings representing the file lines.
74          */
75
76 int BLI_is_dir(char *file);
77
78 struct LinkNode *BLI_read_file_as_lines(char *name);
79
80         /**
81          * Free the list returned by BLI_read_file_as_lines.
82          */
83 void BLI_free_file_lines(struct LinkNode *lines);
84
85         /* Compare if one was last modified before the other */
86 int             BLI_file_older(const char *file1, const char *file2);
87
88 #endif /* BLI_STORAGE_H */
89