pjs/content/base/src/nsXHTMLContentSerializer.h

209 строки
7.7 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Laurent Jouanneau <laurent.jouanneau@disruptive-innovations.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* nsIContentSerializer implementation that can be used with an
* nsIDocumentEncoder to convert an XHTML (not HTML!) DOM to an XHTML
* string that could be parsed into more or less the original DOM.
*/
#ifndef nsXHTMLContentSerializer_h__
#define nsXHTMLContentSerializer_h__
#include "nsXMLContentSerializer.h"
#include "nsIEntityConverter.h"
#include "nsString.h"
#include "nsTArray.h"
class nsIContent;
class nsIAtom;
class nsXHTMLContentSerializer : public nsXMLContentSerializer {
public:
nsXHTMLContentSerializer();
virtual ~nsXHTMLContentSerializer();
NS_IMETHOD Init(PRUint32 flags, PRUint32 aWrapColumn,
const char* aCharSet, PRBool aIsCopying,
PRBool aRewriteEncodingDeclaration);
NS_IMETHOD AppendText(nsIDOMText* aText,
PRInt32 aStartOffset,
PRInt32 aEndOffset,
nsAString& aStr);
NS_IMETHOD AppendDocumentStart(nsIDOMDocument *aDocument,
nsAString& aStr);
protected:
virtual PRBool CheckElementStart(nsIContent * aContent,
PRBool & aForceFormat,
nsAString& aStr);
virtual void AppendEndOfElementStart(nsIDOMElement *aOriginalElement,
nsIAtom * aName,
PRInt32 aNamespaceID,
nsAString& aStr);
virtual void AfterElementStart(nsIContent * aContent,
nsIDOMElement *aOriginalElement,
nsAString& aStr);
virtual PRBool CheckElementEnd(nsIContent * aContent,
PRBool & aForceFormat,
nsAString& aStr);
virtual void AfterElementEnd(nsIContent * aContent,
nsAString& aStr);
virtual PRBool LineBreakBeforeOpen(PRInt32 aNamespaceID, nsIAtom* aName);
virtual PRBool LineBreakAfterOpen(PRInt32 aNamespaceID, nsIAtom* aName);
virtual PRBool LineBreakBeforeClose(PRInt32 aNamespaceID, nsIAtom* aName);
virtual PRBool LineBreakAfterClose(PRInt32 aNamespaceID, nsIAtom* aName);
PRBool HasLongLines(const nsString& text, PRInt32& aLastNewlineOffset);
// functions to check if we enter in or leave from a preformated content
virtual void MaybeEnterInPreContent(nsIContent* aNode);
virtual void MaybeLeaveFromPreContent(nsIContent* aNode);
virtual void SerializeAttributes(nsIContent* aContent,
nsIDOMElement *aOriginalElement,
nsAString& aTagPrefix,
const nsAString& aTagNamespaceURI,
nsIAtom* aTagName,
nsAString& aStr,
PRUint32 aSkipAttr,
PRBool aAddNSAttr);
PRBool IsFirstChildOfOL(nsIDOMElement* aElement);
void SerializeLIValueAttribute(nsIDOMElement* aElement,
nsAString& aStr);
PRBool IsShorthandAttr(const nsIAtom* aAttrName,
const nsIAtom* aElementName);
virtual void AppendToString(const PRUnichar* aStr,
PRInt32 aLength,
nsAString& aOutputStr);
virtual void AppendToString(const PRUnichar aChar,
nsAString& aOutputStr);
virtual void AppendToString(const nsAString& aStr,
nsAString& aOutputStr);
virtual void AppendAndTranslateEntities(const nsAString& aStr,
nsAString& aOutputStr);
virtual void AppendToStringConvertLF(const nsAString& aStr,
nsAString& aOutputStr);
virtual void AppendToStringWrapped(const nsASingleFragmentString& aStr,
nsAString& aOutputStr);
virtual void AppendToStringFormatedWrapped(const nsASingleFragmentString& aStr,
nsAString& aOutputStr);
nsresult EscapeURI(nsIContent* aContent,
const nsAString& aURI,
nsAString& aEscapedURI);
nsCOMPtr<nsIEntityConverter> mEntityConverter;
PRInt32 mInBody;
/*
* isHTMLParser should be set to true by the HTML parser which inherits from
* this class. It avoids to redefine methods just for few changes.
*/
PRPackedBool mIsHTMLSerializer;
PRPackedBool mDoHeader;
PRPackedBool mBodyOnly;
PRPackedBool mIsCopying; // Set to PR_TRUE only while copying
/*
* mDisableEntityEncoding is higher than 0 while the serializer is serializing
* the content of a element whose content is considerd CDATA by the
* serializer (such elements are 'script', 'style', 'noscript' and
* possibly others in XHTML) This doesn't have anything to do with if the
* element is defined as CDATA in the DTD, it simply means we'll
* output the content of the element without doing any entity encoding
* what so ever.
*/
PRInt32 mDisableEntityEncoding;
// This is to ensure that we only do meta tag fixups when dealing with
// whole documents.
PRPackedBool mRewriteEncodingDeclaration;
// To keep track of First LI child of OL in selected range
PRPackedBool mIsFirstChildOfOL;
// To keep track of startvalue of OL and first list item for nested lists
struct olState {
olState(PRInt32 aStart, PRBool aIsFirst)
: startVal(aStart),
isFirstListItem(aIsFirst)
{
}
olState(const olState & aOlState)
{
startVal = aOlState.startVal;
isFirstListItem = aOlState.isFirstListItem;
}
// the value of the start attribute in the OL
PRInt32 startVal;
// is true only before the serialization of the first li of an ol
// should be false for other li in the list
PRBool isFirstListItem;
};
// Stack to store one olState struct per <OL>.
nsAutoTArray<olState, 8> mOLStateStack;
};
nsresult
NS_NewXHTMLContentSerializer(nsIContentSerializer** aSerializer);
#endif