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
|
{
***************************************************************************
* *
* This source is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This code 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 *
* General Public License for more details. *
* *
* A copy of the GNU General Public License is available on the World *
* Wide Web at <http://www.gnu.org/copyleft/gpl.html>. You can also *
* obtain it by writing to the Free Software Foundation, *
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
* *
***************************************************************************
Author: Mattias Gaertner
Abstract:
This unit is part of the IDE's help system. It implements the help for
sources via fpdoc files and pascal comments.
}
unit CodeHelp;
{$mode objfpc}{$H+}
{off $DEFINE VerboseLazDoc}
{off $DEFINE VerboseLazDocFails}
{off $DEFINE VerboseHints}
{$IFDEF VerboseLazDoc}
{$DEFINE VerboseLazDocFails}
{$ENDIF}
interface
uses
Classes, SysUtils, LCLProc, Forms, Controls, FileUtil, Dialogs, AvgLvlTree,
// codetools
CodeAtom, CodeTree, CodeToolManager, FindDeclarationTool, BasicCodeTools,
CodeCache, CacheCodeTools, FileProcs,
Laz_DOM, Laz_XMLRead, Laz_XMLWrite,
// IDEIntf
IDEMsgIntf, MacroIntf, PackageIntf, LazHelpIntf, ProjectIntf, IDEDialogs,
LazIDEIntf,
// IDE
LazarusIDEStrConsts, CompilerOptions, IDEProcs, PackageDefs, EnvironmentOpts,
TransferMacros, PackageSystem, DialogProcs;
type
TFPDocItem = (
fpdiShort,
fpdiElementLink,
fpdiDescription,
fpdiErrors,
fpdiSeeAlso,
fpdiExample
);
TFPDocElementValues = array [TFPDocItem] of String;
const
FPDocItemNames: array[TFPDocItem] of shortstring = (
'short',
'elementlink',
'descr',
'errors',
'seealso',
'example'
);
type
TLazFPDocFileFlag = (
ldffDocChangingCalled,
ldffDocChangedNeedsCalling
);
TLazFPDocFileFlags = set of TLazFPDocFileFlag;
{ TLazFPDocFile
An fpdoc xml file. The CodeBuffer is the xml source. The Doc is the parsed dom tree. }
TLazFPDocFile = class
private
fUpdateLock: integer;
FFlags: TLazFPDocFileFlags;
public
Filename: string;// the fpdoc xml filename
Doc: TXMLdocument;// IMPORTANT: if you change this, call DocChanging and DocChanged to notify the references
DocErrorMsg: string; // if xml is broken, Doc could not be created
DocModified: boolean;
ChangeStep: integer;// the CodeBuffer.ChangeStep value, when Doc was built
CodeBuffer: TCodeBuffer;
destructor Destroy; override;
function GetPackageNode: TDOMNode; // the lazarus project or package
function GetPackageName: string;
function GetModuleNode: TDOMNode; // the unit
function GetModuleName: string;
function GetFirstElement: TDOMNode;
function GetElementWithName(const ElementName: string;
CreateIfNotExists: boolean = false): TDOMNode;
function GetChildValuesAsString(Node: TDOMNode): String;
function GetValuesFromNode(Node: TDOMNode): TFPDocElementValues;
function GetValueFromNode(Node: TDOMNode; Item: TFPDocItem): string;
procedure SetChildValue(Node: TDOMNode; const ChildName: string; NewValue: string);
procedure DocChanging;
procedure DocChanged;
procedure BeginUpdate;
procedure EndUpdate;
end;
{ TLazFPDocNode }
TLazFPDocNode = class
public
DocFile: TLazFPDocFile;
Node: TDomNode;
constructor Create(AFile: TLazFPDocFile; ANode: TDOMNode);
end;
{ TCHSourceToFPDocFile - cache item for source to FPDoc file mapping }
TCHSourceToFPDocFile = class
public
SourceFilename: string;
FPDocFilename: string;
FPDocFileOwner: TObject;
FPDocFilenameTimeStamp: integer;
FilesTimeStamp: integer;
end;
{ TCodeHelpElement - mapping between one codetools position and a fpdoc xml node.
This data is only valid for short times, so don't store it. }
TCodeHelpElement = class
public
CodeContext: TFindContext;
CodeXYPos: TCodeXYPosition;
ElementOwnerName: string;// the 'fpdoc package' = the name of the lazarus package or project
ElementUnitName: string;
ElementUnitFileName: string;
ElementName: string;
ElementNode: TDOMNode;
ElementNodeValid: boolean;
FPDocFile: TLazFPDocFile;
procedure WriteDebugReport;
end;
{ TCodeHelpElementChain - a list of TCodeHelpElement.
For example the list of one element plus its ancestors.
Only valid for short time. So always check IsValid. }
TCodeHelpElementChain = class
private
FItems: TFPList; // list of TCodeHelpElement
function GetCount: integer;
function GetItems(Index: integer): TCodeHelpElement;
function Add: TCodeHelpElement;
public
CodePos: TCodePosition;
IDEChangeStep: integer;
CodetoolsChangeStep: integer;
constructor Create;
destructor Destroy; override;
procedure Clear;
property Items[Index: integer]: TCodeHelpElement read GetItems; default;
property Count: integer read GetCount;
function IndexOfFile(AFile: TLazFPDocFile): integer;
function IsValid: boolean;
procedure MakeValid;
function DocFile: TLazFPDocFile;
procedure WriteDebugReport;
end;
TCodeHelpChangeEvent = procedure(Sender: TObject; LazFPDocFile: TLazFPDocFile) of object;
TCodeHelpManagerHandler = (
chmhDocChanging,
chmhDocChanged
);
TCodeHelpOpenFileFlag = (
chofUpdateFromDisk,
chofRevert,
chofQuiet
);
TCodeHelpOpenFileFlags = set of TCodeHelpOpenFileFlag;
TCodeHelpParseResult = (
chprParsing, // means: done a small step, but not yet finished the job
chprFailed,
chprSuccess
);
TCodeHelpHintOption = (
chhoComplete, // ??
chhoSmartHint, // add smart hint
chhoComments // return info from comments in the code
);
TCodeHelpHintOptions = set of TCodeHelpHintOption;
{ TCodeHelpManager }
TCodeHelpManager = class
private
FDocs: TAvgLvlTree;// tree of loaded TLazFPDocFile
FHandlers: array[TCodeHelpManagerHandler] of TMethodList;
FSrcToDocMap: TAvgLvlTree; // tree of TCHSourceToFPDocFile sorted for SourceFilename
FDeclarationCache: TDeclarationInheritanceCache;
procedure AddHandler(HandlerType: TCodeHelpManagerHandler;
const AMethod: TMethod; AsLast: boolean = false);
procedure RemoveHandler(HandlerType: TCodeHelpManagerHandler;
const AMethod: TMethod);
procedure FreeHandlers;
procedure CallDocChangeEvents(HandlerType: TCodeHelpManagerHandler;
Doc: TLazFPDocFile);
function DoCreateFPDocFileForSource(const SrcFilename: string;
out NewOwner: TObject): string;
function CreateFPDocFile(const ExpandedFilename, PackageName,
ModuleName: string): TCodeBuffer;
public
constructor Create;
destructor Destroy; override;
procedure FreeDocs;
procedure ClearSrcToDocMap;
function FindFPDocFile(const Filename: string): TLazFPDocFile;
function LoadFPDocFile(const Filename: string;
Flags: TCodeHelpOpenFileFlags;
out ADocFile: TLazFPDocFile;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function SaveFPDocFile(ADocFile: TLazFPDocFile): TModalResult;
function GetFPDocFilenameForHelpContext(
Context: TPascalHelpContextList;
out CacheWasUsed: boolean): string;
function GetFPDocFilenameForSource(SrcFilename: string;
ResolveIncludeFiles: Boolean;
out CacheWasUsed: boolean;
out AnOwner: TObject;// package or project
CreateIfNotExists: boolean = false): string;
function GetFPDocFilenameForPkgFile(PkgFile: TPkgFile;
ResolveIncludeFiles: Boolean;
out CacheWasUsed: boolean;
CreateIfNotExists: boolean = false): string;
procedure GetFPDocFilenamesForSources(SrcFilenames: TStringToStringTree;
ResolveIncludeFiles: boolean;
var FPDocFilenames: TStringToStringTree // Names=Filename, Values=ModuleName
);
function FindModuleOwner(const Modulename: string): TObject;
function FindModuleOwner(FPDocFile: TLazFPDocFile): TObject;
function GetModuleOwnerName(TheOwner: TObject): string;
function ExpandFPDocLinkID(const LinkID, DefaultUnitName,
DefaultOwnerName: string): string;
function ExpandFPDocLinkID(const LinkID, DefaultUnitName: string;
TheOwner: TObject): string;
function CodeNodeToElementName(Tool: TFindDeclarationTool;
CodeNode: TCodeTreeNode): string;
function GetFPDocNode(Tool: TCodeTool; CodeNode: TCodeTreeNode; Complete: boolean;
out FPDocFile: TLazFPDocFile; out DOMNode: TDOMNode;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function GetLinkedFPDocNode(StartFPDocFile: TLazFPDocFile;
StartDOMNode: TDOMNode;
const Path: string;
Flags: TCodeHelpOpenFileFlags;
out ModuleOwner: TObject;
out FPDocFile: TLazFPDocFile; out DOMNode: TDOMNode;
out InvalidPath: integer;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function GetDeclarationChain(Code: TCodeBuffer; X, Y: integer;
out ListOfPCodeXYPosition: TFPList;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function GetCodeContext(CodePos: PCodeXYPosition;
out FindContext: TFindContext;
Complete: boolean;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function GetElementChain(Code: TCodeBuffer; X, Y: integer; Complete: boolean;
out Chain: TCodeHelpElementChain;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function GetHTMLHint(Code: TCodeBuffer; X, Y: integer; Options: TCodeHelpHintOptions;
out BaseURL, HTMLHint: string;
out CacheWasUsed: boolean): TCodeHelpParseResult;
function CreateElement(Code: TCodeBuffer; X, Y: integer;
out Element: TCodeHelpElement): Boolean;
public
// Event lists
procedure RemoveAllHandlersOfObject(AnObject: TObject);
procedure AddHandlerOnChanging(const OnDocChangingEvent: TCodeHelpChangeEvent;
AsLast: boolean = false);
procedure RemoveHandlerOnChanging(const OnDocChangingEvent: TCodeHelpChangeEvent);
procedure AddHandlerOnChanged(const OnDocChangedEvent: TCodeHelpChangeEvent;
AsLast: boolean = false);
procedure RemoveHandlerOnChanged(const OnDocChangedEvent: TCodeHelpChangeEvent);
end;
var
CodeHelpBoss: TCodeHelpManager = nil;// set by the IDE
function CompareLazFPDocFilenames(Data1, Data2: Pointer): integer;
function CompareAnsistringWithLazFPDocFile(Key, Data: Pointer): integer;
function CompareLDSrc2DocSrcFilenames(Data1, Data2: Pointer): integer;
function CompareAnsistringWithLDSrc2DocSrcFile(Key, Data: Pointer): integer;
function ToUnixLineEnding(const s: String): String;
function ToOSLineEnding(const s: String): String;
function ReplaceLineEndings(const s, NewLineEnds: string): string;
implementation
function ToUnixLineEnding(const s: String): String;
var
p: Integer;
begin
Result:=s;
p:=1;
while (p<=length(Result)) do begin
case Result[p] of
#10:
if (p<length(Result)) and (Result[p+1] in [#10,#13])
and (Result[p]<>Result[p+1]) then begin
// double character line ending
System.Delete(Result,p,2);
end;
#13:
begin
// single char line ending #13
Result[p]:=#10;
end;
end;
inc(p);
end;
end;
function ToOSLineEnding(const s: String): String;
const
le: shortstring = LineEnding;
var
p: Integer;
begin
Result:=s;
p:=1;
while (p<=length(s)) do begin
if not (s[p] in [#10,#13]) then begin
inc(p);
end else begin
// line ending
if (p<length(s)) and (s[p+1] in [#10,#13]) and (s[p]<>s[p+1]) then begin
// double character line ending
if (length(le)<>2)
or (le[1]<>s[p]) or (le[2]<>s[p+1]) then begin
Result:=copy(Result,1,p-1)+le+copy(Result,p+2,length(Result));
end;
end else begin
// single char line ending #13 or #10
if (length(le)<>1)
or (le[1]<>s[p]) then begin
Result:=copy(Result,1,p-1)+le+copy(Result,p+2,length(Result));
end;
end;
inc(p);
end;
end;
end;
function ReplaceLineEndings(const s, NewLineEnds: string): string;
var
p: Integer;
StartPos: LongInt;
begin
Result:=s;
p:=1;
while (p<=length(Result)) do begin
if Result[p] in [#10,#13] then begin
StartPos:=p;
if (p<length(Result))
and (Result[p+1] in [#10,#13]) and (Result[p]<>Result[p+1]) then
inc(p);
Result:=copy(Result,1,StartPos-1)+NewLineEnds+copy(Result,p+1,length(Result));
inc(p,length(NewLineEnds));
end else begin
inc(p);
end;
end;
end;
function CompareLazFPDocFilenames(Data1, Data2: Pointer): integer;
begin
Result:=CompareFilenames(TLazFPDocFile(Data1).Filename,
TLazFPDocFile(Data2).Filename);
end;
function CompareAnsistringWithLazFPDocFile(Key, Data: Pointer): integer;
begin
Result:=CompareFilenames(AnsiString(Key),TLazFPDocFile(Data).Filename);
end;
function CompareLDSrc2DocSrcFilenames(Data1, Data2: Pointer): integer;
begin
Result:=CompareFilenames(TCHSourceToFPDocFile(Data1).SourceFilename,
TCHSourceToFPDocFile(Data2).SourceFilename);
end;
function CompareAnsistringWithLDSrc2DocSrcFile(Key, Data: Pointer): integer;
begin
Result:=CompareFilenames(AnsiString(Key),TCHSourceToFPDocFile(Data).SourceFilename);
end;
{ TLazFPDocFile }
destructor TLazFPDocFile.Destroy;
begin
FreeAndNil(Doc);
inherited Destroy;
end;
function TLazFPDocFile.GetPackageNode: TDOMNode;
begin
Result:=nil;
if Doc=nil then exit;
// get first node
Result := Doc.FindNode('fpdoc-descriptions');
if Result=nil then begin
//DebugLn(['TLazFPDocFile.GetPackageNode fpdoc-descriptions not found']);
exit;
end;
// proceed to package
Result := Result.FindNode('package');
end;
function TLazFPDocFile.GetPackageName: string;
var
Node: TDOMNode;
begin
Node:=GetPackageNode;
if Node is TDOMElement then
Result:=TDomElement(Node).GetAttribute('name')
else
Result:='';
end;
function TLazFPDocFile.GetModuleNode: TDOMNode;
begin
Result:=GetPackageNode;
if Result=nil then begin
//DebugLn(['TLazFPDocFile.GetModuleNode fpdoc-descriptions has no package']);
exit;
end;
// proceed to module
Result := Result.FindNode('module');
end;
function TLazFPDocFile.GetModuleName: string;
var
Node: TDOMNode;
begin
Node:=GetModuleNode;
if Node is TDOMElement then
Result:=TDomElement(Node).GetAttribute('name')
else
Result:='';
end;
function TLazFPDocFile.GetFirstElement: TDOMNode;
begin
//get first module node
Result := GetModuleNode;
//DebugLn(['TLazFPDocFile.GetFirstElement GetModuleNode=',GetModuleNode<>nil]);
if Result=nil then exit;
//proceed to element
Result := Result.FirstChild;
while (Result<>nil) and (Result.NodeName <> 'element') do
Result := Result.NextSibling;
end;
function TLazFPDocFile.GetElementWithName(const ElementName: string;
CreateIfNotExists: boolean): TDOMNode;
var
ModuleNode: TDOMNode;
begin
Result:=nil;
// get first module node
ModuleNode:=GetModuleNode;
if ModuleNode=nil then begin
if CreateIfNotExists then
DebugLn(['TLazFPDocFile.GetElementWithName create failed: missing module name. ElementName=',ElementName]);
exit;
end;
// check module name
if (ModuleNode is TDomElement)
and (SysUtils.CompareText(TDomElement(ModuleNode).GetAttribute('name'),ElementName)=0)
then begin
Result:=ModuleNode;
exit;
end;
// check elements
Result:=GetFirstElement;
//DebugLn(['TLazFPDocFile.GetElementWithName ',ElementName,' GetFirstElement=',GetFirstElement<>nil]);
while Result<>nil do begin
//DebugLn(['TLazFPDocFile.GetElementWithName ',dbgsName(Result)]);
//if Result is TDomElement then DebugLn(['TLazFPDocFile.GetElementWithName ',TDomElement(Result).GetAttribute('name')]);
if (Result is TDomElement)
and (SysUtils.CompareText(TDomElement(Result).GetAttribute('name'),ElementName)=0)
then
exit;
Result:=Result.NextSibling;
end;
if (Result=nil) and CreateIfNotExists then begin
DebugLn(['TLazFPDocFile.GetElementWithName creating ',ElementName]);
Result:=Doc.CreateElement('element');
DocChanging;
TDOMElement(Result).SetAttribute('name',ElementName);
ModuleNode.AppendChild(Result);
DocChanged;
end;
end;
function TLazFPDocFile.GetChildValuesAsString(Node: TDOMNode): String;
procedure FindEndOfTag(const Src: string; var EndPos: integer);
begin
while (EndPos<=length(Src)) do begin
if (Src[EndPos]='>') then begin
inc(EndPos);
exit;
end else if Src[EndPos]='"' then begin
repeat
inc(EndPos);
until (EndPos>=length(Src)) or (Src[EndPos]='"');
end;
inc(EndPos);
end;
end;
var
MemStream: TMemoryStream;
StartPos: Integer;
EndPos: Integer;
begin
Result:='';
MemStream:=TMemoryStream.Create;
try
// write node with childs
WriteXML(Node,MemStream);
MemStream.Position:=0;
SetLength(Result,MemStream.Size);
if Result<>'' then
MemStream.Read(Result[1],length(Result));
// remove enclosing tag(s) for Node, because Result should only
// contain the child values:
// <nodename/> or <nodename>...<nodename/>
// <nodename something=""/>
// plus line ends
StartPos:=1;
EndPos:=length(Result)+1;
// skip start tag and spaces at start
while (StartPos<=length(Result))
and (Result[StartPos] in [' ',#9,#10,#13]) do
inc(StartPos);
if (StartPos<=length(Result)) and (Result[StartPos]='<') then begin
inc(StartPos);
FindEndOfTag(Result,StartPos);
while (StartPos<=length(Result))
and (Result[StartPos] in [' ',#9,#10,#13]) do
inc(StartPos);
end;
// skip ending line ends and spaces at end
while (EndPos>StartPos) and (Result[EndPos-1] in [' ',#9,#10,#13]) do
dec(EndPos);
// skip end tag
if (EndPos>StartPos) and (Result[EndPos-1]='>') then begin
repeat
dec(EndPos);
if (EndPos=StartPos) then break;
if (Result[EndPos-1]='"') then begin
repeat
dec(EndPos);
until (EndPos=StartPos) or (Result[EndPos]='"');
end else if (Result[EndPos-1]='<') then begin
dec(EndPos);
break;
end;
until false;
while (EndPos>StartPos) and (Result[EndPos-1] in [' ',#9,#10,#13]) do
dec(EndPos);
end;
Result:=copy(Result,StartPos,EndPos-StartPos);
// the xml writer adds/removes spaces/new lines automatically
// add newlines after br and p tags
StartPos:=1;
while StartPos<length(Result) do begin
if Result[StartPos]='<' then begin
// search end of tag
EndPos:=StartPos+1;
FindEndOfTag(Result,EndPos);
if Result[StartPos+1]='/' then
inc(StartPos);
if (CompareIdentifiers(@Result[StartPos+1],'br')=0)
or (CompareIdentifiers(@Result[StartPos+1],'p')=0) then
begin
// add new line
if (EndPos <= Length(Result)) and not (Result[EndPos] in [#10,#13]) then
Result:=copy(Result,1,EndPos-1)+LineEnding+copy(Result,EndPos,length(Result));
end;
StartPos:=EndPos;
end else begin
inc(StartPos);
end;
end;
finally
MemStream.Free;
end;
{$ifdef VerboseLazDoc}
if Result<>'' then
DebugLn(['TLazFPDocFile.GetChildValuesAsString Node=',Node.NodeName,' Result=',Result]);
{$endif}
end;
function TLazFPDocFile.GetValuesFromNode(Node: TDOMNode): TFPDocElementValues;
// simple function to return the values as string
var
S: String;
begin
//DebugLn(['TLazFPDocFile.GetValuesFromNode ',Node.NodeName,' ',dbgsName(Node),' ',Node is TDomElement]);
if Node is TDomElement then
Result[fpdiElementLink] := TDomElement(Node).GetAttribute('link');
Node := Node.FirstChild;
while Assigned(Node) do
begin
if (Node.NodeType = ELEMENT_NODE) then
begin
S := Node.NodeName;
if S = FPDocItemNames[fpdiShort] then
Result[fpdiShort] := GetChildValuesAsString(Node);
if S = FPDocItemNames[fpdiDescription] then
Result[fpdiDescription] := GetChildValuesAsString(Node);
if S = FPDocItemNames[fpdiErrors] then
Result[fpdiErrors] := GetChildValuesAsString(Node);
if S = FPDocItemNames[fpdiSeeAlso] then
Result[fpdiSeeAlso] := GetChildValuesAsString(Node);
if S = FPDocItemNames[fpdiExample] then
Result[fpdiExample] := Node.Attributes.GetNamedItem('file').NodeValue;
end;
Node := Node.NextSibling;
end;
end;
function TLazFPDocFile.GetValueFromNode(Node: TDOMNode; Item: TFPDocItem
): string;
var
Child: TDOMNode;
begin
Result:='';
Child:=Node.FindNode(FPDocItemNames[Item]);
//DebugLn(['TLazFPDocFile.GetValueFromNode ',FPDocItemNames[Item],' Found=',Child<>nil]);
if Child<>nil then begin
if Item=fpdiExample then
Result := Child.Attributes.GetNamedItem('file').NodeValue
else
Result := GetChildValuesAsString(Child);
end;
end;
procedure TLazFPDocFile.SetChildValue(Node: TDOMNode; const ChildName: string;
NewValue: string);
procedure ReadXMLFragmentFromString(AParentNode: TDOMNode; const s: string);
var
MemStream: TStream;
begin
if s='' then exit;
try
MemStream:=TMemoryStream.Create;
MemStream.Write(s[1],length(s));
MemStream.Position:=0;
ReadXMLFragment(AParentNode,MemStream);
finally
MemStream.Free;
end;
end;
var
Child: TDOMNode;
FileAttribute, LinkAttribute: TDOMAttr;
begin
NewValue:=ToUnixLineEnding(NewValue);
if ChildName=FPDocItemNames[fpdiElementLink] then begin
// update attribute
if Node is TDomElement then begin
LinkAttribute:=TDomElement(Node).GetAttributeNode('link');
if ((NewValue='') and (LinkAttribute<>nil))
or ((NewValue<>'') and ((LinkAttribute=nil) or (LinkAttribute.NodeValue<>NewValue)))
then begin
// delete, add or change attribute 'link'
DebugLn(['TLazFPDocFile.SetChildValue Changing link Name=',ChildName,' NewValue="',NewValue,'"']);
DocChanging;
try
if NewValue='' then begin
TDomElement(Node).RemoveAttributeNode(LinkAttribute);
LinkAttribute.Free;
end else
TDomElement(Node).SetAttribute('link',NewValue);
finally
DocChanged;
end;
end;
end;
end else begin
// update sub node
Child:=Node.FindNode(ChildName);
if ChildName = FPDocItemNames[fpdiExample] then begin
// update sub node example, attribute file
NewValue:=FilenameToURLPath(NewValue);
FileAttribute:=nil;
if Child is TDomElement then
FileAttribute:=TDomElement(Child).GetAttributeNode('file');
if ((NewValue='') and (FileAttribute<>nil))
or ((NewValue<>'') and ((FileAttribute=nil) or (FileAttribute.NodeValue<>NewValue)))
then begin
// delete, add or change attribute 'file'
DebugLn(['TLazFPDocFile.SetChildValue Changing example file Name=',ChildName,' NewValue="',NewValue,'"']);
DocChanging;
try
if NewValue='' then begin
// remove old content
while Child.LastChild<>nil do
Child.RemoveChild(Child.LastChild);
Node.RemoveChild(Child);
end else begin
if Child=nil then begin
Child := Doc.CreateElement(ChildName);
Node.AppendChild(Child);
end;
TDomElement(Child).SetAttribute('file',NewValue);
end;
finally
DocChanged;
end;
end;
end else begin
if Child=nil then begin
// add node
if NewValue<>'' then begin
DebugLn(['TLazFPDocFile.SetChildValue Adding Name=',ChildName,' NewValue="',NewValue,'"']);
DocChanging;
try
Child := Doc.CreateElement(ChildName);
Node.AppendChild(Child);
ReadXMLFragmentFromString(Child,NewValue);
finally
DocChanged;
end;
end;
end else if GetChildValuesAsString(Child)<>NewValue then begin
// change node
DocChanging;
try
DebugLn(['TLazFPDocFile.SetChildValue Changing ',Node.NodeName,
' ChildName=',Child.NodeName,
' OldValue=',GetChildValuesAsString(Child),
' NewValue="',NewValue,'"']);
// remove old content
while Child.LastChild<>nil do
Child.RemoveChild(Child.LastChild);
if NewValue='' then begin
// remove entire child
Node.RemoveChild(Child);
end else begin
// set new content
ReadXMLFragmentFromString(Child,NewValue);
end;
finally
DocChanged;
end;
end;
end;
end;
end;
procedure TLazFPDocFile.DocChanging;
begin
DocModified:=true;
if (fUpdateLock>0) then begin
if (ldffDocChangingCalled in FFlags) then exit;
Include(FFlags,ldffDocChangingCalled);
end;
CodeHelpBoss.CallDocChangeEvents(chmhDocChanging,Self);
end;
procedure TLazFPDocFile.DocChanged;
begin
if (fUpdateLock>0) then begin
Include(FFlags,ldffDocChangedNeedsCalling);
exit;
end;
Exclude(FFlags,ldffDocChangedNeedsCalling);
CodeHelpBoss.CallDocChangeEvents(chmhDocChanged,Self);
end;
procedure TLazFPDocFile.BeginUpdate;
begin
inc(fUpdateLock);
end;
procedure TLazFPDocFile.EndUpdate;
begin
dec(fUpdateLock);
if fUpdateLock<0 then RaiseGDBException('TLazFPDocFile.EndUpdate');
if fUpdateLock=0 then begin
Exclude(FFlags,ldffDocChangingCalled);
if ldffDocChangedNeedsCalling in FFlags then
DocChanged;
end;
end;
procedure TCodeHelpManager.AddHandler(HandlerType: TCodeHelpManagerHandler;
const AMethod: TMethod; AsLast: boolean);
begin
if FHandlers[HandlerType]=nil then
FHandlers[HandlerType]:=TMethodList.Create;
FHandlers[HandlerType].Add(AMethod);
end;
procedure TCodeHelpManager.RemoveHandler(HandlerType: TCodeHelpManagerHandler;
const AMethod: TMethod);
begin
FHandlers[HandlerType].Remove(AMethod);
end;
procedure TCodeHelpManager.FreeHandlers;
var
HandlerType: TCodeHelpManagerHandler;
begin
for HandlerType:=Low(TCodeHelpManagerHandler) to High(TCodeHelpManagerHandler) do
FreeThenNil(FHandlers[HandlerType]);
end;
procedure TCodeHelpManager.CallDocChangeEvents(HandlerType: TCodeHelpManagerHandler;
Doc: TLazFPDocFile);
var
i: LongInt;
begin
i:=FHandlers[HandlerType].Count;
while FHandlers[HandlerType].NextDownIndex(i) do
TCodeHelpChangeEvent(FHandlers[HandlerType].Items[i])(Self,Doc);
end;
function TCodeHelpManager.DoCreateFPDocFileForSource(const SrcFilename: string;
out NewOwner: TObject): string;
procedure CleanUpPkgList(var PkgList: TFPList);
var
i: Integer;
AProject: TLazProject;
BaseDir: String;
APackage: TLazPackage;
begin
if (PkgList=nil) then exit;
for i:=PkgList.Count-1 downto 0 do begin
if TObject(PkgList[i]) is TLazProject then begin
AProject:=TLazProject(PkgList[i]);
BaseDir:=ExtractFilePath(AProject.ProjectInfoFile);
if BaseDir<>'' then continue;
end else if TObject(PkgList[i]) is TLazPackage then begin
APackage:=TLazPackage(PkgList[i]);
BaseDir:=APackage.Directory;
if BaseDir<>'' then continue;
end;
// this owner can not be used
PkgList.Delete(i);
end;
if PkgList.Count=0 then
FreeAndNil(PkgList);
if PkgList.Count>1 then begin
// there are more than one possible owners
DebugLn(['TCodeHelpManager.DoCreateFPDocFileForSource.CleanUpPkgList Warning: overlapping projects/packages']);
end;
end;
function SelectNewLazDocPaths(const Title, BaseDir: string): string;
begin
Result:=LazSelectDirectory('Choose LazDoc directory for '+Title,BaseDir);
end;
var
PkgList: TFPList;
AProject: TLazProject;
APackage: TLazPackage;
p: Integer;
LazDocPaths: String;
LazDocPackageName: String;
NewPath: String;
BaseDir: String;
Code: TCodeBuffer;
CurUnitName: String;
AVLNode: TAvgLvlTreeNode;
begin
Result:='';
NewOwner:=nil;
DebugLn(['TCodeHelpManager.DoCreateFPDocFileForSource ',SrcFilename]);
if not FilenameIsAbsolute(SrcFilename) then begin
DebugLn(['TCodeHelpManager.DoCreateFPDocFileForSource failed, because file no absolute: ',SrcFilename]);
exit;
end;
PkgList:=nil;
try
// get all packages owning the file
PkgList:=PackageEditingInterface.GetOwnersOfUnit(SrcFilename);
CleanUpPkgList(PkgList);
if (PkgList=nil) then begin
PkgList:=PackageEditingInterface.GetPossibleOwnersOfUnit(SrcFilename,
[piosfIncludeSourceDirectories]);
CleanUpPkgList(PkgList);
end;
if PkgList=nil then begin
// no package/project found
MessageDlg(lisProjAddPackageNotFound,
Format(lisLDTheUnitIsNotOwnedBeAnyPackageOrProjectPleaseAddThe, [
SrcFilename, #13, #13]), mtError, [mbCancel], 0);
exit;
end;
NewOwner:=TObject(PkgList[0]);
if NewOwner is TLazProject then begin
AProject:=TLazProject(NewOwner);
BaseDir:=ExtractFilePath(AProject.ProjectInfoFile);
if AProject.LazDocPaths='' then
AProject.LazDocPaths:=SelectNewLazDocPaths(AProject.ShortDescription,BaseDir);
LazDocPaths:=AProject.LazDocPaths;
LazDocPackageName:=GetModuleOwnerName(AProject);
end else if NewOwner is TLazPackage then begin
APackage:=TLazPackage(NewOwner);
BaseDir:=APackage.Directory;
if APackage.LazDocPaths='' then
APackage.LazDocPaths:=SelectNewLazDocPaths(APackage.Name,BaseDir);
LazDocPaths:=APackage.LazDocPaths;
LazDocPackageName:=GetModuleOwnerName(APackage);
end else begin
DebugLn(['TCodeHelpManager.DoCreateFPDocFileForSource unknown owner type ',dbgsName(NewOwner)]);
NewOwner:=nil;
exit;
end;
p:=1;
repeat
NewPath:=GetNextDirectoryInSearchPath(LazDocPaths,p);
if not FilenameIsAbsolute(NewPath) then
NewPath:=AppendPathDelim(BaseDir)+NewPath;
if DirPathExistsCached(NewPath) then begin
// fpdoc directory found
Result:=AppendPathDelim(NewPath)+lowercase(ExtractFileNameOnly(SrcFilename))+'.xml';
Code:=CodeToolBoss.LoadFile(SrcFilename,true,false);
// get unitname
CurUnitName:=ExtractFileNameOnly(SrcFilename);
if Code<>nil then
CurUnitName:=CodeToolBoss.GetSourceName(Code,false);
// remove cache (source to fpdoc filename)
AVLNode:=FSrcToDocMap.FindKey(Pointer(SrcFilename),
@CompareAnsistringWithLDSrc2DocSrcFile);
if AVLNode<>nil then
FSrcToDocMap.FreeAndDelete(AVLNode);
// create fpdoc file
if CreateFPDocFile(Result,LazDocPackageName,CurUnitName)=nil then
Result:='';
exit;
end;
until false;
// no valid directory found
DebugLn(['TCodeHelpManager.DoCreateFPDocFileForSource LazDocModul="',LazDocPackageName,'" LazDocPaths="',LazDocPaths,'" ']);
MessageDlg(lisLDNoValidLazDocPath,
Format(lisLDDoesNotHaveAnyValidLazDocPathUnableToCreateTheFpdo, [
LazDocPackageName, #13, SrcFilename]), mtError, [mbCancel], 0);
finally
PkgList.Free;
end;
end;
function TCodeHelpManager.CreateFPDocFile(const ExpandedFilename,
PackageName, ModuleName: string): TCodeBuffer;
var
Doc: TXMLDocument;
DescrNode: TDOMElement;
ms: TMemoryStream;
s: string;
ModuleNode: TDOMElement;
PackageNode: TDOMElement;
begin
Result:=nil;
if FileExistsCached(ExpandedFilename) then begin
Result:=CodeToolBoss.LoadFile(ExpandedFilename,true,false);
exit;
end;
Result:=CodeToolBoss.CreateFile(ExpandedFilename);
if Result=nil then begin
MessageDlg('Unable to create file',
'Unable to create file '+ExpandedFilename,mtError,[mbCancel],0);
exit;
end;
Doc:=nil;
ms:=nil;
try
Doc:=TXMLDocument.Create;
// <fpdoc-descriptions>
DescrNode:=Doc.CreateElement('fpdoc-descriptions');
Doc.AppendChild(DescrNode);
// <package name="packagename">
PackageNode:=Doc.CreateElement('package');
PackageNode.SetAttribute('name',PackageName);
DescrNode.AppendChild(PackageNode);
// <module name="unitname">
ModuleNode:=Doc.CreateElement('module');
ModuleNode.SetAttribute('name',ModuleName);
PackageNode.AppendChild(ModuleNode);
// write the XML to a string
ms:=TMemoryStream.Create;
WriteXMLFile(Doc,ms);
ms.Position:=0;
SetLength(s,ms.Size);
if s<>'' then
ms.Read(s[1],length(s));
// copy to codebuffer
//DebugLn(['TCodeHelpManager.CreateFPDocFile ',s]);
Result.Source:=s;
// save file
if SaveCodeBuffer(Result)<>mrOk then
Result:=nil;
finally
ms.Free;
Doc.Free;
end;
end;
constructor TCodeHelpManager.Create;
begin
FDocs:=TAvgLvlTree.Create(@CompareLazFPDocFilenames);
FSrcToDocMap:=TAvgLvlTree.Create(@CompareLDSrc2DocSrcFilenames);
FDeclarationCache:=TDeclarationInheritanceCache.Create(
@CodeToolBoss.FindDeclarationAndOverload,
@CodeToolBoss.GetCodeTreeNodesDeletedStep);
end;
destructor TCodeHelpManager.Destroy;
begin
ClearSrcToDocMap;
FreeDocs;
FreeAndNil(FDocs);
FreeAndNil(FSrcToDocMap);
FreeAndNil(FDeclarationCache);
FreeHandlers;
inherited Destroy;
end;
function TCodeHelpManager.FindFPDocFile(const Filename: string): TLazFPDocFile;
var
Node: TAvgLvlTreeNode;
begin
Node:=FDocs.FindKey(Pointer(Filename),@CompareAnsistringWithLazFPDocFile);
if Node<>nil then
Result:=TLazFPDocFile(Node.Data)
else
Result:=nil;
end;
function TCodeHelpManager.LoadFPDocFile(const Filename: string;
Flags: TCodeHelpOpenFileFlags;
out ADocFile: TLazFPDocFile; out CacheWasUsed: boolean
): TCodeHelpParseResult;
var
MemStream: TMemoryStream;
CurFilename: String;
begin
Result:=chprFailed;
CacheWasUsed:=true;
ADocFile:=FindFPDocFile(Filename);
if ADocFile=nil then begin
CacheWasUsed:=false;
ADocFile:=TLazFPDocFile.Create;
ADocFile.Filename:=Filename;
FDocs.Add(ADocFile);
end;
ADocFile.CodeBuffer:=CodeToolBoss.LoadFile(Filename,
chofUpdateFromDisk in Flags,chofRevert in Flags);
if ADocFile.CodeBuffer=nil then begin
DebugLn(['TCodeHelpManager.LoadFPDocFile unable to load "',Filename,'"']);
FreeAndNil(ADocFile.Doc);
exit;
end;
if (ADocFile.ChangeStep=ADocFile.CodeBuffer.ChangeStep) then begin
// CodeBuffer has not changed
if ADocFile.DocErrorMsg<>'' then begin
if not (chofQuiet in Flags) then begin
// for example: Filename(y,x) Error: description
IDEMessagesWindow.AddMsg(ADocFile.DocErrorMsg,
ExtractFilePath(ADocFile.CodeBuffer.Filename),-1);
end;
// no update needed
exit(chprFailed);
end;
if ADocFile.DocModified and (chofRevert in Flags) then begin
// revert the modifications => rebuild the Doc from the CodeBuffer
end else begin
// no update needed
exit(chprSuccess);
end;
end;
CacheWasUsed:=false;
{$IFDEF VerboseLazDoc}
DebugLn(['TCodeHelpManager.LoadFPDocFile parsing ',ADocFile.Filename]);
{$ENDIF}
CallDocChangeEvents(chmhDocChanging,ADocFile);
// parse XML
ADocFile.ChangeStep:=ADocFile.CodeBuffer.ChangeStep;
ADocFile.DocModified:=false;
ADocFile.DocErrorMsg:='Unknown error';
FreeAndNil(ADocFile.Doc);
CurFilename:=ADocFile.CodeBuffer.Filename;
MemStream:=TMemoryStream.Create;
try
ADocFile.CodeBuffer.SaveToStream(MemStream);
MemStream.Position:=0;
Result:=chprFailed;
try
ReadXMLFile(ADocFile.Doc,MemStream,CurFilename);
ADocFile.DocErrorMsg:='';
Result:=chprSuccess;
except
on E: EXMLReadError do begin
ADocFile.DocErrorMsg:=E.Message;
DebugLn(['TCodeHelpManager.LoadFPDocFile ',E.Message]);
if not (chofQuiet in Flags) then begin
// for example: Filename(y,x) Error: description
IDEMessagesWindow.AddMsg(ADocFile.DocErrorMsg,ExtractFilePath(CurFilename),-1);
end;
end;
on E: Exception do begin
ADocFile.DocErrorMsg:='Error reading xml file "'+CurFilename+'" '+E.Message;
DebugLn(['TCodeHelpManager.LoadFPDocFile '+ADocFile.DocErrorMsg]);
if not (chofQuiet in Flags) then begin
MessageDlg(lisErrorReadingXML,
Format(lisErrorReadingXmlFile, ['"', CurFilename,
'"', #13, E.Message]), mtError, [mbCancel], 0);
end;
end;
end;
finally
if Result<>chprSuccess then
FreeAndNil(ADocFile.Doc);
MemStream.Free;
CallDocChangeEvents(chmhDocChanging,ADocFile);
end;
end;
function TCodeHelpManager.SaveFPDocFile(ADocFile: TLazFPDocFile): TModalResult;
var
ms: TMemoryStream;
s: string;
begin
if (not ADocFile.DocModified)
and (ADocFile.ChangeStep=ADocFile.CodeBuffer.ChangeStep)
and (not ADocFile.CodeBuffer.FileOnDiskNeedsUpdate) then begin
DebugLn(['TCodeHelpManager.SaveFPDocFile no save needed: ',ADocFile.Filename]);
exit(mrOk);
end;
if (ADocFile.Doc=nil) then begin
DebugLn(['TCodeHelpManager.SaveFPDocFile no Doc: ',ADocFile.Filename]);
exit(mrOk);
end;
if not FilenameIsAbsolute(ADocFile.Filename) then begin
DebugLn(['TCodeHelpManager.SaveFPDocFile no expanded filename: ',ADocFile.Filename]);
exit(mrCancel);
end;
// write Doc to xml stream
try
ms:=TMemoryStream.Create;
WriteXMLFile(ADocFile.Doc, ms);
ms.Position:=0;
SetLength(s,ms.Size);
if s<>'' then
ms.Read(s[1],length(s));
finally
ms.Free;
end;
// write to CodeBuffer
ADocFile.CodeBuffer.Source:=s;
ADocFile.DocModified:=false;
if ADocFile.CodeBuffer.ChangeStep=ADocFile.ChangeStep then begin
// doc was not really modified => do not save to keep file date
DebugLn(['TCodeHelpManager.SaveFPDocFile Doc was not really modified ',ADocFile.Filename]);
exit(mrOk);
end;
ADocFile.ChangeStep:=ADocFile.CodeBuffer.ChangeStep;
// write to disk
Result:=SaveCodeBuffer(ADocFile.CodeBuffer);
DebugLn(['TCodeHelpManager.SaveFPDocFile saved ',ADocFile.Filename]);
end;
function TCodeHelpManager.GetFPDocFilenameForHelpContext(
Context: TPascalHelpContextList; out CacheWasUsed: boolean): string;
var
i: Integer;
SrcFilename: String;
AnOwner: TObject;
begin
Result:='';
CacheWasUsed:=true;
if Context=nil then exit;
for i:=0 to Context.Count-1 do begin
if Context.Items[i].Descriptor<>pihcFilename then continue;
SrcFilename:=Context.Items[i].Context;
Result:=GetFPDocFilenameForSource(SrcFilename,true,CacheWasUsed,AnOwner);
exit;
end;
end;
function TCodeHelpManager.GetFPDocFilenameForSource(SrcFilename: string;
ResolveIncludeFiles: Boolean; out CacheWasUsed: boolean;
out AnOwner: TObject; CreateIfNotExists: boolean): string;
var
FPDocName: String;
SearchedPaths: string;
function SearchInPath(Paths: string; const BaseDir: string;
out Filename: string): boolean;
var
CurPath: String;
p: Integer;
begin
if Paths='' then exit;
if not IDEMacros.CreateAbsoluteSearchPath(Paths,BaseDir) then exit;
//DebugLn(['SearchInPath START ',Paths]);
if Paths='' then exit;
p:=1;
repeat
CurPath:=GetNextDirectoryInSearchPath(Paths,p);
if CurPath<>'' then begin
CurPath:=CleanAndExpandDirectory(CurPath);
if SearchDirectoryInSearchPath(SearchedPaths,CurPath)<1 then begin
// not yet searched in this directory
SearchedPaths:=SearchedPaths+';'+CurPath;
Filename:=AppendPathDelim(CurPath)+FPDocName;
if FileExistsCached(Filename) then exit(true);
end;
end;
until p>length(Paths);
Filename:='';
Result:=false;
end;
function CheckUnitOwners(CheckSourceDirectories: boolean;
out Filename: string): boolean;
var
PkgList: TFPList;
i: Integer;
APackage: TLazPackage;
BaseDir: String;
AProject: TLazProject;
begin
Result:=false;
Filename:='';
if not FilenameIsAbsolute(SrcFilename) then exit;
if CheckSourceDirectories then begin
PkgList:=PackageEditingInterface.GetPossibleOwnersOfUnit(SrcFilename,[]);
end else begin
PkgList:=PackageEditingInterface.GetOwnersOfUnit(SrcFilename);
end;
// get all packages owning the file
if PkgList=nil then exit;
try
for i:=0 to PkgList.Count-1 do begin
if TObject(PkgList[i]) is TLazProject then begin
AProject:=TLazProject(PkgList[i]);
if AProject.LazDocPaths='' then continue;
BaseDir:=ExtractFilePath(AProject.ProjectInfoFile);
if BaseDir='' then continue;
// add lazdoc paths of project
if SearchInPath(AProject.LazDocPaths,BaseDir,Filename) then begin
AnOwner:=AProject;
exit(true);
end;
end else if TObject(PkgList[i]) is TLazPackage then begin
APackage:=TLazPackage(PkgList[i]);
if APackage.LazDocPaths='' then continue;
BaseDir:=APackage.Directory;
if BaseDir='' then continue;
// add lazdoc paths of package
if SearchInPath(APackage.LazDocPaths,BaseDir,Filename) then begin
AnOwner:=APackage;
exit(true);
end;
end;
end;
finally
PkgList.Free;
end;
end;
function CheckIfInLazarus(out Filename: string): boolean;
var
LazDir: String;
LCLPackage: TLazPackage;
begin
Result:=false;
Filename:='';
if not FilenameIsAbsolute(SrcFilename) then exit;
LazDir:=AppendPathDelim(EnvironmentOptions.LazarusDirectory);
// check LCL
if FileIsInPath(SrcFilename,LazDir+'lcl') then begin
LCLPackage:=PackageGraph.LCLPackage;
if SearchInPath(LCLPackage.LazDocPaths,'',Filename) then
begin
AnOwner:=LCLPackage;
exit(true);
end;
end;
if SearchInPath(EnvironmentOptions.LazDocPaths,'',Filename) then
begin
AnOwner:=nil;
exit(true);
end;
end;
var
CodeBuf: TCodeBuffer;
AVLNode: TAvgLvlTreeNode;
MapEntry: TCHSourceToFPDocFile;
begin
Result:='';
CacheWasUsed:=true;
AnOwner:=nil;
if ResolveIncludeFiles then begin
CodeBuf:=CodeToolBoss.FindFile(SrcFilename);
if CodeBuf<>nil then begin
CodeBuf:=CodeToolBoss.GetMainCode(CodeBuf);
if CodeBuf<>nil then begin
SrcFilename:=CodeBuf.Filename;
end;
end;
end;
if not FilenameIsPascalSource(SrcFilename) then
begin
DebugLn(['TCodeHelpManager.GetFPDocFilenameForSource error: not a source file: "',SrcFilename,'"']);
exit;
end;
try
// first try cache
MapEntry:=nil;
AVLNode:=FSrcToDocMap.FindKey(Pointer(SrcFilename),
@CompareAnsistringWithLDSrc2DocSrcFile);
if AVLNode<>nil then begin
MapEntry:=TCHSourceToFPDocFile(AVLNode.Data);
if (MapEntry.FPDocFilenameTimeStamp=CompilerParseStamp)
and (MapEntry.FilesTimeStamp=FileStateCache.TimeStamp) then begin
AnOwner:=MapEntry.FPDocFileOwner;
Result:=MapEntry.FPDocFilename;
exit;
end;
end;
CacheWasUsed:=false;
{$IFDEF VerboseLazDoc}
DebugLn(['TCodeHelpManager.GetFPDocFilenameForSource searching SrcFilename=',SrcFilename]);
{$ENDIF}
// first check if the file is owned by any project/package
SearchedPaths:='';
FPDocName:=lowercase(ExtractFileNameOnly(SrcFilename))+'.xml';
if (not CheckUnitOwners(false,Result)) // first check if file is owned by a package/project
and (not CheckUnitOwners(true,Result))// then check if the file is in a source directory of a package/project
and (not CheckIfInLazarus(Result))
then begin
// not found
DebugLn(['TCodeHelpManager.GetFPDocFilenameForSource Hint: file without owner: ',SrcFilename]);
end;
// save to cache
if MapEntry=nil then begin
MapEntry:=TCHSourceToFPDocFile.Create;
MapEntry.SourceFilename:=SrcFilename;
FSrcToDocMap.Add(MapEntry);
end;
MapEntry.FPDocFilename:=Result;
MapEntry.FPDocFilenameTimeStamp:=CompilerParseStamp;
MapEntry.FPDocFileOwner:=AnOwner;
MapEntry.FilesTimeStamp:=FileStateCache.TimeStamp;
finally
if (Result='') and CreateIfNotExists then begin
Result:=DoCreateFPDocFileForSource(SrcFilename,AnOwner);
end;
{$IFDEF VerboseLazDoc}
DebugLn(['TCodeHelpManager.GetFPDocFilenameForSource SrcFilename="',SrcFilename,'" Result="',Result,'"']);
{$ENDIF}
end;
{$ifdef VerboseLazDoc}
DebugLn(['TCodeHelpManager.GetFPDocFilenameForSource ',dbgsName(AnOwner)]);
{$endif}
end;
function TCodeHelpManager.GetFPDocFilenameForPkgFile(PkgFile: TPkgFile;
ResolveIncludeFiles: Boolean; out CacheWasUsed: boolean;
CreateIfNotExists: boolean): string;
var
APackage: TLazPackage;
BaseDir: String;
SrcFilename: String;
CodeBuf: TCodeBuffer;
begin
Result:='';
CacheWasUsed:=false;
APackage:=TLazPackage(PkgFile.LazPackage);
if APackage.LazDocPaths='' then exit;
BaseDir:=APackage.Directory;
if BaseDir='' then exit;
SrcFilename:=PkgFile.Filename;
if ResolveIncludeFiles then begin
CodeBuf:=CodeToolBoss.FindFile(SrcFilename);
if CodeBuf<>nil then begin
CodeBuf:=CodeToolBoss.GetMainCode(CodeBuf);
if CodeBuf<>nil then begin
SrcFilename:=CodeBuf.Filename;
end;
end;
end;
if not FilenameIsPascalUnit(SrcFilename) then exit;
SrcFilename:=ExtractFileNameOnly(SrcFilename)+'.xml';
Result:=SearchFileInPath(SrcFilename,BaseDir,APackage.LazDocPaths,';',
ctsfcDefault);
end;
procedure TCodeHelpManager.GetFPDocFilenamesForSources(
SrcFilenames: TStringToStringTree; ResolveIncludeFiles: boolean;
var FPDocFilenames: TStringToStringTree);
var
Node: TAvgLvlTreeNode;
Item: PStringToStringItem;
SrcFilename: String;
CacheWasUsed: boolean;
AnOwner: TObject;
FPDocFilename: String;
begin
Node:=SrcFilenames.Tree.FindLowest;
while Node<>nil do begin
Item:=PStringToStringItem(Node.Data);
SrcFilename:=Item^.Name;
FPDocFilename:=GetFPDocFilenameForSource(SrcFilename,ResolveIncludeFiles,
CacheWasUsed,AnOwner);
//DebugLn(['TCodeHelpManager.GetFPDocFilenamesForSources FPDoc=',FPDocFilename,' Src=',SrcFilename]);
if FPDocFilename<>'' then begin
if FPDocFilenames=nil then
FPDocFilenames:=CreateFilenameToStringTree;
FPDocFilenames[FPDocFilename]:=GetModuleOwnerName(AnOwner);
end;
Node:=SrcFilenames.Tree.FindSuccessor(Node);
end;
end;
function TCodeHelpManager.FindModuleOwner(const Modulename: string): TObject;
var
AProject: TLazProject;
begin
Result:=PackageGraph.FindAPackageWithName(Modulename,nil);
if Result<>nil then exit;
AProject:=LazarusIDE.ActiveProject;
if (AProject<>nil)
and (SysUtils.CompareText(GetModuleOwnerName(AProject),Modulename)=0)
then begin
Result:=AProject;
exit;
end;
Result:=nil;
end;
function TCodeHelpManager.FindModuleOwner(FPDocFile: TLazFPDocFile): TObject;
var
AProject: TLazProject;
Path: String;
p: PChar;
PkgName: String;
function InPackage(Pkg: TLazPackage): boolean;
var
SearchPath: String;
begin
Result:=false;
if (Pkg=nil) or (Pkg.LazDocPaths='') then exit;
// check if the file is in the search path
Path:=ExtractFilePath(FPDocFile.Filename);
SearchPath:=Pkg.LazDocPaths;
if not IDEMacros.CreateAbsoluteSearchPath(SearchPath,Pkg.Directory) then
exit;
SearchPath:=MinimizeSearchPath(SearchPath);
//DebugLn(['InPackage Path="',Path,'" SearchPath="',SearchPath,'"']);
p:=FindPathInSearchPath(PChar(Path),length(Path),
PChar(SearchPath),length(SearchPath));
if p<>nil then begin
FindModuleOwner:=Pkg;
Result:=true;
end;
end;
var
Pkg: TLazPackage;
SearchPath: String;
i: Integer;
begin
Result:=nil;
if FPDocFile=nil then exit;
AProject:=LazarusIDE.ActiveProject;
// virtual files belong to the project
if not FilenameIsAbsolute(FPDocFile.Filename) then begin
Result:=AProject;
exit;
end;
// check if in the doc path of the project
if (AProject<>nil) and (AProject.LazDocPaths<>'') then begin
Path:=ExtractFilePath(FPDocFile.Filename);
SearchPath:=AProject.LazDocPaths;
p:=FindPathInSearchPath(PChar(Path),length(Path),
PChar(SearchPath),length(SearchPath));
if p<>nil then begin
Result:=AProject;
exit;
end;
end;
// check the packagename in the fpdoc file
PkgName:=FPDocFile.GetPackageName;
if PkgName<>'' then begin
Pkg:=PackageGraph.FindAPackageWithName(PkgName,nil);
if InPackage(Pkg) then exit;
end;
// search in all packages
for i:=0 to PackageGraph.Count-1 do
if InPackage(PackageGraph.Packages[i]) then exit;
end;
function TCodeHelpManager.GetModuleOwnerName(TheOwner: TObject): string;
begin
if TheOwner is TLazPackage then
Result:=TLazPackage(TheOwner).Name
else if TheOwner is TLazProject then
Result:=ExtractFileNameOnly(TLazProject(TheOwner).ProjectInfoFile)
else
Result:='';
end;
function TCodeHelpManager.ExpandFPDocLinkID(const LinkID, DefaultUnitName,
DefaultOwnerName: string): string;
begin
Result:=LinkID;
if (LinkID='') or (LinkID[1]='#') then exit;
Result:=ExpandFPDocLinkID(LinkId,DefaultUnitName,
FindModuleOwner(DefaultOwnerName));
end;
function TCodeHelpManager.ExpandFPDocLinkID(const LinkID,
DefaultUnitName: string; TheOwner: TObject): string;
function SearchLazDocFile(SearchPath: string;
const BaseDir, Unitname: string): string;
var
FPDocFilename: String;
begin
Result:='';
if BaseDir='' then exit;
if not IDEMacros.CreateAbsoluteSearchPath(SearchPath,BaseDir) then exit;
FPDocFilename:=lowercase(UnitName)+'.xml';
Result:=SearchFileInPath(FPDocFilename,'',SearchPath,';',ctsfcDefault);
end;
var
FirstPointPos: LongInt;
APackage: TLazPackage;
FirstIdentifier: String;
AddUnit: Boolean;
AProject: TLazProject;
begin
Result:=LinkID;
if (LinkID='') or (LinkID[1]='#') then exit;
FirstPointPos:=System.Pos(LinkID,'.');
FirstIdentifier:=copy(LinkID,1,FirstPointPos);
if (FirstIdentifier<>'')
and (SysUtils.CompareText(FirstIdentifier,DefaultUnitName)<>0) then
begin
// the LinkID has sub identifiers, so the first identifier could be a unit
// But it is not the DefaultUnitName
// => check if it is another unitname of the Owner
AddUnit:=false;
if TheOwner is TLazPackage then begin
APackage:=TLazPackage(TheOwner);
if (APackage.FindUnit(FirstIdentifier)=nil) then begin
// the unit is not owned.
if SearchLazDocFile(APackage.LazDocPaths,APackage.Directory,
FirstIdentifier)='' then
begin
// and there is no fpdoc file for this identifier
// => not a unit
AddUnit:=true;
end;
end;
end else if TheOwner is TLazProject then begin
AProject:=TLazProject(TheOwner);
if SearchLazDocFile(AProject.LazDocPaths,
ExtractFilePath(AProject.ProjectInfoFile),FirstIdentifier)='' then
begin
// there is no fpdoc file for this identifier
// => not a unit
AddUnit:=true;
end;
end else begin
// unknown owner type
exit;
end;
if AddUnit then
Result:=DefaultUnitName+'.'+Result;
end;
Result:='#'+GetModuleOwnerName(TheOwner)+'.'+Result;
end;
function TCodeHelpManager.CodeNodeToElementName(Tool: TFindDeclarationTool;
CodeNode: TCodeTreeNode): string;
var
NodeName: String;
begin
Result:='';
if CodeNode.Desc in AllSourceTypes then begin
Result:=Tool.ExtractSourceName;
end else begin
while CodeNode<>nil do begin
case CodeNode.Desc of
ctnVarDefinition, ctnConstDefinition, ctnTypeDefinition, ctnGenericType:
NodeName:=Tool.ExtractDefinitionName(CodeNode);
ctnProperty:
NodeName:=Tool.ExtractPropName(CodeNode,false);
ctnProcedure:
NodeName:=Tool.ExtractProcName(CodeNode,[]);
ctnEnumIdentifier:
NodeName:=GetIdentifier(@Tool.Src[CodeNode.StartPos]);
ctnIdentifier:
if Tool.NodeIsResultType(CodeNode) then
NodeName:='Result';
else NodeName:='';
end;
if NodeName<>'' then begin
if Result<>'' then
Result:='.'+Result;
Result:=NodeName+Result;
end;
CodeNode:=CodeNode.Parent;
end;
end;
end;
function TCodeHelpManager.GetFPDocNode(Tool: TCodeTool; CodeNode: TCodeTreeNode;
Complete: boolean; out FPDocFile: TLazFPDocFile; out DOMNode: TDOMNode;
out CacheWasUsed: boolean): TCodeHelpParseResult;
var
SrcFilename: String;
FPDocFilename: String;
ElementName: String;
AnOwner: TObject;
begin
FPDocFile:=nil;
DOMNode:=nil;
CacheWasUsed:=true;
// find corresponding FPDoc file
SrcFilename:=Tool.MainFilename;
FPDocFilename:=GetFPDocFilenameForSource(SrcFilename,false,CacheWasUsed,AnOwner);
if FPDocFilename='' then exit(chprFailed);
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
// load FPDoc file
Result:=LoadFPDocFile(FPDocFilename,[chofUpdateFromDisk],FPDocFile,CacheWasUsed);
if Result<>chprSuccess then exit;
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
// find FPDoc node
ElementName:=CodeNodeToElementName(Tool,CodeNode);
if ElementName='' then exit(chprFailed);
DOMNode:=FPDocFile.GetElementWithName(ElementName);
if DOMNode=nil then exit(chprFailed);
Result:=chprSuccess;
end;
function TCodeHelpManager.GetLinkedFPDocNode(StartFPDocFile: TLazFPDocFile;
StartDOMNode: TDOMNode; const Path: string; Flags: TCodeHelpOpenFileFlags;
out ModuleOwner: TObject; out FPDocFile: TLazFPDocFile; out DOMNode: TDOMNode;
out InvalidPath: integer; out CacheWasUsed: boolean): TCodeHelpParseResult;
function FindFPDocFilename(BaseDir, SearchPath, UnitName: string): string;
begin
Result:='';
if not IDEMacros.CreateAbsoluteSearchPath(SearchPath,BaseDir) then exit;
//DebugLn(['FindFPDocFilename BaseDir=',BaseDir,' SearchPath=',SearchPath,' UnitName=',unitname]);
Result:=SearchFileInPath(UnitName+'.xml',BaseDir,SearchPath,';',ctsfcDefault);
end;
function FindElement(StartPos: integer; aFPDocFile: TLazFPDocFile): boolean;
var
ElementName: String;
p: integer;
begin
p:=length(Path)+1;
while p>StartPos do begin
ElementName:=copy(Path,StartPos,p-StartPos);
//DebugLn(['TCodeHelpManager.GetLinkedFPDocNode ElementName=',ElementName]);
DOMNode:=aFPDocFile.GetElementWithName(ElementName);
if DOMNode<>nil then begin
InvalidPath:=p;
if p>length(Path) then
GetLinkedFPDocNode:=chprSuccess
else
GetLinkedFPDocNode:=chprFailed;
FPDocFile:=aFPDocFile;
exit(true);
end;
dec(p);
while (p>StartPos) and (Path[p]<>'.') do dec(p);
end;
Result:=false;
end;
var
StartPos, p: LongInt;
PkgName: String;
Pkg: TLazPackage;
UnitName: String;
AProject: TLazProject;
FPDocFilename: String;
BaseDir: String;
begin
ModuleOwner:=nil;
FPDocFile:=nil;
DOMNode:=nil;
InvalidPath:=0;
CacheWasUsed:=false;
Result:=chprFailed;
//DebugLn(['TCodeHelpManager.GetLinkedFPDocNode Path="',Path,'"']);
if Path='' then exit;
if StartDOMNode=nil then ; // for future use
StartPos:=1;
p:=1;
if Path[1]='#' then begin
// switch package
while (p<=length(Path)) and (Path[p]<>'.') do inc(p);
PkgName:=copy(Path,2,p-2);
//DebugLn(['TCodeHelpManager.GetLinkedFPDocNode PkgName=',PkgName]);
if PkgName='' then exit;
Pkg:=PackageGraph.FindAPackageWithName(PkgName,nil);
if Pkg=nil then exit;
InvalidPath:=p;
ModuleOwner:=Pkg;
if p>length(Path) then begin
// link to the module, no unit
Result:=chprSuccess;
exit;
end;
StartPos:=p+1;
p:=StartPos;
end else begin
// relative link (either in the same fpdoc file or of the same module)
// use same package
ModuleOwner:=FindModuleOwner(StartFPDocFile);
if ModuleOwner=nil then exit;
// try in the same fpdoc file
if FindElement(StartPos,StartFPDocFile) then exit;
end;
// search in another unit
while (p<=length(Path)) and (Path[p]<>'.') do inc(p);
UnitName:=copy(Path,StartPos,p-StartPos);
//DebugLn(['TCodeHelpManager.GetLinkedFPDocNode UnitName=',UnitName]);
if UnitName='' then exit;
FPDocFilename:='';
if ModuleOwner is TLazProject then begin
AProject:=TLazProject(ModuleOwner);
if (AProject.LazDocPaths<>'') then begin
BaseDir:=ExtractFilePath(AProject.ProjectInfoFile);
FPDocFilename:=FindFPDocFilename(BaseDir,AProject.LazDocPaths,UnitName);
end;
end else if ModuleOwner is TLazPackage then begin
Pkg:=TLazPackage(ModuleOwner);
if Pkg.LazDocPaths<>'' then begin
BaseDir:=Pkg.Directory;
FPDocFilename:=FindFPDocFilename(BaseDir,Pkg.LazDocPaths,UnitName);
end;
end;
//DebugLn(['TCodeHelpManager.GetLinkedFPDocNode FPDocFilename=',FPDocFilename]);
if FPDocFilename='' then exit;
// load FPDocFile
Result:=LoadFPDocFile(FPDocFilename,Flags,FPDocFile,CacheWasUsed);
if Result<>chprSuccess then exit;
InvalidPath:=p;
if p>length(Path) then begin
// link to a unit, no element
Result:=chprSuccess;
exit;
end;
StartPos:=p+1;
// find element
if FindElement(StartPos,FPDocFile) then exit;
Result:=chprFailed;
end;
function TCodeHelpManager.GetDeclarationChain(Code: TCodeBuffer; X, Y: integer;
out ListOfPCodeXYPosition: TFPList; out CacheWasUsed: boolean
): TCodeHelpParseResult;
begin
if FDeclarationCache.FindDeclarations(Code,X,Y,ListOfPCodeXYPosition,
CacheWasUsed)
then
Result:=chprSuccess
else
Result:=chprFailed;
end;
function TCodeHelpManager.GetCodeContext(CodePos: PCodeXYPosition; out
FindContext: TFindContext; Complete: boolean; out CacheWasUsed: boolean
): TCodeHelpParseResult;
var
CurTool: TCodeTool;
CleanPos: integer;
Node: TCodeTreeNode;
begin
Result:=chprFailed;
FindContext:=CleanFindContext;
CacheWasUsed:=true;
//DebugLn(['TCodeHelpManager.GetElementChain i=',i,' X=',CodePos^.X,' Y=',CodePos^.Y]);
if (CodePos=nil) or (CodePos^.Code=nil) or (CodePos^.X<1) or (CodePos^.Y<1)
then begin
DebugLn(['TCodeHelpManager.GetElementChain invalid CodePos']);
exit;
end;
// build CodeTree and find node
if not CodeToolBoss.Explore(CodePos^.Code,CurTool,false,true) then begin
DebugLn(['TCodeHelpManager.GetElementChain note: there was a parser error']);
end;
if CurTool=nil then begin
DebugLn(['TCodeHelpManager.GetElementChain explore failed']);
exit;
end;
if CurTool.CaretToCleanPos(CodePos^,CleanPos)<>0 then begin
DebugLn(['TCodeHelpManager.GetElementChain invalid CodePos']);
exit;
end;
Node:=CurTool.FindDeepestNodeAtPos(CleanPos,false);
if Node=nil then begin
DebugLn(['TCodeHelpManager.GetElementChain node not found']);
exit;
end;
// use only definition nodes
if (Node.Desc=ctnProcedureHead) then begin
if CurTool.PositionInFuncResultName(Node,CleanPos)
and (Node.LastChild<>nil) and (Node.LastChild.Desc=ctnIdentifier) then begin
// cursor on function result
// use the result type node
Node:=Node.LastChild;
end else if (Node.Parent<>nil) and (Node.Parent.Desc=ctnProcedure) then
Node:=Node.Parent;
end;
if (not (Node.Desc in
(AllIdentifierDefinitions+AllSourceTypes
+[ctnProperty,ctnProcedure,ctnEnumIdentifier])))
and (not CurTool.NodeIsResultType(Node))
then begin
DebugLn(['TCodeHelpManager.GetElementChain ignoring node ',Node.DescAsString]);
exit;
end;
if (CurTool.NodeIsForwardDeclaration(Node)) then begin
DebugLn(['TCodeHelpManager.GetElementChain ignoring forward']);
exit;
end;
// success
FindContext.Tool:=CurTool;
FindContext.Node:=Node;
Result:=chprSuccess;
end;
function TCodeHelpManager.GetElementChain(Code: TCodeBuffer; X, Y: integer;
Complete: boolean; out Chain: TCodeHelpElementChain; out CacheWasUsed: boolean
): TCodeHelpParseResult;
var
ListOfPCodeXYPosition: TFPList;
i: Integer;
CodePos: PCodeXYPosition;
CHElement: TCodeHelpElement;
FPDocFilename: String;
FindContext: TFindContext;
AnOwner: TObject;
begin
Chain:=nil;
ListOfPCodeXYPosition:=nil;
try
//DebugLn(['TCodeHelpManager.GetElementChain GetDeclarationChain...']);
// get the declaration chain
Result:=GetDeclarationChain(Code,X,Y,ListOfPCodeXYPosition,CacheWasUsed);
if Result<>chprSuccess then begin
{$IFDEF VerboseLazDocFails}
DebugLn(['TCodeHelpManager.GetElementChain GetDeclarationChain failed ',Code.Filename,' x=',x,' y=',y]);
{$ENDIF}
exit;
end;
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
{$IFDEF VerboseLazDoc}
DebugLn(['TCodeHelpManager.GetElementChain init the element chain: ListOfPCodeXYPosition.Count=',ListOfPCodeXYPosition.Count,' ...']);
{$ENDIF}
// init the element chain
Result:=chprParsing;
Chain:=TCodeHelpElementChain.Create;
Chain.CodePos.Code:=Code;
Chain.MakeValid;
Code.LineColToPosition(Y,X,Chain.CodePos.P);
// fill the element chain
for i:=0 to ListOfPCodeXYPosition.Count-1 do begin
// get source position of declaration
CodePos:=PCodeXYPosition(ListOfPCodeXYPosition[i]);
Result:=GetCodeContext(CodePos,FindContext,Complete,CacheWasUsed);
if Result=chprFailed then continue; // skip invalid contexts
if Result<>chprSuccess then continue;
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
// add element
CHElement:=Chain.Add;
CHElement.CodeXYPos:=CodePos^;
CHElement.CodeContext:=FindContext;
//DebugLn(['TCodeHelpManager.GetElementChain i=',i,' CodeContext=',FindContextToString(CHElement.CodeContext)]);
// find corresponding FPDoc file
CHElement.ElementUnitFileName:=CHElement.CodeContext.Tool.MainFilename;
CHElement.ElementUnitName:=CHElement.CodeContext.Tool.GetSourceName(false);
AnOwner:=Self;
FPDocFilename:=GetFPDocFilenameForSource(CHElement.ElementUnitFileName,
false,CacheWasUsed,AnOwner);
CHElement.ElementOwnerName:=GetModuleOwnerName(AnOwner);
//DebugLn(['TCodeHelpManager.GetElementChain FPDocFilename=',FPDocFilename]);
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
if FPDocFilename<>'' then begin
// load FPDoc file
LoadFPDocFile(FPDocFilename,[chofUpdateFromDisk],CHElement.FPDocFile,
CacheWasUsed);
if (not CacheWasUsed) and (not Complete) then exit(chprParsing);
end;
end;
// get fpdoc nodes
for i:=0 to Chain.Count-1 do begin
CHElement:=Chain[i];
// get fpdoc element path
CHElement.ElementName:=CodeNodeToElementName(CHElement.CodeContext.Tool,
CHElement.CodeContext.Node);
//DebugLn(['TCodeHelpManager.GetElementChain i=',i,' Element=',CHElement.ElementName]);
// get fpdoc node
if (CHElement.FPDocFile<>nil) and (CHElement.ElementName<>'') then begin
CHElement.ElementNode:=
CHElement.FPDocFile.GetElementWithName(CHElement.ElementName);
CHElement.ElementNodeValid:=true;
end;
//DebugLn(['TCodeHelpManager.GetElementChain ElementNode=',CHElement.ElementNode<>nil]);
end;
Result:=chprSuccess;
finally
if Result<>chprSuccess then
FreeAndNil(Chain);
end;
end;
function TCodeHelpManager.GetHTMLHint(Code: TCodeBuffer; X, Y: integer;
Options: TCodeHelpHintOptions; out BaseURL, HTMLHint: string; out CacheWasUsed: boolean
): TCodeHelpParseResult;
const
le = '<BR>'+LineEnding;
var
IsHTML: boolean;
function EndNow(var LastResult: TCodeHelpParseResult): boolean;
begin
if LastResult<>chprSuccess then
begin
Result:=true;
if HTMLHint<>'' then
LastResult:=chprSuccess
else
LastResult:=chprFailed;
exit;
end;
if (not CacheWasUsed) and not(chhoComplete in Options) then
begin
Result:=true;
LastResult:=chprParsing;
end;
Result:=false;
end;
function TextToHTML(const s: string): string;
var
p: Integer;
EndPos: Integer;
begin
Result:=s;
// replace line breaks with <BR>
p:=1;
while (p<=length(Result)) do begin
if Result[p] in [#10,#13] then begin
EndPos:=p+1;
if (EndPos<=length(Result)) and (Result[EndPos] in [#10,#13]) then
inc(EndPos);
Result:=copy(Result,1,p-1)+le+copy(Result,EndPos,length(Result));
inc(p,length(le));
end else begin
inc(p);
end;
end;
end;
procedure AddText(const s: string);
begin
if IsHTML then
HTMLHint:=HTMLHint+le+le+TextToHTML(s)
else begin
if HTMLHint<>'' then
HTMLHint:=HTMLHint+LineEnding+LineEnding;
HTMLHint:=HTMLHint+s;
end;
end;
procedure AddHTML(const s: string);
begin
if not IsHTML then begin
IsHTML:=true;
if HTMLHint<>'' then
HTMLHint:=TextToHTML(HTMLHint)+le;
end;
if HTMLHint<>'' then
HTMLHint:=HTMLHint+le;
HTMLHint:=HTMLHint+s;
end;
var
Chain: TCodeHelpElementChain;
i: Integer;
Item: TCodeHelpElement;
NodeValues: TFPDocElementValues;
ListOfPCodeXYPosition: TFPList;
CodeXYPos: PCodeXYPosition;
CommentStart: integer;
NestedComments: Boolean;
CommentStr: String;
ItemAdded: Boolean;
CommentCode: TCodeBuffer;
j: Integer;
{$ifdef VerboseHints}
f: TFPDocItem;
{$endif}
begin
{$ifdef VerboseHints}
DebugLn(['TCodeHelpManager.GetHint ',Code.Filename,' ',X,',',Y]);
{$endif}
BaseURL:='lazdoc://';
IsHTML:=false;
try
if chhoSmartHint in Options then
HTMLHint := CodeToolBoss.FindSmartHint(Code,X,Y)
else
HTMLHint := '';
CacheWasUsed:=true;
Chain:=nil;
ListOfPCodeXYPosition:=nil;
try
{$ifdef VerboseHints}
DebugLn(['TCodeHelpManager.GetHint GetElementChain...']);
{$endif}
Result := GetElementChain(Code, X, Y, chhoComplete in Options, Chain, CacheWasUsed);
if EndNow(Result) then exit;
if Chain <> nil then
begin
for i := 0 to Chain.Count - 1 do
begin
Item:=Chain[i];
ItemAdded:=false;
{$ifdef VerboseHints}
DebugLn(['TCodeHelpManager.GetHint ',i,' Element=',Item.ElementName]);
{$endif}
if Item.ElementNode<>nil then
begin
NodeValues:=Item.FPDocFile.GetValuesFromNode(Item.ElementNode);
{$ifdef VerboseHints}
for f:=Low(TFPDocItem) to High(TFPDocItem) do
DebugLn(['TCodeHelpManager.GetHint ',FPDocItemNames[f],' ',NodeValues[f]]);
{$endif}
if NodeValues[fpdiShort]<>'' then
begin
AddHTML('<B>' + Item.ElementName + '</B>' + le + NodeValues[fpdiShort]);
ItemAdded:=true;
end;
end;
// Add comments
if chhoComments in Options then
begin
FreeListOfPCodeXYPosition(ListOfPCodeXYPosition);
if CodeToolBoss.GetPasDocComments(Item.CodeXYPos.Code,
Item.CodeXYPos.X, Item.CodeXYPos.Y, ListOfPCodeXYPosition) and
(ListOfPCodeXYPosition<>nil) then
begin
NestedComments := CodeToolBoss.GetNestedCommentsFlagForFile(
Item.CodeXYPos.Code.Filename);
for j := 0 to ListOfPCodeXYPosition.Count - 1 do
begin
CodeXYPos := PCodeXYPosition(ListOfPCodeXYPosition[j]);
CommentCode := CodeXYPos^.Code;
CommentCode.LineColToPosition(CodeXYPos^.Y,CodeXYPos^.X,CommentStart);
if (CommentStart<1) or (CommentStart>CommentCode.SourceLength)
then
continue;
CommentStr:=ExtractCommentContent(CommentCode.Source,CommentStart,
NestedComments,true,true,true);
if CommentStr <> '' then
begin
if not ItemAdded then
begin
AddText(Item.ElementName+LineEnding
+CommentStr);
end else
begin
AddText(CommentStr);
end;
ItemAdded := true;
end;
end;
end;
end;
end;
end;
Result:=chprSuccess;
finally
FreeListOfPCodeXYPosition(ListOfPCodeXYPosition);
Chain.Free;
end;
finally
if IsHTML then
HTMLHint:='<HTML><BODY>'+HTMLHint+'</BODY></HTML>';
end;
{$ifdef VerboseHints}
DebugLn(['TCodeHelpManager.GetHint END Hint="',HTMLHint,'"']);
{$endif}
end;
function TCodeHelpManager.CreateElement(Code: TCodeBuffer; X, Y: integer;
out Element: TCodeHelpElement): Boolean;
var
CacheWasUsed: boolean;
FPDocFilename: String;
AnOwner: TObject;
CHResult: TCodeHelpParseResult;
begin
Result:=false;
Element:=nil;
if Code=nil then begin
DebugLn(['TCodeHelpManager.CreateElement failed Code=nil']);
exit;
end;
DebugLn(['TCodeHelpManager.CreateElement START ',Code.Filename,' ',X,',',Y]);
Element:=TCodeHelpElement.Create;
try
// check if code context can have a fpdoc element
Element.CodeXYPos.Code:=Code;
Element.CodeXYPos.X:=X;
Element.CodeXYPos.Y:=Y;
if GetCodeContext(@Element.CodeXYPos,Element.CodeContext,true,
CacheWasUsed)<>chprSuccess then
begin
DebugLn(['TCodeHelpManager.CreateElement GetCodeContext failed for ',Code.Filename,' ',X,',',Y]);
exit;
end;
Element.ElementName:=CodeNodeToElementName(Element.CodeContext.Tool,
Element.CodeContext.Node);
DebugLn(['TCodeHelpManager.CreateElement Element.ElementName=',Element.ElementName]);
// find / create fpdoc file
Element.ElementUnitFileName:=Element.CodeContext.Tool.MainFilename;
Element.ElementUnitName:=Element.CodeContext.Tool.GetSourceName(false);
FPDocFilename:=GetFPDocFilenameForSource(Element.ElementUnitFileName,false,
CacheWasUsed,AnOwner,true);
if FPDocFilename='' then begin
// no fpdoc file
DebugLn(['TCodeHelpManager.CreateElement unable to create fpdoc file for ',FPDocFilename]);
end;
DebugLn(['TCodeHelpManager.CreateElement FPDocFilename=',FPDocFilename]);
// parse fpdoc file
CHResult:=LoadFPDocFile(FPDocFilename,[chofUpdateFromDisk],
Element.FPDocFile,CacheWasUsed);
if CHResult<>chprSuccess then begin
DebugLn(['TCodeHelpManager.CreateElement unable to load fpdoc file ',FPDocFilename]);
exit;
end;
Element.ElementNode:=Element.FPDocFile.GetElementWithName(
Element.ElementName,true);
Result:=Element.ElementNode<>nil;
finally
if not Result then
FreeAndNil(Element);
end;
end;
procedure TCodeHelpManager.FreeDocs;
var
AVLNode: TAvgLvlTreeNode;
begin
AVLNode:=FDocs.FindLowest;
while AVLNode<>nil do begin
CallDocChangeEvents(chmhDocChanging,TLazFPDocFile(AVLNode.Data));
AVLNode:=FDocs.FindSuccessor(AVLNode);
end;
FDocs.FreeAndClear;
end;
procedure TCodeHelpManager.ClearSrcToDocMap;
begin
FSrcToDocMap.FreeAndClear;
end;
procedure TCodeHelpManager.RemoveAllHandlersOfObject(AnObject: TObject);
var
HandlerType: TCodeHelpManagerHandler;
begin
for HandlerType:=Low(TCodeHelpManagerHandler) to High(TCodeHelpManagerHandler) do
FHandlers[HandlerType].RemoveAllMethodsOfObject(AnObject);
end;
procedure TCodeHelpManager.AddHandlerOnChanging(
const OnDocChangingEvent: TCodeHelpChangeEvent; AsLast: boolean);
begin
AddHandler(chmhDocChanging,TMethod(OnDocChangingEvent),AsLast);
end;
procedure TCodeHelpManager.RemoveHandlerOnChanging(
const OnDocChangingEvent: TCodeHelpChangeEvent);
begin
RemoveHandler(chmhDocChanging,TMethod(OnDocChangingEvent));
end;
procedure TCodeHelpManager.AddHandlerOnChanged(
const OnDocChangedEvent: TCodeHelpChangeEvent; AsLast: boolean);
begin
AddHandler(chmhDocChanged,TMethod(OnDocChangedEvent),AsLast);
end;
procedure TCodeHelpManager.RemoveHandlerOnChanged(
const OnDocChangedEvent: TCodeHelpChangeEvent);
begin
RemoveHandler(chmhDocChanged,TMethod(OnDocChangedEvent));
end;
{ TCodeHelpElementChain }
function TCodeHelpElementChain.GetCount: integer;
begin
Result:=FItems.Count;
end;
function TCodeHelpElementChain.GetItems(Index: integer): TCodeHelpElement;
begin
Result:=TCodeHelpElement(FItems[Index]);
end;
function TCodeHelpElementChain.Add: TCodeHelpElement;
begin
Result:=TCodeHelpElement.Create;
FItems.Add(Result);
end;
constructor TCodeHelpElementChain.Create;
begin
FItems:=TFPList.Create;
end;
destructor TCodeHelpElementChain.Destroy;
begin
Clear;
FreeAndNil(FItems);
inherited Destroy;
end;
procedure TCodeHelpElementChain.Clear;
var
i: Integer;
begin
for i:=0 to FItems.Count-1 do TObject(FItems[i]).Free;
FItems.Clear;
end;
function TCodeHelpElementChain.IndexOfFile(AFile: TLazFPDocFile): integer;
begin
Result:=FItems.Count-1;
while (Result>=0) do begin
if Items[Result].FPDocFile=AFile then exit;
dec(Result);
end;
end;
function TCodeHelpElementChain.IsValid: boolean;
begin
Result:=(IDEChangeStep=CompilerParseStamp)
and (CodetoolsChangeStep=CodeToolBoss.CodeTreeNodesDeletedStep);
//DebugLn(['TCodeHelpElementChain.IsValid Result=',Result,' IDEChangeStep=',IDEChangeStep,' CompilerParseStamp=',CompilerParseStamp,' CodetoolsChangeStep=',CodetoolsChangeStep,' CodeToolBoss.CodeTreeNodesDeletedStep=',CodeToolBoss.CodeTreeNodesDeletedStep]);
end;
procedure TCodeHelpElementChain.MakeValid;
begin
IDEChangeStep:=CompilerParseStamp;
CodetoolsChangeStep:=CodeToolBoss.CodeTreeNodesDeletedStep;
end;
function TCodeHelpElementChain.DocFile: TLazFPDocFile;
begin
Result:=nil;
if (Count>0) then
Result:=Items[0].FPDocFile;
end;
procedure TCodeHelpElementChain.WriteDebugReport;
var
Line, Column: integer;
i: Integer;
begin
CodePos.Code.AbsoluteToLineCol(CodePos.P,Line,Column);
DebugLn(['TCodeHelpElementChain.WriteDebugReport ',CodePos.Code.Filename,' X=',Column,' Y=',Line,' IDEChangeStep=',IDEChangeStep,' CodetoolsChangeStep=',CodetoolsChangeStep]);
for i:=0 to Count-1 do
Items[i].WriteDebugReport;
end;
{ TLazFPDocNode }
constructor TLazFPDocNode.Create(AFile: TLazFPDocFile; ANode: TDOMNode);
begin
Node:=ANode;
DocFile:=AFile;
end;
{ TCodeHelpElement }
procedure TCodeHelpElement.WriteDebugReport;
begin
DebugLn([' ',CodeXYPos.Code.Filename,' X=',CodeXYPos.X,' Y=',CodeXYPos.Y,' ElementOwnerName=',ElementOwnerName,' ElementUnitName=',ElementUnitName,' ElementUnitFileName=',ElementUnitFileName,' ElementName=',ElementName]);
end;
end.
|