DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (56e7b9127e89)

VCS Links

Line Code
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 97 98 99 100 101 102 103 104 105 106 107 108 109 110
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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 DDLoggedTypeTraits_h_
#define DDLoggedTypeTraits_h_

#include "mozilla/TypeTraits.h"

namespace mozilla {

// Templated struct carrying compile-time information about C++ types that may
// log messages (including about their lifetime and links to other objects.)
// Classes should declare a specialization by using one of the macros below.
template<typename T>
struct DDLoggedTypeTraits;

#define DDLoggedTypeName(TYPE)                                                 \
  template<>                                                                   \
  struct DDLoggedTypeTraits<TYPE>                                              \
  {                                                                            \
    using Type = TYPE;                                                         \
    static constexpr const char* Name() { return #TYPE; }                      \
    using HasBase = FalseType;                                                 \
    using BaseType = TYPE;                                                     \
    static constexpr const char* BaseTypeName() { return ""; }                 \
  }

#define DDLoggedTypeNameAndBase(TYPE, BASE)                                    \
  template<>                                                                   \
  struct DDLoggedTypeTraits<TYPE>                                              \
  {                                                                            \
    using Type = TYPE;                                                         \
    static constexpr const char* Name() { return #TYPE; }                      \
    using HasBase = TrueType;                                                  \
    using BaseType = BASE;                                                     \
    static constexpr const char* BaseTypeName()                                \
    {                                                                          \
      return DDLoggedTypeTraits<BASE>::Name();                                 \
    }                                                                          \
  }

#define DDLoggedTypeCustomName(TYPE, NAME)                                     \
  template<>                                                                   \
  struct DDLoggedTypeTraits<TYPE>                                              \
  {                                                                            \
    using Type = TYPE;                                                         \
    static constexpr const char* Name() { return #NAME; }                      \
    using HasBase = FalseType;                                                 \
    using BaseType = TYPE;                                                     \
    static constexpr const char* BaseTypeName() { return ""; }                 \
  }

#define DDLoggedTypeCustomNameAndBase(TYPE, NAME, BASE)                        \
  template<>                                                                   \
  struct DDLoggedTypeTraits<TYPE>                                              \
  {                                                                            \
    using Type = TYPE;                                                         \
    static constexpr const char* Name() { return #NAME; }                      \
    using HasBase = TrueType;                                                  \
    using BaseType = BASE;                                                     \
    static constexpr const char* BaseTypeName()                                \
    {                                                                          \
      return DDLoggedTypeTraits<BASE>::Name();                                 \
    }                                                                          \
  }

// Variants with built-in forward-declaration, will only work
// - in mozilla namespace,
// - with unqualified mozilla-namespace type names.
#define DDLoggedTypeDeclName(TYPE)                                             \
  class TYPE;                                                                  \
  DDLoggedTypeName(TYPE);
#define DDLoggedTypeDeclNameAndBase(TYPE, BASE)                                \
  class TYPE;                                                                  \
  DDLoggedTypeNameAndBase(TYPE, BASE);
#define DDLoggedTypeDeclCustomName(TYPE, NAME)                                 \
  class TYPE;                                                                  \
  DDLoggedTypeCustomName(TYPE, NAME);
#define DDLoggedTypeDeclCustomNameAndBase(TYPE, NAME, BASE)                    \
  class TYPE;                                                                  \
  DDLoggedTypeCustomNameAndBase(TYPE, NAME, BASE);

} // namespace mozilla

// Some essential types that live outside of the media stack.
class nsIDocument;
class nsPIDOMWindowInner;
class nsPIDOMWindowOuter;

namespace mozilla {

namespace dom {
class HTMLAudioElement;
class HTMLMediaElement;
class HTMLVideoElement;
} // namespace (mozilla/)dom

DDLoggedTypeName(nsIDocument);
DDLoggedTypeName(nsPIDOMWindowInner);
DDLoggedTypeName(nsPIDOMWindowOuter);
DDLoggedTypeName(dom::HTMLMediaElement);
DDLoggedTypeNameAndBase(dom::HTMLAudioElement, dom::HTMLMediaElement);
DDLoggedTypeNameAndBase(dom::HTMLVideoElement, dom::HTMLMediaElement);

} // namespace mozilla

#endif // DDLoggedTypeTraits_h_