// // mainloop.cs: Simple managed mainloop implementation. // // Authors: // Miguel de Icaza (miguel.de.icaza@gmail.com) // // Copyright (C) 2011 Novell (http://www.novell.com) // // 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. // using System; using System.Collections.Generic; using System.Runtime.InteropServices; namespace Terminal.Gui { /// /// Unix main loop, suitable for using on Posix systems /// /// /// In addition to the general functions of the mainloop, the Unix version /// can watch file descriptors using the AddWatch methods. /// internal class UnixMainLoop : IMainLoopDriver { public UnixMainLoop (ConsoleDriver consoleDriver = null) { // UnixDriver doesn't use the consoleDriver parameter, but the WindowsDriver does. } public const int KEY_RESIZE = unchecked((int)0xffffffffffffffff); [StructLayout (LayoutKind.Sequential)] struct Pollfd { public int fd; public short events, revents; } /// /// Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions. /// [Flags] public enum Condition : short { /// /// There is data to read /// PollIn = 1, /// /// Writing to the specified descriptor will not block /// PollOut = 4, /// /// There is urgent data to read /// PollPri = 2, /// /// Error condition on output /// PollErr = 8, /// /// Hang-up on output /// PollHup = 16, /// /// File descriptor is not open. /// PollNval = 32 } class Watch { public int File; public Condition Condition; public Func Callback; } Dictionary descriptorWatchers = new Dictionary (); [DllImport ("libc")] extern static int poll ([In, Out] Pollfd [] ufds, uint nfds, int timeout); [DllImport ("libc")] extern static int pipe ([In, Out] int [] pipes); [DllImport ("libc")] extern static int read (int fd, IntPtr buf, IntPtr n); [DllImport ("libc")] extern static int write (int fd, IntPtr buf, IntPtr n); Pollfd [] pollmap; bool poll_dirty = true; int [] wakeupPipes = new int [2]; static IntPtr ignore = Marshal.AllocHGlobal (1); MainLoop mainLoop; bool winChanged; public Action WinChanged; void IMainLoopDriver.Wakeup () { write (wakeupPipes [1], ignore, (IntPtr)1); } void IMainLoopDriver.Setup (MainLoop mainLoop) { this.mainLoop = mainLoop; pipe (wakeupPipes); AddWatch (wakeupPipes [0], Condition.PollIn, ml => { read (wakeupPipes [0], ignore, (IntPtr)1); return true; }); } /// /// Removes an active watch from the mainloop. /// /// /// The token parameter is the value returned from AddWatch /// public void RemoveWatch (object token) { var watch = token as Watch; if (watch == null) return; descriptorWatchers.Remove (watch.File); } /// /// Watches a file descriptor for activity. /// /// /// When the condition is met, the provided callback /// is invoked. If the callback returns false, the /// watch is automatically removed. /// /// The return value is a token that represents this watch, you can /// use this token to remove the watch by calling RemoveWatch. /// public object AddWatch (int fileDescriptor, Condition condition, Func callback) { if (callback == null) throw new ArgumentNullException (nameof (callback)); var watch = new Watch () { Condition = condition, Callback = callback, File = fileDescriptor }; descriptorWatchers [fileDescriptor] = watch; poll_dirty = true; return watch; } void UpdatePollMap () { if (!poll_dirty) return; poll_dirty = false; pollmap = new Pollfd [descriptorWatchers.Count]; int i = 0; foreach (var fd in descriptorWatchers.Keys) { pollmap [i].fd = fd; pollmap [i].events = (short)descriptorWatchers [fd].Condition; i++; } } bool IMainLoopDriver.EventsPending (bool wait) { UpdatePollMap (); bool checkTimersResult = CheckTimers (wait, out var pollTimeout); var n = poll (pollmap, (uint)pollmap.Length, pollTimeout); if (n == KEY_RESIZE) { winChanged = true; } return checkTimersResult || n >= KEY_RESIZE; } bool CheckTimers (bool wait, out int pollTimeout) { long now = DateTime.UtcNow.Ticks; if (mainLoop.timeouts.Count > 0) { pollTimeout = (int)((mainLoop.timeouts.Keys [0] - now) / TimeSpan.TicksPerMillisecond); if (pollTimeout < 0) { return true; } } else pollTimeout = -1; if (!wait) pollTimeout = 0; int ic; lock (mainLoop.idleHandlers) { ic = mainLoop.idleHandlers.Count; } return ic > 0; } void IMainLoopDriver.MainIteration () { if (winChanged) { winChanged = false; WinChanged?.Invoke (); } if (pollmap != null) { foreach (var p in pollmap) { Watch watch; if (p.revents == 0) continue; if (!descriptorWatchers.TryGetValue (p.fd, out watch)) continue; if (!watch.Callback (this.mainLoop)) descriptorWatchers.Remove (p.fd); } } } } }