Blender V5.3
io_utils.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <fmt/format.h>
10
11#include "BLI_path_utils.hh"
12#include "BLI_string.hh"
13
14#include "BLT_translation.hh"
15
16#include "BKE_context.hh"
17#include "BKE_main.hh"
18
19#include "DNA_space_types.h"
20
21#include "RNA_access.hh"
22#include "RNA_prototypes.hh"
23
24#include "WM_api.hh"
25
26#include "io_utils.hh"
27
28namespace blender::ed::io {
29
31{
32
33 PropertyRNA *filepath_prop = RNA_struct_find_property(op->ptr, "filepath");
34 PropertyRNA *directory_prop = RNA_struct_find_property(op->ptr, "directory");
35 if ((filepath_prop && RNA_property_is_set(op->ptr, filepath_prop)) ||
36 (directory_prop && RNA_property_is_set(op->ptr, directory_prop)))
37 {
38 std::string title;
39 PropertyRNA *files_prop = RNA_struct_find_property(op->ptr, "files");
40 if (directory_prop && files_prop) {
41 const auto files = paths_from_operator_properties(op->ptr);
42 if (files.size() == 1) {
43 title = files[0];
44 }
45 else {
46 title = fmt::format(fmt::runtime(TIP_("Import {} files")), files.size());
47 }
48 }
49 else {
50 char filepath[FILE_MAX];
51 RNA_string_get(op->ptr, "filepath", filepath);
52 title = filepath;
53 }
55 C, op, 350, std::move(title), WM_operatortype_name(op->type, op->ptr));
56 }
57
60}
61
63{
64 View3D *v3d = CTX_wm_view3d(C);
65 SpaceOutliner *space_outliner = CTX_wm_space_outliner(C);
66 ARegion *region = CTX_wm_region(C);
67 if (!region || region->regiontype != RGN_TYPE_WINDOW) {
68 return false;
69 }
70 if (v3d) {
71 return true;
72 }
73 if (space_outliner && space_outliner->outlinevis == SO_VIEW_LAYER) {
74 return true;
75 }
76 return false;
77}
78
80{
82 PropertyRNA *directory_prop = RNA_struct_find_property(ptr, "directory");
83 PropertyRNA *relative_path_prop = RNA_struct_find_property(ptr, "relative_path");
84 const bool is_relative_path = relative_path_prop ?
85 RNA_property_boolean_get(ptr, relative_path_prop) :
86 false;
87 if (RNA_property_is_set(ptr, directory_prop)) {
88 char directory[FILE_MAX], name[FILE_MAX];
89
90 RNA_string_get(ptr, "directory", directory);
91 if (is_relative_path && !BLI_path_is_rel(directory)) {
93 }
94
96 *ptr, "files", RNA_OperatorFileListElement);
97
98 BLI_assert(files_prop);
99
100 RNA_PROP_BEGIN (ptr, file_ptr, files_prop) {
101 RNA_string_get(&file_ptr, "name", name);
102 char path[FILE_MAX];
103 BLI_path_join(path, sizeof(path), directory, name);
104 BLI_path_normalize(path);
105 paths.append_non_duplicates(path);
106 }
108 }
109 PropertyRNA *filepath_prop = RNA_struct_find_property(ptr, "filepath");
110 if (filepath_prop && RNA_property_is_set(ptr, filepath_prop)) {
111 char filepath[FILE_MAX];
112 RNA_string_get(ptr, "filepath", filepath);
113 if (is_relative_path && !BLI_path_is_rel(filepath)) {
115 }
116 paths.append_non_duplicates(filepath);
117 }
118 return paths;
119}
120
122{
123 char dir[FILE_MAX];
124 BLI_path_split_dir_part(paths[0].c_str(), dir, sizeof(dir));
125 RNA_string_set(ptr, "directory", dir);
126
127 RNA_collection_clear(ptr, "files");
128 for (const auto &path : paths) {
129 char file[FILE_MAX];
130 STRNCPY(file, path.c_str());
131 BLI_path_rel(file, dir);
132
133 PointerRNA itemptr{};
134 RNA_collection_add(ptr, "files", &itemptr);
135 BLI_assert_msg(BLI_path_is_rel(file), "Expected path to be relative (start with '//')");
136 RNA_string_set(&itemptr, "name", file + 2);
137 }
138}
139
140} // namespace blender::ed::io
#define FILE_MAX
#define BLI_path_join(...)
#define TIP_(msgid)
#define RNA_PROP_END
#define RNA_PROP_BEGIN(sptr, itemptr, prop)
#define C
Definition RandGen.cpp:29
#define BLI_assert_msg(a, msg)
void append_non_duplicates(const T &value)
bool poll_file_object_drop(const bContext *C, bke::FileHandlerType *)
Definition io_utils.cc:62
Vector< std::string > paths_from_operator_properties(PointerRNA *ptr)
Definition io_utils.cc:79
void paths_to_operator_properties(PointerRNA *ptr, const Span< std::string > paths)
Definition io_utils.cc:121
wmOperatorStatus filesel_drop_import_invoke(bContext *C, wmOperator *op, const wmEvent *)
Definition io_utils.cc:30
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
char * STRNCPY(char(&dst)[N], const char *src)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
std::string WM_operatortype_name(wmOperatorType *ot, PointerRNA *properties)
SpaceOutliner * CTX_wm_space_outliner(const bContext *C)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
const char * BKE_main_blendfile_path_from_global()
Definition main.cc:1063
bool RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
void void BLI_path_split_dir_part(const char *filepath, char *dir, size_t dir_maxncpy) ATTR_NONNULL(1
void RNA_collection_clear(PointerRNA *ptr, const char *name)
bool void BLI_path_rel(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1)
int BLI_path_normalize(char *path) ATTR_NONNULL(1)
wmOperatorStatus WM_operator_props_dialog_popup(bContext *C, wmOperator *op, int width, std::optional< std::string > title, std::optional< std::string > confirm_text, const bool cancel_default, std::optional< std::string > message, const bool show_icon)
bool BLI_path_is_rel(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
std::string RNA_string_get(PointerRNA *ptr, const char *name)
PropertyRNA * RNA_struct_find_collection_property_check(PointerRNA &props, const char *name, const StructRNA *struct_type_check)
void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value)
ARegion * CTX_wm_region(const bContext *C)
bool RNA_property_is_set(PointerRNA *ptr, PropertyRNA *prop)
View3D * CTX_wm_view3d(const bContext *C)
void WM_event_add_fileselect(bContext *C, wmOperator *op)
eRegion_Type regiontype
eSpaceOutliner_Mode outlinevis
struct wmOperatorType * type