/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_SELECT_ELEMENT_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_SELECT_ELEMENT_H_

#include <vector>

#include "third_party/blink/public/platform/web_common.h"
#include "third_party/blink/public/web/web_autofill_state.h"
#include "third_party/blink/public/web/web_form_control_element.h"
#include "third_party/blink/public/web/web_option_element.h"

namespace blink {

class HTMLSelectElement;

// Provides readonly access to some properties of a DOM select element node.
class BLINK_EXPORT WebSelectElement final : public WebFormControlElement {
 public:
  explicit WebSelectElement(
      cppgc::SourceLocation loc = BLINK_WEB_NODE_LOCATION_FROM_HERE)
      : WebFormControlElement(loc) {}
  WebSelectElement(const WebSelectElement& element) = default;

  WebSelectElement& operator=(const WebSelectElement& element) {
    WebFormControlElement::Assign(element);
    return *this;
  }
  void Assign(const WebSelectElement& element) {
    WebFormControlElement::Assign(element);
  }

  // Auto-selects `option` in `this`. This is preferred in `WebSelectElement`
  // over `WebFormControlElement::SetAutofillValue()` because the former
  // specifies the exact option to select, whereas the latter triggers a
  // search-by-value that could be inaccurate for select elements having options
  // with duplicate values.
  // Also dispatches focus/blur events before and after modifying the option
  // respectively.
  void SetAutofillOption(WebOptionElement* option,
                         WebAutofillState autofill_state);

  // Similar to `SetAutofillOption()` in terms of its advantages over
  // `WebFormControlElement::SetSuggestedValue()`. Does not dispatch any events.
  void SetSuggestedOption(WebOptionElement* option);

  std::vector<WebElement> GetListItems() const;

#if INSIDE_BLINK
  WebSelectElement(HTMLSelectElement*);
  WebSelectElement& operator=(HTMLSelectElement*);
  operator HTMLSelectElement*() const;
#endif
};

DECLARE_WEB_NODE_TYPE_CASTS(WebSelectElement);

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_SELECT_ELEMENT_H_