017f9877bafb6d05c25516dc6fdf6ea9aa42f598
[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 /** \file BLI_storage.h
33  *  \ingroup bli
34  */
35
36 #ifdef WIN32
37 /* for size_t, only needed on win32 for some reason */
38 #include <stddef.h>
39 #endif
40
41 struct direntry;
42
43
44 void   BLI_adddirstrings(void);
45 void   BLI_builddir(const char *dirname, const char *relname);
46 int    BLI_compare(struct direntry *entry1, struct direntry *entry2);
47
48 size_t BLI_filesize(int file);
49 size_t BLI_filepathsize(const char *path);
50 double BLI_diskfree(const char *dir);
51 char *BLI_getwdN(char *dir, const int maxncpy);
52
53 unsigned int BLI_getdir(const char *dirname, struct direntry **filelist);
54 /**
55  * @attention Do not confuse with BLI_exists
56  */
57 int    BLI_exist(const char *name);
58 /**
59          * Read a file as ASCII lines. An empty list is
60          * returned if the file cannot be opened or read.
61          * 
62          * @attention The returned list should be free'd with
63          * BLI_free_file_lines.
64          * 
65          * @param name The name of the file to read.
66          * @retval A list of strings representing the file lines.
67          */
68
69 int BLI_is_dir(const char *file);
70
71 struct LinkNode *BLI_read_file_as_lines(const char *name);
72
73         /**
74          * Free the list returned by BLI_read_file_as_lines.
75          */
76 void BLI_free_file_lines(struct LinkNode *lines);
77
78         /* Compare if one was last modified before the other */
79 int             BLI_file_older(const char *file1, const char *file2);
80
81 #endif /* BLI_STORAGE_H */
82