/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=8 sts=2 et sw=2 tw=80: */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
namespace mozilla { class EventChainPostVisitor; class EventChainPreVisitor; namespace dom { class DialogFormSubmission; class HTMLFormControlsCollection; class HTMLFormSubmission; class HTMLImageElement; class FormData;
class HTMLFormElement final : public nsGenericHTMLElement { friendclass HTMLFormControlsCollection;
/** Whether we already dispatched a DOMFormHasPassword event or not */ bool mHasPendingPasswordEvent = false; /** Whether we already dispatched a DOMPossibleUsernameInputAdded event or not
*/ bool mHasPendingPossibleUsernameEvent = false;
/** * Remove an element from this form's list of elements * * @param aElement the element to remove * @param aUpdateValidity If true, updates the form validity. * @return NS_OK if the element was successfully removed.
*/
nsresult RemoveElement(nsGenericHTMLFormElement* aElement, bool aUpdateValidity);
/** * Remove an element from the lookup table maintained by the form. * We can't fold this method into RemoveElement() because when * RemoveElement() is called it doesn't know if the element is * removed because the id attribute has changed, or because the * name attribute has changed. * * @param aElement the element to remove * @param aName the name or id of the element to remove * @return NS_OK if the element was successfully removed.
*/
nsresult RemoveElementFromTable(nsGenericHTMLFormElement* aElement, const nsAString& aName);
/** * Add an element to end of this form's list of elements * * @param aElement the element to add * @param aUpdateValidity If true, the form validity will be updated. * @param aNotify If true, send DocumentObserver notifications as needed. * @return NS_OK if the element was successfully added
*/
nsresult AddElement(nsGenericHTMLFormElement* aElement, bool aUpdateValidity, bool aNotify);
/** * Add an element to the lookup table maintained by the form. * * We can't fold this method into AddElement() because when * AddElement() is called, the form control has no * attributes. The name or id attributes of the form control * are used as a key into the table.
*/
nsresult AddElementToTable(nsGenericHTMLFormElement* aChild, const nsAString& aName);
/** * Remove an image element from this form's list of image elements * * @param aElement the image element to remove * @return NS_OK if the element was successfully removed.
*/
nsresult RemoveImageElement(HTMLImageElement* aElement);
/** * Remove an image element from the lookup table maintained by the form. * We can't fold this method into RemoveImageElement() because when * RemoveImageElement() is called it doesn't know if the element is * removed because the id attribute has changed, or because the * name attribute has changed. * * @param aElement the image element to remove * @param aName the name or id of the element to remove * @return NS_OK if the element was successfully removed.
*/
nsresult RemoveImageElementFromTable(HTMLImageElement* aElement, const nsAString& aName); /** * Add an image element to the end of this form's list of image elements * * @param aElement the element to add * @return NS_OK if the element was successfully added
*/
nsresult AddImageElement(HTMLImageElement* aElement);
/** * Add an image element to the lookup table maintained by the form. * * We can't fold this method into AddImageElement() because when * AddImageElement() is called, the image attributes can change. * The name or id attributes of the image are used as a key into the table.
*/
nsresult AddImageElementToTable(HTMLImageElement* aChild, const nsAString& aName);
/** * Check whether a given nsGenericHTMLFormElement is the last single line * input control that is not disabled. aElement is expected to not be null.
*/ bool IsLastActiveElement(const nsGenericHTMLFormElement* aElement) const;
/** * Flag the form to know that a button or image triggered scripted form * submission. In that case the form will defer the submission until the * script handler returns and the return value is known.
*/ void OnSubmitClickBegin(Element* aOriginatingElement); void OnSubmitClickEnd();
/** * This method will update the form validity. * * This method has to be called by form elements whenever their validity state * or status regarding constraint validation changes. * * @note This method isn't used for CheckValidity(). * @note If an element becomes barred from constraint validation, it has to be * considered as valid. * * @param aElementValidityState the new validity state of the element
*/ void UpdateValidity(bool aElementValidityState);
/** * Contruct the entry list to get their data pumped into the FormData and * fire a `formdata` event with the entry list in formData attribute. * <https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#constructing-form-data-set> * * @param aFormData the form data object
*/ // TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230)
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult ConstructEntryList(FormData*);
/** * Implements form[name]. Returns form controls in this form with the correct * value of the name attribute.
*/
already_AddRefed<nsISupports> FindNamedItem(const nsAString& aName,
nsWrapperCache** aCache);
// it's only out-of-line because the class definition is not available in the // header
HTMLFormControlsCollection* Elements();
int32_t Length();
/** * Check whether submission can proceed for this form then fire submit event. * This basically implements steps 1-6 (more or less) of * <https://html.spec.whatwg.org/multipage/forms.html#concept-form-submit>. * @param aSubmitter If not null, is the "submitter" from that algorithm. * Therefore it must be a valid submit control.
*/
MOZ_CAN_RUN_SCRIPT void MaybeSubmit(Element* aSubmitter);
MOZ_CAN_RUN_SCRIPT void MaybeReset(Element* aSubmitter); void Submit(ErrorResult& aRv);
/** * Requests to submit the form. Unlike submit(), this method includes * interactive constraint validation and firing a submit event, * either of which can cancel submission. * * @param aSubmitter The submitter argument can be used to point to a specific * submit button. * @param aRv An ErrorResult. * @see * https://html.spec.whatwg.org/multipage/forms.html#dom-form-requestsubmit
*/
MOZ_CAN_RUN_SCRIPT void RequestSubmit(nsGenericHTMLElement* aSubmitter,
ErrorResult& aRv);
// Async callback to handle removal of our default submit void HandleDefaultSubmitRemoval();
// // Submit Helpers // // /** * Attempt to submit (submission might be deferred) * * @param aPresContext the presentation context * @param aEvent the DOM event that was passed to us for the submit
*/
nsresult DoSubmit(Event* aEvent = nullptr);
/** * Prepare the submission object (called by DoSubmit) * * @param aFormSubmission the submission object * @param aEvent the DOM event that was passed to us for the submit
*/
nsresult BuildSubmission(HTMLFormSubmission** aFormSubmission, Event* aEvent); /** * Perform the submission (called by DoSubmit and FlushPendingSubmission) * * @param aFormSubmission the submission object
*/
nsresult SubmitSubmission(HTMLFormSubmission* aFormSubmission);
/** * Submit a form[method=dialog] * @param aFormSubmission the submission object
*/
nsresult SubmitDialog(DialogFormSubmission* aFormSubmission);
/** * Notify any submit observers of the submit. * * @param aActionURL the URL being submitted to * @param aCancelSubmit out param where submit observers can specify that the * submit should be cancelled.
*/
nsresult NotifySubmitObservers(nsIURI* aActionURL, bool* aCancelSubmit, bool aEarlyNotify);
/** * If this form submission is secure -> insecure, ask the user if they want * to continue. * * @param aActionURL the URL being submitted to * @param aCancelSubmit out param: will be true if the user wants to cancel
*/
nsresult DoSecureToInsecureSubmitCheck(nsIURI* aActionURL, bool* aCancelSubmit);
/** * Find form controls in this form with the correct value in the name * attribute.
*/
already_AddRefed<nsISupports> DoResolveName(const nsAString& aName);
// Clear the mImageNameLookupTable and mImageElements. void Clear();
// Insert a element into the past names map. void AddToPastNamesMap(const nsAString& aName, nsISupports* aChild);
// Remove the given element from the past names map. The element must be an // nsGenericHTMLFormElement or HTMLImageElement. void RemoveElementFromPastNamesMap(Element* aElement);
public: /** * Flush a possible pending submission. If there was a scripted submission * triggered by a button or image, the submission was defered. This method * forces the pending submission to be submitted. (happens when the handler * returns false or there is an action/target change in the script)
*/ void FlushPendingSubmission();
/** * Get the full URL to submit to. Do not submit if the returned URL is null. * * @param aActionURL the full, unadulterated URL you'll be submitting to [OUT] * @param aOriginatingElement the originating element of the form submission * [IN]
*/
nsresult GetActionURL(nsIURI** aActionURL, Element* aOriginatingElement);
// Get the target to submit to. This is either the submitter's |formtarget| or // the form's |target| (Including <base>). void GetSubmissionTarget(nsGenericHTMLElement* aSubmitter,
nsAString& aTarget);
// Returns a number for this form that is unique within its owner document. // This is used by nsContentUtils::GenerateStateKey to identify form controls // that are inserted into the document by the parser.
int32_t GetFormNumberForStateKey();
/** * Called when we have been cloned and adopted, and the information of the * node has been changed.
*/ void NodeInfoChanged(Document* aOldDoc) override;
protected: // // Data members // /** The list of controls (form.elements as well as stuff not in elements) */
RefPtr<HTMLFormControlsCollection> mControls;
/** The pending submission object */
UniquePtr<HTMLFormSubmission> mPendingSubmission;
/** The target browsing context, if any. */
RefPtr<BrowsingContext> mTargetContext; /** The load identifier for the pending request created for a
* submit, used to be able to block double submits. */
Maybe<uint64_t> mCurrentLoadId;
/** The default submit element -- WEAK */
nsGenericHTMLFormElement* mDefaultSubmitElement;
/** The first submit element in mElements -- WEAK */
nsGenericHTMLFormElement* mFirstSubmitInElements;
/** The first submit element in mNotInElements -- WEAK */
nsGenericHTMLFormElement* mFirstSubmitNotInElements;
// This array holds on to all HTMLImageElement(s). // This is needed to properly clean up the bi-directional references // (both weak and strong) between the form and its HTMLImageElements.
// A map from an ID or NAME attribute to the HTMLImageElement(s), this // hash holds strong references either to the named HTMLImageElement, or // to a list of named HTMLImageElement(s), in the case where this hash // holds on to a list of named HTMLImageElement(s) the list has weak // references to the HTMLImageElement.
/** Keep track of what the popup state was when the submit was initiated */
PopupBlocker::PopupControlState mSubmitPopupState;
RefPtr<nsDOMTokenList> mRelList;
/** * Number of invalid and candidate for constraint validation elements in the * form the last time UpdateValidity has been called.
*/
int32_t mInvalidElementsCount;
// See GetFormNumberForStateKey.
int32_t mFormNumber;
/** Whether we are currently processing a submit event or not */ bool mGeneratingSubmit; /** Whether we are currently processing a reset event or not */ bool mGeneratingReset; /** Whether the submission is to be deferred in case a script triggers it */ bool mDeferSubmission; /** Whether we notified NS_FORMSUBMIT_SUBJECT listeners already */ bool mNotifiedObservers; /** If we notified the listeners early, what was the result? */ bool mNotifiedObserversResult; /** * Whether the submission of this form has been ever prevented because of * being invalid.
*/ bool mEverTriedInvalidSubmit; /** Whether we are constructing entry list */ bool mIsConstructingEntryList; /** Whether we are firing submission event */ bool mIsFiringSubmissionEvents;
/** * Fire an event when the form is removed from the DOM tree. This is now only * used by the password manager and formautofill.
*/ void MaybeFireFormRemoved();
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
