Back to index

lightning-sunbird  0.9+nobinonly
nsIParserNode.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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 
00055 #ifndef NS_IPARSERNODE__
00056 #define NS_IPARSERNODE__
00057 
00058 #include "nsISupports.h"
00059 #include "prtypes.h"
00060 #include "nsString.h"
00061 #include "nsDebug.h"
00062 
00063 //#define HEAP_ALLOCATED_NODES 
00064 //#define DEBUG_TRACK_NODES
00065 
00066 class nsIAtom;
00067 class CToken;
00068 
00069 // 6e59f160-2717-11d2-9246-00805f8a7ab6
00070 #define NS_IPARSER_NODE_IID      \
00071   {0x6e59f160, 0x2717,  0x11d1,  \
00072   {0x92, 0x46, 0x00,    0x80, 0x5f, 0x8a, 0x7a, 0xb6}}
00073 
00082 class nsIParserNode { // XXX Should be nsAParserNode
00083             
00084   public:
00085 
00086 
00092     virtual const nsAString& GetTagName() const = 0;  //to get name of tag
00093 
00099     virtual const nsAString& GetText() const = 0;  //get plain text if available
00100 
00106     virtual PRInt32 GetNodeType()  const =0;
00107 
00113     virtual PRInt32 GetTokenType()  const =0;
00114 
00120     virtual PRInt32 GetAttributeCount(PRBool askToken=PR_FALSE) const =0;
00121 
00128     virtual const nsAString& GetKeyAt(PRUint32 anIndex) const = 0;
00129 
00136     virtual const nsAString& GetValueAt(PRUint32 anIndex) const = 0;
00137 
00145     virtual PRInt32 TranslateToUnicodeStr(nsString& aString) const = 0;
00146 
00147 
00148     virtual void AddAttribute(CToken* aToken)=0;
00149 
00156     virtual PRInt32 GetSourceLineNumber(void) const =0;
00157 
00163     virtual PRBool  GetGenericState(void) const =0;
00164     virtual void    SetGenericState(PRBool aState) =0;
00165 
00170     virtual void GetSource(nsString& aString)=0;
00171 
00176     virtual nsresult ReleaseAll()=0;
00177 };
00178 
00179 #endif