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