Initial revision
[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 /* let op: Sequence heeft identiek begin. */
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 pad;
66 } ID;
67
68 /**
69  * ??
70  */
71 typedef struct Library {
72         ID id;
73         ID *idblock;
74         struct FileData *filedata;
75         char name[160];
76         int tot, pad;           /* tot, idblock en filedata zijn voor lezen en schrijven */
77 } Library;
78
79 /**
80  * Defines for working with IDs.
81  *
82  * The tags represent types! This is a dirty way of enabling RTTI. The
83  * sig_byte end endian defines aren't really used much.
84  *
85  **/
86
87 #if defined(__sgi) || defined(__sparc) || defined (__PPC__) || defined (__ppc__) || defined (__BIG_ENDIAN__)
88 /* big endian */
89 #define MAKE_ID2(c, d)          ( (c)<<8 | (d) )
90 #define MOST_SIG_BYTE                           0
91 #define BBIG_ENDIAN
92 #else
93 /* little endian  */
94 #define MAKE_ID2(c, d)          ( (d)<<8 | (c) )
95 #define MOST_SIG_BYTE                           1
96 #define BLITTLE_ENDIAN
97 #endif
98
99 /* ID */
100 #define ID_SCE          MAKE_ID2('S', 'C')
101 #define ID_LI           MAKE_ID2('L', 'I')
102 #define ID_OB           MAKE_ID2('O', 'B')
103 #define ID_ME           MAKE_ID2('M', 'E')
104 #define ID_CU           MAKE_ID2('C', 'U')
105 #define ID_MB           MAKE_ID2('M', 'B')
106 #define ID_MA           MAKE_ID2('M', 'A')
107 #define ID_TE           MAKE_ID2('T', 'E')
108 #define ID_IM           MAKE_ID2('I', 'M')
109 #define ID_IK           MAKE_ID2('I', 'K')
110 #define ID_WV           MAKE_ID2('W', 'V')
111 #define ID_LT           MAKE_ID2('L', 'T')
112 #define ID_SE           MAKE_ID2('S', 'E')
113 #define ID_LF           MAKE_ID2('L', 'F')
114 #define ID_LA           MAKE_ID2('L', 'A')
115 #define ID_CA           MAKE_ID2('C', 'A')
116 #define ID_IP           MAKE_ID2('I', 'P')
117 #define ID_KE           MAKE_ID2('K', 'E')
118 #define ID_WO           MAKE_ID2('W', 'O')
119 #define ID_SCR          MAKE_ID2('S', 'R')
120 #define ID_VF           MAKE_ID2('V', 'F')
121 #define ID_TXT          MAKE_ID2('T', 'X')
122 #define ID_SO           MAKE_ID2('S', 'O')
123 #define ID_SAMPLE       MAKE_ID2('S', 'A')
124 #define ID_GR           MAKE_ID2('G', 'R')
125 #define ID_ID           MAKE_ID2('I', 'D')
126 #define ID_SEQ          MAKE_ID2('S', 'Q')
127 #define ID_AR           MAKE_ID2('A', 'R')
128 #define ID_AC           MAKE_ID2('A', 'C')
129
130 #define IPO_CO          MAKE_ID2('C', 'O')      /* NOTE! This is not an ID, but is needed for g.sipo->blocktype */
131
132 /* id->flag: eerste 8 bits altijd op nul zetten bij inlezen */
133 /* (always zero the first 8 bits when reading a file) */
134 #define LIB_LOCAL               0
135 #define LIB_EXTERN              1
136 #define LIB_INDIRECT    2
137 #define LIB_TEST                8
138 #define LIB_TESTEXT             9
139 #define LIB_TESTIND             10
140 #define LIB_READ                16
141 #define LIB_NEEDLINK    32
142
143 #define LIB_NEW                 256
144 #define LIB_FAKEUSER    512
145 /* vrije testflag */
146 #define LIB_DOIT                1024
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif