Library of Assembled Shared Sources
utilities.cpp
Go to the documentation of this file.
1/** @file
2 * @author Bram de Greve (bram@cocamware.com)
3 * @author Tom De Muer (tom@cocamware.com)
4 *
5 * *** BEGIN LICENSE INFORMATION ***
6 *
7 * The contents of this file are subject to the Common Public Attribution License
8 * Version 1.0 (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 * http://lass.sourceforge.net/cpal-license. The License is based on the
11 * Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover
12 * use of software over a computer network and provide for limited attribution for
13 * the Original Developer. In addition, Exhibit A has been modified to be consistent
14 * with Exhibit B.
15 *
16 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT
17 * WARRANTY OF ANY KIND, either express or implied. See the License for the specific
18 * language governing rights and limitations under the License.
19 *
20 * The Original Code is LASS - Library of Assembled Shared Sources.
21 *
22 * The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
23 * The Original Developer is the Initial Developer.
24 *
25 * All portions of the code written by the Initial Developer are:
26 * Copyright (C) 2004-2011 the Initial Developer.
27 * All Rights Reserved.
28 *
29 * Contributor(s):
30 *
31 * Alternatively, the contents of this file may be used under the terms of the
32 * GNU General Public License Version 2 or later (the GPL), in which case the
33 * provisions of GPL are applicable instead of those above. If you wish to allow use
34 * of your version of this file only under the terms of the GPL and not to allow
35 * others to use your version of this file under the CPAL, indicate your decision by
36 * deleting the provisions above and replace them with the notice and other
37 * provisions required by the GPL License. If you do not delete the provisions above,
38 * a recipient may use your version of this file under either the CPAL or the GPL.
39 *
40 * *** END LICENSE INFORMATION ***
41 */
42
43#include "python_common.h"
44#include "utilities.h"
45#include "exception.h"
46#include "pyobject_plus.h"
47
48namespace lass
49{
50namespace python
51{
52namespace impl
53{
54
55TPyObjPtr runString(const char *code, int start)
56{
57 LockGIL LASS_UNUSED(lock);
58 const TPyObjPtr dict = globals();
59 const TPyObjPtr result(PY_ENFORCE_POINTER(PyRun_String(code, start, dict.get(), dict.get())));
60 return result;
61}
62
63}
64
65/** @ingroup Python
66 * @brief retrieve pointer to PyObject by its name in the script.
67 * @return
68 * new reference to PyObject @a iName or NULL if
69 * @a iName does not exist (_without_ setting an exception!)
70 */
71TPyObjPtr getPyObjectByName(const std::string& iName)
72{
73 LockGIL LASS_UNUSED(lock);
74 const TPyObjPtr dict = globals();
75 const TPyObjPtr key(PY_ENFORCE_POINTER(pyBuildSimpleObject(iName)));
76 PyObject* const object = PyDict_GetItem(dict.get(), key.get());
78}
79
80
81
82/** @ingroup Python
83 */
84TPyObjPtr globals()
85{
86 LockGIL LASS_UNUSED(lock);
87 PyObject* const module = PY_ENFORCE_POINTER(PyImport_AddModule("__main__"));
88 PyObject* const dict = PY_ENFORCE_POINTER(PyModule_GetDict(module));
90}
91
92
93
94/** @ingroup Python
95 */
96void execute(const std::string& code)
97{
98 execute(code.c_str());
99}
100
101
102
103/** @ingroup Python
104 */
105void execute(const char* code)
106{
107 impl::runString(code, Py_file_input);
108}
109
110
111
112/** @ingroup Python
113 */
114TPyObjPtr evaluate(const std::string& code)
115{
116 return evaluate(code.c_str());
117}
118
119
120
121/** @ingroup Python
122 */
123TPyObjPtr evaluate(const char* code)
124{
125 return impl::runString(code, Py_eval_input);
126}
127
128
129
130/** os.environ[key] = value
131 * @ingroup Python
132 */
133void putenv(const std::string& key, const std::string& value)
134{
135 putenv(key.c_str(), value.c_str());
136}
137
138
139
140/** os.environ[key] = value
141 * @ingroup Python
142 */
143void putenv(const char* key, const char* value)
144{
145 LockGIL LASS_UNUSED(lock);
146 const TPyObjPtr item(PY_ENFORCE_POINTER(pyBuildSimpleObject(value)));
147 const TPyObjPtr os(PY_ENFORCE_POINTER(PyImport_ImportModule("os")));
148 PyObject* const dict = PY_ENFORCE_POINTER(PyModule_GetDict(os.get()));
149 PyObject* const os_environ = PY_ENFORCE_POINTER(PyDict_GetItemString(dict, "environ"));
150 PY_ENFORCE_ZERO(PyMapping_SetItemString(os_environ, const_cast<char*>(key), item.get()));
151}
152
153
154}
155}
156
157// EOF
acquire the GIL for the current scope.
Definition gil.h:56
#define PY_ENFORCE_ZERO(expression)
Enforce that an expression evaluates to zero.
#define PY_ENFORCE_POINTER(pointer)
Enforce that a Python pointer is not null.
PyObjectPtr< PyObject >::Type TPyObjPtr
PyObjectPtr to a PyObject.
TPyObjPtr getPyObjectByName(const std::string &iName)
retrieve pointer to PyObject by its name in the script.
Definition utilities.cpp:71
void putenv(const std::string &key, const std::string &value)
os.environ[key] = value
lass::util::SharedPtr< T, PyObjectStorage, PyObjectCounter > fromNakedToSharedPtrCast(PyObject *object)
fromNakedToSharedPtrCast.
Comprehensive C++ to Python binding library.
Library for Assembled Shared Sources.
Definition config.h:53