doxygen: editor entry
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 /** \file BLI_blenlib.h
31  *  \ingroup bli
32  *
33  * \section aboutbli Blender LIbrary external interface
34  *
35  * \subsection about About the BLI module
36  *
37  * This is the external interface of the Blender Library. If you find
38  * a call to a BLI function that is not prototyped here, please add a
39  * prototype here. The library offers mathematical operations (mainly
40  * vector and matrix calculus), an abstraction layer for file i/o,
41  * functions for calculating Perlin noise, scanfilling services for
42  * triangles, and a system for guarded memory
43  * allocation/deallocation. There is also a patch to make MS Windows
44  * behave more or less Posix-compliant.
45  *
46  * \subsection issues Known issues with BLI
47  *
48  * - blenlib is written in C.
49  * - The posix-compliancy may move to a separate lib that deals with 
50  *   platform dependencies. (There are other platform-dependent 
51  *   fixes as well.)
52  * - The file i/o has some redundant code. It should be cleaned.
53  * - arithb.c is a very messy matrix library. We need a better 
54  *   solution.
55  * - vectorops.c is close to superfluous. It may disappear in the 
56  *   near future.
57  * 
58  * \subsection dependencies Dependencies
59  *
60  * - The blenlib uses type defines from \ref DNA, and functions from
61  * standard libraries.
62  */
63
64 #ifndef BLI_BLENLIB_H
65 #define BLI_BLENLIB_H
66
67 struct ListBase;
68
69 #include <stdlib.h>
70
71 extern char btempdir[]; /* creator.c temp dir used instead of U.tempdir, set with BLI_where_is_temp( btempdir, 1 ); */
72
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76
77 #include "BLI_listbase.h"
78
79 #include "BLI_string.h"
80
81 #include "BLI_path_util.h"
82
83 #include "BLI_storage.h"
84
85 #include "BLI_fileops.h"
86
87 #include "BLI_rect.h"
88
89 #include "BLI_noise.h"
90
91 /**
92  * @param strct The structure of interest
93  * @param member The name of a member field of @a strct
94  * @retval The offset in bytes of @a member within @a strct
95  */
96 #define BLI_STRUCT_OFFSET(strct, member)        ((int)(intptr_t) &((strct*) 0)->member)
97
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #endif