//===- swift/Basic/Program.h ------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_BASIC_PROGRAM_H
#define SWIFT_BASIC_PROGRAM_H

namespace swift {

/// \brief This function executes the program using the arguments provided,
/// preferring to reexecute the current process, if supported.
///
/// \param Program Path of the program to be executed
/// \param 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.
/// \param env An optional vector of strings to use for the program's
/// environment. If not provided, the current program's environment will be
/// used.
///
/// \returns If this process was reexecuted as the given program, this function
/// will not return. Otherwise, -1 indicates a failure to execute, and other
/// values are the result code of the program.
///
/// \note If the current process cannot be reexecuted as the given program,
/// this function will defer to \ref llvm::sys::ExecuteAndWait(), so callers
/// must be prepared to resume normal execution if this function returns a
/// non-negative value.
int ExecuteInPlace(const char *Program, const char **args,
                   const char **env = nullptr);

} // end namespace swift

#endif