You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

675 lines
37 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>Xerces-C++: XMLGrammarPool Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classXMLGrammarPool-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">XMLGrammarPool Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <div class="dynheader">
  56. Inheritance diagram for XMLGrammarPool:</div>
  57. <div class="dyncontent">
  58. <div class="center">
  59. <img src="classXMLGrammarPool.png" usemap="#XMLGrammarPool_map" alt=""/>
  60. <map id="XMLGrammarPool_map" name="XMLGrammarPool_map">
  61. <area href="classXMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete operators to ..." alt="XMemory" shape="rect" coords="0,0,115,24"/>
  62. </map>
  63. </div></div>
  64. <table class="memberdecls">
  65. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  66. Public Member Functions</h2></td></tr>
  67. <tr class="memitem:a911e64476593684402942f1328be063d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a911e64476593684402942f1328be063d">serializeGrammars</a> (<a class="el" href="classBinOutputStream.html">BinOutputStream</a> *const)=0</td></tr>
  68. <tr class="memdesc:a911e64476593684402942f1328be063d"><td class="mdescLeft">&#160;</td><td class="mdescRight">serialization and deserialization support <a href="#a911e64476593684402942f1328be063d">More...</a><br /></td></tr>
  69. <tr class="separator:a911e64476593684402942f1328be063d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a49c9d8b945202dc52efac9a49777b76c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a49c9d8b945202dc52efac9a49777b76c">deserializeGrammars</a> (<a class="el" href="classBinInputStream.html">BinInputStream</a> *const)=0</td></tr>
  71. <tr class="separator:a49c9d8b945202dc52efac9a49777b76c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:af320d13b44ba404c9653e5934ddd782a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#af320d13b44ba404c9653e5934ddd782a">setIgnoreSerializedAnnotations</a> (const bool flag)</td></tr>
  73. <tr class="separator:af320d13b44ba404c9653e5934ddd782a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a9b8187ba62782cc03c0ad1fc6a658023"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a9b8187ba62782cc03c0ad1fc6a658023">getIgnoreSerializedAnnotations</a> () const </td></tr>
  75. <tr class="separator:a9b8187ba62782cc03c0ad1fc6a658023"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr><td colspan="2"><div class="groupHeader">Virtual destructor for derived classes</div></td></tr>
  77. <tr class="memitem:a792b7f4329e5f5879e697267e1f77045"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a792b7f4329e5f5879e697267e1f77045">~XMLGrammarPool</a> ()</td></tr>
  78. <tr class="memdesc:a792b7f4329e5f5879e697267e1f77045"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual destructor <a href="#a792b7f4329e5f5879e697267e1f77045">More...</a><br /></td></tr>
  79. <tr class="separator:a792b7f4329e5f5879e697267e1f77045"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr><td colspan="2"><div class="groupHeader">The Grammar Pool Interface</div></td></tr>
  81. <tr class="memitem:a08e026b224ce673351399e5aa89986a4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a08e026b224ce673351399e5aa89986a4">cacheGrammar</a> (Grammar *const gramToCache)=0</td></tr>
  82. <tr class="memdesc:a08e026b224ce673351399e5aa89986a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">cacheGrammar <a href="#a08e026b224ce673351399e5aa89986a4">More...</a><br /></td></tr>
  83. <tr class="separator:a08e026b224ce673351399e5aa89986a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a4d46fe203456ff60dd6018f314703c30"><td class="memItemLeft" align="right" valign="top">virtual Grammar *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a4d46fe203456ff60dd6018f314703c30">retrieveGrammar</a> (<a class="el" href="classXMLGrammarDescription.html">XMLGrammarDescription</a> *const gramDesc)=0</td></tr>
  85. <tr class="memdesc:a4d46fe203456ff60dd6018f314703c30"><td class="mdescLeft">&#160;</td><td class="mdescRight">retrieveGrammar <a href="#a4d46fe203456ff60dd6018f314703c30">More...</a><br /></td></tr>
  86. <tr class="separator:a4d46fe203456ff60dd6018f314703c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ad0254f88ff391922562f98f1c9d221df"><td class="memItemLeft" align="right" valign="top">virtual Grammar *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ad0254f88ff391922562f98f1c9d221df">orphanGrammar</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const nameSpaceKey)=0</td></tr>
  88. <tr class="memdesc:ad0254f88ff391922562f98f1c9d221df"><td class="mdescLeft">&#160;</td><td class="mdescRight">orphanGrammar <a href="#ad0254f88ff391922562f98f1c9d221df">More...</a><br /></td></tr>
  89. <tr class="separator:ad0254f88ff391922562f98f1c9d221df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a3cc5ab2ad55b562cb636871b7d9895e8"><td class="memItemLeft" align="right" valign="top">virtual RefHashTableOfEnumerator&lt; Grammar &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a3cc5ab2ad55b562cb636871b7d9895e8">getGrammarEnumerator</a> () const =0</td></tr>
  91. <tr class="memdesc:a3cc5ab2ad55b562cb636871b7d9895e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an enumeration of the cached Grammars in the Grammar pool. <a href="#a3cc5ab2ad55b562cb636871b7d9895e8">More...</a><br /></td></tr>
  92. <tr class="separator:a3cc5ab2ad55b562cb636871b7d9895e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ab85574c2179f8093fc0332e9687effd7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ab85574c2179f8093fc0332e9687effd7">clear</a> ()=0</td></tr>
  94. <tr class="memdesc:ab85574c2179f8093fc0332e9687effd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear <a href="#ab85574c2179f8093fc0332e9687effd7">More...</a><br /></td></tr>
  95. <tr class="separator:ab85574c2179f8093fc0332e9687effd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a31c136f2bee3a151004b51901342798e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a31c136f2bee3a151004b51901342798e">lockPool</a> ()=0</td></tr>
  97. <tr class="memdesc:a31c136f2bee3a151004b51901342798e"><td class="mdescLeft">&#160;</td><td class="mdescRight">lockPool <a href="#a31c136f2bee3a151004b51901342798e">More...</a><br /></td></tr>
  98. <tr class="separator:a31c136f2bee3a151004b51901342798e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a787f93c1c88fb9c95d9547869e217a0a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a787f93c1c88fb9c95d9547869e217a0a">unlockPool</a> ()=0</td></tr>
  100. <tr class="memdesc:a787f93c1c88fb9c95d9547869e217a0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">unlockPool <a href="#a787f93c1c88fb9c95d9547869e217a0a">More...</a><br /></td></tr>
  101. <tr class="separator:a787f93c1c88fb9c95d9547869e217a0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr><td colspan="2"><div class="groupHeader">Factory interface</div></td></tr>
  103. <tr class="memitem:a981598e2cb25c0143405bf4c33ab141c"><td class="memItemLeft" align="right" valign="top">virtual DTDGrammar *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a981598e2cb25c0143405bf4c33ab141c">createDTDGrammar</a> ()=0</td></tr>
  104. <tr class="memdesc:a981598e2cb25c0143405bf4c33ab141c"><td class="mdescLeft">&#160;</td><td class="mdescRight">createDTDGrammar <a href="#a981598e2cb25c0143405bf4c33ab141c">More...</a><br /></td></tr>
  105. <tr class="separator:a981598e2cb25c0143405bf4c33ab141c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ad2de4f22719bf51d9b642f808b5f06fe"><td class="memItemLeft" align="right" valign="top">virtual SchemaGrammar *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ad2de4f22719bf51d9b642f808b5f06fe">createSchemaGrammar</a> ()=0</td></tr>
  107. <tr class="memdesc:ad2de4f22719bf51d9b642f808b5f06fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">createSchemaGrammar <a href="#ad2de4f22719bf51d9b642f808b5f06fe">More...</a><br /></td></tr>
  108. <tr class="separator:ad2de4f22719bf51d9b642f808b5f06fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ad492ce388622e955d1a629e3892e0793"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXMLDTDDescription.html">XMLDTDDescription</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ad492ce388622e955d1a629e3892e0793">createDTDDescription</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const systemId)=0</td></tr>
  110. <tr class="memdesc:ad492ce388622e955d1a629e3892e0793"><td class="mdescLeft">&#160;</td><td class="mdescRight">createDTDDescription <a href="#ad492ce388622e955d1a629e3892e0793">More...</a><br /></td></tr>
  111. <tr class="separator:ad492ce388622e955d1a629e3892e0793"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a1f922708efaa4e4fafee6ed5af04a306"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXMLSchemaDescription.html">XMLSchemaDescription</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a1f922708efaa4e4fafee6ed5af04a306">createSchemaDescription</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const targetNamespace)=0</td></tr>
  113. <tr class="memdesc:a1f922708efaa4e4fafee6ed5af04a306"><td class="mdescLeft">&#160;</td><td class="mdescRight">createSchemaDescription <a href="#a1f922708efaa4e4fafee6ed5af04a306">More...</a><br /></td></tr>
  114. <tr class="separator:a1f922708efaa4e4fafee6ed5af04a306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr><td colspan="2"><div class="groupHeader">schema component model support</div></td></tr>
  116. <tr class="memitem:ad4ae5730d543a4525421d1b5e920a736"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXSModel.html">XSModel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ad4ae5730d543a4525421d1b5e920a736">getXSModel</a> (bool &amp;XSModelWasChanged)=0</td></tr>
  117. <tr class="separator:ad4ae5730d543a4525421d1b5e920a736"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr><td colspan="2"><div class="groupHeader">Getter</div></td></tr>
  119. <tr class="memitem:ae12c5153eb902652d3ebd5c8d504e5b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMemoryManager.html">MemoryManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#ae12c5153eb902652d3ebd5c8d504e5b3">getMemoryManager</a> ()</td></tr>
  120. <tr class="memdesc:ae12c5153eb902652d3ebd5c8d504e5b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">getMemoryManager <a href="#ae12c5153eb902652d3ebd5c8d504e5b3">More...</a><br /></td></tr>
  121. <tr class="separator:ae12c5153eb902652d3ebd5c8d504e5b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:af9f72a65d9b8b15b6f94b9e526e2acd1"><td class="memItemLeft" align="right" valign="top">virtual XMLStringPool *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#af9f72a65d9b8b15b6f94b9e526e2acd1">getURIStringPool</a> ()=0</td></tr>
  123. <tr class="memdesc:af9f72a65d9b8b15b6f94b9e526e2acd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an XMLStringPool for use by validation routines. <a href="#af9f72a65d9b8b15b6f94b9e526e2acd1">More...</a><br /></td></tr>
  124. <tr class="separator:af9f72a65d9b8b15b6f94b9e526e2acd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="inherit_header pub_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXMemory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
  126. <tr class="memitem:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a717678d9deadc627a41fe0dddede9f7f">operator new</a> (size_t size)</td></tr>
  127. <tr class="memdesc:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator new. <a href="#a717678d9deadc627a41fe0dddede9f7f">More...</a><br /></td></tr>
  128. <tr class="separator:a717678d9deadc627a41fe0dddede9f7f inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ac3022fcc968c684a31c1e6a9ede83c10">operator new</a> (size_t size, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
  130. <tr class="memdesc:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method defines a custom operator new, that will use the provided memory manager to perform the allocation. <a href="#ac3022fcc968c684a31c1e6a9ede83c10">More...</a><br /></td></tr>
  131. <tr class="separator:ac3022fcc968c684a31c1e6a9ede83c10 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#aeaad885b799ac2188ffd28f76182339c">operator new</a> (size_t size, void *ptr)</td></tr>
  133. <tr class="memdesc:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides placement operator new. <a href="#aeaad885b799ac2188ffd28f76182339c">More...</a><br /></td></tr>
  134. <tr class="separator:aeaad885b799ac2188ffd28f76182339c inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a9da30f1601ea458908cbf150fc2f8f8b">operator delete</a> (void *p)</td></tr>
  136. <tr class="memdesc:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method overrides operator delete. <a href="#a9da30f1601ea458908cbf150fc2f8f8b">More...</a><br /></td></tr>
  137. <tr class="separator:a9da30f1601ea458908cbf150fc2f8f8b inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a22efbc6459bdbe79f83b7791bba4d1f6">operator delete</a> (void *p, <a class="el" href="classMemoryManager.html">MemoryManager</a> *memMgr)</td></tr>
  139. <tr class="memdesc:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the custom operator new. <a href="#a22efbc6459bdbe79f83b7791bba4d1f6">More...</a><br /></td></tr>
  140. <tr class="separator:a22efbc6459bdbe79f83b7791bba4d1f6 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#a32ee38b70d412e12f669cfbd86adf623">operator delete</a> (void *p, void *ptr)</td></tr>
  142. <tr class="memdesc:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method provides a matching delete for the placement new. <a href="#a32ee38b70d412e12f669cfbd86adf623">More...</a><br /></td></tr>
  143. <tr class="separator:a32ee38b70d412e12f669cfbd86adf623 inherit pub_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table><table class="memberdecls">
  145. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  146. Protected Member Functions</h2></td></tr>
  147. <tr><td colspan="2"><div class="groupHeader"></div></td></tr>
  148. <tr class="memitem:a0dc250a1820cebb8aa99449d1c57e502"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLGrammarPool.html#a0dc250a1820cebb8aa99449d1c57e502">XMLGrammarPool</a> (<a class="el" href="classMemoryManager.html">MemoryManager</a> *const memMgr=<a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
  149. <tr class="memdesc:a0dc250a1820cebb8aa99449d1c57e502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hidden Constructors. <a href="#a0dc250a1820cebb8aa99449d1c57e502">More...</a><br /></td></tr>
  150. <tr class="separator:a0dc250a1820cebb8aa99449d1c57e502"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="inherit_header pro_methods_classXMemory"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classXMemory')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classXMemory.html">XMemory</a></td></tr>
  152. <tr class="memitem:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXMemory.html#ae5b8adaa10d5d9276b42823f47e06858">XMemory</a> ()</td></tr>
  153. <tr class="memdesc:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ae5b8adaa10d5d9276b42823f47e06858">More...</a><br /></td></tr>
  154. <tr class="separator:ae5b8adaa10d5d9276b42823f47e06858 inherit pro_methods_classXMemory"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table>
  156. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  157. <a class="anchor" id="a792b7f4329e5f5879e697267e1f77045"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">virtual XMLGrammarPool::~XMLGrammarPool </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>virtual destructor </p>
  178. </div>
  179. </div>
  180. <a class="anchor" id="a0dc250a1820cebb8aa99449d1c57e502"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">XMLGrammarPool::XMLGrammarPool </td>
  189. <td>(</td>
  190. <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&#160;</td>
  191. <td class="paramname"><em>memMgr</em> = <code><a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Hidden Constructors. </p>
  202. </div>
  203. </div>
  204. <h2 class="groupheader">Member Function Documentation</h2>
  205. <a class="anchor" id="a08e026b224ce673351399e5aa89986a4"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">virtual bool XMLGrammarPool::cacheGrammar </td>
  214. <td>(</td>
  215. <td class="paramtype">Grammar *const&#160;</td>
  216. <td class="paramname"><em>gramToCache</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>cacheGrammar </p>
  227. <p>Provide the grammar pool with an opportunity to cache the given grammar. If the pool does not choose to do so, it should return false; otherwise, it should return true, so that the caller knows whether the grammar has been adopted.</p>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">gramToCache</td><td>the Grammar to be cached in the grammar pool </td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section return"><dt>Returns</dt><dd>true if the grammar pool has elected to cache the grammar (in which case it is assumed to have adopted it); false if it does not cache it </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="ab85574c2179f8093fc0332e9687effd7"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="mlabels">
  241. <tr>
  242. <td class="mlabels-left">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">virtual bool XMLGrammarPool::clear </td>
  246. <td>(</td>
  247. <td class="paramname"></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>clear </p>
  258. <p>all grammars are removed from the grammar pool and deleted. </p><dl class="section return"><dt>Returns</dt><dd>true if the grammar pool was cleared. false if it did not. </dd></dl>
  259. </div>
  260. </div>
  261. <a class="anchor" id="ad492ce388622e955d1a629e3892e0793"></a>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">virtual <a class="el" href="classXMLDTDDescription.html">XMLDTDDescription</a>* XMLGrammarPool::createDTDDescription </td>
  270. <td>(</td>
  271. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  272. <td class="paramname"><em>systemId</em></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>createDTDDescription </p>
  283. </div>
  284. </div>
  285. <a class="anchor" id="a981598e2cb25c0143405bf4c33ab141c"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">virtual DTDGrammar* XMLGrammarPool::createDTDGrammar </td>
  294. <td>(</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>createDTDGrammar </p>
  306. </div>
  307. </div>
  308. <a class="anchor" id="a1f922708efaa4e4fafee6ed5af04a306"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">virtual <a class="el" href="classXMLSchemaDescription.html">XMLSchemaDescription</a>* XMLGrammarPool::createSchemaDescription </td>
  317. <td>(</td>
  318. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  319. <td class="paramname"><em>targetNamespace</em></td><td>)</td>
  320. <td></td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>createSchemaDescription </p>
  330. </div>
  331. </div>
  332. <a class="anchor" id="ad2de4f22719bf51d9b642f808b5f06fe"></a>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="mlabels">
  336. <tr>
  337. <td class="mlabels-left">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">virtual SchemaGrammar* XMLGrammarPool::createSchemaGrammar </td>
  341. <td>(</td>
  342. <td class="paramname"></td><td>)</td>
  343. <td></td>
  344. </tr>
  345. </table>
  346. </td>
  347. <td class="mlabels-right">
  348. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>createSchemaGrammar </p>
  353. </div>
  354. </div>
  355. <a class="anchor" id="a49c9d8b945202dc52efac9a49777b76c"></a>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">virtual void XMLGrammarPool::deserializeGrammars </td>
  364. <td>(</td>
  365. <td class="paramtype"><a class="el" href="classBinInputStream.html">BinInputStream</a> *&#160;</td>
  366. <td class="paramname"><em>const</em></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </td>
  371. <td class="mlabels-right">
  372. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. </div>
  377. </div>
  378. <a class="anchor" id="a3cc5ab2ad55b562cb636871b7d9895e8"></a>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="mlabels">
  382. <tr>
  383. <td class="mlabels-left">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname">virtual RefHashTableOfEnumerator&lt;Grammar&gt; XMLGrammarPool::getGrammarEnumerator </td>
  387. <td>(</td>
  388. <td class="paramname"></td><td>)</td>
  389. <td> const</td>
  390. </tr>
  391. </table>
  392. </td>
  393. <td class="mlabels-right">
  394. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  395. </tr>
  396. </table>
  397. </div><div class="memdoc">
  398. <p>Get an enumeration of the cached Grammars in the Grammar pool. </p>
  399. <dl class="section return"><dt>Returns</dt><dd>enumeration of the cached Grammars in Grammar pool </dd></dl>
  400. </div>
  401. </div>
  402. <a class="anchor" id="a9b8187ba62782cc03c0ad1fc6a658023"></a>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">bool XMLGrammarPool::getIgnoreSerializedAnnotations </td>
  408. <td>(</td>
  409. <td class="paramname"></td><td>)</td>
  410. <td> const</td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. </div>
  415. </div>
  416. <a class="anchor" id="ae12c5153eb902652d3ebd5c8d504e5b3"></a>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname"><a class="el" href="classMemoryManager.html">MemoryManager</a>* XMLGrammarPool::getMemoryManager </td>
  422. <td>(</td>
  423. <td class="paramname"></td><td>)</td>
  424. <td></td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>getMemoryManager </p>
  429. </div>
  430. </div>
  431. <a class="anchor" id="af9f72a65d9b8b15b6f94b9e526e2acd1"></a>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="mlabels">
  435. <tr>
  436. <td class="mlabels-left">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">virtual XMLStringPool* XMLGrammarPool::getURIStringPool </td>
  440. <td>(</td>
  441. <td class="paramname"></td><td>)</td>
  442. <td></td>
  443. </tr>
  444. </table>
  445. </td>
  446. <td class="mlabels-right">
  447. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. <p>Return an XMLStringPool for use by validation routines. </p>
  452. <p>Implementations should not create a string pool on each call to this method, but should maintain one string pool for all grammars for which this pool is responsible. </p>
  453. </div>
  454. </div>
  455. <a class="anchor" id="ad4ae5730d543a4525421d1b5e920a736"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="mlabels">
  459. <tr>
  460. <td class="mlabels-left">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">virtual <a class="el" href="classXSModel.html">XSModel</a>* XMLGrammarPool::getXSModel </td>
  464. <td>(</td>
  465. <td class="paramtype">bool &amp;&#160;</td>
  466. <td class="paramname"><em>XSModelWasChanged</em></td><td>)</td>
  467. <td></td>
  468. </tr>
  469. </table>
  470. </td>
  471. <td class="mlabels-right">
  472. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. </div>
  477. </div>
  478. <a class="anchor" id="a31c136f2bee3a151004b51901342798e"></a>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="mlabels">
  482. <tr>
  483. <td class="mlabels-left">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">virtual void XMLGrammarPool::lockPool </td>
  487. <td>(</td>
  488. <td class="paramname"></td><td>)</td>
  489. <td></td>
  490. </tr>
  491. </table>
  492. </td>
  493. <td class="mlabels-right">
  494. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>lockPool </p>
  499. <p>When this method is called by the application, the grammar pool should stop adding new grammars to the cache. This should result in the grammar pool being sharable among parsers operating in different threads. </p>
  500. </div>
  501. </div>
  502. <a class="anchor" id="ad0254f88ff391922562f98f1c9d221df"></a>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="mlabels">
  506. <tr>
  507. <td class="mlabels-left">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname">virtual Grammar* XMLGrammarPool::orphanGrammar </td>
  511. <td>(</td>
  512. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  513. <td class="paramname"><em>nameSpaceKey</em></td><td>)</td>
  514. <td></td>
  515. </tr>
  516. </table>
  517. </td>
  518. <td class="mlabels-right">
  519. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  520. </tr>
  521. </table>
  522. </div><div class="memdoc">
  523. <p>orphanGrammar </p>
  524. <p>grammar removed from the grammar pool and owned by the caller</p>
  525. <dl class="params"><dt>Parameters</dt><dd>
  526. <table class="params">
  527. <tr><td class="paramname">nameSpaceKey</td><td>Key used to search for grammar in the grammar pool </td></tr>
  528. </table>
  529. </dd>
  530. </dl>
  531. <dl class="section return"><dt>Returns</dt><dd>the grammar that was removed from the pool (0 if none) </dd></dl>
  532. </div>
  533. </div>
  534. <a class="anchor" id="a4d46fe203456ff60dd6018f314703c30"></a>
  535. <div class="memitem">
  536. <div class="memproto">
  537. <table class="mlabels">
  538. <tr>
  539. <td class="mlabels-left">
  540. <table class="memname">
  541. <tr>
  542. <td class="memname">virtual Grammar* XMLGrammarPool::retrieveGrammar </td>
  543. <td>(</td>
  544. <td class="paramtype"><a class="el" href="classXMLGrammarDescription.html">XMLGrammarDescription</a> *const&#160;</td>
  545. <td class="paramname"><em>gramDesc</em></td><td>)</td>
  546. <td></td>
  547. </tr>
  548. </table>
  549. </td>
  550. <td class="mlabels-right">
  551. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  552. </tr>
  553. </table>
  554. </div><div class="memdoc">
  555. <p>retrieveGrammar </p>
  556. <dl class="params"><dt>Parameters</dt><dd>
  557. <table class="params">
  558. <tr><td class="paramname">gramDesc</td><td>the Grammar Description used to search for grammar cached in the grammar pool </td></tr>
  559. </table>
  560. </dd>
  561. </dl>
  562. </div>
  563. </div>
  564. <a class="anchor" id="a911e64476593684402942f1328be063d"></a>
  565. <div class="memitem">
  566. <div class="memproto">
  567. <table class="mlabels">
  568. <tr>
  569. <td class="mlabels-left">
  570. <table class="memname">
  571. <tr>
  572. <td class="memname">virtual void XMLGrammarPool::serializeGrammars </td>
  573. <td>(</td>
  574. <td class="paramtype"><a class="el" href="classBinOutputStream.html">BinOutputStream</a> *&#160;</td>
  575. <td class="paramname"><em>const</em></td><td>)</td>
  576. <td></td>
  577. </tr>
  578. </table>
  579. </td>
  580. <td class="mlabels-right">
  581. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  582. </tr>
  583. </table>
  584. </div><div class="memdoc">
  585. <p>serialization and deserialization support </p>
  586. </div>
  587. </div>
  588. <a class="anchor" id="af320d13b44ba404c9653e5934ddd782a"></a>
  589. <div class="memitem">
  590. <div class="memproto">
  591. <table class="memname">
  592. <tr>
  593. <td class="memname">void XMLGrammarPool::setIgnoreSerializedAnnotations </td>
  594. <td>(</td>
  595. <td class="paramtype">const bool&#160;</td>
  596. <td class="paramname"><em>flag</em></td><td>)</td>
  597. <td></td>
  598. </tr>
  599. </table>
  600. </div><div class="memdoc">
  601. </div>
  602. </div>
  603. <a class="anchor" id="a787f93c1c88fb9c95d9547869e217a0a"></a>
  604. <div class="memitem">
  605. <div class="memproto">
  606. <table class="mlabels">
  607. <tr>
  608. <td class="mlabels-left">
  609. <table class="memname">
  610. <tr>
  611. <td class="memname">virtual void XMLGrammarPool::unlockPool </td>
  612. <td>(</td>
  613. <td class="paramname"></td><td>)</td>
  614. <td></td>
  615. </tr>
  616. </table>
  617. </td>
  618. <td class="mlabels-right">
  619. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  620. </tr>
  621. </table>
  622. </div><div class="memdoc">
  623. <p>unlockPool </p>
  624. <p>After this method has been called, the grammar pool implementation should return to its default behaviour when cacheGrammars(...) is called. One effect, depending on the underlying implementation, is that the grammar pool may no longer be thread-safe (even on read operations).</p>
  625. <p>For PSVI support any previous <a class="el" href="classXSModel.html">XSModel</a> that was produced will be deleted. </p>
  626. </div>
  627. </div>
  628. <hr/>The documentation for this class was generated from the following file:<ul>
  629. <li><a class="el" href="XMLGrammarPool_8hpp_source.html">XMLGrammarPool.hpp</a></li>
  630. </ul>
  631. </div><!-- contents -->
  632. <!-- start footer part -->
  633. <hr class="footer"/><address class="footer"><small>
  634. Generated on Wed Mar 18 2015 10:43:39 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  635. <img class="footer" src="doxygen.png" alt="doxygen"/>
  636. </a> 1.8.9.1
  637. </small></address>
  638. </body>
  639. </html>