File: check_deref.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (54 lines) | stat: -rw-r--r-- 1,643 bytes parent folder | download | duplicates (6)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "base/check.h"
#include "base/compiler_specific.h"

#if CHECK_WILL_STREAM()
#include "base/logging.h"
#endif  // CHECK_WILL_STREAM()

#ifndef BASE_CHECK_DEREF_H_
#define BASE_CHECK_DEREF_H_

namespace logging {

// Returns a reference to pointee of `ptr` if `ptr` is not null, or dies if
// `ptr` is null.
//
// It is useful in initializers and direct assignments, where a direct `CHECK`
// call can't be used:
//
//   MyType& type_ref = CHECK_DEREF(MethodReturningAPointer());
//
// If your raw pointer is stored in a wrapped type like `unique_ptr` or
// `raw_ptr`, you should use their `.get()` methods to get the raw pointer
// before calling `CHECK_DEREF()`:
//
//   MyType& type_ref = CHECK_DEREF(your_wrapped_pointer.get());
//
#define CHECK_DEREF(ptr) ::logging::CheckDeref(ptr, #ptr " != nullptr")

template <typename T>
[[nodiscard]] T& CheckDeref(
    T* ptr,
    const char* message,
    const base::Location& location = base::Location::Current()) {
  // Note: we can't just call `CHECK_NE(ptr, nullptr)` here, as that would
  // cause the error to be reported from this header, and we want the error
  // to be reported at the file and line of the caller.
  if (ptr == nullptr) [[unlikely]] {
#if CHECK_WILL_STREAM()
    // `CheckNoreturnError` will die with a fatal error in its destructor.
    CheckNoreturnError::Check(message, location);
#else
    CheckFailure();
#endif  // !CHECK_WILL_STREAM()
  }
  return *ptr;
}

}  // namespace logging

#endif  // BASE_CHECK_DEREF_H_