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

词法分析

开发平台:

Visual C++

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