wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity
b6b5962e27
gecko/dom/base/nsDocumentEncoder.cpp

2109 lines
62 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* Object that can be used to serialize selections, ranges, or nodes
* to strings in a gazillion different ways.
*/
#include "nsIDocumentEncoder.h"
#include "nscore.h"
#include "nsIFactory.h"
#include "nsISupports.h"
#include "nsIDocument.h"
#include "nsIHTMLDocument.h"
#include "nsCOMPtr.h"
#include "nsIContentSerializer.h"
#include "nsIUnicodeEncoder.h"
#include "nsIOutputStream.h"
#include "nsIDOMElement.h"
#include "nsIDOMText.h"
#include "nsIDOMCDATASection.h"
#include "nsIDOMComment.h"
#include "nsIDOMProcessingInstruction.h"
#include "nsIDOMDocumentType.h"
#include "nsIDOMNodeList.h"
#include "nsRange.h"
#include "nsIDOMRange.h"
#include "nsIDOMDocument.h"
#include "nsGkAtoms.h"
#include "nsIContent.h"
#include "nsIParserService.h"
#include "nsIScriptContext.h"
#include "nsIScriptGlobalObject.h"
#include "nsIScriptSecurityManager.h"
#include "mozilla/dom/Selection.h"
#include "nsISelectionPrivate.h"
#include "nsITransferable.h" // for kUnicodeMime
#include "nsContentUtils.h"
#include "nsNodeUtils.h"
#include "nsUnicharUtils.h"
#include "nsReadableUtils.h"
#include "nsTArray.h"
#include "nsIFrame.h"
#include "nsStringBuffer.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/ShadowRoot.h"
#include "mozilla/dom/EncodingUtils.h"
#include "nsContainerFrame.h"
#include "nsBlockFrame.h"
#include "nsComputedDOMStyle.h"
using namespace mozilla;
using namespace mozilla::dom;
nsresult NS_NewDomSelection(nsISelection **aDomSelection);
enum nsRangeIterationDirection {
kDirectionOut = -1,
kDirectionIn = 1
};
class nsDocumentEncoder : public nsIDocumentEncoder
{
public:
nsDocumentEncoder();
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS(nsDocumentEncoder)
NS_DECL_NSIDOCUMENTENCODER
protected:
virtual ~nsDocumentEncoder();
void Initialize(bool aClearCachedSerializer = true);
nsresult SerializeNodeStart(nsINode* aNode, int32_t aStartOffset,
int32_t aEndOffset, nsAString& aStr,
nsINode* aOriginalNode = nullptr);
nsresult SerializeToStringRecursive(nsINode* aNode,
nsAString& aStr,
bool aDontSerializeRoot,
uint32_t aMaxLength = 0);
nsresult SerializeNodeEnd(nsINode* aNode, nsAString& aStr);
// This serializes the content of aNode.
nsresult SerializeToStringIterative(nsINode* aNode,
nsAString& aStr);
nsresult SerializeRangeToString(nsRange *aRange,
nsAString& aOutputString);
nsresult SerializeRangeNodes(nsRange* aRange,
nsINode* aNode,
nsAString& aString,
int32_t aDepth);
nsresult SerializeRangeContextStart(const nsTArray<nsINode*>& aAncestorArray,
nsAString& aString);
nsresult SerializeRangeContextEnd(const nsTArray<nsINode*>& aAncestorArray,
nsAString& aString);
virtual int32_t
GetImmediateContextCount(const nsTArray<nsINode*>& aAncestorArray)
{
return -1;
}
nsresult FlushText(nsAString& aString, bool aForce);
bool IsVisibleNode(nsINode* aNode)
{
NS_PRECONDITION(aNode, "");
if (mFlags & SkipInvisibleContent) {
// Treat the visibility of the ShadowRoot as if it were
// the host content.
nsCOMPtr<nsIContent> content;
ShadowRoot* shadowRoot = ShadowRoot::FromNode(aNode);
if (shadowRoot) {
content = shadowRoot->GetHost();
} else {
content = do_QueryInterface(aNode);
}
if (content) {
nsIFrame* frame = content->GetPrimaryFrame();
if (!frame) {
if (aNode->IsNodeOfType(nsINode::eTEXT)) {
// We have already checked that our parent is visible.
return true;
}
if (aNode->IsHTMLElement(nsGkAtoms::rp)) {
// Ruby parentheses are part of ruby structure, hence
// shouldn't be stripped out even if it is not displayed.
return true;
}
return false;
}
bool isVisible = frame->StyleVisibility()->IsVisible();
if (!isVisible && aNode->IsNodeOfType(nsINode::eTEXT))
return false;
}
}
return true;
}
virtual bool IncludeInContext(nsINode *aNode);
nsCOMPtr<nsIDocument> mDocument;
nsCOMPtr<nsISelection> mSelection;
RefPtr<nsRange> mRange;
nsCOMPtr<nsINode> mNode;
nsCOMPtr<nsIOutputStream> mStream;
nsCOMPtr<nsIContentSerializer> mSerializer;
nsCOMPtr<nsIUnicodeEncoder> mUnicodeEncoder;
nsCOMPtr<nsINode> mCommonParent;
nsCOMPtr<nsIDocumentEncoderNodeFixup> mNodeFixup;
nsString mMimeType;
nsCString mCharset;
uint32_t mFlags;
uint32_t mWrapColumn;
uint32_t mStartDepth;
uint32_t mEndDepth;
int32_t mStartRootIndex;
int32_t mEndRootIndex;
AutoTArray<nsINode*, 8> mCommonAncestors;
AutoTArray<nsIContent*, 8> mStartNodes;
AutoTArray<int32_t, 8> mStartOffsets;
AutoTArray<nsIContent*, 8> mEndNodes;
AutoTArray<int32_t, 8> mEndOffsets;
bool mHaltRangeHint;
// Used when context has already been serialized for
// table cell selections (where parent is <tr>)
bool mDisableContextSerialize;
bool mIsCopying; // Set to true only while copying
bool mNodeIsContainer;
nsStringBuffer* mCachedBuffer;
};
NS_IMPL_CYCLE_COLLECTING_ADDREF(nsDocumentEncoder)
NS_IMPL_CYCLE_COLLECTING_RELEASE(nsDocumentEncoder)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsDocumentEncoder)
NS_INTERFACE_MAP_ENTRY(nsIDocumentEncoder)
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTION(nsDocumentEncoder,
mDocument, mSelection, mRange, mNode, mCommonParent)
nsDocumentEncoder::nsDocumentEncoder() : mCachedBuffer(nullptr)
{
Initialize();
mMimeType.AssignLiteral("text/plain");
}
void nsDocumentEncoder::Initialize(bool aClearCachedSerializer)
{
mFlags = 0;
mWrapColumn = 72;
mStartDepth = 0;
mEndDepth = 0;
mStartRootIndex = 0;
mEndRootIndex = 0;
mHaltRangeHint = false;
mDisableContextSerialize = false;
mNodeIsContainer = false;
if (aClearCachedSerializer) {
mSerializer = nullptr;
}
}
nsDocumentEncoder::~nsDocumentEncoder()
{
if (mCachedBuffer) {
mCachedBuffer->Release();
}
}
NS_IMETHODIMP
nsDocumentEncoder::Init(nsIDOMDocument* aDocument,
const nsAString& aMimeType,
uint32_t aFlags)
{
if (!aDocument)
return NS_ERROR_INVALID_ARG;
nsCOMPtr<nsIDocument> doc = do_QueryInterface(aDocument);
NS_ENSURE_TRUE(doc, NS_ERROR_FAILURE);
return NativeInit(doc, aMimeType, aFlags);
}
NS_IMETHODIMP
nsDocumentEncoder::NativeInit(nsIDocument* aDocument,
const nsAString& aMimeType,
uint32_t aFlags)
{
if (!aDocument)
return NS_ERROR_INVALID_ARG;
Initialize(!mMimeType.Equals(aMimeType));
mDocument = aDocument;
mMimeType = aMimeType;
mFlags = aFlags;
mIsCopying = false;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetWrapColumn(uint32_t aWC)
{
mWrapColumn = aWC;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetSelection(nsISelection* aSelection)
{
mSelection = aSelection;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetRange(nsIDOMRange* aRange)
{
mRange = static_cast<nsRange*>(aRange);
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetNode(nsIDOMNode* aNode)
{
mNodeIsContainer = false;
mNode = do_QueryInterface(aNode);
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetNativeNode(nsINode* aNode)
{
mNodeIsContainer = false;
mNode = aNode;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetContainerNode(nsIDOMNode *aContainer)
{
mNodeIsContainer = true;
mNode = do_QueryInterface(aContainer);
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetNativeContainerNode(nsINode* aContainer)
{
mNodeIsContainer = true;
mNode = aContainer;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::SetCharset(const nsACString& aCharset)
{
mCharset = aCharset;
return NS_OK;
}
NS_IMETHODIMP
nsDocumentEncoder::GetMimeType(nsAString& aMimeType)
{
aMimeType = mMimeType;
return NS_OK;
}
bool
nsDocumentEncoder::IncludeInContext(nsINode *aNode)
{
return false;
}
static
bool
LineHasNonEmptyContentWorker(nsIFrame* aFrame)
{
// Look for non-empty frames, but ignore inline and br frames.
// For inline frames, descend into the children, if any.
if (aFrame->GetType() == nsGkAtoms::inlineFrame) {
for (nsIFrame* child : aFrame->PrincipalChildList()) {
if (LineHasNonEmptyContentWorker(child)) {
return true;
}
}
} else {
if (aFrame->GetType() != nsGkAtoms::brFrame &&
!aFrame->IsEmpty()) {
return true;
}
}
return false;
}
static
bool
LineHasNonEmptyContent(nsLineBox* aLine)
{
int32_t count = aLine->GetChildCount();
for (nsIFrame* frame = aLine->mFirstChild; count > 0;
--count, frame = frame->GetNextSibling()) {
if (LineHasNonEmptyContentWorker(frame)) {
return true;
}
}
return false;
}
static
bool
IsInvisibleBreak(nsINode *aNode)
{
if (!aNode->IsElement() || !aNode->IsEditable()) {
return false;
}
nsIFrame* frame = aNode->AsElement()->GetPrimaryFrame();
if (!frame || frame->GetType() != nsGkAtoms::brFrame) {
return false;
}
nsContainerFrame* f = frame->GetParent();
while (f && f->IsFrameOfType(nsBox::eLineParticipant)) {
f = f->GetParent();
}
nsBlockFrame* blockAncestor = do_QueryFrame(f);
if (!blockAncestor) {
// The container frame doesn't support line breaking.
return false;
}
bool valid = false;
nsBlockInFlowLineIterator iter(blockAncestor, frame, &valid);
if (!valid) {
return false;
}
bool lineNonEmpty = LineHasNonEmptyContent(iter.GetLine());
while (iter.Next()) {
auto currentLine = iter.GetLine();
// Completely skip empty lines.
if (!currentLine->IsEmpty()) {
// If we come across an inline line, the BR has caused a visible line break.
if (currentLine->IsInline()) {
return false;
}
}
}
return lineNonEmpty;
}
nsresult
nsDocumentEncoder::SerializeNodeStart(nsINode* aNode,
int32_t aStartOffset,
int32_t aEndOffset,
nsAString& aStr,
nsINode* aOriginalNode)
{
if (!IsVisibleNode(aNode))
return NS_OK;
nsINode* node = nullptr;
nsCOMPtr<nsINode> fixedNodeKungfuDeathGrip;
// Caller didn't do fixup, so we'll do it ourselves
if (!aOriginalNode) {
aOriginalNode = aNode;
if (mNodeFixup) {
bool dummy;
nsCOMPtr<nsIDOMNode> domNodeIn = do_QueryInterface(aNode);
nsCOMPtr<nsIDOMNode> domNodeOut;
mNodeFixup->FixupNode(domNodeIn, &dummy, getter_AddRefs(domNodeOut));
fixedNodeKungfuDeathGrip = do_QueryInterface(domNodeOut);
node = fixedNodeKungfuDeathGrip;
}
}
// Either there was no fixed-up node,
// or the caller did fixup themselves and aNode is already fixed
if (!node)
node = aNode;
if (node->IsElement()) {
if ((mFlags & (nsIDocumentEncoder::OutputPreformatted |
nsIDocumentEncoder::OutputDropInvisibleBreak)) &&
IsInvisibleBreak(node)) {
return NS_OK;
}
Element* originalElement =
aOriginalNode && aOriginalNode->IsElement() ?
aOriginalNode->AsElement() : nullptr;
mSerializer->AppendElementStart(node->AsElement(),
originalElement, aStr);
return NS_OK;
}
switch (node->NodeType()) {
case nsIDOMNode::TEXT_NODE:
{
mSerializer->AppendText(static_cast<nsIContent*>(node),
aStartOffset, aEndOffset, aStr);
break;
}
case nsIDOMNode::CDATA_SECTION_NODE:
{
mSerializer->AppendCDATASection(static_cast<nsIContent*>(node),
aStartOffset, aEndOffset, aStr);
break;
}
case nsIDOMNode::PROCESSING_INSTRUCTION_NODE:
{
mSerializer->AppendProcessingInstruction(static_cast<nsIContent*>(node),
aStartOffset, aEndOffset, aStr);
break;
}
case nsIDOMNode::COMMENT_NODE:
{
mSerializer->AppendComment(static_cast<nsIContent*>(node),
aStartOffset, aEndOffset, aStr);
break;
}
case nsIDOMNode::DOCUMENT_TYPE_NODE:
{
mSerializer->AppendDoctype(static_cast<nsIContent*>(node), aStr);
break;
}
}
return NS_OK;
}
nsresult
nsDocumentEncoder::SerializeNodeEnd(nsINode* aNode,
nsAString& aStr)
{
if (!IsVisibleNode(aNode))
return NS_OK;
if (aNode->IsElement()) {
mSerializer->AppendElementEnd(aNode->AsElement(), aStr);
}
return NS_OK;
}
nsresult
nsDocumentEncoder::SerializeToStringRecursive(nsINode* aNode,
nsAString& aStr,
bool aDontSerializeRoot,
uint32_t aMaxLength)
{
if (aMaxLength > 0 && aStr.Length() >= aMaxLength) {
return NS_OK;
}
if (!IsVisibleNode(aNode))
return NS_OK;
nsresult rv = NS_OK;
bool serializeClonedChildren = false;
nsINode* maybeFixedNode = nullptr;
// Keep the node from FixupNode alive.
nsCOMPtr<nsINode> fixedNodeKungfuDeathGrip;
if (mNodeFixup) {
nsCOMPtr<nsIDOMNode> domNodeIn = do_QueryInterface(aNode);
nsCOMPtr<nsIDOMNode> domNodeOut;
mNodeFixup->FixupNode(domNodeIn, &serializeClonedChildren, getter_AddRefs(domNodeOut));
fixedNodeKungfuDeathGrip = do_QueryInterface(domNodeOut);
maybeFixedNode = fixedNodeKungfuDeathGrip;
}
if (!maybeFixedNode)
maybeFixedNode = aNode;
if ((mFlags & SkipInvisibleContent) &&
!(mFlags & OutputNonTextContentAsPlaceholder)) {
if (aNode->IsNodeOfType(nsINode::eCONTENT)) {
nsIFrame* frame = static_cast<nsIContent*>(aNode)->GetPrimaryFrame();
if (frame) {
bool isSelectable;
frame->IsSelectable(&isSelectable, nullptr);
if (!isSelectable){
aDontSerializeRoot = true;
}
}
}
}
if (!aDontSerializeRoot) {
int32_t endOffset = -1;
if (aMaxLength > 0) {
MOZ_ASSERT(aMaxLength >= aStr.Length());
endOffset = aMaxLength - aStr.Length();
}
rv = SerializeNodeStart(maybeFixedNode, 0, endOffset, aStr, aNode);
NS_ENSURE_SUCCESS(rv, rv);
}
nsINode* node = serializeClonedChildren ? maybeFixedNode : aNode;
for (nsINode* child = nsNodeUtils::GetFirstChildOfTemplateOrNode(node);
child;
child = child->GetNextSibling()) {
rv = SerializeToStringRecursive(child, aStr, false, aMaxLength);
NS_ENSURE_SUCCESS(rv, rv);
}
if (!aDontSerializeRoot) {
rv = SerializeNodeEnd(node, aStr);
NS_ENSURE_SUCCESS(rv, rv);
}
return FlushText(aStr, false);
}
nsresult
nsDocumentEncoder::SerializeToStringIterative(nsINode* aNode,
nsAString& aStr)
{
nsresult rv;
nsINode* node = nsNodeUtils::GetFirstChildOfTemplateOrNode(aNode);
while (node) {
nsINode* current = node;
rv = SerializeNodeStart(current, 0, -1, aStr, current);
NS_ENSURE_SUCCESS(rv, rv);
node = nsNodeUtils::GetFirstChildOfTemplateOrNode(current);
while (!node && current && current != aNode) {
rv = SerializeNodeEnd(current, aStr);
NS_ENSURE_SUCCESS(rv, rv);
// Check if we have siblings.
node = current->GetNextSibling();
if (!node) {
// Perhaps parent node has siblings.
current = current->GetParentNode();
// Handle template element. If the parent is a template's content,
// then adjust the parent to be the template element.
if (current && current != aNode &&
current->NodeType() == nsIDOMNode::DOCUMENT_FRAGMENT_NODE) {
DocumentFragment* frag = static_cast<DocumentFragment*>(current);
nsIContent* host = frag->GetHost();
if (host && host->IsHTMLElement(nsGkAtoms::_template)) {
current = host;
}
}
}
}
}
return NS_OK;
}
static nsresult
ConvertAndWrite(const nsAString& aString,
nsIOutputStream* aStream,
nsIUnicodeEncoder* aEncoder)
{
NS_ENSURE_ARG_POINTER(aStream);
NS_ENSURE_ARG_POINTER(aEncoder);
nsresult rv;
int32_t charLength, startCharLength;
const nsPromiseFlatString& flat = PromiseFlatString(aString);
const char16_t* unicodeBuf = flat.get();
int32_t unicodeLength = aString.Length();
int32_t startLength = unicodeLength;
rv = aEncoder->GetMaxLength(unicodeBuf, unicodeLength, &charLength);
startCharLength = charLength;
NS_ENSURE_SUCCESS(rv, rv);
if (!charLength) {
// Nothing to write. Besides, a length 0 string has an immutable buffer, so
// attempts to null-terminate it will crash.
return NS_OK;
}
nsAutoCString charXferString;
if (!charXferString.SetLength(charLength, fallible))
return NS_ERROR_OUT_OF_MEMORY;
char* charXferBuf = charXferString.BeginWriting();
nsresult convert_rv = NS_OK;
do {
unicodeLength = startLength;
charLength = startCharLength;
convert_rv = aEncoder->Convert(unicodeBuf, &unicodeLength, charXferBuf, &charLength);
NS_ENSURE_SUCCESS(convert_rv, convert_rv);
// Make sure charXferBuf is null-terminated before we call
// Write().
charXferBuf[charLength] = '\0';
uint32_t written;
rv = aStream->Write(charXferBuf, charLength, &written);
NS_ENSURE_SUCCESS(rv, rv);
// If the converter couldn't convert a chraacer we replace the
// character with a characre entity.
if (convert_rv == NS_ERROR_UENC_NOMAPPING) {
// Finishes the conversion.
// The converter has the possibility to write some extra data and flush its final state.
char finish_buf[33];
charLength = sizeof(finish_buf) - 1;
rv = aEncoder->Finish(finish_buf, &charLength);
NS_ENSURE_SUCCESS(rv, rv);
// Make sure finish_buf is null-terminated before we call
// Write().
finish_buf[charLength] = '\0';
rv = aStream->Write(finish_buf, charLength, &written);
NS_ENSURE_SUCCESS(rv, rv);
nsAutoCString entString("&#");
if (NS_IS_HIGH_SURROGATE(unicodeBuf[unicodeLength - 1]) &&
unicodeLength < startLength && NS_IS_LOW_SURROGATE(unicodeBuf[unicodeLength])) {
entString.AppendInt(SURROGATE_TO_UCS4(unicodeBuf[unicodeLength - 1],
unicodeBuf[unicodeLength]));
unicodeLength += 1;
}
else
entString.AppendInt(unicodeBuf[unicodeLength - 1]);
entString.Append(';');
// Since entString is an nsAutoCString we know entString.get()
// returns a null-terminated string, so no need for extra
// null-termination before calling Write() here.
rv = aStream->Write(entString.get(), entString.Length(), &written);
NS_ENSURE_SUCCESS(rv, rv);
unicodeBuf += unicodeLength;
startLength -= unicodeLength;
}
} while (convert_rv == NS_ERROR_UENC_NOMAPPING);
return rv;
}
nsresult
nsDocumentEncoder::FlushText(nsAString& aString, bool aForce)
{
if (!mStream)
return NS_OK;
nsresult rv = NS_OK;
if (aString.Length() > 1024 || aForce) {
rv = ConvertAndWrite(aString, mStream, mUnicodeEncoder);
aString.Truncate();
}
return rv;
}
#if 0 // This code is really fast at serializing a range, but unfortunately
// there are problems with it so we don't use it now, maybe later...
static nsresult ChildAt(nsIDOMNode* aNode, int32_t aIndex, nsIDOMNode*& aChild)
{
nsCOMPtr<nsIContent> content(do_QueryInterface(aNode));
aChild = nullptr;
NS_ENSURE_TRUE(content, NS_ERROR_FAILURE);
nsIContent *child = content->GetChildAt(aIndex);
if (child)
return CallQueryInterface(child, &aChild);
return NS_OK;
}
static int32_t IndexOf(nsIDOMNode* aParent, nsIDOMNode* aChild)
{
nsCOMPtr<nsIContent> parent(do_QueryInterface(aParent));
nsCOMPtr<nsIContent> child(do_QueryInterface(aChild));
if (!parent)
return -1;
return parent->IndexOf(child);
}
static inline int32_t GetIndex(nsTArray<int32_t>& aIndexArray)
{
int32_t count = aIndexArray.Length();
if (count) {
return aIndexArray.ElementAt(count - 1);
}
return 0;
}
static nsresult GetNextNode(nsIDOMNode* aNode, nsTArray<int32_t>& aIndexArray,
nsIDOMNode*& aNextNode,
nsRangeIterationDirection& aDirection)
{
bool hasChildren;
aNextNode = nullptr;
aNode->HasChildNodes(&hasChildren);
if (hasChildren && aDirection == kDirectionIn) {
ChildAt(aNode, 0, aNextNode);
NS_ENSURE_TRUE(aNextNode, NS_ERROR_FAILURE);
aIndexArray.AppendElement(0);
aDirection = kDirectionIn;
} else if (aDirection == kDirectionIn) {
aNextNode = aNode;
NS_ADDREF(aNextNode);
aDirection = kDirectionOut;
} else {
nsCOMPtr<nsIDOMNode> parent;
aNode->GetParentNode(getter_AddRefs(parent));
NS_ENSURE_TRUE(parent, NS_ERROR_FAILURE);
int32_t count = aIndexArray.Length();
if (count) {
int32_t indx = aIndexArray.ElementAt(count - 1);
ChildAt(parent, indx + 1, aNextNode);
if (aNextNode)
aIndexArray.ElementAt(count - 1) = indx + 1;
else
aIndexArray.RemoveElementAt(count - 1);
} else {
int32_t indx = IndexOf(parent, aNode);
if (indx >= 0) {
ChildAt(parent, indx + 1, aNextNode);
if (aNextNode)
aIndexArray.AppendElement(indx + 1);
}
}
if (aNextNode) {
aDirection = kDirectionIn;
} else {
aDirection = kDirectionOut;
aNextNode = parent;
NS_ADDREF(aNextNode);
}
}
return NS_OK;
}
#endif
static bool IsTextNode(nsINode *aNode)
{
return aNode && aNode->IsNodeOfType(nsINode::eTEXT);
}
nsresult
nsDocumentEncoder::SerializeRangeNodes(nsRange* aRange,
nsINode* aNode,
nsAString& aString,
int32_t aDepth)
{
nsCOMPtr<nsIContent> content = do_QueryInterface(aNode);
NS_ENSURE_TRUE(content, NS_ERROR_FAILURE);
if (!IsVisibleNode(aNode))
return NS_OK;
nsresult rv = NS_OK;
// get start and end nodes for this recursion level
nsCOMPtr<nsIContent> startNode, endNode;
{
int32_t start = mStartRootIndex - aDepth;
if (start >= 0 && (uint32_t)start <= mStartNodes.Length())
startNode = mStartNodes[start];
int32_t end = mEndRootIndex - aDepth;
if (end >= 0 && (uint32_t)end <= mEndNodes.Length())
endNode = mEndNodes[end];
}
if (startNode != content && endNode != content)
{
// node is completely contained in range. Serialize the whole subtree
// rooted by this node.
rv = SerializeToStringRecursive(aNode, aString, false);
NS_ENSURE_SUCCESS(rv, rv);
}
else
{
// due to implementation it is impossible for text node to be both start and end of
// range. We would have handled that case without getting here.
//XXXsmaug What does this all mean?
if (IsTextNode(aNode))
{
if (startNode == content)
{
int32_t startOffset = aRange->StartOffset();
rv = SerializeNodeStart(aNode, startOffset, -1, aString);
NS_ENSURE_SUCCESS(rv, rv);
}
else
{
int32_t endOffset = aRange->EndOffset();
rv = SerializeNodeStart(aNode, 0, endOffset, aString);
NS_ENSURE_SUCCESS(rv, rv);
}
}
else
{
if (aNode != mCommonParent)
{
if (IncludeInContext(aNode))
{
// halt the incrementing of mStartDepth/mEndDepth. This is
// so paste client will include this node in paste.
mHaltRangeHint = true;
}
if ((startNode == content) && !mHaltRangeHint) mStartDepth++;
if ((endNode == content) && !mHaltRangeHint) mEndDepth++;
// serialize the start of this node
rv = SerializeNodeStart(aNode, 0, -1, aString);
NS_ENSURE_SUCCESS(rv, rv);
}
// do some calculations that will tell us which children of this
// node are in the range.
nsIContent* childAsNode = nullptr;
int32_t startOffset = 0, endOffset = -1;
if (startNode == content && mStartRootIndex >= aDepth)
startOffset = mStartOffsets[mStartRootIndex - aDepth];
if (endNode == content && mEndRootIndex >= aDepth)
endOffset = mEndOffsets[mEndRootIndex - aDepth];
// generated content will cause offset values of -1 to be returned.
int32_t j;
uint32_t childCount = content->GetChildCount();
if (startOffset == -1) startOffset = 0;
if (endOffset == -1) endOffset = childCount;
else
{
// if we are at the "tip" of the selection, endOffset is fine.
// otherwise, we need to add one. This is because of the semantics
// of the offset list created by GetAncestorsAndOffsets(). The
// intermediate points on the list use the endOffset of the
// location of the ancestor, rather than just past it. So we need
// to add one here in order to include it in the children we serialize.
if (aNode != aRange->GetEndParent())
{
endOffset++;
}
}
// serialize the children of this node that are in the range
for (j=startOffset; j<endOffset; j++)
{
childAsNode = content->GetChildAt(j);
if ((j==startOffset) || (j==endOffset-1))
rv = SerializeRangeNodes(aRange, childAsNode, aString, aDepth+1);
else
rv = SerializeToStringRecursive(childAsNode, aString, false);
NS_ENSURE_SUCCESS(rv, rv);
}
// serialize the end of this node
if (aNode != mCommonParent)
{
rv = SerializeNodeEnd(aNode, aString);
NS_ENSURE_SUCCESS(rv, rv);
}
}
}
return NS_OK;
}
nsresult
nsDocumentEncoder::SerializeRangeContextStart(const nsTArray<nsINode*>& aAncestorArray,
nsAString& aString)
{
if (mDisableContextSerialize) {
return NS_OK;
}
int32_t i = aAncestorArray.Length(), j;
nsresult rv = NS_OK;
// currently only for table-related elements; see Bug 137450
j = GetImmediateContextCount(aAncestorArray);
while (i > 0) {
nsINode *node = aAncestorArray.ElementAt(--i);
if (!node)
break;
// Either a general inclusion or as immediate context
if (IncludeInContext(node) || i < j) {
rv = SerializeNodeStart(node, 0, -1, aString);
if (NS_FAILED(rv))
break;
}
}
return rv;
}
nsresult
nsDocumentEncoder::SerializeRangeContextEnd(const nsTArray<nsINode*>& aAncestorArray,
nsAString& aString)
{
if (mDisableContextSerialize) {
return NS_OK;
}
int32_t i = 0, j;
int32_t count = aAncestorArray.Length();
nsresult rv = NS_OK;
// currently only for table-related elements
j = GetImmediateContextCount(aAncestorArray);
while (i < count) {
nsINode *node = aAncestorArray.ElementAt(i++);
if (!node)
break;
// Either a general inclusion or as immediate context
if (IncludeInContext(node) || i - 1 < j) {
rv = SerializeNodeEnd(node, aString);
if (NS_FAILED(rv))
break;
}
}
return rv;
}
nsresult
nsDocumentEncoder::SerializeRangeToString(nsRange *aRange,
nsAString& aOutputString)
{
if (!aRange || aRange->Collapsed())
return NS_OK;
mCommonParent = aRange->GetCommonAncestor();
if (!mCommonParent)
return NS_OK;
nsINode* startParent = aRange->GetStartParent();
NS_ENSURE_TRUE(startParent, NS_ERROR_FAILURE);
int32_t startOffset = aRange->StartOffset();
nsINode* endParent = aRange->GetEndParent();
NS_ENSURE_TRUE(endParent, NS_ERROR_FAILURE);
int32_t endOffset = aRange->EndOffset();
mStartDepth = mEndDepth = 0;
mCommonAncestors.Clear();
mStartNodes.Clear();
mStartOffsets.Clear();
mEndNodes.Clear();
mEndOffsets.Clear();
nsContentUtils::GetAncestors(mCommonParent, mCommonAncestors);
nsCOMPtr<nsIDOMNode> sp = do_QueryInterface(startParent);
nsContentUtils::GetAncestorsAndOffsets(sp, startOffset,
&mStartNodes, &mStartOffsets);
nsCOMPtr<nsIDOMNode> ep = do_QueryInterface(endParent);
nsContentUtils::GetAncestorsAndOffsets(ep, endOffset,
&mEndNodes, &mEndOffsets);
nsCOMPtr<nsIContent> commonContent = do_QueryInterface(mCommonParent);
mStartRootIndex = mStartNodes.IndexOf(commonContent);
mEndRootIndex = mEndNodes.IndexOf(commonContent);
nsresult rv = NS_OK;
rv = SerializeRangeContextStart(mCommonAncestors, aOutputString);
NS_ENSURE_SUCCESS(rv, rv);
if ((startParent == endParent) && IsTextNode(startParent))
{
if (mFlags & SkipInvisibleContent) {
// Check that the parent is visible if we don't a frame.
// IsVisibleNode() will do it when there's a frame.
nsCOMPtr<nsIContent> content = do_QueryInterface(startParent);
if (content && !content->GetPrimaryFrame()) {
nsIContent* parent = content->GetParent();
if (!parent || !IsVisibleNode(parent))
return NS_OK;
}
}
rv = SerializeNodeStart(startParent, startOffset, endOffset, aOutputString);
NS_ENSURE_SUCCESS(rv, rv);
}
else
{
rv = SerializeRangeNodes(aRange, mCommonParent, aOutputString, 0);
NS_ENSURE_SUCCESS(rv, rv);
}
rv = SerializeRangeContextEnd(mCommonAncestors, aOutputString);
NS_ENSURE_SUCCESS(rv, rv);
return rv;
}
NS_IMETHODIMP
nsDocumentEncoder::EncodeToString(nsAString& aOutputString)
{
return EncodeToStringWithMaxLength(0, aOutputString);
}
NS_IMETHODIMP
nsDocumentEncoder::EncodeToStringWithMaxLength(uint32_t aMaxLength,
nsAString& aOutputString)
{
if (!mDocument)
return NS_ERROR_NOT_INITIALIZED;
aOutputString.Truncate();
nsString output;
static const size_t bufferSize = 2048;
if (!mCachedBuffer) {
mCachedBuffer = nsStringBuffer::Alloc(bufferSize).take();
if (NS_WARN_IF(!mCachedBuffer)) {
return NS_ERROR_OUT_OF_MEMORY;
}
}
NS_ASSERTION(!mCachedBuffer->IsReadonly(),
"DocumentEncoder shouldn't keep reference to non-readonly buffer!");
static_cast<char16_t*>(mCachedBuffer->Data())[0] = char16_t(0);
mCachedBuffer->ToString(0, output, true);
// output owns the buffer now!
mCachedBuffer = nullptr;
if (!mSerializer) {
nsAutoCString progId(NS_CONTENTSERIALIZER_CONTRACTID_PREFIX);
AppendUTF16toUTF8(mMimeType, progId);
mSerializer = do_CreateInstance(progId.get());
NS_ENSURE_TRUE(mSerializer, NS_ERROR_NOT_IMPLEMENTED);
}
nsresult rv = NS_OK;
nsCOMPtr<nsIAtom> charsetAtom;
bool rewriteEncodingDeclaration = !(mSelection || mRange || mNode) && !(mFlags & OutputDontRewriteEncodingDeclaration);
mSerializer->Init(mFlags, mWrapColumn, mCharset.get(), mIsCopying, rewriteEncodingDeclaration);
if (mSelection) {
nsCOMPtr<nsIDOMRange> range;
int32_t i, count = 0;
rv = mSelection->GetRangeCount(&count);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIDOMNode> node, prevNode;
uint32_t firstRangeStartDepth = 0;
for (i = 0; i < count; i++) {
mSelection->GetRangeAt(i, getter_AddRefs(range));
// Bug 236546: newlines not added when copying table cells into clipboard
// Each selected cell shows up as a range containing a row with a single cell
// get the row, compare it to previous row and emit </tr><tr> as needed
// Bug 137450: Problem copying/pasting a table from a web page to Excel.
// Each separate block of <tr></tr> produced above will be wrapped by the
// immediate context. This assumes that you can't select cells that are
// multiple selections from two tables simultaneously.
range->GetStartContainer(getter_AddRefs(node));
NS_ENSURE_TRUE(node, NS_ERROR_FAILURE);
if (node != prevNode) {
nsCOMPtr<nsINode> p;
if (prevNode) {
p = do_QueryInterface(prevNode);
rv = SerializeNodeEnd(p, output);
NS_ENSURE_SUCCESS(rv, rv);
}
nsCOMPtr<nsIContent> content = do_QueryInterface(node);
if (content && content->IsHTMLElement(nsGkAtoms::tr)) {
nsINode* n = content;
if (!prevNode) {
// Went from a non-<tr> to a <tr>
mCommonAncestors.Clear();
nsContentUtils::GetAncestors(n->GetParentNode(), mCommonAncestors);
rv = SerializeRangeContextStart(mCommonAncestors, output);
NS_ENSURE_SUCCESS(rv, rv);
// Don't let SerializeRangeToString serialize the context again
mDisableContextSerialize = true;
}
rv = SerializeNodeStart(n, 0, -1, output);
NS_ENSURE_SUCCESS(rv, rv);
prevNode = node;
} else if (prevNode) {
// Went from a <tr> to a non-<tr>
mCommonAncestors.Clear();
nsContentUtils::GetAncestors(p->GetParentNode(), mCommonAncestors);
mDisableContextSerialize = false;
rv = SerializeRangeContextEnd(mCommonAncestors, output);
NS_ENSURE_SUCCESS(rv, rv);
prevNode = nullptr;
}
}
nsRange* r = static_cast<nsRange*>(range.get());
rv = SerializeRangeToString(r, output);
NS_ENSURE_SUCCESS(rv, rv);
if (i == 0) {
firstRangeStartDepth = mStartDepth;
}
}
mStartDepth = firstRangeStartDepth;
if (prevNode) {
nsCOMPtr<nsINode> p = do_QueryInterface(prevNode);
rv = SerializeNodeEnd(p, output);
NS_ENSURE_SUCCESS(rv, rv);
mCommonAncestors.Clear();
nsContentUtils::GetAncestors(p->GetParentNode(), mCommonAncestors);
mDisableContextSerialize = false;
rv = SerializeRangeContextEnd(mCommonAncestors, output);
NS_ENSURE_SUCCESS(rv, rv);
}
// Just to be safe
mDisableContextSerialize = false;
mSelection = nullptr;
} else if (mRange) {
rv = SerializeRangeToString(mRange, output);
mRange = nullptr;
} else if (mNode) {
if (!mNodeFixup && !(mFlags & SkipInvisibleContent) && !mStream &&
mNodeIsContainer) {
rv = SerializeToStringIterative(mNode, output);
} else {
rv = SerializeToStringRecursive(mNode, output, mNodeIsContainer);
}
mNode = nullptr;
} else {
rv = mSerializer->AppendDocumentStart(mDocument, output);
if (NS_SUCCEEDED(rv)) {
rv = SerializeToStringRecursive(mDocument, output, false, aMaxLength);
}
}
NS_ENSURE_SUCCESS(rv, rv);
rv = mSerializer->Flush(output);
mCachedBuffer = nsStringBuffer::FromString(output);
// We have to be careful how we set aOutputString, because we don't
// want it to end up sharing mCachedBuffer if we plan to reuse it.
bool setOutput = false;
// Try to cache the buffer.
if (mCachedBuffer) {
if (mCachedBuffer->StorageSize() == bufferSize &&
!mCachedBuffer->IsReadonly()) {
mCachedBuffer->AddRef();
} else {
if (NS_SUCCEEDED(rv)) {
mCachedBuffer->ToString(output.Length(), aOutputString);
setOutput = true;
}
mCachedBuffer = nullptr;
}
}
if (!setOutput && NS_SUCCEEDED(rv)) {
aOutputString.Append(output.get(), output.Length());
}
return rv;
}
NS_IMETHODIMP
nsDocumentEncoder::EncodeToStream(nsIOutputStream* aStream)
{
nsresult rv = NS_OK;
if (!mDocument)
return NS_ERROR_NOT_INITIALIZED;
nsAutoCString encoding;
if (!EncodingUtils::FindEncodingForLabelNoReplacement(mCharset, encoding)) {
return NS_ERROR_UCONV_NOCONV;
}
mUnicodeEncoder = EncodingUtils::EncoderForEncoding(encoding);
if (mMimeType.LowerCaseEqualsLiteral("text/plain")) {
rv = mUnicodeEncoder->SetOutputErrorBehavior(nsIUnicodeEncoder::kOnError_Replace, nullptr, '?');
NS_ENSURE_SUCCESS(rv, rv);
}
mStream = aStream;
nsAutoString buf;
rv = EncodeToString(buf);
// Force a flush of the last chunk of data.
FlushText(buf, true);
mStream = nullptr;
mUnicodeEncoder = nullptr;
return rv;
}
NS_IMETHODIMP
nsDocumentEncoder::EncodeToStringWithContext(nsAString& aContextString,
nsAString& aInfoString,
nsAString& aEncodedString)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsDocumentEncoder::SetNodeFixup(nsIDocumentEncoderNodeFixup *aFixup)
{
mNodeFixup = aFixup;
return NS_OK;
}
nsresult NS_NewTextEncoder(nsIDocumentEncoder** aResult); // make mac compiler happy
nsresult
NS_NewTextEncoder(nsIDocumentEncoder** aResult)
{
*aResult = new nsDocumentEncoder;
NS_ADDREF(*aResult);
return NS_OK;
}
class nsHTMLCopyEncoder : public nsDocumentEncoder
{
public:
nsHTMLCopyEncoder();
virtual ~nsHTMLCopyEncoder();
NS_IMETHOD Init(nsIDOMDocument* aDocument, const nsAString& aMimeType, uint32_t aFlags);
// overridden methods from nsDocumentEncoder
NS_IMETHOD SetSelection(nsISelection* aSelection);
NS_IMETHOD EncodeToStringWithContext(nsAString& aContextString,
nsAString& aInfoString,
nsAString& aEncodedString);
NS_IMETHOD EncodeToString(nsAString& aOutputString);
protected:
enum Endpoint
{
kStart,
kEnd
};
nsresult PromoteRange(nsIDOMRange *inRange);
nsresult PromoteAncestorChain(nsCOMPtr<nsIDOMNode> *ioNode,
int32_t *ioStartOffset,
int32_t *ioEndOffset);
nsresult GetPromotedPoint(Endpoint aWhere, nsIDOMNode *aNode, int32_t aOffset,
nsCOMPtr<nsIDOMNode> *outNode, int32_t *outOffset, nsIDOMNode *aCommon);
nsCOMPtr<nsIDOMNode> GetChildAt(nsIDOMNode *aParent, int32_t aOffset);
bool IsMozBR(nsIDOMNode* aNode);
nsresult GetNodeLocation(nsIDOMNode *inChild, nsCOMPtr<nsIDOMNode> *outParent, int32_t *outOffset);
bool IsRoot(nsIDOMNode* aNode);
bool IsFirstNode(nsIDOMNode *aNode);
bool IsLastNode(nsIDOMNode *aNode);
bool IsEmptyTextContent(nsIDOMNode* aNode);
virtual bool IncludeInContext(nsINode *aNode);
virtual int32_t
GetImmediateContextCount(const nsTArray<nsINode*>& aAncestorArray);
bool mIsTextWidget;
};
nsHTMLCopyEncoder::nsHTMLCopyEncoder()
{
mIsTextWidget = false;
}
nsHTMLCopyEncoder::~nsHTMLCopyEncoder()
{
}
NS_IMETHODIMP
nsHTMLCopyEncoder::Init(nsIDOMDocument* aDocument,
const nsAString& aMimeType,
uint32_t aFlags)
{
if (!aDocument)
return NS_ERROR_INVALID_ARG;
mIsTextWidget = false;
Initialize();
mIsCopying = true;
mDocument = do_QueryInterface(aDocument);
NS_ENSURE_TRUE(mDocument, NS_ERROR_FAILURE);
// Hack, hack! Traditionally, the caller passes text/unicode, which is
// treated as "guess text/html or text/plain" in this context. (It has a
// different meaning in other contexts. Sigh.) From now on, "text/plain"
// means forcing text/plain instead of guessing.
if (aMimeType.EqualsLiteral("text/plain")) {
mMimeType.AssignLiteral("text/plain");
} else {
mMimeType.AssignLiteral("text/html");
}
// Make all links absolute when copying
// (see related bugs #57296, #41924, #58646, #32768)
mFlags = aFlags | OutputAbsoluteLinks;
if (!mDocument->IsScriptEnabled())
mFlags |= OutputNoScriptContent;
return NS_OK;
}
NS_IMETHODIMP
nsHTMLCopyEncoder::SetSelection(nsISelection* aSelection)
{
// check for text widgets: we need to recognize these so that
// we don't tweak the selection to be outside of the magic
// div that ender-lite text widgets are embedded in.
if (!aSelection)
return NS_ERROR_NULL_POINTER;
nsCOMPtr<nsIDOMRange> range;
nsCOMPtr<nsIDOMNode> commonParent;
Selection* selection = static_cast<Selection*>(aSelection);
uint32_t rangeCount = selection->RangeCount();
// if selection is uninitialized return
if (!rangeCount)
return NS_ERROR_FAILURE;
// we'll just use the common parent of the first range. Implicit assumption
// here that multi-range selections are table cell selections, in which case
// the common parent is somewhere in the table and we don't really care where.
nsresult rv = aSelection->GetRangeAt(0, getter_AddRefs(range));
NS_ENSURE_SUCCESS(rv, rv);
if (!range)
return NS_ERROR_NULL_POINTER;
range->GetCommonAncestorContainer(getter_AddRefs(commonParent));
for (nsCOMPtr<nsIContent> selContent(do_QueryInterface(commonParent));
selContent;
selContent = selContent->GetParent())
{
// checking for selection inside a plaintext form widget
if (selContent->IsAnyOfHTMLElements(nsGkAtoms::input, nsGkAtoms::textarea))
{
mIsTextWidget = true;
break;
}
#if defined(MOZ_THUNDERBIRD) || defined(MOZ_SUITE)
else if (selContent->IsHTMLElement(nsGkAtoms::body)) {
// Currently, setting mIsTextWidget to 'true' will result in the selection
// being encoded/copied as pre-formatted plain text.
// This is fine for copying pre-formatted plain text with Firefox, it is
// already not correct for copying pre-formatted "rich" text (bold, colour)
// with Firefox. As long as the serialisers aren't fixed, copying
// pre-formatted text in Firefox is broken. If we set mIsTextWidget,
// pre-formatted plain text is copied, but pre-formatted "rich" text loses
// the "rich" formatting. If we don't set mIsTextWidget, "rich" text
// attributes aren't lost, but white-space is lost.
// So far the story for Firefox.
//
// Thunderbird has two *conflicting* requirements.
// Case 1:
// When selecting and copying text, even pre-formatted text, as a quote
// to be placed into a reply, we *always* expect HTML to be copied.
// Case 2:
// When copying text in a so-called "plain text" message, that is
// one where the body carries style "white-space:pre-wrap", the text should
// be copied as pre-formatted plain text.
//
// Therefore the following code checks for "pre-wrap" on the body.
// This is a terrible hack.
//
// The proper fix would be this:
// For case 1:
// Communicate the fact that HTML is required to EncodeToString(),
// bug 1141786.
// For case 2:
// Wait for Firefox to get fixed to detect pre-formatting correctly,
// bug 1174452.
nsAutoString styleVal;
if (selContent->GetAttr(kNameSpaceID_None, nsGkAtoms::style, styleVal) &&
styleVal.Find(NS_LITERAL_STRING("pre-wrap")) != kNotFound) {
mIsTextWidget = true;
break;
}
}
#endif
}
// normalize selection if we are not in a widget
if (mIsTextWidget)
{
mSelection = aSelection;
mMimeType.AssignLiteral("text/plain");
return NS_OK;
}
// also consider ourselves in a text widget if we can't find an html document
nsCOMPtr<nsIHTMLDocument> htmlDoc = do_QueryInterface(mDocument);
if (!(htmlDoc && mDocument->IsHTMLDocument())) {
mIsTextWidget = true;
mSelection = aSelection;
// mMimeType is set to text/plain when encoding starts.
return NS_OK;
}
// there's no Clone() for selection! fix...
//nsresult rv = aSelection->Clone(getter_AddRefs(mSelection);
//NS_ENSURE_SUCCESS(rv, rv);
NS_NewDomSelection(getter_AddRefs(mSelection));
NS_ENSURE_TRUE(mSelection, NS_ERROR_FAILURE);
// loop thru the ranges in the selection
for (uint32_t rangeIdx = 0; rangeIdx < rangeCount; ++rangeIdx) {
range = selection->GetRangeAt(rangeIdx);
NS_ENSURE_TRUE(range, NS_ERROR_FAILURE);
nsCOMPtr<nsIDOMRange> myRange;
range->CloneRange(getter_AddRefs(myRange));
NS_ENSURE_TRUE(myRange, NS_ERROR_FAILURE);
// adjust range to include any ancestors who's children are entirely selected
rv = PromoteRange(myRange);
NS_ENSURE_SUCCESS(rv, rv);
rv = mSelection->AddRange(myRange);
NS_ENSURE_SUCCESS(rv, rv);
}
return NS_OK;
}
NS_IMETHODIMP
nsHTMLCopyEncoder::EncodeToString(nsAString& aOutputString)
{
if (mIsTextWidget) {
mMimeType.AssignLiteral("text/plain");
}
return nsDocumentEncoder::EncodeToString(aOutputString);
}
NS_IMETHODIMP
nsHTMLCopyEncoder::EncodeToStringWithContext(nsAString& aContextString,
nsAString& aInfoString,
nsAString& aEncodedString)
{
nsresult rv = EncodeToString(aEncodedString);
NS_ENSURE_SUCCESS(rv, rv);
// do not encode any context info or range hints if we are in a text widget.
if (mIsTextWidget) return NS_OK;
// now encode common ancestors into aContextString. Note that the common ancestors
// will be for the last range in the selection in the case of multirange selections.
// encoding ancestors every range in a multirange selection in a way that could be
// understood by the paste code would be a lot more work to do. As a practical matter,
// selections are single range, and the ones that aren't are table cell selections
// where all the cells are in the same table.
// leaf of ancestors might be text node. If so discard it.
int32_t count = mCommonAncestors.Length();
int32_t i;
nsCOMPtr<nsINode> node;
if (count > 0)
node = mCommonAncestors.ElementAt(0);
if (node && IsTextNode(node))
{
mCommonAncestors.RemoveElementAt(0);
// don't forget to adjust range depth info
if (mStartDepth) mStartDepth--;
if (mEndDepth) mEndDepth--;
// and the count
count--;
}
i = count;
while (i > 0)
{
node = mCommonAncestors.ElementAt(--i);
SerializeNodeStart(node, 0, -1, aContextString);
}
//i = 0; guaranteed by above
while (i < count)
{
node = mCommonAncestors.ElementAt(i++);
SerializeNodeEnd(node, aContextString);
}
// encode range info : the start and end depth of the selection, where the depth is
// distance down in the parent hierarchy. Later we will need to add leading/trailing
// whitespace info to this.
nsAutoString infoString;
infoString.AppendInt(mStartDepth);
infoString.Append(char16_t(','));
infoString.AppendInt(mEndDepth);
aInfoString = infoString;
return NS_OK;
}
bool
nsHTMLCopyEncoder::IncludeInContext(nsINode *aNode)
{
nsCOMPtr<nsIContent> content(do_QueryInterface(aNode));
if (!content)
return false;
return content->IsAnyOfHTMLElements(nsGkAtoms::b,
nsGkAtoms::i,
nsGkAtoms::u,
nsGkAtoms::a,
nsGkAtoms::tt,
nsGkAtoms::s,
nsGkAtoms::big,
nsGkAtoms::small,
nsGkAtoms::strike,
nsGkAtoms::em,
nsGkAtoms::strong,
nsGkAtoms::dfn,
nsGkAtoms::code,
nsGkAtoms::cite,
nsGkAtoms::var,
nsGkAtoms::abbr,
nsGkAtoms::font,
nsGkAtoms::script,
nsGkAtoms::span,
nsGkAtoms::pre,
nsGkAtoms::h1,
nsGkAtoms::h2,
nsGkAtoms::h3,
nsGkAtoms::h4,
nsGkAtoms::h5,
nsGkAtoms::h6);
}
nsresult
nsHTMLCopyEncoder::PromoteRange(nsIDOMRange *inRange)
{
if (!inRange) return NS_ERROR_NULL_POINTER;
nsresult rv;
nsCOMPtr<nsIDOMNode> startNode, endNode, common;
int32_t startOffset, endOffset;
rv = inRange->GetCommonAncestorContainer(getter_AddRefs(common));
NS_ENSURE_SUCCESS(rv, rv);
rv = inRange->GetStartContainer(getter_AddRefs(startNode));
NS_ENSURE_SUCCESS(rv, rv);
rv = inRange->GetStartOffset(&startOffset);
NS_ENSURE_SUCCESS(rv, rv);
rv = inRange->GetEndContainer(getter_AddRefs(endNode));
NS_ENSURE_SUCCESS(rv, rv);
rv = inRange->GetEndOffset(&endOffset);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIDOMNode> opStartNode;
nsCOMPtr<nsIDOMNode> opEndNode;
int32_t opStartOffset, opEndOffset;
nsCOMPtr<nsIDOMRange> opRange;
// examine range endpoints.
rv = GetPromotedPoint( kStart, startNode, startOffset, address_of(opStartNode), &opStartOffset, common);
NS_ENSURE_SUCCESS(rv, rv);
rv = GetPromotedPoint( kEnd, endNode, endOffset, address_of(opEndNode), &opEndOffset, common);
NS_ENSURE_SUCCESS(rv, rv);
// if both range endpoints are at the common ancestor, check for possible inclusion of ancestors
if ( (opStartNode == common) && (opEndNode == common) )
{
rv = PromoteAncestorChain(address_of(opStartNode), &opStartOffset, &opEndOffset);
NS_ENSURE_SUCCESS(rv, rv);
opEndNode = opStartNode;
}
// set the range to the new values
rv = inRange->SetStart(opStartNode, opStartOffset);
NS_ENSURE_SUCCESS(rv, rv);
rv = inRange->SetEnd(opEndNode, opEndOffset);
return rv;
}
// PromoteAncestorChain will promote a range represented by [{*ioNode,*ioStartOffset} , {*ioNode,*ioEndOffset}]
// The promotion is different from that found in getPromotedPoint: it will only promote one endpoint if it can
// promote the other. Thus, instead of having a startnode/endNode, there is just the one ioNode.
nsresult
nsHTMLCopyEncoder::PromoteAncestorChain(nsCOMPtr<nsIDOMNode> *ioNode,
int32_t *ioStartOffset,
int32_t *ioEndOffset)
{
if (!ioNode || !ioStartOffset || !ioEndOffset) return NS_ERROR_NULL_POINTER;
nsresult rv = NS_OK;
bool done = false;
nsCOMPtr<nsIDOMNode> frontNode, endNode, parent;
int32_t frontOffset, endOffset;
//save the editable state of the ioNode, so we don't promote an ancestor if it has different editable state
nsCOMPtr<nsINode> node = do_QueryInterface(*ioNode);
bool isEditable = node->IsEditable();
// loop for as long as we can promote both endpoints
while (!done)
{
rv = (*ioNode)->GetParentNode(getter_AddRefs(parent));
if ((NS_FAILED(rv)) || !parent)
done = true;
else
{
// passing parent as last param to GetPromotedPoint() allows it to promote only one level
// up the hierarchy.
rv = GetPromotedPoint( kStart, *ioNode, *ioStartOffset, address_of(frontNode), &frontOffset, parent);
NS_ENSURE_SUCCESS(rv, rv);
// then we make the same attempt with the endpoint
rv = GetPromotedPoint( kEnd, *ioNode, *ioEndOffset, address_of(endNode), &endOffset, parent);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsINode> frontINode = do_QueryInterface(frontNode);
// if both endpoints were promoted one level and isEditable is the same as the original node,
// keep looping - otherwise we are done.
if ( (frontNode != parent) || (endNode != parent) || (frontINode->IsEditable() != isEditable) )
done = true;
else
{
*ioNode = frontNode;
*ioStartOffset = frontOffset;
*ioEndOffset = endOffset;
}
}
}
return rv;
}
nsresult
nsHTMLCopyEncoder::GetPromotedPoint(Endpoint aWhere, nsIDOMNode *aNode, int32_t aOffset,
nsCOMPtr<nsIDOMNode> *outNode, int32_t *outOffset, nsIDOMNode *common)
{
nsresult rv = NS_OK;
nsCOMPtr<nsIDOMNode> node = aNode;
nsCOMPtr<nsIDOMNode> parent = aNode;
int32_t offset = aOffset;
bool bResetPromotion = false;
// default values
*outNode = node;
*outOffset = offset;
if (common == node)
return NS_OK;
if (aWhere == kStart)
{
// some special casing for text nodes
nsCOMPtr<nsINode> t = do_QueryInterface(aNode);
if (IsTextNode(t))
{
// if not at beginning of text node, we are done
if (offset > 0)
{
// unless everything before us in just whitespace. NOTE: we need a more
// general solution that truly detects all cases of non-significant
// whitesace with no false alarms.
nsCOMPtr<nsIDOMCharacterData> nodeAsText = do_QueryInterface(aNode);
nsAutoString text;
nodeAsText->SubstringData(0, offset, text);
text.CompressWhitespace();
if (!text.IsEmpty())
return NS_OK;
bResetPromotion = true;
}
// else
rv = GetNodeLocation(aNode, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
}
else
{
node = GetChildAt(parent,offset);
}
if (!node) node = parent;
// finding the real start for this point. look up the tree for as long as we are the
// first node in the container, and as long as we haven't hit the body node.
if (!IsRoot(node) && (parent != common))
{
rv = GetNodeLocation(node, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
if (offset == -1) return NS_OK; // we hit generated content; STOP
nsIParserService *parserService = nsContentUtils::GetParserService();
if (!parserService)
return NS_ERROR_OUT_OF_MEMORY;
while ((IsFirstNode(node)) && (!IsRoot(parent)) && (parent != common))
{
if (bResetPromotion)
{
nsCOMPtr<nsIContent> content = do_QueryInterface(parent);
if (content && content->IsHTMLElement())
{
bool isBlock = false;
parserService->IsBlock(parserService->HTMLAtomTagToId(
content->NodeInfo()->NameAtom()), isBlock);
if (isBlock)
{
bResetPromotion = false;
}
}
}
node = parent;
rv = GetNodeLocation(node, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
if (offset == -1) // we hit generated content; STOP
{
// back up a bit
parent = node;
offset = 0;
break;
}
}
if (bResetPromotion)
{
*outNode = aNode;
*outOffset = aOffset;
}
else
{
*outNode = parent;
*outOffset = offset;
}
return rv;
}
}
if (aWhere == kEnd)
{
// some special casing for text nodes
nsCOMPtr<nsINode> n = do_QueryInterface(aNode);
if (IsTextNode(n))
{
// if not at end of text node, we are done
uint32_t len = n->Length();
if (offset < (int32_t)len)
{
// unless everything after us in just whitespace. NOTE: we need a more
// general solution that truly detects all cases of non-significant
// whitespace with no false alarms.
nsCOMPtr<nsIDOMCharacterData> nodeAsText = do_QueryInterface(aNode);
nsAutoString text;
nodeAsText->SubstringData(offset, len-offset, text);
text.CompressWhitespace();
if (!text.IsEmpty())
return NS_OK;
bResetPromotion = true;
}
rv = GetNodeLocation(aNode, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
}
else
{
if (offset) offset--; // we want node _before_ offset
node = GetChildAt(parent,offset);
}
if (!node) node = parent;
// finding the real end for this point. look up the tree for as long as we are the
// last node in the container, and as long as we haven't hit the body node.
if (!IsRoot(node) && (parent != common))
{
rv = GetNodeLocation(node, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
if (offset == -1) return NS_OK; // we hit generated content; STOP
nsIParserService *parserService = nsContentUtils::GetParserService();
if (!parserService)
return NS_ERROR_OUT_OF_MEMORY;
while ((IsLastNode(node)) && (!IsRoot(parent)) && (parent != common))
{
if (bResetPromotion)
{
nsCOMPtr<nsIContent> content = do_QueryInterface(parent);
if (content && content->IsHTMLElement())
{
bool isBlock = false;
parserService->IsBlock(parserService->HTMLAtomTagToId(
content->NodeInfo()->NameAtom()), isBlock);
if (isBlock)
{
bResetPromotion = false;
}
}
}
node = parent;
rv = GetNodeLocation(node, address_of(parent), &offset);
NS_ENSURE_SUCCESS(rv, rv);
if (offset == -1) // we hit generated content; STOP
{
// back up a bit
parent = node;
offset = 0;
break;
}
}
if (bResetPromotion)
{
*outNode = aNode;
*outOffset = aOffset;
}
else
{
*outNode = parent;
offset++; // add one since this in an endpoint - want to be AFTER node.
*outOffset = offset;
}
return rv;
}
}
return rv;
}
nsCOMPtr<nsIDOMNode>
nsHTMLCopyEncoder::GetChildAt(nsIDOMNode *aParent, int32_t aOffset)
{
nsCOMPtr<nsIDOMNode> resultNode;
if (!aParent)
return resultNode;
nsCOMPtr<nsIContent> content = do_QueryInterface(aParent);
NS_PRECONDITION(content, "null content in nsHTMLCopyEncoder::GetChildAt");
resultNode = do_QueryInterface(content->GetChildAt(aOffset));
return resultNode;
}
bool
nsHTMLCopyEncoder::IsMozBR(nsIDOMNode* aNode)
{
MOZ_ASSERT(aNode);
nsCOMPtr<Element> element = do_QueryInterface(aNode);
return element &&
element->IsHTMLElement(nsGkAtoms::br) &&
element->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
NS_LITERAL_STRING("_moz"), eIgnoreCase);
}
nsresult
nsHTMLCopyEncoder::GetNodeLocation(nsIDOMNode *inChild,
nsCOMPtr<nsIDOMNode> *outParent,
int32_t *outOffset)
{
NS_ASSERTION((inChild && outParent && outOffset), "bad args");
nsresult result = NS_ERROR_NULL_POINTER;
if (inChild && outParent && outOffset)
{
result = inChild->GetParentNode(getter_AddRefs(*outParent));
if ((NS_SUCCEEDED(result)) && (*outParent))
{
nsCOMPtr<nsIContent> content = do_QueryInterface(*outParent);
nsCOMPtr<nsIContent> cChild = do_QueryInterface(inChild);
if (!cChild || !content)
return NS_ERROR_NULL_POINTER;
*outOffset = content->IndexOf(cChild);
}
}
return result;
}
bool
nsHTMLCopyEncoder::IsRoot(nsIDOMNode* aNode)
{
nsCOMPtr<nsIContent> content = do_QueryInterface(aNode);
if (!content) {
return false;
}
if (mIsTextWidget) {
return content->IsHTMLElement(nsGkAtoms::div);
}
return content->IsAnyOfHTMLElements(nsGkAtoms::body,
nsGkAtoms::td,
nsGkAtoms::th);
}
bool
nsHTMLCopyEncoder::IsFirstNode(nsIDOMNode *aNode)
{
nsCOMPtr<nsIDOMNode> parent;
int32_t offset, j=0;
nsresult rv = GetNodeLocation(aNode, address_of(parent), &offset);
if (NS_FAILED(rv))
{
NS_NOTREACHED("failure in IsFirstNode");
return false;
}
if (offset == 0) // easy case, we are first dom child
return true;
if (!parent)
return true;
// need to check if any nodes before us are really visible.
// Mike wrote something for me along these lines in nsSelectionController,
// but I don't think it's ready for use yet - revisit.
// HACK: for now, simply consider all whitespace text nodes to be
// invisible formatting nodes.
nsCOMPtr<nsIDOMNodeList> childList;
nsCOMPtr<nsIDOMNode> child;
rv = parent->GetChildNodes(getter_AddRefs(childList));
if (NS_FAILED(rv) || !childList)
{
NS_NOTREACHED("failure in IsFirstNode");
return true;
}
while (j < offset)
{
childList->Item(j, getter_AddRefs(child));
if (!IsEmptyTextContent(child))
return false;
j++;
}
return true;
}
bool
nsHTMLCopyEncoder::IsLastNode(nsIDOMNode *aNode)
{
nsCOMPtr<nsIDOMNode> parent;
int32_t offset,j;
nsresult rv = GetNodeLocation(aNode, address_of(parent), &offset);
if (NS_FAILED(rv))
{
NS_NOTREACHED("failure in IsLastNode");
return false;
}
nsCOMPtr<nsINode> parentNode = do_QueryInterface(parent);
if (!parentNode) {
return true;
}
uint32_t numChildren = parentNode->Length();
if (offset+1 == (int32_t)numChildren) // easy case, we are last dom child
return true;
// need to check if any nodes after us are really visible.
// Mike wrote something for me along these lines in nsSelectionController,
// but I don't think it's ready for use yet - revisit.
// HACK: for now, simply consider all whitespace text nodes to be
// invisible formatting nodes.
j = (int32_t)numChildren-1;
nsCOMPtr<nsIDOMNodeList>childList;
nsCOMPtr<nsIDOMNode> child;
rv = parent->GetChildNodes(getter_AddRefs(childList));
if (NS_FAILED(rv) || !childList)
{
NS_NOTREACHED("failure in IsLastNode");
return true;
}
while (j > offset)
{
childList->Item(j, getter_AddRefs(child));
j--;
if (IsMozBR(child)) // we ignore trailing moz BRs.
continue;
if (!IsEmptyTextContent(child))
return false;
}
return true;
}
bool
nsHTMLCopyEncoder::IsEmptyTextContent(nsIDOMNode* aNode)
{
nsCOMPtr<nsIContent> cont = do_QueryInterface(aNode);
return cont && cont->TextIsOnlyWhitespace();
}
nsresult NS_NewHTMLCopyTextEncoder(nsIDocumentEncoder** aResult); // make mac compiler happy
nsresult
NS_NewHTMLCopyTextEncoder(nsIDocumentEncoder** aResult)
{
*aResult = new nsHTMLCopyEncoder;
NS_ADDREF(*aResult);
return NS_OK;
}
int32_t
nsHTMLCopyEncoder::GetImmediateContextCount(const nsTArray<nsINode*>& aAncestorArray)
{
int32_t i = aAncestorArray.Length(), j = 0;
while (j < i) {
nsINode *node = aAncestorArray.ElementAt(j);
if (!node) {
break;
}
nsCOMPtr<nsIContent> content(do_QueryInterface(node));
if (!content ||
!content->IsAnyOfHTMLElements(nsGkAtoms::tr,
nsGkAtoms::thead,
nsGkAtoms::tbody,
nsGkAtoms::tfoot,
nsGkAtoms::table)) {
break;
}
++j;
}
return j;
}
Reference in New Issue View Git Blame Copy Permalink