vte4 4.1.9

data/lib/vte4/loader.rb

@@ -0,0 +1,51 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Vte
+  class Loader < GObjectIntrospection::Loader
+    private
+    def pre_load(repository, namespace)
+      define_version_module
+    end
+
+    def define_version_module
+      @version_module = Module.new
+      @base_module.const_set("Version", @version_module)
+    end
+
+    def post_load(repository, namespace)
+      require_libraries
+    end
+
+    def require_libraries
+      require "vte4/pty"
+      require "vte4/regex"
+      require "vte4/terminal"
+      require "vte4/version"
+
+      require "vte4/deprecated"
+    end
+
+    def load_constant_info(info)
+      case info.name
+      when /_VERSION\z/
+        @version_module.const_set($PREMATCH, info.value)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/vte4/pty.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2015-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Vte
+  class Pty
+    alias_method :initialize_raw, :initialize
+    def initialize(*args)
+      case args[0]
+      when PtyFlags
+        initialize_new_sync(*args)
+      else
+        initialize_raw(*args)
+      end
+    end
+
+    alias_method :size_raw, :size
+    def size
+      succeeded, rows, columns = size_raw
+      if succeeded
+        [rows, columns]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/vte4/regex.rb

@@ -0,0 +1,44 @@
+# Copyright (C) 2017-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Vte
+  class Regex
+    alias_method :initialize_raw, :initialize
+    def initialize(pattern, compile_flags, options)
+      flags = parse_compile_flags(compile_flags)
+      if options[:for_match]
+        initialize_new_for_match(pattern, pattern.bytesize, flags)
+      elsif options[:for_search]
+        initialize_new_for_search(pattern, pattern.bytesize, flags)
+      else
+        raise(ArgumentError,
+              "must specify usage :for_match or :for_search: #{options.inspect}")
+      end
+    end
+
+    private
+    def parse_compile_flags(compile_flags)
+      return compile_flags if compile_flags.is_a?(Integer)
+      return compile_flags unless compile_flags.is_a?(Array)
+
+      flags = 0
+      compile_flags.each do |flag|
+        flags |= GLib::RegexCompileFlags.new(flag).to_i
+      end
+      flags
+    end
+  end
+end

data/lib/vte4/terminal.rb

@@ -0,0 +1,38 @@
+# Copyright (C) 2015-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Vte
+  class Terminal
+    def spawn(options={})
+      pty_flags = options[:pty_flags] || PtyFlags::DEFAULT
+      working_directory = options[:working_directory]
+      argv = options[:argv] || [ENV["SHELL"] || "/bin/sh"]
+      envv = options[:envv]
+      default_spawn_flags = GLib::Spawn::SEARCH_PATH
+      spawn_flags = options[:spawn_flags] || default_spawn_flags
+      succeeded, pid = spawn_sync(pty_flags,
+                                  working_directory,
+                                  argv,
+                                  envv,
+                                  spawn_flags)
+      if succeeded
+        pid
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/vte4/version.rb

@@ -0,0 +1,33 @@
+# Copyright (C) 2015-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Vte
+  module Version
+    STRING = [MAJOR, MINOR, MICRO].join(".")
+
+    class << self
+      def or_later?(major, minor, micro=nil)
+        micro ||= 0
+        version = [
+          MAJOR,
+          MINOR,
+          MICRO,
+        ]
+        (version <=> [major, minor, micro]) >= 0
+      end
+    end
+  end
+end

data/lib/vte4.rb

@@ -0,0 +1,32 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gtk4"
+
+require "vte4/loader"
+
+module Vte
+  LOG_DOMAIN = "Vte"
+  GLib::Log.set_log_domain(LOG_DOMAIN)
+
+  class Error < StandardError
+  end
+
+  Gtk.init if Gtk.respond_to?(:init)
+  loader = Loader.new(self)
+  loader.version = "3.91"
+  loader.load("Vte")
+end

data/test/run-test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require_relative "../../glib2/test/run-test"
+
+run_test(__dir__,
+         [
+           "glib2",
+           "gobject-introspection",
+           "gio2",
+           "gdk_pixbuf2",
+           "atk",
+           "cairo-gobject",
+           "pango",
+           "gdk4",
+           "gtk4",
+           "vte4",
+         ]) do
+  require_relative "vte4-test-utils"
+end

data/test/test-pty.rb

@@ -0,0 +1,46 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestPty < Test::Unit::TestCase
+  def setup
+    flag = Vte::PtyFlags::DEFAULT
+    @pty = Vte::Pty.new(flag)
+  end
+
+  def test_fd
+    assert_nothing_raised do
+      @pty.fd
+    end
+  end
+
+  def test_size
+    original = @pty.size
+    begin
+      row = 80
+      col = 24
+      @pty.set_size(row, col)
+      assert_equal([row, col], @pty.size)
+    ensure
+      @pty.set_size(*original)
+    end
+  end
+
+  def test_utf8
+    assert_nothing_raised do
+      @pty.utf8 = true
+    end
+  end
+end

data/test/test-regex.rb

@@ -0,0 +1,51 @@
+# Copyright (C) 2017-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestRegex < Test::Unit::TestCase
+  include VteTestUtils
+
+  def test_for_match
+    Vte::Regex.new("test", 0, for_match: true)
+    # TODO: Add assertion
+  end
+
+  def test_for_search
+    Vte::Regex.new("test", 0, for_search: true)
+    # TODO: Add assertion
+  end
+
+  sub_test_case("flags") do
+    def test_integer
+      Vte::Regex.new("test",
+                     GLib::RegexCompileFlags::OPTIMIZE.to_i,
+                     for_match: true)
+      # TODO: Add assertion
+    end
+
+    def test_object
+      Vte::Regex.new("test",
+                     GLib::RegexCompileFlags::OPTIMIZE,
+                     for_match: true)
+      # TODO: Add assertion
+    end
+
+    def test_array
+      flags = [:optimize, :multiline]
+      Vte::Regex.new("test", flags, for_match: true)
+      # TODO: Add assertion
+    end
+  end
+end

data/test/test-terminal-properties.rb

@@ -0,0 +1,93 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestTerminalProperties < Test::Unit::TestCase
+  include VteTestUtils
+
+  def setup
+    @terminal = Vte::Terminal.new
+  end
+
+  def test_allow_bold
+    @terminal.allow_bold = false
+    assert_false(@terminal.allow_bold?)
+  end
+
+  def test_audible_bell
+    @terminal.audible_bell = false
+    assert_false(@terminal.audible_bell?)
+  end
+
+  def test_backspace_binding
+    bind = Vte::EraseBinding::DELETE_SEQUENCE
+    @terminal.backspace_binding = bind
+    assert_equal(bind, @terminal.backspace_binding)
+  end
+
+  def test_cursor_blink_mode
+    cursor_mode = Vte::CursorBlinkMode::ON
+    @terminal.cursor_blink_mode = cursor_mode
+    assert_equal(cursor_mode, @terminal.cursor_blink_mode)
+  end
+
+  def test_cursor_shape
+    shape = Vte::CursorShape::IBEAM
+    @terminal.cursor_shape = shape
+    assert_equal(shape, @terminal.cursor_shape)
+  end
+
+  def test_delete_binding
+    bind = Vte::EraseBinding::ASCII_DELETE
+    @terminal.delete_binding = bind
+    assert_equal(bind, @terminal.delete_binding)
+  end
+
+  def test_encoding
+    encoding = "UTF-16"
+    @terminal.encoding = encoding
+    assert_equal(encoding, @terminal.encoding)
+  end
+
+  def test_font_desc
+    font = Pango::FontDescription.new("Monospace 15")
+    @terminal.font_desc = font
+    assert_equal(font, @terminal.font_desc)
+  end
+
+  def test_pointer_autohide
+    hide = true
+    @terminal.pointer_autohide = hide
+    assert_true(@terminal.pointer_autohide?)
+  end
+
+  def test_scroll_on_keystroke
+    scroll = true
+    @terminal.scroll_on_keystroke = scroll
+    assert_true(@terminal.scroll_on_keystroke?)
+  end
+
+  def test_scroll_on_output
+    scroll = false
+    @terminal.scroll_on_output = scroll
+    assert_false(@terminal.scroll_on_output?)
+  end
+
+  def test_scrollback_lines
+    lines = 1024
+    @terminal.scrollback_lines = lines
+    assert_equal(lines, @terminal.scrollback_lines)
+  end
+end

data/test/test-terminal-signals.rb

@@ -0,0 +1,67 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestTerminalSignals < Test::Unit::TestCase
+  def setup
+    if Vte::Version.or_later?(0, 64)
+      omit("VTE 0.64 or later doesn't work in Docker by default")
+      # /usr/include/c++/11/bits/shared_ptr_base.h:976: std::__shared_ptr_access<
+      #  _Tp,
+      #  _Lp,
+      #  <anonymous>,
+      #  <anonymous>
+      # >::element_type&
+      # std::__shared_ptr_access<
+      #  _Tp,
+      #  _Lp,
+      #  <anonymous>,
+      #  <anonymous>
+      # >::operator*() const [
+      # with
+      #  _Tp = vte::platform::Clipboard;
+      # __gnu_cxx::_Lock_policy _Lp = __gnu_cxx::_S_atomic;
+      #  bool <anonymous> = false;
+      # bool <anonymous> = false;
+      # std::__shared_ptr_access<
+      #  _Tp,
+      #  _Lp,
+      #  <anonymous>,
+      #  <anonymous>
+      # >::element_type = vte::platform::Clipboard
+      #]: Assertion '_M_get() != nullptr' failed.
+    end
+
+    @terminal = Vte::Terminal.new
+  end
+
+  def test_copy_clipboard_signal
+    called = false
+    @terminal.signal_connect("copy-clipboard") do
+      called = true
+    end
+    @terminal.signal_emit("copy-clipboard")
+    assert_true(called)
+  end
+
+  def test_paste_clipboard_signal
+    called = false
+    @terminal.signal_connect("paste-clipboard") do
+      called = true
+    end
+    @terminal.signal_emit("paste-clipboard")
+    assert_true(called)
+  end
+end

data/test/test-terminal.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2014-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestTerminal < Test::Unit::TestCase
+  include VteTestUtils
+
+  def setup
+    @terminal = Vte::Terminal.new
+  end
+
+  def test_font
+    font = Pango::FontDescription.new("Monospace 16")
+    @terminal.font = font
+    assert_equal(font, @terminal.font)
+  end
+
+  sub_test_case "#spawn" do
+    setup do
+      @loop = GLib::MainLoop.new
+      @wait_child_exited = false
+      @child_exit_callback_id = @terminal.signal_connect("child-exited") do
+        @loop.quit
+      end
+
+      if Vte::Version.or_later?(0, 64)
+        omit("VTE 0.64 or later doesn't work in Docker by default")
+        # Fedora Rawhide test in Docker reports:
+        #   Failed to fdwalk: Operation not permitted
+        # not NotFound.
+        #
+        # The following discussions may be related:
+        #   https://github.com/mviereck/x11docker/issues/346
+        #   https://github.com/containers/podman/issues/10130
+      end
+    end
+
+    teardown do
+      unless @wait_child_exited
+        GLib::Idle.add do
+          @loop.quit
+          GLib::Source::REMOVE
+        end
+      end
+      @loop.run
+      @terminal.signal_handler_disconnect(@child_exit_callback_id)
+    end
+
+    test "success" do
+      pid = @terminal.spawn(:argv => ["echo"])
+      @wait_child_exited = true
+      assert do
+        pid > 0
+      end
+    end
+
+    test "failure" do
+      assert_raise(Gio::IOError::NotFound) do
+        @terminal.spawn(:argv => ["/bin/nonexistent"])
+        @wait_child_exited = true
+      end
+    end
+  end
+end

data/test/test-version.rb

@@ -0,0 +1,53 @@
+# Copyright (C) 2015-2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestVteVersion < Test::Unit::TestCase
+  include VteTestUtils
+
+  test "STRING" do
+    major = Vte::Version::MAJOR
+    minor = Vte::Version::MINOR
+    micro = Vte::Version::MICRO
+    assert_equal([major, minor, micro].join("."),
+                 Vte::Version::STRING)
+  end
+
+  sub_test_case("#or_later?") do
+    test "same" do
+      assert do
+        Vte::Version.or_later?(Vte::Version::MAJOR,
+                               Vte::Version::MINOR,
+                               Vte::Version::MICRO)
+      end
+    end
+
+    test "later" do
+      assert do
+        Vte::Version.or_later?(Vte::Version::MAJOR,
+                               Vte::Version::MINOR - 1,
+                               Vte::Version::MICRO)
+      end
+    end
+
+    test "earlier" do
+      assert do
+        not Vte::Version.or_later?(Vte::Version::MAJOR,
+                                   Vte::Version::MINOR + 1,
+                                   Vte::Version::MICRO)
+      end
+    end
+  end
+end