89ba4b2675eac2908c8aad9967c0a4130d265cb2
[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 ID;
38 struct ListBase;
39 struct Main;
40 struct ReportList;
41
42 /* Function that does something with an ID's file path. Should return 1 if the
43    path has changed, and in that case, should write the result to pathOut. */
44 typedef int (*BPathVisitor)(void *userdata, char *path_dst, const char *path_src);
45 /* Executes 'visit' for each path associated with 'id'. */
46 void bpath_traverse_id(struct Main *bmain, struct ID *id, BPathVisitor visit_cb, const int flag, void *userdata);
47 void bpath_traverse_id_list(struct Main *bmain, struct ListBase *lb, BPathVisitor visit_cb, const int flag, void *userdata);
48 void bpath_traverse_main(struct Main *bmain, BPathVisitor visit_cb, const int flag, void *userdata);
49 int bpath_relocate_visitor(void *oldbasepath, char *path_dst, const char *path_src);
50
51 #define BPATH_TRAVERSE_ABS          (1<<0) /* convert paths to absolute */
52 #define BPATH_TRAVERSE_SKIP_LIBRARY (1<<2) /* skip library paths */
53 #define BPATH_TRAVERSE_SKIP_PACKED  (1<<3) /* skip packed data */
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 *searchpath, struct ReportList *reports);
62
63 #endif // BLI_BPATH_H