summaryrefslogtreecommitdiffstats
path: root/tags/cpp-1.0-incubating-M2-RC3/sca/runtime/extensions/python/src/tuscany/sca/python/PythonServiceWrapper.h
blob: 51b0f1dd64af965c92d38a76a8446db7af4060a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 *   
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/* $Rev$ $Date$ */


#ifndef tuscany_sca_python_pythonservicewrapper_h
#define tuscany_sca_python_pythonservicewrapper_h

#include "tuscany/sca/python/export.h"
#include "tuscany/sca/core/ServiceWrapper.h"
#include "tuscany/sca/core/Operation.h"
#include "tuscany/sca/model/Component.h"
#include "tuscany/sca/model/Interface.h"
#include "tuscany/sca/python/model/PythonImplementation.h"

using namespace tuscany::sca::model;

// undefine _DEBUG so Python does not need it's deebug dll
#ifdef _DEBUG
#undef _DEBUG
#define _SCA_PYTHON_DEBUG
#endif
#include <Python.h>
#ifdef _SCA_PYTHON_DEBUG
#define _DEBUG
#endif


namespace tuscany
{
    namespace sca
    {
        namespace python
        {
            class PythonInterface;
            
            /**
             * Wraps the service on a component implementation.
             * This abstract class is extended by generated code which provides 
             * the implementation of some of the methods. 
             * An instance of this class wraps the actual component implementation which 
             * has been written by a developer of an SCA application.
             */
            class PythonServiceWrapper : public ServiceWrapper
            {
            public:

                /**
                 * Constructor.
                 * @param target The component service to which this wrapper refers.
                 */
                PythonServiceWrapper(Service* service);
    
                /**
                 * Destructor.
                 */ 
                virtual    ~PythonServiceWrapper();
    
                /**
                 * All business method calls to the target component go through the invoke method.
                 * @param operation The details of the method, paramaters and return value for the
                 * business method to be called on the target component.
                 */
                virtual void invoke(Operation& operation);
    
                
            protected:
                
                /**
                 * Return the current instance of the python class.
                 * @return A pointer to an instance of the python class.
                 */
                virtual PyObject* getInstance();

                /**
                 * Creates a new instance of the python class.
                 * @return A pointer to a new instance of the python class.
                 */
                virtual PyObject* newInstance();
    
                /**
                 * Indicates that the current instance of the python module or class
                 * has been finished with. 
                 */
                virtual void releaseInstance();
    

            private:
                /**
                 * Holds a class instance if a classname is provided. 
                 * Will be constructed each time if scope is set to STATELESS
                 */
                PyObject* pythonClassInstance;

                /**
                 * Holds the module 
                 */
                PyObject* pythonModule;
                                
                /**
                 * Adds references to the provided implementation module or class instance 
                 */
                void addReferences(PyObject* module);

                /**
                 * Adds properties to the provided implementation module or class instance 
                 */
                void addProperties(PyObject* module);

                /**
                 * The component to which this wrapper refers.
                 */
                Component* component;

                /**
                 * The component implementation
                 */
                PythonImplementation* implementation;
                
            };
            
        } // End namespace python
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_python_pythonservicewrapper_h