c170d6167f
If a process is running under control of winpty, the output of the process is decorated with ESC sequences to control a terminal to print the process output nicely. In some environments however, the client showing the output to the user is not a full terminal emulation, the Eclipse CDT debug console view in example, and the ESC sequences are printed as output additional to the real process output. This commit is adding an API function to switch into a mode where winpty is not decorating the process output with ESC sequences. The console mode is designated to pass on the process output to the client as is.
109 lines
3.2 KiB
C
109 lines
3.2 KiB
C
/*
|
|
* Copyright (c) 2011-2012 Ryan Prichard
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef WINPTY_H
|
|
#define WINPTY_H
|
|
|
|
#include <stdlib.h>
|
|
#include <windows.h>
|
|
|
|
#ifdef WINPTY
|
|
#define WINPTY_API __declspec(dllexport)
|
|
#else
|
|
#define WINPTY_API __declspec(dllimport)
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct winpty_s winpty_t;
|
|
|
|
/*
|
|
* winpty API.
|
|
*/
|
|
|
|
/*
|
|
* Starts a new winpty instance with the given size.
|
|
*
|
|
* This function creates a new agent process and connects to it.
|
|
*/
|
|
WINPTY_API winpty_t *winpty_open(int cols, int rows);
|
|
|
|
/*
|
|
* Start a child process. Either (but not both) of appname and cmdline may
|
|
* be NULL. cwd and env may be NULL. env is a pointer to an environment
|
|
* block like that passed to CreateProcess.
|
|
*
|
|
* This function never modifies the cmdline, unlike CreateProcess.
|
|
*
|
|
* Only one child process may be started. After the child process exits, the
|
|
* agent will scrape the console output one last time, then close the data pipe
|
|
* once all remaining data has been sent.
|
|
*
|
|
* Returns 0 on success or a Win32 error code on failure.
|
|
*/
|
|
WINPTY_API int winpty_start_process(winpty_t *pc,
|
|
const wchar_t *appname,
|
|
const wchar_t *cmdline,
|
|
const wchar_t *cwd,
|
|
const wchar_t *env);
|
|
|
|
/*
|
|
* Returns the exit code of the process started with winpty_start_process,
|
|
* or -1 none is available.
|
|
*/
|
|
WINPTY_API int winpty_get_exit_code(winpty_t *pc);
|
|
|
|
/*
|
|
* Returns the process id of the process started with winpty_start_process,
|
|
* or -1 none is available.
|
|
*/
|
|
WINPTY_API int winpty_get_process_id(winpty_t *pc);
|
|
|
|
/*
|
|
* Returns an overlapped-mode pipe handle that can be read and written
|
|
* like a Unix terminal.
|
|
*/
|
|
WINPTY_API HANDLE winpty_get_data_pipe(winpty_t *pc);
|
|
|
|
/*
|
|
* Change the size of the Windows console.
|
|
*/
|
|
WINPTY_API int winpty_set_size(winpty_t *pc, int cols, int rows);
|
|
|
|
/*
|
|
* Toggle the console mode. If in console mode, no terminal escape sequences are send.
|
|
*/
|
|
WINPTY_API int winpty_set_console_mode(winpty_t *pc, int mode);
|
|
|
|
/*
|
|
* Closes the winpty.
|
|
*/
|
|
WINPTY_API void winpty_close(winpty_t *pc);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* WINPTY_H */
|