Bevel: Remove Debugging Code
[blender.git] / source / blender / blenkernel / BKE_context.h
index 663d7f2586e0535f3a8b3a19738fc907d7cba0f4..88a27b6796335d6ee33f4a3f3b24960236db80d3 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
- *
- * Contributor(s): Blender Foundation (2008).
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
 #ifndef __BKE_CONTEXT_H__
 #define __BKE_CONTEXT_H__
 
-/** \file BKE_context.h
- *  \ingroup bke
+/** \file
+ * \ingroup bke
  */
 
 #include "DNA_listBase.h"
@@ -38,15 +32,20 @@ extern "C" {
 #endif
 
 struct ARegion;
+struct Base;
 struct CacheFile;
+struct Collection;
+struct Depsgraph;
 struct EditBone;
 struct ID;
 struct Image;
+struct LayerCollection;
 struct ListBase;
 struct Main;
 struct Object;
 struct PointerRNA;
 struct RegionView3D;
+struct RenderEngineType;
 struct ReportList;
 struct Scene;
 struct ScrArea;
@@ -58,17 +57,17 @@ struct StructRNA;
 struct Text;
 struct ToolSettings;
 struct View3D;
-struct bGPDbrush;
+struct ViewLayer;
 struct bGPDframe;
 struct bGPDlayer;
-struct bGPDpalette;
-struct bGPDpalettecolor;
 struct bGPdata;
 struct bPoseChannel;
 struct bScreen;
 struct wmWindow;
 struct wmWindowManager;
 
+#include "DNA_object_enums.h"
+
 /* Structs */
 
 struct bContext;
@@ -78,40 +77,46 @@ struct bContextDataResult;
 typedef struct bContextDataResult bContextDataResult;
 
 typedef int (*bContextDataCallback)(const bContext *C,
-                                    const char *member, bContextDataResult *result);
+                                    const char *member,
+                                    bContextDataResult *result);
 
 typedef struct bContextStoreEntry {
-       struct bContextStoreEntry *next, *prev;
+  struct bContextStoreEntry *next, *prev;
 
-       char name[128];
-       PointerRNA ptr;
+  char name[128];
+  PointerRNA ptr;
 } bContextStoreEntry;
 
 typedef struct bContextStore {
-       struct bContextStore *next, *prev;
+  struct bContextStore *next, *prev;
 
-       ListBase entries;
-       bool used;
+  ListBase entries;
+  bool used;
 } bContextStore;
 
 /* for the context's rna mode enum
  * keep aligned with data_mode_strings in context.c */
-enum {
-       CTX_MODE_EDIT_MESH = 0,
-       CTX_MODE_EDIT_CURVE,
-       CTX_MODE_EDIT_SURFACE,
-       CTX_MODE_EDIT_TEXT,
-       CTX_MODE_EDIT_ARMATURE,
-       CTX_MODE_EDIT_METABALL,
-       CTX_MODE_EDIT_LATTICE,
-       CTX_MODE_POSE,
-       CTX_MODE_SCULPT,
-       CTX_MODE_PAINT_WEIGHT,
-       CTX_MODE_PAINT_VERTEX,
-       CTX_MODE_PAINT_TEXTURE,
-       CTX_MODE_PARTICLE,
-       CTX_MODE_OBJECT
-};
+typedef enum eContextObjectMode {
+  CTX_MODE_EDIT_MESH = 0,
+  CTX_MODE_EDIT_CURVE,
+  CTX_MODE_EDIT_SURFACE,
+  CTX_MODE_EDIT_TEXT,
+  CTX_MODE_EDIT_ARMATURE,
+  CTX_MODE_EDIT_METABALL,
+  CTX_MODE_EDIT_LATTICE,
+  CTX_MODE_POSE,
+  CTX_MODE_SCULPT,
+  CTX_MODE_PAINT_WEIGHT,
+  CTX_MODE_PAINT_VERTEX,
+  CTX_MODE_PAINT_TEXTURE,
+  CTX_MODE_PARTICLE,
+  CTX_MODE_OBJECT,
+  CTX_MODE_PAINT_GPENCIL,
+  CTX_MODE_EDIT_GPENCIL,
+  CTX_MODE_SCULPT_GPENCIL,
+  CTX_MODE_WEIGHT_GPENCIL,
+} eContextObjectMode;
+#define CTX_MODE_NUM (CTX_MODE_WEIGHT_GPENCIL + 1)
 
 /* Context */
 
@@ -130,8 +135,8 @@ void CTX_store_free(bContextStore *store);
 void CTX_store_free_list(ListBase *contexts);
 
 /* need to store if python is initialized or not */
-int CTX_py_init_get(bContext *C);
-void CTX_py_init_set(bContext *C, int value);
+bool CTX_py_init_get(bContext *C);
+void CTX_py_init_set(bContext *C, bool value);
 
 void *CTX_py_dict_get(const bContext *C);
 void CTX_py_dict_set(bContext *C, void *value);
@@ -140,12 +145,15 @@ void CTX_py_dict_set(bContext *C, void *value);
 
 struct wmWindowManager *CTX_wm_manager(const bContext *C);
 struct wmWindow *CTX_wm_window(const bContext *C);
+struct WorkSpace *CTX_wm_workspace(const bContext *C);
 struct bScreen *CTX_wm_screen(const bContext *C);
 struct ScrArea *CTX_wm_area(const bContext *C);
 struct SpaceLink *CTX_wm_space_data(const bContext *C);
 struct ARegion *CTX_wm_region(const bContext *C);
 void *CTX_wm_region_data(const bContext *C);
 struct ARegion *CTX_wm_menu(const bContext *C);
+struct wmGizmoGroup *CTX_wm_gizmo_group(const bContext *C);
+struct wmMsgBus *CTX_wm_message_bus(const bContext *C);
 struct ReportList *CTX_wm_reports(const bContext *C);
 
 struct View3D *CTX_wm_view3d(const bContext *C);
@@ -153,19 +161,18 @@ struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
 struct SpaceText *CTX_wm_space_text(const bContext *C);
 struct SpaceImage *CTX_wm_space_image(const bContext *C);
 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
-struct SpaceButs *CTX_wm_space_buts(const bContext *C);
+struct SpaceProperties *CTX_wm_space_properties(const bContext *C);
 struct SpaceFile *CTX_wm_space_file(const bContext *C);
 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
-struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
+struct SpaceOutliner *CTX_wm_space_outliner(const bContext *C);
 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
-struct SpaceTime *CTX_wm_space_time(const bContext *C);
 struct SpaceNode *CTX_wm_space_node(const bContext *C);
-struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
-struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
+struct SpaceGraph *CTX_wm_space_graph(const bContext *C);
 struct SpaceAction *CTX_wm_space_action(const bContext *C);
 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
+struct SpaceTopBar *CTX_wm_space_topbar(const bContext *C);
 
 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
@@ -173,6 +180,7 @@ void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
 void CTX_wm_region_set(bContext *C, struct ARegion *region);
 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
+void CTX_wm_gizmo_group_set(bContext *C, struct wmGizmoGroup *gzgroup);
 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
 
@@ -184,16 +192,23 @@ void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
 
 /* data type, needed so we can tell between a NULL pointer and an empty list */
 enum {
-       CTX_DATA_TYPE_POINTER = 0,
-       CTX_DATA_TYPE_COLLECTION
+  CTX_DATA_TYPE_POINTER = 0,
+  CTX_DATA_TYPE_COLLECTION,
 };
 
 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
+PointerRNA CTX_data_pointer_get_type_silent(const bContext *C,
+                                            const char *member,
+                                            StructRNA *type);
 ListBase CTX_data_collection_get(const bContext *C, const char *member);
-ListBase CTX_data_dir_get_ex(const bContext *C, const bool use_store, const bool use_rna, const bool use_all);
+ListBase CTX_data_dir_get_ex(const bContext *C,
+                             const bool use_store,
+                             const bool use_rna,
+                             const bool use_all);
 ListBase CTX_data_dir_get(const bContext *C);
-int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
+int CTX_data_get(
+    const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
 
 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
@@ -209,44 +224,43 @@ short CTX_data_type_get(struct bContextDataResult *result);
 bool CTX_data_equals(const char *member, const char *str);
 bool CTX_data_dir(const char *member);
 
-#if 0
-void CTX_data_pointer_set(bContextDataResult *result, void *data);
-void CTX_data_list_add(bContextDataResult *result, void *data);
-#endif
+#define CTX_DATA_BEGIN(C, Type, instance, member) \
+  { \
+    ListBase ctx_data_list; \
+    CollectionPointerLink *ctx_link; \
+    CTX_data_##member(C, &ctx_data_list); \
+    for (ctx_link = ctx_data_list.first; ctx_link; ctx_link = ctx_link->next) { \
+      Type instance = ctx_link->ptr.data;
 
-#define CTX_DATA_BEGIN(C, Type, instance, member)                             \
-       {                                                                         \
-               ListBase ctx_data_list;                                               \
-               CollectionPointerLink *ctx_link;                                      \
-               CTX_data_##member(C, &ctx_data_list);                                 \
-               for (ctx_link = ctx_data_list.first;                                  \
-                    ctx_link;                                                        \
-                    ctx_link = ctx_link->next)                                       \
-               {                                                                     \
-                       Type instance = ctx_link->ptr.data;
-
-#define CTX_DATA_END                                                          \
-               }                                                                     \
-               BLI_freelistN(&ctx_data_list);                                        \
-} (void)0
-
-#define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id)      \
-       CTX_DATA_BEGIN(C, Type, instance, member) \
-       Type_id instance_id = ctx_link->ptr.id.data; \
+#define CTX_DATA_END \
+  } \
+  BLI_freelistN(&ctx_data_list); \
+  } \
+  (void)0
+
+#define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id) \
+  CTX_DATA_BEGIN (C, Type, instance, member) \
+    Type_id instance_id = (Type_id)ctx_link->ptr.owner_id;
 
 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
 
-#define CTX_DATA_COUNT(C, member) \
-       ctx_data_list_count(C, CTX_data_##member)
+#define CTX_DATA_COUNT(C, member) ctx_data_list_count(C, CTX_data_##member)
 
 /* Data Context Members */
 
 struct Main *CTX_data_main(const bContext *C);
 struct Scene *CTX_data_scene(const bContext *C);
+struct LayerCollection *CTX_data_layer_collection(const bContext *C);
+struct Collection *CTX_data_collection(const bContext *C);
+struct ViewLayer *CTX_data_view_layer(const bContext *C);
+struct RenderEngineType *CTX_data_engine_type(const bContext *C);
 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
 
 const char *CTX_data_mode_string(const bContext *C);
-int CTX_data_mode_enum(const bContext *C);
+enum eContextObjectMode CTX_data_mode_enum_ex(const struct Object *obedit,
+                                              const struct Object *ob,
+                                              const eObjectMode object_mode);
+enum eContextObjectMode CTX_data_mode_enum(const bContext *C);
 
 void CTX_data_main_set(bContext *C, struct Main *bmain);
 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
@@ -288,18 +302,44 @@ int CTX_data_editable_bones(const bContext *C, ListBase *list);
 
 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
+int CTX_data_selected_pose_bones_from_active_object(const bContext *C, ListBase *list);
 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
 
 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
-struct bGPDpalette *CTX_data_active_gpencil_palette(const bContext *C);
-struct bGPDpalettecolor *CTX_data_active_gpencil_palettecolor(const bContext *C);
-struct bGPDbrush *CTX_data_active_gpencil_brush(const bContext *C);
 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
 
+/* Gets pointer to the dependency graph.
+ * If it doesn't exist yet, it will be allocated.
+ *
+ * The result dependency graph is NOT guaranteed to be up-to-date neither from relation nor from
+ * evaluated data points of view.
+ *
+ * NOTE: Can not be used if access to a fully evaluated datablock is needed. */
+struct Depsgraph *CTX_data_depsgraph_pointer(const bContext *C);
+
+/* Get dependency graph which is expected to be fully evaluated.
+ *
+ * In the release builds it is the same as CTX_data_depsgraph_pointer(). In the debug builds extra
+ * sanity checks are done. Additionally, this provides more semantic meaning to what is exactly
+ * expected to happen. */
+struct Depsgraph *CTX_data_expect_evaluated_depsgraph(const bContext *C);
+
+/* Gets fully updated and evaluated dependency graph.
+ *
+ * All the relations and evaluated objects are guaranteed to be up to date.
+ *
+ * NOTE: Will be expensive if there are relations or objects tagged for update.
+ * NOTE: If there are pending updates depsgraph hooks will be invoked. */
+struct Depsgraph *CTX_data_ensure_evaluated_depsgraph(const bContext *C);
+
+/* Will Return NULL if depsgraph is not allocated yet.
+ * Only used by handful of operators which are run on file load.
+ */
+struct Depsgraph *CTX_data_depsgraph_on_load(const bContext *C);
 
 #ifdef __cplusplus
 }