File: AutoSelectionRestorer.h

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (51 lines) | stat: -rw-r--r-- 1,578 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */

#ifndef mozilla_AutoSelectionRestorer_h_
#define mozilla_AutoSelectionRestorer_h_

#include "EditorBase.h"

namespace mozilla {

/**
 * Stack based helper class for saving/restoring selection.  Note that this
 * assumes that the nodes involved are still around afterwords!
 */
class AutoSelectionRestorer final {
 public:
  AutoSelectionRestorer() = delete;
  explicit AutoSelectionRestorer(const AutoSelectionRestorer& aOther) = delete;
  AutoSelectionRestorer(AutoSelectionRestorer&& aOther) = delete;

  /**
   * Constructor responsible for remembering all state needed to restore
   * aSelection.
   * XXX This constructor and the destructor should be marked as
   *     `MOZ_CAN_RUN_SCRIPT`, but it's impossible due to this may be used
   *     with `Maybe`.
   */
  MOZ_CAN_RUN_SCRIPT_BOUNDARY explicit AutoSelectionRestorer(
      EditorBase* aEditor);

  /**
   * Destructor restores mSelection to its former state
   */
  MOZ_CAN_RUN_SCRIPT_BOUNDARY ~AutoSelectionRestorer();

  /**
   * Abort() cancels to restore the selection.
   */
  void Abort();

  bool MaybeRestoreSelectionLater() const { return !!mEditor; }

 protected:
  // The lifetime must be guaranteed by the creator of this instance.
  MOZ_KNOWN_LIVE EditorBase* mEditor = nullptr;
};
}  // namespace mozilla

#endif