=== bugfix ===
[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 struct DynamicList;
88
89 #ifdef __cplusplus
90 extern "C" {
91 #endif
92
93 /* BLI_util.h */
94 char *BLI_gethome(void);
95 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
96 void BLI_make_exist(char *dir);
97 void BLI_make_existing_file(char *name);
98 void BLI_split_dirfile(const char *string, char *dir, char *file);
99 void BLI_join_dirfile(char *string, const char *dir, const char *file);
100 int BLI_testextensie(const char *str, const char *ext);
101 void addlisttolist(ListBase *list1, ListBase *list2);
102 void BLI_insertlink(struct ListBase *listbase, void *vprevlink, void *vnewlink);
103 void * BLI_findlink(struct ListBase *listbase, int number);
104 void BLI_freelistN(struct ListBase *listbase);
105 void BLI_addtail(struct ListBase *listbase, void *vlink);
106 void BLI_remlink(struct ListBase *listbase, void *vlink);
107 void BLI_newname(char * name, int add);
108 int BLI_stringdec(char *string, char *kop, char *staart, unsigned short *numlen);
109 void BLI_stringenc(char *string, char *kop, char *staart, unsigned short numlen, int pic);
110 void BLI_addhead(struct ListBase *listbase, void *vlink);
111 void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink);
112 void BLI_freelist(struct ListBase *listbase);
113 int BLI_countlist(struct ListBase *listbase);
114 void BLI_freelinkN(ListBase *listbase, void *vlink);
115 void BLI_splitdirstring(char *di,char *fi);
116
117 struct DynamicList *BLI_dlist_from_listbase(struct ListBase *lb);
118 struct ListBase *BLI_listbase_from_dlist(struct DynamicList *dlist, struct ListBase *lb);
119 void * BLI_dlist_find_link(struct DynamicList *dlist, unsigned int index);
120 unsigned int BLI_count_items(struct DynamicList *dlist);
121 void BLI_dlist_free_item(struct DynamicList *dlist, unsigned int index);
122 void BLI_dlist_rem_item(struct DynamicList *dlist, unsigned int index);
123 void * BLI_dlist_add_item_index(struct DynamicList *dlist, void *item, unsigned int index);
124 void BLI_dlist_destroy(struct DynamicList *dlist);
125 void BLI_dlist_init(struct DynamicList *dlist);
126 void BLI_dlist_reinit(struct DynamicList *dlist);
127
128         /**
129          * dir can be any input, like from buttons, and this function
130          * converts it to a regular full path.
131          * Also removes garbage from directory paths, like /../ or double slashes etc 
132          */
133 void BLI_cleanup_dir(const char *relabase, char *dir);
134
135         /**
136          * Blender's path code replacement function.
137          * Bases @a path strings leading with "//" by the
138          * directory @a basepath, and replaces instances of
139          * '#' with the @a framenum. Results are written
140          * back into @a path.
141          * 
142          * @a path The path to convert
143          * @a basepath The directory to base relative paths with.
144          * @a framenum The framenumber to replace the frame code with.
145          * @retval Returns true if the path was relative (started with "//").
146          */
147 int BLI_convertstringcode(char *path, const char *basepath, int framenum);
148
149 void BLI_makestringcode(const char *relfile, char *file);
150
151         /**
152          * Change every @a from in @a string into @a to. The
153          * result will be in @a string
154          *
155          * @a string The string to work on
156          * @a from The character to replace
157          * @a to The character to replace with
158          */
159 void BLI_char_switch(char *string, char from, char to);
160
161         /**
162          * Makes sure @a path has platform-specific slashes.
163          * 
164          * @a path The path to 'clean'
165          */
166 void BLI_clean(char *path);
167         /**
168          * Duplicates the cstring @a str into a newly mallocN'd
169          * string and returns it.
170          * 
171          * @param str The string to be duplicated
172          * @retval Returns the duplicated string
173          */
174 char* BLI_strdup(char *str);
175
176         /**
177          * Duplicates the first @a len bytes of cstring @a str 
178          * into a newly mallocN'd string and returns it. @a str
179          * is assumed to be at least len bytes long.
180          * 
181          * @param str The string to be duplicated
182          * @param len The number of bytes to duplicate
183          * @retval Returns the duplicated string
184          */
185 char* BLI_strdupn(char *str, int len);
186
187         /**
188          * Like strncpy but ensures dst is always
189          * '\0' terminated.
190          * 
191          * @param dst Destination for copy
192          * @param src Source string to copy
193          * @param maxncpy Maximum number of characters to copy (generally
194          *   the size of dst)
195          * @retval Returns dst
196          */
197 char* BLI_strncpy(char *dst, const char *src, int maxncpy);
198
199         /**
200          * Compare two strings
201          * 
202          * @retval True if the strings are equal, false otherwise.
203          */
204 int BLI_streq(char *a, char *b);
205
206         /**
207          * Compare two strings without regard to case.
208          * 
209          * @retval True if the strings are equal, false otherwise.
210          */
211 int BLI_strcaseeq(char *a, char *b);
212
213         /**
214          * Read a file as ASCII lines. An empty list is
215          * returned if the file cannot be opened or read.
216          * 
217          * @attention The returned list should be free'd with
218          * BLI_free_file_lines.
219          * 
220          * @param name The name of the file to read.
221          * @retval A list of strings representing the file lines.
222          */
223 struct LinkNode *BLI_read_file_as_lines(char *name);
224
225         /**
226          * Free the list returned by BLI_read_file_as_lines.
227          */
228 void BLI_free_file_lines(struct LinkNode *lines);
229
230         /**
231          * Checks if name is a fully qualified filename to an executable.
232          * If not it searches $PATH for the file. On Windows it also
233          * adds the correct extension (.com .exe etc) from
234          * $PATHEXT if necessary. Also on Windows it translates
235          * the name to its 8.3 version to prevent problems with
236          * spaces and stuff. Final result is returned in fullname.
237          *
238          * @param fullname The full path and full name of the executable
239          * @param name The name of the executable (usually argv[0]) to be checked
240          */
241 void BLI_where_am_i(char *fullname, char *name);
242
243         /**
244          * determines the full path to the application bundle on OS X
245          *
246          * @return path to application bundle
247          */
248 #ifdef __APPLE__
249 char* BLI_getbundle(void);
250 #endif
251
252 #ifdef WIN32
253 int BLI_getInstallationDir( char * str );
254 #endif
255                 
256 /* BLI_storage.h */
257 int    BLI_filesize(int file);
258 double BLI_diskfree(char *dir);
259 char * BLI_getwdN(char * dir);
260 void BLI_hide_dot_files(int set);
261 unsigned int BLI_getdir(char *dirname,  struct direntry **filelist);
262
263 /**
264  * @attention Do not confuse with BLI_exists
265  */
266 int    BLI_exist(char *name);
267
268 /* BLI_fileops.h */
269 void  BLI_recurdir_fileops(char *dirname);
270 int BLI_link(char *file, char *to);
271 int BLI_backup(char *file, char *from, char *to);
272 int BLI_is_writable(char *filename);
273
274 /**
275  * @attention Do not confuse with BLI_exist
276  */
277 int   BLI_exists(char *file);
278 int   BLI_copy_fileops(char *file, char *to);
279 int   BLI_rename(char *from, char *to);
280 int   BLI_gzip(char *from, char *to);
281 int   BLI_delete(char *file, int dir, int recursive);
282 int   BLI_move(char *file, char *to);
283 int   BLI_touch(char *file);
284 char *BLI_last_slash(char *string);
285
286 /* BLI_rct.c */
287 /**
288  * Determine if a rect is empty. An empty
289  * rect is one with a zero (or negative)
290  * width or height.
291  *
292  * @return True if @a rect is empty.
293  */
294 int  BLI_rcti_is_empty(struct rcti * rect);
295 void BLI_init_rctf(struct rctf *rect, float xmin, float xmax, float ymin, float ymax);
296 void BLI_init_rcti(struct rcti *rect, int xmin, int xmax, int ymin, int ymax);
297 void BLI_translate_rctf(struct rctf *rect, float x, float y);
298 void BLI_translate_rcti(struct rcti *rect, int x, int y);
299 int  BLI_in_rcti(struct rcti * rect, int x, int y);
300 int  BLI_in_rctf(struct rctf *rect, float x, float y);
301 int  BLI_isect_rctf(struct rctf *src1, struct rctf *src2, struct rctf *dest);
302 int  BLI_isect_rcti(struct rcti *src1, struct rcti *src2, struct rcti *dest);
303 void BLI_union_rctf(struct rctf *rcta, struct rctf *rctb);
304
305 /* scanfill.c: used in displist only... */
306 struct EditVert *BLI_addfillvert(float *vec);
307 struct EditEdge *BLI_addfilledge(struct EditVert *v1, struct EditVert *v2);
308 int BLI_edgefill(int mode, int mat_nr);
309 void BLI_end_edgefill(void);
310
311 /* noise.h: */
312 float BLI_hnoise(float noisesize, float x, float y, float z);
313 float BLI_hnoisep(float noisesize, float x, float y, float z);
314 float BLI_turbulence(float noisesize, float x, float y, float z, int nr);
315 float BLI_turbulence1(float noisesize, float x, float y, float z, int nr);
316 /* newnoise: generic noise & turbulence functions to replace the above BLI_hnoise/p & BLI_turbulence/1.
317  * This is done so different noise basis functions can be used */
318 float BLI_gNoise(float noisesize, float x, float y, float z, int hard, int noisebasis);
319 float BLI_gTurbulence(float noisesize, float x, float y, float z, int oct, int hard, int noisebasis);
320 /* newnoise: musgrave functions */
321 float mg_fBm(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
322 float mg_MultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
323 float mg_VLNoise(float x, float y, float z, float distortion, int nbas1, int nbas2);
324 float mg_HeteroTerrain(float x, float y, float z, float H, float lacunarity, float octaves, float offset, int noisebasis);
325 float mg_HybridMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
326 float mg_RidgedMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
327 /* newnoise: voronoi */
328 void voronoi(float x, float y, float z, float* da, float* pa, float me, int dtype);
329 /* newnoise: cellNoise & cellNoiseV (for vector/point/color) */
330 float cellNoise(float x, float y, float z);
331 void cellNoiseV(float x, float y, float z, float *ca);
332
333 /* These callbacks are needed to make the lib finction properly */
334
335 /**
336  * Set a function taking a char* as argument to flag errors. If the
337  * callback is not set, the error is discarded.
338  * @param f The function to use as callback
339  * @attention used in creator.c
340  */
341 void BLI_setErrorCallBack(void (*f)(char*));
342
343 /**
344  * Set a function to be able to interrupt the execution of processing
345  * in this module. If the function returns true, the execution will
346  * terminate gracefully. If the callback is not set, interruption is
347  * not possible.
348  * @param f The function to use as callback
349  * @attention used in creator.c
350  */
351 void BLI_setInterruptCallBack(int (*f)(void));
352
353 char *BLI_strcasestr(const char *s, const char *find);
354 int BLI_strcasecmp(const char *s1, const char *s2);
355 int BLI_strncasecmp(const char *s1, const char *s2, int n);
356 void BLI_timestr(double time, char *str);
357
358 #define PRNTSUB(type,arg)                       printf(#arg ": %" #type " ", arg)
359
360 #ifndef PRINT
361 #define PRINT(t,v)                                      {PRNTSUB(t,v); printf("\n");}
362 #define PRINT2(t1,v1,t2,v2)                     {PRNTSUB(t1,v1); PRNTSUB(t2,v2); printf("\n");}
363 #define PRINT3(t1,v1,t2,v2,t3,v3)       {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); printf("\n");}
364 #define PRINT4(t1,v1,t2,v2,t3,v3,t4,v4) {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); PRNTSUB(t4,v4); printf("\n");}
365 #endif
366
367 /**
368  * @param array The array in question
369  * @retval The number of elements in the array.
370  */
371 #define BLI_ARRAY_NELEMS(array)         (sizeof((array))/sizeof((array)[0]))
372
373 /**
374  * @param strct The structure of interest
375  * @param member The name of a member field of @a strct
376  * @retval The offset in bytes of @a member within @a strct
377  */
378 #define BLI_STRUCT_OFFSET(strct, member)        ((int) &((strct*) 0)->member)
379
380 #ifdef __cplusplus
381 }
382 #endif
383
384 #endif
385