summaryrefslogtreecommitdiffstats
path: root/languages/cpp/typedesc.h
blob: f2746a03b570f4ebac58418f2ea1e47ba79b0842 (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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/***************************************************************************
  copyright            : (C) 2006 by David Nolden
  email                : david.nolden.tdevelop@art-master.de
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef __TYPEDESC_H__
#define __TYPEDESC_H__

#include <tdetexteditor/codecompletioninterface.h>
#include <ksharedptr.h>

#include "includefiles.h"
#include "typedecoration.h"

class TypeDesc;
class TypeDescShared;
class SimpleTypeImpl;

class TypeTrace;

typedef TDESharedPtr<TypeDescShared> TypeDescPointer;
typedef TDESharedPtr<SimpleTypeImpl> TypePointer;

enum ResolutionFlags {
  NoFlag = 0,
  HadTypedef = 1,
  HadTemplate = 2,
  HadAlias = 3
};

class LocateResult {
  public:
    struct NewLocateMode { ///This is a helper that saves the influence on the behavior of locateType(..)
      NewLocateMode() : mode(0), dir(0), valid(false) {
      }
      uint mode;
      int dir;
      bool valid;
    };
  private:
    struct D;
    D* d;
    int m_resolutionCount;
    ResolutionFlags m_flags;
    TypeTrace* m_trace; ///pointer to the previous type in the trace-chain
    int m_locateDepth; ///How far away from the beginning the type was found(counting steps upwards and steps into base-classes. Counter is stopped on the first typedef.)

    NewLocateMode m_locateMode;
  public:
    LocateResult();
    LocateResult( const TypeDesc& desc );

    LocateResult( const TypeDescPointer& desc );
    LocateResult( TypeDescShared* desc );
    LocateResult( const LocateResult& rhs );
    ~LocateResult();
    /*
    LocateResult& operator = ( const TypeDesc& rhs ) {
    	m_desc = new rhs;
    	return *this;
    }*/

  ///Returns the locate-flags that would have been used for locating a sub-item of this one(given the flags this was located with)
  NewLocateMode& locateMode() { 
      return m_locateMode;
    }

	LocateResult& operator = ( const TypeDesc& rhs );

    operator const TypeDesc&() const;

    operator TypeDesc&() ;

	TypeDesc& desc();

	const TypeDesc& desc() const;
	
    int depth() const {
      return m_locateDepth;
    }

    ///This may be used to simply increase the depth while returning a LocateResult
    LocateResult& increaseDepth() {
      m_locateDepth++;
      return *this;
    }

    ///This may be used to simply reset the depth while returning a LocateResult
    LocateResult& resetDepth() {
      m_locateDepth = 0;
      return *this;
    }

    LocateResult& operator * () {
      return * this;
    }

    const LocateResult& operator * () const {
      return * this;
    }

  //operator TypeDescPointer();

    operator bool() const;

    LocateResult& operator = ( const LocateResult& rhs );

    bool operator >( const LocateResult& rhs ) const {
      return m_resolutionCount > rhs.m_resolutionCount;
    }

    const TypeDesc* operator ->() const;

    TypeDesc* operator ->();

    int resolutionCount() const {
      return m_resolutionCount;
    }

    void increaseResolutionCount() {
      m_resolutionCount++;
    }

    void addResolutionFlag( ResolutionFlags flag );

    bool hasResolutionFlag( ResolutionFlags flag ) const;

    TypeTrace* trace();
};

    ///These flags have no internal use, they are set and read from the outside
enum TypeDescFlags {
	Standard = 0,
		ResolutionTried = 1  ///means that the resolution was tried, and should not be retried.
};


struct TypeDescData : public TDEShared {
    typedef TQValueList<LocateResult> TemplateParams;
    TQString m_cleanName;
    int m_pointerDepth;
    int m_functionDepth;
    TemplateParams m_templateParams;
    TypeDescPointer m_nextType;
    TypePointer m_resolved;
    TypeDecoration m_dec;
    TypeDescFlags m_flags;
    HashedStringSet m_includeFiles;

	TypeDescData() : m_hashValid( false ), m_hash2Valid( false ) {
	}
	void invalidateKey() {
		m_hashValid = false;
		m_hash2Valid = false;
	}

	size_t hashKey();
	size_t hashKey2(); 
private:
	bool m_hashValid;
	uint m_hashKey;
	bool m_hash2Valid;
	uint m_hashKey2;
};


class TypeDesc {
  public:
    typedef TQValueList<LocateResult> TemplateParams;

	TypeDesc();

	TypeDesc( const TQString& str );
	
    TypeDesc( const TypeDesc& rhs );

    bool deeper( const TypeDesc& rhs ) const {
      return depth() > rhs.depth();
    }

    bool longer( const TypeDesc& rhs ) const {
      return length() > rhs.length();
    }

    TypeDesc& operator = ( const TypeDesc& rhs );

    TypeDesc& operator = ( const TQString& rhs ) {
      init( rhs );
      return *this;
    }

    TypeDesc firstType() const {
      TypeDesc ret = *this;
      ret.setNext( 0 );
      return ret;
    }

	size_t hashKey() const;

	/**Returns a hash-key that is computed in a different way than the first.
	 * If both keys match, it is pretty sure that typedescs are same.
	 * */
	size_t hashKey2() const;

///this function must be remade
    bool isValidType() const ;

    int depth() const;

    int length() const ;

    ///Does not respect include-files
    int compare ( const TypeDesc& rhs ) const;

    ///Does not respect include-files
    bool operator < ( const TypeDesc& rhs ) const {
      return compare( rhs ) == -1;
    }

    ///Does not respect include-files
    bool operator > ( const TypeDesc& rhs ) const {
      return compare( rhs ) == 1;
    }

    ///Does not respect include-files
    bool operator == ( const TypeDesc& rhs ) const {
      return compare( rhs ) == 0;
    }

    HashedStringSet includeFiles() const;
    
    ///Sets the include-files for this desc, the next-desc, and all template-params
    void setIncludeFiles( const HashedStringSet& files );
    
    void addIncludeFiles( const HashedStringSet& files );

    TQString nameWithParams() const;

    ///returns the type including template-parameters and pointer-depth
    TQString fullName( ) const;

    /**returns the type include template-parameters, pointer-depth, and possible sub-types.
       Example "A::B": A is the type, and B is the subtype */
    TQString fullNameChain( ) const ;

    ///Returns the type-structure(full name-chain without any instance-info)
    TQString fullTypeStructure() const;

	void prependDecoration( const TQString& str );

    ///Since the pointer-depth of a resolved type is always stored in the last element of its chain, this gives fast access to that depth
    int totalPointerDepth() const;

    void setTotalPointerDepth( int d );
  
    int pointerDepth() const {
	    if( !m_data ) return 0;
	    
      return m_data->m_pointerDepth;
    }

    void setPointerDepth( int d ) {
      makeDataPrivate();
      m_data->m_pointerDepth = d;
    }

  /*void decreasePointerDepth() {
	    maybeInit();
	    
      if ( m_data->m_pointerDepth > 0 ) {
        makeDataPrivate();
        m_data->m_pointerDepth--;
      }
    }*/

    ///returns a list include the full name of this type, and all subtypes
    TQStringList fullNameList( ) const;

	TQString decoratedName() const {
		if( !m_data ) return "";
		TQString ret = m_data->m_dec.apply( name() );
		for( int a = 0; a < pointerDepth(); a++ )
			ret += "*";
		return ret;
	}
	
    TQString name() const {
	    if( !m_data ) return "";
      return m_data->m_cleanName;
    };

    void setName( TQString name ) {
      makeDataPrivate();
      m_data->m_cleanName = name;
    }

    /** The template-params may be changed in-place
        this list is local, but the params pointed by them not(call makePrivate before changing) */
    TemplateParams& templateParams();

    const TemplateParams& templateParams() const;

    ///clears the current template-parameters, and extracts those from the given string
    void takeTemplateParams( const TQString& string );

    /**makes all references/pointers private, so everything about this structure may be changed without side-effects*/
    TypeDesc& makePrivate();

    operator bool () const {
	    if( !m_data ) return false;
	    
      return !m_data->m_cleanName.isEmpty();
    }

    TypeDescPointer next();

    TDESharedPtr<const TypeDescShared> next() const;

    bool hasTemplateParams() const ;

    void setNext( TypeDescPointer type );

    void append( TypeDescPointer type );

    TypePointer resolved() const ;

    void setResolved( TypePointer resolved );

    void resetResolved();

    ///Resets the resolved-pointers of this type, and all template-types
    void resetResolvedComplete();

    void increaseFunctionDepth();

    void decreaseFunctionDepth();

    int functionDepth() const;

    static const char* functionMark;

    void setFlag( TypeDescFlags flag ) {
	    makeDataPrivate();
	    m_data->m_flags = ( TypeDescFlags ) ( m_data->m_flags | flag );
    }

    bool hasFlag( TypeDescFlags flag ) {
	    if( !m_data ) return false;
	    
	    return ( bool ) ( m_data->m_flags & flag );
    }

    ///instance-information consists of things like the pointer-depth and the decoration
    void takeInstanceInfo( const TypeDesc& rhs );

	/*bool decorationSmaller( const TypeDesc& rhs );

	int decorationDepth();*/
	
    void clearInstanceInfo();


  private:
	void takeData( const TQString& string );
    void makeDataPrivate();
    TDESharedPtr<TypeDescData> m_data;

	void  maybeInit();
  	void init( TQString stri );

};

class TypeDescShared : public TypeDesc, public TDEShared {
  public:


    TypeDescShared( const TypeDescShared& rhs ) : TypeDesc( rhs ), TDEShared() {}

    TypeDescShared( const TypeDesc& rhs ) : TypeDesc( rhs ), TDEShared() {}

    TypeDescShared& operator = ( const TypeDesc& rhs ) {
      ( *( TypeDesc* ) this ) = rhs;
      return *this;
    }

	TypeDescShared( const TQString& name ) : TypeDesc( name ) {}
	TypeDescShared() : TypeDesc() {}
}
;

extern TypeDesc operator + ( const TypeDesc& lhs, const TypeDesc& rhs );

#endif 
// kate: indent-mode csands; tab-width 4;