window_info.h | Explore in Territory

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

#ifndef COMPONENTS_APP_RESTORE_WINDOW_INFO_H_
#define COMPONENTS_APP_RESTORE_WINDOW_INFO_H_

#include <optional>

#include "base/memory/raw_ptr.h"
#include "base/uuid.h"
#include "chromeos/ui/base/window_state_type.h"
#include "components/tab_groups/tab_group_info.h"
#include "ui/aura/window.h"
#include "ui/base/ui_base_types.h"
#include "ui/gfx/geometry/rect.h"
#include "url/gurl.h"

namespace app_restore {

// Browser specific info. It is used for creating new browsers for saved desks,
// or displaying browser info in the pine dialog.
struct COMPONENT_EXPORT(APP_RESTORE) BrowserExtraInfo {
  BrowserExtraInfo();
  BrowserExtraInfo(BrowserExtraInfo&&);
  BrowserExtraInfo(const BrowserExtraInfo&);
  BrowserExtraInfo& operator=(BrowserExtraInfo&&);
  BrowserExtraInfo& operator=(const BrowserExtraInfo&);
  ~BrowserExtraInfo();

  bool operator==(const BrowserExtraInfo& other) const;

  std::vector<GURL> urls;
  std::optional<int32_t> active_tab_index;
  std::optional<int32_t> first_non_pinned_tab_index;
  // True if the browser was `Browser::TYPE_APP` or `Browser::TYPE_APP_POPUP`.
  // (PWA or SWA).
  std::optional<bool> app_type_browser;
  std::optional<std::string> app_name;
  // Represents tab groups associated with this browser instance if there are
  // any. This is only used in Desks Storage, tab groups in full restore are
  // persisted by sessions. This field is not converted to base::Value in base
  // value conversions.
  std::vector<tab_groups::TabGroupInfo> tab_group_infos;
  // Lacros only, the ID of the lacros profile that this browser uses.
  std::optional<uint64_t> lacros_profile_id;
};

// This struct is the parameter for the interface SaveWindowInfo, to save the
// window information.
struct COMPONENT_EXPORT(APP_RESTORE) WindowInfo {
 public:
  // This struct is the ARC specific window info.
  struct ArcExtraInfo {
    bool operator==(const ArcExtraInfo& other) const = default;
    std::optional<gfx::Size> maximum_size;
    std::optional<gfx::Size> minimum_size;
    std::optional<gfx::Rect> bounds_in_root;
  };

  WindowInfo();
  WindowInfo(WindowInfo&&);
  WindowInfo(const WindowInfo&);
  WindowInfo& operator=(WindowInfo&&);
  WindowInfo& operator=(const WindowInfo&);
  ~WindowInfo();

  bool operator==(const WindowInfo& other) const;

  raw_ptr<aura::Window, DanglingUntriaged> window;

  // Index in MruWindowTracker to restore window stack. A lower index
  // indicates a more recently used window.
  std::optional<int32_t> activation_index;

  // Virtual desk id.
  std::optional<int32_t> desk_id;

  // The GUID of the virtual desk that this window was on.
  base::Uuid desk_guid;

  // Current bounds in screen in coordinates. If the window has restore bounds,
  // then this contains the restore bounds.
  std::optional<gfx::Rect> current_bounds;

  // Window state, minimized, maximized, inactive, etc.
  std::optional<chromeos::WindowStateType> window_state_type;

  // Show state of a window before it was minimized. Empty for non-minimized
  // windows.
  std::optional<ui::WindowShowState> pre_minimized_show_state_type;

  // The snap percentage of a window, if it is snapped. For instance a snap
  // percentage of 75 means the window takes up three quarters of the work area.
  // The primary axis is determined when restoring; if it is portrait, it will
  // be three quarters of the height.
  std::optional<uint32_t> snap_percentage;

  // Display id to launch an app.
  std::optional<int64_t> display_id;

  // The title of the app window. Used for saved desks in case one of the
  // windows in the template is uninstalled, we can show a nice error message.
  // Also used for the ARC ghost window.
  std::optional<std::u16string> app_title;

  // Extra window info of ARC app window.
  std::optional<ArcExtraInfo> arc_extra_info;

  std::string ToString() const;
};

}  // namespace app_restore

#endif  // COMPONENTS_APP_RESTORE_WINDOW_INFO_H_
chromium/components/app_restore/window_info.h
