blob: e9a42cfa3d41a1cf7d8afba0f5ad8a843afb32ae [file] [log] [blame]
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* (C) 2000 Dirk Mueller (mueller@kde.org)
* Copyright (C) 2004-2019 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "FormState.h"
#include "FormSubmission.h"
#include "HTMLElement.h"
#include "RadioButtonGroups.h"
#include <memory>
#include <wtf/IsoMalloc.h>
#include <wtf/WeakHashSet.h>
namespace WebCore {
class DOMFormData;
class Event;
class FormAssociatedElement;
class HTMLFormControlElement;
class HTMLFormControlsCollection;
class HTMLImageElement;
class HTMLFormElement final : public HTMLElement {
WTF_MAKE_ISO_ALLOCATED(HTMLFormElement);
public:
static Ref<HTMLFormElement> create(Document&);
static Ref<HTMLFormElement> create(const QualifiedName&, Document&);
virtual ~HTMLFormElement();
Ref<HTMLFormControlsCollection> elements();
WEBCORE_EXPORT Ref<HTMLCollection> elementsForNativeBindings();
Vector<Ref<Element>> namedElements(const AtomString&);
WEBCORE_EXPORT unsigned length() const;
HTMLElement* item(unsigned index);
std::optional<std::variant<RefPtr<RadioNodeList>, RefPtr<Element>>> namedItem(const AtomString&);
Vector<AtomString> supportedPropertyNames() const;
String enctype() const { return m_attributes.encodingType(); }
WEBCORE_EXPORT void setEnctype(const String&);
bool shouldAutocomplete() const;
WEBCORE_EXPORT void setAutocomplete(const AtomString&);
WEBCORE_EXPORT const AtomString& autocomplete() const;
#if ENABLE(AUTOCORRECT)
WEBCORE_EXPORT bool shouldAutocorrect() const final;
#endif
// FIXME: Should rename these two functions to say "form control" or "form-associated element" instead of "form element".
void registerFormElement(FormAssociatedElement*);
void removeFormElement(FormAssociatedElement*);
void registerInvalidAssociatedFormControl(const HTMLFormControlElement&);
void removeInvalidAssociatedFormControlIfNeeded(const HTMLFormControlElement&);
void registerImgElement(HTMLImageElement*);
void removeImgElement(HTMLImageElement*);
void submitIfPossible(Event*, HTMLFormControlElement* = nullptr, FormSubmissionTrigger = NotSubmittedByJavaScript);
WEBCORE_EXPORT void submit();
void submitFromJavaScript();
ExceptionOr<void> requestSubmit(HTMLElement* submitter);
WEBCORE_EXPORT void reset();
void setDemoted(bool demoted) { m_wasDemoted = demoted; }
void submitImplicitly(Event&, bool fromImplicitSubmissionTrigger);
bool formWouldHaveSecureSubmission(const String& url);
String name() const;
bool noValidate() const;
String acceptCharset() const { return m_attributes.acceptCharset(); }
void setAcceptCharset(const String&);
WEBCORE_EXPORT String action() const;
WEBCORE_EXPORT void setAction(const String&);
WEBCORE_EXPORT String method() const;
WEBCORE_EXPORT void setMethod(const String&);
DOMTokenList& relList();
String target() const final;
String effectiveTarget(const Event*, HTMLFormControlElement* submitter) const;
bool wasUserSubmitted() const;
HTMLFormControlElement* findSubmitter(const Event*) const;
HTMLFormControlElement* defaultButton() const;
void resetDefaultButton();
WEBCORE_EXPORT bool checkValidity();
bool reportValidity();
RadioButtonGroups& radioButtonGroups() { return m_radioButtonGroups; }
WEBCORE_EXPORT const Vector<WeakPtr<HTMLElement>>& unsafeAssociatedElements() const;
Vector<Ref<FormAssociatedElement>> copyAssociatedElementsVector() const;
const Vector<WeakPtr<HTMLImageElement>>& imageElements() const { return m_imageElements; }
StringPairVector textFieldValues() const;
static HTMLFormElement* findClosestFormAncestor(const Element&);
RefPtr<DOMFormData> constructEntryList(Ref<DOMFormData>&&, StringPairVector*);
private:
HTMLFormElement(const QualifiedName&, Document&);
bool rendererIsNeeded(const RenderStyle&) final;
InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) final;
void removedFromAncestor(RemovalType, ContainerNode&) final;
void finishParsingChildren() final;
void parseAttribute(const QualifiedName&, const AtomString&) final;
bool isURLAttribute(const Attribute&) const final;
void resumeFromDocumentSuspension() final;
void didMoveToNewDocument(Document& oldDocument, Document& newDocument) final;
void copyNonAttributePropertiesFromElement(const Element&) final;
void submit(Event*, bool activateSubmitButton, bool processingUserGesture, FormSubmissionTrigger, HTMLFormControlElement* submitter = nullptr);
void submitDialog(Ref<FormSubmission>&&);
unsigned formElementIndexWithFormAttribute(Element*, unsigned rangeStart, unsigned rangeEnd);
unsigned formElementIndex(FormAssociatedElement*);
bool validateInteractively();
// Validates each of the controls, and stores controls of which 'invalid'
// event was not canceled to the specified vector. Returns true if there
// are any invalid controls in this form.
bool checkInvalidControlsAndCollectUnhandled(Vector<RefPtr<HTMLFormControlElement>>&);
RefPtr<HTMLElement> elementFromPastNamesMap(const AtomString&) const;
void addToPastNamesMap(FormNamedItem*, const AtomString& pastName);
#if ASSERT_ENABLED
void assertItemCanBeInPastNamesMap(FormNamedItem*) const;
#endif
void removeFromPastNamesMap(FormNamedItem*);
bool matchesValidPseudoClass() const final;
bool matchesInvalidPseudoClass() const final;
void resetAssociatedFormControlElements();
RefPtr<HTMLFormControlElement> findSubmitButton(HTMLFormControlElement* submitter, bool needButtonActivation);
FormSubmission::Attributes m_attributes;
HashMap<AtomString, WeakPtr<HTMLElement>> m_pastNamesMap;
RadioButtonGroups m_radioButtonGroups;
mutable WeakPtr<HTMLFormControlElement> m_defaultButton;
unsigned m_associatedElementsBeforeIndex { 0 };
unsigned m_associatedElementsAfterIndex { 0 };
Vector<WeakPtr<HTMLElement>> m_associatedElements;
Vector<WeakPtr<HTMLImageElement>> m_imageElements;
WeakHashSet<HTMLFormControlElement> m_invalidAssociatedFormControls;
WeakPtr<FormSubmission> m_plannedFormSubmission;
std::unique_ptr<DOMTokenList> m_relList;
bool m_wasUserSubmitted { false };
bool m_isSubmittingOrPreparingForSubmission { false };
bool m_shouldSubmit { false };
bool m_isInResetFunction { false };
bool m_wasDemoted { false };
bool m_isConstructingEntryList { false };
};
} // namespace WebCore