#ifndef Frame_h
#define Frame_h
#include "AdjustViewSizeOrNot.h"
#include "AnimationController.h"
#include "DragImage.h"
#include "Editor.h"
#include "EventHandler.h"
#include "FrameLoader.h"
#include "FrameSelection.h"
#include "FrameTree.h"
#include "NavigationScheduler.h"
#include "ScriptController.h"
#include "UserScriptTypes.h"
#include "FloatSize.h"
#include "KURL.h"
#include "MathMLNames.h"
#include "SVGNames.h"
#include "ViewportArguments.h"
#include "XLinkNames.h"
#if PLATFORM(WIN)
#include "FrameWin.h"
#endif
#if USE(TILED_BACKING_STORE)
#include "TiledBackingStoreClient.h"
#endif
#ifndef __OBJC__
class NSArray;
class NSMutableDictionary;
class NSString;
#endif
#ifdef __OBJC__
@class DOMNode;
@class DOMCSSStyleDeclaration;
#else
class DOMNode;
class DOMCSSStyleDeclaration;
#endif
#if PLATFORM(WIN)
typedef struct HBITMAP__* HBITMAP;
#endif
namespace WebCore {
class Document;
class FrameDestructionObserver;
class FrameView;
class HTMLTableCellElement;
class RegularExpression;
class RenderLayer;
class RenderPart;
class TiledBackingStore;
enum NodeImageFlag {
DrawNormally = 0,
AllowDownsampling = 1,
DrawContentBehindTransparentNodes = 1 << 1
};
typedef unsigned NodeImageFlags;
enum {
OverflowScrollNone = 0x0,
OverflowScrollLeft = 0x1,
OverflowScrollRight = 0x2,
OverflowScrollUp = 0x4,
OverflowScrollDown = 0x8
};
enum OverflowScrollAction { DoNotPerformOverflowScroll, PerformOverflowScroll };
typedef Node* (*NodeQualifier)(const HitTestResult& hitTestResult, Node* terminationNode, IntRect* nodeBounds);
#if !USE(TILED_BACKING_STORE)
class TiledBackingStoreClient { };
#endif
class TreeScope;
class Frame : public RefCounted<Frame>, public TiledBackingStoreClient {
public:
static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
void init();
void initWithSimpleHTMLDocument(const String& style, const KURL& url);
void setView(PassRefPtr<FrameView>);
void createView(const IntSize&, const Color&, bool, const IntSize&, bool,
ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
~Frame();
void addDestructionObserver(FrameDestructionObserver*);
void removeDestructionObserver(FrameDestructionObserver*);
void willDetachPage();
void detachFromPage();
void disconnectOwnerElement();
Page* page() const;
HTMLFrameOwnerElement* ownerElement() const;
Document* document() const;
FrameView* view() const;
Editor* editor() const;
EventHandler* eventHandler() const;
FrameLoader* loader() const;
NavigationScheduler* navigationScheduler() const;
FrameSelection* selection() const;
FrameTree* tree() const;
AnimationController* animation() const;
ScriptController* script();
RenderView* contentRenderer() const; RenderPart* ownerRenderer() const;
#if ENABLE(PAGE_VISIBILITY_API)
void dispatchVisibilityStateChangeEvent();
#endif
bool isDisconnected() const;
void setIsDisconnected(bool);
bool excludeFromTextSearch() const;
void setExcludeFromTextSearch(bool);
bool inScope(TreeScope*) const;
float documentScale() const; float minimumDocumentScale() const; float deviceScaleFactor() const; void documentScaleChanged();
void injectUserScripts(UserScriptInjectionTime);
String layerTreeAsText(bool showDebugInfo = false) const;
DOMWindow* domWindow() const;
DOMWindow* existingDOMWindow() { return m_domWindow.get(); }
void setDOMWindow(DOMWindow*);
void clearDOMWindow();
static Frame* frameForWidget(const Widget*);
Settings* settings() const;
void setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
bool shouldUsePrintingLayout() const;
FloatSize resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize);
bool inViewSourceMode() const;
void setInViewSourceMode(bool = true);
void setDocument(PassRefPtr<Document>);
void setPageZoomFactor(float factor);
float pageZoomFactor() const { return m_pageZoomFactor; }
void setTextZoomFactor(float factor);
float textZoomFactor() const { return m_textZoomFactor; }
void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
float frameScaleFactor() const;
#if USE(ACCELERATED_COMPOSITING)
void deviceOrPageScaleFactorChanged();
#endif
void didParse(double);
void didLayout(bool, double);
void didForcedLayout();
void getPPTStats(unsigned& parseCount, unsigned& layoutCount, unsigned& forcedLayoutCount, CFTimeInterval& parseDuration, CFTimeInterval& layoutDuration);
void clearPPTStats();
const ViewportArguments& viewportArguments() const;
void setViewportArguments(const ViewportArguments&);
NSDictionary* dictionaryForViewportArguments(const ViewportArguments& arguments) const;
void betterApproximateNode(const IntPoint& testPoint, NodeQualifier, Node*& best, Node* failedNode, IntPoint& bestPoint, IntRect& bestRect, const IntRect& testRect);
bool hitTestResultAtViewportLocation(CGPoint* viewportLocation, HitTestResult& hitTestResult, IntPoint& center);
Node* qualifyingNodeAtViewportLocation(CGPoint* viewportLocation, NodeQualifier aQualifer, bool shouldApproximate);
Node* deepestNodeAtLocation(CGPoint* viewportLocation);
Node* nodeRespondingToClickEvents(CGPoint* viewportLocation);
Node* nodeRespondingToScrollWheelEvents(CGPoint* viewportLocation);
int indexCountOfWordPrecedingSelection(NSString *word) const;
NSArray *wordsInCurrentParagraph() const;
CGRect renderRectForPoint(CGPoint point, bool* isReplaced, float* fontSize) const;
void setSelectionChangeCallbacksDisabled(bool b = true);
bool selectionChangeCallbacksDisabled() const;
void viewportOffsetChanged();
void overflowScrollPositionChangedForNode(const IntPoint&, Node*, bool isUserScroll);
void resetAllGeolocationPermission();
#if ENABLE(ORIENTATION_EVENTS)
void sendOrientationChangeEvent(int orientation);
int orientation() const { return m_orientation; }
#endif
void clearTimers();
static void clearTimers(FrameView*, Document*);
String documentTypeString() const;
String displayStringModifiedByEncoding(const String&) const;
DragImageRef nodeImage(Node*);
DragImageRef dragImageForSelection();
void setSingleLineSelectionBehavior(bool b);
bool singleLineSelectionBehavior() const;
void scrollOverflowLayer(RenderLayer *, const IntRect &visibleRect, const IntRect &exposeRect);
private:
void overflowAutoScrollTimerFired(Timer<Frame>*);
void startOverflowAutoScroll(const IntPoint &);
void stopOverflowAutoScroll();
int checkOverflowScroll(OverflowScrollAction);
public:
VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
Document* documentAtPoint(const IntPoint& windowPoint);
PassRefPtr<Range> rangeForPoint(const IntPoint& framePoint);
String searchForLabelsAboveCell(RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
#if PLATFORM(MAC)
CGImageRef selectionImage(bool forceBlackText = false) const;
CGImageRef nodeImage(Node*, NodeImageFlags flags = DrawNormally) const;
CGImageRef imageFromRect(NSRect, bool allowDownsampling = false) const;
#endif
public:
void setTextAutosizingWidth(float width);
float textAutosizingWidth() const;
public:
int preferredHeight() const;
int innerLineHeight(DOMNode *node) const;
void updateLayout() const;
NSRect caretRect() const;
NSRect rectForScrollToVisible() const;
NSRect rectForSelection(VisibleSelection&) const;
DOMCSSStyleDeclaration *styleAtSelectionStart() const;
void createDefaultFieldEditorDocumentStructure() const;
unsigned formElementsCharacterCount() const;
void setTimersPaused(bool);
bool timersPaused() const { return m_timersPausedCount; }
void dispatchPageHideEventBeforePause();
void dispatchPageShowEventBeforeResume();
void setRangedSelectionBaseToCurrentSelection();
void setRangedSelectionBaseToCurrentSelectionStart();
void setRangedSelectionBaseToCurrentSelectionEnd();
void clearRangedSelectionInitialExtent();
void setRangedSelectionInitialExtentToCurrentSelectionStart();
void setRangedSelectionInitialExtentToCurrentSelectionEnd();
VisibleSelection rangedSelectionBase() const;
VisibleSelection rangedSelectionInitialExtent() const;
void recursiveSetUpdateAppearanceEnabled(bool);
NSArray* interpretationsForCurrentRoot() const;
private:
void setTimersPausedInternal(bool);
public:
void suspendActiveDOMObjectsAndAnimations();
void resumeActiveDOMObjectsAndAnimations();
bool activeDOMObjectsAndAnimationsSuspended() const { return m_activeDOMObjectsAndAnimationsSuspendedCount > 0; }
void notifyChromeClientWheelEventHandlerCountChanged() const;
void notifyChromeClientTouchEventHandlerCountChanged() const;
private:
Frame(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
void injectUserScriptsForWorld(DOMWrapperWorld*, const UserScriptVector&, UserScriptInjectionTime);
HashSet<FrameDestructionObserver*> m_destructionObservers;
Page* m_page;
mutable FrameTree m_treeNode;
mutable FrameLoader m_loader;
mutable NavigationScheduler m_navigationScheduler;
mutable RefPtr<DOMWindow> m_domWindow;
HTMLFrameOwnerElement* m_ownerElement;
RefPtr<FrameView> m_view;
RefPtr<Document> m_doc;
ScriptController m_script;
mutable Editor m_editor;
mutable FrameSelection m_selection;
mutable EventHandler m_eventHandler;
mutable AnimationController m_animationController;
Timer<Frame> m_overflowAutoScrollTimer;
float m_overflowAutoScrollDelta;
IntPoint m_overflowAutoScrollPos;
ViewportArguments m_viewportArguments;
bool m_selectionChangeCallbacksDisabled;
VisibleSelection m_rangedSelectionBase;
VisibleSelection m_rangedSelectionInitialExtent;
float m_textAutosizingWidth;
unsigned m_parseCount;
unsigned m_layoutCount;
unsigned m_forcedLayoutCount;
CFTimeInterval m_parseDuration;
CFTimeInterval m_layoutDuration;
float m_pageZoomFactor;
float m_textZoomFactor;
#if ENABLE(ORIENTATION_EVENTS)
int m_orientation;
#endif
bool m_inViewSourceMode;
bool m_isDisconnected;
bool m_excludeFromTextSearch;
#if USE(TILED_BACKING_STORE)
public:
TiledBackingStore* tiledBackingStore() const { return m_tiledBackingStore.get(); }
void setTiledBackingStoreEnabled(bool);
private:
virtual void tiledBackingStorePaintBegin();
virtual void tiledBackingStorePaint(GraphicsContext*, const IntRect&);
virtual void tiledBackingStorePaintEnd(const Vector<IntRect>& paintedArea);
virtual IntRect tiledBackingStoreContentsRect();
virtual IntRect tiledBackingStoreVisibleRect();
virtual Color tiledBackingStoreBackgroundColor() const;
OwnPtr<TiledBackingStore> m_tiledBackingStore;
#endif
int m_activeDOMObjectsAndAnimationsSuspendedCount;
bool m_singleLineSelectionBehavior;
int m_timersPausedCount;
};
inline void Frame::init()
{
XLinkNames::init();
m_loader.init();
}
inline FrameLoader* Frame::loader() const
{
return &m_loader;
}
inline NavigationScheduler* Frame::navigationScheduler() const
{
return &m_navigationScheduler;
}
inline FrameView* Frame::view() const
{
return m_view.get();
}
inline ScriptController* Frame::script()
{
return &m_script;
}
inline Document* Frame::document() const
{
return m_doc.get();
}
inline FrameSelection* Frame::selection() const
{
return &m_selection;
}
inline Editor* Frame::editor() const
{
return &m_editor;
}
inline AnimationController* Frame::animation() const
{
return &m_animationController;
}
inline HTMLFrameOwnerElement* Frame::ownerElement() const
{
return m_ownerElement;
}
inline bool Frame::isDisconnected() const
{
return m_isDisconnected;
}
inline void Frame::setIsDisconnected(bool isDisconnected)
{
m_isDisconnected = isDisconnected;
}
inline bool Frame::excludeFromTextSearch() const
{
return m_excludeFromTextSearch;
}
inline void Frame::setExcludeFromTextSearch(bool exclude)
{
m_excludeFromTextSearch = exclude;
}
inline bool Frame::inViewSourceMode() const
{
return m_inViewSourceMode;
}
inline void Frame::setInViewSourceMode(bool mode)
{
m_inViewSourceMode = mode;
}
inline FrameTree* Frame::tree() const
{
return &m_treeNode;
}
inline Page* Frame::page() const
{
return m_page;
}
inline void Frame::detachFromPage()
{
m_page = 0;
}
inline EventHandler* Frame::eventHandler() const
{
return &m_eventHandler;
}
}
#endif // Frame_h