mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
986 lines
32 KiB
C++
986 lines
32 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):
|
|
*
|
|
* 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 ***** */
|
|
|
|
/* a presentation of a document, part 1 */
|
|
|
|
#ifndef nsPresContext_h___
|
|
#define nsPresContext_h___
|
|
|
|
#include "nsISupports.h"
|
|
#include "nsColor.h"
|
|
#include "nsCoord.h"
|
|
#include "nsAString.h"
|
|
#include "nsCOMPtr.h"
|
|
#include "nsIPresShell.h"
|
|
#include "nsRect.h"
|
|
#include "nsIDeviceContext.h"
|
|
#include "nsFont.h"
|
|
#include "nsIWeakReference.h"
|
|
#include "nsITheme.h"
|
|
#include "nsILanguageAtomService.h"
|
|
#include "nsIObserver.h"
|
|
#include "nsITimer.h"
|
|
#include "nsCRT.h"
|
|
#include "nsIPrintSettings.h"
|
|
#include "nsPropertyTable.h"
|
|
#include "nsGkAtoms.h"
|
|
#include "nsIDocument.h"
|
|
#include "nsInterfaceHashtable.h"
|
|
#include "nsCycleCollectionParticipant.h"
|
|
// XXX we need only gfxTypes.h, but we cannot include it directly.
|
|
#include "gfxPoint.h"
|
|
class nsImageLoader;
|
|
#ifdef IBMBIDI
|
|
class nsBidiPresUtils;
|
|
#endif // IBMBIDI
|
|
|
|
struct nsRect;
|
|
|
|
class imgIRequest;
|
|
|
|
class nsIContent;
|
|
class nsIFontMetrics;
|
|
class nsIFrame;
|
|
class nsFrameManager;
|
|
class nsIImage;
|
|
class nsILinkHandler;
|
|
class nsStyleContext;
|
|
class nsIAtom;
|
|
class nsIEventStateManager;
|
|
class nsIURI;
|
|
class nsILookAndFeel;
|
|
class nsICSSPseudoComparator;
|
|
class nsIAtom;
|
|
struct nsStyleStruct;
|
|
struct nsStyleBackground;
|
|
template <class T> class nsRunnableMethod;
|
|
class nsIRunnable;
|
|
|
|
#ifdef MOZ_REFLOW_PERF
|
|
class nsIRenderingContext;
|
|
#endif
|
|
|
|
enum nsWidgetType {
|
|
eWidgetType_Button = 1,
|
|
eWidgetType_Checkbox = 2,
|
|
eWidgetType_Radio = 3,
|
|
eWidgetType_Text = 4
|
|
};
|
|
|
|
enum nsLanguageSpecificTransformType {
|
|
eLanguageSpecificTransformType_Unknown = -1,
|
|
eLanguageSpecificTransformType_None = 0,
|
|
eLanguageSpecificTransformType_Japanese
|
|
};
|
|
|
|
// supported values for cached bool types
|
|
enum nsPresContext_CachedBoolPrefType {
|
|
kPresContext_UseDocumentColors = 1,
|
|
kPresContext_UseDocumentFonts,
|
|
kPresContext_UnderlineLinks
|
|
};
|
|
|
|
// supported values for cached integer pref types
|
|
enum nsPresContext_CachedIntPrefType {
|
|
kPresContext_MinimumFontSize = 1,
|
|
kPresContext_ScrollbarSide,
|
|
kPresContext_BidiDirection
|
|
};
|
|
|
|
// IDs for the default variable and fixed fonts (not to be changed, see nsFont.h)
|
|
// To be used for Get/SetDefaultFont(). The other IDs in nsFont.h are also supported.
|
|
const PRUint8 kPresContext_DefaultVariableFont_ID = 0x00; // kGenericFont_moz_variable
|
|
const PRUint8 kPresContext_DefaultFixedFont_ID = 0x01; // kGenericFont_moz_fixed
|
|
|
|
#ifdef DEBUG
|
|
struct nsAutoLayoutPhase;
|
|
|
|
enum nsLayoutPhase {
|
|
eLayoutPhase_Paint,
|
|
eLayoutPhase_Reflow,
|
|
eLayoutPhase_FrameC,
|
|
eLayoutPhase_COUNT
|
|
};
|
|
#endif
|
|
|
|
// An interface for presentation contexts. Presentation contexts are
|
|
// objects that provide an outer context for a presentation shell.
|
|
|
|
class nsPresContext : public nsIObserver {
|
|
public:
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_NSIOBSERVER
|
|
NS_DECL_AND_IMPL_ZEROING_OPERATOR_NEW
|
|
NS_DECL_CYCLE_COLLECTION_CLASS(nsPresContext)
|
|
|
|
enum nsPresContextType {
|
|
eContext_Galley, // unpaginated screen presentation
|
|
eContext_PrintPreview, // paginated screen presentation
|
|
eContext_Print, // paginated printer presentation
|
|
eContext_PageLayout // paginated & editable.
|
|
};
|
|
|
|
nsPresContext(nsIDocument* aDocument, nsPresContextType aType) NS_HIDDEN;
|
|
|
|
/**
|
|
* Initialize the presentation context from a particular device.
|
|
*/
|
|
NS_HIDDEN_(nsresult) Init(nsIDeviceContext* aDeviceContext);
|
|
|
|
/**
|
|
* Set the presentation shell that this context is bound to.
|
|
* A presentation context may only be bound to a single shell.
|
|
*/
|
|
NS_HIDDEN_(void) SetShell(nsIPresShell* aShell);
|
|
|
|
|
|
NS_HIDDEN_(nsPresContextType) Type() const { return mType; }
|
|
|
|
/**
|
|
* Get the PresentationShell that this context is bound to.
|
|
*/
|
|
nsIPresShell* PresShell() const
|
|
{
|
|
NS_ASSERTION(mShell, "Null pres shell");
|
|
return mShell;
|
|
}
|
|
|
|
nsIPresShell* GetPresShell() const { return mShell; }
|
|
|
|
// Find the prescontext for the root of the view manager hierarchy that contains
|
|
// this prescontext.
|
|
nsPresContext* RootPresContext();
|
|
|
|
nsIDocument* Document() const
|
|
{
|
|
NS_ASSERTION(!mShell || !mShell->GetDocument() ||
|
|
mShell->GetDocument() == mDocument,
|
|
"nsPresContext doesn't have the same document as nsPresShell!");
|
|
return mDocument;
|
|
}
|
|
|
|
nsIViewManager* GetViewManager() { return GetPresShell()->GetViewManager(); }
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
nsStyleSet* StyleSet() { return GetPresShell()->StyleSet(); }
|
|
|
|
nsFrameManager* FrameManager()
|
|
{ return GetPresShell()->FrameManager(); }
|
|
#endif
|
|
|
|
/**
|
|
* Access compatibility mode for this context. This is the same as
|
|
* our document's compatibility mode.
|
|
*/
|
|
nsCompatibility CompatibilityMode() const {
|
|
return Document()->GetCompatibilityMode();
|
|
}
|
|
/**
|
|
* Notify the context that the document's compatibility mode has changed
|
|
*/
|
|
NS_HIDDEN_(void) CompatibilityModeChanged();
|
|
|
|
/**
|
|
* Access the image animation mode for this context
|
|
*/
|
|
PRUint16 ImageAnimationMode() const { return mImageAnimationMode; }
|
|
virtual NS_HIDDEN_(void) SetImageAnimationModeExternal(PRUint16 aMode);
|
|
NS_HIDDEN_(void) SetImageAnimationModeInternal(PRUint16 aMode);
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
void SetImageAnimationMode(PRUint16 aMode)
|
|
{ SetImageAnimationModeInternal(aMode); }
|
|
#else
|
|
void SetImageAnimationMode(PRUint16 aMode)
|
|
{ SetImageAnimationModeExternal(aMode); }
|
|
#endif
|
|
|
|
/**
|
|
* Get cached look and feel service. This is faster than obtaining it
|
|
* through the service manager.
|
|
*/
|
|
nsILookAndFeel* LookAndFeel() { return mLookAndFeel; }
|
|
|
|
/**
|
|
* Get medium of presentation
|
|
*/
|
|
nsIAtom* Medium() { return mMedium; }
|
|
|
|
/**
|
|
* Clear style data from the root frame downwards, and reflow.
|
|
*/
|
|
NS_HIDDEN_(void) ClearStyleDataAndReflow();
|
|
|
|
void* AllocateFromShell(size_t aSize)
|
|
{
|
|
if (mShell)
|
|
return mShell->AllocateFrame(aSize);
|
|
return nsnull;
|
|
}
|
|
|
|
void FreeToShell(size_t aSize, void* aFreeChunk)
|
|
{
|
|
if (mShell)
|
|
mShell->FreeFrame(aSize, aFreeChunk);
|
|
}
|
|
|
|
/**
|
|
* Get the font metrics for a given font.
|
|
*/
|
|
virtual NS_HIDDEN_(already_AddRefed<nsIFontMetrics>)
|
|
GetMetricsForExternal(const nsFont& aFont);
|
|
NS_HIDDEN_(already_AddRefed<nsIFontMetrics>)
|
|
GetMetricsForInternal(const nsFont& aFont);
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
already_AddRefed<nsIFontMetrics> GetMetricsFor(const nsFont& aFont)
|
|
{ return GetMetricsForInternal(aFont); }
|
|
#else
|
|
already_AddRefed<nsIFontMetrics> GetMetricsFor(const nsFont& aFont)
|
|
{ return GetMetricsForExternal(aFont); }
|
|
#endif
|
|
|
|
/**
|
|
* Get the default font corresponding to the given ID. This object is
|
|
* read-only, you must copy the font to modify it.
|
|
*
|
|
* When aFontID is kPresContext_DefaultVariableFontID or
|
|
* kPresContext_DefaultFixedFontID (which equals
|
|
* kGenericFont_moz_fixed, which is used for the -moz-fixed generic),
|
|
* the nsFont returned has its name as a CSS generic family (serif or
|
|
* sans-serif for the former, monospace for the latter), and its size
|
|
* as the default font size for variable or fixed fonts for the pres
|
|
* context's language group.
|
|
*
|
|
* For aFontID corresponds to a CSS Generic, the nsFont returned has
|
|
* its name as the name or names of the fonts in the user's
|
|
* preferences for the given generic and the pres context's language
|
|
* group, and its size set to the default variable font size.
|
|
*/
|
|
virtual NS_HIDDEN_(const nsFont*) GetDefaultFontExternal(PRUint8 aFontID) const;
|
|
NS_HIDDEN_(const nsFont*) GetDefaultFontInternal(PRUint8 aFontID) const;
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
const nsFont* GetDefaultFont(PRUint8 aFontID) const
|
|
{ return GetDefaultFontInternal(aFontID); }
|
|
#else
|
|
const nsFont* GetDefaultFont(PRUint8 aFontID) const
|
|
{ return GetDefaultFontExternal(aFontID); }
|
|
#endif
|
|
|
|
/** Get a cached boolean pref, by its type */
|
|
// * - initially created for bugs 31816, 20760, 22963
|
|
PRBool GetCachedBoolPref(nsPresContext_CachedBoolPrefType aPrefType) const
|
|
{
|
|
// If called with a constant parameter, the compiler should optimize
|
|
// this switch statement away.
|
|
switch (aPrefType) {
|
|
case kPresContext_UseDocumentFonts:
|
|
return mUseDocumentFonts;
|
|
case kPresContext_UseDocumentColors:
|
|
return mUseDocumentColors;
|
|
case kPresContext_UnderlineLinks:
|
|
return mUnderlineLinks;
|
|
default:
|
|
NS_ERROR("Invalid arg passed to GetCachedBoolPref");
|
|
}
|
|
|
|
return PR_FALSE;
|
|
}
|
|
|
|
/** Get a cached integer pref, by its type */
|
|
// * - initially created for bugs 30910, 61883, 74186, 84398
|
|
PRInt32 GetCachedIntPref(nsPresContext_CachedIntPrefType aPrefType) const
|
|
{
|
|
// If called with a constant parameter, the compiler should optimize
|
|
// this switch statement away.
|
|
switch (aPrefType) {
|
|
case kPresContext_MinimumFontSize:
|
|
return mMinimumFontSize;
|
|
case kPresContext_ScrollbarSide:
|
|
return mPrefScrollbarSide;
|
|
case kPresContext_BidiDirection:
|
|
return mPrefBidiDirection;
|
|
default:
|
|
NS_ERROR("invalid arg passed to GetCachedIntPref");
|
|
}
|
|
|
|
return PR_FALSE;
|
|
}
|
|
|
|
/**
|
|
* Access Nav's magic font scaler value
|
|
*/
|
|
PRInt32 FontScaler() const { return mFontScaler; }
|
|
|
|
/**
|
|
* Get the default colors
|
|
*/
|
|
const nscolor DefaultColor() const { return mDefaultColor; }
|
|
const nscolor DefaultBackgroundColor() const { return mBackgroundColor; }
|
|
const nscolor DefaultLinkColor() const { return mLinkColor; }
|
|
const nscolor DefaultActiveLinkColor() const { return mActiveLinkColor; }
|
|
const nscolor DefaultVisitedLinkColor() const { return mVisitedLinkColor; }
|
|
const nscolor FocusBackgroundColor() const { return mFocusBackgroundColor; }
|
|
const nscolor FocusTextColor() const { return mFocusTextColor; }
|
|
|
|
PRBool GetUseFocusColors() const { return mUseFocusColors; }
|
|
PRUint8 FocusRingWidth() const { return mFocusRingWidth; }
|
|
PRBool GetFocusRingOnAnything() const { return mFocusRingOnAnything; }
|
|
|
|
|
|
/**
|
|
* Load an image for the target frame. This call can be made
|
|
* repeated with only a single image ever being loaded. When the
|
|
* image's data is ready for rendering the target frame's Paint()
|
|
* method will be invoked (via the ViewManager) so that the
|
|
* appropriate damage repair is done.
|
|
*/
|
|
NS_HIDDEN_(imgIRequest*) LoadImage(imgIRequest* aImage,
|
|
nsIFrame* aTargetFrame);
|
|
|
|
/**
|
|
* This method is called when a frame is being destroyed to
|
|
* ensure that the image load gets disassociated from the prescontext
|
|
*/
|
|
NS_HIDDEN_(void) StopImagesFor(nsIFrame* aTargetFrame);
|
|
|
|
NS_HIDDEN_(void) SetContainer(nsISupports* aContainer);
|
|
|
|
virtual NS_HIDDEN_(already_AddRefed<nsISupports>) GetContainerExternal();
|
|
NS_HIDDEN_(already_AddRefed<nsISupports>) GetContainerInternal();
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
already_AddRefed<nsISupports> GetContainer()
|
|
{ return GetContainerInternal(); }
|
|
#else
|
|
already_AddRefed<nsISupports> GetContainer()
|
|
{ return GetContainerExternal(); }
|
|
#endif
|
|
|
|
// XXX this are going to be replaced with set/get container
|
|
void SetLinkHandler(nsILinkHandler* aHandler) { mLinkHandler = aHandler; }
|
|
nsILinkHandler* GetLinkHandler() { return mLinkHandler; }
|
|
|
|
/**
|
|
* Get the visible area associated with this presentation context.
|
|
* This is the size of the visiable area that is used for
|
|
* presenting the document. The returned value is in the standard
|
|
* nscoord units (as scaled by the device context).
|
|
*/
|
|
nsRect GetVisibleArea() { return mVisibleArea; }
|
|
|
|
/**
|
|
* Set the currently visible area. The units for r are standard
|
|
* nscoord units (as scaled by the device context).
|
|
*/
|
|
void SetVisibleArea(const nsRect& r) { mVisibleArea = r; }
|
|
|
|
/**
|
|
* Return true if this presentation context is a paginated
|
|
* context.
|
|
*/
|
|
PRBool IsPaginated() const { return mPaginated; }
|
|
|
|
PRBool GetRenderedPositionVaryingContent() const { return mRenderedPositionVaryingContent; }
|
|
void SetRenderedPositionVaryingContent() { mRenderedPositionVaryingContent = PR_TRUE; }
|
|
|
|
/**
|
|
* Sets whether the presentation context can scroll for a paginated
|
|
* context.
|
|
*/
|
|
NS_HIDDEN_(void) SetPaginatedScrolling(PRBool aResult);
|
|
|
|
/**
|
|
* Return true if this presentation context can scroll for paginated
|
|
* context.
|
|
*/
|
|
PRBool HasPaginatedScrolling() const { return mCanPaginatedScroll; }
|
|
|
|
/**
|
|
* Get/set the size of a page
|
|
*/
|
|
nsSize GetPageSize() { return mPageSize; }
|
|
void SetPageSize(nsSize aSize) { mPageSize = aSize; }
|
|
|
|
/**
|
|
* Get/set whether this document should be treated as having real pages
|
|
* XXX This raises the obvious question of why a document that isn't a page
|
|
* is paginated; there isn't a good reason except history
|
|
*/
|
|
PRBool IsRootPaginatedDocument() { return mIsRootPaginatedDocument; }
|
|
void SetIsRootPaginatedDocument(PRBool aIsRootPaginatedDocument)
|
|
{ mIsRootPaginatedDocument = aIsRootPaginatedDocument; }
|
|
|
|
/**
|
|
* Get/set the print scaling level; used by nsPageFrame to scale up
|
|
* pages. Set safe to call before reflow, get guaranteed to be set
|
|
* properly after reflow.
|
|
*/
|
|
|
|
float GetPageScale() { return mPageScale; }
|
|
void SetPageScale(float aScale) { mPageScale = aScale; }
|
|
|
|
/**
|
|
* Get/set the scaling facor to use when rendering the pages for print preview.
|
|
* Only safe to get after print preview set up; safe to set anytime.
|
|
* This is a scaling factor for the display of the print preview. It
|
|
* does not affect layout. It only affects the size of the onscreen pages
|
|
* in print preview.
|
|
* XXX Temporary: see http://wiki.mozilla.org/Gecko:PrintPreview
|
|
*/
|
|
float GetPrintPreviewScale() { return mPPScale; }
|
|
void SetPrintPreviewScale(float aScale) { mPPScale = aScale; }
|
|
|
|
nsIDeviceContext* DeviceContext() { return mDeviceContext; }
|
|
nsIEventStateManager* EventStateManager() { return mEventManager; }
|
|
nsIAtom* GetLangGroup() { return mLangGroup; }
|
|
|
|
float TextZoom() { return mTextZoom; }
|
|
void SetTextZoom(float aZoom) {
|
|
mTextZoom = aZoom;
|
|
ClearStyleDataAndReflow();
|
|
}
|
|
|
|
float GetFullZoom() { return mFullZoom; }
|
|
void SetFullZoom(float aZoom);
|
|
|
|
nscoord GetAutoQualityMinFontSize() {
|
|
return DevPixelsToAppUnits(mAutoQualityMinFontSizePixelsPref);
|
|
}
|
|
|
|
static PRInt32 AppUnitsPerCSSPixel() { return nsIDeviceContext::AppUnitsPerCSSPixel(); }
|
|
PRInt32 AppUnitsPerDevPixel() const { return mDeviceContext->AppUnitsPerDevPixel(); }
|
|
PRInt32 AppUnitsPerInch() const { return mDeviceContext->AppUnitsPerInch(); }
|
|
|
|
static nscoord CSSPixelsToAppUnits(PRInt32 aPixels)
|
|
{ return NSIntPixelsToAppUnits(aPixels,
|
|
nsIDeviceContext::AppUnitsPerCSSPixel()); }
|
|
|
|
static nscoord CSSPixelsToAppUnits(float aPixels)
|
|
{ return NSFloatPixelsToAppUnits(aPixels,
|
|
nsIDeviceContext::AppUnitsPerCSSPixel()); }
|
|
|
|
static PRInt32 AppUnitsToIntCSSPixels(nscoord aAppUnits)
|
|
{ return NSAppUnitsToIntPixels(aAppUnits,
|
|
nsIDeviceContext::AppUnitsPerCSSPixel()); }
|
|
|
|
static float AppUnitsToFloatCSSPixels(nscoord aAppUnits)
|
|
{ return NSAppUnitsToFloatPixels(aAppUnits,
|
|
nsIDeviceContext::AppUnitsPerCSSPixel()); }
|
|
|
|
static gfxFloat AppUnitsToGfxCSSPixels(nscoord aAppUnits)
|
|
{ return nsIDeviceContext::AppUnitsToGfxCSSPixels(aAppUnits); }
|
|
|
|
nscoord DevPixelsToAppUnits(PRInt32 aPixels) const
|
|
{ return NSIntPixelsToAppUnits(aPixels,
|
|
mDeviceContext->AppUnitsPerDevPixel()); }
|
|
|
|
PRInt32 AppUnitsToDevPixels(nscoord aAppUnits) const
|
|
{ return NSAppUnitsToIntPixels(aAppUnits,
|
|
mDeviceContext->AppUnitsPerDevPixel()); }
|
|
|
|
gfxFloat AppUnitsToGfxUnits(nscoord aAppUnits) const
|
|
{ return mDeviceContext->AppUnitsToGfxUnits(aAppUnits); }
|
|
|
|
nscoord TwipsToAppUnits(PRInt32 aTwips) const
|
|
{ return NSToCoordRound(NS_TWIPS_TO_INCHES(aTwips) *
|
|
mDeviceContext->AppUnitsPerInch()); }
|
|
|
|
PRInt32 AppUnitsToTwips(nscoord aTwips) const
|
|
{ return NS_INCHES_TO_TWIPS((float)aTwips /
|
|
mDeviceContext->AppUnitsPerInch()); }
|
|
|
|
nscoord PointsToAppUnits(float aPoints) const
|
|
{ return NSToCoordRound(aPoints * mDeviceContext->AppUnitsPerInch() /
|
|
72.0f); }
|
|
float AppUnitsToPoints(nscoord aAppUnits) const
|
|
{ return (float)aAppUnits / mDeviceContext->AppUnitsPerInch() * 72.0f; }
|
|
|
|
nscoord RoundAppUnitsToNearestDevPixels(nscoord aAppUnits) const
|
|
{ return DevPixelsToAppUnits(AppUnitsToDevPixels(aAppUnits)); }
|
|
|
|
/**
|
|
* Get the language-specific transform type for the current document.
|
|
* This tells us whether we need to perform special language-dependent
|
|
* transformations such as Unicode U+005C (backslash) to Japanese
|
|
* Yen Sign (Unicode U+00A5, JIS 0x5C).
|
|
*
|
|
* @param aType returns type, must be non-NULL
|
|
*/
|
|
nsLanguageSpecificTransformType LanguageSpecificTransformType() const
|
|
{
|
|
return mLanguageSpecificTransformType;
|
|
}
|
|
|
|
struct ScrollbarStyles {
|
|
// Always one of NS_STYLE_OVERFLOW_SCROLL, NS_STYLE_OVERFLOW_HIDDEN,
|
|
// or NS_STYLE_OVERFLOW_AUTO.
|
|
PRUint8 mHorizontal, mVertical;
|
|
ScrollbarStyles(PRUint8 h, PRUint8 v) : mHorizontal(h), mVertical(v) {}
|
|
ScrollbarStyles() {}
|
|
};
|
|
void SetViewportOverflowOverride(PRUint8 aX, PRUint8 aY)
|
|
{
|
|
mViewportStyleOverflow.mHorizontal = aX;
|
|
mViewportStyleOverflow.mVertical = aY;
|
|
}
|
|
ScrollbarStyles GetViewportOverflowOverride()
|
|
{
|
|
return mViewportStyleOverflow;
|
|
}
|
|
|
|
/**
|
|
* Set and get methods for controlling the background drawing
|
|
*/
|
|
PRBool GetBackgroundImageDraw() const { return mDrawImageBackground; }
|
|
void SetBackgroundImageDraw(PRBool aCanDraw)
|
|
{
|
|
NS_ASSERTION(!(aCanDraw & ~1), "Value must be true or false");
|
|
mDrawImageBackground = aCanDraw;
|
|
}
|
|
|
|
PRBool GetBackgroundColorDraw() const { return mDrawColorBackground; }
|
|
void SetBackgroundColorDraw(PRBool aCanDraw)
|
|
{
|
|
NS_ASSERTION(!(aCanDraw & ~1), "Value must be true or false");
|
|
mDrawColorBackground = aCanDraw;
|
|
}
|
|
|
|
#ifdef IBMBIDI
|
|
/**
|
|
* Check if bidi enabled (set depending on the presence of RTL
|
|
* characters or when default directionality is RTL).
|
|
* If enabled, we should apply the Unicode Bidi Algorithm
|
|
*
|
|
* @lina 07/12/2000
|
|
*/
|
|
virtual NS_HIDDEN_(PRBool) BidiEnabledExternal() const;
|
|
NS_HIDDEN_(PRBool) BidiEnabledInternal() const;
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
PRBool BidiEnabled() const { return BidiEnabledInternal(); }
|
|
#else
|
|
PRBool BidiEnabled() const { return BidiEnabledExternal(); }
|
|
#endif
|
|
|
|
/**
|
|
* Set bidi enabled. This means we should apply the Unicode Bidi Algorithm
|
|
*
|
|
* @lina 07/12/2000
|
|
*/
|
|
NS_HIDDEN_(void) SetBidiEnabled(PRBool aBidiEnabled) const;
|
|
|
|
/**
|
|
* Set visual or implicit mode into the pres context.
|
|
*
|
|
* Visual directionality is a presentation method that displays text
|
|
* as if it were a uni-directional, according to the primary display
|
|
* direction only.
|
|
*
|
|
* Implicit directionality is a presentation method in which the
|
|
* direction is determined by the Bidi algorithm according to the
|
|
* category of the characters and the category of the adjacent
|
|
* characters, and according to their primary direction.
|
|
*
|
|
* @lina 05/02/2000
|
|
*/
|
|
void SetVisualMode(PRBool aIsVisual)
|
|
{
|
|
NS_ASSERTION(!(aIsVisual & ~1), "Value must be true or false");
|
|
mIsVisual = aIsVisual;
|
|
}
|
|
|
|
/**
|
|
* Check whether the content should be treated as visual.
|
|
*
|
|
* @lina 05/02/2000
|
|
*/
|
|
PRBool IsVisualMode() const { return mIsVisual; }
|
|
|
|
//Mohamed
|
|
|
|
/**
|
|
* Get a Bidi presentation utilities object
|
|
*/
|
|
NS_HIDDEN_(nsBidiPresUtils*) GetBidiUtils();
|
|
|
|
/**
|
|
* Set the Bidi options for the presentation context
|
|
*/
|
|
NS_HIDDEN_(void) SetBidi(PRUint32 aBidiOptions,
|
|
PRBool aForceReflow = PR_FALSE);
|
|
|
|
/**
|
|
* Get the Bidi options for the presentation context
|
|
* Not inline so consumers of nsPresContext are not forced to
|
|
* include nsIDocument.
|
|
*/
|
|
NS_HIDDEN_(PRUint32) GetBidi() const;
|
|
|
|
/**
|
|
* Set the Bidi capabilities of the system
|
|
* @param aIsBidi == TRUE if the system has the capability of reordering Bidi text
|
|
*/
|
|
void SetIsBidiSystem(PRBool aIsBidi)
|
|
{
|
|
NS_ASSERTION(!(aIsBidi & ~1), "Value must be true or false");
|
|
mIsBidiSystem = aIsBidi;
|
|
}
|
|
|
|
/**
|
|
* Get the Bidi capabilities of the system
|
|
* @return TRUE if the system has the capability of reordering Bidi text
|
|
*/
|
|
PRBool IsBidiSystem() const { return mIsBidiSystem; }
|
|
#endif // IBMBIDI
|
|
|
|
/**
|
|
* Render only Selection
|
|
*/
|
|
void SetIsRenderingOnlySelection(PRBool aResult)
|
|
{
|
|
NS_ASSERTION(!(aResult & ~1), "Value must be true or false");
|
|
mIsRenderingOnlySelection = aResult;
|
|
}
|
|
|
|
PRBool IsRenderingOnlySelection() const { return mIsRenderingOnlySelection; }
|
|
|
|
/*
|
|
* Obtain a native them for rendering our widgets (both form controls and html)
|
|
*/
|
|
NS_HIDDEN_(nsITheme*) GetTheme();
|
|
|
|
/*
|
|
* Notify the pres context that the theme has changed. An internal switch
|
|
* means it's one of our Mozilla themes that changed (e.g., Modern to Classic).
|
|
* Otherwise, the OS is telling us that the native theme for the platform
|
|
* has changed.
|
|
*/
|
|
NS_HIDDEN_(void) ThemeChanged();
|
|
|
|
/*
|
|
* Notify the pres context that a system color has changed
|
|
*/
|
|
NS_HIDDEN_(void) SysColorChanged();
|
|
|
|
/** Printing methods below should only be used for Medium() == print **/
|
|
NS_HIDDEN_(void) SetPrintSettings(nsIPrintSettings *aPrintSettings);
|
|
|
|
nsIPrintSettings* GetPrintSettings() { return mPrintSettings; }
|
|
|
|
/* Accessor for table of frame properties */
|
|
nsPropertyTable* PropertyTable() { return &mPropertyTable; }
|
|
|
|
/* Helper function that ensures that this prescontext is shown in its
|
|
docshell if it's the most recent prescontext for the docshell. Returns
|
|
whether the prescontext is now being shown.
|
|
|
|
@param aUnsuppressFocus If this is false, then focus will not be
|
|
unsuppressed when PR_TRUE is returned. It's the caller's responsibility
|
|
to unsuppress focus in that case.
|
|
*/
|
|
NS_HIDDEN_(PRBool) EnsureVisible(PRBool aUnsuppressFocus);
|
|
|
|
#ifdef MOZ_REFLOW_PERF
|
|
NS_HIDDEN_(void) CountReflows(const char * aName,
|
|
nsIFrame * aFrame);
|
|
#endif
|
|
|
|
/**
|
|
* This table maps border-width enums 'thin', 'medium', 'thick'
|
|
* to actual nscoord values.
|
|
*/
|
|
const nscoord* GetBorderWidthTable() { return mBorderWidthTable; }
|
|
|
|
PRBool IsDynamic() { return (mType == eContext_PageLayout || mType == eContext_Galley); }
|
|
PRBool IsScreen() { return (mMedium == nsGkAtoms::screen ||
|
|
mType == eContext_PageLayout ||
|
|
mType == eContext_PrintPreview); }
|
|
|
|
// Is this presentation in a chrome docshell?
|
|
PRBool IsChrome();
|
|
|
|
protected:
|
|
friend class nsRunnableMethod<nsPresContext>;
|
|
NS_HIDDEN_(void) ThemeChangedInternal();
|
|
NS_HIDDEN_(void) SysColorChangedInternal();
|
|
|
|
NS_HIDDEN_(void) SetImgAnimations(nsIContent *aParent, PRUint16 aMode);
|
|
NS_HIDDEN_(void) GetDocumentColorPreferences();
|
|
|
|
NS_HIDDEN_(void) PreferenceChanged(const char* aPrefName);
|
|
static NS_HIDDEN_(int) PR_CALLBACK PrefChangedCallback(const char*, void*);
|
|
|
|
NS_HIDDEN_(void) UpdateAfterPreferencesChanged();
|
|
static NS_HIDDEN_(void) PR_CALLBACK PrefChangedUpdateTimerCallback(nsITimer *aTimer, void *aClosure);
|
|
|
|
NS_HIDDEN_(void) GetUserPreferences();
|
|
NS_HIDDEN_(void) GetFontPreferences();
|
|
|
|
NS_HIDDEN_(void) UpdateCharSet(const nsAFlatCString& aCharSet);
|
|
|
|
// IMPORTANT: The ownership implicit in the following member variables
|
|
// has been explicitly checked. If you add any members to this class,
|
|
// please make the ownership explicit (pinkerton, scc).
|
|
|
|
nsPresContextType mType;
|
|
nsIPresShell* mShell; // [WEAK]
|
|
nsCOMPtr<nsIDocument> mDocument;
|
|
nsIDeviceContext* mDeviceContext; // [STRONG] could be weak, but
|
|
// better safe than sorry.
|
|
// Cannot reintroduce cycles
|
|
// since there is no dependency
|
|
// from gfx back to layout.
|
|
nsIEventStateManager* mEventManager; // [STRONG]
|
|
nsILookAndFeel* mLookAndFeel; // [STRONG]
|
|
nsIAtom* mMedium; // initialized by subclass ctors;
|
|
// weak pointer to static atom
|
|
|
|
nsILinkHandler* mLinkHandler; // [WEAK]
|
|
nsIAtom* mLangGroup; // [STRONG]
|
|
|
|
nsInterfaceHashtable<nsVoidPtrHashKey, nsImageLoader> mImageLoaders;
|
|
nsWeakPtr mContainer;
|
|
|
|
float mTextZoom; // Text zoom, defaults to 1.0
|
|
float mFullZoom; // Page zoom, defaults to 1.0
|
|
PRInt32 mCurAppUnitsPerDevPixel;
|
|
PRInt32 mAutoQualityMinFontSizePixelsPref;
|
|
|
|
#ifdef IBMBIDI
|
|
nsBidiPresUtils* mBidiUtils;
|
|
#endif
|
|
|
|
nsCOMPtr<nsITheme> mTheme;
|
|
nsCOMPtr<nsILanguageAtomService> mLangService;
|
|
nsCOMPtr<nsIPrintSettings> mPrintSettings;
|
|
nsCOMPtr<nsITimer> mPrefChangedTimer;
|
|
|
|
nsPropertyTable mPropertyTable;
|
|
|
|
nsLanguageSpecificTransformType mLanguageSpecificTransformType;
|
|
PRInt32 mFontScaler;
|
|
nscoord mMinimumFontSize;
|
|
|
|
nsRect mVisibleArea;
|
|
nsSize mPageSize;
|
|
float mPageScale;
|
|
float mPPScale;
|
|
|
|
nscolor mDefaultColor;
|
|
nscolor mBackgroundColor;
|
|
|
|
nscolor mLinkColor;
|
|
nscolor mActiveLinkColor;
|
|
nscolor mVisitedLinkColor;
|
|
|
|
nscolor mFocusBackgroundColor;
|
|
nscolor mFocusTextColor;
|
|
|
|
ScrollbarStyles mViewportStyleOverflow;
|
|
PRUint8 mFocusRingWidth;
|
|
|
|
PRUint16 mImageAnimationMode;
|
|
PRUint16 mImageAnimationModePref;
|
|
|
|
nsFont mDefaultVariableFont;
|
|
nsFont mDefaultFixedFont;
|
|
nsFont mDefaultSerifFont;
|
|
nsFont mDefaultSansSerifFont;
|
|
nsFont mDefaultMonospaceFont;
|
|
nsFont mDefaultCursiveFont;
|
|
nsFont mDefaultFantasyFont;
|
|
|
|
nscoord mBorderWidthTable[3];
|
|
|
|
unsigned mUseDocumentFonts : 1;
|
|
unsigned mUseDocumentColors : 1;
|
|
unsigned mUnderlineLinks : 1;
|
|
unsigned mUseFocusColors : 1;
|
|
unsigned mFocusRingOnAnything : 1;
|
|
unsigned mDrawImageBackground : 1;
|
|
unsigned mDrawColorBackground : 1;
|
|
unsigned mNeverAnimate : 1;
|
|
unsigned mIsRenderingOnlySelection : 1;
|
|
unsigned mNoTheme : 1;
|
|
unsigned mPaginated : 1;
|
|
unsigned mCanPaginatedScroll : 1;
|
|
unsigned mDoScaledTwips : 1;
|
|
unsigned mEnableJapaneseTransform : 1;
|
|
unsigned mIsRootPaginatedDocument : 1;
|
|
unsigned mPrefBidiDirection : 1;
|
|
unsigned mPrefScrollbarSide : 2;
|
|
unsigned mPendingSysColorChanged : 1;
|
|
unsigned mPendingThemeChanged : 1;
|
|
unsigned mRenderedPositionVaryingContent : 1;
|
|
|
|
#ifdef IBMBIDI
|
|
unsigned mIsVisual : 1;
|
|
unsigned mIsBidiSystem : 1;
|
|
|
|
#endif
|
|
#ifdef DEBUG
|
|
PRBool mInitialized;
|
|
#endif
|
|
|
|
|
|
protected:
|
|
|
|
~nsPresContext() NS_HIDDEN;
|
|
|
|
// these are private, use the list in nsFont.h if you want a public list
|
|
enum {
|
|
eDefaultFont_Variable,
|
|
eDefaultFont_Fixed,
|
|
eDefaultFont_Serif,
|
|
eDefaultFont_SansSerif,
|
|
eDefaultFont_Monospace,
|
|
eDefaultFont_Cursive,
|
|
eDefaultFont_Fantasy,
|
|
eDefaultFont_COUNT
|
|
};
|
|
|
|
#ifdef DEBUG
|
|
private:
|
|
friend struct nsAutoLayoutPhase;
|
|
PRUint32 mLayoutPhaseCount[eLayoutPhase_COUNT];
|
|
public:
|
|
PRUint32 LayoutPhaseCount(nsLayoutPhase aPhase) {
|
|
return mLayoutPhaseCount[aPhase];
|
|
}
|
|
#endif
|
|
|
|
};
|
|
|
|
// Bit values for StartLoadImage's aImageStatus
|
|
#define NS_LOAD_IMAGE_STATUS_ERROR 0x1
|
|
#define NS_LOAD_IMAGE_STATUS_SIZE 0x2
|
|
#define NS_LOAD_IMAGE_STATUS_BITS 0x4
|
|
|
|
#ifdef DEBUG
|
|
|
|
struct nsAutoLayoutPhase {
|
|
nsAutoLayoutPhase(nsPresContext* aPresContext, nsLayoutPhase aPhase)
|
|
: mPresContext(aPresContext), mPhase(aPhase), mCount(0)
|
|
{
|
|
Enter();
|
|
}
|
|
|
|
~nsAutoLayoutPhase()
|
|
{
|
|
Exit();
|
|
NS_ASSERTION(mCount == 0, "imbalanced");
|
|
}
|
|
|
|
void Enter()
|
|
{
|
|
switch (mPhase) {
|
|
case eLayoutPhase_Paint:
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Paint] == 0,
|
|
"recurring into paint");
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Reflow] == 0,
|
|
"painting in the middle of reflow");
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_FrameC] == 0,
|
|
"painting in the middle of frame construction");
|
|
break;
|
|
case eLayoutPhase_Reflow:
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Paint] == 0,
|
|
"reflowing in the middle of a paint");
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Reflow] == 0,
|
|
"recurring into reflow");
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_FrameC] == 0,
|
|
"reflowing in the middle of frame construction");
|
|
break;
|
|
case eLayoutPhase_FrameC:
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Paint] == 0,
|
|
"constructing frames in the middle of a paint");
|
|
NS_ASSERTION(mPresContext->mLayoutPhaseCount[eLayoutPhase_Reflow] == 0,
|
|
"constructing frames in the middle of reflow");
|
|
// The nsXBLService::LoadBindings call in ConstructFrameInternal
|
|
// makes us hit this one too often to be an NS_ASSERTION,
|
|
// despite how scary it is.
|
|
NS_WARN_IF_FALSE(mPresContext->mLayoutPhaseCount[eLayoutPhase_FrameC] == 0,
|
|
"recurring into frame construction");
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
++(mPresContext->mLayoutPhaseCount[mPhase]);
|
|
++mCount;
|
|
}
|
|
|
|
void Exit()
|
|
{
|
|
NS_ASSERTION(mCount > 0 && mPresContext->mLayoutPhaseCount[mPhase] > 0,
|
|
"imbalanced");
|
|
--(mPresContext->mLayoutPhaseCount[mPhase]);
|
|
--mCount;
|
|
}
|
|
|
|
private:
|
|
nsPresContext *mPresContext;
|
|
nsLayoutPhase mPhase;
|
|
PRUint32 mCount;
|
|
};
|
|
|
|
#define AUTO_LAYOUT_PHASE_ENTRY_POINT(pc_, phase_) \
|
|
nsAutoLayoutPhase autoLayoutPhase((pc_), (eLayoutPhase_##phase_))
|
|
#define LAYOUT_PHASE_TEMP_EXIT() \
|
|
PR_BEGIN_MACRO \
|
|
autoLayoutPhase.Exit(); \
|
|
PR_END_MACRO
|
|
#define LAYOUT_PHASE_TEMP_REENTER() \
|
|
PR_BEGIN_MACRO \
|
|
autoLayoutPhase.Enter(); \
|
|
PR_END_MACRO
|
|
|
|
#else
|
|
|
|
#define AUTO_LAYOUT_PHASE_ENTRY_POINT(pc_, phase_) \
|
|
PR_BEGIN_MACRO PR_END_MACRO
|
|
#define LAYOUT_PHASE_TEMP_EXIT() \
|
|
PR_BEGIN_MACRO PR_END_MACRO
|
|
#define LAYOUT_PHASE_TEMP_REENTER() \
|
|
PR_BEGIN_MACRO PR_END_MACRO
|
|
|
|
#endif
|
|
|
|
#ifdef MOZ_REFLOW_PERF
|
|
|
|
#define DO_GLOBAL_REFLOW_COUNT(_name) \
|
|
aPresContext->CountReflows((_name), (nsIFrame*)this);
|
|
#else
|
|
#define DO_GLOBAL_REFLOW_COUNT(_name)
|
|
#endif // MOZ_REFLOW_PERF
|
|
|
|
#endif /* nsPresContext_h___ */
|