Back to index

lightning-sunbird  0.9+nobinonly
nsXPathResult.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is TransforMiiX XSLT processor code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Peter Van der Beken <peterv@propagandism.org>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsXPathResult_h__
00040 #define nsXPathResult_h__
00041 
00042 #include "ExprResult.h"
00043 #include "nsIDOMXPathResult.h"
00044 #include "nsIDocument.h"
00045 #include "nsIDocumentObserver.h"
00046 #include "nsCOMPtr.h"
00047 #include "nsCOMArray.h"
00048 
00049 // {15b9b301-2012-11d6-a7f2-e6d0a678995c}
00050 #define NS_IXPATHRESULT_IID \
00051 { 0x15b9b301, 0x2012, 0x11d6, {0xa7, 0xf2, 0xe6, 0xd0, 0xa6, 0x78, 0x99, 0x5c }};
00052 
00053 class nsIXPathResult : public nsISupports
00054 {
00055 public:
00056     NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXPATHRESULT_IID)
00057     virtual nsresult SetExprResult(txAExprResult *aExprResult,
00058                                    PRUint16 aResultType) = 0;
00059     virtual nsresult GetExprResult(txAExprResult **aExprResult) = 0;
00060     virtual nsresult Clone(nsIXPathResult **aResult) = 0;
00061 };
00062 
00067 class txResultHolder
00068 {
00069 public:
00070     ~txResultHolder()
00071     {
00072       releaseNodeSet();
00073     }
00074 
00075     txAExprResult *get()
00076     {
00077         return mResult;
00078     }
00079     void set(txAExprResult *aResult);
00080 
00081 private:
00082     void releaseNodeSet();
00083 
00084     nsRefPtr<txAExprResult> mResult;
00085 };
00086 
00090 class nsXPathResult : public nsIDOMXPathResult,
00091                       public nsIDocumentObserver,
00092                       public nsIXPathResult
00093 {
00094 public:
00095     nsXPathResult();
00096     virtual ~nsXPathResult();
00097 
00098     // nsISupports interface
00099     NS_DECL_ISUPPORTS
00100 
00101     // nsIDOMXPathResult interface
00102     NS_DECL_NSIDOMXPATHRESULT
00103 
00104     // nsIDocumentObserver interface
00105     NS_DECL_NSIDOCUMENTOBSERVER
00106 
00107     // nsIXPathResult interface
00108     nsresult SetExprResult(txAExprResult *aExprResult, PRUint16 aResultType);
00109     nsresult GetExprResult(txAExprResult **aExprResult);
00110     nsresult Clone(nsIXPathResult **aResult);
00111 
00112 private:
00113     PRBool isSnapshot() const
00114     {
00115         return mResultType == UNORDERED_NODE_SNAPSHOT_TYPE ||
00116                mResultType == ORDERED_NODE_SNAPSHOT_TYPE;
00117     }
00118     PRBool isIterator() const
00119     {
00120         return mResultType == UNORDERED_NODE_ITERATOR_TYPE ||
00121                mResultType == ORDERED_NODE_ITERATOR_TYPE;
00122     }
00123     PRBool isNode() const
00124     {
00125         return mResultType == FIRST_ORDERED_NODE_TYPE ||
00126                mResultType == ANY_UNORDERED_NODE_TYPE;
00127     }
00128 
00129     void Invalidate();
00130 
00131     txResultHolder mResult;
00132     nsCOMPtr<nsIDocument> mDocument;
00133     PRUint32 mCurrentPos;
00134     PRUint16 mResultType;
00135     PRPackedBool mInvalidIteratorState;
00136 };
00137 
00138 #endif