/* -*- 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 Communicator client code, released * March 31, 1998. * * 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 namespace class for static content utilities. */ #ifndef nsContentUtils_h___ #define nsContentUtils_h___ #include #if defined(XP_WIN) || defined(XP_OS2) #include #endif #if defined(SOLARIS) #include #endif //A trick to handle IEEE floating point exceptions on FreeBSD - E.D. #ifdef __FreeBSD__ #include #ifdef __alpha__ static fp_except_t allmask = FP_X_INV|FP_X_OFL|FP_X_UFL|FP_X_DZ|FP_X_IMP; #else static fp_except_t allmask = FP_X_INV|FP_X_OFL|FP_X_UFL|FP_X_DZ|FP_X_IMP|FP_X_DNML; #endif static fp_except_t oldmask = fpsetmask(~allmask); #endif #include "nsAString.h" #include "nsIStatefulFrame.h" #include "nsINodeInfo.h" #include "nsNodeInfoManager.h" #include "nsContentList.h" #include "nsDOMClassInfoID.h" #include "nsIXPCScriptable.h" #include "nsDataHashtable.h" #include "nsIScriptRuntime.h" #include "nsIScriptGlobalObject.h" #include "nsIDOMEvent.h" #include "nsTArray.h" #include "nsTextFragment.h" #include "nsReadableUtils.h" #include "nsINode.h" #include "nsHashtable.h" #include "nsIDOMNode.h" #include "nsHtml5Parser.h" #include "nsIFragmentContentSink.h" #include "nsMathUtils.h" #include "nsCharSeparatedTokenizer.h" #include "mozilla/AutoRestore.h" #include "mozilla/GuardObjects.h" #include "mozilla/TimeStamp.h" struct nsNativeKeyEvent; // Don't include nsINativeKeyBindings.h here: it will force strange compilation error! class nsIDOMScriptObjectFactory; class nsIXPConnect; class nsIContent; class nsIDOMKeyEvent; class nsIDocument; class nsIDocumentObserver; class nsIDocShell; class nsINameSpaceManager; class nsIScriptSecurityManager; class nsIJSContextStack; class nsIThreadJSContextStack; class nsIParserService; class nsIIOService; class nsIURI; class imgIContainer; class imgIDecoderObserver; class imgIRequest; class imgILoader; class imgICache; class nsIImageLoadingContent; class nsIDOMHTMLFormElement; class nsIDOMDocument; class nsIConsoleService; class nsIStringBundleService; class nsIStringBundle; class nsIContentPolicy; class nsILineBreaker; class nsIWordBreaker; class nsIJSRuntimeService; class nsEventListenerManager; class nsIScriptContext; class nsIRunnable; class nsIInterfaceRequestor; template class nsCOMArray; template class nsRefPtrHashtable; struct JSRuntime; class nsIUGenCategory; class nsIWidget; class nsIDragSession; class nsIPresShell; class nsIXPConnectJSObjectHolder; #ifdef MOZ_XTF class nsIXTFService; #endif #ifdef IBMBIDI class nsIBidiKeyboard; #endif class nsIMIMEHeaderParam; class nsIObserver; class nsPresContext; class nsIChannel; class nsAutoScriptBlockerSuppressNodeRemoved; struct nsIntMargin; class nsPIDOMWindow; class nsIDocumentLoaderFactory; class nsIDOMHTMLInputElement; namespace mozilla { namespace layers { class LayerManager; } // namespace layers namespace dom { class Element; } // namespace dom } // namespace mozilla extern const char kLoadAsData[]; enum EventNameType { EventNameType_None = 0x0000, EventNameType_HTML = 0x0001, EventNameType_XUL = 0x0002, EventNameType_SVGGraphic = 0x0004, // svg graphic elements EventNameType_SVGSVG = 0x0008, // the svg element EventNameType_SMIL = 0x0016, // smil elements EventNameType_HTMLXUL = 0x0003, EventNameType_All = 0xFFFF }; struct EventNameMapping { nsIAtom* mAtom; PRUint32 mId; PRInt32 mType; PRUint32 mStructType; }; struct nsShortcutCandidate { nsShortcutCandidate(PRUint32 aCharCode, bool aIgnoreShift) : mCharCode(aCharCode), mIgnoreShift(aIgnoreShift) { } PRUint32 mCharCode; bool mIgnoreShift; }; class nsContentUtils { friend class nsAutoScriptBlockerSuppressNodeRemoved; typedef mozilla::dom::Element Element; typedef mozilla::TimeDuration TimeDuration; public: static nsresult Init(); /** * Get a JSContext from the document's scope object. */ static JSContext* GetContextFromDocument(nsIDocument *aDocument); /** * Get a scope from aNewDocument. Also get a context through the scope of one * of the documents, from the stack or the safe context. * * @param aOldDocument The document to try to get a context from. May be null. * @param aNewDocument The document to get aNewScope from. * @param aCx [out] Context gotten through one of the scopes, from the stack * or the safe context. * @param aNewScope [out] Scope gotten from aNewDocument. */ static nsresult GetContextAndScope(nsIDocument *aOldDocument, nsIDocument *aNewDocument, JSContext **aCx, JSObject **aNewScope); /** * When a document's scope changes (e.g., from document.open(), call this * function to move all content wrappers from the old scope to the new one. */ static nsresult ReparentContentWrappersInScope(JSContext *cx, nsIScriptGlobalObject *aOldScope, nsIScriptGlobalObject *aNewScope); static bool IsCallerChrome(); static bool IsCallerTrustedForRead(); static bool IsCallerTrustedForWrite(); /** * Check whether a caller has UniversalXPConnect. */ static bool CallerHasUniversalXPConnect(); static bool IsImageSrcSetDisabled(); /** * Returns the parent node of aChild crossing document boundaries. */ static nsINode* GetCrossDocParentNode(nsINode* aChild); /** * Do not ever pass null pointers to this method. If one of your * nsIContents is null, you have to decide for yourself what * "IsDescendantOf" really means. * * @param aPossibleDescendant node to test for being a descendant of * aPossibleAncestor * @param aPossibleAncestor node to test for being an ancestor of * aPossibleDescendant * @return true if aPossibleDescendant is a descendant of * aPossibleAncestor (or is aPossibleAncestor). false * otherwise. */ static bool ContentIsDescendantOf(const nsINode* aPossibleDescendant, const nsINode* aPossibleAncestor); /** * Similar to ContentIsDescendantOf except it crosses document boundaries. */ static bool ContentIsCrossDocDescendantOf(nsINode* aPossibleDescendant, nsINode* aPossibleAncestor); /* * This method fills the |aArray| with all ancestor nodes of |aNode| * including |aNode| at the zero index. */ static nsresult GetAncestors(nsINode* aNode, nsTArray& aArray); /* * This method fills |aAncestorNodes| with all ancestor nodes of |aNode| * including |aNode| (QI'd to nsIContent) at the zero index. * For each ancestor, there is a corresponding element in |aAncestorOffsets| * which is the IndexOf the child in relation to its parent. * * This method just sucks. */ static nsresult GetAncestorsAndOffsets(nsIDOMNode* aNode, PRInt32 aOffset, nsTArray* aAncestorNodes, nsTArray* aAncestorOffsets); /* * The out parameter, |aCommonAncestor| will be the closest node, if any, * to both |aNode| and |aOther| which is also an ancestor of each. * Returns an error if the two nodes are disconnected and don't have * a common ancestor. */ static nsresult GetCommonAncestor(nsIDOMNode *aNode, nsIDOMNode *aOther, nsIDOMNode** aCommonAncestor); /** * Returns the common ancestor, if any, for two nodes. Returns null if the * nodes are disconnected. */ static nsINode* GetCommonAncestor(nsINode* aNode1, nsINode* aNode2); /** * Returns true if aNode1 is before aNode2 in the same connected * tree. */ static bool PositionIsBefore(nsINode* aNode1, nsINode* aNode2) { return (aNode2->CompareDocPosition(aNode1) & (nsIDOMNode::DOCUMENT_POSITION_PRECEDING | nsIDOMNode::DOCUMENT_POSITION_DISCONNECTED)) == nsIDOMNode::DOCUMENT_POSITION_PRECEDING; } /** * Utility routine to compare two "points", where a point is a * node/offset pair * Returns -1 if point1 < point2, 1, if point1 > point2, * 0 if error or if point1 == point2. * NOTE! If the two nodes aren't in the same connected subtree, * the result is 1, and the optional aDisconnected parameter * is set to true. */ static PRInt32 ComparePoints(nsINode* aParent1, PRInt32 aOffset1, nsINode* aParent2, PRInt32 aOffset2, bool* aDisconnected = nsnull); /** * Brute-force search of the element subtree rooted at aContent for * an element with the given id. aId must be nonempty, otherwise * this method may return nodes even if they have no id! */ static Element* MatchElementId(nsIContent *aContent, const nsAString& aId); /** * Similar to above, but to be used if one already has an atom for the ID */ static Element* MatchElementId(nsIContent *aContent, const nsIAtom* aId); /** * Reverses the document position flags passed in. * * @param aDocumentPosition The document position flags to be reversed. * * @return The reversed document position flags. * * @see nsIDOMNode */ static PRUint16 ReverseDocumentPosition(PRUint16 aDocumentPosition); static PRUint32 CopyNewlineNormalizedUnicodeTo(const nsAString& aSource, PRUint32 aSrcOffset, PRUnichar* aDest, PRUint32 aLength, bool& aLastCharCR); static PRUint32 CopyNewlineNormalizedUnicodeTo(nsReadingIterator& aSrcStart, const nsReadingIterator& aSrcEnd, nsAString& aDest); static nsISupports * GetClassInfoInstance(nsDOMClassInfoID aID); static const nsDependentSubstring TrimCharsInSet(const char* aSet, const nsAString& aValue); template static const nsDependentSubstring TrimWhitespace(const nsAString& aStr, bool aTrimTrailing = true); /** * Returns true if aChar is of class Ps, Pi, Po, Pf, or Pe. */ static bool IsPunctuationMark(PRUint32 aChar); static bool IsPunctuationMarkAt(const nsTextFragment* aFrag, PRUint32 aOffset); /** * Returns true if aChar is of class Lu, Ll, Lt, Lm, Lo, Nd, Nl or No */ static bool IsAlphanumeric(PRUint32 aChar); static bool IsAlphanumericAt(const nsTextFragment* aFrag, PRUint32 aOffset); /* * Is the character an HTML whitespace character? * * We define whitespace using the list in HTML5 and css3-selectors: * U+0009, U+000A, U+000C, U+000D, U+0020 * * HTML 4.01 also lists U+200B (zero-width space). */ static bool IsHTMLWhitespace(PRUnichar aChar); /** * Parse a margin string of format 'top, right, bottom, left' into * an nsIntMargin. * * @param aString the string to parse * @param aResult the resulting integer * @return whether the value could be parsed */ static bool ParseIntMarginValue(const nsAString& aString, nsIntMargin& aResult); static void Shutdown(); /** * Checks whether two nodes come from the same origin. */ static nsresult CheckSameOrigin(nsINode* aTrustedNode, nsIDOMNode* aUnTrustedNode); // Check if the (JS) caller can access aNode. static bool CanCallerAccess(nsIDOMNode *aNode); // Check if the (JS) caller can access aWindow. // aWindow can be either outer or inner window. static bool CanCallerAccess(nsPIDOMWindow* aWindow); /** * Get the window through the JS context that's currently on the stack. * If there's no JS context currently on the stack, returns null. */ static nsPIDOMWindow *GetWindowFromCaller(); /** * The two GetDocumentFrom* functions below allow a caller to get at a * document that is relevant to the currently executing script. * * GetDocumentFromCaller gets its document by looking at the last called * function and finding the document that the function itself relates to. * For example, consider two windows A and B in the same origin. B has a * function which does something that ends up needing the current document. * If a script in window A were to call B's function, GetDocumentFromCaller * would find that function (in B) and return B's document. * * GetDocumentFromContext gets its document by looking at the currently * executing context's global object and returning its document. Thus, * given the example above, GetDocumentFromCaller would see that the * currently executing script was in window A, and return A's document. */ /** * Get the document from the currently executing function. This will return * the document that the currently executing function is in/from. * * @return The document or null if no JS Context. */ static nsIDOMDocument *GetDocumentFromCaller(); /** * Get the document through the JS context that's currently on the stack. * If there's no JS context currently on the stack it will return null. * This will return the document of the calling script. * * @return The document or null if no JS context */ static nsIDOMDocument *GetDocumentFromContext(); // Check if a node is in the document prolog, i.e. before the document // element. static bool InProlog(nsINode *aNode); static nsIParserService* GetParserService(); static nsINameSpaceManager* NameSpaceManager() { return sNameSpaceManager; } static nsIIOService* GetIOService() { return sIOService; } static imgILoader* GetImgLoader() { if (!sImgLoaderInitialized) InitImgLoader(); return sImgLoader; } #ifdef MOZ_XTF static nsIXTFService* GetXTFService(); #endif #ifdef IBMBIDI static nsIBidiKeyboard* GetBidiKeyboard(); #endif /** * Get the cache security manager service. Can return null if the layout * module has been shut down. */ static nsIScriptSecurityManager* GetSecurityManager() { return sSecurityManager; } static nsresult GenerateStateKey(nsIContent* aContent, const nsIDocument* aDocument, nsIStatefulFrame::SpecialStateID aID, nsACString& aKey); /** * Create a new nsIURI from aSpec, using aBaseURI as the base. The * origin charset of the new nsIURI will be the document charset of * aDocument. */ static nsresult NewURIWithDocumentCharset(nsIURI** aResult, const nsAString& aSpec, nsIDocument* aDocument, nsIURI* aBaseURI); /** * Convert aInput (in charset aCharset) to UTF16 in aOutput. * * @param aCharset the name of the charset; if empty, we assume UTF8 */ static nsresult ConvertStringFromCharset(const nsACString& aCharset, const nsACString& aInput, nsAString& aOutput); /** * Determine whether a buffer begins with a BOM for UTF-8, UTF-16LE, * UTF-16BE * * @param aBuffer the buffer to check * @param aLength the length of the buffer * @param aCharset empty if not found * @return boolean indicating whether a BOM was detected. */ static bool CheckForBOM(const unsigned char* aBuffer, PRUint32 aLength, nsACString& aCharset, bool *bigEndian = nsnull); /** * Determine whether aContent is in some way associated with aForm. If the * form is a container the only elements that are considered to be associated * with a form are the elements that are contained within the form. If the * form is a leaf element then all elements will be accepted into this list, * since this can happen due to content fixup when a form spans table rows or * table cells. */ static bool BelongsInForm(nsIContent *aForm, nsIContent *aContent); static nsresult CheckQName(const nsAString& aQualifiedName, bool aNamespaceAware = true); static nsresult SplitQName(const nsIContent* aNamespaceResolver, const nsAFlatString& aQName, PRInt32 *aNamespace, nsIAtom **aLocalName); static nsresult GetNodeInfoFromQName(const nsAString& aNamespaceURI, const nsAString& aQualifiedName, nsNodeInfoManager* aNodeInfoManager, PRUint16 aNodeType, nsINodeInfo** aNodeInfo); static void SplitExpatName(const PRUnichar *aExpatName, nsIAtom **aPrefix, nsIAtom **aTagName, PRInt32 *aNameSpaceID); // Get a permission-manager setting for the given uri and type. // If the pref doesn't exist or if it isn't ALLOW_ACTION, false is // returned, otherwise true is returned. static bool IsSitePermAllow(nsIURI* aURI, const char* aType); static nsILineBreaker* LineBreaker() { return sLineBreaker; } static nsIWordBreaker* WordBreaker() { return sWordBreaker; } static nsIUGenCategory* GetGenCat() { return sGenCat; } /** * Regster aObserver as a shutdown observer. A strong reference is held * to aObserver until UnregisterShutdownObserver is called. */ static void RegisterShutdownObserver(nsIObserver* aObserver); static void UnregisterShutdownObserver(nsIObserver* aObserver); /** * @return true if aContent has an attribute aName in namespace aNameSpaceID, * and the attribute value is non-empty. */ static bool HasNonEmptyAttr(const nsIContent* aContent, PRInt32 aNameSpaceID, nsIAtom* aName); /** * Method that gets the primary presContext for the node. * * @param aContent The content node. * @return the presContext, or nsnull if the content is not in a document * (if GetCurrentDoc returns nsnull) */ static nsPresContext* GetContextForContent(const nsIContent* aContent); /** * Method to do security and content policy checks on the image URI * * @param aURI uri of the image to be loaded * @param aContext the context the image is loaded in (eg an element) * @param aLoadingDocument the document we belong to * @param aLoadingPrincipal the principal doing the load * @param aImageBlockingStatus the nsIContentPolicy blocking status for this * image. This will be set even if a security check fails for the * image, to some reasonable REJECT_* value. This out param will only * be set if it's non-null. * @return true if the load can proceed, or false if it is blocked. * Note that aImageBlockingStatus, if set will always be an ACCEPT * status if true is returned and always be a REJECT_* status if * false is returned. */ static bool CanLoadImage(nsIURI* aURI, nsISupports* aContext, nsIDocument* aLoadingDocument, nsIPrincipal* aLoadingPrincipal, PRInt16* aImageBlockingStatus = nsnull); /** * Method to start an image load. This does not do any security checks. * This method will attempt to make aURI immutable; a caller that wants to * keep a mutable version around should pass in a clone. * * @param aURI uri of the image to be loaded * @param aLoadingDocument the document we belong to * @param aLoadingPrincipal the principal doing the load * @param aReferrer the referrer URI * @param aObserver the observer for the image load * @param aLoadFlags the load flags to use. See nsIRequest * @return the imgIRequest for the image load */ static nsresult LoadImage(nsIURI* aURI, nsIDocument* aLoadingDocument, nsIPrincipal* aLoadingPrincipal, nsIURI* aReferrer, imgIDecoderObserver* aObserver, PRInt32 aLoadFlags, imgIRequest** aRequest); /** * Returns whether the given URI is in the image cache. */ static bool IsImageInCache(nsIURI* aURI); /** * Method to get an imgIContainer from an image loading content * * @param aContent The image loading content. Must not be null. * @param aRequest The image request [out] * @return the imgIContainer corresponding to the first frame of the image */ static already_AddRefed GetImageFromContent(nsIImageLoadingContent* aContent, imgIRequest **aRequest = nsnull); /** * Helper method to call imgIRequest::GetStaticRequest. */ static already_AddRefed GetStaticRequest(imgIRequest* aRequest); /** * Method that decides whether a content node is draggable * * @param aContent The content node to test. * @return whether it's draggable */ static bool ContentIsDraggable(nsIContent* aContent); /** * Method that decides whether a content node is a draggable image * * @param aContent The content node to test. * @return whether it's a draggable image */ static bool IsDraggableImage(nsIContent* aContent); /** * Method that decides whether a content node is a draggable link * * @param aContent The content node to test. * @return whether it's a draggable link */ static bool IsDraggableLink(const nsIContent* aContent); /** * Convenience method to create a new nodeinfo that differs only by name * from aNodeInfo. */ static nsresult NameChanged(nsINodeInfo *aNodeInfo, nsIAtom *aName, nsINodeInfo** aResult) { nsNodeInfoManager *niMgr = aNodeInfo->NodeInfoManager(); *aResult = niMgr->GetNodeInfo(aName, aNodeInfo->GetPrefixAtom(), aNodeInfo->NamespaceID(), aNodeInfo->NodeType(), aNodeInfo->GetExtraName()).get(); return *aResult ? NS_OK : NS_ERROR_OUT_OF_MEMORY; } /** * Returns the appropriate event argument names for the specified * namespace and event name. Added because we need to switch between * SVG's "evt" and the rest of the world's "event", and because onerror * takes 3 args. */ static void GetEventArgNames(PRInt32 aNameSpaceID, nsIAtom *aEventName, PRUint32 *aArgCount, const char*** aArgNames); /** * If aNode is not an element, return true exactly when aContent's binding * parent is null. * * If aNode is an element, return true exactly when aContent's binding parent * is the same as aNode's. * * This method is particularly useful for callers who are trying to ensure * that they are working with a non-anonymous descendant of a given node. If * aContent is a descendant of aNode, a return value of false from this * method means that it's an anonymous descendant from aNode's point of view. * * Both arguments to this method must be non-null. */ static bool IsInSameAnonymousTree(const nsINode* aNode, const nsIContent* aContent); /** * Return the nsIXPConnect service. */ static nsIXPConnect *XPConnect() { return sXPConnect; } /** * Report a localized error message to the error console. * @param aErrorFlags See nsIScriptError. * @param aCategory Name of module reporting error. * @param aDocument Reference to the document which triggered the message. * @param aFile Properties file containing localized message. * @param aMessageName Name of localized message. * @param [aParams=nsnull] (Optional) Parameters to be substituted into localized message. * @param [aParamsLength=0] (Optional) Length of aParams. * @param [aURI=nsnull] (Optional) URI of resource containing error. * @param [aSourceLine=EmptyString()] (Optional) The text of the line that contains the error (may be empty). * @param [aLineNumber=0] (Optional) Line number within resource containing error. * @param [aColumnNumber=0] (Optional) Column number within resource containing error. If aURI is null, then aDocument->GetDocumentURI() is used. */ enum PropertiesFile { eCSS_PROPERTIES, eXBL_PROPERTIES, eXUL_PROPERTIES, eLAYOUT_PROPERTIES, eFORMS_PROPERTIES, ePRINTING_PROPERTIES, eDOM_PROPERTIES, eHTMLPARSER_PROPERTIES, eSVG_PROPERTIES, eBRAND_PROPERTIES, eCOMMON_DIALOG_PROPERTIES, PropertiesFile_COUNT }; static nsresult ReportToConsole(PRUint32 aErrorFlags, const char *aCategory, nsIDocument* aDocument, PropertiesFile aFile, const char *aMessageName, const PRUnichar **aParams = nsnull, PRUint32 aParamsLength = 0, nsIURI* aURI = nsnull, const nsAFlatString& aSourceLine = EmptyString(), PRUint32 aLineNumber = 0, PRUint32 aColumnNumber = 0); /** * Get the localized string named |aKey| in properties file |aFile|. */ static nsresult GetLocalizedString(PropertiesFile aFile, const char* aKey, nsXPIDLString& aResult); /** * Fill (with the parameters given) the localized string named |aKey| in * properties file |aFile|. */ static nsresult FormatLocalizedString(PropertiesFile aFile, const char* aKey, const PRUnichar **aParams, PRUint32 aParamsLength, nsXPIDLString& aResult); /** * Returns true if aDocument is a chrome document */ static bool IsChromeDoc(nsIDocument *aDocument); /** * Returns true if aDocument is in a docshell whose parent is the same type */ static bool IsChildOfSameType(nsIDocument* aDoc); /** * Get the script file name to use when compiling the script * referenced by aURI. In cases where there's no need for any extra * security wrapper automation the script file name that's returned * will be the spec in aURI, else it will be the spec in aDocument's * URI followed by aURI's spec, separated by " -> ". Returns true * if the script file name was modified, false if it's aURI's * spec. */ static bool GetWrapperSafeScriptFilename(nsIDocument *aDocument, nsIURI *aURI, nsACString& aScriptURI); /** * Returns true if aDocument belongs to a chrome docshell for * display purposes. Returns false for null documents or documents * which do not belong to a docshell. */ static bool IsInChromeDocshell(nsIDocument *aDocument); /** * Return the content policy service */ static nsIContentPolicy *GetContentPolicy(); /** * Quick helper to determine whether there are any mutation listeners * of a given type that apply to this content or any of its ancestors. * The method has the side effect to call document's MayDispatchMutationEvent * using aTargetForSubtreeModified as the parameter. * * @param aNode The node to search for listeners * @param aType The type of listener (NS_EVENT_BITS_MUTATION_*) * @param aTargetForSubtreeModified The node which is the target of the * possible DOMSubtreeModified event. * * @return true if there are mutation listeners of the specified type */ static bool HasMutationListeners(nsINode* aNode, PRUint32 aType, nsINode* aTargetForSubtreeModified); /** * Quick helper to determine whether there are any mutation listeners * of a given type that apply to any content in this document. It is valid * to pass null for aDocument here, in which case this function always * returns true. * * @param aDocument The document to search for listeners * @param aType The type of listener (NS_EVENT_BITS_MUTATION_*) * * @return true if there are mutation listeners of the specified type */ static bool HasMutationListeners(nsIDocument* aDocument, PRUint32 aType); /** * Synchronously fire DOMNodeRemoved on aChild. Only fires the event if * there really are listeners by checking using the HasMutationListeners * function above. The function makes sure to hold the relevant objects alive * for the duration of the event firing. However there are no guarantees * that any of the objects are alive by the time the function returns. * If you depend on that you need to hold references yourself. * * @param aChild The node to fire DOMNodeRemoved at. * @param aParent The parent of aChild. * @param aOwnerDoc The ownerDocument of aChild. */ static void MaybeFireNodeRemoved(nsINode* aChild, nsINode* aParent, nsIDocument* aOwnerDoc); /** * This method creates and dispatches a trusted event. * Works only with events which can be created by calling * nsIDOMDocument::CreateEvent() with parameter "Events". * @param aDoc The document which will be used to create the event. * @param aTarget The target of the event, should be QIable to * nsIDOMEventTarget. * @param aEventName The name of the event. * @param aCanBubble Whether the event can bubble. * @param aCancelable Is the event cancelable. * @param aDefaultAction Set to true if default action should be taken, * see nsIDOMEventTarget::DispatchEvent. */ static nsresult DispatchTrustedEvent(nsIDocument* aDoc, nsISupports* aTarget, const nsAString& aEventName, bool aCanBubble, bool aCancelable, bool *aDefaultAction = nsnull); /** * This method creates and dispatches a trusted event to the chrome * event handler. * Works only with events which can be created by calling * nsIDOMDocument::CreateEvent() with parameter "Events". * @param aDocument The document which will be used to create the event, * and whose window's chrome handler will be used to * dispatch the event. * @param aTarget The target of the event, used for event->SetTarget() * @param aEventName The name of the event. * @param aCanBubble Whether the event can bubble. * @param aCancelable Is the event cancelable. * @param aDefaultAction Set to true if default action should be taken, * see nsIDOMEventTarget::DispatchEvent. */ static nsresult DispatchChromeEvent(nsIDocument* aDoc, nsISupports* aTarget, const nsAString& aEventName, bool aCanBubble, bool aCancelable, bool *aDefaultAction = nsnull); /** * Determines if an event attribute name (such as onclick) is valid for * a given element type. Types are from the EventNameType enumeration * defined above. * * @param aName the event name to look up * @param aType the type of content */ static bool IsEventAttributeName(nsIAtom* aName, PRInt32 aType); /** * Return the event id for the event with the given name. The name is the * event name with the 'on' prefix. Returns NS_USER_DEFINED_EVENT if the * event doesn't match a known event name. * * @param aName the event name to look up */ static PRUint32 GetEventId(nsIAtom* aName); /** * Return the category for the event with the given name. The name is the * event name *without* the 'on' prefix. Returns NS_EVENT if the event * is not known to be in any particular category. * * @param aName the event name to look up */ static PRUint32 GetEventCategory(const nsAString& aName); /** * Return the event id and atom for the event with the given name. * The name is the event name *without* the 'on' prefix. * Returns NS_USER_DEFINED_EVENT on the aEventID if the * event doesn't match a known event name in the category. * * @param aName the event name to look up * @param aEventStruct only return event id in aEventStruct category */ static nsIAtom* GetEventIdAndAtom(const nsAString& aName, PRUint32 aEventStruct, PRUint32* aEventID); /** * Used only during traversal of the XPCOM graph by the cycle * collector: push a pointer to the listener manager onto the * children deque, if it exists. Do nothing if there is no listener * manager. * * Crucially: does not perform any refcounting operations. * * @param aNode The node to traverse. * @param children The buffer to push a listener manager pointer into. */ static void TraverseListenerManager(nsINode *aNode, nsCycleCollectionTraversalCallback &cb); /** * Get the eventlistener manager for aNode. If a new eventlistener manager * was created, aCreated is set to true. * * @param aNode The node for which to get the eventlistener manager. * @param aCreateIfNotFound If false, returns a listener manager only if * one already exists. */ static nsEventListenerManager* GetListenerManager(nsINode* aNode, bool aCreateIfNotFound); /** * Remove the eventlistener manager for aNode. * * @param aNode The node for which to remove the eventlistener manager. */ static void RemoveListenerManager(nsINode *aNode); static bool IsInitialized() { return sInitialized; } /** * Checks if the localname/prefix/namespace triple is valid wrt prefix * and namespace according to the Namespaces in XML and DOM Code * specfications. * * @param aLocalname localname of the node * @param aPrefix prefix of the node * @param aNamespaceID namespace of the node */ static bool IsValidNodeName(nsIAtom *aLocalName, nsIAtom *aPrefix, PRInt32 aNamespaceID); /** * Creates a DocumentFragment from text using a context node to resolve * namespaces. * * Note! In the HTML case with the HTML5 parser enabled, this is only called * from Range.createContextualFragment() and the implementation here is * quirky accordingly (html context node behaves like a body context node). * If you don't want that quirky behavior, don't use this method as-is! * * @param aContextNode the node which is used to resolve namespaces * @param aFragment the string which is parsed to a DocumentFragment * @param aReturn the resulting fragment * @param aPreventScriptExecution whether to mark scripts as already started */ static nsresult CreateContextualFragment(nsINode* aContextNode, const nsAString& aFragment, bool aPreventScriptExecution, nsIDOMDocumentFragment** aReturn); /** * Invoke the fragment parsing algorithm (innerHTML) using the HTML parser. * * @param aSourceBuffer the string being set as innerHTML * @param aTargetNode the target container * @param aContextLocalName local name of context node * @param aContextNamespace namespace of context node * @param aQuirks true to make not close

* @param aPreventScriptExecution true to prevent scripts from executing; * don't set to false when parsing into a target node that has been * bound to tree. * @return NS_ERROR_DOM_INVALID_STATE_ERR if a re-entrant attempt to parse * fragments is made and NS_OK otherwise. */ static nsresult ParseFragmentHTML(const nsAString& aSourceBuffer, nsIContent* aTargetNode, nsIAtom* aContextLocalName, PRInt32 aContextNamespace, bool aQuirks, bool aPreventScriptExecution); /** * Invoke the fragment parsing algorithm (innerHTML) using the XML parser. * * @param aSourceBuffer the string being set as innerHTML * @param aTargetNode the target container * @param aTagStack the namespace mapping context * @param aPreventExecution whether to mark scripts as already started * @param aReturn the result fragment * @return NS_ERROR_DOM_INVALID_STATE_ERR if a re-entrant attempt to parse * fragments is made, a return code from the XML parser. */ static nsresult ParseFragmentXML(const nsAString& aSourceBuffer, nsIDocument* aDocument, nsTArray& aTagStack, bool aPreventScriptExecution, nsIDOMDocumentFragment** aReturn); /** * Creates a new XML document, which is marked to be loaded as data. * * @param aNamespaceURI Namespace for the root element to create and insert in * the document. Only used if aQualifiedName is not * empty. * @param aQualifiedName Qualified name for the root element to create and * insert in the document. If empty no root element will * be created. * @param aDoctype Doctype node to insert in the document. * @param aDocumentURI URI of the document. Must not be null. * @param aBaseURI Base URI of the document. Must not be null. * @param aPrincipal Prinicpal of the document. Must not be null. * @param aScriptObject The object from which the context for event handling * can be got. * @param aFlavor Select the kind of document to create. * @param aResult [out] The document that was created. */ static nsresult CreateDocument(const nsAString& aNamespaceURI, const nsAString& aQualifiedName, nsIDOMDocumentType* aDoctype, nsIURI* aDocumentURI, nsIURI* aBaseURI, nsIPrincipal* aPrincipal, nsIScriptGlobalObject* aScriptObject, DocumentFlavor aFlavor, nsIDOMDocument** aResult); /** * Sets the text contents of a node by replacing all existing children * with a single text child. * * The function always notifies. * * Will reuse the first text child if one is available. Will not reuse * existing cdata children. * * @param aContent Node to set contents of. * @param aValue Value to set contents to. * @param aTryReuse When true, the function will try to reuse an existing * textnodes rather than always creating a new one. */ static nsresult SetNodeTextContent(nsIContent* aContent, const nsAString& aValue, bool aTryReuse); /** * Get the textual contents of a node. This is a concatenation of all * textnodes that are direct or (depending on aDeep) indirect children * of the node. * * NOTE! No serialization takes place and
elements * are not converted into newlines. Only textnodes and cdata nodes are * added to the result. * * @param aNode Node to get textual contents of. * @param aDeep If true child elements of aNode are recursivly descended * into to find text children. * @param aResult the result. Out param. */ static void GetNodeTextContent(nsINode* aNode, bool aDeep, nsAString& aResult) { aResult.Truncate(); AppendNodeTextContent(aNode, aDeep, aResult); } /** * Same as GetNodeTextContents but appends the result rather than sets it. */ static void AppendNodeTextContent(nsINode* aNode, bool aDeep, nsAString& aResult); /** * Utility method that checks if a given node has any non-empty * children. * NOTE! This method does not descend recursivly into elements. * Though it would be easy to make it so if needed */ static bool HasNonEmptyTextContent(nsINode* aNode); /** * Delete strings allocated for nsContentList matches */ static void DestroyMatchString(void* aData) { if (aData) { nsString* matchString = static_cast(aData); delete matchString; } } static void DropScriptObject(PRUint32 aLangID, void *aObject, const char *name, void *aClosure) { DropScriptObject(aLangID, aObject, aClosure); } /** * Unbinds the content from the tree and nulls it out if it's not null. */ static void DestroyAnonymousContent(nsCOMPtr* aContent); /** * Keep script object aNewObject, held by aScriptObjectHolder, alive. * * NOTE: This currently only supports objects that hold script objects of one * scripting language. * * @param aLangID script language ID of aNewObject * @param aScriptObjectHolder the object that holds aNewObject * @param aTracer the tracer for aScriptObject * @param aNewObject the script object to hold * @param aWasHoldingObjects whether aScriptObjectHolder was already holding * script objects (ie. HoldScriptObject was called * on it before, without a corresponding call to * DropScriptObjects) */ static nsresult HoldScriptObject(PRUint32 aLangID, void* aScriptObjectHolder, nsScriptObjectTracer* aTracer, void* aNewObject, bool aWasHoldingObjects) { if (aLangID == nsIProgrammingLanguage::JAVASCRIPT) { return aWasHoldingObjects ? NS_OK : HoldJSObjects(aScriptObjectHolder, aTracer); } return HoldScriptObject(aLangID, aNewObject); } /** * Drop any script objects that aScriptObjectHolder is holding. * * NOTE: This currently only supports objects that hold script objects of one * scripting language. * * @param aLangID script language ID of the objects that * @param aScriptObjectHolder the object that holds script object that we want * to drop * @param aTracer the tracer for aScriptObject */ static nsresult DropScriptObjects(PRUint32 aLangID, void* aScriptObjectHolder, nsScriptObjectTracer* aTracer) { if (aLangID == nsIProgrammingLanguage::JAVASCRIPT) { return DropJSObjects(aScriptObjectHolder); } aTracer->Trace(aScriptObjectHolder, DropScriptObject, nsnull); return NS_OK; } /** * Keep the JS objects held by aScriptObjectHolder alive. * * @param aScriptObjectHolder the object that holds JS objects that we want to * keep alive * @param aTracer the tracer for aScriptObject */ static nsresult HoldJSObjects(void* aScriptObjectHolder, nsScriptObjectTracer* aTracer); /** * Drop the JS objects held by aScriptObjectHolder. * * @param aScriptObjectHolder the object that holds JS objects that we want to * drop */ static nsresult DropJSObjects(void* aScriptObjectHolder); #ifdef DEBUG static void CheckCCWrapperTraversal(nsISupports* aScriptObjectHolder, nsWrapperCache* aCache); #endif static void PreserveWrapper(nsISupports* aScriptObjectHolder, nsWrapperCache* aCache) { if (!aCache->PreservingWrapper()) { nsXPCOMCycleCollectionParticipant* participant; CallQueryInterface(aScriptObjectHolder, &participant); HoldJSObjects(aScriptObjectHolder, participant); aCache->SetPreservingWrapper(true); #ifdef DEBUG // Make sure the cycle collector will be able to traverse to the wrapper. CheckCCWrapperTraversal(aScriptObjectHolder, aCache); #endif } } static void ReleaseWrapper(nsISupports* aScriptObjectHolder, nsWrapperCache* aCache); static void TraceWrapper(nsWrapperCache* aCache, TraceCallback aCallback, void *aClosure); /* * Notify when the first XUL menu is opened and when the all XUL menus are * closed. At opening, aInstalling should be TRUE, otherwise, it should be * FALSE. */ static void NotifyInstalledMenuKeyboardListener(bool aInstalling); /** * Do security checks before loading a resource. Does the following checks: * nsIScriptSecurityManager::CheckLoadURIWithPrincipal * NS_CheckContentLoadPolicy * nsIScriptSecurityManager::CheckSameOriginURI * * You will still need to do at least SameOrigin checks before on redirects. * * @param aURIToLoad URI that is getting loaded. * @param aLoadingPrincipal Principal of the resource that is initiating * the load * @param aCheckLoadFlags Flags to be passed to * nsIScriptSecurityManager::CheckLoadURIWithPrincipal * NOTE: If this contains ALLOW_CHROME the * CheckSameOriginURI check will be skipped if * aURIToLoad is a chrome uri. * @param aAllowData Set to true to skip CheckSameOriginURI check when aURIToLoad is a data uri. * @param aContentPolicyType Type \ * @param aContext Context |- to be passed to * @param aMimeGuess Mimetype | NS_CheckContentLoadPolicy * @param aExtra Extra / */ static nsresult CheckSecurityBeforeLoad(nsIURI* aURIToLoad, nsIPrincipal* aLoadingPrincipal, PRUint32 aCheckLoadFlags, bool aAllowData, PRUint32 aContentPolicyType, nsISupports* aContext, const nsACString& aMimeGuess = EmptyCString(), nsISupports* aExtra = nsnull); /** * Returns true if aPrincipal is the system principal. */ static bool IsSystemPrincipal(nsIPrincipal* aPrincipal); /** * Trigger a link with uri aLinkURI. If aClick is false, this triggers a * mouseover on the link, otherwise it triggers a load after doing a * security check using aContent's principal. * * @param aContent the node on which a link was triggered. * @param aPresContext the pres context, must be non-null. * @param aLinkURI the URI of the link, must be non-null. * @param aTargetSpec the target (like target=, may be empty). * @param aClick whether this was a click or not (if false, this method * assumes you just hovered over the link). * @param aIsUserTriggered whether the user triggered the link. This would be * false for loads from auto XLinks or from the * click() method if we ever implement it. * @param aIsTrusted If false, JS Context will be pushed to stack * when the link is triggered. */ static void TriggerLink(nsIContent *aContent, nsPresContext *aPresContext, nsIURI *aLinkURI, const nsString& aTargetSpec, bool aClick, bool aIsUserTriggered, bool aIsTrusted); /** * Return top-level widget in the parent chain. */ static nsIWidget* GetTopLevelWidget(nsIWidget* aWidget); /** * Return the localized ellipsis for UI. */ static const nsDependentString GetLocalizedEllipsis(); /** * The routine GetNativeEvent is used to fill nsNativeKeyEvent. * It's also used in DOMEventToNativeKeyEvent. * See bug 406407 for details. */ static nsEvent* GetNativeEvent(nsIDOMEvent* aDOMEvent); static bool DOMEventToNativeKeyEvent(nsIDOMKeyEvent* aKeyEvent, nsNativeKeyEvent* aNativeEvent, bool aGetCharCode); /** * Get the candidates for accelkeys for aDOMKeyEvent. * * @param aDOMKeyEvent [in] the key event for accelkey handling. * @param aCandidates [out] the candidate shortcut key combination list. * the first item is most preferred. */ static void GetAccelKeyCandidates(nsIDOMKeyEvent* aDOMKeyEvent, nsTArray& aCandidates); /** * Get the candidates for accesskeys for aNativeKeyEvent. * * @param aNativeKeyEvent [in] the key event for accesskey handling. * @param aCandidates [out] the candidate access key list. * the first item is most preferred. */ static void GetAccessKeyCandidates(nsKeyEvent* aNativeKeyEvent, nsTArray& aCandidates); /** * Hide any XUL popups associated with aDocument, including any documents * displayed in child frames. Does nothing if aDocument is null. */ static void HidePopupsInDocument(nsIDocument* aDocument); /** * Retrieve the current drag session, or null if no drag is currently occuring */ static already_AddRefed GetDragSession(); /* * Initialize and set the dataTransfer field of an nsDragEvent. */ static nsresult SetDataTransferInEvent(nsDragEvent* aDragEvent); // filters the drag and drop action to fit within the effects allowed and // returns it. static PRUint32 FilterDropEffect(PRUint32 aAction, PRUint32 aEffectAllowed); /** * Return true if aURI is a local file URI (i.e. file://). */ static bool URIIsLocalFile(nsIURI *aURI); /** * Given a URI, return set beforeHash to the part before the '#', and * afterHash to the remainder of the URI, including the '#'. */ static nsresult SplitURIAtHash(nsIURI *aURI, nsACString &aBeforeHash, nsACString &aAfterHash); /** * Get the application manifest URI for this document. The manifest URI * is specified in the manifest= attribute of the root element of the * document. * * @param aDocument The document that lists the manifest. * @param aURI The manifest URI. */ static void GetOfflineAppManifest(nsIDocument *aDocument, nsIURI **aURI); /** * Check whether an application should be allowed to use offline APIs. */ static bool OfflineAppAllowed(nsIURI *aURI); /** * Check whether an application should be allowed to use offline APIs. */ static bool OfflineAppAllowed(nsIPrincipal *aPrincipal); /** * Increases the count of blockers preventing scripts from running. * NOTE: You might want to use nsAutoScriptBlocker rather than calling * this directly */ static void AddScriptBlocker(); /** * Increases the count of blockers preventing scripts from running. * Also, while this script blocker is active, script runners must not be * added --- we'll assert if one is, and ignore it. */ static void AddScriptBlockerAndPreventAddingRunners(); /** * Decreases the count of blockers preventing scripts from running. * NOTE: You might want to use nsAutoScriptBlocker rather than calling * this directly * * WARNING! Calling this function could synchronously execute scripts. */ static void RemoveScriptBlocker(); /** * Add a runnable that is to be executed as soon as it's safe to execute * scripts. * NOTE: If it's currently safe to execute scripts, aRunnable will be run * synchronously before the function returns. * * @param aRunnable The nsIRunnable to run as soon as it's safe to execute * scripts. Passing null is allowed and results in nothing * happening. It is also allowed to pass an object that * has not yet been AddRefed. * @return false on out of memory, true otherwise. */ static bool AddScriptRunner(nsIRunnable* aRunnable); /** * Returns true if it's safe to execute content script and false otherwise. * * The only known case where this lies is mutation events. They run, and can * run anything else, when this function returns false, but this is ok. */ static bool IsSafeToRunScript() { return sScriptBlockerCount == 0; } /* Process viewport META data. This gives us information for the scale * and zoom of a page on mobile devices. We stick the information in * the document header and use it later on after rendering. * * See Bug #436083 */ static nsresult ProcessViewportInfo(nsIDocument *aDocument, const nsAString &viewportInfo); static nsIScriptContext* GetContextForEventHandlers(nsINode* aNode, nsresult* aRv); static JSContext *GetCurrentJSContext(); /** * Case insensitive comparison between two strings. However it only ignores * case for ASCII characters a-z. */ static bool EqualsIgnoreASCIICase(const nsAString& aStr1, const nsAString& aStr2); /** * Convert ASCII A-Z to a-z. */ static void ASCIIToLower(nsAString& aStr); static void ASCIIToLower(const nsAString& aSource, nsAString& aDest); /** * Convert ASCII a-z to A-Z. */ static void ASCIIToUpper(nsAString& aStr); static void ASCIIToUpper(const nsAString& aSource, nsAString& aDest); // Returns NS_OK for same origin, error (NS_ERROR_DOM_BAD_URI) if not. static nsresult CheckSameOrigin(nsIChannel *aOldChannel, nsIChannel *aNewChannel); static nsIInterfaceRequestor* GetSameOriginChecker(); static nsIThreadJSContextStack* ThreadJSContextStack() { return sThreadJSContextStack; } /** * Get the Origin of the passed in nsIPrincipal or nsIURI. If the passed in * nsIURI or the URI of the passed in nsIPrincipal does not have a host, the * origin is set to 'null'. * * The ASCII versions return a ASCII strings that are puny-code encoded, * suitable for, for example, header values. The UTF versions return strings * containing international characters. * * @pre aPrincipal/aOrigin must not be null. * * @note this should be used for HTML5 origin determination. */ static nsresult GetASCIIOrigin(nsIPrincipal* aPrincipal, nsCString& aOrigin); static nsresult GetASCIIOrigin(nsIURI* aURI, nsCString& aOrigin); static nsresult GetUTFOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin); static nsresult GetUTFOrigin(nsIURI* aURI, nsString& aOrigin); /** * This method creates and dispatches "command" event, which implements * nsIDOMXULCommandEvent. * If aShell is not null, dispatching goes via * nsIPresShell::HandleDOMEventWithTarget. */ static nsresult DispatchXULCommand(nsIContent* aTarget, bool aTrusted, nsIDOMEvent* aSourceEvent = nsnull, nsIPresShell* aShell = nsnull, bool aCtrl = false, bool aAlt = false, bool aShift = false, bool aMeta = false); /** * Gets the nsIDocument given the script context. Will return nsnull on failure. * * @param aScriptContext the script context to get the document for; can be null * * @return the document associated with the script context */ static already_AddRefed GetDocumentFromScriptContext(nsIScriptContext *aScriptContext); static bool CheckMayLoad(nsIPrincipal* aPrincipal, nsIChannel* aChannel); /** * The method checks whether the caller can access native anonymous content. * If there is no JS in the stack or privileged JS is running, this * method returns true, otherwise false. */ static bool CanAccessNativeAnon(); static nsresult WrapNative(JSContext *cx, JSObject *scope, nsISupports *native, const nsIID* aIID, jsval *vp, // If non-null aHolder will keep the jsval alive // while there's a ref to it nsIXPConnectJSObjectHolder** aHolder = nsnull, bool aAllowWrapping = false) { return WrapNative(cx, scope, native, nsnull, aIID, vp, aHolder, aAllowWrapping); } // Same as the WrapNative above, but use this one if aIID is nsISupports' IID. static nsresult WrapNative(JSContext *cx, JSObject *scope, nsISupports *native, jsval *vp, // If non-null aHolder will keep the jsval alive // while there's a ref to it nsIXPConnectJSObjectHolder** aHolder = nsnull, bool aAllowWrapping = false) { return WrapNative(cx, scope, native, nsnull, nsnull, vp, aHolder, aAllowWrapping); } static nsresult WrapNative(JSContext *cx, JSObject *scope, nsISupports *native, nsWrapperCache *cache, jsval *vp, // If non-null aHolder will keep the jsval alive // while there's a ref to it nsIXPConnectJSObjectHolder** aHolder = nsnull, bool aAllowWrapping = false) { return WrapNative(cx, scope, native, cache, nsnull, vp, aHolder, aAllowWrapping); } /** * Creates an arraybuffer from a binary string. */ static nsresult CreateArrayBuffer(JSContext *aCx, const nsACString& aData, JSObject** aResult); static void StripNullChars(const nsAString& aInStr, nsAString& aOutStr); /** * Strip all \n, \r and nulls from the given string * @param aString the string to remove newlines from [in/out] */ static void RemoveNewlines(nsString &aString); /** * Convert Windows and Mac platform linebreaks to \n. * @param aString the string to convert the newlines inside [in/out] */ static void PlatformToDOMLineBreaks(nsString &aString); static bool IsHandlingKeyBoardEvent() { return sIsHandlingKeyBoardEvent; } static void SetIsHandlingKeyBoardEvent(bool aHandling) { sIsHandlingKeyBoardEvent = aHandling; } /** * Utility method for getElementsByClassName. aRootNode is the node (either * document or element), which getElementsByClassName was called on. */ static nsresult GetElementsByClassName(nsINode* aRootNode, const nsAString& aClasses, nsIDOMNodeList** aReturn); /** * Returns a layer manager to use for the given document. Basically we * look up the document hierarchy for the first document which has * a presentation with an associated widget, and use that widget's * layer manager. * * @param aDoc the document for which to return a layer manager. * @param aAllowRetaining an outparam that states whether the returned * layer manager should be used for retained layers */ static already_AddRefed LayerManagerForDocument(nsIDocument *aDoc, bool *aAllowRetaining = nsnull); /** * Returns a layer manager to use for the given document. Basically we * look up the document hierarchy for the first document which has * a presentation with an associated widget, and use that widget's * layer manager. In addition to the normal layer manager lookup this will * specifically request a persistent layer manager. This means that the layer * manager is expected to remain the layer manager for the document in the * forseeable future. This function should be used carefully as it may change * the document's layer manager. * * @param aDoc the document for which to return a layer manager. * @param aAllowRetaining an outparam that states whether the returned * layer manager should be used for retained layers */ static already_AddRefed PersistentLayerManagerForDocument(nsIDocument *aDoc, bool *aAllowRetaining = nsnull); /** * Determine whether a content node is focused or not, * * @param aContent the content node to check * @return true if the content node is focused, false otherwise. */ static bool IsFocusedContent(const nsIContent *aContent); /** * Returns true if the DOM full-screen API is enabled. */ static bool IsFullScreenApiEnabled(); /** * Returns true if requests for full-screen are allowed in the current * context. Requests are only allowed if the user initiated them (like with * a mouse-click or key press), unless this check has been disabled by * setting the pref "full-screen-api.allow-trusted-requests-only" to false. */ static bool IsRequestFullScreenAllowed(); /** * Returns true if key input is restricted in DOM full-screen mode * to non-alpha-numeric key codes only. This mirrors the * "full-screen-api.key-input-restricted" pref. */ static bool IsFullScreenKeyInputRestricted(); /** * Returns true if the doc tree branch which contains aDoc contains any * plugins which we don't control event dispatch for, i.e. do any plugins * in the same tab as this document receive key events outside of our * control? This always returns false on MacOSX. */ static bool HasPluginWithUncontrolledEventDispatch(nsIDocument* aDoc); /** * Returns true if the content is in a document and contains a plugin * which we don't control event dispatch for, i.e. do any plugins in this * doc tree receive key events outside of our control? This always returns * false on MacOSX. */ static bool HasPluginWithUncontrolledEventDispatch(nsIContent* aContent); /** * Returns the root document in a document hierarchy. Normally this will * be the chrome document. */ static nsIDocument* GetRootDocument(nsIDocument* aDoc); /** * Returns the time limit on handling user input before * nsEventStateManager::IsHandlingUserInput() stops returning true. * This enables us to detect long running user-generated event handlers. */ static TimeDuration HandlingUserInputTimeout(); static void GetShiftText(nsAString& text); static void GetControlText(nsAString& text); static void GetMetaText(nsAString& text); static void GetAltText(nsAString& text); static void GetModifierSeparatorText(nsAString& text); /** * Returns if aContent has a tabbable subdocument. * A sub document isn't tabbable when it's a zombie document. * * @param aElement element to test. * * @return Whether the subdocument is tabbable. */ static bool IsSubDocumentTabbable(nsIContent* aContent); /** * Flushes the layout tree (recursively) * * @param aWindow the window the flush should start at * */ static void FlushLayoutForTree(nsIDOMWindow* aWindow); /** * Returns true if content with the given principal is allowed to use XUL * and XBL and false otherwise. */ static bool AllowXULXBLForPrincipal(nsIPrincipal* aPrincipal); /** * Perform cleanup that's appropriate for XPCOM shutdown. */ static void XPCOMShutdown(); enum ContentViewerType { TYPE_UNSUPPORTED, TYPE_CONTENT, TYPE_PLUGIN, TYPE_UNKNOWN }; static already_AddRefed FindInternalContentViewer(const char* aType, ContentViewerType* aLoaderType = nsnull); /** * This helper method returns true if the aPattern pattern matches aValue. * aPattern should not contain leading and trailing slashes (/). * The pattern has to match the entire value not just a subset. * aDocument must be a valid pointer (not null). * * This is following the HTML5 specification: * http://dev.w3.org/html5/spec/forms.html#attr-input-pattern * * WARNING: This method mutates aPattern and aValue! * * @param aValue the string to check. * @param aPattern the string defining the pattern. * @param aDocument the owner document of the element. * @result whether the given string is matches the pattern. */ static bool IsPatternMatching(nsAString& aValue, nsAString& aPattern, nsIDocument* aDocument); /** * Calling this adds support for * ontouch* event handler DOM attributes. */ static void InitializeTouchEventTable(); /** * Test whether the given URI always inherits a security context * from the document it comes from. */ static nsresult URIInheritsSecurityContext(nsIURI *aURI, bool *aResult); /** * Set the given principal as the owner of the given channel, if * needed. aURI must be the URI of aChannel. aPrincipal may be * null. If aSetUpForAboutBlank is true, then about:blank will get * the principal set up on it. * * The return value is whether the principal was set up as the owner * of the channel. */ static bool SetUpChannelOwner(nsIPrincipal* aLoadingPrincipal, nsIChannel* aChannel, nsIURI* aURI, bool aSetUpForAboutBlank); static nsresult Btoa(const nsAString& aBinaryData, nsAString& aAsciiBase64String); static nsresult Atob(const nsAString& aAsciiString, nsAString& aBinaryData); /** * Returns whether the input element passed in parameter has the autocomplete * functionnality enabled. It is taking into account the form owner. * NOTE: the caller has to make sure autocomplete makes sense for the * element's type. * * @param aInput the input element to check. NOTE: aInput can't be null. * @return whether the input element has autocomplete enabled. */ static bool IsAutocompleteEnabled(nsIDOMHTMLInputElement* aInput); private: static bool InitializeEventTable(); static nsresult EnsureStringBundle(PropertiesFile aFile); static nsIDOMScriptObjectFactory *GetDOMScriptObjectFactory(); static nsresult HoldScriptObject(PRUint32 aLangID, void* aObject); static void DropScriptObject(PRUint32 aLangID, void *aObject, void *aClosure); static bool CanCallerAccess(nsIPrincipal* aSubjectPrincipal, nsIPrincipal* aPrincipal); static nsresult WrapNative(JSContext *cx, JSObject *scope, nsISupports *native, nsWrapperCache *cache, const nsIID* aIID, jsval *vp, nsIXPConnectJSObjectHolder** aHolder, bool aAllowWrapping); static void InitializeModifierStrings(); static void DropFragmentParsers(); static nsIDOMScriptObjectFactory *sDOMScriptObjectFactory; static nsIXPConnect *sXPConnect; static nsIScriptSecurityManager *sSecurityManager; static nsIThreadJSContextStack *sThreadJSContextStack; static nsIParserService *sParserService; static nsINameSpaceManager *sNameSpaceManager; static nsIIOService *sIOService; #ifdef MOZ_XTF static nsIXTFService *sXTFService; #endif static bool sImgLoaderInitialized; static void InitImgLoader(); // The following two members are initialized lazily static imgILoader* sImgLoader; static imgICache* sImgCache; static nsIConsoleService* sConsoleService; static nsDataHashtable* sAtomEventTable; static nsDataHashtable* sStringEventTable; static nsCOMArray* sUserDefinedEvents; static nsIStringBundleService* sStringBundleService; static nsIStringBundle* sStringBundles[PropertiesFile_COUNT]; static nsIContentPolicy* sContentPolicyService; static bool sTriedToGetContentPolicy; static nsILineBreaker* sLineBreaker; static nsIWordBreaker* sWordBreaker; static nsIUGenCategory* sGenCat; static nsIScriptRuntime* sScriptRuntimes[NS_STID_ARRAY_UBOUND]; static PRInt32 sScriptRootCount[NS_STID_ARRAY_UBOUND]; static PRUint32 sJSGCThingRootCount; #ifdef IBMBIDI static nsIBidiKeyboard* sBidiKeyboard; #endif static bool sInitialized; static PRUint32 sScriptBlockerCount; #ifdef DEBUG static PRUint32 sDOMNodeRemovedSuppressCount; #endif // Not an nsCOMArray because removing elements from those is slower static nsTArray< nsCOMPtr >* sBlockedScriptRunners; static PRUint32 sRunnersCountAtFirstBlocker; static PRUint32 sScriptBlockerCountWhereRunnersPrevented; static nsIInterfaceRequestor* sSameOriginChecker; static bool sIsHandlingKeyBoardEvent; static bool sAllowXULXBL_for_file; static bool sIsFullScreenApiEnabled; static bool sTrustedFullScreenOnly; static bool sFullScreenKeyInputRestricted; static PRUint32 sHandlingInputTimeout; static nsHtml5Parser* sHTMLFragmentParser; static nsIParser* sXMLFragmentParser; static nsIFragmentContentSink* sXMLFragmentSink; /** * True if there's a fragment parser activation on the stack. */ static bool sFragmentParsingActive; static nsString* sShiftText; static nsString* sControlText; static nsString* sMetaText; static nsString* sAltText; static nsString* sModifierSeparator; }; typedef nsCharSeparatedTokenizerTemplate HTMLSplitOnSpacesTokenizer; #define NS_HOLD_JS_OBJECTS(obj, clazz) \ nsContentUtils::HoldJSObjects(NS_CYCLE_COLLECTION_UPCAST(obj, clazz), \ &NS_CYCLE_COLLECTION_NAME(clazz)) #define NS_DROP_JS_OBJECTS(obj, clazz) \ nsContentUtils::DropJSObjects(NS_CYCLE_COLLECTION_UPCAST(obj, clazz)) class NS_STACK_CLASS nsCxPusher { public: nsCxPusher(); ~nsCxPusher(); // Calls Pop(); // Returns false if something erroneous happened. bool Push(nsIDOMEventTarget *aCurrentTarget); // If nothing has been pushed to stack, this works like Push. // Otherwise if context will change, Pop and Push will be called. bool RePush(nsIDOMEventTarget *aCurrentTarget); // If a null JSContext is passed to Push(), that will cause no // push to happen and false to be returned. bool Push(JSContext *cx, bool aRequiresScriptContext = true); // Explicitly push a null JSContext on the the stack bool PushNull(); // Pop() will be a no-op if Push() or PushNull() fail void Pop(); nsIScriptContext* GetCurrentScriptContext() { return mScx; } private: // Combined code for PushNull() and Push(JSContext*) bool DoPush(JSContext* cx); nsCOMPtr mScx; bool mScriptIsRunning; bool mPushedSomething; #ifdef DEBUG JSContext* mPushedContext; #endif }; class NS_STACK_CLASS nsAutoScriptBlocker { public: nsAutoScriptBlocker(MOZILLA_GUARD_OBJECT_NOTIFIER_ONLY_PARAM) { MOZILLA_GUARD_OBJECT_NOTIFIER_INIT; nsContentUtils::AddScriptBlocker(); } ~nsAutoScriptBlocker() { nsContentUtils::RemoveScriptBlocker(); } private: MOZILLA_DECL_USE_GUARD_OBJECT_NOTIFIER }; class NS_STACK_CLASS nsAutoScriptBlockerSuppressNodeRemoved : public nsAutoScriptBlocker { public: nsAutoScriptBlockerSuppressNodeRemoved() { #ifdef DEBUG ++nsContentUtils::sDOMNodeRemovedSuppressCount; #endif } ~nsAutoScriptBlockerSuppressNodeRemoved() { #ifdef DEBUG --nsContentUtils::sDOMNodeRemovedSuppressCount; #endif } }; #define NS_INTERFACE_MAP_ENTRY_TEAROFF(_interface, _allocator) \ if (aIID.Equals(NS_GET_IID(_interface))) { \ foundInterface = static_cast<_interface *>(_allocator); \ if (!foundInterface) { \ *aInstancePtr = nsnull; \ return NS_ERROR_OUT_OF_MEMORY; \ } \ } else /** * Macros to workaround math-bugs bugs in various platforms */ /** * Stefan Hanske reports: * ARM is a little endian architecture but 64 bit double words are stored * differently: the 32 bit words are in little endian byte order, the two words * are stored in big endian`s way. */ #if defined(__arm) || defined(__arm32__) || defined(__arm26__) || defined(__arm__) #if !defined(__VFP_FP__) #define FPU_IS_ARM_FPA #endif #endif typedef union dpun { struct { #if defined(IS_LITTLE_ENDIAN) && !defined(FPU_IS_ARM_FPA) PRUint32 lo, hi; #else PRUint32 hi, lo; #endif } s; PRFloat64 d; public: operator double() const { return d; } } dpun; /** * Utility class for doubles */ #if (__GNUC__ == 2 && __GNUC_MINOR__ > 95) || __GNUC__ > 2 /** * This version of the macros is safe for the alias optimizations * that gcc does, but uses gcc-specific extensions. */ #define DOUBLE_HI32(x) (__extension__ ({ dpun u; u.d = (x); u.s.hi; })) #define DOUBLE_LO32(x) (__extension__ ({ dpun u; u.d = (x); u.s.lo; })) #else // __GNUC__ /* We don't know of any non-gcc compilers that perform alias optimization, * so this code should work. */ #if defined(IS_LITTLE_ENDIAN) && !defined(FPU_IS_ARM_FPA) #define DOUBLE_HI32(x) (((PRUint32 *)&(x))[1]) #define DOUBLE_LO32(x) (((PRUint32 *)&(x))[0]) #else #define DOUBLE_HI32(x) (((PRUint32 *)&(x))[0]) #define DOUBLE_LO32(x) (((PRUint32 *)&(x))[1]) #endif #endif // __GNUC__ #define DOUBLE_HI32_SIGNBIT 0x80000000 #define DOUBLE_HI32_EXPMASK 0x7ff00000 #define DOUBLE_HI32_MANTMASK 0x000fffff #define DOUBLE_IS_NaN(x) \ ((DOUBLE_HI32(x) & DOUBLE_HI32_EXPMASK) == DOUBLE_HI32_EXPMASK && \ (DOUBLE_LO32(x) || (DOUBLE_HI32(x) & DOUBLE_HI32_MANTMASK))) #ifdef IS_BIG_ENDIAN #define DOUBLE_NaN {{DOUBLE_HI32_EXPMASK | DOUBLE_HI32_MANTMASK, \ 0xffffffff}} #else #define DOUBLE_NaN {{0xffffffff, \ DOUBLE_HI32_EXPMASK | DOUBLE_HI32_MANTMASK}} #endif #if defined(XP_WIN) #define DOUBLE_COMPARE(LVAL, OP, RVAL) \ (!DOUBLE_IS_NaN(LVAL) && !DOUBLE_IS_NaN(RVAL) && (LVAL) OP (RVAL)) #else #define DOUBLE_COMPARE(LVAL, OP, RVAL) ((LVAL) OP (RVAL)) #endif /* * In the following helper macros we exploit the fact that the result of a * series of additions will not be finite if any one of the operands in the * series is not finite. */ #define NS_ENSURE_FINITE(f, rv) \ if (!NS_finite(f)) { \ return (rv); \ } #define NS_ENSURE_FINITE2(f1, f2, rv) \ if (!NS_finite((f1)+(f2))) { \ return (rv); \ } #define NS_ENSURE_FINITE3(f1, f2, f3, rv) \ if (!NS_finite((f1)+(f2)+(f3))) { \ return (rv); \ } #define NS_ENSURE_FINITE4(f1, f2, f3, f4, rv) \ if (!NS_finite((f1)+(f2)+(f3)+(f4))) { \ return (rv); \ } #define NS_ENSURE_FINITE5(f1, f2, f3, f4, f5, rv) \ if (!NS_finite((f1)+(f2)+(f3)+(f4)+(f5))) { \ return (rv); \ } #define NS_ENSURE_FINITE6(f1, f2, f3, f4, f5, f6, rv) \ if (!NS_finite((f1)+(f2)+(f3)+(f4)+(f5)+(f6))) { \ return (rv); \ } // Deletes a linked list iteratively to avoid blowing up the stack (bug 460444). #define NS_CONTENT_DELETE_LIST_MEMBER(type_, ptr_, member_) \ { \ type_ *cur = (ptr_)->member_; \ (ptr_)->member_ = nsnull; \ while (cur) { \ type_ *next = cur->member_; \ cur->member_ = nsnull; \ delete cur; \ cur = next; \ } \ } class nsContentTypeParser { public: nsContentTypeParser(const nsAString& aString); ~nsContentTypeParser(); nsresult GetParameter(const char* aParameterName, nsAString& aResult); nsresult GetType(nsAString& aResult) { return GetParameter(nsnull, aResult); } private: NS_ConvertUTF16toUTF8 mString; nsIMIMEHeaderParam* mService; }; class nsDocElementCreatedNotificationRunner : public nsRunnable { public: nsDocElementCreatedNotificationRunner(nsIDocument* aDoc) : mDoc(aDoc) { } NS_IMETHOD Run() { nsContentSink::NotifyDocElementCreated(mDoc); return NS_OK; } nsCOMPtr mDoc; }; #endif /* nsContentUtils_h___ */