mfbt/Unused.h
author Mathijs Henquet <mathijs.henquet@gmail.com>
Mon, 14 Jan 2019 15:38:59 +0000
changeset 453746 42961555f63beaffc1f6ac94c5a8774a848a3daf
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1519536 - Remove rustdoc of removed argument. r=kvark Depends on D16359 Differential Revision: https://phabricator.services.mozilla.com/D16360

/* -*- 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 mozilla_unused_h
#define mozilla_unused_h

#include "mozilla/Attributes.h"
#include "mozilla/Types.h"

#ifdef __cplusplus

namespace mozilla {

//
// Suppress GCC warnings about unused return values with
//   Unused << SomeFuncDeclaredWarnUnusedReturnValue();
//
struct unused_t {
  template <typename T>
  MOZ_ALWAYS_INLINE_EVEN_DEBUG void operator<<(const T& /*unused*/) const {}
};

extern MFBT_DATA const unused_t Unused;

}  // namespace mozilla

#endif  // __cplusplus

// An alternative to mozilla::Unused for use in (a) C code and (b) code where
// linking with unused.o is difficult.
#define MOZ_UNUSED(expr) \
  do {                   \
    if (expr) {          \
      (void)0;           \
    }                    \
  } while (0)

#endif  // mozilla_unused_h