Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_bpath.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup bke
18  *  \attention Based on ghash, difference is ghash is not a fixed size,
19  *   so for BPath we don't need to malloc
20  */
21
22 #ifndef __BKE_BPATH_H__
23 #define __BKE_BPATH_H__
24
25 struct ID;
26 struct ListBase;
27 struct Main;
28 struct ReportList;
29
30 /* Function that does something with an ID's file path. Should return 1 if the
31  * path has changed, and in that case, should write the result to pathOut. */
32 typedef bool (*BPathVisitor)(void *userdata, char *path_dst, const char *path_src);
33 /* Executes 'visit' for each path associated with 'id'. */
34 void BKE_bpath_traverse_id(struct Main *bmain, struct ID *id, BPathVisitor visit_cb, const int flag, void *userdata);
35 void BKE_bpath_traverse_id_list(struct Main *bmain, struct ListBase *lb, BPathVisitor visit_cb, const int flag, void *userdata);
36 void BKE_bpath_traverse_main(struct Main *bmain, BPathVisitor visit_cb, const int flag, void *userdata);
37 bool BKE_bpath_relocate_visitor(void *oldbasepath, char *path_dst, const char *path_src);
38
39 /* Functions for temp backup/restore of paths, path count must NOT change */
40 void *BKE_bpath_list_backup(struct Main *bmain, const int flag);
41 void  BKE_bpath_list_restore(struct Main *bmain, const int flag, void *ls_handle);
42 void  BKE_bpath_list_free(void *ls_handle);
43
44 enum {
45         /* convert paths to absolute */
46         BKE_BPATH_TRAVERSE_ABS = (1 << 0),
47         /* skip library paths */
48         BKE_BPATH_TRAVERSE_SKIP_LIBRARY = (1 << 1),
49         /* skip packed data */
50         BKE_BPATH_TRAVERSE_SKIP_PACKED = (1 << 2),
51         /* skip paths where a single dir is used with an array of files, eg.
52          * sequence strip images and pointcache. in this case only use the first
53          * file, this is needed for directory manipulation functions which might
54          * otherwise modify the same directory multiple times */
55         BKE_BPATH_TRAVERSE_SKIP_MULTIFILE = (1 << 3),
56         /* reload data (when the path is edited) */
57         BKE_BPATH_TRAVERSE_RELOAD_EDITED = (1 << 4),
58 };
59
60 /* high level funcs */
61
62 /* creates a text file with missing files if there are any */
63 void BKE_bpath_missing_files_check(struct Main *bmain, struct ReportList *reports);
64 void BKE_bpath_missing_files_find(struct Main *bmain, const char *searchpath, struct ReportList *reports,
65                                   const bool find_all);
66 void BKE_bpath_relative_convert(struct Main *bmain, const char *basedir, struct ReportList *reports);
67 void BKE_bpath_absolute_convert(struct Main *bmain, const char *basedir, struct ReportList *reports);
68
69 #endif  /* __BKE_BPATH_H__ */