e8bca09d50eafda009e359008b8bd922acd77a90
[blender-staging.git] / source / blender / python / BPY_menus.h
1 /* 
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * This is a new part of Blender.
24  *
25  * Contributor(s): Willian P. Germano, Matt Ebb
26  *
27  * ***** END GPL LICENSE BLOCK *****
28 */
29
30 #ifndef BPY_MENUS_H
31 #define BPY_MENUS_H
32
33 /* This header exposes BPyMenu related public declarations.  The implementation
34  * adds 'dynamic' menus to Blender, letting scripts register themselves in any
35  * of a few pre-defined (trivial to upgrade) places in menus.  These places or
36  * slots are called groups here (Import, Export, etc).  This is how it works:
37  * - scripts at dirs user pref U.pythondir and .blender/scripts/ are scanned
38  * for registration info.
39  * - this data is also saved to a Bpymenus file at the user's .blender/ dir and
40  * only re-created when the scripts folder gets modified.
41  * - on start-up Blender uses this info to fill a table, which is used to
42  * create the menu entries when they are needed (see header_info.c or
43  * header_script.c, under source/blender/src/, for examples).
44 */
45
46 /* These two structs hold py menu/submenu info.
47  * BPyMenu holds a script's name (as should appear in the menu) and filename,
48  * plus an optional list of submenus.  Each submenu is related to a string
49  * (arg) that the script can get from the __script__ pydict, to know which
50  * submenu was chosen. */
51
52 typedef struct BPySubMenu {
53         char *name;
54         char *arg;
55         struct BPySubMenu *next;
56 } BPySubMenu;
57
58 typedef struct BPyMenu {
59         char *name;
60         char *filename;
61         char *tooltip;
62         short version;          /* Blender version */
63         int dir;                /* 0: default, 1: U.pythondir */
64         struct BPySubMenu *submenus;
65         struct BPyMenu *next;
66 } BPyMenu;
67
68 /* Scripts can be added to only a few pre-defined places in menus, like
69  * File->Import, File->Export, etc. (for speed and better control).
70  * To make a new menu 'slot' available for scripts:
71  * - add an entry to the enum below, before PYMENU_TOTAL, of course;
72  * - update the bpymenu_group_atoi() and BPyMenu_group_itoa() functions in
73  * BPY_menus.c; 
74  * - add the necessary code to the header_***.c file in
75  * source/blender/src/, like done in header_info.c for import/export;
76 */
77 typedef enum {
78         PYMENU_ADD,/* creates new objects */
79         PYMENU_ANIMATION,
80         PYMENU_EXPORT,
81         PYMENU_IMPORT,
82         PYMENU_MATERIALS,
83         PYMENU_MESH,
84         PYMENU_MISC,
85         PYMENU_OBJECT,
86         PYMENU_RENDER,/* exporters to external renderers */
87         PYMENU_SYSTEM,
88         PYMENU_THEMES,
89         PYMENU_UV,/* UV editing tools, to go in UV/Image editor space, 'UV' menu */
90         PYMENU_IMAGE,/* Image editing tools, to go in UV/Image editor space, 'Image' menu */
91         PYMENU_WIZARDS,/* complex 'app' scripts */
92
93         /* entries put after Wizards don't appear at the Scripts win->Scripts menu;
94          * see define right below */
95
96         PYMENU_FACESELECT,
97         PYMENU_WEIGHTPAINT,
98         PYMENU_VERTEXPAINT,
99         PYMENU_UVCALCULATION,
100         PYMENU_ARMATURE,
101         PYMENU_SCRIPTTEMPLATE,
102         PYMENU_TEXTPLUGIN,
103         PYMENU_HELP,/*Main Help menu items - prob best to leave for 'official' ones*/
104         PYMENU_HELPSYSTEM,/* Resources, troubleshooting, system tools */
105         PYMENU_HELPWEBSITES,/* Help -> Websites submenu */
106         PYMENU_MESHFACEKEY, /* face key in mesh editmode */
107         PYMENU_ADDMESH, /* adds mesh */
108         PYMENU_TOTAL
109 } PYMENUHOOKS;
110
111 #define PYMENU_SCRIPTS_MENU_TOTAL (PYMENU_WIZARDS + 1)
112
113 /* BPyMenuTable holds all registered pymenus, as linked lists for each menu
114  * where they can appear (see PYMENUHOOKS enum above).
115 */
116 extern BPyMenu *BPyMenuTable[]; /* defined in BPY_menus.c */
117
118 /* public functions: */
119 int BPyMenu_Init( int usedir );
120 void BPyMenu_RemoveAllEntries( void );
121 void BPyMenu_PrintAllEntries( void );
122 char *BPyMenu_CreatePupmenuStr( BPyMenu * pym, short group );
123 char *BPyMenu_group_itoa( short group );
124 struct BPyMenu *BPyMenu_GetEntry( short group, short pos );
125
126 #endif                          /* BPY_MENUS_H */