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
144
145
146
147
148
149
150
151
152
|
/***************************************************************************
* object.h
* This file is part of the KDE project
* copyright (C)2004-2006 by Sebastian Sauer (mail@dipe.org)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KROSS_API_OBJECT_H
#define KROSS_API_OBJECT_H
#include <tqstring.h>
#include <tqvaluelist.h>
#include <tqmap.h>
#include <tqvariant.h>
//#include <tqobject.h>
#include <ksharedptr.h>
#include "../main/krossconfig.h"
namespace Kross { namespace Api {
// Forward declaration.
class List;
/**
* The common Object class all other object-classes are
* inheritated from.
*
* The Object class is used as base class to provide
* common functionality. It's similar to what we know
* in Python as PyObject or in TQt as TQObject.
*
* Inherited from e.g. \a Value, \a Module and \a Class .
*
* This class implementates reference counting for shared
* objects. So, no need to take care of freeing objects.
*/
class Object : public KShared
{
public:
/**
* Shared pointer to implement reference-counting.
*/
typedef KSharedPtr<Object> Ptr;
/**
* Constructor.
*/
explicit Object();
/**
* Destructor.
*/
virtual ~Object();
/**
* Return the class name. This could be something
* like "Kross::Api::Object" for this object. The
* value is mainly used for display purposes.
*
* \return The name of this class.
*/
virtual const TQString getClassName() const = 0;
/**
* \return a string representation of the object or
* it's content. This method is mainly used for
* debugging and testing purposes.
*/
virtual const TQString toString();
/**
* Pass a call to the object and evaluated it recursive
* down the object-hierachy. Objects like \a Class are able
* to handle call's by just implementing this function.
* If the call is done the \a called() method will be
* executed recursive from bottom up the call hierachy.
*
* \throws TypeException if the object or the name
* is not callable.
* \param name Each call has a name that says what
* should be called. In the case of a \a Class
* the name is the functionname.
* \param arguments The list of arguments passed to
* the call.
* \return The call-result as \a Object::Ptr instance or
* NULL if the call has no result.
*/
virtual Object::Ptr call(const TQString& name, KSharedPtr<List> arguments);
/**
* Return a list of supported callable objects.
*
* \return List of supported calls.
*/
virtual TQStringList getCalls() { return TQStringList(); }
//FIXME replace function with getChildren() functionality ?
/**
* Try to convert the \a Object instance to the
* template class T.
*
* \throw TypeException if the cast failed.
* \param object The Object to cast.
* \return The to a instance from template type T
* casted Object.
*/
template<class T> static T* fromObject(Object::Ptr object);
/**
* This method got used by the \a ProxyFunction classes
* to translate an unknown \p TYPE to a \a Object instance.
* Classes like \a Value or \a ListT or \a Class are
* overwriting this method to transparently translate these
* passed type while this method just assumes that the
* type is already a \a Object instance.
*/
template<typename TYPE>
static Object::Ptr toObject(TYPE t) { return t; }
};
}}
#include "exception.h"
namespace Kross { namespace Api {
template<class T> inline T* Object::fromObject(Object::Ptr object)
{
T* t = (T*) object.data();
if(! t)
throw KSharedPtr<Exception>( new Exception(TQString("Object \"%1\" invalid.").arg(object ? object->getClassName() : "")) );
return t;
}
}}
#endif
|
