source/blender/makesrna/intern/rna_wm_api.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
  17  * All rights reserved.
  18  */
  19
  20 /** \file
  21  * \ingroup RNA
  22  */
  23
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <ctype.h>
  27
  28 #include "BLI_utildefines.h"
  29
  30 #include "RNA_define.h"
  31 #include "RNA_enum_types.h"
  32
  33 #include "DNA_screen_types.h"
  34 #include "DNA_space_types.h"
  35 #include "DNA_windowmanager_types.h"
  36
  37 #include "UI_interface.h"
  38
  39 #include "wm_cursors.h"
  40 #include "wm_event_types.h"
  41
  42 #include "rna_internal.h" /* own include */
  43
  44 /* confusingm 2 enums mixed up here */
  45 const EnumPropertyItem rna_enum_window_cursor_items[] = {
  46     {CURSOR_STD, "DEFAULT", 0, "Default", ""},
  47     {CURSOR_NONE, "NONE", 0, "None", ""},
  48     {CURSOR_WAIT, "WAIT", 0, "Wait", ""},
  49     {CURSOR_EDIT, "CROSSHAIR", 0, "Crosshair", ""},
  50     {CURSOR_X_MOVE, "MOVE_X", 0, "Move-X", ""},
  51     {CURSOR_Y_MOVE, "MOVE_Y", 0, "Move-Y", ""},
  52
  53     /* new */
  54     {BC_KNIFECURSOR, "KNIFE", 0, "Knife", ""},
  55     {BC_TEXTEDITCURSOR, "TEXT", 0, "Text", ""},
  56     {BC_PAINTBRUSHCURSOR, "PAINT_BRUSH", 0, "Paint Brush", ""},
  57     {BC_HANDCURSOR, "HAND", 0, "Hand", ""},
  58     {BC_EW_SCROLLCURSOR, "SCROLL_X", 0, "Scroll-X", ""},
  59     {BC_NS_SCROLLCURSOR, "SCROLL_Y", 0, "Scroll-Y", ""},
  60     {BC_NSEW_SCROLLCURSOR, "SCROLL_XY", 0, "Scroll-XY", ""},
  61     {BC_EYEDROPPER_CURSOR, "EYEDROPPER", 0, "Eyedropper", ""},
  62     {0, NULL, 0, NULL, NULL},
  63 };
  64
  65 #ifdef RNA_RUNTIME
  66
  67 #  include "BKE_context.h"
  68 #  include "BKE_undo_system.h"
  69
  70 #  include "WM_types.h"
  71
  72 static void rna_KeyMapItem_to_string(wmKeyMapItem *kmi, bool compact, char *result)
  73 {
  74   WM_keymap_item_to_string(kmi, compact, result, UI_MAX_SHORTCUT_STR);
  75 }
  76
  77 static wmKeyMap *rna_keymap_active(wmKeyMap *km, bContext *C)
  78 {
  79   wmWindowManager *wm = CTX_wm_manager(C);
  80   return WM_keymap_active(wm, km);
  81 }
  82
  83 static void rna_keymap_restore_item_to_default(wmKeyMap *km, bContext *C, wmKeyMapItem *kmi)
  84 {
  85   WM_keymap_item_restore_to_default(C, km, kmi);
  86 }
  87
  88 static void rna_Operator_report(wmOperator *op, int type, const char *msg)
  89 {
  90   BKE_report(op->reports, type, msg);
  91 }
  92
  93 static bool rna_Operator_is_repeat(wmOperator *op, bContext *C)
  94 {
  95   return WM_operator_is_repeat(C, op);
  96 }
  97
  98 /* since event isn't needed... */
  99 static void rna_Operator_enum_search_invoke(bContext *C, wmOperator *op)
 100 {
 101   WM_enum_search_invoke(C, op, NULL);
 102 }
 103
 104 static bool rna_event_modal_handler_add(struct bContext *C, struct wmOperator *operator)
 105 {
 106   return WM_event_add_modal_handler(C, operator) != NULL;
 107 }
 108
 109 /* XXX, need a way for python to know event types, 0x0110 is hard coded */
 110 static wmTimer *rna_event_timer_add(struct wmWindowManager *wm, float time_step, wmWindow *win)
 111 {
 112   return WM_event_add_timer(wm, win, 0x0110, time_step);
 113 }
 114
 115 static void rna_event_timer_remove(struct wmWindowManager *wm, wmTimer *timer)
 116 {
 117   WM_event_remove_timer(wm, timer->win, timer);
 118 }
 119
 120 static wmGizmoGroupType *wm_gizmogrouptype_find_for_add_remove(ReportList *reports,
 121                                                                const char *idname)
 122 {
 123   wmGizmoGroupType *gzgt = WM_gizmogrouptype_find(idname, true);
 124   if (gzgt == NULL) {
 125     BKE_reportf(reports, RPT_ERROR, "Gizmo group type '%s' not found!", idname);
 126     return NULL;
 127   }
 128   if (gzgt->flag & WM_GIZMOGROUPTYPE_PERSISTENT) {
 129     BKE_reportf(reports, RPT_ERROR, "Gizmo group '%s' has 'PERSISTENT' option set!", idname);
 130     return NULL;
 131   }
 132   return gzgt;
 133 }
 134
 135 static void rna_gizmo_group_type_ensure(ReportList *reports, const char *idname)
 136 {
 137   wmGizmoGroupType *gzgt = wm_gizmogrouptype_find_for_add_remove(reports, idname);
 138   if (gzgt != NULL) {
 139     WM_gizmo_group_type_ensure_ptr(gzgt);
 140   }
 141 }
 142
 143 static void rna_gizmo_group_type_unlink_delayed(ReportList *reports, const char *idname)
 144 {
 145   wmGizmoGroupType *gzgt = wm_gizmogrouptype_find_for_add_remove(reports, idname);
 146   if (gzgt != NULL) {
 147     WM_gizmo_group_type_unlink_delayed_ptr(gzgt);
 148   }
 149 }
 150
 151 /* placeholder data for final implementation of a true progressbar */
 152 static struct wmStaticProgress {
 153   float min;
 154   float max;
 155   bool is_valid;
 156 } wm_progress_state = {0, 0, false};
 157
 158 static void rna_progress_begin(struct wmWindowManager *UNUSED(wm), float min, float max)
 159 {
 160   float range = max - min;
 161   if (range != 0) {
 162     wm_progress_state.min = min;
 163     wm_progress_state.max = max;
 164     wm_progress_state.is_valid = true;
 165   }
 166   else {
 167     wm_progress_state.is_valid = false;
 168   }
 169 }
 170
 171 static void rna_progress_update(struct wmWindowManager *wm, float value)
 172 {
 173   if (wm_progress_state.is_valid) {
 174     /* Map to cursor_time range [0,9999] */
 175     wmWindow *win = wm->winactive;
 176     if (win) {
 177       int val = (int)(10000 * (value - wm_progress_state.min) /
 178                       (wm_progress_state.max - wm_progress_state.min));
 179       WM_cursor_time(win, val);
 180     }
 181   }
 182 }
 183
 184 static void rna_progress_end(struct wmWindowManager *wm)
 185 {
 186   if (wm_progress_state.is_valid) {
 187     wmWindow *win = wm->winactive;
 188     if (win) {
 189       WM_cursor_modal_restore(win);
 190       wm_progress_state.is_valid = false;
 191     }
 192   }
 193 }
 194
 195 /* wrap these because of 'const wmEvent *' */
 196 static int rna_Operator_confirm(bContext *C, wmOperator *op, wmEvent *event)
 197 {
 198   return WM_operator_confirm(C, op, event);
 199 }
 200 static int rna_Operator_props_popup(bContext *C, wmOperator *op, wmEvent *event)
 201 {
 202   return WM_operator_props_popup(C, op, event);
 203 }
 204
 205 static wmKeyMapItem *rna_KeyMap_item_new(wmKeyMap *km,
 206                                          ReportList *reports,
 207                                          const char *idname,
 208                                          int type,
 209                                          int value,
 210                                          bool any,
 211                                          bool shift,
 212                                          bool ctrl,
 213                                          bool alt,
 214                                          bool oskey,
 215                                          int keymodifier,
 216                                          bool head)
 217 {
 218   /*  wmWindowManager *wm = CTX_wm_manager(C); */
 219   wmKeyMapItem *kmi = NULL;
 220   char idname_bl[OP_MAX_TYPENAME];
 221   int modifier = 0;
 222
 223   /* only on non-modal maps */
 224   if (km->flag & KEYMAP_MODAL) {
 225     BKE_report(reports, RPT_ERROR, "Not a non-modal keymap");
 226     return NULL;
 227   }
 228
 229   WM_operator_bl_idname(idname_bl, idname);
 230
 231   if (shift) {
 232     modifier |= KM_SHIFT;
 233   }
 234   if (ctrl) {
 235     modifier |= KM_CTRL;
 236   }
 237   if (alt) {
 238     modifier |= KM_ALT;
 239   }
 240   if (oskey) {
 241     modifier |= KM_OSKEY;
 242   }
 243
 244   if (any) {
 245     modifier = KM_ANY;
 246   }
 247
 248   /* create keymap item */
 249   kmi = WM_keymap_add_item(km, idname_bl, type, value, modifier, keymodifier);
 250
 251   /* [#32437] allow scripts to define hotkeys that get added to start of keymap
 252    *          so that they stand a chance against catch-all defines later on
 253    */
 254   if (head) {
 255     BLI_remlink(&km->items, kmi);
 256     BLI_addhead(&km->items, kmi);
 257   }
 258
 259   return kmi;
 260 }
 261
 262 static wmKeyMapItem *rna_KeyMap_item_new_from_item(wmKeyMap *km,
 263                                                    ReportList *reports,
 264                                                    wmKeyMapItem *kmi_src,
 265                                                    bool head)
 266 {
 267   /*  wmWindowManager *wm = CTX_wm_manager(C); */
 268
 269   if ((km->flag & KEYMAP_MODAL) == (kmi_src->idname[0] != '\0')) {
 270     BKE_report(reports, RPT_ERROR, "Can not mix modal/non-modal items");
 271     return NULL;
 272   }
 273
 274   /* create keymap item */
 275   wmKeyMapItem *kmi = WM_keymap_add_item_copy(km, kmi_src);
 276   if (head) {
 277     BLI_remlink(&km->items, kmi);
 278     BLI_addhead(&km->items, kmi);
 279   }
 280   return kmi;
 281 }
 282
 283 static wmKeyMapItem *rna_KeyMap_item_new_modal(wmKeyMap *km,
 284                                                ReportList *reports,
 285                                                const char *propvalue_str,
 286                                                int type,
 287                                                int value,
 288                                                bool any,
 289                                                bool shift,
 290                                                bool ctrl,
 291                                                bool alt,
 292                                                bool oskey,
 293                                                int keymodifier)
 294 {
 295   int modifier = 0;
 296   int propvalue = 0;
 297
 298   /* only modal maps */
 299   if ((km->flag & KEYMAP_MODAL) == 0) {
 300     BKE_report(reports, RPT_ERROR, "Not a modal keymap");
 301     return NULL;
 302   }
 303
 304   if (shift) {
 305     modifier |= KM_SHIFT;
 306   }
 307   if (ctrl) {
 308     modifier |= KM_CTRL;
 309   }
 310   if (alt) {
 311     modifier |= KM_ALT;
 312   }
 313   if (oskey) {
 314     modifier |= KM_OSKEY;
 315   }
 316
 317   if (any) {
 318     modifier = KM_ANY;
 319   }
 320
 321   /* not initialized yet, do delayed lookup */
 322   if (!km->modal_items) {
 323     return WM_modalkeymap_add_item_str(km, type, value, modifier, keymodifier, propvalue_str);
 324   }
 325
 326   if (RNA_enum_value_from_id(km->modal_items, propvalue_str, &propvalue) == 0) {
 327     BKE_report(reports, RPT_WARNING, "Property value not in enumeration");
 328   }
 329
 330   return WM_modalkeymap_add_item(km, type, value, modifier, keymodifier, propvalue);
 331 }
 332
 333 static void rna_KeyMap_item_remove(wmKeyMap *km, ReportList *reports, PointerRNA *kmi_ptr)
 334 {
 335   wmKeyMapItem *kmi = kmi_ptr->data;
 336
 337   if (WM_keymap_remove_item(km, kmi) == false) {
 338     BKE_reportf(reports,
 339                 RPT_ERROR,
 340                 "KeyMapItem '%s' cannot be removed from '%s'",
 341                 kmi->idname,
 342                 km->idname);
 343     return;
 344   }
 345
 346   RNA_POINTER_INVALIDATE(kmi_ptr);
 347 }
 348
 349 static PointerRNA rna_KeyMap_item_find_from_operator(ID *id,
 350                                                      wmKeyMap *km,
 351                                                      const char *idname,
 352                                                      PointerRNA *properties,
 353                                                      int include_mask,
 354                                                      int exclude_mask)
 355 {
 356   char idname_bl[OP_MAX_TYPENAME];
 357   WM_operator_bl_idname(idname_bl, idname);
 358
 359   wmKeyMapItem *kmi = WM_key_event_operator_from_keymap(
 360       km, idname_bl, properties->data, include_mask, exclude_mask);
 361   PointerRNA kmi_ptr;
 362   RNA_pointer_create(id, &RNA_KeyMapItem, kmi, &kmi_ptr);
 363   return kmi_ptr;
 364 }
 365
 366 static wmKeyMap *rna_keymap_new(
 367     wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid, bool modal, bool tool)
 368 {
 369   wmKeyMap *keymap;
 370
 371   if (modal == 0) {
 372     keymap = WM_keymap_ensure(keyconf, idname, spaceid, regionid);
 373   }
 374   else {
 375     keymap = WM_modalkeymap_add(keyconf, idname, NULL); /* items will be lazy init */
 376   }
 377
 378   if (keymap && tool) {
 379     keymap->flag |= KEYMAP_TOOL;
 380   }
 381
 382   return keymap;
 383 }
 384
 385 static wmKeyMap *rna_keymap_find(wmKeyConfig *keyconf,
 386                                  const char *idname,
 387                                  int spaceid,
 388                                  int regionid)
 389 {
 390   return WM_keymap_list_find(&keyconf->keymaps, idname, spaceid, regionid);
 391 }
 392
 393 static wmKeyMap *rna_keymap_find_modal(wmKeyConfig *UNUSED(keyconf), const char *idname)
 394 {
 395   wmOperatorType *ot = WM_operatortype_find(idname, 0);
 396
 397   if (!ot) {
 398     return NULL;
 399   }
 400   else {
 401     return ot->modalkeymap;
 402   }
 403 }
 404
 405 static void rna_KeyMap_remove(wmKeyConfig *keyconfig, ReportList *reports, PointerRNA *keymap_ptr)
 406 {
 407   wmKeyMap *keymap = keymap_ptr->data;
 408
 409   if (WM_keymap_remove(keyconfig, keymap) == false) {
 410     BKE_reportf(reports, RPT_ERROR, "KeyConfig '%s' cannot be removed", keymap->idname);
 411     return;
 412   }
 413
 414   RNA_POINTER_INVALIDATE(keymap_ptr);
 415 }
 416
 417 static void rna_KeyConfig_remove(wmWindowManager *wm, ReportList *reports, PointerRNA *keyconf_ptr)
 418 {
 419   wmKeyConfig *keyconf = keyconf_ptr->data;
 420
 421   if (WM_keyconfig_remove(wm, keyconf) == false) {
 422     BKE_reportf(reports, RPT_ERROR, "KeyConfig '%s' cannot be removed", keyconf->idname);
 423     return;
 424   }
 425
 426   RNA_POINTER_INVALIDATE(keyconf_ptr);
 427 }
 428
 429 static PointerRNA rna_KeyConfig_find_item_from_operator(wmWindowManager *wm,
 430                                                         bContext *C,
 431                                                         const char *idname,
 432                                                         int opcontext,
 433                                                         PointerRNA *properties,
 434                                                         int include_mask,
 435                                                         int exclude_mask,
 436                                                         PointerRNA *km_ptr)
 437 {
 438   char idname_bl[OP_MAX_TYPENAME];
 439   WM_operator_bl_idname(idname_bl, idname);
 440
 441   wmKeyMap *km = NULL;
 442   wmKeyMapItem *kmi = WM_key_event_operator(
 443       C, idname_bl, opcontext, properties->data, include_mask, exclude_mask, &km);
 444   PointerRNA kmi_ptr;
 445   RNA_pointer_create(&wm->id, &RNA_KeyMap, km, km_ptr);
 446   RNA_pointer_create(&wm->id, &RNA_KeyMapItem, kmi, &kmi_ptr);
 447   return kmi_ptr;
 448 }
 449
 450 static void rna_KeyConfig_update(wmWindowManager *wm)
 451 {
 452   WM_keyconfig_update(wm);
 453 }
 454
 455 /* popup menu wrapper */
 456 static PointerRNA rna_PopMenuBegin(bContext *C, const char *title, int icon)
 457 {
 458   PointerRNA r_ptr;
 459   void *data;
 460
 461   data = (void *)UI_popup_menu_begin(C, title, icon);
 462
 463   RNA_pointer_create(NULL, &RNA_UIPopupMenu, data, &r_ptr);
 464
 465   return r_ptr;
 466 }
 467
 468 static void rna_PopMenuEnd(bContext *C, PointerRNA *handle)
 469 {
 470   UI_popup_menu_end(C, handle->data);
 471 }
 472
 473 /* popover wrapper */
 474 static PointerRNA rna_PopoverBegin(bContext *C, int ui_units_x, bool from_active_button)
 475 {
 476   PointerRNA r_ptr;
 477   void *data;
 478
 479   data = (void *)UI_popover_begin(C, U.widget_unit * ui_units_x, from_active_button);
 480
 481   RNA_pointer_create(NULL, &RNA_UIPopover, data, &r_ptr);
 482
 483   return r_ptr;
 484 }
 485
 486 static void rna_PopoverEnd(bContext *C, PointerRNA *handle, wmKeyMap *keymap)
 487 {
 488   UI_popover_end(C, handle->data, keymap);
 489 }
 490
 491 /* pie menu wrapper */
 492 static PointerRNA rna_PieMenuBegin(bContext *C, const char *title, int icon, PointerRNA *event)
 493 {
 494   PointerRNA r_ptr;
 495   void *data;
 496
 497   data = (void *)UI_pie_menu_begin(C, title, icon, event->data);
 498
 499   RNA_pointer_create(NULL, &RNA_UIPieMenu, data, &r_ptr);
 500
 501   return r_ptr;
 502 }
 503
 504 static void rna_PieMenuEnd(bContext *C, PointerRNA *handle)
 505 {
 506   UI_pie_menu_end(C, handle->data);
 507 }
 508
 509 static void rna_WindowManager_print_undo_steps(wmWindowManager *wm)
 510 {
 511   BKE_undosys_print(wm->undo_stack);
 512 }
 513
 514 static PointerRNA rna_WindoManager_operator_properties_last(const char *idname)
 515 {
 516   wmOperatorType *ot = WM_operatortype_find(idname, true);
 517
 518   if (ot != NULL) {
 519     PointerRNA ptr;
 520     WM_operator_last_properties_ensure(ot, &ptr);
 521     return ptr;
 522   }
 523   return PointerRNA_NULL;
 524 }
 525
 526 static wmEvent *rna_Window_event_add_simulate(wmWindow *win,
 527                                               ReportList *reports,
 528                                               int type,
 529                                               int value,
 530                                               const char *unicode,
 531                                               int x,
 532                                               int y,
 533                                               bool shift,
 534                                               bool ctrl,
 535                                               bool alt,
 536                                               bool oskey)
 537 {
 538   if ((G.f & G_FLAG_EVENT_SIMULATE) == 0) {
 539     BKE_report(reports, RPT_ERROR, "Not running with '--enable-event-simulate' enabled");
 540     return NULL;
 541   }
 542
 543   if (!ELEM(value, KM_PRESS, KM_RELEASE, KM_NOTHING)) {
 544     BKE_report(reports, RPT_ERROR, "value: only 'PRESS/RELEASE/NOTHING' are supported");
 545     return NULL;
 546   }
 547   if (ISKEYBOARD(type) || ISMOUSE_BUTTON(type)) {
 548     if (!ELEM(value, KM_PRESS, KM_RELEASE)) {
 549       BKE_report(reports, RPT_ERROR, "value: must be 'PRESS/RELEASE' for keyboard/buttons");
 550       return NULL;
 551     }
 552   }
 553   if (ELEM(type, MOUSEMOVE, INBETWEEN_MOUSEMOVE)) {
 554     if (value != KM_NOTHING) {
 555       BKE_report(reports, RPT_ERROR, "value: must be 'NOTHING' for motion");
 556       return NULL;
 557     }
 558   }
 559   if (unicode != NULL) {
 560     if (value != KM_PRESS) {
 561       BKE_report(reports, RPT_ERROR, "value: must be 'PRESS' when unicode is set");
 562       return NULL;
 563     }
 564   }
 565   /* TODO: validate NDOF. */
 566
 567   char ascii = 0;
 568   if (unicode != NULL) {
 569     int len = BLI_str_utf8_size(unicode);
 570     if (len == -1 || unicode[len] != '\0') {
 571       BKE_report(reports, RPT_ERROR, "Only a single character supported");
 572       return NULL;
 573     }
 574     if (len == 1 && isascii(unicode[0])) {
 575       ascii = unicode[0];
 576     }
 577   }
 578
 579   wmEvent e = *win->eventstate;
 580   e.type = type;
 581   e.val = value;
 582   e.x = x;
 583   e.y = y;
 584   /* Note: KM_MOD_FIRST, KM_MOD_SECOND aren't used anywhere, set as bools */
 585   e.shift = shift;
 586   e.ctrl = ctrl;
 587   e.alt = alt;
 588   e.oskey = oskey;
 589
 590   e.prevx = win->eventstate->x;
 591   e.prevy = win->eventstate->y;
 592   e.prevval = win->eventstate->val;
 593   e.prevtype = win->eventstate->type;
 594
 595   e.ascii = '\0';
 596   e.utf8_buf[0] = '\0';
 597   if (unicode != NULL) {
 598     e.ascii = ascii;
 599     STRNCPY(e.utf8_buf, unicode);
 600   }
 601
 602   return WM_event_add_simulate(win, &e);
 603 }
 604
 605 #else
 606
 607 #  define WM_GEN_INVOKE_EVENT (1 << 0)
 608 #  define WM_GEN_INVOKE_SIZE (1 << 1)
 609 #  define WM_GEN_INVOKE_RETURN (1 << 2)
 610
 611 static void rna_generic_op_invoke(FunctionRNA *func, int flag)
 612 {
 613   PropertyRNA *parm;
 614
 615   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 616   parm = RNA_def_pointer(func, "operator", "Operator", "", "Operator to call");
 617   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 618
 619   if (flag & WM_GEN_INVOKE_EVENT) {
 620     parm = RNA_def_pointer(func, "event", "Event", "", "Event");
 621     RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 622   }
 623
 624   if (flag & WM_GEN_INVOKE_SIZE) {
 625     RNA_def_int(func, "width", 300, 0, INT_MAX, "", "Width of the popup", 0, INT_MAX);
 626     RNA_def_int(func, "height", 20, 0, INT_MAX, "", "Height of the popup", 0, INT_MAX);
 627   }
 628
 629   if (flag & WM_GEN_INVOKE_RETURN) {
 630     parm = RNA_def_enum_flag(
 631         func, "result", rna_enum_operator_return_items, OPERATOR_CANCELLED, "result", "");
 632     RNA_def_function_return(func, parm);
 633   }
 634 }
 635
 636 void RNA_api_window(StructRNA *srna)
 637 {
 638   FunctionRNA *func;
 639   PropertyRNA *parm;
 640
 641   func = RNA_def_function(srna, "cursor_warp", "WM_cursor_warp");
 642   parm = RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "", "", INT_MIN, INT_MAX);
 643   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 644   parm = RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "", "", INT_MIN, INT_MAX);
 645   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 646   RNA_def_function_ui_description(func, "Set the cursor position");
 647
 648   func = RNA_def_function(srna, "cursor_set", "WM_cursor_set");
 649   parm = RNA_def_property(func, "cursor", PROP_ENUM, PROP_NONE);
 650   RNA_def_property_enum_items(parm, rna_enum_window_cursor_items);
 651   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 652   RNA_def_function_ui_description(func, "Set the cursor");
 653
 654   func = RNA_def_function(srna, "cursor_modal_set", "WM_cursor_modal_set");
 655   parm = RNA_def_property(func, "cursor", PROP_ENUM, PROP_NONE);
 656   RNA_def_property_enum_items(parm, rna_enum_window_cursor_items);
 657   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 658   RNA_def_function_ui_description(func, "Set the cursor, so the previous cursor can be restored");
 659
 660   RNA_def_function(srna, "cursor_modal_restore", "WM_cursor_modal_restore");
 661   RNA_def_function_ui_description(
 662       func, "Restore the previous cursor after calling ``cursor_modal_set``");
 663
 664   /* Arguments match 'rna_KeyMap_item_new'. */
 665   func = RNA_def_function(srna, "event_simulate", "rna_Window_event_add_simulate");
 666   RNA_def_function_flag(func, FUNC_USE_REPORTS);
 667   parm = RNA_def_enum(func, "type", rna_enum_event_type_items, 0, "Type", "");
 668   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 669   parm = RNA_def_enum(func, "value", rna_enum_event_value_items, 0, "Value", "");
 670   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 671   parm = RNA_def_string(func, "unicode", NULL, 0, "", "");
 672   RNA_def_parameter_clear_flags(parm, PROP_NEVER_NULL, 0);
 673
 674   RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "", "", INT_MIN, INT_MAX);
 675   RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "", "", INT_MIN, INT_MAX);
 676
 677   RNA_def_boolean(func, "shift", 0, "Shift", "");
 678   RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
 679   RNA_def_boolean(func, "alt", 0, "Alt", "");
 680   RNA_def_boolean(func, "oskey", 0, "OS Key", "");
 681   parm = RNA_def_pointer(func, "event", "Event", "Item", "Added key map item");
 682   RNA_def_function_return(func, parm);
 683 }
 684
 685 void RNA_api_wm(StructRNA *srna)
 686 {
 687   FunctionRNA *func;
 688   PropertyRNA *parm;
 689
 690   func = RNA_def_function(srna, "fileselect_add", "WM_event_add_fileselect");
 691   RNA_def_function_ui_description(
 692       func,
 693       "Opens a file selector with an operator. "
 694       "The string properties 'filepath', 'filename', 'directory' and a 'files' "
 695       "collection are assigned when present in the operator");
 696   rna_generic_op_invoke(func, 0);
 697
 698   func = RNA_def_function(srna, "modal_handler_add", "rna_event_modal_handler_add");
 699   RNA_def_function_ui_description(
 700       func,
 701       "Add a modal handler to the window manager, for the given modal operator "
 702       "(called by invoke() with self, just before returning {'RUNNING_MODAL'})");
 703   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 704   parm = RNA_def_pointer(func, "operator", "Operator", "", "Operator to call");
 705   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 706   RNA_def_function_return(
 707       func, RNA_def_boolean(func, "handle", 1, "", "Whether adding the handler was successful"));
 708
 709   func = RNA_def_function(srna, "event_timer_add", "rna_event_timer_add");
 710   RNA_def_function_ui_description(
 711       func, "Add a timer to the given window, to generate periodic 'TIMER' events");
 712   parm = RNA_def_property(func, "time_step", PROP_FLOAT, PROP_NONE);
 713   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 714   RNA_def_property_range(parm, 0.0, FLT_MAX);
 715   RNA_def_property_ui_text(parm, "Time Step", "Interval in seconds between timer events");
 716   RNA_def_pointer(func, "window", "Window", "", "Window to attach the timer to, or None");
 717   parm = RNA_def_pointer(func, "result", "Timer", "", "");
 718   RNA_def_function_return(func, parm);
 719
 720   func = RNA_def_function(srna, "event_timer_remove", "rna_event_timer_remove");
 721   parm = RNA_def_pointer(func, "timer", "Timer", "", "");
 722   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 723
 724   func = RNA_def_function(srna, "gizmo_group_type_ensure", "rna_gizmo_group_type_ensure");
 725   RNA_def_function_ui_description(
 726       func, "Activate an existing widget group (when the persistent option isn't set)");
 727   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_REPORTS);
 728   parm = RNA_def_string(func, "identifier", NULL, 0, "", "Gizmo group type name");
 729   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 730
 731   func = RNA_def_function(
 732       srna, "gizmo_group_type_unlink_delayed", "rna_gizmo_group_type_unlink_delayed");
 733   RNA_def_function_ui_description(func,
 734                                   "Unlink a widget group (when the persistent option is set)");
 735   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_REPORTS);
 736   parm = RNA_def_string(func, "identifier", NULL, 0, "", "Gizmo group type name");
 737   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 738
 739   /* Progress bar interface */
 740   func = RNA_def_function(srna, "progress_begin", "rna_progress_begin");
 741   RNA_def_function_ui_description(func, "Start progress report");
 742   parm = RNA_def_property(func, "min", PROP_FLOAT, PROP_NONE);
 743   RNA_def_property_ui_text(parm, "min", "any value in range [0,9999]");
 744   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 745   parm = RNA_def_property(func, "max", PROP_FLOAT, PROP_NONE);
 746   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 747   RNA_def_property_ui_text(parm, "max", "any value in range [min+1,9998]");
 748
 749   func = RNA_def_function(srna, "progress_update", "rna_progress_update");
 750   RNA_def_function_ui_description(func, "Update the progress feedback");
 751   parm = RNA_def_property(func, "value", PROP_FLOAT, PROP_NONE);
 752   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 753   RNA_def_property_ui_text(
 754       parm, "value", "Any value between min and max as set in progress_begin()");
 755
 756   func = RNA_def_function(srna, "progress_end", "rna_progress_end");
 757   RNA_def_function_ui_description(func, "Terminate progress report");
 758
 759   /* invoke functions, for use with python */
 760   func = RNA_def_function(srna, "invoke_props_popup", "rna_Operator_props_popup");
 761   RNA_def_function_ui_description(
 762       func,
 763       "Operator popup invoke "
 764       "(show operator properties and execute it automatically on changes)");
 765   rna_generic_op_invoke(func, WM_GEN_INVOKE_EVENT | WM_GEN_INVOKE_RETURN);
 766
 767   /* invoked dialog opens popup with OK button, does not auto-exec operator. */
 768   func = RNA_def_function(srna, "invoke_props_dialog", "WM_operator_props_dialog_popup");
 769   RNA_def_function_ui_description(
 770       func,
 771       "Operator dialog (non-autoexec popup) invoke "
 772       "(show operator properties and only execute it on click on OK button)");
 773   rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE | WM_GEN_INVOKE_RETURN);
 774
 775   /* invoke enum */
 776   func = RNA_def_function(srna, "invoke_search_popup", "rna_Operator_enum_search_invoke");
 777   RNA_def_function_ui_description(
 778       func,
 779       "Operator search popup invoke which "
 780       "searches values of the operator's :class:`bpy.types.Operator.bl_property` "
 781       "(which must be an EnumProperty), executing it on confirmation");
 782   rna_generic_op_invoke(func, 0);
 783
 784   /* invoke functions, for use with python */
 785   func = RNA_def_function(srna, "invoke_popup", "WM_operator_ui_popup");
 786   RNA_def_function_ui_description(func,
 787                                   "Operator popup invoke "
 788                                   "(only shows operator's properties, without executing it)");
 789   rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE | WM_GEN_INVOKE_RETURN);
 790
 791   func = RNA_def_function(srna, "invoke_confirm", "rna_Operator_confirm");
 792   RNA_def_function_ui_description(
 793       func,
 794       "Operator confirmation popup "
 795       "(only to let user confirm the execution, no operator properties shown)");
 796   rna_generic_op_invoke(func, WM_GEN_INVOKE_EVENT | WM_GEN_INVOKE_RETURN);
 797
 798   /* wrap UI_popup_menu_begin */
 799   func = RNA_def_function(srna, "popmenu_begin__internal", "rna_PopMenuBegin");
 800   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 801   parm = RNA_def_string(func, "title", NULL, 0, "", "");
 802   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 803   parm = RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
 804   RNA_def_property_enum_items(parm, rna_enum_icon_items);
 805   /* return */
 806   parm = RNA_def_pointer(func, "menu", "UIPopupMenu", "", "");
 807   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR);
 808   RNA_def_function_return(func, parm);
 809
 810   /* wrap UI_popup_menu_end */
 811   func = RNA_def_function(srna, "popmenu_end__internal", "rna_PopMenuEnd");
 812   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 813   parm = RNA_def_pointer(func, "menu", "UIPopupMenu", "", "");
 814   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR | PARM_REQUIRED);
 815
 816   /* wrap UI_popover_begin */
 817   func = RNA_def_function(srna, "popover_begin__internal", "rna_PopoverBegin");
 818   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 819   RNA_def_property(func, "ui_units_x", PROP_INT, PROP_UNSIGNED);
 820   /* return */
 821   parm = RNA_def_pointer(func, "menu", "UIPopover", "", "");
 822   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR);
 823   RNA_def_function_return(func, parm);
 824   RNA_def_boolean(
 825       func, "from_active_button", 0, "Use Button", "Use the active button for positioning");
 826
 827   /* wrap UI_popover_end */
 828   func = RNA_def_function(srna, "popover_end__internal", "rna_PopoverEnd");
 829   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 830   parm = RNA_def_pointer(func, "menu", "UIPopover", "", "");
 831   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR | PARM_REQUIRED);
 832   RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Active key map");
 833
 834   /* wrap uiPieMenuBegin */
 835   func = RNA_def_function(srna, "piemenu_begin__internal", "rna_PieMenuBegin");
 836   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 837   parm = RNA_def_string(func, "title", NULL, 0, "", "");
 838   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 839   parm = RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
 840   RNA_def_property_enum_items(parm, rna_enum_icon_items);
 841   parm = RNA_def_pointer(func, "event", "Event", "", "");
 842   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR);
 843   /* return */
 844   parm = RNA_def_pointer(func, "menu_pie", "UIPieMenu", "", "");
 845   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR);
 846   RNA_def_function_return(func, parm);
 847
 848   /* wrap uiPieMenuEnd */
 849   func = RNA_def_function(srna, "piemenu_end__internal", "rna_PieMenuEnd");
 850   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
 851   parm = RNA_def_pointer(func, "menu", "UIPieMenu", "", "");
 852   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR | PARM_REQUIRED);
 853
 854   /* access last operator options (optionally create). */
 855   func = RNA_def_function(
 856       srna, "operator_properties_last", "rna_WindoManager_operator_properties_last");
 857   RNA_def_function_flag(func, FUNC_NO_SELF);
 858   parm = RNA_def_string(func, "operator", NULL, 0, "", "");
 859   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 860   /* return */
 861   parm = RNA_def_pointer(func, "result", "OperatorProperties", "", "");
 862   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_RNAPTR);
 863   RNA_def_function_return(func, parm);
 864
 865   RNA_def_function(srna, "print_undo_steps", "rna_WindowManager_print_undo_steps");
 866 }
 867
 868 void RNA_api_operator(StructRNA *srna)
 869 {
 870   FunctionRNA *func;
 871   PropertyRNA *parm;
 872
 873   /* utility, not for registering */
 874   func = RNA_def_function(srna, "report", "rna_Operator_report");
 875   parm = RNA_def_enum_flag(func, "type", rna_enum_wm_report_items, 0, "Type", "");
 876   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 877   parm = RNA_def_string(func, "message", NULL, 0, "Report Message", "");
 878   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 879
 880   /* utility, not for registering */
 881   func = RNA_def_function(srna, "is_repeat", "rna_Operator_is_repeat");
 882   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
 883   /* return */
 884   parm = RNA_def_boolean(func, "result", 0, "result", "");
 885   RNA_def_function_return(func, parm);
 886
 887   /* Registration */
 888
 889   /* poll */
 890   func = RNA_def_function(srna, "poll", NULL);
 891   RNA_def_function_ui_description(func, "Test if the operator can be called or not");
 892   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
 893   RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
 894   parm = RNA_def_pointer(func, "context", "Context", "", "");
 895   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 896
 897   /* exec */
 898   func = RNA_def_function(srna, "execute", NULL);
 899   RNA_def_function_ui_description(func, "Execute the operator");
 900   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
 901   parm = RNA_def_pointer(func, "context", "Context", "", "");
 902   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 903
 904   /* better name? */
 905   parm = RNA_def_enum_flag(
 906       func, "result", rna_enum_operator_return_items, OPERATOR_CANCELLED, "result", "");
 907   RNA_def_function_return(func, parm);
 908
 909   /* check */
 910   func = RNA_def_function(srna, "check", NULL);
 911   RNA_def_function_ui_description(
 912       func, "Check the operator settings, return True to signal a change to redraw");
 913   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
 914   parm = RNA_def_pointer(func, "context", "Context", "", "");
 915   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 916
 917   parm = RNA_def_boolean(func, "result", 0, "result", ""); /* better name? */
 918   RNA_def_function_return(func, parm);
 919
 920   /* invoke */
 921   func = RNA_def_function(srna, "invoke", NULL);
 922   RNA_def_function_ui_description(func, "Invoke the operator");
 923   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
 924   parm = RNA_def_pointer(func, "context", "Context", "", "");
 925   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 926   parm = RNA_def_pointer(func, "event", "Event", "", "");
 927   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 928
 929   /* better name? */
 930   parm = RNA_def_enum_flag(
 931       func, "result", rna_enum_operator_return_items, OPERATOR_CANCELLED, "result", "");
 932   RNA_def_function_return(func, parm);
 933
 934   func = RNA_def_function(srna, "modal", NULL); /* same as invoke */
 935   RNA_def_function_ui_description(func, "Modal operator function");
 936   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
 937   parm = RNA_def_pointer(func, "context", "Context", "", "");
 938   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 939   parm = RNA_def_pointer(func, "event", "Event", "", "");
 940   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 941
 942   /* better name? */
 943   parm = RNA_def_enum_flag(
 944       func, "result", rna_enum_operator_return_items, OPERATOR_CANCELLED, "result", "");
 945   RNA_def_function_return(func, parm);
 946
 947   /* draw */
 948   func = RNA_def_function(srna, "draw", NULL);
 949   RNA_def_function_ui_description(func, "Draw function for the operator");
 950   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
 951   parm = RNA_def_pointer(func, "context", "Context", "", "");
 952   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 953
 954   /* cancel */
 955   func = RNA_def_function(srna, "cancel", NULL);
 956   RNA_def_function_ui_description(func, "Called when the operator is canceled");
 957   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
 958   parm = RNA_def_pointer(func, "context", "Context", "", "");
 959   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 960
 961   /* description */
 962   func = RNA_def_function(srna, "description", NULL);
 963   RNA_def_function_ui_description(func, "Compute a description string that depends on parameters");
 964   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
 965   parm = RNA_def_string(func, "result", NULL, 4096, "result", "");
 966   RNA_def_parameter_clear_flags(parm, PROP_NEVER_NULL, 0);
 967   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
 968   RNA_def_function_output(func, parm);
 969   parm = RNA_def_pointer(func, "context", "Context", "", "");
 970   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 971   parm = RNA_def_pointer(func, "properties", "OperatorProperties", "", "");
 972   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
 973 }
 974
 975 void RNA_api_macro(StructRNA *srna)
 976 {
 977   FunctionRNA *func;
 978   PropertyRNA *parm;
 979
 980   /* utility, not for registering */
 981   func = RNA_def_function(srna, "report", "rna_Operator_report");
 982   parm = RNA_def_enum_flag(func, "type", rna_enum_wm_report_items, 0, "Type", "");
 983   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 984   parm = RNA_def_string(func, "message", NULL, 0, "Report Message", "");
 985   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
 986
 987   /* Registration */
 988
 989   /* poll */
 990   func = RNA_def_function(srna, "poll", NULL);
 991   RNA_def_function_ui_description(func, "Test if the operator can be called or not");
 992   RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
 993   RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
 994   parm = RNA_def_pointer(func, "context", "Context", "", "");
 995   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
 996
 997   /* draw */
 998   func = RNA_def_function(srna, "draw", NULL);
 999   RNA_def_function_ui_description(func, "Draw function for the operator");
1000   RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1001   parm = RNA_def_pointer(func, "context", "Context", "", "");
1002   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1003 }
1004
1005 void RNA_api_keyconfig(StructRNA *UNUSED(srna))
1006 {
1007   /* FunctionRNA *func; */
1008   /* PropertyRNA *parm; */
1009 }
1010
1011 void RNA_api_keymap(StructRNA *srna)
1012 {
1013   FunctionRNA *func;
1014   PropertyRNA *parm;
1015
1016   func = RNA_def_function(srna, "active", "rna_keymap_active");
1017   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1018   parm = RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Active key map");
1019   RNA_def_function_return(func, parm);
1020
1021   func = RNA_def_function(srna, "restore_to_default", "WM_keymap_restore_to_default");
1022   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1023
1024   func = RNA_def_function(srna, "restore_item_to_default", "rna_keymap_restore_item_to_default");
1025   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1026   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
1027   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1028 }
1029
1030 void RNA_api_keymapitem(StructRNA *srna)
1031 {
1032   FunctionRNA *func;
1033   PropertyRNA *parm;
1034
1035   func = RNA_def_function(srna, "compare", "WM_keymap_item_compare");
1036   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
1037   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1038   parm = RNA_def_boolean(func, "result", 0, "Comparison result", "");
1039   RNA_def_function_return(func, parm);
1040
1041   func = RNA_def_function(srna, "to_string", "rna_KeyMapItem_to_string");
1042   RNA_def_boolean(func, "compact", false, "Compact", "");
1043   parm = RNA_def_string(func, "result", NULL, UI_MAX_SHORTCUT_STR, "result", "");
1044   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
1045   RNA_def_function_output(func, parm);
1046 }
1047
1048 void RNA_api_keymapitems(StructRNA *srna)
1049 {
1050   FunctionRNA *func;
1051   PropertyRNA *parm;
1052
1053   func = RNA_def_function(srna, "new", "rna_KeyMap_item_new");
1054   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1055   parm = RNA_def_string(func, "idname", NULL, 0, "Operator Identifier", "");
1056   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1057   parm = RNA_def_enum(func, "type", rna_enum_event_type_items, 0, "Type", "");
1058   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1059   parm = RNA_def_enum(func, "value", rna_enum_event_value_items, 0, "Value", "");
1060   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1061   RNA_def_boolean(func, "any", 0, "Any", "");
1062   RNA_def_boolean(func, "shift", 0, "Shift", "");
1063   RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
1064   RNA_def_boolean(func, "alt", 0, "Alt", "");
1065   RNA_def_boolean(func, "oskey", 0, "OS Key", "");
1066   RNA_def_enum(func, "key_modifier", rna_enum_event_type_items, 0, "Key Modifier", "");
1067   RNA_def_boolean(func,
1068                   "head",
1069                   0,
1070                   "At Head",
1071                   "Force item to be added at start (not end) of key map so that "
1072                   "it doesn't get blocked by an existing key map item");
1073   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item");
1074   RNA_def_function_return(func, parm);
1075
1076   func = RNA_def_function(srna, "new_modal", "rna_KeyMap_item_new_modal");
1077   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1078   parm = RNA_def_string(func, "propvalue", NULL, 0, "Property Value", "");
1079   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1080   parm = RNA_def_enum(func, "type", rna_enum_event_type_items, 0, "Type", "");
1081   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1082   parm = RNA_def_enum(func, "value", rna_enum_event_value_items, 0, "Value", "");
1083   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1084   RNA_def_boolean(func, "any", 0, "Any", "");
1085   RNA_def_boolean(func, "shift", 0, "Shift", "");
1086   RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
1087   RNA_def_boolean(func, "alt", 0, "Alt", "");
1088   RNA_def_boolean(func, "oskey", 0, "OS Key", "");
1089   RNA_def_enum(func, "key_modifier", rna_enum_event_type_items, 0, "Key Modifier", "");
1090   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item");
1091   RNA_def_function_return(func, parm);
1092
1093   func = RNA_def_function(srna, "new_from_item", "rna_KeyMap_item_new_from_item");
1094   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1095   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Item to use as a reference");
1096   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1097   RNA_def_boolean(func, "head", 0, "At Head", "");
1098   parm = RNA_def_pointer(func, "result", "KeyMapItem", "Item", "Added key map item");
1099   RNA_def_function_return(func, parm);
1100
1101   func = RNA_def_function(srna, "remove", "rna_KeyMap_item_remove");
1102   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1103   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
1104   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1105   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1106
1107   func = RNA_def_function(srna, "from_id", "WM_keymap_item_find_id");
1108   parm = RNA_def_property(func, "id", PROP_INT, PROP_NONE);
1109   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1110   RNA_def_property_ui_text(parm, "id", "ID of the item");
1111   parm = RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
1112   RNA_def_function_return(func, parm);
1113
1114   /* Keymap introspection
1115    * Args follow: KeyConfigs.find_item_from_operator */
1116   func = RNA_def_function(srna, "find_from_operator", "rna_KeyMap_item_find_from_operator");
1117   RNA_def_function_flag(func, FUNC_USE_SELF_ID);
1118   parm = RNA_def_string(func, "idname", NULL, 0, "Operator Identifier", "");
1119   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1120   parm = RNA_def_pointer(func, "properties", "OperatorProperties", "", "");
1121   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1122   RNA_def_enum_flag(
1123       func, "include", rna_enum_event_type_mask_items, EVT_TYPE_MASK_ALL, "Include", "");
1124   RNA_def_enum_flag(func, "exclude", rna_enum_event_type_mask_items, 0, "Exclude", "");
1125   parm = RNA_def_pointer(func, "item", "KeyMapItem", "", "");
1126   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1127   RNA_def_function_return(func, parm);
1128 }
1129
1130 void RNA_api_keymaps(StructRNA *srna)
1131 {
1132   FunctionRNA *func;
1133   PropertyRNA *parm;
1134
1135   func = RNA_def_function(srna, "new", "rna_keymap_new"); /* add_keymap */
1136   parm = RNA_def_string(func, "name", NULL, 0, "Name", "");
1137   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1138   RNA_def_enum(func, "space_type", rna_enum_space_type_items, SPACE_EMPTY, "Space Type", "");
1139   RNA_def_enum(
1140       func, "region_type", rna_enum_region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
1141   RNA_def_boolean(func, "modal", 0, "Modal", "Keymap for modal operators");
1142   RNA_def_boolean(func, "tool", 0, "Tool", "Keymap for active tools");
1143   parm = RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Added key map");
1144   RNA_def_function_return(func, parm);
1145
1146   func = RNA_def_function(srna, "remove", "rna_KeyMap_remove"); /* remove_keymap */
1147   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1148   parm = RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Removed key map");
1149   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1150   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1151
1152   func = RNA_def_function(srna, "find", "rna_keymap_find"); /* find_keymap */
1153   parm = RNA_def_string(func, "name", NULL, 0, "Name", "");
1154   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1155   RNA_def_enum(func, "space_type", rna_enum_space_type_items, SPACE_EMPTY, "Space Type", "");
1156   RNA_def_enum(
1157       func, "region_type", rna_enum_region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
1158   parm = RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Corresponding key map");
1159   RNA_def_function_return(func, parm);
1160
1161   func = RNA_def_function(srna, "find_modal", "rna_keymap_find_modal"); /* find_keymap_modal */
1162   parm = RNA_def_string(func, "name", NULL, 0, "Operator Name", "");
1163   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1164   parm = RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Corresponding key map");
1165   RNA_def_function_return(func, parm);
1166 }
1167
1168 void RNA_api_keyconfigs(StructRNA *srna)
1169 {
1170   FunctionRNA *func;
1171   PropertyRNA *parm;
1172
1173   func = RNA_def_function(srna, "new", "WM_keyconfig_new_user"); /* add_keyconfig */
1174   parm = RNA_def_string(func, "name", NULL, 0, "Name", "");
1175   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1176   parm = RNA_def_pointer(
1177       func, "keyconfig", "KeyConfig", "Key Configuration", "Added key configuration");
1178   RNA_def_function_return(func, parm);
1179
1180   func = RNA_def_function(srna, "remove", "rna_KeyConfig_remove"); /* remove_keyconfig */
1181   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1182   parm = RNA_def_pointer(
1183       func, "keyconfig", "KeyConfig", "Key Configuration", "Removed key configuration");
1184   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1185   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1186
1187   /* Helper functions */
1188
1189   /* Keymap introspection */
1190   func = RNA_def_function(
1191       srna, "find_item_from_operator", "rna_KeyConfig_find_item_from_operator");
1192   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1193   parm = RNA_def_string(func, "idname", NULL, 0, "Operator Identifier", "");
1194   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1195   parm = RNA_def_property(func, "context", PROP_ENUM, PROP_NONE);
1196   RNA_def_property_enum_items(parm, rna_enum_operator_context_items);
1197   parm = RNA_def_pointer(func, "properties", "OperatorProperties", "", "");
1198   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1199   RNA_def_enum_flag(
1200       func, "include", rna_enum_event_type_mask_items, EVT_TYPE_MASK_ALL, "Include", "");
1201   RNA_def_enum_flag(func, "exclude", rna_enum_event_type_mask_items, 0, "Exclude", "");
1202   parm = RNA_def_pointer(func, "keymap", "KeyMap", "", "");
1203   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR | PARM_OUTPUT);
1204   parm = RNA_def_pointer(func, "item", "KeyMapItem", "", "");
1205   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1206   RNA_def_function_return(func, parm);
1207
1208   RNA_def_function(srna, "update", "rna_KeyConfig_update"); /* WM_keyconfig_update */
1209 }
1210
1211 #endif