layout/base/LayoutLogging.h
author shindli <shindli@mozilla.com>
Sun, 21 Jan 2018 23:57:26 +0200
changeset 400156 5faab9e619901b1513fd4ca137747231be550def
parent 388790 905239391e05483e8fb221378dd2092c5a0df8b7
child 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Merge inbound to mozilla-central. a=merge

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 LayoutLogging_h
#define LayoutLogging_h

#include "mozilla/Logging.h"

/**
 * Retrieves the log module to use for layout logging.
 */
static mozilla::LazyLogModule sLayoutLog("layout");

/**
 * Use the layout log to warn if a given condition is false.
 *
 * This is only enabled in debug builds and the logging is only displayed if
 * the environmental variable MOZ_LOG includes "layout:2" (or higher).
 */
#ifdef DEBUG
#define LAYOUT_WARN_IF_FALSE(_cond, _msg)                                  \
  PR_BEGIN_MACRO                                                           \
    if (MOZ_LOG_TEST(sLayoutLog, mozilla::LogLevel::Warning) &&        \
        !(_cond)) {                                                        \
      mozilla::detail::LayoutLogWarning(_msg, #_cond, __FILE__, __LINE__); \
    }                                                                      \
  PR_END_MACRO
#else
#define LAYOUT_WARN_IF_FALSE(_cond, _msg) \
  PR_BEGIN_MACRO                          \
  PR_END_MACRO
#endif

/**
 * Use the layout log to emit a warning with the same format as NS_WARNING.
 *
 * This is only enabled in debug builds and the logging is only displayed if
 * the environmental variable MOZ_LOG includes "layout:2" (or higher).
 */
#ifdef DEBUG
#define LAYOUT_WARNING(_msg)                                                \
  PR_BEGIN_MACRO                                                            \
    if (MOZ_LOG_TEST(sLayoutLog, mozilla::LogLevel::Warning)) {         \
      mozilla::detail::LayoutLogWarning(_msg, nullptr, __FILE__, __LINE__); \
    }                                                                       \
  PR_END_MACRO
#else
#define LAYOUT_WARNING(_msg) \
  PR_BEGIN_MACRO             \
  PR_END_MACRO
#endif

namespace mozilla {
namespace detail {

void LayoutLogWarning(const char* aStr, const char* aExpr,
                      const char* aFile, int32_t aLine);

} // namespace detail
} // namespace mozilla

#endif // LayoutLogging_h