reflex-terminal 0.1.0

data/include/reflex/terminal.h

@@ -0,0 +1,233 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_H__
+#define __REFLEX_TERMINAL_H__
+
+
+#include <vector>
+#include <map>
+#include <optional>
+#include <xot/pimpl.h>
+#include <xot/string.h>
+#include <xot/util.h>
+#include <reflex/defs.h>
+#include <reflex/event.h>
+
+
+namespace Reflex
+{
+
+
+	class Terminal
+	{
+
+		public:
+
+			struct Span
+			{
+
+				enum Attribute
+				{
+
+					BOLD            = Xot::bit(0),
+
+					ITALIC          = Xot::bit(1),
+
+					FAINT           = Xot::bit(2),
+
+					BLINK           = Xot::bit(3),
+
+					INVISIBLE       = Xot::bit(4),
+
+					STRIKETHROUGH   = Xot::bit(5),
+
+					OVERLINE        = Xot::bit(6),
+
+					INVERSE         = Xot::bit(7),
+
+					SELECTED        = Xot::bit(8),
+
+					UNDERLINE_SHIFT = 9,
+
+					UNDERLINE_MASK  = Xot::bit(UNDERLINE_SHIFT, 0x7)
+
+				};// Attribute
+
+				enum {COLOR_NONE = -1};
+
+				int x, width;// in cells
+
+				String text;// UTF-8, wide-cell spacers excluded
+
+				uint cell_offset, cell_size;
+
+				int fg, bg;// 0xRRGGBB, or COLOR_NONE
+
+				uint attribs;
+
+			};// Span
+
+			typedef std::vector<Span>                       SpanList;
+
+			typedef std::vector<SpanList>                   RowList;
+
+			typedef std::map<String, std::optional<String>> EnvMap;
+
+			struct Cursor
+			{
+
+				enum Style
+				{
+
+					BAR = 0,
+
+					BLOCK,
+
+					UNDERLINE,
+
+					BLOCK_HOLLOW
+
+				};// Style
+
+				int x, y;
+
+				Style style;
+
+				bool visible;
+
+			};// Cursor
+
+			enum ColorIndex
+			{
+
+				COLOR_FOREGROUND = 1,
+
+				COLOR_BACKGROUND,
+
+				COLOR_CURSOR,
+
+				COLOR_PALETTE_FIRST,
+
+				COLOR_PALETTE_LAST = COLOR_PALETTE_FIRST + 255
+
+			};// ColorIndex
+
+			enum OptionAsAlt
+			{
+
+				OPTION_AS_ALT_OFF = 0,
+
+				OPTION_AS_ALT_ON,
+
+				OPTION_AS_ALT_LEFT,
+
+				OPTION_AS_ALT_RIGHT,
+
+				OPTION_AS_ALT_MAX
+
+			};// OptionAsAlt
+
+			Terminal ();
+
+			Terminal (
+				int columns, int rows,
+				size_t scrollback_bytes = 8 * 1024 * 1024);
+
+			~Terminal ();
+
+			bool update ();
+
+			void reset ();
+
+			void resize (
+				int columns, int rows,
+				int   cell_width, int   cell_height,
+				int screen_width, int screen_height);
+
+			void feed (const char* bytes, size_t size);
+
+			String read_pending_input ();
+
+			void spawn (const StringList& args = {}, const EnvMap& envs = {});
+
+			void close ();
+
+			void write (const char* bytes, size_t size);
+
+			void write_key (const KeyEvent& event);
+
+			void write_pointer (const PointerEvent& event);
+
+			void write_wheel (const WheelEvent& event);
+
+			void paste (const char* text, size_t size);
+
+			bool is_alive () const;
+
+			bool is_mouse_tracking () const;
+
+			void     select (int x1, int y1, int x2, int y2);
+
+			void     select_rect (int x1, int y1, int x2, int y2);
+
+			void     select_word (int x, int y);
+
+			void     select_line (int y);
+
+			void   deselect ();
+
+			bool has_selection () const;
+
+			String   selected_text () const;
+
+			void scroll_to (int row);
+
+			void scroll_by (int rows);
+
+			int  scroll () const;
+
+			void    set_option_as_alt (OptionAsAlt state);
+
+			OptionAsAlt option_as_alt () const;
+
+			int columns () const;
+
+			int rows () const;
+
+			Cursor cursor () const;
+
+			void   set_default_color (ColorIndex index, const Color& color);
+
+			void clear_default_color (ColorIndex index);
+
+			bool   get_default_color (ColorIndex index, Color* color) const;
+
+			bool           get_color (ColorIndex index, Color* color) const;
+
+			const char* title () const;
+
+			StringList lines () const;
+
+			int            history_rows () const;
+
+			StringList get_history_lines (int offset, int size) const;
+
+			longlong bells () const;
+
+			const RowList& spans () const;
+
+			operator bool () const;
+
+			bool operator ! () const;
+
+			struct Data;
+
+			Xot::PSharedImpl<Data> self;
+
+	};// Terminal
+
+
+}// Reflex
+
+
+#endif//EOH

data/include/reflex-terminal/defs.h

@@ -0,0 +1,36 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_DEFS_H__
+#define __REFLEX_TERMINAL_DEFS_H__
+
+
+#include <reflex/defs.h>
+
+
+#if defined(WIN32) && defined(GCC) && defined(REFLEX_TERMINAL)
+	#define REFLEX_TERMINAL_EXPORT __declspec(dllexport)
+#else
+	#define REFLEX_TERMINAL_EXPORT
+#endif
+
+
+namespace ReflexTerminal
+{
+
+
+	using namespace Xot   ::Types;
+
+	using namespace Rays  ::Types;
+
+	using namespace Reflex::Types;
+
+
+	using Rays::String;
+
+	using Rays::StringList;
+
+
+}// ReflexTerminal
+
+
+#endif//EOH

data/include/reflex-terminal/renderer.h

@@ -0,0 +1,57 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_RENDERER_H__
+#define __REFLEX_TERMINAL_RENDERER_H__
+
+
+#include <xot/pimpl.h>
+#include <rays/bounds.h>
+#include <rays/color.h>
+#include <rays/font.h>
+#include <rays/painter.h>
+#include <reflex-terminal/defs.h>
+#include <reflex/terminal.h>
+
+
+namespace ReflexTerminal
+{
+
+
+	class Renderer
+	{
+
+		public:
+
+			Renderer ();
+
+			Renderer (const Font& font);
+
+			~Renderer ();
+
+			void    set_font (const Font& font);
+
+			const Font& font () const;
+
+			coord cell_width () const;
+
+			coord cell_height () const;
+
+			void bake_glyphs (const Reflex::Terminal& terminal);
+
+			size_t    glyph_count () const;
+
+			void draw (
+				Painter* painter, const Reflex::Terminal& terminal,
+				const Bounds& bounds);
+
+			struct Data;
+
+			Xot::PSharedImpl<Data> self;
+
+	};// Renderer
+
+
+}// ReflexTerminal
+
+
+#endif//EOH

data/include/reflex-terminal/ruby/renderer.h

@@ -0,0 +1,41 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_RUBY_RENDERER_H__
+#define __REFLEX_TERMINAL_RUBY_RENDERER_H__
+
+
+#include <rucy/class.h>
+#include <rucy/extension.h>
+#include <reflex-terminal/defs.h>
+#include <reflex-terminal/renderer.h>
+
+
+RUCY_DECLARE_VALUE_FROM_TO(REFLEX_TERMINAL_EXPORT, ReflexTerminal::Renderer)
+
+
+namespace ReflexTerminal
+{
+
+
+	REFLEX_TERMINAL_EXPORT Rucy::Class renderer_class ();
+	// class ReflexTerminal::Renderer
+
+
+}// ReflexTerminal
+
+
+namespace Rucy
+{
+
+
+	template <> inline Class
+	get_ruby_class<ReflexTerminal::Renderer> ()
+	{
+		return ReflexTerminal::renderer_class();
+	}
+
+
+}// Rucy
+
+
+#endif//EOH

data/include/reflex-terminal/ruby/terminal.h

@@ -0,0 +1,43 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_RUBY_TERMINAL_H__
+#define __REFLEX_TERMINAL_RUBY_TERMINAL_H__
+
+
+#include <rucy/class.h>
+#include <rucy/extension.h>
+#include <reflex-terminal/defs.h>
+#include <reflex/terminal.h>
+
+
+RUCY_DECLARE_VALUE_FROM_TO(REFLEX_TERMINAL_EXPORT, Reflex::Terminal)
+
+RUCY_DECLARE_CONVERT_TO(REFLEX_TERMINAL_EXPORT, Reflex::Terminal::OptionAsAlt)
+
+
+namespace Reflex
+{
+
+
+	REFLEX_TERMINAL_EXPORT Rucy::Class terminal_class ();
+	// class Reflex::Terminal
+
+
+}// Reflex
+
+
+namespace Rucy
+{
+
+
+	template <> inline Class
+	get_ruby_class<Reflex::Terminal> ()
+	{
+		return Reflex::terminal_class();
+	}
+
+
+}// Rucy
+
+
+#endif//EOH

data/include/reflex-terminal/ruby.h

@@ -0,0 +1,11 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_RUBY_ALL_H__
+#define __REFLEX_TERMINAL_RUBY_ALL_H__
+
+
+#include <reflex-terminal/ruby/terminal.h>
+#include <reflex-terminal/ruby/renderer.h>
+
+
+#endif//EOH

data/include/reflex-terminal.h

@@ -0,0 +1,13 @@
+// -*- c++ -*-
+#pragma once
+#ifndef __REFLEX_TERMINAL_ALL_H__
+#define __REFLEX_TERMINAL_ALL_H__
+
+
+#include <reflex/terminal.h>
+
+#include <reflex-terminal/defs.h>
+#include <reflex-terminal/renderer.h>
+
+
+#endif//EOH

data/lib/reflex/bell_event.rb

@@ -0,0 +1,15 @@
+module Reflex
+
+
+  class BellEvent
+
+    def initialize(count = 1)
+      @count = count
+    end
+
+    attr_reader :count
+
+  end# BellEvent
+
+
+end# Reflex

data/lib/reflex/terminal.rb

@@ -0,0 +1,168 @@
+require 'xot/util'
+require 'xot/const_symbol_accessor'
+require 'xot/universal_accessor'
+require 'reflex-terminal/ext'
+
+
+module Reflex
+
+
+  class Terminal
+
+    PALETTE_RANGE      = (0..(COLOR_PALETTE_LAST - COLOR_PALETTE_FIRST)).freeze
+
+    HISTORY_CHUNK_SIZE = 500
+
+    def initialize(
+      columns = 80, rows = 24,
+      # a memory budget rather than a line count: how many lines fit
+      # depends on how wide the terminal is. 0 keeps no scrollback
+      scrollback_bytes: 8 * 1024 * 1024)
+
+      initialize! columns, rows, scrollback_bytes
+    end
+
+    def resize(
+      columns, rows,
+        cell_width: 8,   cell_height: 16,
+      screen_width: 0, screen_height: 0)
+
+      resize! columns, rows, cell_width, cell_height, screen_width, screen_height
+    end
+
+    # Starts a child process on a new pseudo terminal.
+    #
+    # Follows the Kernel#spawn convention: a leading hash sets environment
+    # variables (a nil value removes one), a single string runs via the
+    # shell (so quoting and pipes work), and multiple arguments exec
+    # directly. Unlike Kernel#spawn, unsetenv_others is not supported.
+    #
+    # @return [self] self
+    #
+    def spawn(*args)
+      envs = args.first.is_a?(Hash) ? args.shift : {}
+      args = args.compact
+      args = shell_command(args.first) if args.size == 1
+      spawn! args, envs
+    end
+
+    # Yields each style span of the visible screen.
+    #
+    # @yield [x, y, width, text, fg, bg, flags] a run of cells sharing
+    #   the same style; x, y and width are in cells, and fg/bg are
+    #   0xRRGGBB or nil for the terminal's default color
+    #
+    # @return [Enumerator] when no block is given
+    #
+    def each_span(&block)
+      return enum_for :each_span unless block
+      each_span!(&block)
+    end
+
+    # Yields each line of the visible screen.
+    #
+    # @yield [line] a row of the screen, without its trailing spaces and
+    #   without a newline of its own
+    #
+    # @return [Enumerator] when no block is given
+    #
+    def each_line(&block)
+      return enum_for :each_line unless block
+      each_line!(&block)
+    end
+
+    # @return [Array<String>] the visible screen, one string per row
+    #
+    def lines()
+      each_line.to_a
+    end
+
+    # Yields each line of the scrollback, oldest first.
+    #
+    # The history is walked in chunks rather than handed over at once,
+    # since it can hold far more than fits in memory.
+    #
+    # @yield [line] a line of the history, without its trailing spaces
+    #
+    # @return [Enumerator] when no block is given
+    #
+    def each_history_line(&block)
+      return enum_for :each_history_line unless block
+      (0...history_rows).step HISTORY_CHUNK_SIZE do |row|
+        get_history_lines!(row, HISTORY_CHUNK_SIZE).each(&block)
+      end
+      self
+    end
+
+    const_symbol_accessor :option_as_alt, **{
+      off:   OPTION_AS_ALT_OFF,
+      on:    OPTION_AS_ALT_ON,
+      left:  OPTION_AS_ALT_LEFT,
+      right: OPTION_AS_ALT_RIGHT
+    }
+
+    def default_foreground_color=(color)
+      set_or_clear_default_color COLOR_FOREGROUND, color
+    end
+
+    def default_background_color=(color)
+      set_or_clear_default_color COLOR_BACKGROUND, color
+    end
+
+    def default_cursor_color=(color)
+      set_or_clear_default_color COLOR_CURSOR, color
+    end
+
+    def set_default_palette(index, color)
+      Array(index).each do |i|
+        set_or_clear_default_color to_palette_index(i), color
+      end
+    end
+
+    def default_foreground_color()      = get_default_color! COLOR_FOREGROUND
+
+    def default_background_color()      = get_default_color! COLOR_BACKGROUND
+
+    def     default_cursor_color()      = get_default_color! COLOR_CURSOR
+
+    def          default_palette(index) = get_default_color! to_palette_index(index)
+
+    def         foreground_color()      =         get_color! COLOR_FOREGROUND
+
+    def         background_color()      =         get_color! COLOR_BACKGROUND
+
+    def             cursor_color()      =         get_color! COLOR_CURSOR
+
+    def                  palette(index) =         get_color! to_palette_index(index)
+
+    universal_accessor :default_foreground_color, :default_background_color,
+      :default_cursor_color
+
+    private
+
+    def shell_command(command)
+      if Xot.win32?
+        [ENV['COMSPEC'] || 'cmd.exe', '/c', command]
+      else
+        ['/bin/sh', '-c', command]
+      end
+    end
+
+    def set_or_clear_default_color(index, color)
+      if color
+        set_default_color! index, color
+      else
+        clear_default_color! index
+      end
+    end
+
+    def to_palette_index(index)
+      raise IndexError, "palette index out of range: #{index}" unless
+        PALETTE_RANGE.include? index
+      COLOR_PALETTE_FIRST + index
+    end
+
+  end# Terminal
+
+
+end# Reflex