Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_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  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file BKE_bpath.h
24  *  \ingroup bke
25  *  \attention Based on ghash, difference is ghash is not a fixed size,
26  *   so for BPath we don't need to malloc
27  */
28
29 #ifndef __BKE_BPATH_H__
30 #define __BKE_BPATH_H__
31
32 struct ID;
33 struct ListBase;
34 struct Main;
35 struct ReportList;
36
37 /* Function that does something with an ID's file path. Should return 1 if the
38  * path has changed, and in that case, should write the result to pathOut. */
39 typedef bool (*BPathVisitor)(void *userdata, char *path_dst, const char *path_src);
40 /* Executes 'visit' for each path associated with 'id'. */
41 void BKE_bpath_traverse_id(struct Main *bmain, struct ID *id, BPathVisitor visit_cb, const int flag, void *userdata);
42 void BKE_bpath_traverse_id_list(struct Main *bmain, struct ListBase *lb, BPathVisitor visit_cb, const int flag, void *userdata);
43 void BKE_bpath_traverse_main(struct Main *bmain, BPathVisitor visit_cb, const int flag, void *userdata);
44 bool BKE_bpath_relocate_visitor(void *oldbasepath, char *path_dst, const char *path_src);
45
46 /* Functions for temp backup/restore of paths, path count must NOT change */
47 void *BKE_bpath_list_backup(struct Main *bmain, const int flag);
48 void  BKE_bpath_list_restore(struct Main *bmain, const int flag, void *ls_handle);
49 void  BKE_bpath_list_free(void *ls_handle);
50
51 enum {
52         /* convert paths to absolute */
53         BKE_BPATH_TRAVERSE_ABS = (1 << 0),
54         /* skip library paths */
55         BKE_BPATH_TRAVERSE_SKIP_LIBRARY = (1 << 1),
56         /* skip packed data */
57         BKE_BPATH_TRAVERSE_SKIP_PACKED = (1 << 2),
58         /* skip paths where a single dir is used with an array of files, eg.
59          * sequence strip images and pointcache. in this case only use the first
60          * file, this is needed for directory manipulation functions which might
61          * otherwise modify the same directory multiple times */
62         BKE_BPATH_TRAVERSE_SKIP_MULTIFILE = (1 << 3),
63         /* reload data (when the path is edited) */
64         BKE_BPATH_TRAVERSE_RELOAD_EDITED = (1 << 4),
65 };
66
67 /* high level funcs */
68
69 /* creates a text file with missing files if there are any */
70 void BKE_bpath_missing_files_check(struct Main *bmain, struct ReportList *reports);
71 void BKE_bpath_missing_files_find(struct Main *bmain, const char *searchpath, struct ReportList *reports,
72                                   const bool find_all);
73 void BKE_bpath_relative_convert(struct Main *bmain, const char *basedir, struct ReportList *reports);
74 void BKE_bpath_absolute_convert(struct Main *bmain, const char *basedir, struct ReportList *reports);
75
76 #endif  /* __BKE_BPATH_H__ */