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