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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EditingState_h
#define EditingState_h
#include "core/CoreExport.h"
#include "wtf/Allocator.h"
#include "wtf/Assertions.h"
#include "wtf/Noncopyable.h"
namespace blink {
// EditingState represents current editing command running state for propagating
// DOM tree mutation operation failure to callers.
//
// Example usage:
// EditingState editingState;
// ...
// functionMutatesDOMTree(..., &editingState);
// if (editingState.isAborted())
// return;
//
class CORE_EXPORT EditingState final {
STACK_ALLOCATED();
WTF_MAKE_NONCOPYABLE(EditingState);
public:
EditingState();
~EditingState();
void abort();
bool isAborted() const { return m_isAborted; }
private:
bool m_isAborted = false;
};
// TODO(yosin): Once all commands aware |EditingState|, we get rid of
// |IgnorableEditingAbortState | class
class IgnorableEditingAbortState final {
STACK_ALLOCATED();
WTF_MAKE_NONCOPYABLE(IgnorableEditingAbortState);
public:
IgnorableEditingAbortState();
~IgnorableEditingAbortState();
EditingState* editingState() { return &m_editingState; }
private:
EditingState m_editingState;
};
// Abort the editing command if the specified expression is true.
#define ABORT_EDITING_COMMAND_IF(expr) \
do { \
if (expr) { \
editingState->abort(); \
return; \
} \
} while (false)
#if DCHECK_IS_ON()
// This class is inspired by |NoExceptionStateAssertionChecker|.
class NoEditingAbortChecker final {
STACK_ALLOCATED();
WTF_MAKE_NONCOPYABLE(NoEditingAbortChecker);
public:
NoEditingAbortChecker(const char* file, int line);
~NoEditingAbortChecker();
EditingState* editingState() { return &m_editingState; }
private:
EditingState m_editingState;
const char* const m_file;
int const m_line;
};
// If a function with EditingState* argument should not be aborted,
// ASSERT_NO_EDITING_ABORT should be specified.
// fooFunc(...., ASSERT_NO_EDITING_ABORT);
// It causes an assertion failure If DCHECK_IS_ON() and the function was aborted
// unexpectedly.
#define ASSERT_NO_EDITING_ABORT \
(NoEditingAbortChecker(__FILE__, __LINE__).editingState())
#else
#define ASSERT_NO_EDITING_ABORT (IgnorableEditingAbortState().editingState())
#endif
} // namespace blink
#endif // EditingState_h
|