// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_
#define UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_

#include <memory>
#include <string_view>

#include "base/memory/raw_ptr.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/views/controls/button/label_button.h"
#include "ui/views/metadata/view_factory.h"

namespace views {

class MenuButtonController;

////////////////////////////////////////////////////////////////////////////////
//
// MenuButton
//
//  A button that shows a menu when the left mouse button is pushed
//
////////////////////////////////////////////////////////////////////////////////
class VIEWS_EXPORT MenuButton : public LabelButton {
  METADATA_HEADER(MenuButton, LabelButton)

 public:
  explicit MenuButton(PressedCallback callback = PressedCallback(),
                      std::u16string_view text = {},
                      int button_context = style::CONTEXT_BUTTON);
  MenuButton(const MenuButton&) = delete;
  MenuButton& operator=(const MenuButton&) = delete;
  ~MenuButton() override;

  MenuButtonController* button_controller() const {
    return menu_button_controller_;
  }

  bool Activate(const ui::Event* event);

  // We should use MenuButton::SetMenuButtonController() instead of
  // Button::SetButtonController() whenever we need to set a
  // ButtonController for a menu button.
  // Button::SetButtonController takes a std::unique_ptr<ButtonController>
  // button_controller as a parameter here, but MenuButton requires a
  // MenuButtonController here – it caches a pointer to the MenuButtonController
  // as a member raw_ptr and invokes its PressedCallback during activation.
  // Since Button::SetButtonController() cannot guarantee that the parameter is
  // a MenuButtonController, nor can it cache the pointer we need, directly
  // using this method will cause certain issues.
  // See https://crbug.com/477645289
  void SetMenuButtonController(
      std::unique_ptr<MenuButtonController> menu_button_controller);

  // Button:
  void SetCallback(PressedCallback callback) override;

 protected:
  // Button:
  void NotifyClick(const ui::Event& event) final;

 private:
  raw_ptr<MenuButtonController> menu_button_controller_;
};

BEGIN_VIEW_BUILDER(VIEWS_EXPORT, MenuButton, LabelButton)
END_VIEW_BUILDER

}  // namespace views

DEFINE_VIEW_BUILDER(VIEWS_EXPORT, MenuButton)

#endif  // UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_