[llvm-profdata] Add SaturatingAdd/SaturatingMultiply Helper Functions
[oota-llvm.git] / include / llvm / Support / SystemUtils.h
1 //===- SystemUtils.h - Utilities to do low-level system stuff ---*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains functions used to do a variety of low-level, often
11 // system-specific, tasks.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_SUPPORT_SYSTEMUTILS_H
16 #define LLVM_SUPPORT_SYSTEMUTILS_H
17
18 namespace llvm {
19   class raw_ostream;
20
21 /// Determine if the raw_ostream provided is connected to a terminal. If so,
22 /// generate a warning message to errs() advising against display of bitcode
23 /// and return true. Otherwise just return false.
24 /// @brief Check for output written to a console
25 bool CheckBitcodeOutputToConsole(
26   raw_ostream &stream_to_check, ///< The stream to be checked
27   bool print_warning = true     ///< Control whether warnings are printed
28 );
29
30 } // End llvm namespace
31
32 #endif