Back to index

lightning-sunbird  0.9+nobinonly
nsXMLContentSerializer.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 #ifndef nsXMLContentSerializer_h__
00039 #define nsXMLContentSerializer_h__
00040 
00041 #include "nsIContentSerializer.h"
00042 #include "nsISupportsUtils.h"
00043 #include "nsCOMPtr.h"
00044 #include "nsVoidArray.h"
00045 
00046 class nsIDOMNode;
00047 
00048 class nsXMLContentSerializer : public nsIContentSerializer {
00049  public:
00050   nsXMLContentSerializer();
00051   virtual ~nsXMLContentSerializer();
00052 
00053   NS_DECL_ISUPPORTS
00054 
00055   NS_IMETHOD Init(PRUint32 flags, PRUint32 aWrapColumn,
00056                   const char* aCharSet, PRBool aIsCopying);
00057 
00058   NS_IMETHOD AppendText(nsIDOMText* aText, PRInt32 aStartOffset,
00059                         PRInt32 aEndOffset, nsAString& aStr);
00060 
00061   NS_IMETHOD AppendCDATASection(nsIDOMCDATASection* aCDATASection,
00062                                 PRInt32 aStartOffset, PRInt32 aEndOffset,
00063                                 nsAString& aStr);
00064 
00065   NS_IMETHOD AppendProcessingInstruction(nsIDOMProcessingInstruction* aPI,
00066                                          PRInt32 aStartOffset,
00067                                          PRInt32 aEndOffset,
00068                                          nsAString& aStr);
00069 
00070   NS_IMETHOD AppendComment(nsIDOMComment* aComment, PRInt32 aStartOffset,
00071                            PRInt32 aEndOffset, nsAString& aStr);
00072   
00073   NS_IMETHOD AppendDoctype(nsIDOMDocumentType *aDoctype,
00074                            nsAString& aStr);
00075 
00076   NS_IMETHOD AppendElementStart(nsIDOMElement *aElement,
00077                                 PRBool aHasChildren,
00078                                 nsAString& aStr);
00079   
00080   NS_IMETHOD AppendElementEnd(nsIDOMElement *aElement,
00081                               nsAString& aStr);
00082 
00083   NS_IMETHOD Flush(nsAString& aStr) { return NS_OK; }
00084 
00085   NS_IMETHOD AppendDocumentStart(nsIDOMDocument *aDocument,
00086                                  nsAString& aStr);
00087 
00088  protected:
00089   virtual void AppendToString(const PRUnichar* aStr,
00090                               PRInt32 aLength,
00091                               nsAString& aOutputStr);
00092   virtual void AppendToString(const PRUnichar aChar, nsAString& aOutputStr);
00093   virtual void AppendToString(const nsAString& aStr,
00094                               nsAString& aOutputStr,
00095                               PRBool aTranslateEntities = PR_FALSE,
00096                               PRBool aIncrColumn = PR_TRUE);
00097   nsresult AppendTextData(nsIDOMNode* aNode, 
00098                           PRInt32 aStartOffset,
00099                           PRInt32 aEndOffset,
00100                           nsAString& aStr,
00101                           PRBool aTranslateEntities,
00102                           PRBool aIncrColumn);
00103   virtual nsresult PushNameSpaceDecl(const nsAString& aPrefix,
00104                                      const nsAString& aURI,
00105                                      nsIDOMElement* aOwner);
00106   void PopNameSpaceDeclsFor(nsIDOMElement* aOwner);
00107 
00127   PRBool ConfirmPrefix(nsAString& aPrefix,
00128                        const nsAString& aURI,
00129                        nsIDOMElement* aElement,
00130                        PRBool aMustHavePrefix);
00134   void GenerateNewPrefix(nsAString& aPrefix);
00135   void SerializeAttr(const nsAString& aPrefix,
00136                      const nsAString& aName,
00137                      const nsAString& aValue,
00138                      nsAString& aStr,
00139                      PRBool aDoEscapeEntities);
00140   PRBool IsShorthandAttr(const nsIAtom* aAttrName,
00141                          const nsIAtom* aElementName);
00142 
00143   // Functions to check for newlines that needs to be added between nodes in
00144   // the root of a document.
00145   void MaybeAddNewline(nsAString& aStr);
00146   void MaybeFlagNewline(nsIDOMNode* aNode);
00147 
00148   PRInt32 mPrefixIndex;
00149   nsVoidArray mNameSpaceStack;
00150   PRPackedBool mInAttribute;
00151   PRPackedBool mAddNewline;
00152 };
00153 
00154 nsresult
00155 NS_NewXMLContentSerializer(nsIContentSerializer** aSerializer);
00156 
00157 #endif