Orange <-> bf-blender conflict, with 2.40 saved files the version-patch to
[blender.git] / source / blender / blenlib / BLI_blenlib.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  *
32  * @mainpage BLI - Blender LIbrary external interface
33  *
34  * @section about About the BLI module
35  *
36  * This is the external interface of the Blender Library. If you find
37  * a call to a BLI function that is not prototyped here, please add a
38  * prototype here. The library offers mathematical operations (mainly
39  * vector and matrix calculus), an abstraction layer for file i/o,
40  * functions for calculating Perlin noise, scanfilling services for
41  * triangles, and a system for guarded memory
42  * allocation/deallocation. There is also a patch to make MS Windows
43  * behave more or less Posix-compliant.
44  *
45  * @section issues Known issues with BLI
46  *
47  * - blenlib is written in C.
48  * - The posix-compliancy may move to a separate lib that deals with 
49  *   platform dependencies. (There are other platform-dependent 
50  *   fixes as well.)
51  * - The file i/o has some redundant code. It should be cleaned.
52  * - arithb.c is a very messy matrix library. We need a better 
53  *   solution.
54  * - vectorops.c is close to superfluous. It may disappear in the 
55  *   near future.
56  * 
57  * @section dependencies Dependencies
58  *
59  * - The blenlib uses type defines from makesdna/, and functions from
60  * standard libraries.
61  * 
62  * $Id$ 
63 */
64
65 #ifndef BLI_BLENLIB_H
66 #define BLI_BLENLIB_H
67
68 /* braindamage for the masses... needed
69         because fillfacebase and fillvertbase are used outside */
70 #include "DNA_listBase.h" 
71
72 extern ListBase fillfacebase;
73 extern ListBase fillvertbase;
74 /**
75  * @attention Defined in scanfill.c
76  */
77 extern ListBase filledgebase;
78 extern int totblock;
79
80 struct chardesc;
81 struct direntry;
82 struct rctf;
83 struct rcti;
84 struct EditVert;
85 struct PackedFile;
86 struct LinkNode;
87
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91
92 /* BLI_util.h */
93 char *BLI_gethome(void);
94 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
95 void BLI_make_exist(char *dir);
96 void BLI_split_dirfile(char *string, char *dir, char *file);
97 int BLI_testextensie(char *str, char *ext);
98 void addlisttolist(ListBase *list1, ListBase *list2);
99 void BLI_insertlink(struct ListBase *listbase, void *vprevlink, void *vnewlink);
100 void * BLI_findlink(struct ListBase *listbase, int number);
101 void BLI_freelistN(struct ListBase *listbase);
102 void BLI_addtail(struct ListBase *listbase, void *vlink);
103 void BLI_remlink(struct ListBase *listbase, void *vlink);
104 void BLI_newname(char * name, int add);
105 int BLI_stringdec(char *string, char *kop, char *staart, unsigned short *numlen);
106 void BLI_stringenc(char *string, char *kop, char *staart, unsigned short numlen, int pic);
107 void BLI_addhead(struct ListBase *listbase, void *vlink);
108 void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink);
109 void BLI_freelist(struct ListBase *listbase);
110 int BLI_countlist(struct ListBase *listbase);
111 void BLI_freelinkN(ListBase *listbase, void *vlink);
112 void BLI_splitdirstring(char *di,char *fi);
113
114         /**
115          * dir can be any input, like from buttons, and this function
116          * converts it to a regular full path.
117          * Also removes garbage from directory paths, like /../ or double slashes etc 
118          */
119 void BLI_cleanup_dir(const char *relabase, char *dir);
120
121         /**
122          * Blender's path code replacement function.
123          * Bases @a path strings leading with "//" by the
124          * directory @a basepath, and replaces instances of
125          * '#' with the @a framenum. Results are written
126          * back into @a path.
127          * 
128          * @a path The path to convert
129          * @a basepath The directory to base relative paths with.
130          * @a framenum The framenumber to replace the frame code with.
131          * @retval Returns true if the path was relative (started with "//").
132          */
133 int BLI_convertstringcode(char *path, const char *basepath, int framenum);
134
135 void BLI_makestringcode(const char *relfile, char *file);
136
137         /**
138          * Change every @a from in @a string into @a to. The
139          * result will be in @a string
140          *
141          * @a string The string to work on
142          * @a from The character to replace
143          * @a to The character to replace with
144          */
145 void BLI_char_switch(char *string, char from, char to);
146
147         /**
148          * Makes sure @a path has platform-specific slashes.
149          * 
150          * @a path The path to 'clean'
151          */
152 void BLI_clean(char *path);
153         /**
154          * Duplicates the cstring @a str into a newly mallocN'd
155          * string and returns it.
156          * 
157          * @param str The string to be duplicated
158          * @retval Returns the duplicated string
159          */
160 char* BLI_strdup(char *str);
161
162         /**
163          * Duplicates the first @a len bytes of cstring @a str 
164          * into a newly mallocN'd string and returns it. @a str
165          * is assumed to be at least len bytes long.
166          * 
167          * @param str The string to be duplicated
168          * @param len The number of bytes to duplicate
169          * @retval Returns the duplicated string
170          */
171 char* BLI_strdupn(char *str, int len);
172
173         /**
174          * Like strncpy but ensures dst is always
175          * '\0' terminated.
176          * 
177          * @param dst Destination for copy
178          * @param src Source string to copy
179          * @param maxncpy Maximum number of characters to copy (generally
180          *   the size of dst)
181          * @retval Returns dst
182          */
183 char* BLI_strncpy(char *dst, char *src, int maxncpy);
184
185         /**
186          * Compare two strings
187          * 
188          * @retval True if the strings are equal, false otherwise.
189          */
190 int BLI_streq(char *a, char *b);
191
192         /**
193          * Compare two strings without regard to case.
194          * 
195          * @retval True if the strings are equal, false otherwise.
196          */
197 int BLI_strcaseeq(char *a, char *b);
198
199         /**
200          * Read a file as ASCII lines. An empty list is
201          * returned if the file cannot be opened or read.
202          * 
203          * @attention The returned list should be free'd with
204          * BLI_free_file_lines.
205          * 
206          * @param name The name of the file to read.
207          * @retval A list of strings representing the file lines.
208          */
209 struct LinkNode *BLI_read_file_as_lines(char *name);
210
211         /**
212          * Free the list returned by BLI_read_file_as_lines.
213          */
214 void BLI_free_file_lines(struct LinkNode *lines);
215
216         /**
217          * Checks if name is a fully qualified filename to an executable.
218          * If not it searches $PATH for the file. On Windows it also
219          * adds the correct extension (.com .exe etc) from
220          * $PATHEXT if necessary. Also on Windows it translates
221          * the name to its 8.3 version to prevent problems with
222          * spaces and stuff. Final result is returned in fullname.
223          *
224          * @param fullname The full path and full name of the executable
225          * @param name The name of the executable (usually argv[0]) to be checked
226          */
227 void BLI_where_am_i(char *fullname, char *name);
228
229         /**
230          * determines the full path to the application bundle on OS X
231          *
232          * @return path to application bundle
233          */
234 #ifdef __APPLE__
235 char* BLI_getbundle(void);
236 #endif
237
238 #ifdef WIN32
239 int BLI_getInstallationDir( char * str );
240 #endif
241                 
242 /* BLI_storage.h */
243 int    BLI_filesize(int file);
244 double BLI_diskfree(char *dir);
245 char * BLI_getwdN(char * dir);
246 void BLI_hide_dot_files(int set);
247 unsigned int BLI_getdir(char *dirname,  struct direntry **filelist);
248
249 /**
250  * @attention Do not confuse with BLI_exists
251  */
252 int    BLI_exist(char *name);
253
254 /* BLI_fileops.h */
255 void  BLI_recurdir_fileops(char *dirname);
256 int BLI_link(char *file, char *to);
257 int BLI_backup(char *file, char *from, char *to);
258
259
260 /**
261  * @attention Do not confuse with BLI_exist
262  */
263 int   BLI_exists(char *file);
264 int   BLI_copy_fileops(char *file, char *to);
265 int   BLI_rename(char *from, char *to);
266 int   BLI_gzip(char *from, char *to);
267 int   BLI_delete(char *file, int dir, int recursive);
268 int   BLI_move(char *file, char *to);
269 int   BLI_touch(char *file);
270 char *BLI_last_slash(char *string);
271
272 /* BLI_rct.c */
273 /**
274  * Determine if a rect is empty. An empty
275  * rect is one with a zero (or negative)
276  * width or height.
277  *
278  * @return True if @a rect is empty.
279  */
280 int BLI_rcti_is_empty(struct rcti * rect);
281 void BLI_init_rctf(struct rctf *rect, float xmin, float xmax, float ymin, float ymax);
282 int  BLI_in_rcti(struct rcti * rect, int x, int y);
283 int  BLI_in_rctf(struct rctf *rect, float x, float y);
284 int  BLI_isect_rctf(struct rctf *src1, struct rctf *src2, struct rctf *dest);
285 /* why oh why doesn't this work? */
286 //void BLI_union_rctf(struct rctf *rct1, struct rctf *rct2);
287 void BLI_union_rctf(struct rctf *rcta, struct rctf *rctb);
288
289 /* scanfill.c: used in displist only... */
290 struct EditVert *BLI_addfillvert(float *vec);
291 struct EditEdge *BLI_addfilledge(struct EditVert *v1, struct EditVert *v2);
292 int BLI_edgefill(int mode, int mat_nr);
293 void BLI_end_edgefill(void);
294
295 /* noise.h: */
296 float BLI_hnoise(float noisesize, float x, float y, float z);
297 float BLI_hnoisep(float noisesize, float x, float y, float z);
298 float BLI_turbulence(float noisesize, float x, float y, float z, int nr);
299 float BLI_turbulence1(float noisesize, float x, float y, float z, int nr);
300 /* newnoise: generic noise & turbulence functions to replace the above BLI_hnoise/p & BLI_turbulence/1.
301  * This is done so different noise basis functions can be used */
302 float BLI_gNoise(float noisesize, float x, float y, float z, int hard, int noisebasis);
303 float BLI_gTurbulence(float noisesize, float x, float y, float z, int oct, int hard, int noisebasis);
304 /* newnoise: musgrave functions */
305 float mg_fBm(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
306 float mg_MultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
307 float mg_VLNoise(float x, float y, float z, float distortion, int nbas1, int nbas2);
308 float mg_HeteroTerrain(float x, float y, float z, float H, float lacunarity, float octaves, float offset, int noisebasis);
309 float mg_HybridMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
310 float mg_RidgedMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
311 /* newnoise: voronoi */
312 void voronoi(float x, float y, float z, float* da, float* pa, float me, int dtype);
313 /* newnoise: cellNoise & cellNoiseV (for vector/point/color) */
314 float cellNoise(float x, float y, float z);
315 void cellNoiseV(float x, float y, float z, float *ca);
316
317 /* These callbacks are needed to make the lib finction properly */
318
319 /**
320  * Set a function taking a char* as argument to flag errors. If the
321  * callback is not set, the error is discarded.
322  * @param f The function to use as callback
323  * @attention used in creator.c
324  */
325 void BLI_setErrorCallBack(void (*f)(char*));
326
327 /**
328  * Set a function to be able to interrupt the execution of processing
329  * in this module. If the function returns true, the execution will
330  * terminate gracefully. If the callback is not set, interruption is
331  * not possible.
332  * @param f The function to use as callback
333  * @attention used in creator.c
334  */
335 void BLI_setInterruptCallBack(int (*f)(void));
336
337 int BLI_strcasecmp(const char *s1, const char *s2);
338 int BLI_strncasecmp(const char *s1, const char *s2, int n);
339
340 #define PRNTSUB(type,arg)                       printf(#arg ": %" #type " ", arg)
341
342 #ifndef PRINT
343 #define PRINT(t,v)                                      {PRNTSUB(t,v); printf("\n");}
344 #define PRINT2(t1,v1,t2,v2)                     {PRNTSUB(t1,v1); PRNTSUB(t2,v2); printf("\n");}
345 #define PRINT3(t1,v1,t2,v2,t3,v3)       {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); printf("\n");}
346 #define PRINT4(t1,v1,t2,v2,t3,v3,t4,v4) {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); PRNTSUB(t4,v4); printf("\n");}
347 #endif
348
349 /**
350  * @param array The array in question
351  * @retval The number of elements in the array.
352  */
353 #define BLI_ARRAY_NELEMS(array)         (sizeof((array))/sizeof((array)[0]))
354
355 /**
356  * @param strct The structure of interest
357  * @param member The name of a member field of @a strct
358  * @retval The offset in bytes of @a member within @a strct
359  */
360 #define BLI_STRUCT_OFFSET(strct, member)        ((int) &((strct*) 0)->member)
361
362 #ifdef __cplusplus
363 }
364 #endif
365
366 #endif
367