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
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
|
/******************************************************************************
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#include <stdlib.h>
#include <stdio.h>
#include "settings.h"
#include "message.h"
#if USE_SQLITE3
#include "qtbc.h"
#include "sqlite3gen.h"
#include "doxygen.h"
#include "xmlgen.h"
#include "xmldocvisitor.h"
#include "config.h"
#include "util.h"
#include "outputlist.h"
#include "docparser.h"
#include "language.h"
#include "version.h"
#include "dot.h"
#include "arguments.h"
#include "classlist.h"
#include "filedef.h"
#include "namespacedef.h"
#include "filename.h"
#include "groupdef.h"
#include "membername.h"
#include "memberdef.h"
#include "pagedef.h"
#include "dirdef.h"
#include "section.h"
#include <sys/stat.h>
#include <qdir.h>
#include <string.h>
#include <sqlite3.h>
// enable to show general debug messages
// #define SQLITE3_DEBUG
// enable to print all executed SQL statements.
// I recommend using the smallest possible input list.
// #define SQLITE3_DEBUG_SQL
# ifdef SQLITE3_DEBUG
# define DBG_CTX(x) printf x
# else // SQLITE3_DEBUG
# define DBG_CTX(x) do { } while(0)
# endif
# ifdef SQLITE3_DEBUG_SQL
// used by sqlite3_trace in generateSqlite3()
static void sqlLog(void *dbName, const char *sql){
msg("SQL: '%s'\n", sql);
}
# endif
const char * table_schema[][2] = {
/* TABLES */
{ "meta",
"CREATE TABLE IF NOT EXISTS meta (\n"
"\t-- Information about this db and how it was generated.\n"
"\t-- Doxygen info\n"
"\tdoxygen_version TEXT PRIMARY KEY NOT NULL,\n"
/*
Doxygen's version is likely to rollover much faster than the schema, and
at least until it becomes a core output format, we might want to make
fairly large schema changes even on minor iterations for Doxygen itself.
If these tools just track a predefined semver schema version that can
iterate independently, it *might* not be as hard to keep them in sync?
*/
"\tschema_version TEXT NOT NULL, -- Schema-specific semver\n"
"\t-- run info\n"
"\tgenerated_at TEXT NOT NULL,\n"
"\tgenerated_on TEXT NOT NULL,\n"
"\t-- project info\n"
"\tproject_name TEXT NOT NULL,\n"
"\tproject_number TEXT,\n"
"\tproject_brief TEXT\n"
");"
},
{ "includes",
"CREATE TABLE IF NOT EXISTS includes (\n"
"\t-- #include relations.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tlocal INTEGER NOT NULL,\n"
"\tsrc_id INTEGER NOT NULL REFERENCES path, -- File id of the includer.\n"
"\tdst_id INTEGER NOT NULL REFERENCES path, -- File id of the includee.\n"
/*
In theory we could include name here to be informationally equivalent
with the XML, but I don't see an obvious use for it.
*/
"\tUNIQUE(local, src_id, dst_id) ON CONFLICT IGNORE\n"
");"
},
{ "contains",
"CREATE TABLE IF NOT EXISTS contains (\n"
"\t-- inner/outer relations (file, namespace, dir, class, group, page)\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tinner_rowid INTEGER NOT NULL REFERENCES compounddef,\n"
"\touter_rowid INTEGER NOT NULL REFERENCES compounddef\n"
");"
},
/* TODO: Path can also share rowids with refid/compounddef/def. (It could
* even collapse into that table...)
*
* I took a first swing at this by changing insertPath() to:
* - accept a FileDef
* - make its own call to insertRefid
* - return a refid struct.
*
* I rolled this back when I had trouble getting a FileDef for all types
* (PageDef in particular).
*
* Note: all colums referencing path would need an update.
*/
{ "path",
"CREATE TABLE IF NOT EXISTS path (\n"
"\t-- Paths of source files and includes.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\ttype INTEGER NOT NULL, -- 1:file 2:dir\n"
"\tlocal INTEGER NOT NULL,\n"
"\tfound INTEGER NOT NULL,\n"
"\tname TEXT NOT NULL\n"
");"
},
{ "refid",
"CREATE TABLE IF NOT EXISTS refid (\n"
"\t-- Distinct refid for all documented entities.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\trefid TEXT NOT NULL UNIQUE\n"
");"
},
{ "xrefs",
"CREATE TABLE IF NOT EXISTS xrefs (\n"
"\t-- Cross-reference relation\n"
"\t-- (combines xml <referencedby> and <references> nodes).\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tsrc_rowid INTEGER NOT NULL REFERENCES refid, -- referrer id.\n"
"\tdst_rowid INTEGER NOT NULL REFERENCES refid, -- referee id.\n"
"\tcontext TEXT NOT NULL, -- inline, argument, initializer\n"
"\t-- Just need to know they link; ignore duplicates.\n"
"\tUNIQUE(src_rowid, dst_rowid, context) ON CONFLICT IGNORE\n"
");\n"
},
{ "memberdef",
"CREATE TABLE IF NOT EXISTS memberdef (\n"
"\t-- All processed identifiers.\n"
"\trowid INTEGER PRIMARY KEY NOT NULL,\n"
"\tname TEXT NOT NULL,\n"
"\tdefinition TEXT,\n"
"\ttype TEXT,\n"
"\targsstring TEXT,\n"
"\tscope TEXT,\n"
"\tinitializer TEXT,\n"
"\tbitfield TEXT,\n"
"\tread TEXT,\n"
"\twrite TEXT,\n"
"\tprot INTEGER DEFAULT 0, -- 0:public 1:protected 2:private 3:package\n"
"\tstatic INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tconst INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\texplicit INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tinline INTEGER DEFAULT 0, -- 0:no 1:yes 2:both (set after encountering inline and not-inline)\n"
"\tfinal INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tsealed INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tnew INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\toptional INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\trequired INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tvolatile INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tvirt INTEGER DEFAULT 0, -- 0:no 1:virtual 2:pure-virtual\n"
"\tmutable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tinitonly INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tattribute INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tproperty INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\treadonly INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tbound INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tconstrained INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\ttransient INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tmaybevoid INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tmaybedefault INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tmaybeambiguous INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\treadable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\twritable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tgettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tprivategettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tprotectedgettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tsettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tprivatesettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tprotectedsettable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\taccessor INTEGER DEFAULT 0, -- 0:no 1:assign 2:copy 3:retain 4:string 5:weak\n"
"\taddable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tremovable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\traisable INTEGER DEFAULT 0, -- 0:no 1:yes\n"
"\tkind TEXT NOT NULL, -- 'macro definition' 'function' 'variable' 'typedef' 'enumeration' 'enumvalue' 'signal' 'slot' 'friend' 'dcop' 'property' 'event' 'interface' 'service'\n"
"\tbodystart INTEGER DEFAULT 0, -- starting line of definition\n"
"\tbodyend INTEGER DEFAULT 0, -- ending line of definition\n"
"\tbodyfile_id INTEGER REFERENCES path, -- file of definition\n"
"\tfile_id INTEGER NOT NULL REFERENCES path, -- file where this identifier is located\n"
"\tline INTEGER NOT NULL, -- line where this identifier is located\n"
"\tcolumn INTEGER NOT NULL, -- column where this identifier is located\n"
"\tdetaileddescription TEXT,\n"
"\tbriefdescription TEXT,\n"
"\tinbodydescription TEXT,\n"
"\tFOREIGN KEY (rowid) REFERENCES refid (rowid)\n"
");"
},
{ "member",
"CREATE TABLE IF NOT EXISTS member (\n"
"\t-- Memberdef <-> containing compound relation.\n"
"\t-- Similar to XML listofallmembers.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tscope_rowid INTEGER NOT NULL REFERENCES compounddef,\n"
"\tmemberdef_rowid INTEGER NOT NULL REFERENCES memberdef,\n"
"\tprot INTEGER NOT NULL,\n"
"\tvirt INTEGER NOT NULL,\n"
"\tUNIQUE(scope_rowid, memberdef_rowid)\n"
");"
},
{ "reimplements",
"CREATE TABLE IF NOT EXISTS reimplements (\n"
"\t-- Inherited member reimplmentation relations.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tmemberdef_rowid INTEGER NOT NULL REFERENCES memberdef, -- reimplementing memberdef id.\n"
"\treimplemented_rowid INTEGER NOT NULL REFERENCES memberdef, -- reimplemented memberdef id.\n"
"\tUNIQUE(memberdef_rowid, reimplemented_rowid) ON CONFLICT IGNORE\n"
");\n"
},
{ "compounddef",
"CREATE TABLE IF NOT EXISTS compounddef (\n"
"\t-- Class/struct definitions.\n"
"\trowid INTEGER PRIMARY KEY NOT NULL,\n"
"\tname TEXT NOT NULL,\n"
"\ttitle TEXT,\n"
// probably won't be empty '' or unknown, but the source *could* return them...
"\tkind TEXT NOT NULL, -- 'category' 'class' 'constants' 'dir' 'enum' 'example' 'exception' 'file' 'group' 'interface' 'library' 'module' 'namespace' 'package' 'page' 'protocol' 'service' 'singleton' 'struct' 'type' 'union' 'unknown' ''\n"
"\tprot INTEGER,\n"
"\tfile_id INTEGER NOT NULL REFERENCES path,\n"
"\tline INTEGER NOT NULL,\n"
"\tcolumn INTEGER NOT NULL,\n"
"\theader_id INTEGER REFERENCES path,\n"
"\tdetaileddescription TEXT,\n"
"\tbriefdescription TEXT,\n"
"\tFOREIGN KEY (rowid) REFERENCES refid (rowid)\n"
");"
},
{ "compoundref",
"CREATE TABLE IF NOT EXISTS compoundref (\n"
"\t-- Inheritance relation.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tbase_rowid INTEGER NOT NULL REFERENCES compounddef,\n"
"\tderived_rowid INTEGER NOT NULL REFERENCES compounddef,\n"
"\tprot INTEGER NOT NULL,\n"
"\tvirt INTEGER NOT NULL,\n"
"\tUNIQUE(base_rowid, derived_rowid)\n"
");"
},
{ "param",
"CREATE TABLE IF NOT EXISTS param (\n"
"\t-- All processed parameters.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tattributes TEXT,\n"
"\ttype TEXT,\n"
"\tdeclname TEXT,\n"
"\tdefname TEXT,\n"
"\tarray TEXT,\n"
"\tdefval TEXT,\n"
"\tbriefdescription TEXT\n"
");"
"CREATE UNIQUE INDEX idx_param ON param\n"
"\t(type, defname);"
},
{ "memberdef_param",
"CREATE TABLE IF NOT EXISTS memberdef_param (\n"
"\t-- Junction table for memberdef parameters.\n"
"\trowid INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n"
"\tmemberdef_id INTEGER NOT NULL REFERENCES memberdef,\n"
"\tparam_id INTEGER NOT NULL REFERENCES param\n"
");"
},
};
const char * view_schema[][2] = {
/* VIEWS *
We'll set these up AFTER we build the database, so that they can be indexed,
but so we don't have to pay a performance penalty for inserts as we build.
*/
{
/*
Makes all reference/relation tables easier to use. For example:
1. query xrefs and join this view on either xrefs.dst_rowid=def.rowid or
xrefs.src_rowid=def.rowid
2. get everything you need to output a list of references to/from an entity
Also supports simple name search/lookup for both compound and member types.
NOTES:
- summary for compounds generalizes title and briefdescription because
there's no single field that works as a quick introduction for both
pages and classes
- May be value in eventually extending this to fulltext or levenshtein
distance-driven lookup/search, but I'm avoiding these for now as it
takes some effort to enable them.
*/
"def",
"CREATE VIEW IF NOT EXISTS def (\n"
"\t-- Combined summary of all -def types for easier joins.\n"
"\trowid,\n"
"\trefid,\n"
"\tkind,\n"
"\tname,\n"
"\tsummary"
")\n"
"as SELECT \n"
"\trefid.rowid,\n"
"\trefid.refid,\n"
"\tmemberdef.kind,\n"
"\tmemberdef.name,\n"
"\tmemberdef.briefdescription \n"
"FROM refid \n"
"JOIN memberdef ON refid.rowid=memberdef.rowid \n"
"UNION ALL \n"
"SELECT \n"
"\trefid.rowid,\n"
"\trefid.refid,\n"
"\tcompounddef.kind,\n"
"\tcompounddef.name,\n"
"\tCASE \n"
"\t\tWHEN briefdescription IS NOT NULL \n"
"\t\tTHEN briefdescription \n"
"\t\tELSE title \n"
"\tEND summary\n"
"FROM refid \n"
"JOIN compounddef ON refid.rowid=compounddef.rowid;"
},
{
"local_file",
"CREATE VIEW IF NOT EXISTS local_file (\n"
"\t-- File paths found within the project.\n"
"\trowid,\n"
"\tfound,\n"
"\tname\n"
")\n"
"as SELECT \n"
"\tpath.rowid,\n"
"\tpath.found,\n"
"\tpath.name\n"
"FROM path WHERE path.type=1 AND path.local=1 AND path.found=1;\n"
},
{
"external_file",
"CREATE VIEW IF NOT EXISTS external_file (\n"
"\t-- File paths outside the project (found or not).\n"
"\trowid,\n"
"\tfound,\n"
"\tname\n"
")\n"
"as SELECT \n"
"\tpath.rowid,\n"
"\tpath.name\n"
"FROM path WHERE path.type=1 AND path.local=0;\n"
},
{
"inline_xrefs",
"CREATE VIEW IF NOT EXISTS inline_xrefs (\n"
"\t-- Crossrefs from inline member source.\n"
"\trowid,\n"
"\tsrc_rowid,\n"
"\tdst_rowid\n"
")\n"
"as SELECT \n"
"\txrefs.rowid,\n"
"\txrefs.src_rowid,\n"
"\txrefs.dst_rowid\n"
"FROM xrefs WHERE xrefs.context='inline';\n"
},
{
"argument_xrefs",
"CREATE VIEW IF NOT EXISTS argument_xrefs (\n"
"\t-- Crossrefs from member def/decl arguments\n"
"\trowid,\n"
"\tsrc_rowid,\n"
"\tdst_rowid\n"
")\n"
"as SELECT \n"
"\txrefs.rowid,\n"
"\txrefs.src_rowid,\n"
"\txrefs.dst_rowid\n"
"FROM xrefs WHERE xrefs.context='argument';\n"
},
{
"initializer_xrefs",
"CREATE VIEW IF NOT EXISTS initializer_xrefs (\n"
"\t-- Crossrefs from member initializers\n"
"\trowid,\n"
"\tsrc_rowid,\n"
"\tdst_rowid\n"
")\n"
"as SELECT \n"
"\txrefs.rowid,\n"
"\txrefs.src_rowid,\n"
"\txrefs.dst_rowid\n"
"FROM xrefs WHERE xrefs.context='initializer';\n"
},
{
"inner_outer",
"CREATE VIEW IF NOT EXISTS inner_outer\n"
"\t-- Joins 'contains' relations to simplify inner/outer 'rel' queries.\n"
"as SELECT \n"
"\tinner.*,\n"
"\touter.*\n"
"FROM def as inner\n"
"\tJOIN contains ON inner.rowid=contains.inner_rowid\n"
"\tJOIN def AS outer ON outer.rowid=contains.outer_rowid;\n"
},
{
"rel",
"CREATE VIEW IF NOT EXISTS rel (\n"
"\t-- Boolean indicator of relations available for a given entity.\n"
"\t-- Join to (compound-|member-)def to find fetch-worthy relations.\n"
"\trowid,\n"
"\treimplemented,\n"
"\treimplements,\n"
"\tinnercompounds,\n"
"\toutercompounds,\n"
"\tinnerpages,\n"
"\touterpages,\n"
"\tinnerdirs,\n"
"\touterdirs,\n"
"\tinnerfiles,\n"
"\touterfiles,\n"
"\tinnerclasses,\n"
"\touterclasses,\n"
"\tinnernamespaces,\n"
"\touternamespaces,\n"
"\tinnergroups,\n"
"\toutergroups,\n"
"\tmembers,\n"
"\tcompounds,\n"
"\tsubclasses,\n"
"\tsuperclasses,\n"
"\tlinks_in,\n"
"\tlinks_out,\n"
"\targument_links_in,\n"
"\targument_links_out,\n"
"\tinitializer_links_in,\n"
"\tinitializer_links_out\n"
")\n"
"as SELECT \n"
"\tdef.rowid,\n"
"\tEXISTS (SELECT rowid FROM reimplements WHERE reimplemented_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM reimplements WHERE memberdef_rowid=def.rowid),\n"
"\t-- rowid/kind for inner, [rowid:1/kind:1] for outer\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind='page'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1]='page'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind='dir'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1]='dir'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind='file'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1]='file'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind in (\n"
"'category','class','enum','exception','interface','module','protocol',\n"
"'service','singleton','struct','type','union'\n"
")),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1] in (\n"
"'category','class','enum','exception','interface','module','protocol',\n"
"'service','singleton','struct','type','union'\n"
")),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind='namespace'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1]='namespace'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE [rowid:1]=def.rowid AND kind='group'),\n"
"\tEXISTS (SELECT * FROM inner_outer WHERE rowid=def.rowid AND [kind:1]='group'),\n"
"\tEXISTS (SELECT rowid FROM member WHERE scope_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM member WHERE memberdef_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM compoundref WHERE base_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM compoundref WHERE derived_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM inline_xrefs WHERE dst_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM inline_xrefs WHERE src_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM argument_xrefs WHERE dst_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM argument_xrefs WHERE src_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM initializer_xrefs WHERE dst_rowid=def.rowid),\n"
"\tEXISTS (SELECT rowid FROM initializer_xrefs WHERE src_rowid=def.rowid)\n"
"FROM def ORDER BY def.rowid;"
}
};
//////////////////////////////////////////////////////
struct SqlStmt {
const char *query;
sqlite3_stmt *stmt;
sqlite3 *db;
};
//////////////////////////////////////////////////////
/* If you add a new statement below, make sure to add it to
prepareStatements(). If sqlite3 is segfaulting (especially in
sqlite3_clear_bindings()), using an un-prepared statement may
be the cause. */
SqlStmt meta_insert = {
"INSERT INTO meta "
"( doxygen_version, schema_version, generated_at, generated_on, project_name, project_number, project_brief )"
"VALUES "
"(:doxygen_version,:schema_version,:generated_at,:generated_on,:project_name,:project_number,:project_brief )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt incl_insert = {
"INSERT INTO includes "
"( local, src_id, dst_id ) "
"VALUES "
"(:local,:src_id,:dst_id )"
,NULL
};
SqlStmt incl_select = {
"SELECT COUNT(*) FROM includes WHERE "
"local=:local AND src_id=:src_id AND dst_id=:dst_id"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt contains_insert={
"INSERT INTO contains "
"( inner_rowid, outer_rowid )"
"VALUES "
"(:inner_rowid,:outer_rowid )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt path_select = {
"SELECT rowid FROM path WHERE name=:name"
,NULL
};
SqlStmt path_insert = {
"INSERT INTO path "
"( type, local, found, name )"
"VALUES "
"(:type,:local,:found,:name )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt refid_select = {
"SELECT rowid FROM refid WHERE refid=:refid"
,NULL
};
SqlStmt refid_insert = {
"INSERT INTO refid "
"( refid )"
"VALUES "
"(:refid )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt xrefs_insert= {
"INSERT INTO xrefs "
"( src_rowid, dst_rowid, context )"
"VALUES "
"(:src_rowid,:dst_rowid,:context )"
,NULL
};//////////////////////////////////////////////////////
SqlStmt reimplements_insert= {
"INSERT INTO reimplements "
"( memberdef_rowid, reimplemented_rowid )"
"VALUES "
"(:memberdef_rowid,:reimplemented_rowid )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt memberdef_exists={
"SELECT EXISTS (SELECT * FROM memberdef WHERE rowid = :rowid)"
,NULL
};
SqlStmt memberdef_incomplete={
"SELECT EXISTS ("
"SELECT * FROM memberdef WHERE "
"rowid = :rowid AND inline != 2 AND inline != :new_inline"
")"
,NULL
};
SqlStmt memberdef_insert={
"INSERT INTO memberdef "
"("
"rowid,"
"name,"
"definition,"
"type,"
"argsstring,"
"scope,"
"initializer,"
"bitfield,"
"read,"
"write,"
"prot,"
"static,"
"const,"
"explicit,"
"inline,"
"final,"
"sealed,"
"new,"
"optional,"
"required,"
"volatile,"
"virt,"
"mutable,"
"initonly,"
"attribute,"
"property,"
"readonly,"
"bound,"
"constrained,"
"transient,"
"maybevoid,"
"maybedefault,"
"maybeambiguous,"
"readable,"
"writable,"
"gettable,"
"protectedsettable,"
"protectedgettable,"
"settable,"
"privatesettable,"
"privategettable,"
"accessor,"
"addable,"
"removable,"
"raisable,"
"kind,"
"bodystart,"
"bodyend,"
"bodyfile_id,"
"file_id,"
"line,"
"column,"
"detaileddescription,"
"briefdescription,"
"inbodydescription"
")"
"VALUES "
"("
":rowid,"
":name,"
":definition,"
":type,"
":argsstring,"
":scope,"
":initializer,"
":bitfield,"
":read,"
":write,"
":prot,"
":static,"
":const,"
":explicit,"
":inline,"
":final,"
":sealed,"
":new,"
":optional,"
":required,"
":volatile,"
":virt,"
":mutable,"
":initonly,"
":attribute,"
":property,"
":readonly,"
":bound,"
":constrained,"
":transient,"
":maybevoid,"
":maybedefault,"
":maybeambiguous,"
":readable,"
":writable,"
":gettable,"
":protectedsettable,"
":protectedgettable,"
":settable,"
":privatesettable,"
":privategettable,"
":accessor,"
":addable,"
":removable,"
":raisable,"
":kind,"
":bodystart,"
":bodyend,"
":bodyfile_id,"
":file_id,"
":line,"
":column,"
":detaileddescription,"
":briefdescription,"
":inbodydescription"
")"
,NULL
};
/*
We have a slightly different need than the XML here. The XML can have two
memberdef nodes with the same refid to document the declaration and the
definition. This doesn't play very nice with a referential model. It isn't a
big issue if only one is documented, but in case both are, we'll fall back on
this kludge to combine them in a single row...
*/
SqlStmt memberdef_update_decl={
"UPDATE memberdef SET "
"inline = :inline,"
"file_id = :file_id,"
"line = :line,"
"column = :column,"
"detaileddescription = 'Declaration: ' || :detaileddescription || 'Definition: ' || detaileddescription,"
"briefdescription = 'Declaration: ' || :briefdescription || 'Definition: ' || briefdescription,"
"inbodydescription = 'Declaration: ' || :inbodydescription || 'Definition: ' || inbodydescription "
"WHERE rowid = :rowid"
,NULL
};
SqlStmt memberdef_update_def={
"UPDATE memberdef SET "
"inline = :inline,"
"bodystart = :bodystart,"
"bodyend = :bodyend,"
"bodyfile_id = :bodyfile_id,"
"detaileddescription = 'Declaration: ' || detaileddescription || 'Definition: ' || :detaileddescription,"
"briefdescription = 'Declaration: ' || briefdescription || 'Definition: ' || :briefdescription,"
"inbodydescription = 'Declaration: ' || inbodydescription || 'Definition: ' || :inbodydescription "
"WHERE rowid = :rowid"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt member_insert={
"INSERT INTO member "
"( scope_rowid, memberdef_rowid, prot, virt ) "
"VALUES "
"(:scope_rowid,:memberdef_rowid,:prot,:virt )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt compounddef_insert={
"INSERT INTO compounddef "
"("
"rowid,"
"name,"
"title,"
"kind,"
"prot,"
"file_id,"
"line,"
"column,"
"header_id,"
"briefdescription,"
"detaileddescription"
")"
"VALUES "
"("
":rowid,"
":name,"
":title,"
":kind,"
":prot,"
":file_id,"
":line,"
":column,"
":header_id,"
":briefdescription,"
":detaileddescription"
")"
,NULL
};
SqlStmt compounddef_exists={
"SELECT EXISTS ("
"SELECT * FROM compounddef WHERE rowid = :rowid"
")"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt compoundref_insert={
"INSERT INTO compoundref "
"( base_rowid, derived_rowid, prot, virt ) "
"VALUES "
"(:base_rowid,:derived_rowid,:prot,:virt )"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt param_select = {
"SELECT rowid FROM param WHERE "
"(attributes IS NULL OR attributes=:attributes) AND "
"(type IS NULL OR type=:type) AND "
"(declname IS NULL OR declname=:declname) AND "
"(defname IS NULL OR defname=:defname) AND "
"(array IS NULL OR array=:array) AND "
"(defval IS NULL OR defval=:defval) AND "
"(briefdescription IS NULL OR briefdescription=:briefdescription)"
,NULL
};
SqlStmt param_insert = {
"INSERT INTO param "
"( attributes, type, declname, defname, array, defval, briefdescription ) "
"VALUES "
"(:attributes,:type,:declname,:defname,:array,:defval,:briefdescription)"
,NULL
};
//////////////////////////////////////////////////////
SqlStmt memberdef_param_insert={
"INSERT INTO memberdef_param "
"( memberdef_id, param_id)"
"VALUES "
"(:memberdef_id,:param_id)"
,NULL
};
class TextGeneratorSqlite3Impl : public TextGeneratorIntf
{
public:
TextGeneratorSqlite3Impl(StringList &l) : l(l) {
l.setAutoDelete(TRUE);
}
void writeString(const char * /*s*/,bool /*keepSpaces*/) const
{
}
void writeBreak(int) const
{
DBG_CTX(("writeBreak\n"));
}
void writeLink(const char * /*extRef*/,const char *file,
const char *anchor,const char * /*text*/
) const
{
QCString *rs=new QCString(file);
if (anchor)
{
rs->append("_1").append(anchor);
}
l.append(rs);
}
private:
StringList &l;
// the list is filled by linkifyText and consumed by the caller
};
static bool bindTextParameter(SqlStmt &s,const char *name,const char *value, bool _static=TRUE)
{
int idx = sqlite3_bind_parameter_index(s.stmt, name);
if (idx==0) {
msg("sqlite3_bind_parameter_index(%s)[%s] failed: %s\n", name, s.query, sqlite3_errmsg(s.db));
return false;
}
int rv = sqlite3_bind_text(s.stmt, idx, value, -1, _static==TRUE?SQLITE_STATIC:SQLITE_TRANSIENT);
if (rv!=SQLITE_OK) {
msg("sqlite3_bind_text(%s)[%s] failed: %s\n", name, s.query, sqlite3_errmsg(s.db));
return false;
}
return true;
}
static bool bindIntParameter(SqlStmt &s,const char *name,int value)
{
int idx = sqlite3_bind_parameter_index(s.stmt, name);
if (idx==0) {
msg("sqlite3_bind_parameter_index(%s)[%s] failed to find column: %s\n", name, s.query, sqlite3_errmsg(s.db));
return false;
}
int rv = sqlite3_bind_int(s.stmt, idx, value);
if (rv!=SQLITE_OK) {
msg("sqlite3_bind_int(%s)[%s] failed: %s\n", name, s.query, sqlite3_errmsg(s.db));
return false;
}
return true;
}
static int step(SqlStmt &s,bool getRowId=FALSE, bool select=FALSE)
{
int rowid=-1;
int rc = sqlite3_step(s.stmt);
if (rc!=SQLITE_DONE && rc!=SQLITE_ROW)
{
DBG_CTX(("sqlite3_step: %s (rc: %d)\n", sqlite3_errmsg(s.db), rc));
sqlite3_reset(s.stmt);
sqlite3_clear_bindings(s.stmt);
return -1;
}
if (getRowId && select) rowid = sqlite3_column_int(s.stmt, 0); // works on selects, doesn't on inserts
if (getRowId && !select) rowid = sqlite3_last_insert_rowid(s.db); //works on inserts, doesn't on selects
sqlite3_reset(s.stmt);
sqlite3_clear_bindings(s.stmt); // XXX When should this really be called
return rowid;
}
static int insertPath(QCString name, bool local=TRUE, bool found=TRUE, int type=1)
{
int rowid=-1;
if (name==0) return rowid;
name = stripFromPath(name);
bindTextParameter(path_select,":name",name.data(),FALSE);
rowid=step(path_select,TRUE,TRUE);
if (rowid==0)
{
bindTextParameter(path_insert,":name",name.data(),FALSE);
bindIntParameter(path_insert,":type",type);
bindIntParameter(path_insert,":local",local?1:0);
bindIntParameter(path_insert,":found",found?1:0);
rowid=step(path_insert,TRUE);
}
return rowid;
}
static void recordMetadata()
{
bindTextParameter(meta_insert,":doxygen_version",versionString);
bindTextParameter(meta_insert,":schema_version","0.2.0"); //TODO: this should be a constant somewhere; not sure where
bindTextParameter(meta_insert,":generated_at",dateToString(TRUE), FALSE);
bindTextParameter(meta_insert,":generated_on",dateToString(FALSE), FALSE);
bindTextParameter(meta_insert,":project_name",Config_getString(PROJECT_NAME));
bindTextParameter(meta_insert,":project_number",Config_getString(PROJECT_NUMBER));
bindTextParameter(meta_insert,":project_brief",Config_getString(PROJECT_BRIEF));
step(meta_insert);
}
struct Refid {
int rowid;
const char *refid;
bool created;
};
struct Refid insertRefid(const char *refid)
{
struct Refid ret;
ret.rowid=-1;
ret.refid=refid;
ret.created = FALSE;
if (refid==0) return ret;
bindTextParameter(refid_select,":refid",refid);
ret.rowid=step(refid_select,TRUE,TRUE);
if (ret.rowid==0)
{
bindTextParameter(refid_insert,":refid",refid);
ret.rowid=step(refid_insert,TRUE);
ret.created = TRUE;
}
return ret;
}
static bool memberdefExists(struct Refid refid)
{
bindIntParameter(memberdef_exists,":rowid",refid.rowid);
int test = step(memberdef_exists,TRUE,TRUE);
return test ? true : false;
}
static bool memberdefIncomplete(struct Refid refid, const MemberDef* md)
{
bindIntParameter(memberdef_incomplete,":rowid",refid.rowid);
bindIntParameter(memberdef_incomplete,":new_inline",md->isInline());
int test = step(memberdef_incomplete,TRUE,TRUE);
return test ? true : false;
}
static bool compounddefExists(struct Refid refid)
{
bindIntParameter(compounddef_exists,":rowid",refid.rowid);
int test = step(compounddef_exists,TRUE,TRUE);
return test ? true : false;
}
static bool insertMemberReference(struct Refid src_refid, struct Refid dst_refid, const char *context)
{
if (src_refid.rowid==-1||dst_refid.rowid==-1)
return false;
if (
!bindIntParameter(xrefs_insert,":src_rowid",src_refid.rowid) ||
!bindIntParameter(xrefs_insert,":dst_rowid",dst_refid.rowid)
)
{
return false;
}
else
{
bindTextParameter(xrefs_insert,":context",context);
}
step(xrefs_insert);
return true;
}
static void insertMemberReference(const MemberDef *src, const MemberDef *dst, const char *context)
{
QCString qdst_refid = dst->getOutputFileBase() + "_1" + dst->anchor();
QCString qsrc_refid = src->getOutputFileBase() + "_1" + src->anchor();
struct Refid src_refid = insertRefid(qsrc_refid);
struct Refid dst_refid = insertRefid(qdst_refid);
insertMemberReference(src_refid,dst_refid,context);
}
static void insertMemberFunctionParams(int memberdef_id, const MemberDef *md, const Definition *def)
{
ArgumentList *declAl = md->declArgumentList();
ArgumentList *defAl = md->argumentList();
if (declAl!=0 && declAl->count()>0)
{
ArgumentListIterator declAli(*declAl);
ArgumentListIterator defAli(*defAl);
Argument *a;
for (declAli.toFirst();(a=declAli.current());++declAli)
{
Argument *defArg = defAli.current();
if (!a->attrib.isEmpty())
{
bindTextParameter(param_select,":attributes",a->attrib);
bindTextParameter(param_insert,":attributes",a->attrib);
}
if (!a->type.isEmpty())
{
StringList l;
linkifyText(TextGeneratorSqlite3Impl(l),def,md->getBodyDef(),md,a->type);
StringListIterator li(l);
QCString *s;
while ((s=li.current()))
{
QCString qsrc_refid = md->getOutputFileBase() + "_1" + md->anchor();
struct Refid src_refid = insertRefid(qsrc_refid);
struct Refid dst_refid = insertRefid(s->data());
insertMemberReference(src_refid,dst_refid, "argument");
++li;
}
bindTextParameter(param_select,":type",a->type);
bindTextParameter(param_insert,":type",a->type);
}
if (!a->name.isEmpty())
{
bindTextParameter(param_select,":declname",a->name);
bindTextParameter(param_insert,":declname",a->name);
}
if (defArg && !defArg->name.isEmpty() && defArg->name!=a->name)
{
bindTextParameter(param_select,":defname",defArg->name);
bindTextParameter(param_insert,":defname",defArg->name);
}
if (!a->array.isEmpty())
{
bindTextParameter(param_select,":array",a->array);
bindTextParameter(param_insert,":array",a->array);
}
if (!a->defval.isEmpty())
{
StringList l;
linkifyText(TextGeneratorSqlite3Impl(l),def,md->getBodyDef(),md,a->defval);
bindTextParameter(param_select,":defval",a->defval);
bindTextParameter(param_insert,":defval",a->defval);
}
if (defArg) ++defAli;
int param_id=step(param_select,TRUE,TRUE);
if (param_id==0) {
param_id=step(param_insert,TRUE);
}
if (param_id==-1) {
DBG_CTX(("error INSERT params failed\n"));
continue;
}
bindIntParameter(memberdef_param_insert,":memberdef_id",memberdef_id);
bindIntParameter(memberdef_param_insert,":param_id",param_id);
step(memberdef_param_insert);
}
}
}
static void insertMemberDefineParams(int memberdef_id,const MemberDef *md, const Definition *def)
{
if (md->argumentList()->count()==0) // special case for "foo()" to
// disguish it from "foo".
{
DBG_CTX(("no params\n"));
}
else
{
ArgumentListIterator ali(*md->argumentList());
Argument *a;
for (ali.toFirst();(a=ali.current());++ali)
{
bindTextParameter(param_insert,":defname",a->type);
int param_id=step(param_insert,TRUE);
if (param_id==-1) {
continue;
}
bindIntParameter(memberdef_param_insert,":memberdef_id",memberdef_id);
bindIntParameter(memberdef_param_insert,":param_id",param_id);
step(memberdef_param_insert);
}
}
}
static void associateMember(const MemberDef *md, struct Refid member_refid, struct Refid scope_refid)
{
// TODO: skip EnumValue only to guard against recording refids and member records
// for enumvalues until we can support documenting them as entities.
if (md->memberType()==MemberType_EnumValue) return;
if (md->name().at(0)!='@') // skip anonymous members
{
bindIntParameter(member_insert, ":scope_rowid", scope_refid.rowid);
bindIntParameter(member_insert, ":memberdef_rowid", member_refid.rowid);
bindIntParameter(member_insert, ":prot", md->protection());
bindIntParameter(member_insert, ":virt", md->virtualness());
step(member_insert);
}
}
static void stripQualifiers(QCString &typeStr)
{
bool done=FALSE;
while (!done)
{
if (typeStr.stripPrefix("static "));
else if (typeStr.stripPrefix("virtual "));
else if (typeStr.stripPrefix("volatile "));
else if (typeStr=="virtual") typeStr="";
else done=TRUE;
}
}
static int prepareStatement(sqlite3 *db, SqlStmt &s)
{
int rc;
rc = sqlite3_prepare_v2(db,s.query,-1,&s.stmt,0);
if (rc!=SQLITE_OK)
{
msg("prepare failed for %s\n%s\n", s.query, sqlite3_errmsg(db));
s.db = NULL;
return -1;
}
s.db = db;
return rc;
}
static int prepareStatements(sqlite3 *db)
{
if (
-1==prepareStatement(db, meta_insert) ||
-1==prepareStatement(db, memberdef_exists) ||
-1==prepareStatement(db, memberdef_incomplete) ||
-1==prepareStatement(db, memberdef_insert) ||
-1==prepareStatement(db, memberdef_update_def) ||
-1==prepareStatement(db, memberdef_update_decl) ||
-1==prepareStatement(db, member_insert) ||
-1==prepareStatement(db, path_insert) ||
-1==prepareStatement(db, path_select) ||
-1==prepareStatement(db, refid_insert) ||
-1==prepareStatement(db, refid_select) ||
-1==prepareStatement(db, incl_insert)||
-1==prepareStatement(db, incl_select)||
-1==prepareStatement(db, param_insert) ||
-1==prepareStatement(db, param_select) ||
-1==prepareStatement(db, xrefs_insert) ||
-1==prepareStatement(db, reimplements_insert) ||
-1==prepareStatement(db, contains_insert) ||
-1==prepareStatement(db, compounddef_exists) ||
-1==prepareStatement(db, compounddef_insert) ||
-1==prepareStatement(db, compoundref_insert) ||
-1==prepareStatement(db, memberdef_param_insert)
)
{
return -1;
}
return 0;
}
static void beginTransaction(sqlite3 *db)
{
char * sErrMsg = 0;
sqlite3_exec(db, "BEGIN TRANSACTION", NULL, NULL, &sErrMsg);
}
static void endTransaction(sqlite3 *db)
{
char * sErrMsg = 0;
sqlite3_exec(db, "END TRANSACTION", NULL, NULL, &sErrMsg);
}
static void pragmaTuning(sqlite3 *db)
{
char * sErrMsg = 0;
sqlite3_exec(db, "PRAGMA synchronous = OFF", NULL, NULL, &sErrMsg);
sqlite3_exec(db, "PRAGMA journal_mode = MEMORY", NULL, NULL, &sErrMsg);
sqlite3_exec(db, "PRAGMA temp_store = MEMORY;", NULL, NULL, &sErrMsg);
}
static int initializeTables(sqlite3* db)
{
int rc;
sqlite3_stmt *stmt = 0;
msg("Initializing DB schema (tables)...\n");
for (unsigned int k = 0; k < sizeof(table_schema) / sizeof(table_schema[0]); k++)
{
const char *q = table_schema[k][1];
char *errmsg;
rc = sqlite3_exec(db, q, NULL, NULL, &errmsg);
if (rc != SQLITE_OK)
{
msg("failed to execute query: %s\n\t%s\n", q, errmsg);
return -1;
}
}
return 0;
}
static int initializeViews(sqlite3* db)
{
int rc;
sqlite3_stmt *stmt = 0;
msg("Initializing DB schema (views)...\n");
for (unsigned int k = 0; k < sizeof(view_schema) / sizeof(view_schema[0]); k++)
{
const char *q = view_schema[k][1];
char *errmsg;
rc = sqlite3_exec(db, q, NULL, NULL, &errmsg);
if (rc != SQLITE_OK)
{
msg("failed to execute query: %s\n\t%s\n", q, errmsg);
return -1;
}
}
return 0;
}
////////////////////////////////////////////
/* TODO:
I collapsed all innerX tables into 'contains', which raises the prospect that
all of these very similar writeInnerX funcs could be refactored into a one,
or a small set of common parts.
I think the hurdles are:
- picking a first argument that every call location can pass
- which yields a consistent iterator
- accommodates PageDef's slightly different rules for generating the
inner_refid (unless I'm missing a method that would uniformly return
the correct refid for all types).
*/
static void writeInnerClasses(const ClassSDict *cl, struct Refid outer_refid)
{
if (!cl) return;
ClassSDict::Iterator cli(*cl);
const ClassDef *cd;
for (cli.toFirst();(cd=cli.current());++cli)
{
if (!cd->isHidden() && cd->name().find('@')==-1) // skip anonymous scopes
{
struct Refid inner_refid = insertRefid(cd->getOutputFileBase());
bindIntParameter(contains_insert,":inner_rowid", inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid", outer_refid.rowid);
step(contains_insert);
}
}
}
static void writeInnerPages(const PageSDict *pl, struct Refid outer_refid)
{
if (!pl) return;
PageSDict::Iterator pli(*pl);
const PageDef *pd;
for (pli.toFirst();(pd=pli.current());++pli)
{
struct Refid inner_refid = insertRefid(
pd->getGroupDef() ? pd->getOutputFileBase()+"_"+pd->name() : pd->getOutputFileBase()
);
bindIntParameter(contains_insert,":inner_rowid", inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid", outer_refid.rowid);
step(contains_insert);
}
}
static void writeInnerGroups(const GroupList *gl, struct Refid outer_refid)
{
if (gl)
{
GroupListIterator gli(*gl);
const GroupDef *sgd;
for (gli.toFirst();(sgd=gli.current());++gli)
{
struct Refid inner_refid = insertRefid(sgd->getOutputFileBase());
bindIntParameter(contains_insert,":inner_rowid", inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid", outer_refid.rowid);
step(contains_insert);
}
}
}
static void writeInnerFiles(const FileList *fl, struct Refid outer_refid)
{
if (fl)
{
QListIterator<FileDef> fli(*fl);
const FileDef *fd;
for (fli.toFirst();(fd=fli.current());++fli)
{
struct Refid inner_refid = insertRefid(fd->getOutputFileBase());
bindIntParameter(contains_insert,":inner_rowid", inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid", outer_refid.rowid);
step(contains_insert);
}
}
}
static void writeInnerDirs(const DirList *dl, struct Refid outer_refid)
{
if (dl)
{
QListIterator<DirDef> subdirs(*dl);
const DirDef *subdir;
for (subdirs.toFirst();(subdir=subdirs.current());++subdirs)
{
struct Refid inner_refid = insertRefid(subdir->getOutputFileBase());
bindIntParameter(contains_insert,":inner_rowid", inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid", outer_refid.rowid);
step(contains_insert);
}
}
}
static void writeInnerNamespaces(const NamespaceSDict *nl, struct Refid outer_refid)
{
if (nl)
{
NamespaceSDict::Iterator nli(*nl);
const NamespaceDef *nd;
for (nli.toFirst();(nd=nli.current());++nli)
{
if (!nd->isHidden() && nd->name().find('@')==-1) // skip anonymous scopes
{
struct Refid inner_refid = insertRefid(nd->getOutputFileBase());
bindIntParameter(contains_insert,":inner_rowid",inner_refid.rowid);
bindIntParameter(contains_insert,":outer_rowid",outer_refid.rowid);
step(contains_insert);
}
}
}
}
static void writeTemplateArgumentList(const ArgumentList * al,
const Definition * scope,
const FileDef * fileScope)
{
if (al)
{
ArgumentListIterator ali(*al);
Argument *a;
for (ali.toFirst();(a=ali.current());++ali)
{
if (!a->type.isEmpty())
{
#warning linkifyText(TextGeneratorXMLImpl(t),scope,fileScope,0,a->type);
bindTextParameter(param_select,":type",a->type);
bindTextParameter(param_insert,":type",a->type);
}
if (!a->name.isEmpty())
{
bindTextParameter(param_select,":declname",a->name);
bindTextParameter(param_insert,":declname",a->name);
bindTextParameter(param_select,":defname",a->name);
bindTextParameter(param_insert,":defname",a->name);
}
if (!a->defval.isEmpty())
{
#warning linkifyText(TextGeneratorXMLImpl(t),scope,fileScope,0,a->defval);
bindTextParameter(param_select,":defval",a->defval);
bindTextParameter(param_insert,":defval",a->defval);
}
if (!step(param_select,TRUE,TRUE))
step(param_insert);
}
}
}
static void writeMemberTemplateLists(const MemberDef *md)
{
ArgumentList *templMd = md->templateArguments();
if (templMd) // function template prefix
{
writeTemplateArgumentList(templMd,md->getClassDef(),md->getFileDef());
}
}
static void writeTemplateList(const ClassDef *cd)
{
writeTemplateArgumentList(cd->templateArguments(),cd,0);
}
QCString getSQLDocBlock(const Definition *scope,
const Definition *def,
const QCString &doc,
const QCString &fileName,
int lineNr)
{
QGString s;
if (doc.isEmpty()) return s.data();
FTextStream t(&s);
DocNode *root = validatingParseDoc(
fileName,
lineNr,
const_cast<Definition*>(scope),
const_cast<MemberDef*>(reinterpret_cast<const MemberDef*>(def)),
doc,
FALSE,
FALSE
);
XMLCodeGenerator codeGen(t);
// create a parse tree visitor for XML
XmlDocVisitor *visitor = new XmlDocVisitor(t,codeGen);
root->accept(visitor);
delete visitor;
delete root;
QCString result = convertCharEntitiesToUTF8(s.data());
return result.data();
}
static void getSQLDesc(SqlStmt &s,const char *col,const char *value,const Definition *def)
{
bindTextParameter(
s,
col,
getSQLDocBlock(
def->getOuterScope(),
def,
value,
def->docFile(),
def->docLine()
),
FALSE
);
}
////////////////////////////////////////////
/* (updated Sep 01 2018)
DoxMemberKind and DoxCompoundKind (compound.xsd) gave me some
faulty assumptions about "kind" strings, so I compiled a reference
The XML schema claims:
DoxMemberKind: (14)
dcop define enum event friend function interface property prototype
service signal slot typedef variable
DoxCompoundKind: (17)
category class dir example exception file group interface module
namespace page protocol service singleton struct type union
Member kind comes from MemberDef::memberTypeName()
types.h defines 14 MemberType_*s
_DCOP _Define _Enumeration _EnumValue _Event _Friend _Function _Interface
_Property _Service _Signal _Slot _Typedef _Variable
- xml doesn't include enumvalue here
(but renders enumvalue as) a sub-node of memberdef/templateparamlist
- xml includes 'prototype' that is unlisted here
vestigial? commented out in docsets.cpp and perlmodgen.cpp
MemberDef::memberTypeName() can return 15 strings:
(sorted by MemberType to match above; quoted because whitespace...)
"dcop" "macro definition" "enumeration" "enumvalue" "event" "friend"
"function" "interface" "property" "service" "signal" "slot" "typedef"
"variable"
Above describes potential values for memberdef.kind
Compound kind is more complex. *Def::compoundTypeString()
ClassDef kind comes from ::compoundTypeString()
classdef.h defines 9 compound types
Category Class Exception Interface Protocol Service Singleton Struct Union
But ClassDef::compoundTypeString() "could" return 13 strings
- default "unknown" shouldn't actually return
- other 12 can vary by source language; see method for specifics
category class enum exception interface module protocol service
singleton struct type union
DirDef, FileDef, GroupDef have no method to return a string
tagfile/outputs hard-code kind to 'dir' 'file' or 'group'
NamespaceDef kind comes from ::compoundTypeString()
NamespaceDef::compoundTypeString() "could" return 6 strings
- default empty ("") string
- other 5 differ by source language
constants library module namespace package
PageDef also has no method to return a string
- some locations hard-code the kind to 'page'
- others conditionally output 'page' or 'example'
All together, that's 23 potential strings (21 excl "" and unknown)
"" category class constants dir enum example exception file group
interface library module namespace package page protocol service singleton
struct type union unknown
Above describes potential values for compounddef.kind
For reference, there are 35 potential values of def.kind (33 excl "" and unknown):
"" "category" "class" "constants" "dcop" "dir" "enum" "enumeration"
"enumvalue" "event" "example" "exception" "file" "friend" "function" "group"
"interface" "library" "macro definition" "module" "namespace" "package"
"page" "property" "protocol" "service" "signal" "singleton" "slot" "struct"
"type" "typedef" "union" "unknown" "variable"
This is relevant because the 'def' view generalizes memberdef and compounddef,
and two member+compound kind strings (interface and service) overlap.
I have no grasp of whether a real user docset would include one or more
member and compound using the interface or service kind.
*/
//////////////////////////////////////////////////////////////////////////////
static void generateSqlite3ForMember(const MemberDef *md, struct Refid scope_refid, const Definition *def)
{
// + declaration/definition arg lists
// + reimplements
// + reimplementedBy
// - exceptions
// + const/volatile specifiers
// - examples
// + source definition
// + source references
// + source referenced by
// - body code
// + template arguments
// (templateArguments(), definitionTemplateParameterLists())
// - call graph
// enum values are written as part of the enum
if (md->memberType()==MemberType_EnumValue) return;
if (md->isHidden()) return;
QCString memType;
// memberdef
QCString qrefid = md->getOutputFileBase() + "_1" + md->anchor();
struct Refid refid = insertRefid(qrefid);
associateMember(md, refid, scope_refid);
// compacting duplicate defs
if(!refid.created && memberdefExists(refid) && memberdefIncomplete(refid, md))
{
/*
For performance, ideal to skip a member we've already added.
Unfortunately, we can have two memberdefs with the same refid documenting
the declaration and definition. memberdefIncomplete() uses the 'inline'
value to figure this out. Once we get to this point, we should *only* be
seeing the *other* type of def/decl, so we'll set inline to a new value (2),
indicating that this entry covers both inline types.
*/
struct SqlStmt memberdef_update;
// definitions have bodyfile/start/end
if (md->getStartBodyLine()!=-1)
{
memberdef_update = memberdef_update_def;
int bodyfile_id = insertPath(md->getBodyDef()->absFilePath(),!md->getBodyDef()->isReference());
if (bodyfile_id == -1)
{
sqlite3_clear_bindings(memberdef_update.stmt);
}
else
{
bindIntParameter(memberdef_update,":bodyfile_id",bodyfile_id);
bindIntParameter(memberdef_update,":bodystart",md->getStartBodyLine());
bindIntParameter(memberdef_update,":bodyend",md->getEndBodyLine());
}
}
// declarations don't
else
{
memberdef_update = memberdef_update_decl;
if (md->getDefLine() != -1)
{
int file_id = insertPath(md->getDefFileName(),!md->isReference());
if (file_id!=-1)
{
bindIntParameter(memberdef_update,":file_id",file_id);
bindIntParameter(memberdef_update,":line",md->getDefLine());
bindIntParameter(memberdef_update,":column",md->getDefColumn());
}
}
}
bindIntParameter(memberdef_update, ":rowid", refid.rowid);
// value 2 indicates we've seen "both" inline types.
bindIntParameter(memberdef_update,":inline", 2);
/* in case both are used, append/prepend descriptions */
getSQLDesc(memberdef_update,":briefdescription",md->briefDescription(),md);
getSQLDesc(memberdef_update,":detaileddescription",md->documentation(),md);
getSQLDesc(memberdef_update,":inbodydescription",md->inbodyDocumentation(),md);
step(memberdef_update,TRUE);
// don't think we need to repeat params; should have from first encounter
// + source references
// The cross-references in initializers only work when both the src and dst
// are defined.
MemberSDict *mdict = md->getReferencesMembers();
if (mdict!=0)
{
MemberSDict::IteratorDict mdi(*mdict);
const MemberDef *rmd;
for (mdi.toFirst();(rmd=mdi.current());++mdi)
{
insertMemberReference(md,rmd, "inline");
}
}
// + source referenced by
mdict = md->getReferencedByMembers();
if (mdict!=0)
{
MemberSDict::IteratorDict mdi(*mdict);
const MemberDef *rmd;
for (mdi.toFirst();(rmd=mdi.current());++mdi)
{
insertMemberReference(rmd,md, "inline");
}
}
return;
}
bindIntParameter(memberdef_insert,":rowid", refid.rowid);
bindTextParameter(memberdef_insert,":kind",md->memberTypeName(),FALSE);
bindIntParameter(memberdef_insert,":prot",md->protection());
bindIntParameter(memberdef_insert,":static",md->isStatic());
bool isFunc=FALSE;
switch (md->memberType())
{
case MemberType_Function: // fall through
case MemberType_Signal: // fall through
case MemberType_Friend: // fall through
case MemberType_DCOP: // fall through
case MemberType_Slot:
isFunc=TRUE;
break;
default:
break;
}
if (isFunc)
{
ArgumentList *al = md->argumentList();
if (al!=0)
{
bindIntParameter(memberdef_insert,":const",al->constSpecifier);
bindIntParameter(memberdef_insert,":volatile",al->volatileSpecifier);
}
bindIntParameter(memberdef_insert,":explicit",md->isExplicit());
bindIntParameter(memberdef_insert,":inline",md->isInline());
bindIntParameter(memberdef_insert,":final",md->isFinal());
bindIntParameter(memberdef_insert,":sealed",md->isSealed());
bindIntParameter(memberdef_insert,":new",md->isNew());
bindIntParameter(memberdef_insert,":optional",md->isOptional());
bindIntParameter(memberdef_insert,":required",md->isRequired());
bindIntParameter(memberdef_insert,":virt",md->virtualness());
}
if (md->memberType() == MemberType_Variable)
{
bindIntParameter(memberdef_insert,":mutable",md->isMutable());
bindIntParameter(memberdef_insert,":initonly",md->isInitonly());
bindIntParameter(memberdef_insert,":attribute",md->isAttribute());
bindIntParameter(memberdef_insert,":property",md->isProperty());
bindIntParameter(memberdef_insert,":readonly",md->isReadonly());
bindIntParameter(memberdef_insert,":bound",md->isBound());
bindIntParameter(memberdef_insert,":removable",md->isRemovable());
bindIntParameter(memberdef_insert,":constrained",md->isConstrained());
bindIntParameter(memberdef_insert,":transient",md->isTransient());
bindIntParameter(memberdef_insert,":maybevoid",md->isMaybeVoid());
bindIntParameter(memberdef_insert,":maybedefault",md->isMaybeDefault());
bindIntParameter(memberdef_insert,":maybeambiguous",md->isMaybeAmbiguous());
if (md->bitfieldString())
{
QCString bitfield = md->bitfieldString();
if (bitfield.at(0)==':') bitfield=bitfield.mid(1);
bindTextParameter(memberdef_insert,":bitfield",bitfield.stripWhiteSpace());
}
}
else if (md->memberType() == MemberType_Property)
{
bindIntParameter(memberdef_insert,":readable",md->isReadable());
bindIntParameter(memberdef_insert,":writable",md->isWritable());
bindIntParameter(memberdef_insert,":gettable",md->isGettable());
bindIntParameter(memberdef_insert,":privategettable",md->isPrivateGettable());
bindIntParameter(memberdef_insert,":protectedgettable",md->isProtectedGettable());
bindIntParameter(memberdef_insert,":settable",md->isSettable());
bindIntParameter(memberdef_insert,":privatesettable",md->isPrivateSettable());
bindIntParameter(memberdef_insert,":protectedsettable",md->isProtectedSettable());
if (md->isAssign() || md->isCopy() || md->isRetain()
|| md->isStrong() || md->isWeak())
{
int accessor=0;
if (md->isAssign()) accessor = 1;
else if (md->isCopy()) accessor = 2;
else if (md->isRetain()) accessor = 3;
else if (md->isStrong()) accessor = 4;
else if (md->isWeak()) accessor = 5;
bindIntParameter(memberdef_insert,":accessor",accessor);
}
bindTextParameter(memberdef_insert,":read",md->getReadAccessor());
bindTextParameter(memberdef_insert,":write",md->getWriteAccessor());
}
else if (md->memberType() == MemberType_Event)
{
bindIntParameter(memberdef_insert,":addable",md->isAddable());
bindIntParameter(memberdef_insert,":removable",md->isRemovable());
bindIntParameter(memberdef_insert,":raisable",md->isRaisable());
}
const MemberDef *rmd = md->reimplements();
if(rmd)
{
QCString qreimplemented_refid = rmd->getOutputFileBase() + "_1" + rmd->anchor();
struct Refid reimplemented_refid = insertRefid(qreimplemented_refid);
bindIntParameter(reimplements_insert,":memberdef_rowid", refid.rowid);
bindIntParameter(reimplements_insert,":reimplemented_rowid", reimplemented_refid.rowid);
step(reimplements_insert,TRUE);
}
// + declaration/definition arg lists
if (md->memberType()!=MemberType_Define &&
md->memberType()!=MemberType_Enumeration
)
{
if (md->memberType()!=MemberType_Typedef)
{
writeMemberTemplateLists(md);
}
QCString typeStr = md->typeString();
stripQualifiers(typeStr);
StringList l;
linkifyText(TextGeneratorSqlite3Impl(l), def, md->getBodyDef(),md,typeStr);
if (typeStr)
{
bindTextParameter(memberdef_insert,":type",typeStr,FALSE);
}
if (md->definition())
{
bindTextParameter(memberdef_insert,":definition",md->definition());
}
if (md->argsString())
{
bindTextParameter(memberdef_insert,":argsstring",md->argsString());
}
}
bindTextParameter(memberdef_insert,":name",md->name());
// Extract references from initializer
if (md->hasMultiLineInitializer() || md->hasOneLineInitializer())
{
bindTextParameter(memberdef_insert,":initializer",md->initializer());
StringList l;
linkifyText(TextGeneratorSqlite3Impl(l),def,md->getBodyDef(),md,md->initializer());
StringListIterator li(l);
QCString *s;
while ((s=li.current()))
{
if (md->getBodyDef())
{
DBG_CTX(("initializer:%s %s %s %d\n",
md->anchor().data(),
s->data(),
md->getBodyDef()->getDefFileName().data(),
md->getStartBodyLine()));
QCString qsrc_refid = md->getOutputFileBase() + "_1" + md->anchor();
struct Refid src_refid = insertRefid(qsrc_refid);
struct Refid dst_refid = insertRefid(s->data());
insertMemberReference(src_refid,dst_refid, "initializer");
}
++li;
}
}
if ( md->getScopeString() )
{
bindTextParameter(memberdef_insert,":scope",md->getScopeString(),FALSE);
}
// +Brief, detailed and inbody description
getSQLDesc(memberdef_insert,":briefdescription",md->briefDescription(),md);
getSQLDesc(memberdef_insert,":detaileddescription",md->documentation(),md);
getSQLDesc(memberdef_insert,":inbodydescription",md->inbodyDocumentation(),md);
// File location
if (md->getDefLine() != -1)
{
int file_id = insertPath(md->getDefFileName(),!md->isReference());
if (file_id!=-1)
{
bindIntParameter(memberdef_insert,":file_id",file_id);
bindIntParameter(memberdef_insert,":line",md->getDefLine());
bindIntParameter(memberdef_insert,":column",md->getDefColumn());
// definitions also have bodyfile/start/end
if (md->getStartBodyLine()!=-1)
{
int bodyfile_id = insertPath(md->getBodyDef()->absFilePath(),!md->getBodyDef()->isReference());
if (bodyfile_id == -1)
{
sqlite3_clear_bindings(memberdef_insert.stmt);
}
else
{
bindIntParameter(memberdef_insert,":bodyfile_id",bodyfile_id);
bindIntParameter(memberdef_insert,":bodystart",md->getStartBodyLine());
bindIntParameter(memberdef_insert,":bodyend",md->getEndBodyLine());
}
}
}
}
int memberdef_id=step(memberdef_insert,TRUE);
if (isFunc)
{
insertMemberFunctionParams(memberdef_id,md,def);
}
else if (md->memberType()==MemberType_Define &&
md->argsString())
{
insertMemberDefineParams(memberdef_id,md,def);
}
// + source references
// The cross-references in initializers only work when both the src and dst
// are defined.
MemberSDict *mdict = md->getReferencesMembers();
if (mdict!=0)
{
MemberSDict::IteratorDict mdi(*mdict);
const MemberDef *rmd;
for (mdi.toFirst();(rmd=mdi.current());++mdi)
{
insertMemberReference(md,rmd, "inline");
}
}
// + source referenced by
mdict = md->getReferencedByMembers();
if (mdict!=0)
{
MemberSDict::IteratorDict mdi(*mdict);
const MemberDef *rmd;
for (mdi.toFirst();(rmd=mdi.current());++mdi)
{
insertMemberReference(rmd,md, "inline");
}
}
}
static void generateSqlite3Section( const Definition *d,
const MemberList *ml,
struct Refid scope_refid,
const char * /*kind*/,
const char * /*header*/=0,
const char * /*documentation*/=0)
{
if (ml==0) return;
MemberListIterator mli(*ml);
const MemberDef *md;
for (mli.toFirst();(md=mli.current());++mli)
{
// TODO: necessary? just tracking what xmlgen does; xmlgen says:
// namespace members are also inserted in the file scope, but
// to prevent this duplication in the XML output, we filter those here.
if (d->definitionType()!=Definition::TypeFile || md->getNamespaceDef()==0)
{
generateSqlite3ForMember(md, scope_refid, d);
}
}
}
static void associateAllClassMembers(const ClassDef *cd, struct Refid scope_refid)
{
if (cd->memberNameInfoSDict())
{
MemberNameInfoSDict::Iterator mnii(*cd->memberNameInfoSDict());
MemberNameInfo *mni;
for (mnii.toFirst();(mni=mnii.current());++mnii)
{
MemberNameInfoIterator mii(*mni);
MemberInfo *mi;
for (mii.toFirst();(mi=mii.current());++mii)
{
MemberDef *md = mi->memberDef;
QCString qrefid = md->getOutputFileBase() + "_1" + md->anchor();
associateMember(md, insertRefid(qrefid), scope_refid);
}
}
}
}
// many kinds: category class enum exception interface
// module protocol service singleton struct type union
// enum is Java only (and is distinct from enum memberdefs)
static void generateSqlite3ForClass(const ClassDef *cd)
{
// NOTE: Skeptical about XML's version of these
// 'x' marks missing items XML claims to include
// + brief description
// + detailed description
// + template argument list(s)
// + include file
// + member groups
// x inheritance DOT diagram
// + list of direct super classes
// + list of direct sub classes
// + list of inner classes
// x collaboration DOT diagram
// + list of all members
// x user defined member sections
// x standard member sections
// x detailed member documentation
// - examples using the class
if (cd->isReference()) return; // skip external references.
if (cd->isHidden()) return; // skip hidden classes.
if (cd->name().find('@')!=-1) return; // skip anonymous compounds.
if (cd->templateMaster()!=0) return; // skip generated template instances.
struct Refid refid = insertRefid(cd->getOutputFileBase());
// can omit a class that already has a refid
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid", refid.rowid);
bindTextParameter(compounddef_insert,":name",cd->name());
bindTextParameter(compounddef_insert,":title",cd->title(), FALSE);
bindTextParameter(compounddef_insert,":kind",cd->compoundTypeString(),FALSE);
bindIntParameter(compounddef_insert,":prot",cd->protection());
int file_id = insertPath(cd->getDefFileName());
bindIntParameter(compounddef_insert,":file_id",file_id);
bindIntParameter(compounddef_insert,":line",cd->getDefLine());
bindIntParameter(compounddef_insert,":column",cd->getDefColumn());
// + include file
/*
TODO: I wonder if this can actually be cut (just here)
We were adding this "include" to the "includes" table alongside
other includes (from a FileDef). However, FileDef and ClassDef are using
"includes" nodes in very a different way:
- With FileDef, it means the file includes another.
- With ClassDef, it means you should include this file to use this class.
Because of this difference, I added a column to compounddef, header_id, and
linked it back to the appropriate file. We could just add a nullable text
column that would hold a string equivalent to what the HTML docs include,
but the logic for generating it is embedded in
ClassDef::writeIncludeFiles(OutputList &ol).
That said, at least on the handful of test sets I have, header_id == file_id,
suggesting it could be cut and clients might be able to reconstruct it from
other values if there's a solid heuristic for *when a class will
have a header file*.
*/
IncludeInfo *ii=cd->includeInfo();
if (ii)
{
QCString nm = ii->includeName;
if (nm.isEmpty() && ii->fileDef) nm = ii->fileDef->docName();
if (!nm.isEmpty())
{
int header_id=insertPath(ii->fileDef->absFilePath(),!ii->fileDef->isReference());
DBG_CTX(("-----> ClassDef includeInfo for %s\n", nm.data()));
DBG_CTX((" local : %d\n", ii->local));
DBG_CTX((" imported : %d\n", ii->imported));
DBG_CTX((" indirect : %d\n", ii->indirect));
DBG_CTX(("header: %s\n", ii->fileDef->absFilePath().data()));
DBG_CTX((" file_id : %d\n", file_id));
DBG_CTX((" header_id: %d\n", header_id));
if(header_id!=-1)
{
bindIntParameter(compounddef_insert,":header_id",header_id);
}
}
}
getSQLDesc(compounddef_insert,":briefdescription",cd->briefDescription(),cd);
getSQLDesc(compounddef_insert,":detaileddescription",cd->documentation(),cd);
step(compounddef_insert);
// + list of direct super classes
if (cd->baseClasses())
{
BaseClassListIterator bcli(*cd->baseClasses());
const BaseClassDef *bcd;
for (bcli.toFirst();(bcd=bcli.current());++bcli)
{
struct Refid base_refid = insertRefid(bcd->classDef->getOutputFileBase());
struct Refid derived_refid = insertRefid(cd->getOutputFileBase());
bindIntParameter(compoundref_insert,":base_rowid", base_refid.rowid);
bindIntParameter(compoundref_insert,":derived_rowid", derived_refid.rowid);
bindIntParameter(compoundref_insert,":prot",bcd->prot);
bindIntParameter(compoundref_insert,":virt",bcd->virt);
step(compoundref_insert);
}
}
// + list of direct sub classes
if (cd->subClasses())
{
BaseClassListIterator bcli(*cd->subClasses());
const BaseClassDef *bcd;
for (bcli.toFirst();(bcd=bcli.current());++bcli)
{
struct Refid derived_refid = insertRefid(bcd->classDef->getOutputFileBase());
struct Refid base_refid = insertRefid(cd->getOutputFileBase());
bindIntParameter(compoundref_insert,":base_rowid", base_refid.rowid);
bindIntParameter(compoundref_insert,":derived_rowid", derived_refid.rowid);
bindIntParameter(compoundref_insert,":prot",bcd->prot);
bindIntParameter(compoundref_insert,":virt",bcd->virt);
step(compoundref_insert);
}
}
// + list of inner classes
writeInnerClasses(cd->getClassSDict(),refid);
// + template argument list(s)
writeTemplateList(cd);
// + member groups
if (cd->getMemberGroupSDict())
{
MemberGroupSDict::Iterator mgli(*cd->getMemberGroupSDict());
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
{
generateSqlite3Section(cd,mg->members(),refid,"user-defined",mg->header(),
mg->documentation());
}
}
// this is just a list of *local* members
QListIterator<MemberList> mli(cd->getMemberLists());
MemberList *ml;
for (mli.toFirst();(ml=mli.current());++mli)
{
if ((ml->listType()&MemberListType_detailedLists)==0)
{
generateSqlite3Section(cd,ml,refid,"user-defined");
}
}
// + list of all members
associateAllClassMembers(cd, refid);
}
// kinds: constants library module namespace package
static void generateSqlite3ForNamespace(const NamespaceDef *nd)
{
// + contained class definitions
// + contained namespace definitions
// + member groups
// + normal members
// + brief desc
// + detailed desc
// + location (file_id, line, column)
// - files containing (parts of) the namespace definition
if (nd->isReference() || nd->isHidden()) return; // skip external references
struct Refid refid = insertRefid(nd->getOutputFileBase());
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid", refid.rowid);
bindTextParameter(compounddef_insert,":name",nd->name());
bindTextParameter(compounddef_insert,":title",nd->title(), FALSE);
bindTextParameter(compounddef_insert,":kind","namespace",FALSE);
int file_id = insertPath(nd->getDefFileName());
bindIntParameter(compounddef_insert,":file_id",file_id);
bindIntParameter(compounddef_insert,":line",nd->getDefLine());
bindIntParameter(compounddef_insert,":column",nd->getDefColumn());
getSQLDesc(compounddef_insert,":briefdescription",nd->briefDescription(),nd);
getSQLDesc(compounddef_insert,":detaileddescription",nd->documentation(),nd);
step(compounddef_insert);
// + contained class definitions
writeInnerClasses(nd->getClassSDict(),refid);
// + contained namespace definitions
writeInnerNamespaces(nd->getNamespaceSDict(),refid);
// + member groups
if (nd->getMemberGroupSDict())
{
MemberGroupSDict::Iterator mgli(*nd->getMemberGroupSDict());
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
{
generateSqlite3Section(nd,mg->members(),refid,"user-defined",mg->header(),
mg->documentation());
}
}
// + normal members
QListIterator<MemberList> mli(nd->getMemberLists());
MemberList *ml;
for (mli.toFirst();(ml=mli.current());++mli)
{
if ((ml->listType()&MemberListType_declarationLists)!=0)
{
generateSqlite3Section(nd,ml,refid,"user-defined");
}
}
}
// kind: file
static void generateSqlite3ForFile(const FileDef *fd)
{
// + includes files
// + includedby files
// x include graph
// x included by graph
// + contained class definitions
// + contained namespace definitions
// + member groups
// + normal members
// + brief desc
// + detailed desc
// x source code
// + location (file_id, line, column)
// - number of lines
if (fd->isReference()) return; // skip external references
struct Refid refid = insertRefid(fd->getOutputFileBase());
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid", refid.rowid);
bindTextParameter(compounddef_insert,":name",fd->name(),FALSE);
bindTextParameter(compounddef_insert,":title",fd->title(),FALSE);
bindTextParameter(compounddef_insert,":kind","file",FALSE);
int file_id = insertPath(fd->getDefFileName());
bindIntParameter(compounddef_insert,":file_id",file_id);
bindIntParameter(compounddef_insert,":line",fd->getDefLine());
bindIntParameter(compounddef_insert,":column",fd->getDefColumn());
getSQLDesc(compounddef_insert,":briefdescription",fd->briefDescription(),fd);
getSQLDesc(compounddef_insert,":detaileddescription",fd->documentation(),fd);
step(compounddef_insert);
// + includes files
IncludeInfo *ii;
if (fd->includeFileList())
{
QListIterator<IncludeInfo> ili(*fd->includeFileList());
for (ili.toFirst();(ii=ili.current());++ili)
{
int src_id=insertPath(fd->absFilePath(),!fd->isReference());
int dst_id;
QCString dst_path;
if(ii->fileDef) // found file
{
if(ii->fileDef->isReference())
{
// strip tagfile from path
QCString tagfile = ii->fileDef->getReference();
dst_path = ii->fileDef->absFilePath().copy();
dst_path.stripPrefix(tagfile+":");
}
else
{
dst_path = ii->fileDef->absFilePath();
}
dst_id = insertPath(dst_path,ii->local);
}
else // can't find file
{
dst_id = insertPath(ii->includeName,ii->local,FALSE);
}
DBG_CTX(("-----> FileDef includeInfo for %s\n", ii->includeName.data()));
DBG_CTX((" local: %d\n", ii->local));
DBG_CTX((" imported: %d\n", ii->imported));
DBG_CTX((" indirect: %d\n", ii->indirect));
if(ii->fileDef)
{
DBG_CTX(("include: %s\n", ii->fileDef->absFilePath().data()));
}
DBG_CTX((" src_id : %d\n", src_id));
DBG_CTX((" dst_id: %d\n", dst_id));
bindIntParameter(incl_select,":local",ii->local);
bindIntParameter(incl_select,":src_id",src_id);
bindIntParameter(incl_select,":dst_id",dst_id);
if (step(incl_select,TRUE,TRUE)==0) {
bindIntParameter(incl_insert,":local",ii->local);
bindIntParameter(incl_insert,":src_id",src_id);
bindIntParameter(incl_insert,":dst_id",dst_id);
step(incl_insert);
}
}
}
// + includedby files
if (fd->includedByFileList())
{
QListIterator<IncludeInfo> ili(*fd->includedByFileList());
for (ili.toFirst();(ii=ili.current());++ili)
{
int dst_id=insertPath(fd->absFilePath(),!fd->isReference());
int src_id;
QCString src_path;
if(ii->fileDef) // found file
{
if(ii->fileDef->isReference())
{
// strip tagfile from path
QCString tagfile = ii->fileDef->getReference();
src_path = ii->fileDef->absFilePath().copy();
src_path.stripPrefix(tagfile+":");
}
else
{
src_path = ii->fileDef->absFilePath();
}
src_id = insertPath(src_path,ii->local);
}
else // can't find file
{
src_id = insertPath(ii->includeName,ii->local,FALSE);
}
bindIntParameter(incl_select,":local",ii->local);
bindIntParameter(incl_select,":src_id",src_id);
bindIntParameter(incl_select,":dst_id",dst_id);
if (step(incl_select,TRUE,TRUE)==0) {
bindIntParameter(incl_insert,":local",ii->local);
bindIntParameter(incl_insert,":src_id",src_id);
bindIntParameter(incl_insert,":dst_id",dst_id);
step(incl_insert);
}
}
}
// + contained class definitions
if (fd->getClassSDict())
{
writeInnerClasses(fd->getClassSDict(),refid);
}
// + contained namespace definitions
if (fd->getNamespaceSDict())
{
writeInnerNamespaces(fd->getNamespaceSDict(),refid);
}
// + member groups
if (fd->getMemberGroupSDict())
{
MemberGroupSDict::Iterator mgli(*fd->getMemberGroupSDict());
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
{
generateSqlite3Section(fd,mg->members(),refid,"user-defined",mg->header(),
mg->documentation());
}
}
// + normal members
QListIterator<MemberList> mli(fd->getMemberLists());
MemberList *ml;
for (mli.toFirst();(ml=mli.current());++mli)
{
if ((ml->listType()&MemberListType_declarationLists)!=0)
{
generateSqlite3Section(fd,ml,refid,"user-defined");
}
}
}
// kind: group
static void generateSqlite3ForGroup(const GroupDef *gd)
{
// + members
// + member groups
// + files
// + classes
// + namespaces
// - packages
// + pages
// + child groups
// - examples
// + brief description
// + detailed description
if (gd->isReference()) return; // skip external references.
struct Refid refid = insertRefid(gd->getOutputFileBase());
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid", refid.rowid);
bindTextParameter(compounddef_insert,":name",gd->name());
bindTextParameter(compounddef_insert,":title",gd->groupTitle(), FALSE);
bindTextParameter(compounddef_insert,":kind","group",FALSE);
int file_id = insertPath(gd->getDefFileName());
bindIntParameter(compounddef_insert,":file_id",file_id);
bindIntParameter(compounddef_insert,":line",gd->getDefLine());
bindIntParameter(compounddef_insert,":column",gd->getDefColumn());
getSQLDesc(compounddef_insert,":briefdescription",gd->briefDescription(),gd);
getSQLDesc(compounddef_insert,":detaileddescription",gd->documentation(),gd);
step(compounddef_insert);
// + files
writeInnerFiles(gd->getFiles(),refid);
// + classes
writeInnerClasses(gd->getClasses(),refid);
// + namespaces
writeInnerNamespaces(gd->getNamespaces(),refid);
// + pages
writeInnerPages(gd->getPages(),refid);
// + groups
writeInnerGroups(gd->getSubGroups(),refid);
// + member groups
if (gd->getMemberGroupSDict())
{
MemberGroupSDict::Iterator mgli(*gd->getMemberGroupSDict());
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
{
generateSqlite3Section(gd,mg->members(),refid,"user-defined",mg->header(),
mg->documentation());
}
}
// + members
QListIterator<MemberList> mli(gd->getMemberLists());
MemberList *ml;
for (mli.toFirst();(ml=mli.current());++mli)
{
if ((ml->listType()&MemberListType_declarationLists)!=0)
{
generateSqlite3Section(gd,ml,refid,"user-defined");
}
}
}
// kind: dir
static void generateSqlite3ForDir(const DirDef *dd)
{
// + dirs
// + files
// + briefdescription
// + detaileddescription
// + location (below uses file_id, line, column; XML just uses file)
if (dd->isReference()) return; // skip external references
struct Refid refid = insertRefid(dd->getOutputFileBase());
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid", refid.rowid);
bindTextParameter(compounddef_insert,":name",dd->displayName());
bindTextParameter(compounddef_insert,":kind","dir",FALSE);
int file_id = insertPath(dd->getDefFileName(),TRUE,TRUE,2);
bindIntParameter(compounddef_insert,":file_id",file_id);
/*
line and column are weird here, but:
- dir goes into compounddef with all of the others
- the semantics would be fine if we set them to NULL here
- but defining line and column as NOT NULL is an important promise
for other compounds, so I don't want to loosen it
For reference, the queries return 1.
0 or -1 make more sense, but I see that as a change for DirDef.
*/
bindIntParameter(compounddef_insert,":line",dd->getDefLine());
bindIntParameter(compounddef_insert,":column",dd->getDefColumn());
getSQLDesc(compounddef_insert,":briefdescription",dd->briefDescription(),dd);
getSQLDesc(compounddef_insert,":detaileddescription",dd->documentation(),dd);
step(compounddef_insert);
// + files
writeInnerDirs(&dd->subDirs(),refid);
// + files
writeInnerFiles(dd->getFiles(),refid);
}
// kinds: page, example
static void generateSqlite3ForPage(const PageDef *pd,bool isExample)
{
// + name
// + title
// + brief description
// + documentation (detailed description)
// + inbody documentation
// + sub pages
if (pd->isReference()) return; // skip external references.
// TODO: do we more special handling if isExample?
QCString qrefid = pd->getOutputFileBase();
if (pd->getGroupDef())
{
qrefid+=(QCString)"_"+pd->name();
}
if (qrefid=="index") qrefid="indexpage"; // to prevent overwriting the generated index page.
struct Refid refid = insertRefid(qrefid);
// can omit a page that already has a refid
if(!refid.created && compounddefExists(refid)){return;}
bindIntParameter(compounddef_insert,":rowid",refid.rowid);
// + name
bindTextParameter(compounddef_insert,":name",pd->name());
QCString title;
if (pd==Doxygen::mainPage) // main page is special
{
if (!pd->title().isEmpty() && pd->title().lower()!="notitle")
{
title = filterTitle(convertCharEntitiesToUTF8(Doxygen::mainPage->title()));
}
else
{
title = Config_getString(PROJECT_NAME);
}
}
else
{
SectionInfo *si = Doxygen::sectionDict->find(pd->name());
if (si)
{
title = si->title;
}
if(!title){title = pd->title();}
}
// + title
bindTextParameter(compounddef_insert,":title",title,FALSE);
bindTextParameter(compounddef_insert,":kind", isExample ? "example" : "page");
int file_id = insertPath(pd->getDefFileName());
bindIntParameter(compounddef_insert,":file_id",file_id);
bindIntParameter(compounddef_insert,":line",pd->getDefLine());
bindIntParameter(compounddef_insert,":column",pd->getDefColumn());
// + brief description
getSQLDesc(compounddef_insert,":briefdescription",pd->briefDescription(),pd);
// + documentation (detailed description)
getSQLDesc(compounddef_insert,":detaileddescription",pd->documentation(),pd);
step(compounddef_insert);
// + sub pages
writeInnerPages(pd->getSubPages(),refid);
}
static sqlite3* openDbConnection()
{
QCString outputDirectory = Config_getString(OUTPUT_DIRECTORY);
QDir sqlite3Dir(outputDirectory);
sqlite3 *db;
int rc;
struct stat buf;
rc = sqlite3_initialize();
if (rc != SQLITE_OK)
{
msg("sqlite3_initialize failed\n");
return NULL;
}
if (stat (outputDirectory+"/doxygen_sqlite3.db", &buf) == 0)
{
msg("doxygen_sqlite3.db already exists! aborting sqlite3 output generation!\n");
msg("If you wish to re-generate the database, remove or archive the existing copy first.\n");
return NULL;
}
rc = sqlite3_open_v2(
outputDirectory+"/doxygen_sqlite3.db",
&db,
SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE,
0
);
if (rc != SQLITE_OK)
{
sqlite3_close(db);
msg("database open failed: %s\n", "doxygen_sqlite3.db");
return NULL;
}
return db;
}
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
void generateSqlite3()
{
// + classes
// + namespaces
// + files
// + groups
// + related pages
// + examples
// + main page
sqlite3 *db;
db = openDbConnection();
if (db==NULL)
{
return;
}
# ifdef SQLITE3_DEBUG
// debug: show all executed statements
sqlite3_trace(db, &sqlLog, NULL);
# endif
beginTransaction(db);
pragmaTuning(db);
if (-1==initializeTables(db))
return;
if ( -1 == prepareStatements(db) )
{
err("sqlite generator: prepareStatements failed!");
return;
}
recordMetadata();
// + classes
ClassSDict::Iterator cli(*Doxygen::classSDict);
const ClassDef *cd;
for (cli.toFirst();(cd=cli.current());++cli)
{
msg("Generating Sqlite3 output for class %s\n",cd->name().data());
generateSqlite3ForClass(cd);
}
// + namespaces
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
const NamespaceDef *nd;
for (nli.toFirst();(nd=nli.current());++nli)
{
msg("Generating Sqlite3 output for namespace %s\n",nd->name().data());
generateSqlite3ForNamespace(nd);
}
// + files
FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (;(fn=fnli.current());++fnli)
{
FileNameIterator fni(*fn);
const FileDef *fd;
for (;(fd=fni.current());++fni)
{
msg("Generating Sqlite3 output for file %s\n",fd->name().data());
generateSqlite3ForFile(fd);
}
}
// + groups
GroupSDict::Iterator gli(*Doxygen::groupSDict);
const GroupDef *gd;
for (;(gd=gli.current());++gli)
{
msg("Generating Sqlite3 output for group %s\n",gd->name().data());
generateSqlite3ForGroup(gd);
}
// + page
{
PageSDict::Iterator pdi(*Doxygen::pageSDict);
const PageDef *pd=0;
for (pdi.toFirst();(pd=pdi.current());++pdi)
{
msg("Generating Sqlite3 output for page %s\n",pd->name().data());
generateSqlite3ForPage(pd,FALSE);
}
}
// + dirs
{
const DirDef *dir;
DirSDict::Iterator sdi(*Doxygen::directories);
for (sdi.toFirst();(dir=sdi.current());++sdi)
{
msg("Generating Sqlite3 output for dir %s\n",dir->name().data());
generateSqlite3ForDir(dir);
}
}
// + examples
{
PageSDict::Iterator pdi(*Doxygen::exampleSDict);
const PageDef *pd=0;
for (pdi.toFirst();(pd=pdi.current());++pdi)
{
msg("Generating Sqlite3 output for example %s\n",pd->name().data());
generateSqlite3ForPage(pd,TRUE);
}
}
// + main page
if (Doxygen::mainPage)
{
msg("Generating Sqlite3 output for the main page\n");
generateSqlite3ForPage(Doxygen::mainPage,FALSE);
}
// TODO: copied from initializeSchema; not certain if we should say/do more
// if there's a failure here?
if (-1==initializeViews(db))
return;
endTransaction(db);
}
#else // USE_SQLITE3
void generateSqlite3()
{
err("sqlite3 support has not been compiled in!");
}
#endif
// vim: noai:ts=2:sw=2:ss=2:expandtab
|