Reapply r73647 in a non-broken form.

[oota-llvm.git] / include / llvm / System / Program.h

diff --git a/include/llvm/System/Program.h b/include/llvm/System/Program.h
index a0e0f8c2b6922e5c9f798e26e1bc349f63f9a4d9..37f55466a50d717b5dc51ac7050b503d7a8a6eea 100644 (file)
--- a/include/llvm/System/Program.h
+++ b/include/llvm/System/Program.h
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer and is distributed under the
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -15,7 +15,6 @@
 #define LLVM_SYSTEM_PROGRAM_H
 
 #include "llvm/System/Path.h"
-#include <vector>
 
 namespace llvm {
 namespace sys {
@@ -46,16 +45,15 @@ namespace sys {
       /// environment and other configuration settings of the invoking program.
       /// If Path::executable() does not return true when this function is
       /// called then a std::string is thrown.
-      /// @param path A sys::Path object providing the path of the program to be
-      /// executed. It is presumed this is the result of the FindProgramByName
-      /// method.
       /// @returns an integer result code indicating the status of the program.
-      /// @throws std::string on a variety of error conditions or if the invoked
-      /// program aborted abnormally.
+      /// A zero or positive value indicates the result code of the program. A
+      /// negative value is the signal number on which it terminated.
       /// @see FindProgrambyName
       /// @brief Executes the program with the given set of \p args.
       static int ExecuteAndWait(
-        const Path& path,  ///< The path to the program to execute
+        const Path& path,  ///< sys::Path object providing the path of the
+          ///< program to be executed. It is presumed this is the result of
+          ///< the FindProgramByName method.
         const char** args, ///< A vector of strings that are passed to the
           ///< program.  The first element should be the name of the program.
           ///< The list *must* be terminated by a null char* entry.
@@ -67,16 +65,30 @@ namespace sys {
           ///< should have a size of at least three. If the pointer in the array
           ///< are not null, then the inferior process's stdin(0), stdout(1),
           ///< and stderr(2) will be redirected to the corresponding Paths.
-        unsigned secondsToWait = 0 ///< If non-zero, this specifies the amount
+          ///< When an empty Path is passed in, the corresponding file
+          ///< descriptor will be disconnected (ie, /dev/null'd) in a portable
+          ///< way.
+        unsigned secondsToWait = 0, ///< If non-zero, this specifies the amount
           ///< of time to wait for the child process to exit. If the time
           ///< expires, the child is killed and this call returns. If zero,
           ///< this function will wait until the child finishes or forever if
           ///< it doesn't.
+        unsigned memoryLimit = 0, ///< If non-zero, this specifies max. amount
+          ///< of memory can be allocated by process. If memory usage will be
+          ///< higher limit, the child is killed and this call returns. If zero
+          ///< - no memory limit.
+        std::string* ErrMsg = 0 ///< If non-zero, provides a pointer to a string
+          ///< instance in which error messages will be returned. If the string
+          ///< is non-empty upon return an error occurred while invoking the
+          ///< program.
       );
+      // These methods change the specified standard stream (stdin or stdout) to
+      // binary mode. They return true if an error occurred
+      static bool ChangeStdinToBinary();
+      static bool ChangeStdoutToBinary();
+    /// @}
   };
 }
 }
 
-// vim: sw=2
-
 #endif