summaryrefslogtreecommitdiffstats
path: root/lib/interfaces/codemodel.h
blob: 9e420dc192775f2f5060c2fa341a3646a4fc6704 (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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
/* This file is part of TDevelop
   Copyright (C) 2003 Roberto Raggi <roberto@kdevelop.org>
   Copyright (C) 2004 Matt Rogers <mattr@kde.org> 
   Copyright (C) 2004 Alexander Dymo <adymo@kdevelop.org>

   This library 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 library 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 library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef CODEMODEL_H
#define CODEMODEL_H

/**
@file codemodel.h
Code Model - a memory symbol store.
*/


#include <tqmap.h>
#include <tqstringlist.h>
#include <ksharedptr.h>
#include <tqvaluevector.h>
#include "hashedstring.h"

#include <iostream>
#include <ostream>
#include <string>
#include <sstream>
#include <set>

enum ParsedFileType {
  CppParsedFile
};

class AbstractParseResult : public TDEShared {
public:
  virtual void read( TQDataStream& stream ) = 0;

  virtual void write( TQDataStream& stream ) const = 0;

  virtual ParsedFileType type() const = 0;
};

typedef TDESharedPtr<AbstractParseResult> ParseResultPointer;
  
using namespace std;

class CodeModel;
class CodeModelItem;
class FileModel;
class NamespaceModel;
class ClassModel;
class FunctionModel;
class FunctionDefinitionModel;
class VariableModel;
class ArgumentModel;
class EnumModel;
class EnumeratorModel;
class TypeAliasModel;

/**
@class ItemDom
Safe pointer to the @ref CodeModelItem.
This is a type definition: @code typedef TDESharedPtr<CodeModelItem> ItemDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<CodeModelItem> ItemDom;

/**
@class FileDom
Safe pointer to the @ref FileModel.
This is a type definition: @code typedef TDESharedPtr<FileModel> FileDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<FileModel> FileDom;

/**
@class NamespaceDom
Safe pointer to the @ref NamespaceModel.
This is a type definition: @code typedef TDESharedPtr<NamespaceModel> NamespaceDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<NamespaceModel> NamespaceDom;

/**
@class ClassDom
Safe pointer to the @ref ClassModel.
This is a type definition: @code typedef TDESharedPtr<ClassModel> ClassDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<ClassModel> ClassDom;

/**
@class FunctionDom
Safe pointer to the @ref FunctionModel.
This is a type definition: @code typedef TDESharedPtr<FunctionModel> FunctionDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<FunctionModel> FunctionDom;

/**
@class FunctionDefinitionDom
Safe pointer to the @ref FunctionDefinitionModel.
This is a type definition: @code typedef TDESharedPtr<FunctionDefinitionModel> FunctionDefinitionDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<FunctionDefinitionModel> FunctionDefinitionDom;

/**
@class VariableDom
Safe pointer to the @ref VariableModel.
This is a type definition: @code typedef TDESharedPtr<VariableModel> VariableDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<VariableModel> VariableDom;

/**
@class ArgumentDom
Safe pointer to the @ref ArgumentModel.
This is a type definition: @code typedef TDESharedPtr<ArgumentModel> ArgumentDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<ArgumentModel> ArgumentDom;

/**
@class EnumDom
Safe pointer to the @ref EnumModel.
This is a type definition: @code typedef TDESharedPtr<EnumModel> EnumDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<EnumModel> EnumDom;

/**
@class TypeAliasDom
Safe pointer to the @ref TypeAliasModel.
This is a type definition: @code typedef TDESharedPtr<TypeAliasModel> TypeAliasDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<TypeAliasModel> TypeAliasDom;

/**
@class EnumeratorDom
Safe pointer to the @ref EnumeratorModel.
This is a type definition: @code typedef TDESharedPtr<EnumeratorModel> EnumeratorDom; @endcode
@sa TDESharedPtr
*/
typedef TDESharedPtr<EnumeratorModel> EnumeratorDom;

/**
@class ItemList
The list of code model items.
This is a type definition: @code typedef TQValueList<ItemDom> ItemList; @endcode
@sa TQValueList
*/
typedef TQValueList<ItemDom> ItemList;

/**
@class FileList
The list of code model files.
This is a type definition: @code typedef TQValueList<FileDom> FileList; @endcode
@sa TQValueList
*/
typedef TQValueList<FileDom> FileList;

/**
@class NamespaceList
The list of code model namespaces.
This is a type definition: @code typedef TQValueList<NamespaceDom> NamespaceList; @endcode
@sa TQValueList
*/
typedef TQValueList<NamespaceDom> NamespaceList;

/**
@class ClassList
The list of code model classes.
This is a type definition: @code typedef TQValueList<ClassDom> ClassList; @endcode
@sa TQValueList
*/
typedef TQValueList<ClassDom> ClassList;

/**
@class FunctionList
The list of code model functions.
This is a type definition: @code typedef TQValueList<FunctionDom> FunctionList; @endcode
@sa TQValueList
*/
typedef TQValueList<FunctionDom> FunctionList;

/**
@class FunctionDefinitionList
The list of code model function definitions.
This is a type definition: @code typedef TQValueList<FunctionDefinitionDom> FunctionDefinitionList; @endcode
@sa TQValueList
*/

typedef TQValueList<FunctionDefinitionDom> FunctionDefinitionList;
/**
@class VariableList
The list of code model variables.
This is a type definition: @code typedef TQValueList<VariableDom> VariableList; @endcode
@sa TQValueList
*/
typedef TQValueList<VariableDom> VariableList;

/**
@class ArgumentList
The list of code model arguments.
This is a type definition: @code typedef TQValueList<ArgumentDom> ArgumentList; @endcode
@sa TQValueList
*/
typedef TQValueList<ArgumentDom> ArgumentList;

/**
@class EnumList
The list of code model enums.
This is a type definition: @code typedef TQValueList<EnumDom> EnumList; @endcode
@sa TQValueList
*/
typedef TQValueList<EnumDom> EnumList;

/**
@class TypeAliasList
The list of code model type aliases.
This is a type definition: @code typedef TQValueList<TypeAliasDom> TypeAliasList; @endcode
@sa TQValueList
*/
typedef TQValueList<TypeAliasDom> TypeAliasList;

/**
@class EnumeratorList
The list of code model enumerators.
This is a type definition: @code typedef TQValueList<EnumeratorDom> EnumeratorList; @endcode
@sa TQValueList
*/
typedef TQValueList<EnumeratorDom> EnumeratorList;

/**
Iterates through @p lst and creates sorted list of code model item names.
Can be used, for example, to get the list of classes in the store:
@code
TQStringList classList = sortedNameList(codeModel()->globalNamespace()->classList());
@endcode
@param lst The list to iterate.
@return Sorted list of code model item names.
*/
template <class ItemList>
TQStringList sortedNameList( const ItemList& lst )
{
    TQStringList nameList;

    typename ItemList::ConstIterator it = lst.begin();
    while( it != lst.end() ){
        if( !(*it)->name().isEmpty() )
            nameList << (*it)->name();
        ++it;
    }

    nameList.sort();
    return nameList;
}

/**
Casts safe code model pointers (@p TDESharedPtr<T> objects like
FileDom, NamespaceDom, etc.) to the @p Result type.

Example:
@code
//ns is of type NamespaceDom
ClassDom cl = model_cast<ClassDom>(ns);
@endcode
@param x Object to cast.
*/
template <class Result, class T>
Result model_cast( TDESharedPtr<T> x )
{
    Result r( static_cast<T*>(x) );
    return r;
}

/**
Casts code model pointers (objects like
FileModel, NamespaceModel, etc.) to the @p Result type.

Example:
@code
//ns is of type NamespaceModel*
ClassDom cl = model_cast<ClassDom>(ns);
@endcode
@param x Object to cast.
*/
template <class Result, class T>
Result model_cast( T* x )
{
    Result r( static_cast<T*>(x) );
    return r;
}


/**
Code Model - a memory symbol store.
Symbol store (aka class store) is a database of symbols
found in code with the important information about those symbols.

For example, programming language support plugins use symbol store
to remember information about classes, functions, etc. For each type
of symbol a certain information can be stored - symbol name, the
location in source file, etc.

@sa codemodel.h documentation for a list of typedefs and other convenience functions.

@sa codemodel_utils.h documentation for an additional code model utility functions and classes reference.
*/
class CodeModel
{
public:
    /**Constructor.*/
    CodeModel();
    /**Destructor.*/
    virtual ~CodeModel();

    /**Creates a code model item. This should be used to create
    code model items.
    
    For example, to create a class model somewhere in your plugin, use:
    @code
    klass = codeModel()->create<ClassModel>();
    klass->setName("ClassName");
    klass->setFileName("FileName");
    klass->setStartPosition(line, column);
    @endcode
    @return Created code model item.*/
    template <class T> typename T::Ptr create()
    {
        typename T::Ptr ptr( new T(this) );
        return ptr;
    }

    /**Resets the CodeModel.*/
    void wipeout();

    /**Gets the list of files in the store.
    @return The FileList object that contains the list of files.*/
    FileList fileList();

    /**Gets the list of files in the store.
    This is a const version for convenience.
    @return The FileList object that contains the list of files.*/
    const FileList fileList() const;

    /**Checks to see if a file is in the store.
    @return true if @p name is in the file list.*/
    bool hasFile( const TQString& name ) const;

    /**Gets the FileDom object for a file.
    @param name The name of the file to get the FileDom object for.*/
    FileDom fileByName( const TQString& name );

    /**Gets the FileDom object for a file.
    This is a const version provided for convenience.
    @param name the name of the file to get the FileDom object for.*/
    const FileDom fileByName( const TQString& name ) const;

    /**Adds a file to the store.
    @param file The FileDom object to add to the store.
    @return true if the file was added successfully.*/
    bool addFile( FileDom file );

    /**Removes a file from the store.
    @param file the FileDom object to remove from the store.*/
    void removeFile( FileDom file  );

    /**Gets the global namespace
    @return The NamespaceDom object that represents the global namespace.*/
    const NamespaceDom globalNamespace() const;

    /**Reads the model from a stream.
    Use this to save the memory symbol store to a file.
    
    Language support plugins usually save symbols from projects before the project is 
    closed to avoid reparsing when the project is opened next time.
    @param stream Stream to read from.
    @return whether the read succeeded(may fail when the store-format is deprecated).*/
    virtual void read( TQDataStream& stream );
    /**Writes the model to a stream.
    Use this to restore the memory symbol store to a file.
    
    Language support plugins usually save symbols from projects before the project is 
    closed to avoid reparsing when the project is opened next time.
    @param stream Stream to write to.*/
    virtual void write( TQDataStream& stream ) const;
    
    /** this will dump the whole tree into dot-file-format so it can be inspected, not ready yet*/
    virtual void dump( std::ostream& file, TQString Info="" );
    
    /** Merges two groups, by changing the group-ids of the files.
    Returns the id of the new group, or 0 on fail.
    @param g1 first group
    @param g2 second group */
    int mergeGroups( int g1, int g2 );
    
    /** Returns all files within the given group 
    it should be preferred calling FileModel::wholeGroup and 
    FileModel::wholeGroupStrings because those return in constant
    time if they are the only member of the group */
    FileList getGroup( int gid ) const;
    
    FileList getGroup( const FileDom& file) const;
    
    /** Same as above, but returns the names instead of the objects */
    virtual TQStringList getGroupStrings( int gid ) const;
    
private:
    /**Adds a namespace to the store.
    @param target The NamespaceDom object that the namespace will be added to.
    @param source The NamespaceDom object that contains the namespace to remove.*/
    void addNamespace( NamespaceDom target, NamespaceDom source );

    /**Removes a namespace from the store.
    @param target The NamespaceDom object that the namespace will be removed from.
    @param source The NamespaceDom object that contains the namespace to remove.*/
    void removeNamespace( NamespaceDom target, NamespaceDom source );

private:
    TQMap<TQString, FileDom> m_files;
    NamespaceDom m_globalNamespace;

    virtual int newGroupId();
    ///the groups were introduced to represent dependencies between different files.
    ///Files can have slaves that are owned by other files within the same group.
    ///While parsing, whole groups should always be parsed/reparsed together.
    int m_currentGroupId;   ///normally, each file has its own group.
    
private:
    CodeModel( const CodeModel& source );
    void operator = ( const CodeModel& source );
    friend class CodeModelItem;
    friend class FileModel;
};


/**
Item in code model (symbol store).
Item is a symbol in a store. Code model provides several predefined classes
for predefined item types (files, namespaces, classes, functions and function definitions,
variables, arguments, enums and enumerators, type aliases.

Instances of this class should be created using @ref CodeModel::create method but usually
it is better to create instances of derived classes like ClassModel, NamespaceModel, FileModel, etc.
*/
class CodeModelItem: public TDEShared
{
public:
    /**A definition of safe pointer to the code model item.*/
    typedef ItemDom Ptr;

    /**A type of a code model item.*/
    enum Kind
    {
        File,                /**<File.*/
        Namespace,           /**<Namespace.*/
        Class,               /**<Class.*/
        Function,            /**<Function or class method.*/
        Variable,            /**<Variable.*/
        Argument,            /**<Function or method parameter.*/
        FunctionDefinition,  /**<Function definition.*/
        Enum,                /**<Enum.*/
        Enumerator,          /**<Enumerator - a member of an Enum (example: @code enum Type { A, B, C} @endcode 
                                Type will be an Enum; A, B and C - Enumerators.*/
        TypeAlias,           /**<Type alias (aka typedef in c++).*/
    
        Custom = 1000        /**<Custom model items should have type greater than 1000*/
    };

    /**An access to the code model item.*/
    enum Access
    {
        Public,        /**<Public.*/
        Protected,     /**<Protected.*/
        Private        /**<Private.*/
    };
    void update( const CodeModelItem* i );
    bool canUpdate( const CodeModelItem* i ) const;

protected:
    /**Constructor.
    @param kind The type, see also @ref CodeModelItem::Kind.
    @param model Code model which stores this item.*/
    CodeModelItem( int kind, CodeModel* model );

public:
    /**Destructor.*/
    virtual ~CodeModelItem();

    /**@return The type (kind) of item.*/
    int kind() const { return m_kind; }

    /**Sets the type (kind) of item.
    @param kind The type, see also @ref CodeModelItem::Kind.*/
    void setKind( int kind ) { m_kind = kind; }

    /**@return The name of the item.*/
    TQString name() const;

    TQString comment() const {
        return m_comment;
    }
    
    void setComment( TQString comment ) {
        m_comment = comment;
    }
    
    /**Sets the name of the item.
    @param name The name.*/
    void setName( const TQString& name );

    /**Gets the file of the item.
    @return The FileDom object for the item.*/
    FileDom file();

    /**Gets the file of the item
    This is a const version provided for convenience.
    @return The FileDom object for the item.*/
    const FileDom file() const;

    /**@return The filename of the item.*/
    TQString fileName() const;

    /**Sets the filename of the item.
    @param fileName The file name.*/
    void setFileName( const TQString& fileName );

    /**Gets the start position of the item.
    @param line Will be set to the line number of the items start position. Pass 0 if line number is not necessary.
    @param col Will be set to the column number of the items start position. Pass 0 if column number is not necessary.*/
    void getStartPosition( int* line, int* col ) const;

    /**Sets the start position of the item.
    @param line Line number.
    @param col Column number.*/
    void setStartPosition( int line, int col );

    /**Get the end position of the item.
    @param line Will be set to the line number of the items end position. Pass 0 if line number is not necessary.
    @param col Will be set to the column number of the items end position. Pass 0 if column number is not necessary.*/
    void getEndPosition( int* line, int* col ) const;

    /**Set the end position of the item.
    @param line Line number.
    @param col Column number.*/
    void setEndPosition( int line, int col );

    /**@return true if an item is a FileModel.*/
    virtual bool isFile() const { return false; }
    /**@return true if an item is a NamespaceModel.*/
    virtual bool isNamespace() const { return false; }
    /**@return true if an item is a ClassModel.*/
    virtual bool isClass() const { return false; }
    /**@return true if an item is a FunctionModel.*/
    virtual bool isFunction() const { return false; }
    /**@return true if an item is a FileDefinitionModel.*/
    virtual bool isFunctionDefinition() const { return false; }
    /**@return true if an item is a VariableModel.*/
    virtual bool isVariable() const { return false; }
    /**@return true if an item is an ArgumentModel.*/
    virtual bool isArgument() const { return false; }
    /**@return true if an item is a EnumModel.*/
    virtual bool isEnum() const { return false; }
    /**@return true if an item is a EnumeratorModel.*/
    virtual bool isEnumerator() const { return false; }
    /**@return true if an item is a TypeAliasModel.*/
    virtual bool isTypeAlias() const { return false; }
    /**@return true if an item is a custom item.*/
    virtual bool isCustom() const { return false; }
    
    virtual bool isTemplateable() const { return false; }

    /**Reads an item from the stream.
    @param stream The stream to read from.*/
    virtual void read( TQDataStream& stream );
    /**Writes an item to the stream.
    @param stream The stream to write to.*/
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
    /**@return The code model for this item.*/
    CodeModel* codeModel() { return m_model; }

    /**@note This is a const version provided for convenience.
    @return The code model for this item*/
    const CodeModel* codeModel() const { return m_model; }

private:
    int m_kind;
    CodeModel* m_model;
    TQString m_name;
    TQString m_fileName;
    TQString m_comment; ///not stored yet
    int m_startLine, m_startColumn;
    int m_endLine, m_endColumn;

private:
    CodeModelItem( const CodeModelItem& source );
    void operator = ( const CodeModelItem& source );
};



class TemplateModelItem {
    public:
        typedef TQPair< TQString, TQString > ParamPair;
        typedef TQValueVector< ParamPair > ParamMap; ///The first is the name, and the second the default-parameter, or "" if there is none.
        
        virtual const ParamMap& getTemplateParams() {
            return m_params;
        }
        
        virtual void addTemplateParam( TQString name, TQString def = "" ) {
            m_params.push_back( ParamPair( name, def ) );
        }
        
        virtual void clearTemplateParams() {
            m_params.clear();
        }

				bool hasSpecializationDeclaration() const {
					return !m_specialization.isEmpty();
				}

				virtual TQString getSpecializationDeclaration() const {
					return m_specialization;
				}

				void setSpecializationDeclaration( const TQString& str ) {
					m_specialization = str;
				}
        
        ///returns -1 if the parameter does not exist
        virtual int findTemplateParam( const TQString& name ) const {
            for( unsigned int a = 0; a< m_params.size(); a++) 
                if( m_params[a].first == name ) return a;
            return -1;
       }
        
       const ParamPair getParam( int index ) const {
           return m_params[index];
       }
       
       virtual bool isTemplateable() const  { return true; }
    
       void write(  TQDataStream & stream ) const {
			 		 stream << m_specialization;
           stream << (int)m_params.size();
           for( ParamMap::const_iterator it = m_params.begin(); it != m_params.end(); ++it ) {
               stream << (*it).first;
               stream << (*it).second;
           }
       }
       
       void read(  TQDataStream & stream )  {
           int count;
					 stream >> m_specialization;
           stream >> count;
           for( int a = 0; a < count; a++ ) {
               ParamPair tmp;
               stream >> tmp.first;
               stream >> tmp.second;
               m_params.push_back( tmp );
           }
       }
    
    protected:
        ParamMap m_params;
				TQString m_specialization;
};



/**
Class model.
Represents a class in the code model.

Instances of this class should be created using @ref CodeModel::create method.
*/
class ClassModel: public CodeModelItem, public TemplateModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    ClassModel( CodeModel* model );

public:
    /**A definition of safe pointer to the class model.*/
    typedef ClassDom Ptr;

    virtual bool isClass() const { return true; }

    /**@return The scope of the class. Scope is a string list composed from names of parent classes and namespaces.*/
    TQStringList scope() const { return m_scope; }
    /**Sets the scope of this class.
    @param scope The scope - a list of parent classes and namespaces.*/
    void setScope( const TQStringList& scope ) { m_scope = scope; }

    /**@return The list of base class names.*/
    TQStringList baseClassList() const;

    /**Adds a base class to the list of base classes.
    @param baseClass The base class name.*/
    bool addBaseClass( const TQString& baseClass );

    /**Removes a base class from the list of base classes.
    @param baseClass The base class name.*/
    void removeBaseClass( const TQString& baseClass );

    /**@return The list of (sub)classes in this model.*/
    ClassList classList();

    /**@note This is a const version provided for convenience.
    @return The list of (sub)classes in this model.*/
    const ClassList classList() const;

    /**Checks if the class specified by @p name is in this model.
    @param name The name of a class to look for.
    @return true if the model has a class.*/
    bool hasClass( const TQString& name ) const;

    /**@param name The name of a class.
    @return A list of classes that match the name given by @p name.*/
    ClassList classByName( const TQString& name );

    /**@param name The name of a class.
    @return A list of classes that match the name given by @p name.
    @note This is a const version provided for convenience.*/
    const ClassList classByName( const TQString& name ) const;

    /**Adds a class to the model.
    @param klass The class model to add.
    @return true if addition was successful.*/
    bool addClass( ClassDom klass );

    /**Removes a class from the model.
    @param klass The class model to remove.*/    
    void removeClass( ClassDom klass );

    /**@return A list of functions in the model.*/
    FunctionList functionList();

    /**@return A list of functions in the model.
    @note This is a const version provided for convenience.*/
    const FunctionList functionList() const;

    /**Check if the function specified by @p name is in the model.
    @param name The name of a function to look for.
    @return true if the model has a class.*/
    bool hasFunction( const TQString& name ) const;

    /**@param name The name of a function to look for.
    @return A list of functions that match the name given by @p name.*/
    FunctionList functionByName( const TQString& name );

    /**@param name The name of a function to look for.
    @return A list of functions that match the name given by @p name.
    @note This is a const version provided for convenience.*/
    const FunctionList functionByName( const TQString& name ) const;

    /**Adds a function to the class model.
    @param fun The function model to add.
    @return true if addition was successful.*/
    bool addFunction( FunctionDom fun );

    /**Removes a function from the class model.
    @param fun The FunctionDom object to remove from the model.*/
    void removeFunction( FunctionDom fun );

    /**@return The list of function definitions in the model.*/
    FunctionDefinitionList functionDefinitionList();

    /**@return The list of function definitions
    @note This is a const version provided for convenience.*/
    const FunctionDefinitionList functionDefinitionList() const;

    /**Checks if the function definition specified by \p name is in the model.
    @param name The name of a function definition to look for.
    @return true if the function definition was found.*/
    bool hasFunctionDefinition( const TQString& name ) const;

    /**Gets the list of functions that match the name given by \p name.
    If there are no matches, then the list returned is empty.
    @param name The name of a function definition to look for.
    @return The FunctionDefinitionList object containing the definitions that match.*/
    FunctionDefinitionList functionDefinitionByName( const TQString& name );

    /**Gets the list of functions that match the name given by \p name.
    If there are no matches, then the list returned is empty.
    @param name The name of a function definition to look for.
    @return The FunctionDefinitionList object containing the definitions that match.
    @note This is a const version provided for convenience.*/
    const FunctionDefinitionList functionDefinitionByName( const TQString& name ) const;

    /**Adds a function definition to the model.
    @param fun The function fefinition model to add to the model.
    @return true if the addition was successful.*/
    bool addFunctionDefinition( FunctionDefinitionDom fun );

    /**Removes a function definition from the model.
    @param fun The function fefinition model to remove from the model.*/
    void removeFunctionDefinition( FunctionDefinitionDom fun );

    /**@return The list of variables in the model.*/
    VariableList variableList();

    /**@return The list of variables in the model.
    @note This is a const version provided for convenience.*/
    const VariableList variableList() const;

    /**Checks if the variable specified by @p name is in the model.
    @param name The name of a variable.
    @return true if the variable was found.*/
    bool hasVariable( const TQString& name ) const;

    /**Gets the variable specified by @p name.
    If there are no matches, then the VariableDom object returned is empty.
    @param name The name of a variable.
    @return A VariableDom object that matches the name specified.*/
    VariableDom variableByName( const TQString& name );

    /**Gets the variable specified by @p name.
    If there are no matches, then the VariableDom object returned is empty.
    @param name The name of a variable.
    @return A VariableDom object that matches the name specified.
    @note This is a const version provided for convenience.*/
    const VariableDom variableByName( const TQString& name ) const;

    /**Adds a variable to the model.
    @param var The variable model to add to the model.
    @return true if the addition was successful.*/
    bool addVariable( VariableDom var );

    /**Removes a variable from the model.
    @param var The variable model to remove from the model.*/
    void removeVariable( VariableDom var );

    /**@return The type alias list for this model.*/
    TypeAliasList typeAliasList();

    /**@return The type alias list for this model.
    @note This is a const version provided for convenience.*/
    const TypeAliasList typeAliasList() const;

    /**Checks if the type alias specified by @p name is in the model.
    @param name The name of a type alias.
    @return true if the type alias was found.*/
    bool hasTypeAlias( const TQString& name ) const;

    /**Gets the list of type aliases that match @p name.
    If there are no matches, the TypeAliasList object is empty.
    @param name The name of a type alias.
    @return A TypeAliasList object that contains the matches.*/
    TypeAliasList typeAliasByName( const TQString& name );

    /**Gets the list of type aliases that match @p name.
    If there are no matches, the TypeAliasList object is empty.
    @param name The name of a type alias.
    @return A TypeAliasList object that contains the matches.
    @note This is a const version provided for convenience.*/
    const TypeAliasList typeAliasByName( const TQString& name ) const;

    /**Adds a type alias to the model.
    @param typeAlias The type alias model to add to the model.
    @return true if the addition was successful.*/
    bool addTypeAlias( TypeAliasDom typeAlias );

    /**Removes a type alias from the model.
    @param typeAlias The TypeAliasDom object to remove from the model.*/
    void removeTypeAlias( TypeAliasDom typeAlias );

    /**@return The list of enums in the model.*/
    EnumList enumList();

    /**@return The list of enums in the model.
    @note This is a const version provided for convenience.*/
    const EnumList enumList() const;

    /**Checks if the enum specified by @p name is in the model.
    @param name The name of an enum.
    @return true if the enum was found.*/
    bool hasEnum( const TQString& name ) const;

    /**Gets the enum specified by @p name.
    The EnumDom object returned will be empty if no match is found.
    @param name The name of an enum.
    @return The EnumDom object that contains the match.*/
    EnumDom enumByName( const TQString& name );

    /**Gets the enum specified by @p name.
    The EnumDom object returned will be empty if no match is found.
    @param name The name of an enum.
    @return The EnumDom object that contains the match.*/
    const EnumDom enumByName( const TQString& name ) const;

    /**Adds an enum to the model.
    @param e The enum model to add to the model.
    @return true if the addition was successful.*/
    bool addEnum( EnumDom e );

    /**Removes an enum from the model.
    @param e The enum model to remove from the model.*/
    void removeEnum( EnumDom e );

    void update( const ClassModel* i );
    bool canUpdate( const ClassModel* i ) const;
    
    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
private:
    TQStringList m_scope;
    TQStringList m_baseClassList;
    TQMap<TQString, ClassList> m_classes;
    TQMap<TQString, FunctionList> m_functions;
    TQMap<TQString, FunctionDefinitionList> m_functionDefinitions;
    TQMap<TQString, VariableDom> m_variables;
    TQMap<TQString, TypeAliasList> m_typeAliases;
    TQMap<TQString, EnumDom> m_enumerators;

private:
    ClassModel( const ClassModel& source );
    void operator = ( const ClassModel& source );
    friend class CodeModel;
};

class NamespaceAliasModel {
public:
  virtual void read( TQDataStream& stream );
  virtual void write( TQDataStream& stream ) const;

  TQString name() const {
    return m_name;
  }

  void setName( const TQString& name ) {
    m_name = name;
  }

  void setAliasName( const TQString& theValue ) {
    m_aliasName = theValue;
  }

  TQString aliasName() const {
    return m_aliasName;
  }

  void setFileName( const HashedString& theValue ) {
    m_fileName = theValue;
  }

  HashedString fileName() const {
    return m_fileName;
  }

  bool operator < ( const NamespaceAliasModel& rhs ) const {
    if( m_name < rhs.m_name ) return true;
    if( m_name == rhs.m_name ) {
      if( m_aliasName < rhs.m_aliasName ) return true;
      if(  m_aliasName == rhs.m_aliasName && m_fileName < rhs.m_fileName ) return true;
    }
    return false;
  }

  bool operator == ( const NamespaceAliasModel& rhs ) const {
    return m_name == rhs.m_name && m_aliasName == rhs.m_aliasName && m_fileName == rhs.m_fileName;
  }
  
private:
  TQString m_name;
  TQString m_aliasName;
  HashedString m_fileName;
};

class NamespaceImportModel {
public:
  virtual void read( TQDataStream& stream );
  virtual void write( TQDataStream& stream ) const;
  
  TQString name() const {
    return m_name;
  }
  
  HashedString fileName() const {
    return m_fileName;
  }

  void setName( const TQString& name ) {
    m_name = name;
  }

  void setFileName( const HashedString& file ) {
    m_fileName = file;
  }
  
  bool operator < ( const NamespaceImportModel& rhs ) const {
    if( m_name < rhs.m_name ) return true;
    if( m_name == rhs.m_name )
      if( m_fileName < rhs.m_fileName ) return true;

    return false;
  }
  
  bool operator == ( const NamespaceImportModel& rhs ) const {
    return m_name == rhs.m_name && m_fileName == rhs.m_fileName;
  }
  
private:
  TQString m_name;
  HashedString m_fileName;
};

/**
Namespace model.
Represents a namespace in the code model.
Namespace model can represent either usual c++ namespaces
and packages or modules from other languages.

Instances of this class should be created using @ref CodeModel::create method.
*/
class NamespaceModel: public ClassModel
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    NamespaceModel( CodeModel* model );

public:
  typedef std::set<NamespaceAliasModel> NamespaceAliasModelList; ///I'm using std-sets here, because TQt-3 has no appropriate replacement
  typedef std::set<NamespaceImportModel> NamespaceImportModelList;
  
    /**A definition of safe pointer to the namespace model.*/
    typedef NamespaceDom Ptr;

    virtual bool isClass() const { return false; }
    virtual bool isNamespace() const { return true; }

    /**@return The list of namespaces in this model.*/
    NamespaceList namespaceList();

    /**@return The list of namespaces in this model.
    @note This is a const version provided for convenience.*/
    const NamespaceList namespaceList() const;

    /**Checks if the namespace referenced by @p name is in the model.
    @param name The name of a namespace.
    @return true if the namespace was found.*/
    bool hasNamespace( const TQString& name ) const;

    /**Gets the namespace specified by @p name.
    If there are no matches, then the NamespaceDom object returned is empty.
    @param name The name of a namespace.
    @return The NamespaceDom object that contains the match.*/
    NamespaceDom namespaceByName( const TQString& name );

    /**Gets the namespace specified by @p name.
    If there are no matches, then the NamespaceDom object returned is empty.
    @param name The name of a namespace.
    @return The NamespaceDom object that contains the match.
    @note This is a const version provided for convenience.*/
    const NamespaceDom namespaceByName( const TQString& name ) const;

    /**Adds a namespace to the model.
    @param ns The namespace model to add to the model.
    @return true if addition was successful.*/
    bool addNamespace( NamespaceDom ns );

    /**Removes the namespace from the model.
    @param ns The namespace model to remove from the model.*/
    void removeNamespace( NamespaceDom ns );

    /**Updates this model so it has the same content as the other one. Only the line/column is updated. canUpdate(..) must be tested before.
     * @param ns the namespace to match
    */
    void update( const NamespaceModel* ns );
    bool canUpdate( const NamespaceModel* ns ) const;
    
    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );

    void addNamespaceImport( const NamespaceImportModel& import );
    void addNamespaceAlias( const NamespaceAliasModel& alias );
    void removeNamespaceImport( const NamespaceImportModel& import );
    void removeNamespaceAlias( const NamespaceAliasModel& alias );

    ///Must not be called on temporary objects because a reference is returned(for performance-reasons)
    const NamespaceAliasModelList& namespaceAliases() const {
      return m_namespaceAliases;
    }
  
    ///Must not be called on temporary objects because a reference is returned(for performance-reasons)
    const NamespaceImportModelList& namespaceImports() const {
      return m_namespaceImports;
    }
private:
    TQMap<TQString, NamespaceDom> m_namespaces;
    NamespaceAliasModelList m_namespaceAliases;
    NamespaceImportModelList m_namespaceImports;

private:
  
    NamespaceModel( const NamespaceModel& source );
    void operator = ( const NamespaceModel& source );
    friend class CodeModel;
};




/**
File model.
Represents a file in the code model.
Files in general contain classes, namespaces, functions,
types, etc. Therefore FileModel is derived from NamespaceModel.

Instances of this class should be created using @ref CodeModel::create method.
*/
class FileModel: public NamespaceModel
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    FileModel( CodeModel* model );

public:
    /**A definition of safe pointer to the file model.*/
    typedef FileDom Ptr;

    virtual bool isFile() const { return true; }

    virtual int groupId() const {
        return m_groupId;
    }
    
    virtual void setGroupId(int newId) {
        m_groupId = newId;
    }
    
    /** This function additionally does version-checking and
        should be used instead of read when read should be called
        from outside.
    @return whether the read was successful */
    
    virtual void write( TQDataStream& stream ) const;

    FileList wholeGroup() ;
    
    TQStringList wholeGroupStrings() const;
    
    virtual void read( TQDataStream& stream );

    ParseResultPointer parseResult() const;
    void setParseResult( const ParseResultPointer& result );

  void update( const FileModel* i );
private:
    int m_groupId;
    ParseResultPointer m_parseResult;
    FileModel( const FileModel& );
    void operator = ( const FileModel& );
    friend class CodeModel;
};


/**
Function (procedure) argument model.
Represents an argument in the function.

Instances of this class should be created using @ref CodeModel::create method.
*/
class ArgumentModel: public CodeModelItem
{
protected:
    ArgumentModel( CodeModel* model );

public:
    /**A definition of safe pointer to the argument model.*/
    typedef ArgumentDom Ptr;

    virtual bool isArgument() const { return true; }

    /**@return The type of this argument.*/
    TQString type() const;

    /**Sets the type of this argument.
    @param type The type to set.*/
    void setType( const TQString& type );

    /**@return The default value of this argument.*/
    TQString defaultValue() const;

    /**Sets the default value of this argument.
    @param defaultValue The default value to set.*/
    void setDefaultValue( const TQString& defaultValue );

    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
private:
    TQString m_type;
    TQString m_defaultValue;

private:
    ArgumentModel( const ArgumentModel& source );
    void operator = ( const ArgumentModel& source );
    friend class CodeModel;
};


/**
Function model.
Represents:
- functions;
- procedures;
- class methods;
.
In languages that have separate function declarations and definitions (c++)
this represents only function declarations. @see FunctionDefinitionModel 
for a model of function definitions.

Instances of this class should be created using @ref CodeModel::create method.
*/
class FunctionModel: public CodeModelItem, public TemplateModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    FunctionModel( CodeModel* model );

public:
    /**A definition of safe pointer to the function model.*/
    typedef FunctionDom Ptr;

    virtual bool isFunction() const { return true; }

    /**@return The scope of the function. Scope is a string list composed 
    from names of parent functions, classes and namespaces.*/
    TQStringList scope() const { return m_scope; }

    /**Sets the scope of the function.
    @param scope The scope to set.*/
    void setScope( const TQStringList& scope ) { m_scope = scope; }

    /**@return The access level of the function. Can return either values of type @ref CodeModelItem::Access or 
    other integers if the function has other access level (for example pascal methods can have "published"
    access level).*/
    int access() const;

    /**Sets the access level of the function.
    @param access The access level.*/
    void setAccess( int access );

    /**@return true if the function is a signal.*/
    bool isSignal() const;
    /**Sets the function to be a signal.
    @param isSignal The signal flag.*/
    void setSignal( bool isSignal );

    /**@return true if the function is a slot.*/
    bool isSlot() const;
    /**Sets the function to be a slot.
    @param isSlot The slot flag.*/
    void setSlot( bool isSlot );

    /**@return true if the function is a virtual function.*/
    bool isVirtual() const;
    /**Sets the function to be a virtual function.
    @param isVirtual The virtual flag.*/
    void setVirtual( bool isVirtual );

    /**@return true if the function is a static function.*/
    bool isStatic() const;
    /**Sets the function to be a static function.
    @param isStatic The static flag.*/
    void setStatic( bool isStatic );

    /**@return true if the function is an inline function.*/
    bool isInline() const;
    /**Sets the function to be an inline function.
    @param isInline The inline flag.*/
    void setInline( bool isInline );

    /**@return true if the function is a constant function.*/
    bool isConstant() const;
    /**Sets the function to be a constant function.
    @param isConstant The constant flag.*/
    void setConstant( bool isConstant );

    /**@return true if the function is an abstract function.*/
    bool isAbstract() const;
    /**Sets the function to be an inline function.
    @param isAbstract The abstract flag.*/
    void setAbstract( bool isAbstract );

    /**@return The result type of a function.*/
    TQString resultType() const;
    /**Sets the result type of a function.
    @param type The type of a function result.*/
    void setResultType( const TQString& type );

    /**Gets the list of arguments being passed to the function.
    If there are no arguments, then the list is empty.
    @return The ArgumentList object that contains the arguments for this function.*/
    ArgumentList argumentList();

    /**Gets the list of arguments being passed to the function.
    If there are no arguments, then the list is empty.
    @return The ArgumentList object that contains the arguments for this function.
    @note This is a const version provided for convenience.*/
    const ArgumentList argumentList() const;

    /**Adds an argument to the function.
    @param arg The argument model to add as an argument to the function.
    @return true if the addition was successful.*/
    bool addArgument( ArgumentDom arg );

    /**Removes an argument from the function.
    @param arg The argument model to remove from the function.*/
    void removeArgument( ArgumentDom arg );

    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
    void update( const FunctionModel* i );
    bool canUpdate( const FunctionModel* i ) const;
    
private:
    TQStringList m_scope;
    int m_access;

    union {
        struct {
            int m_signal : 1;
            int m_slot : 1;
            int m_virtual : 1;
            int m_static : 1;
            int m_inline : 1;
            int m_constant : 1;
            int m_abstract : 1;
        } v;
        int flags;
    } d;

    TQString m_resultType;
    ArgumentList m_arguments;

private:
    FunctionModel( const FunctionModel& source );
    void operator = ( const FunctionModel& source );
    friend class CodeModel;
};

/**
Function model.
Represents function definition for languages that have such.

Instances of this class should be created using @ref CodeModel::create method.
*/
class FunctionDefinitionModel: public FunctionModel
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    FunctionDefinitionModel( CodeModel* model );

public:
    /**A definition of safe pointer to the function definition model.*/
    typedef FunctionDefinitionDom Ptr;

    virtual bool isFunctionDefinition() const { return true; }

private:
    FunctionDefinitionModel( const FunctionDefinitionModel& source );
    void operator = ( const FunctionDefinitionModel& source );
    friend class CodeModel;
};


/**
Variable model.
Represents variables and class attributes.

Instances of this class should be created using @ref CodeModel::create method.
*/
class VariableModel: public CodeModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    VariableModel( CodeModel* model );

public:
    /**A definition of safe pointer to the variable model.*/
    typedef VariableDom Ptr;

    virtual bool isVariable() const { return true; }

    /**@return The access level of the variable. Can return either values of type @ref CodeModelItem::Access or 
    other integers if the variable has other access level (for example pascal attributes can have "published"
    access level).*/
    int access() const;
    /**Sets the access level of the variable.
    @param access The access level.*/
    void setAccess( int access );

    /**@return true if the variable is a static variable.*/
    bool isStatic() const;
    /**Sets the variable to be a static variable.
    @param isStatic The static flag.*/
    void setStatic( bool isStatic );

    /**@return A type of the variable.*/
    TQString type() const;
    /**Sets the type of the variable.
    @param type The type name.*/
    void setType( const TQString& type );

		/**@return If this is an enumerator, the enum it is part of, else an empty string. This is just a hack, necessary because EnumeratorModel is not used at all by the cpp-code-model. */
		bool isEnumeratorVariable() const;

		void setEnumeratorVariable( bool b );

    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );

    void update( const VariableModel* i );
    bool canUpdate( const VariableModel* i ) const;
    
private:
    int m_access;
    int m_static;
    TQString m_type;
		int m_isEnumeratorVariable;

private:
    VariableModel( const VariableModel& source );
    void operator = ( const VariableModel& source );
    friend class CodeModel;
};


/**
Enum model.
Represents enums.

Instances of this class should be created using @ref CodeModel::create method.
*/
class EnumModel: public CodeModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    EnumModel( CodeModel* model );

public:
    /**A definition of safe pointer to the enum model.*/
    typedef EnumDom Ptr;

    virtual bool isEnum() const { return true; }

    /**@return The access level of the enum. Can return either values 
    of type @ref CodeModelItem::Access or other integers if the enum has other access level.*/
    int access() const;
    /**Sets the access level of the enum.
    @param access The access level.*/
    void setAccess( int access );
    
    /**@return The list of enumerators in this enum.*/
    EnumeratorList enumeratorList();
    /**@return The list of enumerators in this enum.
    @note This is a const version provided for convenience.*/
    const EnumeratorList enumeratorList() const;
    /**Adds an enumerator to the model.
    @param e The enumerator model to add.*/
    void addEnumerator( EnumeratorDom e );
    /**Removes an enumerator from the model.
    @param e The enumerator model to remove.*/
    void removeEnumerator( EnumeratorDom e );

    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    ///The dump-function is not ready yet
    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );

    void update( const EnumModel* i );
    bool canUpdate( const EnumModel* i ) const;
    
private:
    int m_access;
    TQMap<TQString, EnumeratorDom> m_enumerators;

private:
    EnumModel( const EnumModel& source );
    void operator = ( const EnumModel& source );
    friend class CodeModel;
};


/**
Enumerator model.
Represents enumerators. Enums consist of enumerators, for example in code:
@code
enum Type { A, B, C};
@endcode
Type is represented as EnumModel;\n
A, B, C are represented with EnumeratorModel.

Instances of this class should be created using @ref CodeModel::create method.
*/
class EnumeratorModel: public CodeModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    EnumeratorModel( CodeModel* model );

public:
    /**A definition of safe pointer to the enumerator model.*/
    typedef EnumeratorDom Ptr;

    virtual bool isEnumerator() const { return true; }
    
    /**@return The value of an enumerator.*/
    TQString value() const;
    /**Sets the value of an enumerator.
    @param value The value.*/
    void setValue( const TQString& value );

    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
private:
    TQString m_value;
    
private:
    EnumeratorModel( const EnumeratorModel& source );
    void operator = ( const EnumeratorModel& source );
    friend class CodeModel;
};


/**
Type alias model.
Represents type aliases (like subtypes/derived types in Ada and typedefs in c++).
*/
class TypeAliasModel: public CodeModelItem
{
protected:
    /**Constructor.
    @param model Code model which stores this item.*/
    TypeAliasModel( CodeModel* model );

public:
    /**A definition of safe pointer to the type alias model.*/
    typedef TypeAliasDom Ptr;

    virtual bool isTypeAlias() const { return true; }
    
    /**@return The actual type of an alias.*/
    TQString type() const;
    /**Sets the type of an alias.
    @param type The type name.*/
    void setType( const TQString& type );
    
    virtual void read( TQDataStream& stream );
    virtual void write( TQDataStream& stream ) const;

    
    virtual void dump( std::ostream& file, bool recurse=false, TQString Info="" );
    
    void update( const TypeAliasModel* i );
    bool canUpdate( const TypeAliasModel* i ) const;

private:
    TQString m_type;
    
private:
    TypeAliasModel( const TypeAliasModel& source );
    void operator = ( const TypeAliasModel& source );
    friend class CodeModel;
};

#endif