All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pyInterpreter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef TF_PYINTERPRETER_H
25 #define TF_PYINTERPRETER_H
26 
29 
30 #include "pxr/pxr.h"
31 
32 #include "pxr/base/tf/api.h"
33 #include <boost/python/handle.hpp>
34 #include <boost/python/object.hpp>
35 #include <string>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
45 TF_API
46 extern void TfPyInitialize();
47 
52 TF_API
53 extern int TfPyRunSimpleString(const std::string & cmd);
54 
64 TF_API
65 extern boost::python::handle<>
66 TfPyRunString(const std::string & cmd, int start,
67  boost::python::object const &globals = boost::python::object(),
68  boost::python::object const &locals = boost::python::object()
69  );
70 
80 TF_API
81 extern boost::python::handle<>
82 TfPyRunFile(const std::string &filename, int start,
83  boost::python::object const &globals = boost::python::object(),
84  boost::python::object const &locals = boost::python::object()
85  );
86 
91 TF_API
92 extern std::string TfPyGetModulePath(const std::string & moduleName);
93 
94 PXR_NAMESPACE_CLOSE_SCOPE
95 
96 #endif // TF_PYINTERPRETER_H
TF_API boost::python::handle TfPyRunString(const std::string &cmd, int start, boost::python::object const &globals=boost::python::object(), boost::python::object const &locals=boost::python::object())
Runs the given string using PyRun_String().
TF_API void TfPyInitialize()
Starts up the python runtime.
TF_API std::string TfPyGetModulePath(const std::string &moduleName)
Returns the disk path to the given module as an NSString.
TF_API int TfPyRunSimpleString(const std::string &cmd)
Runs the given string using PyRun_SimpleString().
TF_API boost::python::handle TfPyRunFile(const std::string &filename, int start, boost::python::object const &globals=boost::python::object(), boost::python::object const &locals=boost::python::object())
Runs the given file using PyRun_File().