Allow specifying conpty PSEUDOCONSOLE_INHERIT_CURSOR

src/native.d.ts

@@ -3,7 +3,7 @@
  */
 
 interface IConptyNative {
-  startProcess(file: string, cols: number, rows: number, debug: boolean, pipeName: string): IConptyProcess;
+  startProcess(file: string, cols: number, rows: number, debug: boolean, pipeName: string, conptyInheritCursor: boolean): IConptyProcess;
   connect(ptyId: number, commandLine: string, cwd: string, env: string[], onExitCallback: (exitCode: number) => void): { pid: number };
   resize(ptyId: number, cols: number, rows: number): void;
   kill(ptyId: number): void;

src/win/conpty.cc

@@ -160,13 +160,14 @@ static NAN_METHOD(PtyStartProcess) {
   std::unique_ptr<wchar_t[]> mutableCommandline;
   PROCESS_INFORMATION _piClient{};
 
-  if (info.Length() != 5 ||
+  if (info.Length() != 6 ||
       !info[0]->IsString() ||
       !info[1]->IsNumber() ||
       !info[2]->IsNumber() ||
       !info[3]->IsBoolean() ||
-      !info[4]->IsString()) {
-    Nan::ThrowError("Usage: pty.startProcess(file, cols, rows, debug, pipeName)");
+      !info[4]->IsString() ||
+      !info[5]->IsBoolean()) {
+    Nan::ThrowError("Usage: pty.startProcess(file, cols, rows, debug, pipeName, inheritCursor)");
     return;
   }
 
@@ -175,6 +176,7 @@ static NAN_METHOD(PtyStartProcess) {
   const SHORT rows = info[2]->Uint32Value(Nan::GetCurrentContext()).FromJust();
   const bool debug = info[3]->ToBoolean(Nan::GetCurrentContext()).ToLocalChecked()->IsTrue();
   const std::wstring pipeName(path_util::to_wstring(Nan::Utf8String(info[4])));
+  const bool inheritCursor = info[5]->ToBoolean(Nan::GetCurrentContext()).ToLocalChecked()->IsTrue();
 
   // use environment 'Path' variable to determine location of
   // the relative path that we have recieved (e.g cmd.exe)
@@ -196,7 +198,7 @@ static NAN_METHOD(PtyStartProcess) {
 
   HANDLE hIn, hOut;
   HPCON hpc;
-  HRESULT hr = CreateNamedPipesAndPseudoConsole({cols, rows}, 0, &hIn, &hOut, &hpc, inName, outName, pipeName);
+  HRESULT hr = CreateNamedPipesAndPseudoConsole({cols, rows}, inheritCursor ? 1/*PSEUDOCONSOLE_INHERIT_CURSOR*/ : 0, &hIn, &hOut, &hpc, inName, outName, pipeName);
 
   // Restore default handling of ctrl+c
   SetConsoleCtrlHandler(NULL, FALSE);

src/windowsPtyAgent.ts

@@ -51,7 +51,8 @@ export class WindowsPtyAgent {
     cols: number,
     rows: number,
     debug: boolean,
-    private _useConpty: boolean | undefined
+    private _useConpty: boolean | undefined,
+    conptyInheritCursor: boolean = false
   ) {
     if (this._useConpty === undefined || this._useConpty === true) {
       this._useConpty = this._getWindowsBuildNumber() >= 18309;
@@ -84,7 +85,7 @@ export class WindowsPtyAgent {
     // Open pty session.
     let term: IConptyProcess | IWinptyProcess;
     if (this._useConpty) {
-      term = (this._ptyNative as IConptyNative).startProcess(file, cols, rows, debug, this._generatePipeName());
+      term = (this._ptyNative as IConptyNative).startProcess(file, cols, rows, debug, this._generatePipeName(), conptyInheritCursor);
     } else {
       term = (this._ptyNative as IWinptyNative).startProcess(file, commandLine, env, cwd, cols, rows, debug);
       this._pid = (term as IWinptyProcess).pid;

src/windowsTerminal.ts

@@ -10,6 +10,7 @@ import { WindowsPtyAgent } from './windowsPtyAgent';
 import { IPtyForkOptions, IPtyOpenOptions } from './interfaces';
 import { ArgvOrCommandLine } from './types';
 import { assign } from './utils';
+import { IWindowsPtyForkOptions } from 'node-pty';
 
 const DEFAULT_FILE = 'cmd.exe';
 const DEFAULT_NAME = 'Windows Shell';
@@ -19,7 +20,7 @@ export class WindowsTerminal extends Terminal {
   private _deferreds: any[];
   private _agent: WindowsPtyAgent;
 
-  constructor(file?: string, args?: ArgvOrCommandLine, opt?: IPtyForkOptions) {
+  constructor(file?: string, args?: ArgvOrCommandLine, opt?: IWindowsPtyForkOptions) {
     super(opt);
 
     // Initialize arguments
@@ -46,7 +47,7 @@ export class WindowsTerminal extends Terminal {
     this._deferreds = [];
 
     // Create new termal.
-    this._agent = new WindowsPtyAgent(file, args, parsedEnv, cwd, this._cols, this._rows, false, opt.experimentalUseConpty);
+    this._agent = new WindowsPtyAgent(file, args, parsedEnv, cwd, this._cols, this._rows, false, opt.experimentalUseConpty, opt.conptyInheritCursor);
     this._socket = this._agent.outSocket;
 
     // Not available until `ready` event emitted.

typings/node-pty.d.ts

@@ -15,7 +15,7 @@ declare module 'node-pty' {
    * @see Parsing C++ Comamnd-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
    * @see GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
    */
-  export function spawn(file: string, args: string[] | string, options: IPtyForkOptions): IPty;
+  export function spawn(file: string, args: string[] | string, options: IPtyForkOptions | IWindowsPtyForkOptions): IPty;
 
   export interface IPtyForkOptions {
     name?: string;
@@ -26,6 +26,15 @@ declare module 'node-pty' {
     uid?: number;
     gid?: number;
     encoding?: string;
+  }
+
+  export interface IWindowsPtyForkOptions {
+    name?: string;
+    cols?: number;
+    rows?: number;
+    cwd?: string;
+    env?: { [key: string]: string };
+    encoding?: string;
     /**
      * Whether to use the experimental ConPTY system on Windows. When this is not set, ConPTY will
      * be used when the Windows build number is >= 18309 (it's available in 17134 and 17692 but is
@@ -34,6 +43,11 @@ declare module 'node-pty' {
      * This setting does nothing on non-Windows.
      */
     experimentalUseConpty?: boolean;
+    /**
+     * Whether to use PSEUDOCONSOLE_INHERIT_CURSOR in conpty.
+     * @see https://docs.microsoft.com/en-us/windows/console/createpseudoconsole
+     */
+    conptyInheritCursor?: boolean;
   }
 
   /**