doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / intern / blender_user_menu.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bke
19  *
20  * User defined menu API.
21  */
22
23 #include <string.h>
24
25 #include "MEM_guardedalloc.h"
26
27 #include "BLI_listbase.h"
28 #include "BLI_string.h"
29
30 #include "DNA_userdef_types.h"
31
32 #include "BKE_blender_user_menu.h"
33 #include "BKE_idprop.h"
34
35 /* -------------------------------------------------------------------- */
36 /** \name Menu Type
37  * \{ */
38
39 bUserMenu *BKE_blender_user_menu_find(
40         ListBase *lb, char space_type, const char *context)
41 {
42         for (bUserMenu *um = lb->first; um; um = um->next) {
43                 if ((space_type == um->space_type) &&
44                     (STREQ(context, um->context)))
45                 {
46                         return um;
47                 }
48         }
49         return NULL;
50 }
51
52 bUserMenu *BKE_blender_user_menu_ensure(
53         ListBase *lb, char space_type, const char *context)
54 {
55         bUserMenu *um = BKE_blender_user_menu_find(lb, space_type, context);
56         if (um == NULL) {
57                 um = MEM_callocN(sizeof(bUserMenu), __func__);
58                 um->space_type = space_type;
59                 STRNCPY(um->context, context);
60                 BLI_addhead(lb, um);
61         }
62         return um;
63 }
64
65 /** \} */
66
67 /* -------------------------------------------------------------------- */
68 /** \name Menu Item
69  * \{ */
70
71 bUserMenuItem *BKE_blender_user_menu_item_add(ListBase *lb, int type)
72 {
73         uint size;
74
75         if (type == USER_MENU_TYPE_SEP) {
76                 size = sizeof(bUserMenuItem);
77         }
78         else if (type == USER_MENU_TYPE_OPERATOR) {
79                 size = sizeof(bUserMenuItem_Op);
80         }
81         else if (type == USER_MENU_TYPE_MENU) {
82                 size = sizeof(bUserMenuItem_Menu);
83         }
84         else if (type == USER_MENU_TYPE_PROP) {
85                 size = sizeof(bUserMenuItem_Prop);
86         }
87         else {
88                 size = sizeof(bUserMenuItem);
89                 BLI_assert(0);
90         }
91
92         bUserMenuItem *umi = MEM_callocN(size, __func__);
93         umi->type = type;
94         BLI_addtail(lb, umi);
95         return umi;
96 }
97
98 void BKE_blender_user_menu_item_free(bUserMenuItem *umi)
99 {
100         if (umi->type == USER_MENU_TYPE_OPERATOR) {
101                 bUserMenuItem_Op *umi_op = (bUserMenuItem_Op *)umi;
102                 if (umi_op->prop) {
103                         IDP_FreeProperty(umi_op->prop);
104                         MEM_freeN(umi_op->prop);
105                 }
106         }
107         MEM_freeN(umi);
108 }
109
110 void BKE_blender_user_menu_item_free_list(ListBase *lb)
111 {
112         for (bUserMenuItem *umi = lb->first, *umi_next; umi; umi = umi_next) {
113                 umi_next = umi->next;
114                 BKE_blender_user_menu_item_free(umi);
115         }
116         BLI_listbase_clear(lb);
117 }