You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by tn...@apache.org on 2002/02/20 22:01:57 UTC

cvs commit: xml-xerces/c/doc build-misc.xml build-other.xml build-winunix.xml faq-build.xml faq-other.xml faq-parse.xml install.xml migration.xml program-dom.xml program-sax.xml program-sax2.xml

tng         02/02/20 13:01:57

  Modified:    c/doc    build-misc.xml build-other.xml build-winunix.xml
                        faq-build.xml faq-other.xml faq-parse.xml
                        install.xml migration.xml program-dom.xml
                        program-sax.xml program-sax2.xml
  Log:
  documentation update for sane_include, Xerces-C++ 1.7, and others.
  
  Revision  Changes    Path
  1.6       +2 -2      xml-xerces/c/doc/build-misc.xml
  
  Index: build-misc.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/build-misc.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- build-misc.xml	13 Feb 2002 19:49:39 -0000	1.5
  +++ build-misc.xml	20 Feb 2002 21:01:56 -0000	1.6
  @@ -174,8 +174,8 @@
   
         <ol>
   
  -        <li>The directory <code>src/util/Platforms</code> contains the
  -        platform sensitive files while <code>src/util/Compilers</code> contains
  +        <li>The directory <code>src/xercesc/util/Platforms</code> contains the
  +        platform sensitive files while <code>src/xercesc/util/Compilers</code> contains
           all development environment sensitive files. Each operating
           system has a file of its own and each development environment
           has another one of its own too.
  
  
  
  1.11      +12 -12    xml-xerces/c/doc/build-other.xml
  
  Index: build-other.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/build-other.xml,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- build-other.xml	18 Feb 2002 18:19:45 -0000	1.10
  +++ build-other.xml	20 Feb 2002 21:01:56 -0000	1.11
  @@ -84,7 +84,7 @@
   
            <p>To configure the make files for an iSeries build do the following under Qsh:</p>
   <source>qsh:
  -cd &lt;full path to &XercesCName;&gt;/src
  +cd &lt;full path to &XercesCName;&gt;/src/xercesc
   runConfigure -p os400 -x icc -c icc -m inmem -t Iconv400</source>
   
            <p>Troubleshooting:</p>
  @@ -105,7 +105,7 @@
           <p><em>Build</em></p>
   
   <source>qsh:
  -cd &lt;full path to &XercesCName;&gt;/src
  +cd &lt;full path to &XercesCName;&gt;/src/xercesc
   gmake</source>
   
            <p>The above gmake should result in a service program being created
  @@ -170,14 +170,14 @@
            to the source:</p>
   
            <ul>
  -         <li>src/dom/DocumentImpl.cpp</li>
  -         <li>src/dom/DocumentImpl.hpp</li>
  -         <li>src/idom/IDDocumentImpl.cpp</li>
  -         <li>src/idom/IDDocumentImpl.hpp</li>
  -         <li>src/validators/common/ContentSpecNode.hpp</li>
  +         <li>src/xercesc/dom/DocumentImpl.cpp</li>
  +         <li>src/xercesc/dom/DocumentImpl.hpp</li>
  +         <li>src/xercesc/idom/IDDocumentImpl.cpp</li>
  +         <li>src/xercesc/idom/IDDocumentImpl.hpp</li>
  +         <li>src/xercesc/validators/common/ContentSpecNode.hpp</li>
            </ul>
   
  -         <p>Update  the following routines in src/dom/DocumentImpl.cpp as follows:</p>
  +         <p>Update  the following routines in src/xercesc/dom/DocumentImpl.cpp as follows:</p>
   <source>
    void DocumentImpl::setUserData(NodeImpl* n, void* data)
    {
  @@ -210,7 +210,7 @@
    }
   </source>
   
  -         <p>To update src/dom/DoumentImpl.hpp as follows:</p>
  +         <p>To update src/xercesc/dom/DoumentImpl.hpp as follows:</p>
   
   <source>
    #ifdef __OS400__
  @@ -221,7 +221,7 @@
    #endif
   </source>
   
  -          <p>Update  the following routines in src/idom/IDDocumentImpl.cpp as follows:</p>
  +          <p>Update  the following routines in src/xercesc/idom/IDDocumentImpl.cpp as follows:</p>
   <source>
    void IDDocumentImpl::setUserData(IDOM_Node* n, void* data)
    {
  @@ -256,7 +256,7 @@
    }
   </source>
   
  -          <p>To update src/idom/IDDocumentImpl.hpp:</p>
  +          <p>To update src/xercesc/idom/IDDocumentImpl.hpp:</p>
   <source>
    #ifdef __OS400__
       RefHashTableOf&lt;char&gt;        *fUserData;
  @@ -279,7 +279,7 @@
             <li>Make sure you have created a binding directory (symbolic link)
             in the file system so that you can bind the &XercesCName; service program
             to the ICU service program and specify that on the <code>EXTRA_LINK_OPTIONS</code>
  -          in <code>src/Makefile.incl</code> (usually the default is a link
  +          in <code>src/xercesc/Makefile.incl</code> (usually the default is a link
             in <code>/usr/local/lib</code>).</li>
            </ol>
   
  
  
  
  1.11      +3 -3      xml-xerces/c/doc/build-winunix.xml
  
  Index: build-winunix.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/build-winunix.xml,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- build-winunix.xml	13 Feb 2002 19:49:39 -0000	1.10
  +++ build-winunix.xml	20 Feb 2002 21:01:56 -0000	1.11
  @@ -205,10 +205,10 @@
               a set of portable scripts (configure) that you can run on all
               other platforms without actually having the autoconf tool installed
               everywhere. In all probability the autoconf-generated script
  -            (called <code>configure</code>) is already in your <code>src</code>
  +            (called <code>configure</code>) is already in your <code>src/xercesc</code>
               directory. If not, type:</p>
   
  -<source>cd $XERCESCROOT/src
  +<source>cd $XERCESCROOT/src/xercesc
   autoconf</source>
   
               <p>This generates a shell-script called <code>configure</code>. It is tempting to run
  @@ -349,7 +349,7 @@
   configure
   
   If the result of the above commands look OK to you, go to the directory
  -$HOME/&XercesCSrcInstallDir;/src and type "gmake" to make the XERCES-C system.</source>
  +$HOME/&XercesCSrcInstallDir;/src/xercesc and type "gmake" to make the XERCES-C system.</source>
   
   <note>The error message concerning <code>conf.h</code>
   is NOT an indication of a problem. This code has been inserted to make it
  
  
  
  1.5       +1 -1      xml-xerces/c/doc/faq-build.xml
  
  Index: faq-build.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/faq-build.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- faq-build.xml	13 Feb 2002 19:49:39 -0000	1.4
  +++ faq-build.xml	20 Feb 2002 21:01:56 -0000	1.5
  @@ -222,7 +222,7 @@
   }</source>
   
         <p>This initializes the &XercesCProjectName; system and sets its internal
  -        variables. Note that you must the include <code>util/PlatformUtils.hpp</code> file for this to work.</p>
  +        variables. Note that you must the include <code>xercesc/util/PlatformUtils.hpp</code> file for this to work.</p>
   
       </a>
     </faq>
  
  
  
  1.15      +1 -1      xml-xerces/c/doc/faq-other.xml
  
  Index: faq-other.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/faq-other.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- faq-other.xml	13 Feb 2002 19:49:39 -0000	1.14
  +++ faq-other.xml	20 Feb 2002 21:01:56 -0000	1.15
  @@ -7,7 +7,7 @@
           <a>
   
              <p>The version string for &XercesCName; is in one of the header files. Look
  -           inside the file <code>src/util/XercesDefs.hpp</code> or, in the binary distribution, look in <code>include/utils/XercesDefs.hpp</code>. Search for the static variable <code>gXercesFullVersionStr</code> and look at its definition. (It is usually a string like "1_4_0" or
  +           inside the file <code>src/xercesc/util/XercesDefs.hpp</code> or, in the binary distribution, look in <code>include/xercesc/utils/XercesDefs.hpp</code>. Search for the static variable <code>gXercesFullVersionStr</code> and look at its definition. (It is usually a string like "1_4_0" or
              something similar). This is the version of &XercesCName; you are using.</p>
   
              <p>If you don't have the header files, you have to find the version
  
  
  
  1.43      +2 -2      xml-xerces/c/doc/faq-parse.xml
  
  Index: faq-parse.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/faq-parse.xml,v
  retrieving revision 1.42
  retrieving revision 1.43
  diff -u -r1.42 -r1.43
  --- faq-parse.xml	13 Feb 2002 19:49:39 -0000	1.42
  +++ faq-parse.xml	20 Feb 2002 21:01:56 -0000	1.43
  @@ -65,7 +65,7 @@
   }</source>
   
         <p>This initializes the &XercesCProjectName; system and sets its internal
  -        variables. Note that you must the include <code>util/PlatformUtils.hpp</code> file for this to work.</p>
  +        variables. Note that you must the include <code>xercesc/util/PlatformUtils.hpp</code> file for this to work.</p>
   
       </a>
     </faq>
  @@ -429,7 +429,7 @@
           platforms.</p>
   
         <p>To address the need to make remote connections to resources specified
  -        using additional protocols, ftp for example, &XercesCName; provides the <code>NetAccessor</code> interface. The header file is <code>src/util/XMLNetAccessor.hpp</code>. This interface allows you to plug in your own implementation of URL
  +        using additional protocols, ftp for example, &XercesCName; provides the <code>NetAccessor</code> interface. The header file is <code>src/xercesc/util/XMLNetAccessor.hpp</code>. This interface allows you to plug in your own implementation of URL
           networking code into the &XercesCName; parser.</p>
   
       </a>
  
  
  
  1.5       +4 -0      xml-xerces/c/doc/install.xml
  
  Index: install.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/install.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- install.xml	13 Feb 2002 19:49:39 -0000	1.4
  +++ install.xml	20 Feb 2002 21:01:56 -0000	1.5
  @@ -36,6 +36,10 @@
           which contains the &XercesCName; distribution. You will need to add the
           &XercesCInstallDir;-linux/bin directory to your PATH environment variable:</p>
   
  +        <note>On Solaris, you may need to use <code>gtar</code> instead of tar.  See
  +        <jump href="faq-distrib.html#faq-11">FAQ</jump> for more information.</note>
  +
  +
           <p>For Bourne Shell, K Shell or Bash, type: </p>
   <source>export PATH="$PATH:$HOME/&XercesCInstallDir;-linux/bin"</source>
   		<p>For C Shell, type:</p>
  
  
  
  1.19      +63 -25    xml-xerces/c/doc/migration.xml
  
  Index: migration.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/migration.xml,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- migration.xml	13 Feb 2002 19:49:39 -0000	1.18
  +++ migration.xml	20 Feb 2002 21:01:56 -0000	1.19
  @@ -22,7 +22,10 @@
       <anchor name="NewFeatures"/>
       <s2 title="New features in &XercesCName; &XercesCVersion; code base">
         <ul>
  -        <li>SAX2-ext's DeclHandler.</li>
  +        <li>Added SAX2-ext's DeclHandler.</li>
  +        <li>Added support for building with new MacOSURLAccessCF NetAccessor.</li>
  +        <li>Used IDOMParser instead of DOMParser in Schema Processing for better performance.</li>
  +        <li>Added test case IDOMMemTest.</li>
         </ul>
       </s2>
   
  @@ -36,9 +39,10 @@
           <anchor name="NewAPI"/>
           <s3 title="New Public API">
               <ul>
  -              <li>SAX2-ext's DeclHandler class.
  +              <li>Added SAX2-ext's DeclHandler class.
                     See <jump href="api.html">the API documentation page</jump> for details.</li>
  -              <li>To support SAX2-ext's DeclHandler, the following new methods are added:</li>
  +              <li>To support SAX2-ext's DeclHandler, the following new methods are added
  +                  in classes DefaultHandler and SAX2XMLReader:</li>
                 <ul>
                   <li>void DefaultHandler::elementDecl(const XMLCh* const name, const XMLCh* const model)</li>
                   <li>void DefaultHandler::attributeDecl(const XMLCh* const eName, const XMLCh* const aName,
  @@ -48,23 +52,55 @@
                       const XMLCh* const systemId)</li>
                   <li>DeclHandler* SAX2XMLReader::getDeclarationHandler() const</li>
                   <li>void SAX2XMLReader::setDeclarationHandler(DeclHandler* const handler)</li>
  -                <li>DeclHandler* SAX2XMLReaderImpl::getDeclarationHandler() const</li>
  -                <li>void SAX2XMLReaderImpl::setDeclarationHandler(DeclHandler* const handler)</li>
                 </ul>
  +              <li>To conform to DOM Level 2 specifiction, the following methods are added:</li>
  +              <ul>
  +                <li>DOM_Node DOM_NodeIterator::getRoot()</li>
  +                <li>DOM_Node DOM_TreeWalker::getRoot()</li>
  +                <li>bool DOM_Node::hasAttributes() const</li>
  +                <li>bool DOM_Element::hasAttribute(const DOMString &amp;name) const</li>
  +                <li>bool DOM_Element::hasAttributeNS(const DOMString &amp;namespaceURI,
  +                                const DOMString &amp;localName) const</li>
  +                <li>IDOM_Node* IDOM_NodeIterator::getRoot()</li>
  +                <li>IDOM_Node* IDOM_TreeWalker::getRoot()</li>
  +                <li>bool IDOM_Node::hasAttributes() const</li>
  +                <li>bool IDOM_Element::hasAttribute(const XMLCh* name) const</li>
  +                <li>bool IDOM_Element::hasAttributeNS(const XMLCh* namespaceURI,
  +                                const XMLCh* localName) const</li>
  +              </ul>
  +              <li>To fix [Bug 5570], a copy constructor is added to DOM_Range</li>
               </ul>
           </s3>
   
           <anchor name="ModifiedAPI"/>
           <s3 title="Modified Public API">
               <ul>
  -              <li>The namespace-prefixes feature in SAX2 is set to off as default.</li>
  +              <li>To conform to the SAX2 specification, the namespace-prefixes feature
  +                  in SAX2 is set to off as default.</li>
  +              <li>To fix [Bug 6330], the Base64::encode and Base64::decode have been modified
  +                  as follows</li>
  +                  <ul>
  +                  <li>static XMLByte* Base64::encode(const XMLByte* const inputData,
  +                      const unsigned int   inputLength,
  +                      unsigned int*        outputLength);</li>
  +                  <li>static XMLByte* Base64::decode(const XMLByte* const inputData,
  +                           unsigned int*        outputLength);</li>
  +                  <li>static XMLCh* decode(const XMLCh* const inputData,
  +                         unsigned int*      outputLength);</li>
  +                  </ul>
  +              <li>To conform to DOM Level 2 specifiction, the DOM_Node::supports and IDOM_Node::supports
  +                  are modified to</li>
  +              <ul>
  +                <li>bool DOM_Node::isSupported(const DOMString &amp;feature, const DOMString &amp;version) const</li>
  +                <li>bool IDOM_Node::isSupported(const XMLCh* feature, const XMLCh* version) const</li>
  +              </ul>
               </ul>
           </s3>
   
           <anchor name="DeprecatedAPI"/>
           <s3 title="Deprecated Public API">
               <ul>
  -              <li></li>
  +              <li>No Deprecated Public API in this release.</li>
               </ul>
           </s3>
   
  @@ -72,24 +108,26 @@
   
       <anchor name="DirChange"/>
       <s2 title="Directory change in &XercesCName; &XercesCVersion; code base">
  -      <ul>
  -        <li>
  -            A new directory, <em>src/xercesc</em> is created to be the new parent directory to
  -			all src's direct subdirectories.</li>
  -        <li>
  -            Windows application, <br/>
  -			shall either change the <em>additional include directories </em> setting,
  -			to "..\..\..\..\..\src\<em>xercesc</em>" (Projects->settings->C/C++->Preprocessor).
  -			or <br/>
  -			change the relevant #include instances, in the source/header files, accordingly, eg <br/>
  -			#include &lt;util/XMLString.hpp&gt; be changed to <br/>
  -			#include &lt;<em>xercesc</em>/util/XMLString.hpp&gt; </li>
  -        <li>
  -            Unix application, <br/>
  -			shall either add the line to the Makefile " -I &lt;installroot&gt;/include/<em>xercesc</em>",
  -			or <br/>
  -			change the relevant #include instances in the source/header files as shown above. </li>
  -      </ul>
  +        <ul>
  +            <li>A new directory, <em>src/xercesc</em> is created to be the new parent directory to
  +                all src's direct subdirectories.</li>
  +            <li>And in the binary package, all the headers are distributed in <em>include/xercesc</em> directory.</li>
  +            <li>Migration considerations:</li>
  +            <ul>
  +              <li>Windows application, <br/>
  +                  shall either change the <em>include directories </em> setting to
  +                  "..\..\..\..\..\src\<em>xercesc</em>" (Projects->settings->C/C++->Preprocessor), <br/>
  +                  or <br/>
  +                  change the relevant #include instances in the source/header files, accordingly, eg <br/>
  +                  #include &lt;util/XMLString.hpp&gt; be changed to <br/>
  +                  #include &lt;<em>xercesc</em>/util/XMLString.hpp&gt; </li>
  +              <li>Unix application, <br/>
  +                  shall either change the <em>include search path </em> in the Makefile to
  +                  " -I &lt;installroot&gt;/include/<em>xercesc</em>", <br/>
  +                  or <br/>
  +                  change the relevant #include instances in the source/header files as shown above. </li>
  +            </ul>
  +        </ul>
       </s2>
   
       <s2 title="Migration Archive">
  
  
  
  1.3       +1 -1      xml-xerces/c/doc/program-dom.xml
  
  Index: program-dom.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/program-dom.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- program-dom.xml	13 Feb 2002 19:49:39 -0000	1.2
  +++ program-dom.xml	20 Feb 2002 21:01:56 -0000	1.3
  @@ -21,7 +21,7 @@
   
   <source>
   // C++
  -#include &lt;dom/DOM.hpp></source>
  +#include &lt;xercesc/dom/DOM.hpp></source>
   
   <source>// Java
   import org.w3c.dom.*</source>
  
  
  
  1.3       +2 -2      xml-xerces/c/doc/program-sax.xml
  
  Index: program-sax.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/program-sax.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- program-sax.xml	13 Feb 2002 19:49:39 -0000	1.2
  +++ program-sax.xml	20 Feb 2002 21:01:56 -0000	1.3
  @@ -71,7 +71,7 @@
           called when XML constructs are recognized, and ErrorHandler
           which is called when an error occurs. The header files for the
           various SAX handler classes are in
  -        '&lt;&XercesCInstallDir;>/include/sax'</p>
  +        '&lt;&XercesCInstallDir;>/include/xercesc/sax'</p>
   
         <p>As a convenience, &XercesCName; provides the class
           HandlerBase, which is a single class which is publicly derived
  @@ -86,7 +86,7 @@
           additional examples of how to write handler classes.</p>
   
         <p>This is the header file MySAXHandler.hpp:</p>
  -<source>#include &lt;sax/HandlerBase.hpp>
  +<source>#include &lt;xercesc/sax/HandlerBase.hpp>
   
   class MySAXHandler : public HandlerBase {
   public:
  
  
  
  1.5       +2 -2      xml-xerces/c/doc/program-sax2.xml
  
  Index: program-sax2.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/doc/program-sax2.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- program-sax2.xml	13 Feb 2002 19:49:39 -0000	1.4
  +++ program-sax2.xml	20 Feb 2002 21:01:56 -0000	1.5
  @@ -70,7 +70,7 @@
           called when XML constructs are recognized, and ErrorHandler
           which is called when an error occurs. The header files for the
           various SAX2 handler classes are in
  -        '&lt;&XercesCInstallDir;>/include/sax2'</p>
  +        '&lt;&XercesCInstallDir;>/include/xercesc/sax2'</p>
   
         <p>As a convenience, &XercesCName; provides the class
           DefaultHandler, which is a single class which is publicly derived
  @@ -85,7 +85,7 @@
           additional examples of how to write handler classes.</p>
   
         <p>This is the header file MySAX2Handler.hpp:</p>
  -<source>#include &lt;sax2/DefaultHandler.hpp>
  +<source>#include &lt;xercesc/sax2/DefaultHandler.hpp>
   
   class MySAX2Handler : public DefaultHandler {
   public:
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org