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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 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: Locator.hpp,v $
  58.  * Revision 1.4  2003/03/07 18:10:06  tng
  59.  * Return a reference instead of void for operator=
  60.  *
  61.  * Revision 1.3  2002/11/04 14:56:26  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.2  2002/05/27 18:33:07  tng
  65.  * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
  66.  *
  67.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  68.  * sane_include
  69.  *
  70.  * Revision 1.6  2000/03/02 19:54:35  roddey
  71.  * This checkin includes many changes done while waiting for the
  72.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  73.  * available elsewhere.
  74.  *
  75.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  76.  * Swat for removing Log from API docs
  77.  *
  78.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  79.  * Removed duplicate CVS Log entries.
  80.  *
  81.  * Revision 1.3  2000/02/09 01:55:06  abagchi
  82.  * Removed private function docs
  83.  *
  84.  * Revision 1.2  2000/02/06 07:47:58  rahulj
  85.  * Year 2K copyright swat.
  86.  *
  87.  * Revision 1.1.1.1  1999/11/09 01:07:46  twl
  88.  * Initial checkin
  89.  *
  90.  * Revision 1.3  1999/11/08 20:45:01  rahul
  91.  * Swat for adding in Product name and CVS comment log variable.
  92.  *
  93.  */
  94. #ifndef LOCATOR_HPP
  95. #define LOCATOR_HPP
  96. #include <xercesc/util/XercesDefs.hpp>
  97. XERCES_CPP_NAMESPACE_BEGIN
  98. /**
  99.   * Interface for associating a SAX event with a document location.
  100.   *
  101.   * <p>If a SAX parser provides location information to the SAX
  102.   * application, it does so by implementing this interface and then
  103.   * passing an instance to the application using the document
  104.   * handler's setDocumentLocator method.  The application can use the
  105.   * object to obtain the location of any other document handler event
  106.   * in the XML source document.</p>
  107.   *
  108.   * <p>Note that the results returned by the object will be valid only
  109.   * during the scope of each document handler method: the application
  110.   * will receive unpredictable results if it attempts to use the
  111.   * locator at any other time.</p>
  112.   *
  113.   * <p>SAX parsers are not required to supply a locator, but they are
  114.   * very strong encouraged to do so.  If the parser supplies a
  115.   * locator, it must do so before reporting any other document events.
  116.   * If no locator has been set by the time the application receives
  117.   * the startDocument event, the application should assume that a
  118.   * locator is not available.</p>
  119.   *
  120.   * @see DocumentHandler#setDocumentLocator
  121.   */
  122. class SAX_EXPORT Locator
  123. {
  124. public:
  125.     /** @name Constructors and Destructor */
  126.     //@{
  127.     /** Default constructor */
  128.     Locator()
  129.     {
  130.     }
  131.     /** Destructor */
  132.     virtual ~Locator()
  133.     {
  134.     }
  135.     //@}
  136.     /** @name The locator interface */
  137.     //@{
  138.   /**
  139.     * Return the public identifier for the current document event.
  140.     * <p>This will be the public identifier
  141.     * @return A string containing the public identifier, or
  142.     *         null if none is available.
  143.     * @see #getSystemId
  144.     */
  145.     virtual const XMLCh* getPublicId() const = 0;
  146.   /**
  147.     * Return the system identifier for the current document event.
  148.     *
  149.     * <p>If the system identifier is a URL, the parser must resolve it
  150.     * fully before passing it to the application.</p>
  151.     *
  152.     * @return A string containing the system identifier, or null
  153.     *         if none is available.
  154.     * @see #getPublicId
  155.     */
  156.     virtual const XMLCh* getSystemId() const = 0;
  157.   /**
  158.     * Return the line number where the current document event ends.
  159.     * Note that this is the line position of the first character
  160.     * after the text associated with the document event.
  161.     * @return The line number, or -1 if none is available.
  162.     * @see #getColumnNumber
  163.     */
  164.     virtual XMLSSize_t getLineNumber() const = 0;
  165.   /**
  166.     * Return the column number where the current document event ends.
  167.     * Note that this is the column number of the first
  168.     * character after the text associated with the document
  169.     * event.  The first column in a line is position 1.
  170.     * @return The column number, or -1 if none is available.
  171.     * @see #getLineNumber
  172.     */
  173.     virtual XMLSSize_t getColumnNumber() const = 0;
  174.     //@}
  175. private :
  176.     /* Copy constructor */
  177.     Locator(const Locator&);
  178.     /* Assignment operator */
  179.     Locator& operator=(const Locator&);
  180. };
  181. XERCES_CPP_NAMESPACE_END
  182. #endif