00001 /*
00002 * The Apache Software License, Version 1.1
00003 *
00004 * Copyright (c) 1999-2000 The Apache Software Foundation. All rights
00005 * reserved.
00006 *
00007 * Redistribution and use in source and binary forms, with or without
00008 * modification, are permitted provided that the following conditions
00009 * are met:
00010 *
00011 * 1. Redistributions of source code must retain the above copyright
00012 * notice, this list of conditions and the following disclaimer.
00013 *
00014 * 2. Redistributions in binary form must reproduce the above copyright
00015 * notice, this list of conditions and the following disclaimer in
00016 * the documentation and/or other materials provided with the
00017 * distribution.
00018 *
00019 * 3. The end-user documentation included with the redistribution,
00020 * if any, must include the following acknowledgment:
00021 * "This product includes software developed by the
00022 * Apache Software Foundation (http://www.apache.org/)."
00023 * Alternately, this acknowledgment may appear in the software itself,
00024 * if and wherever such third-party acknowledgments normally appear.
00025 *
00026 * 4. The names "Xerces" and "Apache Software Foundation" must
00027 * not be used to endorse or promote products derived from this
00028 * software without prior written permission. For written
00029 * permission, please contact apache\@apache.org.
00030 *
00031 * 5. Products derived from this software may not be called "Apache",
00032 * nor may "Apache" appear in their name, without prior written
00033 * permission of the Apache Software Foundation.
00034 *
00035 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046 * SUCH DAMAGE.
00047 * ====================================================================
00048 *
00049 * This software consists of voluntary contributions made by many
00050 * individuals on behalf of the Apache Software Foundation, and was
00051 * originally based on software copyright (c) 1999, International
00052 * Business Machines, Inc., http://www.ibm.com . For more information
00053 * on the Apache Software Foundation, please see
00054 * <http://www.apache.org/>.
00055 */
00056
00057 /*
00058 * $Log: TreeWalkerImpl.hpp,v $
00059 * Revision 1.5 2000/02/24 20:11:31 abagchi
00060 * Swat for removing Log from API docs
00061 *
00062 * Revision 1.4 2000/02/15 23:17:37 andyh
00063 * Update Doc++ API comments
00064 * NameSpace bugfix and update to track W3C
00065 * Chih Hsiang Chou
00066 *
00067 * Revision 1.3 2000/02/06 07:47:34 rahulj
00068 * Year 2K copyright swat.
00069 *
00070 * Revision 1.2 2000/02/04 01:49:24 aruna1
00071 * TreeWalker and NodeIterator changes
00072 *
00073 * Revision 1.1.1.1 1999/11/09 01:09:20 twl
00074 * Initial checkin
00075 *
00076 * Revision 1.3 1999/11/08 20:44:34 rahul
00077 * Swat for adding in Product name and CVS comment log variable.
00078 *
00079 */
00080
00081 #ifndef TreeWalkerImpl_HEADER_GUARD_
00082 #define TreeWalkerImpl_HEADER_GUARD_
00083
00084
00085 #include "DOM_TreeWalker.hpp"
00086 #include "RefCountedImpl.hpp"
00087
00088
00089 class TreeWalkerImpl : public RefCountedImpl {
00090
00091 public:
00092 // Implementation Note: No state is kept except the data above
00093 // (fWhatToShow, fNodeFilter, fCurrentNode, fRoot) such that
00094 // setters could be created for these data values and the
00095 // implementation will still work.
00096
00098 TreeWalkerImpl (
00099 DOM_Node root,
00100 unsigned long whatToShow,
00101 DOM_NodeFilter* nodeFilter,
00102 bool expandEntityRef);
00103 TreeWalkerImpl (const TreeWalkerImpl& twi);
00104 TreeWalkerImpl& operator= (const TreeWalkerImpl& twi);
00105
00106 // Return the whatToShow value.
00107 unsigned long getWhatToShow ();
00108
00109 // Return the NodeFilter.
00110 DOM_NodeFilter* getFilter ();
00111
00112 void detach ();
00113
00114 // Return the current DOM_Node.
00115 DOM_NodegetCurrentNode ();
00116
00117 // Return the current Node.
00118 void setCurrentNode (DOM_Node node);
00119
00120 // Return the parent Node from the current node,
00121 // after applying filter, whatToshow.
00122 // If result is not null, set the current Node.
00123 DOM_NodeparentNode ();
00124
00125 // Return the first child Node from the current node,
00126 // after applying filter, whatToshow.
00127 // If result is not null, set the current Node.
00128 DOM_NodefirstChild ();
00129
00130 // Return the last child Node from the current node,
00131 // after applying filter, whatToshow.
00132 // If result is not null, set the current Node.
00133 DOM_NodelastChild ();
00134
00135 // Return the previous sibling Node from the current node,
00136 // after applying filter, whatToshow.
00137 // If result is not null, set the current Node.
00138 DOM_NodepreviousSibling ();
00139
00140 // Return the next sibling Node from the current node,
00141 // after applying filter, whatToshow.
00142 // If result is not null, set the current Node.
00143
00144 DOM_NodenextSibling ();
00145 // Return the previous Node from the current node,
00146 // after applying filter, whatToshow.
00147 // If result is not null, set the current Node.
00148 DOM_NodepreviousNode ();
00149
00150 // Return the next Node from the current node,
00151 // after applying filter, whatToshow.
00152 // If result is not null, set the current Node.
00153 DOM_NodenextNode ();
00154
00155 void unreferenced ();
00156
00157 // Get the expandEntity reference flag.
00158 bool getExpandEntityReferences();
00159
00160 protected:
00161
00162 // Internal function.
00163 // Return the parent Node, from the input node
00164 // after applying filter, whatToshow.
00165 // The current node is not consulted or set.
00166 DOM_NodegetParentNode (DOM_Node node);
00167
00168 // Internal function.
00169 // Return the nextSibling Node, from the input node
00170 // after applying filter, whatToshow.
00171 // The current node is not consulted or set.
00172 DOM_NodegetNextSibling (DOM_Node node);
00173
00174 // Internal function.
00175 // Return the previous sibling Node, from the input node
00176 // after applying filter, whatToshow.
00177 // The current node is not consulted or set.
00178 DOM_NodegetPreviousSibling (DOM_Node node);
00179
00180 // Internal function.
00181 // Return the first child Node, from the input node
00182 // after applying filter, whatToshow.
00183 // The current node is not consulted or set.
00184 DOM_NodegetFirstChild (DOM_Node node);
00185
00186 // Internal function.
00187 // Return the last child Node, from the input node
00188 // after applying filter, whatToshow.
00189 // The current node is not consulted or set.
00190 DOM_NodegetLastChild (DOM_Node node);
00191
00192 // The node is accepted if it passes the whatToShow and the filter.
00193 short acceptNode (DOM_Node node);
00194
00195
00196 private:
00197 // The whatToShow mask.
00198 unsigned long fWhatToShow;
00199
00200 // The NodeFilter reference.
00201 DOM_NodeFilter* fNodeFilter;
00202
00203 // The current Node.
00204 DOM_Node fCurrentNode;
00205
00206 // The root Node.
00207 DOM_Node fRoot;
00208
00209 // The expandEntity reference flag.
00210 bool fExpandEntityReferences;
00211
00212 bool fDetached;
00213 };
00214
00215 #endif