Files
Terminal.Gui/Terminal.Gui/ConsoleDrivers/CursesDriver/ClipboardImpl.cs
Tig 0df485a890 Fixes #666. Refactor ConsoleDrivers to simplify and remove duplicated code (#2612)
* Added ClipRegion; cleaned up driver code

* clip region unit tests

* api docs

* Moved color stuff from ConsoleDriver to Color.cs

* Removes unused ConsoleDriver APIs

* Code cleanup and Removes unused ConsoleDriver APIs

* Code cleanup and Removes unused ConsoleDriver APIs

* Work around https://github.com/gui-cs/Terminal.Gui/issues/2610

* adjusted unit tests

* initial commit

* Made Rows, Cols, Top, Left virtual

* Made Clipboard non-virtual

* Made EnableConsoleScrolling  non-virtual

* Made Contents non-virtual

* Pulled Row/Col up

* Made MoveTo virtual; fixed stupid FakeDriver cursor issue

* Made CurrentAttribute non-virtual

* Made SetAttribute  non-virtual

* Moved clipboard code out

* Code cleanup

* Removes dependecy on NStack from ConsoleDrivers - WIP

* Fixed unit tests

* Fixed unit tests

* Added list of unit tests needed

* Did some perf testing; tweaked code and charmap to address

* Brough in code from PR #2264 (but commented)

* Tons of code cleanup

* Fighting with ScrollView

* Fixing bugs

* Fixed TabView tests

* Fixed View.Visible test that was not really working

* Fixed unit tests

* Cleaned up clipboard APIs in attempt to track down unit test failure

* Add Cut_Preserves_Selection test

* Removed invalid code

* Removed invalid test code; unit tests now pass

* EscSeq* - Adjusted naming, added more sequences, made code more consistent, simplified, etc...

* Added CSI_SetGraphicsRendition

* NetDriver code cleanup

* code cleanup

* Cleaned up color handling in NetDriver

* refixed tabview unit test

* WindowsDriver color code cleanup

* WindowsDriver color code cleanup

* CursesDriver color code cleanup

* CursesDriver - Adding _BOLD has no effect. Further up the stack we cast the return of ColorToCursesColor from int to short and the _BOLD values don't fit in a short.

* CursesDriver color code - make code more accurate

* CursesDriver color code - make code more accurate

* Simplified ConsoleDriver.GetColors API

* Simplified ConsoleDriver.GetColors API further

* Improved encapslation of Attribute; prep for TrueColor & other attributes like blink

* Fixes #2249. CharacterMap isn't refreshing well non-BMP code points on scroll.

* Use GetRange to take some of the runes before convert to string.

* Attempting to fix unit tests not being cleaned up

* Fixes #2658 - ConsoleDriver.IsRuneSupported

* Fixes #2658 - ConsoleDriver.IsRuneSupported (for WindowsDriver)

* Check all the range values and not only the max value.

* Reducing code.

* Fixes #2674 - Unit test process doesn't exit

* Changed Cell to support IsDirty and list of Runes

* add support for rendering TrueColor output on Windows merging veeman & tznind code

* add colorconverter changes

* fixed merged v2_develop

* Fixing merge bugs

* Fixed merge bugs

* Fixed merge bugs - all unit tests pass

* Debugging netdriver

* More netdriver diag

* API docs for escutils

* Update unicode scenario to stress more stuff

* Contents: Now a 2D array of Cells; WIP

* AddRune and ClearContents no longer virtual/abstract

* WindowsDriver renders correctly again

* Progress on Curses

* Progress on Curses

* broke windowsdriver

* Cleaned up FakeMainLoop

* Cleaned up some build warnings

* Removed _init from AutoInitShutdown as it's not needed anymore

* Removed unused var

* Removed unused var

* Fixed nullabiltiy warning in LineCanvas

* Fixed charmap crash

* Fixes #2758 in v2

* Port testonfail fix to v2

* Remove EnableConsoleScrolling

* Backport #2764 from develop (clear last line)

* Remove uneeded usings

* Progress on unicode

* Merged in changes from PR #2786, Fixes #2784

* revamp charmap rendering

* Charmap option to show glyph widths

* Fixed issue with wide glpyhs being overwritten

* Fixed charmap startcodepoint change issue

* Added abiltiy to see ncurses verison/lib

* Fought with CursesDriver; giving up for now. See notes.

* Leverage Wcwidth nuget library instaed of our own tables

* enhanced charmap Details dialog

* Final attempt at fixing curses

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
Co-authored-by: adstep <stephensonadamj@gmail.com>
2023-08-09 14:28:36 -06:00

226 lines
7.1 KiB
C#

using System;
using System.Runtime.InteropServices;
using Unix.Terminal;
namespace Terminal.Gui;
/// <summary>
/// A clipboard implementation for Linux.
/// This implementation uses the xclip command to access the clipboard.
/// </summary>
/// <remarks>
/// If xclip is not installed, this implementation will not work.
/// </remarks>
class CursesClipboard : ClipboardBase {
public CursesClipboard ()
{
IsSupported = CheckSupport ();
}
string _xclipPath = string.Empty;
public override bool IsSupported { get; }
bool CheckSupport ()
{
#pragma warning disable RCS1075 // Avoid empty catch clause that catches System.Exception.
try {
var (exitCode, result) = ClipboardProcessRunner.Bash ("which xclip", waitForOutput: true);
if (exitCode == 0 && result.FileExists ()) {
_xclipPath = result;
return true;
}
} catch (Exception) {
// Permissions issue.
}
#pragma warning restore RCS1075 // Avoid empty catch clause that catches System.Exception.
return false;
}
protected override string GetClipboardDataImpl ()
{
var tempFileName = System.IO.Path.GetTempFileName ();
var xclipargs = "-selection clipboard -o";
try {
var (exitCode, result) = ClipboardProcessRunner.Bash ($"{_xclipPath} {xclipargs} > {tempFileName}", waitForOutput: false);
if (exitCode == 0) {
if (Application.Driver is CursesDriver) {
Curses.raw ();
Curses.noecho ();
}
return System.IO.File.ReadAllText (tempFileName);
}
} catch (Exception e) {
throw new NotSupportedException ($"\"{_xclipPath} {xclipargs}\" failed.", e);
} finally {
System.IO.File.Delete (tempFileName);
}
return string.Empty;
}
protected override void SetClipboardDataImpl (string text)
{
var xclipargs = "-selection clipboard -i";
try {
var (exitCode, _) = ClipboardProcessRunner.Bash ($"{_xclipPath} {xclipargs}", text, waitForOutput: false);
if (exitCode == 0 && Application.Driver is CursesDriver) {
Curses.raw ();
Curses.noecho ();
}
} catch (Exception e) {
throw new NotSupportedException ($"\"{_xclipPath} {xclipargs} < {text}\" failed", e);
}
}
}
/// <summary>
/// A clipboard implementation for MacOSX.
/// This implementation uses the Mac clipboard API (via P/Invoke) to copy/paste.
/// The existance of the Mac pbcopy and pbpaste commands
/// is used to determine if copy/paste is supported.
/// </summary>
class MacOSXClipboard : ClipboardBase {
IntPtr _nsString = objc_getClass ("NSString");
IntPtr _nsPasteboard = objc_getClass ("NSPasteboard");
IntPtr _utfTextType;
IntPtr _generalPasteboard;
IntPtr _initWithUtf8Register = sel_registerName ("initWithUTF8String:");
IntPtr _allocRegister = sel_registerName ("alloc");
IntPtr _setStringRegister = sel_registerName ("setString:forType:");
IntPtr _stringForTypeRegister = sel_registerName ("stringForType:");
IntPtr _utf8Register = sel_registerName ("UTF8String");
IntPtr _nsStringPboardType;
IntPtr _generalPasteboardRegister = sel_registerName ("generalPasteboard");
IntPtr _clearContentsRegister = sel_registerName ("clearContents");
public MacOSXClipboard ()
{
_utfTextType = objc_msgSend (objc_msgSend (_nsString, _allocRegister), _initWithUtf8Register, "public.utf8-plain-text");
_nsStringPboardType = objc_msgSend (objc_msgSend (_nsString, _allocRegister), _initWithUtf8Register, "NSStringPboardType");
_generalPasteboard = objc_msgSend (_nsPasteboard, _generalPasteboardRegister);
IsSupported = CheckSupport ();
}
public override bool IsSupported { get; }
bool CheckSupport ()
{
var (exitCode, result) = ClipboardProcessRunner.Bash ("which pbcopy", waitForOutput: true);
if (exitCode != 0 || !result.FileExists ()) {
return false;
}
(exitCode, result) = ClipboardProcessRunner.Bash ("which pbpaste", waitForOutput: true);
return exitCode == 0 && result.FileExists ();
}
protected override string GetClipboardDataImpl ()
{
var ptr = objc_msgSend (_generalPasteboard, _stringForTypeRegister, _nsStringPboardType);
var charArray = objc_msgSend (ptr, _utf8Register);
return Marshal.PtrToStringAnsi (charArray);
}
protected override void SetClipboardDataImpl (string text)
{
IntPtr str = default;
try {
str = objc_msgSend (objc_msgSend (_nsString, _allocRegister), _initWithUtf8Register, text);
objc_msgSend (_generalPasteboard, _clearContentsRegister);
objc_msgSend (_generalPasteboard, _setStringRegister, str, _utfTextType);
} finally {
if (str != default) {
objc_msgSend (str, sel_registerName ("release"));
}
}
}
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr objc_getClass (string className);
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr objc_msgSend (IntPtr receiver, IntPtr selector);
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr objc_msgSend (IntPtr receiver, IntPtr selector, string arg1);
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr objc_msgSend (IntPtr receiver, IntPtr selector, IntPtr arg1);
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr objc_msgSend (IntPtr receiver, IntPtr selector, IntPtr arg1, IntPtr arg2);
[DllImport ("/System/Library/Frameworks/AppKit.framework/AppKit")]
static extern IntPtr sel_registerName (string selectorName);
}
/// <summary>
/// A clipboard implementation for Linux, when running under WSL.
/// This implementation uses the Windows clipboard to store the data, and uses Windows'
/// powershell.exe (launched via WSL interop services) to set/get the Windows
/// clipboard.
/// </summary>
class WSLClipboard : ClipboardBase {
public WSLClipboard ()
{
}
public override bool IsSupported {
get {
return CheckSupport ();
}
}
private static string _powershellPath = string.Empty;
bool CheckSupport ()
{
if (string.IsNullOrEmpty (_powershellPath)) {
// Specify pwsh.exe (not pwsh) to ensure we get the Windows version (invoked via WSL)
var (exitCode, result) = ClipboardProcessRunner.Bash ("which pwsh.exe", waitForOutput: true);
if (exitCode > 0) {
(exitCode, result) = ClipboardProcessRunner.Bash ("which powershell.exe", waitForOutput: true);
}
if (exitCode == 0) {
_powershellPath = result;
}
}
return !string.IsNullOrEmpty (_powershellPath);
}
protected override string GetClipboardDataImpl ()
{
if (!IsSupported) {
return string.Empty;
}
var (exitCode, output) = ClipboardProcessRunner.Process (_powershellPath, "-noprofile -command \"Get-Clipboard\"");
if (exitCode == 0) {
if (Application.Driver is CursesDriver) {
Curses.raw ();
Curses.noecho ();
}
if (output.EndsWith ("\r\n")) {
output = output.Substring (0, output.Length - 2);
}
return output;
}
return string.Empty;
}
protected override void SetClipboardDataImpl (string text)
{
if (!IsSupported) {
return;
}
var (exitCode, output) = ClipboardProcessRunner.Process (_powershellPath, $"-noprofile -command \"Set-Clipboard -Value \\\"{text}\\\"\"");
if (exitCode == 0) {
if (Application.Driver is CursesDriver) {
Curses.raw ();
Curses.noecho ();
}
}
}
}