svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 struct direntry;
44
45 void   BLI_adddirstrings(void);
46 void   BLI_builddir(char *dirname, char *relname);
47 int    BLI_compare(struct direntry *entry1, struct direntry *entry2);
48
49 int    BLI_filesize(int file);
50 int    BLI_filepathsize(const char *path);
51 double BLI_diskfree(char *dir);
52 char *BLI_getwdN(char *dir);
53 void BLI_hide_dot_files(int set);
54 unsigned int BLI_getdir(char *dirname, struct direntry **filelist);
55 /**
56  * @attention Do not confuse with BLI_exists
57  */
58 int    BLI_exist(char *name);
59 /**
60          * Read a file as ASCII lines. An empty list is
61          * returned if the file cannot be opened or read.
62          * 
63          * @attention The returned list should be free'd with
64          * BLI_free_file_lines.
65          * 
66          * @param name The name of the file to read.
67          * @retval A list of strings representing the file lines.
68          */
69 struct LinkNode *BLI_read_file_as_lines(char *name);
70
71         /**
72          * Free the list returned by BLI_read_file_as_lines.
73          */
74 void BLI_free_file_lines(struct LinkNode *lines);
75
76 #endif /* BLI_STORAGE_H */
77