/usr/include/xercesc/parsers/AbstractDOMParser.hpp is in libxerces-c2-dev 2.8.0+deb1-2build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id: AbstractDOMParser.hpp 568078 2007-08-21 11:43:25Z amassari $
*
*/
#if !defined(ABSTRACTDOMPARSER_HPP)
#define ABSTRACTDOMPARSER_HPP
#include <xercesc/dom/DOMDocument.hpp>
#include <xercesc/framework/XMLDocumentHandler.hpp>
#include <xercesc/framework/XMLErrorReporter.hpp>
#include <xercesc/framework/XMLEntityHandler.hpp>
#include <xercesc/util/SecurityManager.hpp>
#include <xercesc/util/ValueStackOf.hpp>
#include <xercesc/validators/DTD/DocTypeHandler.hpp>
#include <xercesc/dom/DOMDocumentType.hpp>
#include <xercesc/validators/DTD/DTDElementDecl.hpp>
#include <xercesc/framework/XMLBufferMgr.hpp>
#include <xercesc/framework/psvi/PSVIHandler.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class XMLPScanToken;
class XMLScanner;
class XMLValidator;
class DOMDocumentImpl;
class DOMDocumentTypeImpl;
class DOMElement;
class GrammarResolver;
class XMLGrammarPool;
class PSVIHandler;
/**
* This class implements the Document Object Model (DOM) interface.
* It is used as a base for DOM parsers (i.e. XercesDOMParser, DOMBuilder).
*/
class PARSERS_EXPORT AbstractDOMParser :
public XMemory
, public XMLDocumentHandler
, public XMLErrorReporter
, public XMLEntityHandler
, public DocTypeHandler
, public PSVIHandler
{
public :
// -----------------------------------------------------------------------
// Class types
// -----------------------------------------------------------------------
/** @name Public constants */
//@{
/** ValScheme enum used in setValidationScheme
* Val_Never: Do not report validation errors.
* Val_Always: The parser will always report validation errors.
* Val_Auto: The parser will report validation errors only if a grammar is specified.
*
* @see #setValidationScheme
*/
enum ValSchemes
{
Val_Never
, Val_Always
, Val_Auto
};
//@}
// -----------------------------------------------------------------------
// Constructors and Detructor
// -----------------------------------------------------------------------
/** @name Destructor */
//@{
/**
* Destructor
*/
virtual ~AbstractDOMParser();
//@}
// -----------------------------------------------------------------------
// Utility methods
// -----------------------------------------------------------------------
/** @name Utility methods */
//@{
/** Reset the parser
*
* This method resets the state of the DOM driver and makes
* it ready for a fresh parse run.
*/
void reset();
/** Adopt the DOM document
*
* This method returns the DOMDocument object representing the
* root of the document tree.
*
* The caller will adopt the DOMDocument and thus is responsible to
* call DOMDocument::release() to release the associated memory.
* The parser will not delete it. The ownership is transferred
* from the parser to the caller.
*
* @return The adopted DOMDocument object which represents the entire
* XML document.
*/
DOMDocument* adoptDocument();
//@}
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
/** @name Getter methods */
//@{
/** Get the DOM document
*
* This method returns the DOMDocument object representing the
* root of the document tree. This object provides the primary
* access to the document's data.
*
* The returned DOMDocument object is owned by the parser.
*
* @return The DOMDocument object which represents the entire
* XML document.
*/
DOMDocument* getDocument();
/** Get a const reference to the validator
*
* This method returns a reference to the parser's installed
* validator.
*
* @return A const reference to the installed validator object.
*/
const XMLValidator& getValidator() const;
/**
* This method returns an enumerated value that indicates the current
* validation scheme set on this parser.
*
* @return The ValSchemes value current set on this parser.
* @see #setValidationScheme
*/
ValSchemes getValidationScheme() const;
/** Get the 'do schema' flag
*
* This method returns the state of the parser's schema processing
* flag.
*
* @return true, if the parser is currently configured to
* understand schema, false otherwise.
*
* @see #setDoSchema
*/
bool getDoSchema() const;
/** Get the 'full schema constraint checking' flag
*
* This method returns the state of the parser's full schema constraint
* checking flag.
*
* @return true, if the parser is currently configured to
* have full schema constraint checking, false otherwise.
*
* @see #setValidationSchemaFullChecking
*/
bool getValidationSchemaFullChecking() const;
/** Get the identity constraint checking' flag
*
* This method returns the state of the parser's identity constraint
* checking flag.
*
* @return true, if the parser is currently configured to
* have identity constraint checking, false otherwise.
*
* @see setIdentityConstraintChecking
*/
bool getIdentityConstraintChecking() const;
/** Get error count from the last parse operation.
*
* This method returns the error count from the last parse
* operation. Note that this count is actually stored in the
* scanner, so this method simply returns what the
* scanner reports.
*
* @return number of errors encountered during the latest
* parse operation.
*
*/
int getErrorCount() const;
/** Get the 'do namespaces' flag
*
* This method returns the state of the parser's namespace processing
* flag.
*
* @return true, if the parser is currently configured to
* understand namespaces, false otherwise.
*
* @see #setDoNamespaces
*/
bool getDoNamespaces() const;
/** Get the 'exit on first error' flag
*
* This method returns the state of the parser's
* exit-on-First-Fatal-Error flag. If this flag is true, then the
* parse will exit the first time it sees any non-wellformed XML or
* any validity error. The default state is true.
*
* @return true, if the parser is currently configured to
* exit on the first fatal error, false otherwise.
*
* @see #setExitOnFirstFatalError
*/
bool getExitOnFirstFatalError() const;
/**
* This method returns the state of the parser's
* validation-constraint-fatal flag.
*
* @return true, if the parser is currently configured to
* set validation constraint errors as fatal, false
* otherwise.
*
* @see #setValidationContraintFatal
*/
bool getValidationConstraintFatal() const;
/** Get the 'include entity references' flag
*
* This method returns the flag that specifies whether the parser is
* creating entity reference nodes in the DOM tree being produced.
*
* @return The state of the create entity reference node
* flag.
* @see #setCreateEntityReferenceNodes
*/
bool getCreateEntityReferenceNodes()const;
/** Get the 'include ignorable whitespace' flag.
*
* This method returns the state of the parser's include ignorable
* whitespace flag.
*
* @return 'true' if the include ignorable whitespace flag is set on
* the parser, 'false' otherwise.
*
* @see #setIncludeIgnorableWhitespace
*/
bool getIncludeIgnorableWhitespace() const;
/** Get the set of Namespace/SchemaLocation that is specified externaly.
*
* This method returns the list of Namespace/SchemaLocation that was
* specified using setExternalSchemaLocation.
*
* The parser owns the returned string, and the memory allocated for
* the returned string will be destroyed when the parser is deleted.
*
* To ensure assessiblity of the returned information after the parser
* is deleted, callers need to copy and store the returned information
* somewhere else.
*
* @return a pointer to the list of Namespace/SchemaLocation that was
* specified externally. The pointer spans the same life-time as
* the parser. A null pointer is returned if nothing
* was specified externally.
*
* @see #setExternalSchemaLocation(const XMLCh* const)
*/
XMLCh* getExternalSchemaLocation() const;
/** Get the noNamespace SchemaLocation that is specified externaly.
*
* This method returns the no target namespace XML Schema Location
* that was specified using setExternalNoNamespaceSchemaLocation.
*
* The parser owns the returned string, and the memory allocated for
* the returned string will be destroyed when the parser is deleted.
*
* To ensure assessiblity of the returned information after the parser
* is deleted, callers need to copy and store the returned information
* somewhere else.
*
* @return a pointer to the no target namespace Schema Location that was
* specified externally. The pointer spans the same life-time as
* the parser. A null pointer is returned if nothing
* was specified externally.
*
* @see #setExternalNoNamespaceSchemaLocation(const XMLCh* const)
*/
XMLCh* getExternalNoNamespaceSchemaLocation() const;
/** Get the SecurityManager instance attached to this parser.
*
* This method returns the security manager
* that was specified using setSecurityManager.
*
* The SecurityManager instance must have been specified by the application;
* this should not be deleted until after the parser has been deleted (or
* a new SecurityManager instance has been supplied to the parser).
*
* @return a pointer to the SecurityManager instance
* specified externally. A null pointer is returned if nothing
* was specified externally.
*
* @see #setSecurityManager(const SecurityManager* const)
*/
SecurityManager* getSecurityManager() const;
/** Get the 'Loading External DTD' flag
*
* This method returns the state of the parser's loading external DTD
* flag.
*
* @return false, if the parser is currently configured to
* ignore external DTD completely, true otherwise.
*
* @see #setLoadExternalDTD
* @see #getValidationScheme
*/
bool getLoadExternalDTD() const;
/** Get the 'create comment node' flag
*
* This method returns the flag that specifies whether the parser is
* creating comment nodes in the DOM tree being produced.
*
* @return The state of the create comment node flag.
* @see #setCreateCommentNodes
*/
bool getCreateCommentNodes()const;
/**
* Get the 'calculate src offset flag'
*
* This method returns the state of the parser's src offset calculation
* when parsing an XML document.
*
* @return true, if the parser is currently configured to
* calculate src offsets, false otherwise.
*
* @see #setCalculateSrcOfs
*/
bool getCalculateSrcOfs() const;
/**
* Get the 'force standard uri flag'
*
* This method returns the state if the parser forces standard uri
*
* @return true, if the parser is currently configured to
* force standard uri, i.e. malformed uri will be rejected.
*
* @see #setStandardUriConformant
*/
bool getStandardUriConformant() const;
/**
* This method returns the installed PSVI handler. Suitable
* for 'lvalue' usages.
*
* @return The pointer to the installed PSVI handler object.
*/
PSVIHandler* getPSVIHandler();
/**
* This method returns the installed PSVI handler. Suitable
* for 'rvalue' usages.
*
* @return A const pointer to the installed PSVI handler object.
*/
const PSVIHandler* getPSVIHandler() const;
/** Get the 'associate schema info' flag
*
* This method returns the flag that specifies whether
* the parser is storing schema informations in the element
* and attribute nodes in the DOM tree being produced.
*
* @return The state of the associate schema info flag.
* @see #setCreateSchemaInfo
*/
bool getCreateSchemaInfo() const;
/** Get the 'generate synthetic annotations' flag
*
* @return true, if the parser is currently configured to
* generate synthetic annotations, false otherwise.
* A synthetic XSAnnotation is created when a schema
* component has non-schema attributes but has no
* child annotations so that the non-schema attributes
* can be recovered under PSVI.
*
* @see #setGenerateSyntheticAnnotations
*/
bool getGenerateSyntheticAnnotations() const;
/** Get the 'validate annotations' flag
*
* @return true, if the parser is currently configured to
* validate annotations, false otherwise.
*
* @see #setValidateAnnotations
*/
bool getValidateAnnotations() const;
/** Get the 'ignore annotations' flag
*
* @return true, if the parser is currently configured to
* ignore annotations, false otherwise.
*
* @see #setIgnoreAnnotations
*/
bool getIgnoreAnnotations() const;
/** Get the 'disable default entity resolution' flag
*
* @return true, if the parser is currently configured to
* not perform default entity resolution, false otherwise.
*
* @see #setDisableDefaultEntityResolution
*/
bool getDisableDefaultEntityResolution() const;
/** Get the 'skip DTD validation' flag
*
* @return true, if the parser is currently configured to
* skip DTD validation, false otherwise.
*
* @see #setSkipDTDValidation
*/
bool getSkipDTDValidation() const;
//@}
// -----------------------------------------------------------------------
// Setter methods
// -----------------------------------------------------------------------
/** @name Setter methods */
//@{
/** set the 'generate synthetic annotations' flag
*
* @param newValue The value for specifying whether Synthetic Annotations
* should be generated or not.
* A synthetic XSAnnotation is created when a schema
* component has non-schema attributes but has no
* child annotations so that the non-schema attributes
* can be recovered under PSVI.
*
* @see #getGenerateSyntheticAnnotations
*/
void setGenerateSyntheticAnnotations(const bool newValue);
/** set the 'validlate annotations' flag
*
* @param newValue The value for specifying whether Annotations
* should be validated or not.
*
* @see #getValidateAnnotations
*/
void setValidateAnnotations(const bool newValue);
/** Set the 'do namespaces' flag
*
* This method allows users to enable or disable the parser's
* namespace processing. When set to true, parser starts enforcing
* all the constraints and rules specified by the NameSpace
* specification.
*
* The parser's default state is: false.
*
* @param newState The value specifying whether NameSpace rules should
* be enforced or not.
*
* @see #getDoNamespaces
*/
void setDoNamespaces(const bool newState);
/** Set the 'exit on first error' flag
*
* This method allows users to set the parser's behaviour when it
* encounters the first fatal error. If set to true, the parser
* will exit at the first fatal error. If false, then it will
* report the error and continue processing.
*
* The default value is 'true' and the parser exits on the
* first fatal error.
*
* @param newState The value specifying whether the parser should
* continue or exit when it encounters the first
* fatal error.
*
* @see #getExitOnFirstFatalError
*/
void setExitOnFirstFatalError(const bool newState);
/**
* This method allows users to set the parser's behaviour when it
* encounters a validtion constraint error. If set to true, and the
* the parser will treat validation error as fatal and will exit depends on the
* state of "getExitOnFirstFatalError". If false, then it will
* report the error and continue processing.
*
* Note: setting this true does not mean the validation error will be printed with
* the word "Fatal Error". It is still printed as "Error", but the parser
* will exit if "setExitOnFirstFatalError" is set to true.
*
* <p>The default value is 'false'.</p>
*
* @param newState If true, the parser will exit if "setExitOnFirstFatalError"
* is set to true.
*
* @see #getValidationConstraintFatal
* @see #setExitOnFirstFatalError
*/
void setValidationConstraintFatal(const bool newState);
/** Set the 'include entity references' flag
*
* This method allows the user to specify whether the parser should
* create entity reference nodes in the DOM tree being produced.
* When the 'create' flag is
* true, the parser will create EntityReference nodes in the DOM tree.
* The EntityReference nodes and their child nodes will be read-only.
* When the 'create' flag is false, no EntityReference nodes will be created.
* <p>The replacement text
* of the entity is included in either case, either as a
* child of the Entity Reference node or in place at the location
* of the reference.
* <p>The default value is 'true'.
*
* @param create The new state of the create entity reference nodes
* flag.
* @see #getCreateEntityReferenceNodes
*/
void setCreateEntityReferenceNodes(const bool create);
/** Set the 'include ignorable whitespace' flag
*
* This method allows the user to specify whether a validating parser
* should include ignorable whitespaces as text nodes. It has no effect
* on non-validating parsers which always include non-markup text.
* <p>When set to true (also the default), ignorable whitespaces will be
* added to the DOM tree as text nodes. The method
* DOMText::isIgnorableWhitespace() will return true for those text
* nodes only.
* <p>When set to false, all ignorable whitespace will be discarded and
* no text node is added to the DOM tree. Note: applications intended
* to process the "xml:space" attribute should not set this flag to false.
* And this flag also overrides any schema datateye whitespace facets,
* that is, all ignorable whitespace will be discarded even though
* 'preserve' is set in schema datatype whitespace facets.
*
* @param include The new state of the include ignorable whitespace
* flag.
*
* @see #getIncludeIgnorableWhitespace
*/
void setIncludeIgnorableWhitespace(const bool include);
/**
* This method allows users to set the validation scheme to be used
* by this parser. The value is one of the ValSchemes enumerated values
* defined by this class:
*
* <br> Val_Never - turn off validation
* <br> Val_Always - turn on validation
* <br> Val_Auto - turn on validation if any internal/external
* DTD subset have been seen
*
* <p>The parser's default state is: Val_Never.</p>
*
* @param newScheme The new validation scheme to use.
*
* @see #getValidationScheme
*/
void setValidationScheme(const ValSchemes newScheme);
/** Set the 'do schema' flag
*
* This method allows users to enable or disable the parser's
* schema processing. When set to false, parser will not process
* any schema found.
*
* The parser's default state is: false.
*
* Note: If set to true, namespace processing must also be turned on.
*
* @param newState The value specifying whether schema support should
* be enforced or not.
*
* @see #getDoSchema
*/
void setDoSchema(const bool newState);
/**
* This method allows the user to turn full Schema constraint checking on/off.
* Only takes effect if Schema validation is enabled.
* If turned off, partial constraint checking is done.
*
* Full schema constraint checking includes those checking that may
* be time-consuming or memory intensive. Currently, particle unique
* attribution constraint checking and particle derivation resriction checking
* are controlled by this option.
*
* The parser's default state is: false.
*
* @param schemaFullChecking True to turn on full schema constraint checking.
*
* @see #getValidationSchemaFullChecking
*/
void setValidationSchemaFullChecking(const bool schemaFullChecking);
/**
* This method allows users to enable or disable the parser's identity
* constraint checks.
*
* <p>By default, the parser does identity constraint checks.
* The default value is true.</p>
*
* @param newState The value specifying whether the parser should
* do identity constraint checks or not in the
* input XML document.
*
* @see #getIdentityConstraintChecking
*/
void setIdentityConstraintChecking(const bool newState);
/**
* This method allows the user to specify a list of schemas to use.
* If the targetNamespace of a schema specified using this method matches
* the targetNamespace of a schema occuring in the instance document in
* the schemaLocation attribute, or if the targetNamespace matches the
* namespace attribute of the "import" element, the schema specified by the
* user using this method will be used (i.e., the schemaLocation attribute
* in the instance document or on the "import" element will be effectively ignored).
*
* If this method is called more than once, only the last one takes effect.
*
* The syntax is the same as for schemaLocation attributes in instance
* documents: e.g, "http://www.example.com file_name.xsd". The user can
* specify more than one XML Schema in the list.
*
* @param schemaLocation the list of schemas to use
*
* @see #getExternalSchemaLocation
*/
void setExternalSchemaLocation(const XMLCh* const schemaLocation);
/**
* This method is same as setExternalSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
* @param schemaLocation the list of schemas to use
*
* @see #setExternalSchemaLocation(const XMLCh* const)
*/
void setExternalSchemaLocation(const char* const schemaLocation);
/**
* This method allows the user to specify the no target namespace XML
* Schema Location externally. If specified, the instance document's
* noNamespaceSchemaLocation attribute will be effectively ignored.
*
* If this method is called more than once, only the last one takes effect.
*
* The syntax is the same as for the noNamespaceSchemaLocation attribute
* that may occur in an instance document: e.g."file_name.xsd".
*
* @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #getExternalNoNamespaceSchemaLocation
*/
void setExternalNoNamespaceSchemaLocation(const XMLCh* const noNamespaceSchemaLocation);
/**
* This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
* @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #setExternalNoNamespaceSchemaLocation(const XMLCh* const)
*/
void setExternalNoNamespaceSchemaLocation(const char* const noNamespaceSchemaLocation);
/**
* This allows an application to set a SecurityManager on
* the parser; this object stores information that various
* components use to limit their consumption of system
* resources while processing documents.
*
* If this method is called more than once, only the last one takes effect.
* It may not be reset during a parse.
*
*
* @param securityManager the SecurityManager instance to
* be used by this parser
*
* @see #getSecurityManager
*/
void setSecurityManager(SecurityManager* const securityManager);
/** Set the 'Loading External DTD' flag
*
* This method allows users to enable or disable the loading of external DTD.
* When set to false, the parser will ignore any external DTD completely
* if the validationScheme is set to Val_Never.
*
* The parser's default state is: true.
*
* This flag is ignored if the validationScheme is set to Val_Always or Val_Auto.
*
* @param newState The value specifying whether external DTD should
* be loaded or not.
*
* @see #getLoadExternalDTD
* @see #setValidationScheme
*/
void setLoadExternalDTD(const bool newState);
/** Set the 'create comment nodes' flag
*
* This method allows the user to specify whether the parser should
* create comment nodes in the DOM tree being produced.
* <p>The default value is 'true'.
*
* @param create The new state of the create comment nodes
* flag.
* @see #getCreateCommentNodes
*/
void setCreateCommentNodes(const bool create);
/** Enable/disable src offset calculation
*
* This method allows users to enable/disable src offset calculation.
* Disabling the calculation will improve performance.
*
* The parser's default state is: false.
*
* @param newState The value specifying whether we should enable or
* disable src offset calculation
*
* @see #getCalculateSrcOfs
*/
void setCalculateSrcOfs(const bool newState);
/** Force standard uri
*
* This method allows users to tell the parser to force standard uri conformance.
*
* The parser's default state is: false.
*
* @param newState The value specifying whether the parser should reject malformed URI.
*
* @see #getStandardUriConformant
*/
void setStandardUriConformant(const bool newState);
/** Set the scanner to use when scanning the XML document
*
* This method allows users to set the scanner to use
* when scanning a given XML document.
*
* @param scannerName The name of the desired scanner
*/
void useScanner(const XMLCh* const scannerName);
/** Set the implementation to use when creating the document
*
* This method allows users to set the implementation to use
* to create the document when parseing.
*
* @param implementationFeatures The names of the desired features the implementation should have.
*/
void useImplementation(const XMLCh* const implementationFeatures);
/**
* This method installs the user specified PSVI handler on
* the parser.
*
* @param handler A pointer to the PSVI handler to be called
* when the parser comes across 'PSVI' events
* as per the schema specification.
*/
virtual void setPSVIHandler(PSVIHandler* const handler);
/** Set the 'associate schema info' flag
*
* This method allows users to specify whether
* the parser should store schema informations in the element
* and attribute nodes in the DOM tree being produced.
*
* @return The state of the associate schema info flag.
* @see #getCreateSchemaInfo
*/
void setCreateSchemaInfo(const bool newState);
/** Set the 'ignore annotation' flag
*
* This method gives users the option to not generate XSAnnotations
* when "traversing" a schema.
*
* The parser's default state is false
*
* @param newValue The state to set
*/
void setIgnoreAnnotations(const bool newValue);
/** Set the 'disable default entity resolution' flag
*
* This method gives users the option to not perform default entity
* resolution. If the user's resolveEntity method returns NULL the
* parser will try to resolve the entity on its own. When this option
* is set to true, the parser will not attempt to resolve the entity
* when the resolveEntity method returns NULL.
*
* The parser's default state is false
*
* @param newValue The state to set
*
* @see #entityResolver
*/
void setDisableDefaultEntityResolution(const bool newValue);
/** Set the 'skip DTD validation' flag
*
* This method gives users the option to skip DTD validation only when
* schema validation is on (i.e. when performing validation, we will
* ignore the DTD, except for entities, when schema validation is enabled).
*
* NOTE: This option is ignored if schema validation is disabled.
*
* The parser's default state is false
*
* @param newValue The state to set
*/
void setSkipDTDValidation(const bool newValue);
//@}
// -----------------------------------------------------------------------
// Parsing methods
// -----------------------------------------------------------------------
/** @name Parsing methods */
//@{
/** Parse via an input source object
*
* This method invokes the parsing process on the XML file specified
* by the InputSource parameter. This API is borrowed from the
* SAX Parser interface.
*
* @param source A const reference to the InputSource object which
* points to the XML file to be parsed.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @exception XMLException An exception from the parser or client
* handler code.
* @exception DOMException A DOM exception as per DOM spec.
* @see InputSource#InputSource
*/
void parse(const InputSource& source);
/** Parse via a file path or URL
*
* This method invokes the parsing process on the XML file specified by
* the Unicode string parameter 'systemId'. This method is borrowed
* from the SAX Parser interface.
*
* @param systemId A const XMLCh pointer to the Unicode string which
* contains the path to the XML file to be parsed.
*
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @exception XMLException An exception from the parser or client
* handler code.
* @exception DOMException A DOM exception as per DOM spec.
* @see #parse(InputSource,...)
*/
void parse(const XMLCh* const systemId);
/** Parse via a file path or URL (in the local code page)
*
* This method invokes the parsing process on the XML file specified by
* the native char* string parameter 'systemId'.
*
* @param systemId A const char pointer to a native string which
* contains the path to the XML file to be parsed.
*
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @exception XMLException An exception from the parser or client
* handler code.
* @exception DOMException A DOM exception as per DOM spec.
* @see #parse(InputSource,...)
*/
void parse(const char* const systemId);
/** Begin a progressive parse operation
*
* This method is used to start a progressive parse on a XML file.
* To continue parsing, subsequent calls must be to the parseNext
* method.
*
* It scans through the prolog and returns a token to be used on
* subsequent scanNext() calls. If the return value is true, then the
* token is legal and ready for further use. If it returns false, then
* the scan of the prolog failed and the token is not going to work on
* subsequent scanNext() calls.
*
* @param systemId A pointer to a Unicode string represting the path
* to the XML file to be parsed.
* @param toFill A token maintaing state information to maintain
* internal consistency between invocation of 'parseNext'
* calls.
* @return 'true', if successful in parsing the prolog. It indicates the
* user can go ahead with parsing the rest of the file. It
* returns 'false' to indicate that the parser could not parse
* the prolog.
*
* @see #parseNext
* @see #parseFirst(char*,...)
* @see #parseFirst(InputSource&,...)
*/
bool parseFirst
(
const XMLCh* const systemId
, XMLPScanToken& toFill
);
/** Begin a progressive parse operation
*
* This method is used to start a progressive parse on a XML file.
* To continue parsing, subsequent calls must be to the parseNext
* method.
*
* It scans through the prolog and returns a token to be used on
* subsequent scanNext() calls. If the return value is true, then the
* token is legal and ready for further use. If it returns false, then
* the scan of the prolog failed and the token is not going to work on
* subsequent scanNext() calls.
*
* @param systemId A pointer to a regular native string represting
* the path to the XML file to be parsed.
* @param toFill A token maintaing state information to maintain
* internal consistency between invocation of 'parseNext'
* calls.
*
* @return 'true', if successful in parsing the prolog. It indicates the
* user can go ahead with parsing the rest of the file. It
* returns 'false' to indicate that the parser could not parse
* the prolog.
*
* @see #parseNext
* @see #parseFirst(XMLCh*,...)
* @see #parseFirst(InputSource&,...)
*/
bool parseFirst
(
const char* const systemId
, XMLPScanToken& toFill
);
/** Begin a progressive parse operation
*
* This method is used to start a progressive parse on a XML file.
* To continue parsing, subsequent calls must be to the parseNext
* method.
*
* It scans through the prolog and returns a token to be used on
* subsequent scanNext() calls. If the return value is true, then the
* token is legal and ready for further use. If it returns false, then
* the scan of the prolog failed and the token is not going to work on
* subsequent scanNext() calls.
*
* @param source A const reference to the InputSource object which
* points to the XML file to be parsed.
* @param toFill A token maintaing state information to maintain
* internal consistency between invocation of 'parseNext'
* calls.
*
* @return 'true', if successful in parsing the prolog. It indicates the
* user can go ahead with parsing the rest of the file. It
* returns 'false' to indicate that the parser could not parse
* the prolog.
*
* @see #parseNext
* @see #parseFirst(XMLCh*,...)
* @see #parseFirst(char*,...)
*/
bool parseFirst
(
const InputSource& source
, XMLPScanToken& toFill
);
/** Continue a progressive parse operation
*
* This method is used to continue with progressive parsing of
* XML files started by a call to 'parseFirst' method.
*
* It parses the XML file and stops as soon as it comes across
* a XML token (as defined in the XML specification).
*
* @param token A token maintaing state information to maintain
* internal consistency between invocation of 'parseNext'
* calls.
*
* @return 'true', if successful in parsing the next XML token.
* It indicates the user can go ahead with parsing the rest
* of the file. It returns 'false' to indicate that the parser
* could not find next token as per the XML specification
* production rule.
*
* @see #parseFirst(XMLCh*,...)
* @see #parseFirst(char*,...)
* @see #parseFirst(InputSource&,...)
*/
bool parseNext(XMLPScanToken& token);
/** Reset the parser after a progressive parse
*
* If a progressive parse loop exits before the end of the document
* is reached, the parser has no way of knowing this. So it will leave
* open any files or sockets or memory buffers that were in use at
* the time that the parse loop exited.
*
* The next parse operation will cause these open files and such to
* be closed, but the next parse operation might occur at some unknown
* future point. To avoid this problem, you should reset the parser if
* you exit the loop early.
*
* If you exited because of an error, then this cleanup will be done
* for you. Its only when you exit the file prematurely of your own
* accord, because you've found what you wanted in the file most
* likely.
*
* @param token A token maintaing state information to maintain
* internal consistency between invocation of 'parseNext'
* calls.
*
* @see #parseFirst(XMLCh*,...)
* @see #parseFirst(char*,...)
* @see #parseFirst(InputSource&,...)
*/
void parseReset(XMLPScanToken& token);
//@}
// -----------------------------------------------------------------------
// Implementation of the PSVIHandler interface.
// -----------------------------------------------------------------------
/** @name Implementation of the PSVIHandler interface. */
//@{
/** Receive notification of the PSVI properties of an element.
* The scanner will issue this call after the XMLDocumentHandler
* endElement call. Since the scanner will issue the psviAttributes
* call immediately after reading the start tag of an element, all element
* content will be effectively bracketed by these two calls.
* @param localName The name of the element whose end tag was just
* parsed.
* @param uri The namespace to which the element is bound
* @param elementInfo Object containing the element's PSVI properties
*/
virtual void handleElementPSVI
(
const XMLCh* const localName
, const XMLCh* const uri
, PSVIElement * elementInfo
);
virtual void handlePartialElementPSVI
(
const XMLCh* const localName
, const XMLCh* const uri
, PSVIElement * elementInfo
);
/**
* Enables PSVI information about attributes to be passed back to the
* application. This callback will be made on *all*
* elements; on elements with no attributes, the final parameter will
* be null.
* @param localName The name of the element upon which start tag
* these attributes were encountered.
* @param uri The namespace to which the element is bound
* @param psviAttributes Object containing the attributes' PSVI properties
* with information to identify them.
*/
virtual void handleAttributesPSVI
(
const XMLCh* const localName
, const XMLCh* const uri
, PSVIAttributeList * psviAttributes
);
//@}
// -----------------------------------------------------------------------
// Implementation of the XMLDocumentHandler interface.
// -----------------------------------------------------------------------
/** @name Implementation of the XMLDocumentHandler interface. */
//@{
/** Handle document character events
*
* This method is used to report all the characters scanned by the
* parser. This DOM implementation stores this data in the appropriate
* DOM node, creating one if necessary.
*
* @param chars A const pointer to a Unicode string representing the
* character data.
* @param length The length of the Unicode string returned in 'chars'.
* @param cdataSection A flag indicating if the characters represent
* content from the CDATA section.
*/
virtual void docCharacters
(
const XMLCh* const chars
, const unsigned int length
, const bool cdataSection
);
/** Handle a document comment event
*
* This method is used to report any comments scanned by the parser.
* A new comment node is created which stores this data.
*
* @param comment A const pointer to a null terminated Unicode
* string representing the comment text.
*/
virtual void docComment
(
const XMLCh* const comment
);
/** Handle a document PI event
*
* This method is used to report any PI scanned by the parser. A new
* PI node is created and appended as a child of the current node in
* the tree.
*
* @param target A const pointer to a Unicode string representing the
* target of the PI declaration.
* @param data A const pointer to a Unicode string representing the
* data of the PI declaration. See the PI production rule
* in the XML specification for details.
*/
virtual void docPI
(
const XMLCh* const target
, const XMLCh* const data
);
/** Handle the end of document event
*
* This method is used to indicate the end of the current document.
*/
virtual void endDocument();
/** Handle and end of element event
*
* This method is used to indicate the end tag of an element. The
* DOM parser pops the current element off the top of the element
* stack, and make it the new current element.
*
* @param elemDecl A const reference to the object containing element
* declaration information.
* @param urlId An id referring to the namespace prefix, if
* namespaces setting is switched on.
* @param isRoot A flag indicating whether this element was the
* root element.
* @param elemPrefix A const pointer to a Unicode string containing
* the namespace prefix for this element. Applicable
* only when namespace processing is enabled.
*/
virtual void endElement
(
const XMLElementDecl& elemDecl
, const unsigned int urlId
, const bool isRoot
, const XMLCh* const elemPrefix
);
/** Handle and end of entity reference event
*
* This method is used to indicate that an end of an entity reference
* was just scanned.
*
* @param entDecl A const reference to the object containing the
* entity declaration information.
*/
virtual void endEntityReference
(
const XMLEntityDecl& entDecl
);
/** Handle an ignorable whitespace vent
*
* This method is used to report all the whitespace characters, which
* are determined to be 'ignorable'. This distinction between characters
* is only made, if validation is enabled.
*
* Any whitespace before content is ignored. If the current node is
* already of type DOMNode::TEXT_NODE, then these whitespaces are
* appended, otherwise a new Text node is created which stores this
* data. Essentially all contiguous ignorable characters are collected
* in one node.
*
* @param chars A const pointer to a Unicode string representing the
* ignorable whitespace character data.
* @param length The length of the Unicode string 'chars'.
* @param cdataSection A flag indicating if the characters represent
* content from the CDATA section.
*/
virtual void ignorableWhitespace
(
const XMLCh* const chars
, const unsigned int length
, const bool cdataSection
);
/** Handle a document reset event
*
* This method allows the user installed Document Handler to 'reset'
* itself, freeing all the memory resources. The scanner calls this
* method before starting a new parse event.
*/
virtual void resetDocument();
/** Handle a start document event
*
* This method is used to report the start of the parsing process.
*/
virtual void startDocument();
/** Handle a start element event
*
* This method is used to report the start of an element. It is
* called at the end of the element, by which time all attributes
* specified are also parsed. A new DOM Element node is created
* along with as many attribute nodes as required. This new element
* is added appended as a child of the current node in the tree, and
* then replaces it as the current node (if the isEmpty flag is false.)
*
* @param elemDecl A const reference to the object containing element
* declaration information.
* @param urlId An id referring to the namespace prefix, if
* namespaces setting is switched on.
* @param elemPrefix A const pointer to a Unicode string containing
* the namespace prefix for this element. Applicable
* only when namespace processing is enabled.
* @param attrList A const reference to the object containing the
* list of attributes just scanned for this element.
* @param attrCount A count of number of attributes in the list
* specified by the parameter 'attrList'.
* @param isEmpty A flag indicating whether this is an empty element
* or not. If empty, then no endElement() call will
* be made.
* @param isRoot A flag indicating whether this element was the
* root element.
* @see DocumentHandler#startElement
*/
virtual void startElement
(
const XMLElementDecl& elemDecl
, const unsigned int urlId
, const XMLCh* const elemPrefix
, const RefVectorOf<XMLAttr>& attrList
, const unsigned int attrCount
, const bool isEmpty
, const bool isRoot
);
/** Handle a start entity reference event
*
* This method is used to indicate the start of an entity reference.
* If the expand entity reference flag is true, then a new
* DOM Entity reference node is created.
*
* @param entDecl A const reference to the object containing the
* entity declaration information.
*/
virtual void startEntityReference
(
const XMLEntityDecl& entDecl
);
/** Handle an XMLDecl event
*
* This method is used to report the XML decl scanned by the parser.
* Refer to the XML specification to see the meaning of parameters.
*
* <b>This method is a no-op for this DOM
* implementation.</b>
*
* @param versionStr A const pointer to a Unicode string representing
* version string value.
* @param encodingStr A const pointer to a Unicode string representing
* the encoding string value.
* @param standaloneStr A const pointer to a Unicode string
* representing the standalone string value.
* @param actualEncStr A const pointer to a Unicode string
* representing the actual encoding string
* value.
*/
virtual void XMLDecl
(
const XMLCh* const versionStr
, const XMLCh* const encodingStr
, const XMLCh* const standaloneStr
, const XMLCh* const actualEncStr
);
/** Receive notification of the name and namespace of the type that validated
* the element corresponding to the most recent endElement event.
* This event will be fired immediately after the
* endElement() event that signifies the end of the element
* to which it applies; no other events will intervene.
* This method is <em>EXPERIMENTAL</em> and may change, disappear
* or become pure virtual at any time.
*
* This corresponds to a part of the information required by DOM Core
* level 3's TypeInfo interface.
*
* @param typeName local name of the type that actually validated
* the content of the element corresponding to the
* most recent endElement() callback
* @param typeURI namespace of the type that actually validated
* the content of the element corresponding to the
* most recent endElement() callback
* @deprecated
*/
virtual void elementTypeInfo
(
const XMLCh* const typeName
, const XMLCh* const typeURI
);
//@}
// -----------------------------------------------------------------------
// Implementation of the deprecated DocTypeHandler interface.
// -----------------------------------------------------------------------
/** @name Deprecated DocTypeHandler Interfaces */
//@{
virtual void attDef
(
const DTDElementDecl& elemDecl
, const DTDAttDef& attDef
, const bool ignoring
);
virtual void doctypeComment
(
const XMLCh* const comment
);
virtual void doctypeDecl
(
const DTDElementDecl& elemDecl
, const XMLCh* const publicId
, const XMLCh* const systemId
, const bool hasIntSubset
, const bool hasExtSubset = false
);
virtual void doctypePI
(
const XMLCh* const target
, const XMLCh* const data
);
virtual void doctypeWhitespace
(
const XMLCh* const chars
, const unsigned int length
);
virtual void elementDecl
(
const DTDElementDecl& decl
, const bool isIgnored
);
virtual void endAttList
(
const DTDElementDecl& elemDecl
);
virtual void endIntSubset();
virtual void endExtSubset();
virtual void entityDecl
(
const DTDEntityDecl& entityDecl
, const bool isPEDecl
, const bool isIgnored
);
virtual void resetDocType();
virtual void notationDecl
(
const XMLNotationDecl& notDecl
, const bool isIgnored
);
virtual void startAttList
(
const DTDElementDecl& elemDecl
);
virtual void startIntSubset();
virtual void startExtSubset();
virtual void TextDecl
(
const XMLCh* const versionStr
, const XMLCh* const encodingStr
);
//@}
// -----------------------------------------------------------------------
// Deprecated Methods
// -----------------------------------------------------------------------
/** @name Deprecated Methods */
//@{
/**
* This method returns the state of the parser's validation
* handling flag which controls whether validation checks
* are enforced or not.
*
* @return true, if the parser is currently configured to
* do validation, false otherwise.
*
* @see #setDoValidation
*/
bool getDoValidation() const;
/**
* This method allows users to enable or disable the parser's validation
* checks.
*
* <p>By default, the parser does not to any validation. The default
* value is false.</p>
*
* @param newState The value specifying whether the parser should
* do validity checks or not against the DTD in the
* input XML document.
*
* @see #getDoValidation
*/
void setDoValidation(const bool newState);
/** Get the 'expand entity references' flag.
* DEPRECATED Use getCreateEntityReferenceNodes() instead.
*
* This method returns the state of the parser's expand entity
* references flag.
*
* @return 'true' if the expand entity reference flag is set on
* the parser, 'false' otherwise.
*
* @see #setExpandEntityReferences
* @see #setCreateEntityReferenceNodes
* @see #getCreateEntityReferenceNodes
*/
bool getExpandEntityReferences() const;
/** Set the 'expand entity references' flag
*
* DEPRECATED. USE setCreateEntityReferenceNodes instead.
* This method allows the user to specify whether the parser should
* expand all entity reference nodes. When the 'do expansion' flag is
* true, the DOM tree does not have any entity reference nodes. It is
* replaced by the sub-tree representing the replacement text of the
* entity. When the 'do expansion' flag is false, the DOM tree
* contains an extra entity reference node, whose children is the
* sub tree of the replacement text.
* <p>The default value is 'false'.
*
* @param expand The new state of the expand entity reference
* flag.
* @see #setCreateEntityReferenceNodes
*/
void setExpandEntityReferences(const bool expand);
//@}
protected :
// -----------------------------------------------------------------------
// Protected Constructor Methods
// -----------------------------------------------------------------------
/** @name Constructors */
//@{
/** Construct a AbstractDOMParser, with an optional validator
*
* Constructor with an instance of validator class to use for
* validation. If you don't provide a validator, a default one will
* be created for you in the scanner.
*
* @param valToAdopt Pointer to the validator instance to use. The
* parser is responsible for freeing the memory.
*
* @param gramPool Pointer to the grammar pool instance from
* external application (through derivatives).
* The parser does NOT own it.
*
* @param manager Pointer to the memory manager to be used to
* allocate objects.
*/
AbstractDOMParser
(
XMLValidator* const valToAdopt = 0
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
, XMLGrammarPool* const gramPool = 0
);
//@}
// -----------------------------------------------------------------------
// Protected getter methods
// -----------------------------------------------------------------------
/** @name Protected getter methods */
//@{
/** Get the current DOM node
*
* This provides derived classes with access to the current node, i.e.
* the node to which new nodes are being added.
*/
DOMNode* getCurrentNode();
/** Get the XML scanner
*
* This provides derived classes with access to the XML scanner.
*/
XMLScanner* getScanner() const;
/** Get the Grammar resolver
*
* This provides derived classes with access to the grammar resolver.
*/
GrammarResolver* getGrammarResolver() const;
/** Get the parse in progress flag
*
* This provides derived classes with access to the parse in progress
* flag.
*/
bool getParseInProgress() const;
MemoryManager* getMemoryManager() const;
//@}
// -----------------------------------------------------------------------
// Protected setter methods
// -----------------------------------------------------------------------
/** @name Protected setter methods */
//@{
/** Set the current DOM node
*
* This method sets the current node maintained inside the parser to
* the one specified.
*
* @param toSet The DOM node which will be the current node.
*/
void setCurrentNode(DOMNode* toSet);
/** Set the document node
*
* This method sets the DOM Document node to the one specified.
*
* @param toSet The new DOM Document node for this XML document.
*/
void setDocument(DOMDocument* toSet);
/** Set the parse in progress flag
*
* This method sets the parse in progress flag to true or false.
*
* @param toSet The value of the flag to be set.
*/
void setParseInProgress(const bool toSet);
//@}
// -----------------------------------------------------------------------
// Protected Helper methods
// -----------------------------------------------------------------------
/** @name Protected helper methods */
//@{
virtual DOMElement* createElementNSNode(const XMLCh *fNamespaceURI,
const XMLCh *qualifiedName);
void resetPool();
/**
* Returns true if the user has adopted the document
*/
bool isDocumentAdopted() const;
//@}
private :
// -----------------------------------------------------------------------
// Initialize/Cleanup methods
// -----------------------------------------------------------------------
void initialize();
void cleanUp();
void resetInProgress();
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
AbstractDOMParser(const AbstractDOMParser&);
AbstractDOMParser& operator=(const AbstractDOMParser&);
protected:
// -----------------------------------------------------------------------
// Protected data members
//
// fCurrentNode
// fCurrentParent
// Used to track the current node during nested element events. Since
// the tree must be built from a set of disjoint callbacks, we need
// these to keep up with where we currently are.
//
// fCurrentEntity
// Used to track the current entity decl. If a text decl is seen later on,
// it is used to update the encoding and version information.
//
// fDocument
// The root document object, filled with the document contents.
//
// fCreateEntityReferenceNodes
// Indicates whether entity reference nodes should be created.
//
// fIncludeIgnorableWhitespace
// Indicates whether ignorable whiltespace should be added to
// the DOM tree for validating parsers.
//
// fScanner
// The scanner used for this parser. This is created during the
// constructor.
//
// fImplementationFeatures
// The implementation features that we use to get an implementation
// for use in creating the DOMDocument used during parse. If this is
// null then the default DOMImplementation is used
//
// fNodeStack
// Used to track previous parent nodes during nested element events.
//
// fParseInProgress
// Used to prevent multiple entrance to the parser while its doing
// a parse.
//
// fWithinElement
// A flag to indicate that the parser is within at least one level
// of element processing.
//
// fDocumentType
// Used to store and update the documentType variable information
// in fDocument
//
// fDocumentVector
// Store all the previous fDocument(s) (thus not the current fDocument)
// created in this parser. It is destroyed when the parser is destructed.
//
// fCreateCommentNodes
// Indicates whether comment nodes should be created.
//
// fDocumentAdoptedByUser
// The DOMDocument ownership has been transferred to application
// If set to true, the parser does not own the document anymore
// and thus will not release its memory.
//
// fInternalSubset
// Buffer for storing the internal subset information.
// Once complete (after DOCTYPE is finished scanning), send
// it to DocumentType Node
//
// fGrammarPool
// The grammar pool passed from external application (through derivatives).
// which could be 0, not owned.
//
// fCreateSchemaInfo
// Indicates whether element and attributes will have schema info associated
//
// -----------------------------------------------------------------------
bool fCreateEntityReferenceNodes;
bool fIncludeIgnorableWhitespace;
bool fWithinElement;
bool fParseInProgress;
bool fCreateCommentNodes;
bool fDocumentAdoptedByUser;
bool fCreateSchemaInfo;
XMLScanner* fScanner;
XMLCh* fImplementationFeatures;
DOMNode* fCurrentParent;
DOMNode* fCurrentNode;
DOMEntity* fCurrentEntity;
DOMDocumentImpl* fDocument;
ValueStackOf<DOMNode*>* fNodeStack;
DOMDocumentTypeImpl* fDocumentType;
RefVectorOf<DOMDocumentImpl>* fDocumentVector;
GrammarResolver* fGrammarResolver;
XMLStringPool* fURIStringPool;
XMLValidator* fValidator;
MemoryManager* fMemoryManager;
XMLGrammarPool* fGrammarPool;
XMLBufferMgr fBufMgr;
XMLBuffer& fInternalSubset;
PSVIHandler* fPSVIHandler;
};
// ---------------------------------------------------------------------------
// AbstractDOMParser: Getter methods
// ---------------------------------------------------------------------------
inline bool AbstractDOMParser::getExpandEntityReferences() const
{
return !fCreateEntityReferenceNodes;
}
inline bool AbstractDOMParser::getCreateEntityReferenceNodes() const
{
return fCreateEntityReferenceNodes;
}
inline bool AbstractDOMParser::getIncludeIgnorableWhitespace() const
{
return fIncludeIgnorableWhitespace;
}
inline bool AbstractDOMParser::getParseInProgress() const
{
return fParseInProgress;
}
inline XMLScanner* AbstractDOMParser::getScanner() const
{
return fScanner;
}
inline GrammarResolver* AbstractDOMParser::getGrammarResolver() const
{
return fGrammarResolver;
}
inline bool AbstractDOMParser::getCreateCommentNodes() const
{
return fCreateCommentNodes;
}
inline PSVIHandler* AbstractDOMParser::getPSVIHandler()
{
return fPSVIHandler;
}
inline const PSVIHandler* AbstractDOMParser::getPSVIHandler() const
{
return fPSVIHandler;
}
inline bool AbstractDOMParser::getCreateSchemaInfo() const
{
return fCreateSchemaInfo;
}
// ---------------------------------------------------------------------------
// AbstractDOMParser: Setter methods
// ---------------------------------------------------------------------------
inline void AbstractDOMParser::setExpandEntityReferences(const bool expand)
{
fCreateEntityReferenceNodes = !expand;
}
inline void AbstractDOMParser::setCreateEntityReferenceNodes(const bool create)
{
fCreateEntityReferenceNodes = create;
}
inline void AbstractDOMParser::setIncludeIgnorableWhitespace(const bool include)
{
fIncludeIgnorableWhitespace = include;
}
inline void AbstractDOMParser::setCreateCommentNodes(const bool create)
{
fCreateCommentNodes = create;
}
inline void AbstractDOMParser::useImplementation(const XMLCh* const implementationFeatures)
{
fMemoryManager->deallocate(fImplementationFeatures);
fImplementationFeatures = XMLString::replicate(implementationFeatures, fMemoryManager);
}
// ---------------------------------------------------------------------------
// AbstractDOMParser: Protected getter methods
// ---------------------------------------------------------------------------
inline DOMNode* AbstractDOMParser::getCurrentNode()
{
return fCurrentNode;
}
inline MemoryManager* AbstractDOMParser::getMemoryManager() const
{
return fMemoryManager;
}
// ---------------------------------------------------------------------------
// AbstractDOMParser: Protected setter methods
// ---------------------------------------------------------------------------
inline void AbstractDOMParser::setCurrentNode(DOMNode* toSet)
{
fCurrentNode = toSet;
}
inline void AbstractDOMParser::setParseInProgress(const bool toSet)
{
fParseInProgress = toSet;
}
XERCES_CPP_NAMESPACE_END
#endif
|