Made a change as to when the view map data structure is released,
[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 /* Based on ghash, difference is ghash is not a fixed size,
30  * so for BPath we dont need to malloc  */
31
32 #ifndef BLI_BPATH_H
33 #define BLI_BPATH_H
34
35 struct BPathIteratorSeqData {
36         int totseq;
37         int seq;
38         struct Sequence **seqar; /* Sequence */
39         struct Scene *scene;                    /* Current scene */
40 };
41
42 struct BPathIteratorFrsModuleData {
43         struct Scene *scene;                    /* Current scene */
44         struct SceneRenderLayer *layer; /* Scene render layer */
45         struct FreestyleModuleConfig *module;
46 };
47
48 struct BPathIterator {
49         char*   path;
50         const char*     lib;
51         const char*     name;
52         void*   data;
53         int             len;
54         int             type;
55         
56         void (*setpath_callback)(struct BPathIterator *, const char *);
57         void (*getpath_callback)(struct BPathIterator *, char *);
58         
59         const char*     base_path; /* base path, the directry the blend file is in - normally G.main->name */
60
61         /* only for seq data */
62         struct BPathIteratorSeqData seqdata;
63         /* only for Freestyle module data */
64         struct BPathIteratorFrsModuleData frsmoduledata;
65 };
66
67 void                    BLI_bpathIterator_init                          (struct BPathIterator *bpi, const char *base_path);
68 void                    BLI_bpathIterator_free                          (struct BPathIterator *bpi);
69 const char*             BLI_bpathIterator_getLib                        (struct BPathIterator *bpi);
70 const char*             BLI_bpathIterator_getName                       (struct BPathIterator *bpi);
71 int                             BLI_bpathIterator_getType                       (struct BPathIterator *bpi);
72 int                             BLI_bpathIterator_getPathMaxLen         (struct BPathIterator *bpi);
73 void                    BLI_bpathIterator_step                          (struct BPathIterator *bpi);
74 int                             BLI_bpathIterator_isDone                        (struct BPathIterator *bpi);
75 void                    BLI_bpathIterator_getPath                       (struct BPathIterator *bpi, char *path);
76 void                    BLI_bpathIterator_getPathExpanded       (struct BPathIterator *bpi, char *path_expanded);
77 void                    BLI_bpathIterator_setPath                       (struct BPathIterator *bpi, const char *path);
78
79 /* high level funcs */
80
81 /* creates a text file with missing files if there are any */
82 void checkMissingFiles(const char *basepath, ReportList *reports);
83 void makeFilesRelative(const char *basepath, ReportList *reports);
84 void makeFilesAbsolute(const char *basepath, ReportList *reports);
85 void findMissingFiles(const char *basepath, const char *str);
86
87 #endif // BLI_BPATH_H