Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / source / blender / blenlib / BLI_bpath.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): Campbell Barton
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file BLI_bpath.h
29  *  \ingroup bli
30  *  \attention Based on ghash, difference is ghash is not a fixed size,
31  *   so for BPath we dont need to malloc
32  */
33
34 #ifndef BLI_BPATH_H
35 #define BLI_BPATH_H
36
37 struct BPathIterator;
38 struct ReportList;
39 struct Main;
40
41 void                    BLI_bpathIterator_init                          (struct BPathIterator **bpi, struct Main *bmain, const char *basedir, const int flag);
42 void                    BLI_bpathIterator_free                          (struct BPathIterator *bpi);
43 const char*             BLI_bpathIterator_getLib                        (struct BPathIterator *bpi);
44 const char*             BLI_bpathIterator_getName                       (struct BPathIterator *bpi);
45 int                             BLI_bpathIterator_getType                       (struct BPathIterator *bpi);
46 unsigned int    BLI_bpathIterator_getPathMaxLen         (struct BPathIterator *bpi);
47 const char*             BLI_bpathIterator_getBasePath           (struct BPathIterator *bpi);
48 void                    BLI_bpathIterator_step                          (struct BPathIterator *bpi);
49 int                             BLI_bpathIterator_isDone                        (struct BPathIterator *bpi);
50 void                    BLI_bpathIterator_getPath                       (struct BPathIterator *bpi, char *path);
51 void                    BLI_bpathIterator_getPathExpanded       (struct BPathIterator *bpi, char *path_expanded);
52 void                    BLI_bpathIterator_setPath                       (struct BPathIterator *bpi, const char *path);
53
54 /* high level funcs */
55
56 /* creates a text file with missing files if there are any */
57 void checkMissingFiles(struct Main *bmain, struct ReportList *reports);
58 void makeFilesRelative(struct Main *bmain, const char *basedir, struct ReportList *reports);
59 void makeFilesAbsolute(struct Main *bmain, const char *basedir, struct ReportList *reports);
60 void findMissingFiles(struct Main *bmain, const char *str);
61
62 #define BPATH_USE_PACKED 1
63
64 #endif // BLI_BPATH_H