LLVM API Documentation

SystemUtils.h
Go to the documentation of this file.
00001 //===- SystemUtils.h - Utilities to do low-level system stuff ---*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file contains functions used to do a variety of low-level, often
00011 // system-specific, tasks.
00012 //
00013 //===----------------------------------------------------------------------===//
00014 
00015 #ifndef LLVM_SUPPORT_SYSTEMUTILS_H
00016 #define LLVM_SUPPORT_SYSTEMUTILS_H
00017 
00018 #include <string>
00019 
00020 namespace llvm {
00021   class raw_ostream;
00022 
00023 /// Determine if the raw_ostream provided is connected to a terminal. If so,
00024 /// generate a warning message to errs() advising against display of bitcode
00025 /// and return true. Otherwise just return false.
00026 /// @brief Check for output written to a console
00027 bool CheckBitcodeOutputToConsole(
00028   raw_ostream &stream_to_check, ///< The stream to be checked
00029   bool print_warning = true     ///< Control whether warnings are printed
00030 );
00031 
00032 } // End llvm namespace
00033 
00034 #endif