DOMLocator.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:9k
源码类别:

词法分析

开发平台:

Visual C++

  1. #ifndef DOMLocator_HEADER_GUARD_
  2. #define DOMLocator_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 1999, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Log: DOMLocator.hpp,v $
  60.  * Revision 1.7  2003/03/07 19:59:05  tng
  61.  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
  62.  *
  63.  * Revision 1.6  2002/11/04 15:09:24  tng
  64.  * C++ Namespace Support.
  65.  *
  66.  * Revision 1.5  2002/08/22 15:04:57  tng
  67.  * Remove unused parameter variables in inline functions.
  68.  *
  69.  * Revision 1.4  2002/06/06 20:53:06  tng
  70.  * Documentation Fix: Update the API Documentation for DOM headers
  71.  *
  72.  * Revision 1.3  2002/05/30 19:24:48  knoaman
  73.  * documentation update
  74.  *
  75.  * Revision 1.2  2002/05/27 18:28:26  tng
  76.  * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
  77.  *
  78.  * Revision 1.1  2002/05/23 15:47:24  knoaman
  79.  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
  80.  *
  81.  */
  82. #include <xercesc/util/XercesDefs.hpp>
  83. XERCES_CPP_NAMESPACE_BEGIN
  84. class DOMNode;
  85. /**
  86.   * DOMLocator is an interface that describes a location. (e.g. where an error
  87.   * occured).
  88.   *
  89.   * @see DOMError#DOMError
  90.   * @since DOM Level 3
  91.   */
  92. class CDOM_EXPORT DOMLocator
  93. {
  94. protected:
  95.     // -----------------------------------------------------------------------
  96.     //  Hidden constructors
  97.     // -----------------------------------------------------------------------
  98.     /** @name Hidden constructors */
  99.     //@{    
  100.     DOMLocator() {};
  101.     //@}
  102.     
  103. private:    
  104.     // -----------------------------------------------------------------------
  105.     // Unimplemented constructors and operators
  106.     // -----------------------------------------------------------------------
  107.     /** @name Unimplemented constructors and operators */
  108.     //@{
  109.     DOMLocator(const DOMLocator &);
  110.     DOMLocator & operator = (const DOMLocator &);
  111.     //@}
  112. public:
  113.     // -----------------------------------------------------------------------
  114.     //  All constructors are hidden, just the destructor is available
  115.     // -----------------------------------------------------------------------
  116.     /** @name Destructor */
  117.     //@{
  118.     /**
  119.      * Destructor
  120.      *
  121.      */
  122.     virtual ~DOMLocator() {};
  123.     //@}
  124.     // -----------------------------------------------------------------------
  125.     //  Virtual DOMLocator interface
  126.     // -----------------------------------------------------------------------
  127.     /** @name Functions introduced in DOM Level 3 */
  128.     //@{
  129.     // -----------------------------------------------------------------------
  130.     //  Getter methods
  131.     // -----------------------------------------------------------------------
  132.     /**
  133.      * Get the line number where the error occured. The value is -1 if there is
  134.      * no line number available.
  135.      *
  136.      * <p><b>"Experimental - subject to change"</b></p>
  137.      *
  138.      * @see #setLineNumber
  139.      * @since DOM Level 3
  140.      */
  141.     virtual XMLSSize_t getLineNumber() const = 0;
  142.     /**
  143.      * Get the column number where the error occured. The value is -1 if there
  144.      * is no column number available.
  145.      *
  146.      * <p><b>"Experimental - subject to change"</b></p>
  147.      *
  148.      * @see #setColumnNumber
  149.      * @since DOM Level 3
  150.      */
  151.     virtual XMLSSize_t getColumnNumber() const = 0;
  152.     /**
  153.      * Get the byte or character offset into the input source, if we're parsing
  154.      * a file or a byte stream then this will be the byte offset into that
  155.      * stream, but if a character media is parsed then the offset will be the
  156.      * character offset. The value is -1 if there is no offset available.
  157.      *
  158.      * <p><b>"Experimental - subject to change"</b></p>
  159.      *
  160.      * @see #setOffset
  161.      * @since DOM Level 3
  162.      */
  163.     virtual XMLSSize_t getOffset() const = 0;
  164.     /**
  165.      * Get the DOMNode where the error occured, or <code>null</code> if there
  166.      * is no node available.
  167.      *
  168.      * <p><b>"Experimental - subject to change"</b></p>
  169.      *
  170.      * @see #setErrorNode
  171.      * @since DOM Level 3
  172.      */
  173.     virtual DOMNode* getErrorNode() const = 0;
  174.     /**
  175.      * Get the URI where the error occured, or <code>null</code> if there is no
  176.      * URI available.
  177.      *
  178.      * <p><b>"Experimental - subject to change"</b></p>
  179.      *
  180.      * @see #setURI
  181.      * @since DOM Level 3
  182.      */
  183.     virtual const XMLCh* getURI() const = 0;
  184.     // -----------------------------------------------------------------------
  185.     //  Setter methods
  186.     // -----------------------------------------------------------------------
  187.     /**
  188.      * Set the line number of the error
  189.      *
  190.      * <p><b>"Experimental - subject to change"</b></p>
  191.      *
  192.      * @param lineNumber the line number to set
  193.      *
  194.      * @see #getLinNumner
  195.      * @since DOM Level 3
  196.      */
  197.     virtual void setLineNumber(const XMLSSize_t lineNumber) = 0;
  198.     /**
  199.      * Set the column number of the error
  200.      *
  201.      * <p><b>"Experimental - subject to change"</b></p>
  202.      *
  203.      * @param columnNumber the column number to set.
  204.      *
  205.      * @see #getColumnNumner
  206.      * @since DOM Level 3
  207.      */
  208.     virtual void setColumnNumber(const XMLSSize_t columnNumber) = 0;
  209.     /**
  210.      * Set the byte/character offset.
  211.      *
  212.      * <p><b>"Experimental - subject to change"</b></p>
  213.      *
  214.      * @param offset the byte/characte offset to set.
  215.      *
  216.      * @see #getOffset
  217.      * @since DOM Level 3
  218.      */
  219.     virtual void setOffset(const XMLSSize_t offset) = 0;
  220.     /**
  221.      * Set the DOMNode where the error occured
  222.      *
  223.      * <p><b>"Experimental - subject to change"</b></p>
  224.      *
  225.      * @param errorNode the DOMNode to set
  226.      *
  227.      * @see #getErrorNode
  228.      * @since DOM Level 3
  229.      */
  230.     virtual void setErrorNode(DOMNode* const errorNode) = 0;
  231.     /**
  232.      * Set the URI where the error occured
  233.      *
  234.      * <p><b>"Experimental - subject to change"</b></p>
  235.      *
  236.      * @param uri the URI to set.
  237.      *
  238.      * @see #getURI
  239.      * @since DOM Level 3
  240.      */
  241.     virtual void setURI(const XMLCh* const uri) = 0;
  242.     //@}
  243. };
  244. XERCES_CPP_NAMESPACE_END
  245. #endif