Merged changes in the trunk up to revision 55357.
[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 "BKE_idcode.h"
41
42 typedef struct {
43         unsigned short code;
44         const char *name, *plural;
45         
46         int flags;
47 #define IDTYPE_FLAGS_ISLINKABLE (1 << 0)
48 } IDType;
49
50 /* plural need to match rna_main.c's MainCollectionDef */
51 /* WARNING! Keep it in sync with i18n contexts in BLF_translation.h */
52 static IDType idtypes[] = {
53         { ID_AC,     "Action",           "actions",         IDTYPE_FLAGS_ISLINKABLE },
54         { ID_AR,     "Armature",         "armatures",       IDTYPE_FLAGS_ISLINKABLE },
55         { ID_BR,     "Brush",            "brushes",         IDTYPE_FLAGS_ISLINKABLE },
56         { ID_CA,     "Camera",           "cameras",         IDTYPE_FLAGS_ISLINKABLE },
57         { ID_CU,     "Curve",            "curves",          IDTYPE_FLAGS_ISLINKABLE },
58         { ID_GD,     "GPencil",          "grease_pencil",   IDTYPE_FLAGS_ISLINKABLE }, /* rename gpencil */
59         { ID_GR,     "Group",            "groups",          IDTYPE_FLAGS_ISLINKABLE },
60         { ID_ID,     "ID",               "ids",             0                       }, /* plural is fake */
61         { ID_IM,     "Image",            "images",          IDTYPE_FLAGS_ISLINKABLE },
62         { ID_IP,     "Ipo",              "ipos",            IDTYPE_FLAGS_ISLINKABLE }, /* deprecated */
63         { ID_KE,     "Key",              "shape_keys",      0                       },
64         { ID_LA,     "Lamp",             "lamps",           IDTYPE_FLAGS_ISLINKABLE },
65         { ID_LI,     "Library",          "libraries",       0                       },
66 #ifdef WITH_FREESTYLE
67         { ID_LS,     "FreestyleLineStyle", "linestyles",    IDTYPE_FLAGS_ISLINKABLE },
68 #endif
69         { ID_LT,     "Lattice",          "lattices",        IDTYPE_FLAGS_ISLINKABLE },
70         { ID_MA,     "Material",         "materials",       IDTYPE_FLAGS_ISLINKABLE },
71         { ID_MB,     "Metaball",         "metaballs",       IDTYPE_FLAGS_ISLINKABLE },
72         { ID_MC,     "MovieClip",        "movieclips",      IDTYPE_FLAGS_ISLINKABLE },
73         { ID_ME,     "Mesh",             "meshes",          IDTYPE_FLAGS_ISLINKABLE },
74         { ID_MSK,    "Mask",             "masks",           IDTYPE_FLAGS_ISLINKABLE },
75         { ID_NT,     "NodeTree",         "node_groups",     IDTYPE_FLAGS_ISLINKABLE },
76         { ID_OB,     "Object",           "objects",         IDTYPE_FLAGS_ISLINKABLE },
77         { ID_PA,     "ParticleSettings", "particles",       0                       },
78         { ID_SCE,    "Scene",            "scenes",          IDTYPE_FLAGS_ISLINKABLE },
79         { ID_SCR,    "Screen",           "screens",         0                       },
80         { ID_SEQ,    "Sequence",         "sequences",       0                       }, /* not actually ID data */
81         { ID_SPK,    "Speaker",          "speakers",        IDTYPE_FLAGS_ISLINKABLE },
82         { ID_SO,     "Sound",            "sounds",          IDTYPE_FLAGS_ISLINKABLE },
83         { ID_TE,     "Texture",          "textures",        IDTYPE_FLAGS_ISLINKABLE },
84         { ID_TXT,    "Text",             "texts",           IDTYPE_FLAGS_ISLINKABLE },
85         { ID_VF,     "VFont",            "fonts",           IDTYPE_FLAGS_ISLINKABLE },
86         { ID_WO,     "World",            "worlds",          IDTYPE_FLAGS_ISLINKABLE },
87         { ID_WM,     "WindowManager",    "window_managers", 0                       },
88 };
89 static int nidtypes = sizeof(idtypes) / sizeof(idtypes[0]);
90
91 static IDType *idtype_from_name(const char *str) 
92 {
93         int i = nidtypes;
94         
95         while (i--) {
96                 if (STREQ(str, idtypes[i].name)) {
97                         return &idtypes[i];
98                 }
99         }
100
101         return NULL;
102 }
103 static IDType *idtype_from_code(int code) 
104 {
105         int i = nidtypes;
106         
107         while (i--)
108                 if (code == idtypes[i].code)
109                         return &idtypes[i];
110         
111         return NULL;
112 }
113
114 bool BKE_idcode_is_valid(int code)
115 {
116         return idtype_from_code(code) ? true : false;
117 }
118
119 bool BKE_idcode_is_linkable(int code)
120 {
121         IDType *idt = idtype_from_code(code);
122         return idt ? ((idt->flags & IDTYPE_FLAGS_ISLINKABLE) != 0) : false;
123 }
124
125 const char *BKE_idcode_to_name(int code) 
126 {
127         IDType *idt = idtype_from_code(code);
128         
129         return idt ? idt->name : NULL;
130 }
131
132 int BKE_idcode_from_name(const char *name) 
133 {
134         IDType *idt = idtype_from_name(name);
135         
136         return idt ? idt->code : 0;
137 }
138
139 const char *BKE_idcode_to_name_plural(int code) 
140 {
141         IDType *idt = idtype_from_code(code);
142         
143         return idt ? idt->plural : NULL;
144 }
145
146 int BKE_idcode_iter_step(int *index)
147 {
148         return (*index < nidtypes) ? idtypes[(*index)++].code : 0;
149 }