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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-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.  * $Id: DOM_ProcessingInstruction.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_ProcessingInstruction_HEADER_GUARD_
  60. #define DOM_ProcessingInstruction_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class ProcessingInstructionImpl;
  65. /**
  66.  * The <code>ProcessingInstruction</code> interface represents a  "processing
  67.  * instruction", used in XML as a way to keep processor-specific information
  68.  * in the text of the document.
  69.  */
  70. class  CDOM_EXPORT DOM_ProcessingInstruction: public DOM_Node {
  71. public:
  72.     /** @name Constructors and assignment operator */
  73.     //@{
  74.     /**
  75.       * Default constructor for DOM_ProcessingInstruction.  The resulting object
  76.       *  does not refer to an actual PI node; it will compare == to 0, and is similar
  77.       * to a null object reference variable in Java.  It may subsequently be
  78.       * assigned to refer to an actual PI node.
  79.       * <p>
  80.       * New Processing Instruction nodes are created by DOM_Document::createProcessingInstruction().
  81.       *
  82.       *
  83.       */
  84.     DOM_ProcessingInstruction();
  85.     /**
  86.       * Copy constructor.  Creates a new <code>DOM_ProcessingInstruction</code> that refers to the
  87.       * same underlying node as the original.  See also DOM_Node::clone(),
  88.       * which will copy the actual PI node, rather than just creating a new
  89.       * reference to the original node.
  90.       *
  91.       * @param other The object to be copied.
  92.       */
  93.     DOM_ProcessingInstruction(const DOM_ProcessingInstruction &other);
  94.     /**
  95.       * Assignment operator.
  96.       *
  97.       * @param other The object to be copied.
  98.       */
  99.     DOM_ProcessingInstruction & operator = (const DOM_ProcessingInstruction &other);
  100.     /**
  101.       * Assignment operator.  This overloaded variant is provided for
  102.       *   the sole purpose of setting a DOM_Node reference variable to
  103.       *   zero.  Nulling out a reference variable in this way will decrement
  104.       *   the reference count on the underlying Node object that the variable
  105.       *   formerly referenced.  This effect is normally obtained when reference
  106.       *   variable goes out of scope, but zeroing them can be useful for
  107.       *   global instances, or for local instances that will remain in scope
  108.       *   for an extended time,  when the storage belonging to the underlying
  109.       *   node needs to be reclaimed.
  110.       *
  111.       * @param val   Only a value of 0, or null, is allowed.
  112.       */
  113.     DOM_ProcessingInstruction & operator = (const DOM_NullPtr *val);
  114.     //@}
  115.     /** @name Destructor. */
  116.     //@{
  117.  /**
  118.   * Destructor for DOM_processingInstruction.  The object being destroyed is the reference
  119.       * object, not the underlying PI node itself.
  120.   *
  121.   */
  122.     ~DOM_ProcessingInstruction();
  123.     //@}
  124.     /** @name Get functions. */
  125.     //@{
  126.     /**
  127.      * The target of this processing instruction.
  128.      *
  129.      * XML defines this as being the
  130.      * first token following the markup that begins the processing instruction.
  131.      */
  132.     DOMString        getTarget() const;
  133.     /**
  134.      * The content of this processing instruction.
  135.      *
  136.      * This is from the first non
  137.      * white space character after the target to the character immediately
  138.      * preceding the <code>?&gt;</code>.
  139.      * @exception DOMException
  140.      *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  141.      */
  142.     DOMString        getData() const;
  143.     //@}
  144.     /** @name Set functions. */
  145.     //@{
  146.     /**
  147.     * Sets the content of this processing instruction.
  148.     *
  149.     * This is from the first non
  150.     * white space character after the target to the character immediately
  151.     * preceding the <code>?&gt;</code>.
  152.     * @param data The string containing the processing instruction
  153.     */
  154.     void             setData(const DOMString &data);
  155.     //@}
  156. protected:
  157.     DOM_ProcessingInstruction(ProcessingInstructionImpl *impl);
  158.     friend class DOM_Document;
  159. };
  160. XERCES_CPP_NAMESPACE_END
  161. #endif