24#ifndef PXR_USD_SDF_PY_LIST_EDITOR_PROXY_H
25#define PXR_USD_SDF_PY_LIST_EDITOR_PROXY_H
31#include "pxr/usd/sdf/listOp.h"
37#include "pxr/base/tf/pyResultConversions.h"
38#include "pxr/base/tf/pyLock.h"
41#include <boost/python.hpp>
43PXR_NAMESPACE_OPEN_SCOPE
45class Sdf_PyListEditorUtils {
47 template <
class T,
class V>
50 ApplyHelper(
const T& owner,
const boost::python::object& callback) :
57 std::optional<V> operator()(SdfListOpType op,
const V& value)
59 using namespace boost::python;
62 object result = _callback(_owner, value, op);
66 return std::optional<V>(e());
70 "incorrect return type.");
73 return std::optional<V>();
84 ModifyHelper(
const boost::python::object& callback) :
90 std::optional<V> operator()(
const V& value)
92 using namespace boost::python;
95 object result = _callback(value);
99 return std::optional<V>(e());
103 "incorrect return type.");
106 return std::optional<V>();
115class SdfPyWrapListEditorProxy {
118 typedef typename Type::TypePolicy TypePolicy;
119 typedef typename Type::value_type value_type;
120 typedef typename Type::value_vector_type value_vector_type;
121 typedef typename Type::ApplyCallback ApplyCallback;
122 typedef typename Type::ModifyCallback ModifyCallback;
123 typedef SdfPyWrapListEditorProxy<Type> This;
126 SdfPyWrapListEditorProxy()
128 TfPyWrapOnce<Type>(&This::_Wrap);
129 SdfPyWrapListProxy<ListProxy>();
135 using namespace boost::python;
137 class_<Type>(_GetName().c_str(), no_init)
138 .def(
"__str__", &This::_GetStr)
139 .add_property(
"isExpired", &Type::IsExpired)
140 .add_property(
"explicitItems",
141 &Type::GetExplicitItems,
142 &This::_SetExplicitProxy)
143 .add_property(
"addedItems",
144 &Type::GetAddedItems,
145 &This::_SetAddedProxy)
146 .add_property(
"prependedItems",
147 &Type::GetPrependedItems,
148 &This::_SetPrependedProxy)
149 .add_property(
"appendedItems",
150 &Type::GetAppendedItems,
151 &This::_SetAppendedProxy)
152 .add_property(
"deletedItems",
153 &Type::GetDeletedItems,
154 &This::_SetDeletedProxy)
155 .add_property(
"orderedItems",
156 &Type::GetOrderedItems,
157 &This::_SetOrderedProxy)
158 .def(
"GetAddedOrExplicitItems", &Type::GetAppliedItems,
159 return_value_policy<TfPySequenceToTuple>())
160 .def(
"GetAppliedItems", &Type::GetAppliedItems,
161 return_value_policy<TfPySequenceToTuple>())
162 .add_property(
"isExplicit", &Type::IsExplicit)
163 .add_property(
"isOrderedOnly", &Type::IsOrderedOnly)
164 .def(
"ApplyEditsToList",
165 &This::_ApplyEditsToList,
166 return_value_policy<TfPySequenceToList>())
167 .def(
"ApplyEditsToList",
168 &This::_ApplyEditsToList2,
169 return_value_policy<TfPySequenceToList>())
171 .def(
"CopyItems", &Type::CopyItems)
172 .def(
"ClearEdits", &Type::ClearEdits)
173 .def(
"ClearEditsAndMakeExplicit", &Type::ClearEditsAndMakeExplicit)
174 .def(
"ContainsItemEdit", &Type::ContainsItemEdit,
175 (arg(
"item"), arg(
"onlyAddOrExplicit")=
false))
176 .def(
"RemoveItemEdits", &Type::RemoveItemEdits)
177 .def(
"ReplaceItemEdits", &Type::ReplaceItemEdits)
178 .def(
"ModifyItemEdits", &This::_ModifyEdits)
181 .def(
"Add", &Type::Add)
182 .def(
"Prepend", &Type::Prepend)
183 .def(
"Append", &Type::Append)
184 .def(
"Remove", &Type::Remove)
185 .def(
"Erase", &Type::Erase)
189 static std::string _GetName()
191 std::string name =
"ListEditorProxy_" +
192 ArchGetDemangled<TypePolicy>();
201 static std::string _GetStr(
const Type& x)
203 return x._listEditor ?
TfStringify(*x._listEditor) :
std::string();
206 static void _SetExplicitProxy(Type& x,
const value_vector_type& v)
208 x.GetExplicitItems() = v;
211 static void _SetAddedProxy(Type& x,
const value_vector_type& v)
213 x.GetAddedItems() = v;
216 static void _SetPrependedProxy(Type& x,
const value_vector_type& v)
218 x.GetPrependedItems() = v;
221 static void _SetAppendedProxy(Type& x,
const value_vector_type& v)
223 x.GetAppendedItems() = v;
226 static void _SetDeletedProxy(Type& x,
const value_vector_type& v)
228 x.GetDeletedItems() = v;
231 static void _SetOrderedProxy(Type& x,
const value_vector_type& v)
233 x.GetOrderedItems() = v;
236 static value_vector_type _ApplyEditsToList(
const Type& x,
237 const value_vector_type& v)
239 value_vector_type tmp = v;
240 x.ApplyEditsToList(&tmp);
244 static value_vector_type _ApplyEditsToList2(
const Type& x,
245 const value_vector_type& v,
246 const boost::python::object& cb)
248 value_vector_type tmp = v;
249 x.ApplyEditsToList(&tmp,
250 Sdf_PyListEditorUtils::ApplyHelper<Type, value_type>(x, cb));
254 static void _ModifyEdits(Type& x,
const boost::python::object& cb)
256 x.ModifyItemEdits(Sdf_PyListEditorUtils::ModifyHelper<value_type>(cb));
260PXR_NAMESPACE_CLOSE_SCOPE
Low-level utilities for informing users of various internal and external diagnostic conditions.
Miscellaneous Utilities for dealing with script.
TF_API bool TfPyIsNone(boost::python::object const &obj)
Return true iff obj is None.
Represents a single list of list editing operations.
Convenience class for accessing the Python Global Interpreter Lock.
Demangle C++ typenames generated by the typeid() facility.
#define TF_CODING_ERROR(fmt, args)
Issue an internal programming error, but continue execution.
std::string TfStringify(const T &v)
Convert an arbitrary type into a string.
TF_API std::string TfStringReplace(const std::string &source, const std::string &from, const std::string &to)
Replaces all occurrences of string from with to in source.
Utilities for calling python callables.
Definitions of basic string utilities in tf.
Provide a way to call a Python callable.