LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SystemUtils.h
Go to the documentation of this file.
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 #include <string>
19 
20 namespace llvm {
21  class raw_ostream;
22 
23 /// Determine if the raw_ostream provided is connected to a terminal. If so,
24 /// generate a warning message to errs() advising against display of bitcode
25 /// and return true. Otherwise just return false.
26 /// @brief Check for output written to a console
28  raw_ostream &stream_to_check, ///< The stream to be checked
29  bool print_warning = true ///< Control whether warnings are printed
30 );
31 
32 } // End llvm namespace
33 
34 #endif
bool CheckBitcodeOutputToConsole(raw_ostream &stream_to_check, bool print_warning=true)
Check for output written to a console.
Definition: SystemUtils.cpp:21