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 #include <string>
  19
  20 namespace llvm {
  21   class raw_ostream;
  22   namespace sys { class Path; }
  23
  24 /// Determine if the raw_ostream provided is connected to the outs() and
  25 /// displayed or not (to a console window). If so, generate a warning message
  26 /// advising against display of bitcode and return true. Otherwise just return
  27 /// false
  28 /// @brief Check for output written to a console
  29 bool CheckBitcodeOutputToConsole(
  30   raw_ostream &stream_to_check, ///< The stream to be checked
  31   bool print_warning = true     ///< Control whether warnings are printed
  32 );
  33
  34 /// FindExecutable - Find a named executable, giving the argv[0] of program
  35 /// being executed. This allows us to find another LLVM tool if it is built in
  36 /// the same directory.  If the executable cannot be found, return an
  37 /// empty string.
  38 /// @brief Find a named executable.
  39 sys::Path FindExecutable(const std::string &ExeName,
  40                          const char *Argv0, void *MainAddr);
  41
  42 } // End llvm namespace
  43
  44 #endif