Mozilla/mozilla/layout/mathml/base/src/nsMathMLTokenFrame.cpp
roc+%cs.cmu.edu 9199079043 Bug 313817. DeCOMtaminate SVG and MathML NS_New*Frame functions. r+sr=roc, patch by Marc Liddell.
git-svn-id: svn://10.0.0.236/trunk@184444 18797224-902f-48f8-a5cc-f745e15eee43
2005-11-11 02:36:29 +00:00

420 lines
14 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 MathML Project.
*
* The Initial Developer of the Original Code is
* The University of Queensland.
* Portions created by the Initial Developer are Copyright (C) 1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Roger B. Sidje <rbs@maths.uq.edu.au>
*
* Alternatively, the contents of this file may be used under the terms of
* either 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 ***** */
#include "nsCOMPtr.h"
#include "nsFrame.h"
#include "nsPresContext.h"
#include "nsUnitConversion.h"
#include "nsStyleContext.h"
#include "nsStyleConsts.h"
#include "nsIRenderingContext.h"
#include "nsIFontMetrics.h"
#include "nsIDOMText.h"
#include "nsITextContent.h"
#include "nsFrameManager.h"
#include "nsLayoutAtoms.h"
#include "nsStyleChangeList.h"
#include "nsINameSpaceManager.h"
#include "nsMathMLTokenFrame.h"
nsIFrame*
NS_NewMathMLTokenFrame(nsIPresShell* aPresShell)
{
return new (aPresShell) nsMathMLTokenFrame;
}
nsMathMLTokenFrame::nsMathMLTokenFrame()
{
}
nsMathMLTokenFrame::~nsMathMLTokenFrame()
{
}
nsIAtom*
nsMathMLTokenFrame::GetType() const
{
// treat everything other than <mi> as ordinary...
if (mContent->Tag() != nsMathMLAtoms::mi_) {
return nsMathMLAtoms::ordinaryMathMLFrame;
}
// for <mi>, distinguish between italic and upright...
nsAutoString value;
mContent->GetAttr(kNameSpaceID_None, nsMathMLAtoms::MOZfontstyle, value);
// treat invariant the same as italic to inherit its inter-space properties
return value.EqualsLiteral("normal")
? nsMathMLAtoms::uprightIdentifierMathMLFrame
: nsMathMLAtoms::italicIdentifierMathMLFrame;
}
static void
CompressWhitespace(nsIContent* aContent)
{
PRUint32 numKids = aContent->GetChildCount();
for (PRUint32 kid = 0; kid < numKids; kid++) {
nsCOMPtr<nsITextContent> tc(do_QueryInterface(aContent->GetChildAt(kid)));
if (tc && tc->IsContentOfType(nsIContent::eTEXT)) {
nsAutoString text;
tc->AppendTextTo(text);
text.CompressWhitespace();
tc->SetText(text, PR_FALSE); // not meant to be used if notify is needed
}
}
}
NS_IMETHODIMP
nsMathMLTokenFrame::Init(nsPresContext* aPresContext,
nsIContent* aContent,
nsIFrame* aParent,
nsStyleContext* aContext,
nsIFrame* aPrevInFlow)
{
// leading and trailing whitespace doesn't count -- bug 15402
// brute force removal for people who do <mi> a </mi> instead of <mi>a</mi>
// XXX the best fix is to skip these in nsTextFrame
CompressWhitespace(aContent);
// let the base class do its Init()
return nsMathMLContainerFrame::Init(aPresContext, aContent, aParent, aContext, aPrevInFlow);
}
NS_IMETHODIMP
nsMathMLTokenFrame::SetInitialChildList(nsPresContext* aPresContext,
nsIAtom* aListName,
nsIFrame* aChildList)
{
// First, let the base class do its work
nsresult rv = nsMathMLContainerFrame::SetInitialChildList(aPresContext, aListName, aChildList);
if (NS_FAILED(rv))
return rv;
// Safety measure to cater for math fonts with metrics that sometimes
// cause glyphs in the text frames to protrude outside. Without this,
// such glyphs may be clipped at the painting stage
mState |= NS_FRAME_OUTSIDE_CHILDREN;
nsIFrame* childFrame = mFrames.FirstChild();
while (childFrame) {
childFrame->AddStateBits(NS_FRAME_OUTSIDE_CHILDREN);
childFrame = childFrame->GetNextSibling();
}
SetQuotes(aPresContext);
ProcessTextData(aPresContext);
return rv;
}
nsresult
nsMathMLTokenFrame::Reflow(nsPresContext* aPresContext,
nsHTMLReflowMetrics& aDesiredSize,
const nsHTMLReflowState& aReflowState,
nsReflowStatus& aStatus)
{
nsresult rv = NS_OK;
// See if this is an incremental reflow
if (aReflowState.reason == eReflowReason_Incremental) {
#ifdef MATHML_NOISY_INCREMENTAL_REFLOW
printf("nsMathMLContainerFrame::ReflowTokenFor:IncrementalReflow received by: ");
nsFrame::ListTag(stdout, aFrame);
printf("\n");
#endif
}
// initializations needed for empty markup like <mtag></mtag>
aDesiredSize.width = aDesiredSize.height = 0;
aDesiredSize.ascent = aDesiredSize.descent = 0;
aDesiredSize.mBoundingMetrics.Clear();
// ask our children to compute their bounding metrics
nsHTMLReflowMetrics childDesiredSize(aDesiredSize.mComputeMEW,
aDesiredSize.mFlags | NS_REFLOW_CALC_BOUNDING_METRICS);
nsSize availSize(aReflowState.mComputedWidth, aReflowState.mComputedHeight);
PRInt32 count = 0;
nsIFrame* childFrame = GetFirstChild(nsnull);
while (childFrame) {
nsHTMLReflowState childReflowState(aPresContext, aReflowState,
childFrame, availSize);
rv = ReflowChild(childFrame, aPresContext, childDesiredSize,
childReflowState, aStatus);
//NS_ASSERTION(NS_FRAME_IS_COMPLETE(aStatus), "bad status");
if (NS_FAILED(rv)) return rv;
// origins are used as placeholders to store the child's ascent and descent.
childFrame->SetRect(nsRect(childDesiredSize.descent, childDesiredSize.ascent,
childDesiredSize.width, childDesiredSize.height));
// compute and cache the bounding metrics
if (0 == count)
aDesiredSize.mBoundingMetrics = childDesiredSize.mBoundingMetrics;
else
aDesiredSize.mBoundingMetrics += childDesiredSize.mBoundingMetrics;
count++;
childFrame = childFrame->GetNextSibling();
}
if (aDesiredSize.mComputeMEW) {
aDesiredSize.mMaxElementWidth = childDesiredSize.mMaxElementWidth;
}
FinishAndStoreOverflow(&aDesiredSize);
// Act as if there is overflow no matter what. This is a
// safety measure to cater for math fonts with metrics that sometimes
// cause glyphs in the text frames to protrude outside. Without this,
// such glyphs may be clipped at the painting stage
// This flag has already been set on the children as well in
// SetInitialChildList()
mState |= NS_FRAME_OUTSIDE_CHILDREN;
// cache the frame's mBoundingMetrics
mBoundingMetrics = aDesiredSize.mBoundingMetrics;
// place and size children
FinalizeReflow(*aReflowState.rendContext, aDesiredSize);
aStatus = NS_FRAME_COMPLETE;
NS_FRAME_SET_TRUNCATION(aStatus, aReflowState, aDesiredSize);
return NS_OK;
}
// For token elements, mBoundingMetrics is computed at the ReflowToken
// pass, it is not computed here because our children may be text frames
// that do not implement the GetBoundingMetrics() interface.
nsresult
nsMathMLTokenFrame::Place(nsIRenderingContext& aRenderingContext,
PRBool aPlaceOrigin,
nsHTMLReflowMetrics& aDesiredSize)
{
nsCOMPtr<nsIFontMetrics> fm =
GetPresContext()->GetMetricsFor(GetStyleFont()->mFont);
nscoord ascent, descent;
fm->GetMaxAscent(ascent);
fm->GetMaxDescent(descent);
aDesiredSize.mBoundingMetrics = mBoundingMetrics;
aDesiredSize.width = mBoundingMetrics.width;
aDesiredSize.ascent = PR_MAX(mBoundingMetrics.ascent, ascent);
aDesiredSize.descent = PR_MAX(mBoundingMetrics.descent, descent);
aDesiredSize.height = aDesiredSize.ascent + aDesiredSize.descent;
if (aPlaceOrigin) {
nscoord dy, dx = 0;
nsIFrame* childFrame = GetFirstChild(nsnull);
while (childFrame) {
nsRect rect = childFrame->GetRect();
nsHTMLReflowMetrics childSize(nsnull);
childSize.width = rect.width;
childSize.height = aDesiredSize.height; //rect.height;
// place and size the child; (dx,0) makes the caret happy - bug 188146
dy = rect.IsEmpty() ? 0 : aDesiredSize.ascent - rect.y;
FinishReflowChild(childFrame, GetPresContext(), nsnull, childSize, dx, dy, 0);
dx += rect.width;
childFrame = childFrame->GetNextSibling();
}
}
SetReference(nsPoint(0, aDesiredSize.ascent));
return NS_OK;
}
NS_IMETHODIMP
nsMathMLTokenFrame::ReflowDirtyChild(nsIPresShell* aPresShell,
nsIFrame* aChild)
{
// if we get this, it means it was called by the nsTextFrame beneath us, and
// this means something changed in the text content. So re-process our text
ProcessTextData(aPresShell->GetPresContext());
mState |= NS_FRAME_IS_DIRTY | NS_FRAME_HAS_DIRTY_CHILDREN;
return mParent->ReflowDirtyChild(aPresShell, this);
}
NS_IMETHODIMP
nsMathMLTokenFrame::AttributeChanged(PRInt32 aNameSpaceID,
nsIAtom* aAttribute,
PRInt32 aModType)
{
if (nsMathMLAtoms::lquote_ == aAttribute ||
nsMathMLAtoms::rquote_ == aAttribute) {
SetQuotes(GetPresContext());
}
return nsMathMLContainerFrame::
AttributeChanged(aNameSpaceID, aAttribute, aModType);
}
void
nsMathMLTokenFrame::ProcessTextData(nsPresContext* aPresContext)
{
SetTextStyle(aPresContext);
}
///////////////////////////////////////////////////////////////////////////
// For <mi>, if the content is not a single character, turn the font to
// normal (this function will also query attributes from the mstyle hierarchy)
void
nsMathMLTokenFrame::SetTextStyle(nsPresContext* aPresContext)
{
if (mContent->Tag() != nsMathMLAtoms::mi_)
return;
if (!mFrames.FirstChild())
return;
// Get the text content that we enclose and its length
// our content can include comment-nodes, attribute-nodes, text-nodes...
// we use the DOM to make sure that we are only looking at text-nodes...
nsAutoString data;
PRUint32 numKids = mContent->GetChildCount();
for (PRUint32 kid = 0; kid < numKids; kid++) {
nsCOMPtr<nsIDOMText> kidText(do_QueryInterface(mContent->GetChildAt(kid)));
if (kidText) {
nsAutoString kidData;
kidText->GetData(kidData);
data += kidData;
}
}
PRInt32 length = data.Length();
if (!length)
return;
// attributes may override the default behavior
nsAutoString fontstyle;
GetAttribute(mContent, mPresentationData.mstyle, nsMathMLAtoms::fontstyle_, fontstyle);
if (1 == length && nsMathMLOperators::LookupInvariantChar(data[0])) {
// bug 65951 - a non-stylable character has its own intrinsic appearance
fontstyle.AssignLiteral("invariant");
}
if (fontstyle.IsEmpty()) {
fontstyle.AssignASCII((1 == length) ? "italic" : "normal");
}
// set the -moz-math-font-style attribute without notifying that we want a reflow
mContent->SetAttr(kNameSpaceID_None, nsMathMLAtoms::MOZfontstyle, fontstyle, PR_FALSE);
// then, re-resolve the style contexts in our subtree
nsFrameManager *fm = aPresContext->FrameManager();
nsStyleChangeList changeList;
fm->ComputeStyleChangeFor(this, &changeList, NS_STYLE_HINT_NONE);
#ifdef DEBUG
// Use the parent frame to make sure we catch in-flows and such
nsIFrame* parentFrame = GetParent();
fm->DebugVerifyStyleTree(parentFrame ? parentFrame : this);
#endif
}
///////////////////////////////////////////////////////////////////////////
// For <ms>, it is assumed that the mathml.css file contains two rules:
// ms:before { content: open-quote; }
// ms:after { content: close-quote; }
// With these two rules, the frame construction code will
// create inline frames that contain text frames which themselves
// contain the text content of the quotes.
// So the main idea in this code is to see if there are lquote and
// rquote attributes. If these are there, we ovewrite the default
// quotes in the text frames.
//
// But what if the mathml.css file wasn't loaded?
// We also check that we are not relying on null pointers...
static void
SetQuote(nsPresContext* aPresContext,
nsIFrame* aFrame,
nsString& aValue)
{
nsIFrame* textFrame;
do {
// walk down the hierarchy of first children because they could be wrapped
textFrame = aFrame->GetFirstChild(nsnull);
if (textFrame) {
if (textFrame->GetType() == nsLayoutAtoms::textFrame)
break;
}
aFrame = textFrame;
} while (textFrame);
if (textFrame) {
nsIContent* quoteContent = textFrame->GetContent();
if (quoteContent) {
nsCOMPtr<nsIDOMText> domText(do_QueryInterface(quoteContent));
if (domText) {
nsCOMPtr<nsITextContent> tc(do_QueryInterface(quoteContent));
if (tc) {
tc->SetText(aValue, PR_FALSE); // no notify since we don't want a reflow yet
}
}
}
}
}
void
nsMathMLTokenFrame::SetQuotes(nsPresContext* aPresContext)
{
if (mContent->Tag() != nsMathMLAtoms::ms_)
return;
nsIFrame* rightFrame = nsnull;
nsIFrame* baseFrame = nsnull;
nsIFrame* leftFrame = mFrames.FirstChild();
if (leftFrame)
baseFrame = leftFrame->GetNextSibling();
if (baseFrame)
rightFrame = baseFrame->GetNextSibling();
if (!leftFrame || !baseFrame || !rightFrame)
return;
nsAutoString value;
// lquote
if (GetAttribute(mContent, mPresentationData.mstyle,
nsMathMLAtoms::lquote_, value)) {
SetQuote(aPresContext, leftFrame, value);
}
// rquote
if (GetAttribute(mContent, mPresentationData.mstyle,
nsMathMLAtoms::rquote_, value)) {
SetQuote(aPresContext, rightFrame, value);
}
}