Final merge of HEAD (bf-blender) into the orange branch.
[blender.git] / source / blender / makesdna / DNA_ID.h
1 /**
2  * blenlib/DNA_ID.h (mar-2001 nzc)
3  *
4  * ID and Library types, which are fundamental for sdna, 
5  *
6  * $Id$ 
7  *
8  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version. The Blender
14  * Foundation also sells licenses for use in proprietary software under
15  * the Blender License.  See http://www.blender.org/BL/ for information
16  * about this.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  *
27  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
28  * All rights reserved.
29  *
30  * The Original Code is: all of this file.
31  *
32  * Contributor(s): none yet.
33  *
34  * ***** END GPL/BL DUAL LICENSE BLOCK *****
35  */
36 #ifndef DNA_ID_H
37 #define DNA_ID_H
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /* There's a nasty circular dependency here.... void* to the rescue! I
44  * really wonder why this is needed. */
45
46 struct Library;
47 struct FileData;
48
49 /* watch it: Sequence has identical beginning. */
50 /**
51  * ID is the first thing included in all serializable types. It
52  * provides a common handle to place all data in double-linked lists.
53  * */
54 typedef struct ID {
55         void *next, *prev;
56         struct ID *newid;
57         struct Library *lib;
58         char name[24];
59         short us;
60         /**
61          * LIB_... flags report on status of the datablock this ID belongs
62          * to.
63          */
64         short flag;
65         int icon_id;
66 } ID;
67
68 /**
69  * For each library file used, a Library struct is added to Main
70  */
71 typedef struct Library {
72         ID id;
73         ID *idblock;
74         struct FileData *filedata;
75         char name[240];         /* reveiled in the UI, can store relative path */
76         char filename[240];     /* expanded name, not relative, used while reading */
77         int tot, pad;           /* tot, idblock and filedata are only fo read and write */
78 } Library;
79
80 /**
81  * Defines for working with IDs.
82  *
83  * The tags represent types! This is a dirty way of enabling RTTI. The
84  * sig_byte end endian defines aren't really used much.
85  *
86  **/
87
88 #if defined(__sgi) || defined(__sparc) || defined(__sparc__) || defined (__PPC__) || defined (__ppc__) || defined (__BIG_ENDIAN__)
89 /* big endian */
90 #define MAKE_ID2(c, d)          ( (c)<<8 | (d) )
91 #define MOST_SIG_BYTE                           0
92 #define BBIG_ENDIAN
93 #else
94 /* little endian  */
95 #define MAKE_ID2(c, d)          ( (d)<<8 | (c) )
96 #define MOST_SIG_BYTE                           1
97 #define BLITTLE_ENDIAN
98 #endif
99
100 /* ID */
101 #define ID_SCE          MAKE_ID2('S', 'C')
102 #define ID_LI           MAKE_ID2('L', 'I')
103 #define ID_OB           MAKE_ID2('O', 'B')
104 #define ID_ME           MAKE_ID2('M', 'E')
105 #define ID_CU           MAKE_ID2('C', 'U')
106 #define ID_MB           MAKE_ID2('M', 'B')
107 #define ID_MA           MAKE_ID2('M', 'A')
108 #define ID_TE           MAKE_ID2('T', 'E')
109 #define ID_IM           MAKE_ID2('I', 'M')
110 #define ID_IK           MAKE_ID2('I', 'K')
111 #define ID_WV           MAKE_ID2('W', 'V')
112 #define ID_LT           MAKE_ID2('L', 'T')
113 #define ID_SE           MAKE_ID2('S', 'E')
114 #define ID_LF           MAKE_ID2('L', 'F')
115 #define ID_LA           MAKE_ID2('L', 'A')
116 #define ID_CA           MAKE_ID2('C', 'A')
117 #define ID_IP           MAKE_ID2('I', 'P')
118 #define ID_KE           MAKE_ID2('K', 'E')
119 #define ID_WO           MAKE_ID2('W', 'O')
120 #define ID_SCR          MAKE_ID2('S', 'R')
121 #define ID_VF           MAKE_ID2('V', 'F')
122 #define ID_TXT          MAKE_ID2('T', 'X')
123 #define ID_SO           MAKE_ID2('S', 'O')
124 #define ID_SAMPLE       MAKE_ID2('S', 'A')
125 #define ID_GR           MAKE_ID2('G', 'R')
126 #define ID_ID           MAKE_ID2('I', 'D')
127 #define ID_AR           MAKE_ID2('A', 'R')
128 #define ID_AC           MAKE_ID2('A', 'C')
129 #define ID_SCRIPT       MAKE_ID2('P', 'Y')
130 #define ID_NT           MAKE_ID2('N', 'T')
131
132         /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
133 #define ID_SEQ          MAKE_ID2('S', 'Q')
134                         /* constraint */
135 #define ID_CO           MAKE_ID2('C', 'O')
136                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
137 #define ID_PO           MAKE_ID2('A', 'C')
138                         /* used in outliner... */
139 #define ID_NLA          MAKE_ID2('N', 'L')
140
141
142 /* id->flag: set frist 8 bits always at zero while reading */
143 #define LIB_LOCAL               0
144 #define LIB_EXTERN              1
145 #define LIB_INDIRECT    2
146 #define LIB_TEST                8
147 #define LIB_TESTEXT             9
148 #define LIB_TESTIND             10
149 #define LIB_READ                16
150 #define LIB_NEEDLINK    32
151
152 #define LIB_NEW                 256
153 #define LIB_FAKEUSER    512
154 /* free test flag */
155 #define LIB_DOIT                1024
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif
162