Back to index

lightning-sunbird  0.9+nobinonly
nsFind.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 mozilla.org 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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Akkana Peck   <akkana@netscape.com>
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 nsFind_h__
00040 #define nsFind_h__
00041 
00042 #include "nsIFind.h"
00043 
00044 #include "nsCOMPtr.h"
00045 #include "nsIDOMNode.h"
00046 #include "nsIDOMRange.h"
00047 #include "nsIContentIterator.h"
00048 #include "nsIParserService.h"
00049 #include "nsIWordBreaker.h"
00050 
00051 class nsIPresShell;
00052 class nsIAtom;
00053 
00054 #define NS_FIND_CONTRACTID "@mozilla.org/embedcomp/rangefind;1"
00055 
00056 #define NS_FIND_CID \
00057  {0x471f4944, 0x1dd2, 0x11b2, {0x87, 0xac, 0x90, 0xbe, 0x0a, 0x51, 0xd6, 0x09}}
00058 
00059 class nsFind : public nsIFind
00060 {
00061 public:
00062   NS_DECL_ISUPPORTS
00063   NS_DECL_NSIFIND
00064 
00065   nsFind();
00066   virtual ~nsFind();
00067 
00068 protected:
00069   static PRInt32 sInstanceCount;
00070 
00071   // HTML tags we treat specially
00072   static nsIAtom* sImgAtom;
00073   static nsIAtom* sHRAtom;
00074   // Nodes we skip
00075   static nsIAtom* sScriptAtom;
00076   static nsIAtom* sNoframesAtom;
00077   static nsIAtom* sSelectAtom;
00078   static nsIAtom* sTextareaAtom;
00079   static nsIAtom* sThAtom;
00080   static nsIAtom* sTdAtom;
00081 
00082   // Parameters set from the interface:
00083   //nsCOMPtr<nsIDOMRange> mRange;   // search only in this range
00084   PRPackedBool mFindBackward;
00085   PRPackedBool mCaseSensitive;
00086 
00087   nsCOMPtr<nsIWordBreaker> mWordBreaker;
00088   nsCOMPtr<nsIParserService> mParserService;
00089 
00090   PRInt32 mIterOffset;
00091   nsCOMPtr<nsIDOMNode> mIterNode;
00092 
00093   // Last block parent, so that we will notice crossing block boundaries:
00094   nsCOMPtr<nsIDOMNode> mLastBlockParent;
00095   nsresult GetBlockParent(nsIDOMNode* aNode, nsIDOMNode** aParent);
00096 
00097   // Utility routines:
00098   PRBool IsTextNode(nsIDOMNode* aNode);
00099   PRBool IsBlockNode(nsIContent* aNode);
00100   PRBool SkipNode(nsIContent* aNode);
00101   PRBool IsVisibleNode(nsIDOMNode *aNode);
00102 
00103   // Move in the right direction for our search:
00104   nsresult NextNode(nsIDOMRange* aSearchRange,
00105                     nsIDOMRange* aStartPoint, nsIDOMRange* aEndPoint,
00106                     PRBool aContinueOk);
00107 
00108   // Reset variables before returning -- don't hold any references.
00109   void ResetAll();
00110 
00111   // The iterator we use to move through the document:
00112   nsresult InitIterator(nsIDOMRange* aSearchRange);
00113   nsCOMPtr<nsIContentIterator> mIterator;
00114 };
00115 
00116 #endif // nsFind_h__