Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / idcode.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * return info about ID types
27  */
28
29 /** \file blender/blenkernel/intern/idcode.c
30  *  \ingroup bke
31  */
32
33 #include <stdlib.h>
34 #include <string.h>
35
36 #include "DNA_ID.h"
37
38 #include "BLI_utildefines.h"
39
40 #include "BLT_translation.h"
41
42 #include "BKE_library.h"
43 #include "BKE_idcode.h"
44
45 typedef struct {
46         unsigned short code;
47         const char *name, *plural;
48
49         const char *i18n_context;
50         
51         int flags;
52 #define IDTYPE_FLAGS_ISLINKABLE (1 << 0)
53 } IDType;
54
55 /* plural need to match rna_main.c's MainCollectionDef */
56 /* WARNING! Keep it in sync with i18n contexts in BLT_translation.h */
57 static IDType idtypes[] = {
58         /** ID's directly below must all be in #Main, and be kept in sync with #MAX_LIBARRAY (membership, not order) */
59         { ID_AC,   "Action",             "actions",         BLT_I18NCONTEXT_ID_ACTION,             IDTYPE_FLAGS_ISLINKABLE },
60         { ID_AR,   "Armature",           "armatures",       BLT_I18NCONTEXT_ID_ARMATURE,           IDTYPE_FLAGS_ISLINKABLE },
61         { ID_BR,   "Brush",              "brushes",         BLT_I18NCONTEXT_ID_BRUSH,              IDTYPE_FLAGS_ISLINKABLE },
62         { ID_CA,   "Camera",             "cameras",         BLT_I18NCONTEXT_ID_CAMERA,             IDTYPE_FLAGS_ISLINKABLE },
63         { ID_CU,   "Curve",              "curves",          BLT_I18NCONTEXT_ID_CURVE,              IDTYPE_FLAGS_ISLINKABLE },
64         { ID_GD,   "GPencil",            "grease_pencil",   BLT_I18NCONTEXT_ID_GPENCIL,            IDTYPE_FLAGS_ISLINKABLE }, /* rename gpencil */
65         { ID_GR,   "Group",              "groups",          BLT_I18NCONTEXT_ID_GROUP,              IDTYPE_FLAGS_ISLINKABLE },
66         { ID_IM,   "Image",              "images",          BLT_I18NCONTEXT_ID_IMAGE,              IDTYPE_FLAGS_ISLINKABLE },
67         { ID_IP,   "Ipo",                "ipos",            "",                                    IDTYPE_FLAGS_ISLINKABLE }, /* deprecated */
68         { ID_KE,   "Key",                "shape_keys",      BLT_I18NCONTEXT_ID_SHAPEKEY,           0                       },
69         { ID_LA,   "Lamp",               "lamps",           BLT_I18NCONTEXT_ID_LAMP,               IDTYPE_FLAGS_ISLINKABLE },
70         { ID_LI,   "Library",            "libraries",       BLT_I18NCONTEXT_ID_LIBRARY,            0                       },
71         { ID_LS,   "FreestyleLineStyle", "linestyles",      BLT_I18NCONTEXT_ID_FREESTYLELINESTYLE, IDTYPE_FLAGS_ISLINKABLE },
72         { ID_LT,   "Lattice",            "lattices",        BLT_I18NCONTEXT_ID_LATTICE,            IDTYPE_FLAGS_ISLINKABLE },
73         { ID_MA,   "Material",           "materials",       BLT_I18NCONTEXT_ID_MATERIAL,           IDTYPE_FLAGS_ISLINKABLE },
74         { ID_MB,   "Metaball",           "metaballs",       BLT_I18NCONTEXT_ID_METABALL,           IDTYPE_FLAGS_ISLINKABLE },
75         { ID_MC,   "MovieClip",          "movieclips",      BLT_I18NCONTEXT_ID_MOVIECLIP,          IDTYPE_FLAGS_ISLINKABLE },
76         { ID_ME,   "Mesh",               "meshes",          BLT_I18NCONTEXT_ID_MESH,               IDTYPE_FLAGS_ISLINKABLE },
77         { ID_MSK,  "Mask",               "masks",           BLT_I18NCONTEXT_ID_MASK,               IDTYPE_FLAGS_ISLINKABLE },
78         { ID_NT,   "NodeTree",           "node_groups",     BLT_I18NCONTEXT_ID_NODETREE,           IDTYPE_FLAGS_ISLINKABLE },
79         { ID_OB,   "Object",             "objects",         BLT_I18NCONTEXT_ID_OBJECT,             IDTYPE_FLAGS_ISLINKABLE },
80         { ID_PAL,  "Palettes",           "palettes",        BLT_I18NCONTEXT_ID_PALETTE,            IDTYPE_FLAGS_ISLINKABLE },
81         { ID_PC,   "PaintCurve",         "paint_curves",    BLT_I18NCONTEXT_ID_PAINTCURVE,         IDTYPE_FLAGS_ISLINKABLE },
82         { ID_SCE,  "Scene",              "scenes",          BLT_I18NCONTEXT_ID_SCENE,              IDTYPE_FLAGS_ISLINKABLE },
83         { ID_SCR,  "Screen",             "screens",         BLT_I18NCONTEXT_ID_SCREEN,             0                       },
84         { ID_SEQ,  "Sequence",           "sequences",       BLT_I18NCONTEXT_ID_SEQUENCE,           0                       }, /* not actually ID data */
85         { ID_SPK,  "Speaker",            "speakers",        BLT_I18NCONTEXT_ID_SPEAKER,            IDTYPE_FLAGS_ISLINKABLE },
86         { ID_SO,   "Sound",              "sounds",          BLT_I18NCONTEXT_ID_SOUND,              IDTYPE_FLAGS_ISLINKABLE },
87         { ID_TE,   "Texture",            "textures",        BLT_I18NCONTEXT_ID_TEXTURE,            IDTYPE_FLAGS_ISLINKABLE },
88         { ID_TXT,  "Text",               "texts",           BLT_I18NCONTEXT_ID_TEXT,               IDTYPE_FLAGS_ISLINKABLE },
89         { ID_VF,   "VFont",              "fonts",           BLT_I18NCONTEXT_ID_VFONT,              IDTYPE_FLAGS_ISLINKABLE },
90         { ID_WO,   "World",              "worlds",          BLT_I18NCONTEXT_ID_WORLD,              IDTYPE_FLAGS_ISLINKABLE },
91         { ID_WM,   "WindowManager",      "window_managers", BLT_I18NCONTEXT_ID_WINDOWMANAGER,      0                       },
92
93         /** Keep last, not an ID exactly, only include for completeness */
94         { ID_ID,   "ID",                 "ids",             BLT_I18NCONTEXT_ID_ID,                 0                       }, /* plural is fake */
95 };
96
97 /* -1 for ID_ID */
98 BLI_STATIC_ASSERT((ARRAY_SIZE(idtypes) - 1 == MAX_LIBARRAY), "Missing IDType");
99
100 static IDType *idtype_from_name(const char *str) 
101 {
102         int i = ARRAY_SIZE(idtypes);
103
104         while (i--) {
105                 if (STREQ(str, idtypes[i].name)) {
106                         return &idtypes[i];
107                 }
108         }
109
110         return NULL;
111 }
112 static IDType *idtype_from_code(short idcode)
113 {
114         int i = ARRAY_SIZE(idtypes);
115
116         while (i--)
117                 if (idcode == idtypes[i].code)
118                         return &idtypes[i];
119         
120         return NULL;
121 }
122
123 /**
124  * Return if the ID code is a valid ID code.
125  *
126  * \param code The code to check.
127  * \return Boolean, 0 when invalid.
128  */
129 bool BKE_idcode_is_valid(short idcode)
130 {
131         return idtype_from_code(idcode) ? true : false;
132 }
133
134 /**
135  * Return non-zero when an ID type is linkable.
136  *
137  * \param code The code to check.
138  * \return Boolean, 0 when non linkable.
139  */
140 bool BKE_idcode_is_linkable(short idcode)
141 {
142         IDType *idt = idtype_from_code(idcode);
143         BLI_assert(idt);
144         return idt ? ((idt->flags & IDTYPE_FLAGS_ISLINKABLE) != 0) : false;
145 }
146
147 /**
148  * Convert an idcode into a name.
149  *
150  * \param code The code to convert.
151  * \return A static string representing the name of
152  * the code.
153  */
154 const char *BKE_idcode_to_name(short idcode)
155 {
156         IDType *idt = idtype_from_code(idcode);
157         BLI_assert(idt);
158         return idt ? idt->name : NULL;
159 }
160
161 /**
162  * Convert a name into an idcode (ie. ID_SCE)
163  *
164  * \param name The name to convert.
165  * \return The code for the name, or 0 if invalid.
166  */
167 short BKE_idcode_from_name(const char *name)
168 {
169         IDType *idt = idtype_from_name(name);
170         BLI_assert(idt);
171         return idt ? idt->code : 0;
172 }
173
174 /**
175  * Convert an idcode into an idfilter (e.g. ID_OB -> FILTER_ID_OB).
176  */
177 int BKE_idcode_to_idfilter(const short idcode)
178 {
179 #define CASE_IDFILTER(_id) case ID_##_id: return FILTER_ID_##_id
180
181         switch (idcode) {
182                 CASE_IDFILTER(AC);
183                 CASE_IDFILTER(AR);
184                 CASE_IDFILTER(BR);
185                 CASE_IDFILTER(CA);
186                 CASE_IDFILTER(CU);
187                 CASE_IDFILTER(GD);
188                 CASE_IDFILTER(GR);
189                 CASE_IDFILTER(IM);
190                 CASE_IDFILTER(LA);
191                 CASE_IDFILTER(LS);
192                 CASE_IDFILTER(LT);
193                 CASE_IDFILTER(MA);
194                 CASE_IDFILTER(MB);
195                 CASE_IDFILTER(MC);
196                 CASE_IDFILTER(ME);
197                 CASE_IDFILTER(MSK);
198                 CASE_IDFILTER(NT);
199                 CASE_IDFILTER(OB);
200                 CASE_IDFILTER(PAL);
201                 CASE_IDFILTER(PC);
202                 CASE_IDFILTER(SCE);
203                 CASE_IDFILTER(SPK);
204                 CASE_IDFILTER(SO);
205                 CASE_IDFILTER(TE);
206                 CASE_IDFILTER(TXT);
207                 CASE_IDFILTER(VF);
208                 CASE_IDFILTER(WO);
209                 default:
210                         return 0;
211         }
212
213 #undef CASE_IDFILTER
214 }
215
216 /**
217  * Convert an idfilter into an idcode (e.g. FILTER_ID_OB -> ID_OB).
218  */
219 short BKE_idcode_from_idfilter(const int idfilter)
220 {
221 #define CASE_IDFILTER(_id) case FILTER_ID_##_id: return ID_##_id
222
223         switch (idfilter) {
224                 CASE_IDFILTER(AC);
225                 CASE_IDFILTER(AR);
226                 CASE_IDFILTER(BR);
227                 CASE_IDFILTER(CA);
228                 CASE_IDFILTER(CU);
229                 CASE_IDFILTER(GD);
230                 CASE_IDFILTER(GR);
231                 CASE_IDFILTER(IM);
232                 CASE_IDFILTER(LA);
233                 CASE_IDFILTER(LS);
234                 CASE_IDFILTER(LT);
235                 CASE_IDFILTER(MA);
236                 CASE_IDFILTER(MB);
237                 CASE_IDFILTER(MC);
238                 CASE_IDFILTER(ME);
239                 CASE_IDFILTER(MSK);
240                 CASE_IDFILTER(NT);
241                 CASE_IDFILTER(OB);
242                 CASE_IDFILTER(PAL);
243                 CASE_IDFILTER(PC);
244                 CASE_IDFILTER(SCE);
245                 CASE_IDFILTER(SPK);
246                 CASE_IDFILTER(SO);
247                 CASE_IDFILTER(TE);
248                 CASE_IDFILTER(TXT);
249                 CASE_IDFILTER(VF);
250                 CASE_IDFILTER(WO);
251                 default:
252                         return 0;
253         }
254
255 #undef CASE_IDFILTER
256 }
257
258 /**
259  * Convert an idcode into a name (plural).
260  *
261  * \param code The code to convert.
262  * \return A static string representing the name of
263  * the code.
264  */
265 const char *BKE_idcode_to_name_plural(short idcode)
266 {
267         IDType *idt = idtype_from_code(idcode);
268         BLI_assert(idt);
269         return idt ? idt->plural : NULL;
270 }
271
272 /**
273  * Convert an idcode into its translations' context.
274  *
275  * \param code The code to convert.
276  * \return A static string representing the i18n context of the code.
277  */
278 const char *BKE_idcode_to_translation_context(short idcode)
279 {
280         IDType *idt = idtype_from_code(idcode);
281         BLI_assert(idt);
282         return idt ? idt->i18n_context : BLT_I18NCONTEXT_DEFAULT;
283 }
284
285 /**
286  * Return an ID code and steps the index forward 1.
287  *
288  * \param index start as 0.
289  * \return the code, 0 when all codes have been returned.
290  */
291 short BKE_idcode_iter_step(int *index)
292 {
293         return (*index < ARRAY_SIZE(idtypes)) ? idtypes[(*index)++].code : 0;
294 }