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