summaryrefslogtreecommitdiffstats
path: root/kexi/plugins/macros/lib/metamethod.h
blob: daf7dfcb6999571e8cb821514604f0723b8efade (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
144
145
146
147
148
149
150
/***************************************************************************
 * This file is part of the KDE project
 * copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
 * copyright (C) 2005 by Tobi Krebs (tobi.krebs@gmail.com)
 *
 * 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 KOMACRO_METAMETHOD_H
#define KOMACRO_METAMETHOD_H

#include <tqstring.h>
#include <tqvaluelist.h>
#include <ksharedptr.h>

#include "komacro_export.h"

struct TQUObject;

namespace KoMacro {

	// forward declarations.
	class Variable;
	class MetaObject;
	class MetaParameter;
	class MetaProxy;

	/**
	* Class to provide abstract methods for the undocumented 
	* TQt3 TQUObject-API functionality.
	*
	* The design tried to limit future porting to TQt4 by providing a
	* somewhat similar API to the TQt4 TQMeta* stuff.
	*/
	class KOMACRO_EXPORT MetaMethod : public KShared
	{
		public:

			/**
			* The type of method this @a MetaMethod provides
			* access to.
			*/
			enum Type {
				Signal, /// The @a MetaMethod points to a TQt signal.
				Slot, /// The @a MetaMethod points to a TQt slot.
				Unknown /// The @a MetaMethod is not known.
			};

			/**
			* Constructor.
			*
			* @param signature The signature this @a MetaMethod has. This
			* includes the tagname and the arguments and could look like
			* "myslot(const TQString&, int)".
			* @param type The @a MetaMethod::Type the @a MethodMethod
			* has.
			* @param object The @a MetaObject this @a MethodMethod
			* belongs to. Each @a MethodMethod is associated with
			* exactly one @a MetaObject .
			*/
			explicit MetaMethod(const TQString& signature, Type type = Unknown, KSharedPtr<MetaObject> object = 0);

			/**
			* Destructor.
			*/
			~MetaMethod();

			/**
			* @return the @a MetaObject instance this @a MethodMethod
			* belongs to.
			*/
			KSharedPtr<MetaObject> const object() const;

			/**
			* @return the signature this @a MetaMethod has. It could
			* be something like "mySlot(const TQString&,int)".
			*/
			const TQString signature() const;

			/**
			* @return the signatures tagname this @a MetaMethod has.
			* At the signature "mySlot(const TQString&,int)" the
			* tagname would be "mySlot".
			*/
			const TQString signatureTag() const;

			/**
			* @return the signatures arguments this @a MetaMethod has.
			* At the signature "mySlot(const TQString&,int)" the
			* arguments are "const TQString&,int".
			*/
			const TQString signatureArguments() const;

			/**
			* @return the @a Type of method this @a MetaMethod provides
			* access to.
			*/
			Type type() const;

			/**
			* @return the signature arguments as parsed list of
			* @a MetaParameter instances.
			*/
			TQValueList< KSharedPtr<MetaParameter> > arguments() const;

			/**
			* Translate the passed @p arguments list of @a Variable instances
			* into a TQt3 TQUObject* array.
			*/
			TQUObject* toTQUObject(TQValueList< KSharedPtr<Variable> > arguments);

			/**
			* Translate the passed @p uo TQUObject reference into an internal used
			* @a Variable instances.
			*/
			KSharedPtr<Variable> toVariable(TQUObject* uo);

			/**
			* Translate the passed @p uo TQUObject array into an internal used
			* list of @a Variable instances.
			*/
			TQValueList< KSharedPtr<Variable> > toVariableList(TQUObject* uo);

			/**
			* Invoke the @a MetaMethod with the optional arguments
			* @p arguments and return a variable.
			*/
			KSharedPtr<Variable> invoke(TQValueList< KSharedPtr<Variable> > arguments);

		private:
			/// @internal d-pointer class.
			class Private;
			/// @internal d-pointer instance.
			Private* const d;
	};

}

#endif