Changed frame numbering to only alter hashes if they are in the filename (not the...
[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);
154 int BLI_convertstringframe(char *path, int frame);
155
156 void BLI_makestringcode(const char *relfile, char *file);
157
158         /**
159          * Change every @a from in @a string into @a to. The
160          * result will be in @a string
161          *
162          * @a string The string to work on
163          * @a from The character to replace
164          * @a to The character to replace with
165          */
166 void BLI_char_switch(char *string, char from, char to);
167
168         /**
169          * Makes sure @a path has platform-specific slashes.
170          * 
171          * @a path The path to 'clean'
172          */
173 void BLI_clean(char *path);
174         /**
175          * Duplicates the cstring @a str into a newly mallocN'd
176          * string and returns it.
177          * 
178          * @param str The string to be duplicated
179          * @retval Returns the duplicated string
180          */
181 char *BLI_strdup(const char *str);
182
183         /**
184          * Duplicates the first @a len bytes of cstring @a str 
185          * into a newly mallocN'd string and returns it. @a str
186          * is assumed to be at least len bytes long.
187          * 
188          * @param str The string to be duplicated
189          * @param len The number of bytes to duplicate
190          * @retval Returns the duplicated string
191          */
192 char *BLI_strdupn(const char *str, int len);
193
194         /**
195          * Like strncpy but ensures dst is always
196          * '\0' terminated.
197          * 
198          * @param dst Destination for copy
199          * @param src Source string to copy
200          * @param maxncpy Maximum number of characters to copy (generally
201          *   the size of dst)
202          * @retval Returns dst
203          */
204 char *BLI_strncpy(char *dst, const char *src, int maxncpy);
205
206         /* 
207          * Replacement for snprintf
208          */
209 int BLI_snprintf(char *buffer, size_t count, const char *format, ...);
210
211         /**
212          * Compare two strings
213          * 
214          * @retval True if the strings are equal, false otherwise.
215          */
216 int BLI_streq(char *a, char *b);
217
218         /**
219          * Compare two strings without regard to case.
220          * 
221          * @retval True if the strings are equal, false otherwise.
222          */
223 int BLI_strcaseeq(char *a, char *b);
224
225 /* in util.c */
226 #ifdef WITH_ICONV
227 void BLI_string_to_utf8(char *original, char *utf_8, char *code);
228 #endif
229
230         /**
231          * Read a file as ASCII lines. An empty list is
232          * returned if the file cannot be opened or read.
233          * 
234          * @attention The returned list should be free'd with
235          * BLI_free_file_lines.
236          * 
237          * @param name The name of the file to read.
238          * @retval A list of strings representing the file lines.
239          */
240 struct LinkNode *BLI_read_file_as_lines(char *name);
241
242         /**
243          * Free the list returned by BLI_read_file_as_lines.
244          */
245 void BLI_free_file_lines(struct LinkNode *lines);
246
247         /**
248          * Checks if name is a fully qualified filename to an executable.
249          * If not it searches $PATH for the file. On Windows it also
250          * adds the correct extension (.com .exe etc) from
251          * $PATHEXT if necessary. Also on Windows it translates
252          * the name to its 8.3 version to prevent problems with
253          * spaces and stuff. Final result is returned in fullname.
254          *
255          * @param fullname The full path and full name of the executable
256          * @param name The name of the executable (usually argv[0]) to be checked
257          */
258 void BLI_where_am_i(char *fullname, const char *name);
259
260 char *get_install_dir(void);
261         /**
262          * Gets the temp directory when blender first runs.
263          * If the default path is not found, use try $TEMP
264          * 
265          * Also make sure the temp dir has a trailing slash
266          *
267          * @param fullname The full path to the temp directory
268          */
269 void BLI_where_is_temp(char *fullname, int usertemp);
270
271
272         /**
273          * determines the full path to the application bundle on OS X
274          *
275          * @return path to application bundle
276          */
277 #ifdef __APPLE__
278 char* BLI_getbundle(void);
279 #endif
280
281 #ifdef WIN32
282 int BLI_getInstallationDir(char *str);
283 #endif
284                 
285 /* BLI_storage.h */
286 int    BLI_filesize(int file);
287 int    BLI_filepathsize(const char *path);
288 double BLI_diskfree(char *dir);
289 char *BLI_getwdN(char *dir);
290 void BLI_hide_dot_files(int set);
291 unsigned int BLI_getdir(char *dirname, struct direntry **filelist);
292
293 /**
294  * @attention Do not confuse with BLI_exists
295  */
296 int    BLI_exist(char *name);
297
298 /* BLI_fileops.h */
299 void  BLI_recurdir_fileops(char *dirname);
300 int BLI_link(char *file, char *to);
301 int BLI_is_writable(char *filename);
302
303 /**
304  * @attention Do not confuse with BLI_exist
305  */
306 int   BLI_exists(char *file);
307 int   BLI_copy_fileops(char *file, char *to);
308 int   BLI_rename(char *from, char *to);
309 int   BLI_gzip(char *from, char *to);
310 int   BLI_delete(char *file, int dir, int recursive);
311 int   BLI_move(char *file, char *to);
312 int   BLI_touch(const char *file);
313 char *BLI_last_slash(const char *string);
314 void  BLI_add_slash(char *string);
315 void  BLI_del_slash(char *string);
316
317 /* BLI_rct.c */
318 /**
319  * Determine if a rect is empty. An empty
320  * rect is one with a zero (or negative)
321  * width or height.
322  *
323  * @return True if @a rect is empty.
324  */
325 int  BLI_rcti_is_empty(struct rcti *rect);
326 void BLI_init_rctf(struct rctf *rect, float xmin, float xmax, float ymin, float ymax);
327 void BLI_init_rcti(struct rcti *rect, int xmin, int xmax, int ymin, int ymax);
328 void BLI_translate_rctf(struct rctf *rect, float x, float y);
329 void BLI_translate_rcti(struct rcti *rect, int x, int y);
330 int  BLI_in_rcti(struct rcti *rect, int x, int y);
331 int  BLI_in_rctf(struct rctf *rect, float x, float y);
332 int  BLI_isect_rctf(struct rctf *src1, struct rctf *src2, struct rctf *dest);
333 int  BLI_isect_rcti(struct rcti *src1, struct rcti *src2, struct rcti *dest);
334 void BLI_union_rctf(struct rctf *rcta, struct rctf *rctb);
335
336 /* scanfill.c: used in displist only... */
337 struct EditVert *BLI_addfillvert(float *vec);
338 struct EditEdge *BLI_addfilledge(struct EditVert *v1, struct EditVert *v2);
339 int BLI_edgefill(int mode, int mat_nr);
340 void BLI_end_edgefill(void);
341
342 /* noise.h: */
343 float BLI_hnoise(float noisesize, float x, float y, float z);
344 float BLI_hnoisep(float noisesize, float x, float y, float z);
345 float BLI_turbulence(float noisesize, float x, float y, float z, int nr);
346 float BLI_turbulence1(float noisesize, float x, float y, float z, int nr);
347 /* newnoise: generic noise & turbulence functions to replace the above BLI_hnoise/p & BLI_turbulence/1.
348  * This is done so different noise basis functions can be used */
349 float BLI_gNoise(float noisesize, float x, float y, float z, int hard, int noisebasis);
350 float BLI_gTurbulence(float noisesize, float x, float y, float z, int oct, int hard, int noisebasis);
351 /* newnoise: musgrave functions */
352 float mg_fBm(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
353 float mg_MultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
354 float mg_VLNoise(float x, float y, float z, float distortion, int nbas1, int nbas2);
355 float mg_HeteroTerrain(float x, float y, float z, float H, float lacunarity, float octaves, float offset, int noisebasis);
356 float mg_HybridMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
357 float mg_RidgedMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
358 /* newnoise: voronoi */
359 void voronoi(float x, float y, float z, float* da, float* pa, float me, int dtype);
360 /* newnoise: cellNoise & cellNoiseV (for vector/point/color) */
361 float cellNoise(float x, float y, float z);
362 void cellNoiseV(float x, float y, float z, float *ca);
363
364 /* These callbacks are needed to make the lib finction properly */
365
366 /**
367  * Set a function taking a char* as argument to flag errors. If the
368  * callback is not set, the error is discarded.
369  * @param f The function to use as callback
370  * @attention used in creator.c
371  */
372 void BLI_setErrorCallBack(void (*f)(char*));
373
374 /**
375  * Set a function to be able to interrupt the execution of processing
376  * in this module. If the function returns true, the execution will
377  * terminate gracefully. If the callback is not set, interruption is
378  * not possible.
379  * @param f The function to use as callback
380  * @attention used in creator.c
381  */
382 void BLI_setInterruptCallBack(int (*f)(void));
383
384 char *BLI_strcasestr(const char *s, const char *find);
385 int BLI_strcasecmp(const char *s1, const char *s2);
386 int BLI_strncasecmp(const char *s1, const char *s2, int n);
387 void BLI_timestr(double _time, char *str); /* time var is global */
388
389 /** 
390   * Trick to address 32 GB with an int (only for malloced pointers)
391   */
392 int BLI_int_from_pointer(void *poin);
393 void *BLI_pointer_from_int(int val);
394
395
396 #define PRNTSUB(type,arg)                       printf(#arg ": %" #type " ", arg)
397
398 #ifndef PRINT
399 #define PRINT(t,v)                                      {PRNTSUB(t,v); printf("\n");}
400 #define PRINT2(t1,v1,t2,v2)                     {PRNTSUB(t1,v1); PRNTSUB(t2,v2); printf("\n");}
401 #define PRINT3(t1,v1,t2,v2,t3,v3)       {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); printf("\n");}
402 #define PRINT4(t1,v1,t2,v2,t3,v3,t4,v4) {PRNTSUB(t1,v1); PRNTSUB(t2,v2); PRNTSUB(t3,v3); PRNTSUB(t4,v4); printf("\n");}
403 #endif
404
405 /**
406  * @param array The array in question
407  * @retval The number of elements in the array.
408  */
409 #define BLI_ARRAY_NELEMS(array)         (sizeof((array))/sizeof((array)[0]))
410
411 /**
412  * @param strct The structure of interest
413  * @param member The name of a member field of @a strct
414  * @retval The offset in bytes of @a member within @a strct
415  */
416 #define BLI_STRUCT_OFFSET(strct, member)        ((int) &((strct*) 0)->member)
417
418 #ifdef __cplusplus
419 }
420 #endif
421
422 #endif