real    0m50.865s
user    0m0.015s
sys     0m6.776s

CPU:        AMD FX 6100 - Black Edition (Six-core processor)
Memory:     8 GiB, DDR-3 1800 Mhz
Storage:    128 Gib SSD, 1Tib HDD
Graphics:   AMD Radeon R7 240, 2GiB
Monitor:    LCD, HD (1080p)
OS/Kernel:  Arch/Linux 5.9 (x86_64)
Desktop:    GNOME 3.36 (X11)
Framework:  Ultimate++ 2020.1 (alpha)
Flags:      GUI
Compilers:  GCC 10.0.1 CLANG 10.0.0
Application: TerminalExample (with a high througput loop).

Disclaimer: The benchmarks below do not represent any competition.  
            they don't represent any weak spots of the used terminals.
            The sole purpose of these benchmarks is to give an idea as to where
            the Terminal ctrl's "engine" performance stands ATM.

Note: All benchmarks are repeated 50 times, automatically.
      The performance difference between GCC/CLANG builds is negligeable.
      The latest stable versions of these terminals are used (as of May-June 2020).

Results of command: "time find /usr", Total files: 415897, page size: 237 x 55, Monospace Font)

Terminal Emulator                  real         user        sys        Notes
-----------------                 ----------   ----------   ---------- ----------
Alacritty                         0m3,776s     0m1,134s     0m2,637s   Scrollback buffer size: 64k
Terminal ctrl                     0m4,126s     0m1,202s     0m2,466s   Scrollback buffer size: 64k
Kitty                             0m5,608s     0m1,224s     0m2,763s   Scrollback buffer size: 64k
Gnome Terminal                    0m6,785s     0m1,243s     0m3,015s   Scrollback buffer size: 64k
xterm                             0m24,368s    0m1,661s     0m3,766s   Scrollback buffer size: 64k

Terminal Emulator                  real         user        sys         Notes
-----------------                 ----------   ----------   ----------  ----------
Simple terminal (0.8)             0m3,791s     0m1,162s     0m2,533s    Has no scrollback buffer.
Terminal ctrl   (0.3)             0m3,971s     0m1,120s     0m2,472s    Scrollback disabled.

Terminal Emulator                  real         user        sys         Notes
-----------------                 ----------   ----------   ----------  ----------
Terminal ctrl   (0.3)             0m4,380s     0m1,479s     0m2,536s    localhost, Scrollback buffer size: 2000 lines, no compression, (SshTerminalExample is used)
PuTTY (0.73)                      0m40,828s    0m1,354s     0m3,071s    localhost, Scrollback buffer size: 2000 lines, no compression

// Vte-bench, benchmark 1: scrolling. page size: 237 x 55, Monospace Font.

Terminal Emulator                  real         user        sys        Notes
-----------------                 ----------   ----------   ---------- ----------
Alacritty                         0m1,936s     0m0,001s     0m0,946s
Kitty                             0m2,985s     0m0,000s     0m0,567s
Gnome Terminal                    0m3,758s     0m0,001s     0m0,940s
Terminal ctrl                     0m4,064s     0m0,000s     0m0,859s
Simple terminal (0.8)             0m4,623s     0m0,000s     0m1,105s 
xterm                             0m47,249s    0m0,000s     0m0,567s

// Vte-bench, benchmark 2: alt-screen-random-write, page size: 237 x 55, Monospace Font.

Terminal Emulator                  real         user        sys        Notes
-----------------                 ----------   ----------   ---------- ----------
Alacritty                         0m1,520s     0m0,000s     0m0,554snear-real-life,
Kitty                             0m2,750s     0m0,000s     0m0,408s
Gnome Terminal                    0m3,153s     0m0,004s     0m0,726s
Terminal ctrl                     0m3,790s     0m0,000s     0m0,474s
Simple terminal (0.8)             0m7,097s     0m0,001s     0m0,825s 
xterm                             0m19,797s    0m0,001s     0m0,993s

// Vte-bench, benchmark 3: scrolling-in-region, page size: 237 x 55, Monospace Font.

Terminal Emulator                  real         user        sys        Notes
-----------------                 ----------   ----------   ---------- ----------
Alacritty                         0m3,337s     0m0,001s     0m3,297s
Gnome Terminal                    0m5,280s     0m0,001s     0m3,254s
Kitty                             0m6,326s     0m0,001s     0m6,034s
Terminal ctrl                     0m6,739s     0m0,001s     0m4,033s
Simple terminal (0.8)             0m7,844s     0m0,001s     0m7,348s
xterm                             3m36,599s    0m0,001s     0m11,011s

HANDLE WinPtyCreateProcess(const char *cmdptr, const char *envptr, const char *cd, winpty_t* hConsole)
{
	Buffer<wchar> cmd, env;
	sCmdToUnicode(cmd, cmdptr);
	sEnvToUnicode(env, envptr);

	auto hSpawnConfig = winpty_spawn_config_new(
		WINPTY_SPAWN_FLAG_AUTO_SHUTDOWN,
		cmd,                          //error here
		nullptr,
		cd ? ~WString(cd) : nullptr,  //error here
		env,                          //error here
		nullptr);

C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (104): error: no matching function for call to 'winpty_spawn_config_new'
 (): auto hSpawnConfig = winpty_spawn_config_new
(
C:\upp\UppHub\TerminalCtrl\PtyProcess/lib/include/winpty.h (170): note: candidate function not viable: no known conversion from 'Buffer<Upp::wchar>' (aka 'Buffer<unsigned long>') to 'LPCWSTR' (aka 'const wchar_t *') for 2nd argument
 (): w
inpty_spawn_config_new(UINT64 spawnFlags,
 (): 1 error generated.

	auto hSpawnConfig = winpty_spawn_config_new(
		WINPTY_SPAWN_FLAG_AUTO_SHUTDOWN,
		(wchar_t *) ~cmd,
		nullptr,
		(wchar_t *) (cd ? ~WString(cd) : nullptr),
		(wchar_t *) ~env,
		nullptr);

C:/upp/out/UppHub/PtyProcess/CLANGx64.Debug.Debug_Full.Gui.Win10\PtyProcess$blitz.cpp (13): In file included from C:/upp/out/UppHub/PtyProcess/CLANGx64.Debug.Debug_Full.Gui.Win10\PtyProcess$blitz.cpp:13:
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (80): error: expected ')'
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (88): error: extraneous ')' before ';'
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (81): warning: left operand of comma operator has no effect [-Wunused-value]
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (82): warning: left operand of comma operator has no effect [-Wunused-value]
 (): nullptr
,
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (84): warning: left operand of comma operator has no effect [-Wunused-value]
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (87): warning: left operand of comma operator has no effect [-Wunused-value]
C:\upp\UppHub\TerminalCtrl\PtyProcess\Win32Pty.cpp (88): warning: expression result unused [-Wunused-value]

		while(IsOpen() && !tabs.IsEmpty()) {
			ProcessEvents();
			for(int i = 0; i < tabs.GetCount(); i++) {
				TerminalTab& tt = tabs[i];
/* Error here? --->*/		if(!tt.Do()) {
					tabbar.RemoveCtrl(tt);
					tabs.Remove(i);
					i--;
				}
			}
			Sleep(10);
		}

if(i && !tt.Do()) {

* C:\upp\out\UppHub\CLANGx64.Debug.Debug_Full.Gui.Win10\TerminalLayoutExample.exe 16.09.2022 07:37:46, user: peter

PtyProcess [WIN32]: Win32CreateProcess() failed.
PtyProcess [WIN32]: Couldn't set pty size!

1) PtyProcess can use two backends on Windows (for console process):

   a) winpty: This backend can be compiled and run on Win >= Vista.
              Requires the PtyAgent.exe to be present. This agent is a daemon that handles the win32 console stuff.
              The PtyAgent executable must be put into the same directory as the application using the PtyProces.
              PtyAgent can be found in TerminalCtrl/PtyAgent folder. It has to be separately compiled.
              This backend does not require U++ to be compiled with WIN10 flag.

   b) win10:  This backend uses the window 10 native pseudoconsole api. This api and relevant subsystem is added to
              windows with the later revisions of windows 10. Does not use or require winpty or Ptyagent.exe
              This backend requires U++ to be compiled with WIN10 flag.
 
2) Either of these backends can be used on windows version >= 10. Only winpty can be used on Windows version < 10

3) TerminalCtrl does not require PtyProcess. You can write your own. TerminalCtrl only expects data input.
   The source of the input is up to the user/developer. PtyPRocess is only a reference implementation,
   and provided with the Terminal packages as a default option.

4) To better test TerminalCtrl and PtyProcess in Windows, recommended demo case would be to install 
   the good old Far Manager (a text mode file manager you can find on the net). 

- Terminal lines are no longer truncated on window/terminal resize (when the new size is smaller than the old size).
- Size hint now has round edges.
- Programmable colors (reset) wrong index variable fixed.

It is now possible to override the application mouse tracking mode by using a configurable modifier key (ctrl, shift, alt and their combinations).

Custom highlighting support: Client code can now manipulate the visible terminal lines to add custom highlighting to TerminalCtrl.

TerminalCtrl has gained text search support. Client code can now add any type of custom text search method to TerminalCtrl. 

1) Selector Mode: TerminalCtrl now allows full keyboard navigation for selecting text in a special mode called "Selector Mode".
   At the moment, three types of selection are possible in this mode: text, rectangle, word.

2) Annotations:  This is a cool new feature. User or the hosted app can now add annotations to terminal texts (in both plain text and rich text (qtf) format).
   This can be done via user input (mouse, or keyboard in selector mode) or programatically (using a simple, proprietary protocol). AFAIK, this has been one of the most favored iterm2 features.

3) Word Selection filters: Word selection filter can now be set by the client code. It allows cell-level inspection, so it is even possible to select blocks of text ("words") according to their SGR attributes, associated data type, or colors.

4) Highlighting: TerminalCtrl allows full cell-level highlighting.

5) Shell integration: TerminalCtrl now allows hosted apps or shells to notify the terminal of the working directory, so the terminal can be aware of its environment (and act accordingly).

6) Configurable Keyboard shortcuts: Keyboard shortcuts are now configurable and can be redefined in client code.

OSC 9 ; 4 ; [state] ; [value] ST

1 - Running Doom in terminal emulator
2 - Navigating the open terminals, using the Navigator.
3 - Using the Finder to find text.
4 - Navigating through the open terminals using l/r keys.

- All PtyProcess classes are now derived from APtyProcess base class.
- On Windows, it is now possible to use both WinPty (as WinPtyProcess) and Windows console api (ConPtyProcess) at the same time
- On Linux the actual class is named as PosixPtyProcess.
- Existing code will work, since the PtyProcess is now an alias which designates PosixPtyProcess on *NIX systems, and depending on the WIN10 flag it designates either ConPty or WinPty. (Old behavior is kept.)
- Since they are all derived from the APtyProcess class, it is now possible to dynamically create and store them in the same container.

---

Requirements
- U++ >= 2024.1
- C++17

Customizability
- Custom Word/Cell Selection: Supports client-defined word selection via a filter. Selections can be based on text, SGR attributes, data types, or colors.
- Selector Mode: Introduced "Selector Mode" for keyboard navigation and text selection, supporting text, rectangle, line, and word selections. 
- Configurable keyboard Shortcuts: All shortcuts are made configurable and can be redefined in client code.
- Text Search: TerminalCtrl now have support for text search, including range-based and parallel (`CoFind`) search 
- Annotations: Users and hosted apps can now add annotations to terminal text (plain text or rich text via a simple protocol or menu).
- Custom Highlighting: Custom *cell-level* highlighting support.
- Application Mouse Tracking Override: Added the ability to override application mouse tracking with customizable modifier keys (Ctrl, Shift, Alt, and their combinations).
---

Protocols
- Directory Change Protocol: Implements the `OSC 7` and `OSC 9 ; 9`protocols to notify the terminal of the shell's working directory.
- Message Notification Protocol: Implements the `OSC 9 ; 2` message notification support.
- Progress Notification Protocol: Implements the `OSC 9 ; 4` protocol, used by modern terminal emulators, this protocol allows tracking of progress from hosted applications.
- iTerm2 Background Image Protocol: Implements iTerm2's background image change protocol.
  
---

Appearance
- Hyperlink Underline: Hyperlinks now switch to an under-dot pattern when using the underline attribute.
- Size Hint: The size hint now has rounded edges for better aesthetics.
  
---

Bug Fixes
- Mouse Reporting: Fixed mouse reporting bug.
- PC-Style Keys: Fixed the handling of HOME/END keys in PC-style mode.
- Stray Unicode Character: Fixed the Alt+Win key combination issue that produced stray Unicode characters.
- Background Transparency: Addressed transparency and background rendering issues.
- Selection on Resize: Selections are now cleared properly when resizing the terminal.

---

Performance Improvements
- Renderer Optimization: Refactored the renderer to combine non-contiguous characters, resulting in better performance
  
---

Behavior Changes
- Modifier Keys: `AltGr` and `Super` modifier keys no longer scroll the page.
- Page Scroll on Paste: The page now automatically scrolls to the bottom when pasting.
- Terminal Resize Behavior: Terminal lines are no longer truncated when resizing to a smaller window.

Code Maintenance
- Code Cleanup: Removed unused variables, redundant code.
- APtyProcess Base Class: 
  - All PtyProcess classes are now derived from APtyProcess.
  - On Linux, the active class is `PosixPtyProcess`.
  - On Windows, it can use either `WinPtyProcess` or `ConPtyProcess` based on system configuration.
  - This makes it possible to dynamically manage different PtyProcess types in a single container.

- Its API is virtually identical to SocketWaitEvent but for Pty processes.
- Provides a mechanism for waiting on multiple pseudoterminal (pty) processes to become ready for I/O operations.
- On windows it uses I/O Completion Ports (IOCP) to wait for events on process and pipe handles.
- On POSIX-compliant operating systems it uses the poll() system call to wait for events on pty/file descriptors
- On all platform this class effectively removes the  limitation of max 64 wait objects.

| Sequence                               | Description                                                         | Device Level |
| ---                                    | ---                                                                 | ---          |
|`OSC 133 ; [command] ST`                | Sets the semantic information, starting from the cursor position.   | Level 1      |

#### Notes

- `command` can be one of the following four values (case sensitive):
   - `A`: Marks the starting point of the shell prompt.
   - `B`: Marks the end of the shell prompt and the start of the user input.
   - `C`: Marks the end of the user input and the start of the command output.
   - `D`: Marks the end of the command output.

- TerminalCtrl currently supports only a minimal--but reasonable--subset of this protocol. This may change in the future.
- TerminalCtrl does not process or display semantic information by itself. Instead, it is up to the client code to make use of the protocol, typically in combination with features like cell highlighting or search functionality.

# What's Changed

## Requirements
- U++ 2025.1
- C++17

## Highlights

- `PtyWaitEvent` class added for proper event waiting across the supported platforms.
- `PtyProcess` class now  check for the dll version of ConPty first, to take advantage of the newest features and improvements.
- A subset of semantic information protocol (`OSC 133`) is implemented.
- Option to treat ambiguous width characters as wide characters.

## Changes and Fixes

TerminalCtrl: Semantic information protocol (OSC 133) (59c332c)
TerminalCtrl: Synchronized output feature detection. (7013fa8)
TerminalCtrl: VT mouse events are now ignored if the terminal is in read-only mode. (37bb880)
TerminalCtrl: Clipboard access protocol (write) is advertised in DA. (4f62f0f)
TerminalCtrl: XTVERSION sequence fix (thanks @j4james) (1f3ff94)
TerminalCtrl: Extendended Color format parsing refactored and optimized. (17c737c)
TerminalCtrl: DECRPM 2027 added (reports as permanently reset). (2b1a863)
TerminalCtrl: Parser optimization (d051a38)
TerminalCtrl: VTCell: IsSpecial() method added. VTPage: Minor optimizations. (5af5a33)
TerminalCtrl: Unused insert unicode menu item removed (should be implemented by client code) (6b5d9b1)
TerminalCtrl: Minor renderer optimizations. (bdbd35f)
TerminalCtrl: SetEmulationLevel & SetDeviceConformanceLevel methods are refactored. (511eb34)
TerminalCtrl: RefreshDisplay() method refactored and optimized. (a5b88ee)
TerminalCtrl: Background paint (inverse video) fix. (7b8deb8)
TerminalCtrl: Line length calculation is corrected. (c27c437)
TerminalCtrl: VTPage: Line offset calculation is corrected. (67fa91a)
TerminalCtrl: Option to treat ambiguous chars as wide (2 column) chars. (0f856ee)
TerminalCtrl: Width table updated (ambiguous width chars added). (abc7e6b)
TerminalCtrl: Width table updated (formatting chars table added). (4e6fb72)
TerminalCtrl: Device ID can be changed by the client. (09dff1d)
TerminalCtrl: Report extendend device attributes (term id). (185c9ac)
TerminalCtrl: Selector Mode now automatically initializes to text mode if the mode is unspecified (proper init). (6ecda9d)
TerminalCtrl: Examples are updated to reflect PtyWaitEvent integration & readme updated. (0a2ce7a)

PtyProcess: Windows ConPty now loads as dll. (1ccd90b)
PtyProcess: PtyWaitEvent class is added. Read method (win) refactored. (2fb3e25)