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