canopus 0.3.0 → 0.4.0

data/sig/canopus.rbs

@@ -161,6 +161,7 @@ module Canopus
     def row_count: () -> Integer
     def wrap_width=: (Integer? width) -> void
     def tab_size=: (Integer size) -> void
+    def set_overlays: (Array[Decoration::Item] items, ?font: Alhena::Font?, ?font_size: Numeric, ?line_height: Numeric) -> bool
     def fold: (Range[Integer] range) -> void
     def unfold: (Integer offset) -> void
     def insert_block: (untyped id, row: Integer, text: String, ?kind: Symbol) -> void
@@ -321,7 +322,7 @@ module Canopus
     def dismiss_notification: (Integer id) -> void
     def expire_notifications: (?Numeric now) -> bool
     attr_accessor show_project: bool
-    attr_accessor terminal_visible: bool?
+    attr_accessor terminal_visible: bool
     attr_accessor terminal_composition: Zaniah::Input::Composition?
     attr_reader terminals: Array[Terminal::PTY]
     attr_reader active_terminal_index: Integer
@@ -356,15 +357,16 @@ module Canopus
     def resize_terminal: (Integer columns, Integer rows, ?final: bool, ?now: Numeric) -> void
     def flush_terminal_resize: () -> void
     def toggle_dock: (Symbol side) -> bool
-    def register_panel: (String name, ?side: Symbol) { () -> (Zaniah::Element | String) } -> untyped
-    def register_action: (String name, ?description: String) { (*untyped) -> untyped } -> untyped
+    def register_panel: (String name, ?side: Panel::dock) { () -> (Zaniah::Element | String) } -> Panel::Definition
+    def register_action: (String name, ?description: String, ?category: String, ?condition: String, ?keybinding: Command::keybinding) { (*untyped) -> untyped } -> Command::Definition
     def definition_for: (String? path) -> Language::Definition
     def register_language: (String name, extensions: Array[String], ?lexer: String, ?comment: String, ?indent_open: String, ?indent_close: String, ?servers: Array[Array[String]]) -> untyped
-    def call: (String name, *untyped arguments) -> untyped
+    def command_context: (?terminal: bool) -> Command::context
+    def call: (String name, *untyped arguments, ?context: Command::context?) -> untyped
     def save_session: (String path) -> void
     def restore_session: (String path) -> self
     def theme=: (Theme | String theme) -> void
-    def palette_open: (Symbol kind) -> void
+    def palette_open: (Symbol kind, ?command_ids: Array[String]?, ?context: Command::context?) -> void
     def show_snippet_choices: (?Editor current) -> untyped
     def update_palette: () -> void
     def palette_accept: () -> void

data/sig/command.rbs

@@ -0,0 +1,30 @@
+module Canopus
+  module Command
+    type context = Hash[String | Symbol, untyped]
+    type keybinding = String | Hash[String, String] | nil
+
+    DEFAULT_KEYBINDINGS: Hash[String, Hash[String, String]]
+
+    class Definition < Data
+      attr_reader id: String
+      attr_reader title: String
+      attr_reader category: String
+      attr_reader when: String
+      attr_reader run: ^(*untyped) -> untyped
+      attr_reader keybinding: keybinding
+      def self.new: (String id, String title, String category, String when, ^(*untyped) -> untyped run, keybinding keybinding) -> instance
+    end
+
+    class Registry
+      attr_reader version: Integer
+      def initialize: () -> void
+      def register: (Definition definition) -> Definition
+                  | (String id, ?description: String, ?category: String, ?condition: String, ?keybinding: keybinding) { (*untyped) -> untyped } -> Definition
+      def resolve: (String | Symbol id, ?context: context) -> Definition?
+      def call: (String | Symbol id, *untyped arguments, ?context: context) -> untyped
+      def each: (?context: context?) { (Definition) -> untyped } -> self
+              | (?context: context?) -> Enumerator[Definition, self]
+      def entries: (?context: context?) -> Hash[String, String]
+    end
+  end
+end

data/sig/controller.rbs

@@ -1,7 +1,5 @@
 module Canopus
   class Controller
-    SHORTCUTS: Hash[String, String]
-    TERMINAL_SHORTCUTS: Hash[String, String]
     attr_reader workspace: Workspace
     attr_reader view: Workspace::View
     attr_reader window: Zaniah::Platform::Headless::Window

data/sig/decoration.rbs

@@ -0,0 +1,26 @@
+module Canopus
+  module Decoration
+    type kind = :inline | :block | :gutter | :highlight | :line
+
+    class Item < Data
+      attr_reader kind: kind
+      attr_reader range: Range[Integer]?
+      attr_reader row: Integer?
+      attr_reader content: untyped
+      attr_reader style: untyped
+      attr_reader priority: Numeric
+      attr_reader source: Symbol?
+      attr_reader on_click: (^(Editor, Integer) -> untyped)?
+      def self.new: (kind kind, Range[Integer]? range, Integer? row, untyped content, untyped style, Numeric priority, Symbol? source, (^(Editor, Integer) -> untyped)? on_click) -> instance
+    end
+
+    class Registry
+      attr_reader version: Integer
+      def initialize: () -> void
+      def register: (Symbol source) { (Buffer, Range[Integer], ?Editor) -> Array[Item] } -> Symbol
+      def unregister: (Symbol source) -> Proc?
+      def items_for: (Buffer buffer, Range[Integer] row_range, ?context: Editor?) -> Array[Item]
+      def invalidate: (Symbol source, ?buffer: Buffer?, ?rows: Range[Integer]?) -> nil
+    end
+  end
+end

data/sig/display_stages.rbs

@@ -10,7 +10,7 @@ module Canopus
   class TabMap
     attr_reader tab_size: Integer
     def initialize: (?tab_size: Integer) -> void
-    def transform: (String text, Array[Integer] offsets, ?checkpoint: (^() -> void)?) -> [String, Array[Integer]]
+    def transform: (String text, Array[Integer] offsets, ?checkpoint: (^() -> void)?, ?overlays: Array[DisplayMap::OverlayMap::Inline]?) -> ([String, Array[Integer]] | [String, Array[Integer], Array[DisplayMap::OverlayMap::Inline]])
   end
   class WrapMap
     attr_reader width: Numeric?
@@ -19,7 +19,7 @@ module Canopus
     attr_reader font_paths: Array[String]?
     attr_reader typesetter: Zaniah::TextSystem::Typesetter?
     def initialize: (?width: Numeric?, ?font: Alhena::Font?, ?font_size: Numeric, ?font_paths: Array[String]?, ?typesetter: Zaniah::TextSystem::Typesetter?) -> void
-    def transform: (String text, Array[Integer] offsets, ?checkpoint: (^() -> void)?) -> Array[[String, Array[Integer]]]
+    def transform: (String text, Array[Integer] offsets, ?checkpoint: (^() -> void)?, ?overlays: Array[DisplayMap::OverlayMap::Inline], ?tab_map: TabMap?) -> Array[([String, Array[Integer]] | [String, Array[Integer], Array[DisplayMap::OverlayMap::Inline]])]
     def close: () -> void
   end
   class BlockMap
@@ -38,9 +38,35 @@ module Canopus
     def apply: (patch patch) -> Hash[untyped, Block]
   end
   class DisplayMap
+    class OverlayMap
+      class Inline < Data
+        attr_reader item: Decoration::Item
+        attr_reader offset: Integer
+        attr_reader width: Float
+        attr_reader cell_width: Float
+        attr_reader height: Float
+        attr_reader align: :before | :after
+        def self.new: (Decoration::Item item, Integer offset, Float width, Float cell_width, Float height, :before | :after align) -> instance
+      end
+      class Block < Data
+        attr_reader item: Decoration::Item
+        attr_reader row: Integer
+        attr_reader height: Float
+        attr_reader row_span: Integer
+        attr_reader position: :above | :below
+        def self.new: (Decoration::Item item, Integer row, Float height, Integer row_span, :above | :below position) -> instance
+      end
+      attr_reader line_height: Numeric
+      def initialize: () -> void
+      def replace: (Array[Decoration::Item] items, rope: rope, ?font: Alhena::Font?, ?font_size: Numeric, ?line_height: Numeric) -> Array[Integer]
+      def transform: (rope rope, Integer row, String text, Array[Integer] offsets) -> Array[Inline]
+      def blocks: (Integer row, :above | :below position) -> Array[Block]
+      def snapshot: () -> OverlayMap
+    end
     attr_reader layout_error: StandardError?
     def wrap_pixels: (Numeric width, ?font: Alhena::Font?, font_size: Numeric, ?font_paths: Array[String]?, ?typesetter: Zaniah::TextSystem::Typesetter?) -> void
     attr_reader fold_map: FoldMap
+    attr_reader overlay_map: OverlayMap
     attr_reader tab_map: TabMap
     attr_reader wrap_map: WrapMap
     attr_reader block_map: BlockMap

data/sig/panel.rbs

@@ -0,0 +1,35 @@
+module Canopus
+  module Panel
+    type dock = :left | :right | :bottom
+    type dock_state = { visible: bool, size: Numeric }
+    type saved_state = Hash[String, Hash[String, bool | Numeric]]
+
+    class Definition < Data
+      attr_reader id: String
+      attr_reader title: String
+      attr_reader icon: untyped
+      attr_reader dock: dock
+      attr_reader build: ^() -> untyped
+      attr_reader badge: untyped
+      def self.new: (String | Symbol id, String title, untyped icon, dock dock, ^() -> untyped build, untyped badge) -> instance
+    end
+
+    class Registry
+      DOCKS: Array[dock]
+      attr_reader docks: Hash[dock, dock_state]
+      def initialize: (Hash[dock, dock_state] docks) -> void
+      def register: (Definition definition, ?visible: bool, ?size: Numeric?) -> Definition
+      def fetch: (String | Symbol id) -> Definition
+      def key?: (String | Symbol id) -> bool
+      def visible?: (String | Symbol id) -> bool
+      def show: (String | Symbol id) -> Definition
+      def hide: (String | Symbol id) -> Definition
+      def toggle: (String | Symbol id) -> Definition
+      def active: (dock dock) -> Array[Definition]
+      def badge: (String | Symbol id, untyped value) -> Definition
+      def resize: (dock dock, Numeric size) -> Numeric
+      def state: () -> saved_state
+      def restore: (saved_state state, ?docks: Hash[dock, dock_state]?) -> self
+    end
+  end
+end

data/sig/workspace_services.rbs

@@ -25,10 +25,12 @@ module Canopus
     type palette_state = Hash[Symbol, untyped]
     type search_options = { ?case_sensitive: bool, ?whole_word: bool, ?range: Range[Integer] }
     type semantic_style = {line: Integer, character: Integer, length: Integer, type: Integer, modifiers: Integer, name: String?}
-    attr_reader actions: Zaniah::Input::ActionRegistry
+    attr_reader actions: Command::Registry
+    attr_reader commands: Command::Registry
     attr_reader project: Project?
     attr_reader docks: Hash[Symbol, {visible: bool, size: Numeric}]
-    attr_reader panels: Hash[String, [Symbol, ^() -> (Zaniah::Element | String)]]
+    attr_reader panels: Panel::Registry
+    attr_reader decorations: Decoration::Registry
     attr_accessor window: Zaniah::Platform::Headless::Window?
     attr_reader palette: palette_state?
     def palette=: (palette_state? value) -> void
@@ -68,6 +70,7 @@ module Canopus
     def git_diff: (?Buffer buffer, ?async: bool) -> Porrima::Diff?
     def git_hunks: (?Buffer buffer, ?async: bool) -> Array[Porrima::Hunk]
     def git_gutter_marks: (?Buffer buffer) -> Array[Porrima::Mark]
+    def git_decorations: (Buffer buffer, Range[Integer] rows) -> Array[Decoration::Item]
     def show_git_diff: () -> Language::Document
     def toggle_git_hunk: (?Editor current, ?row: Integer?) -> bool
     def show_git_blame: () -> String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canopus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: antares
   requirement: !ruby/object:Gem::Requirement
@@ -155,14 +155,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.0
 email:
 - t.yudai92@gmail.com
 executables:
@@ -183,6 +183,9 @@ files:
 - docs/adr/005-windows-runtime.md
 - docs/adr/006-tab-close-lifetime.md
 - docs/adr/007-terminal-key-routing.md
+- docs/adr/008-component-domain-boundaries.md
+- docs/adr/009-decoration-overlay-path.md
+- docs/adr/010-overlay-aware-display-map.md
 - docs/adr/README.md
 - docs/distribution.md
 - docs/lsp.md
@@ -198,11 +201,14 @@ files:
 - lib/canopus/block_map.rb
 - lib/canopus/buffer.rb
 - lib/canopus/cli.rb
+- lib/canopus/command.rb
 - lib/canopus/controller.rb
 - lib/canopus/data_compat.rb
+- lib/canopus/decoration.rb
 - lib/canopus/display_map.rb
 - lib/canopus/display_map/line_builder.rb
 - lib/canopus/display_map/line_set.rb
+- lib/canopus/display_map/overlay_map.rb
 - lib/canopus/display_map/pending_line_set.rb
 - lib/canopus/display_map/summary.rb
 - lib/canopus/display_map/worker.rb
@@ -234,6 +240,7 @@ files:
 - lib/canopus/match_data_compat.rb
 - lib/canopus/multi_buffer.rb
 - lib/canopus/pane.rb
+- lib/canopus/panel.rb
 - lib/canopus/patch.rb
 - lib/canopus/patch/composite.rb
 - lib/canopus/patch/reload.rb
@@ -290,10 +297,13 @@ files:
 - lib/canopus/workspace/view/terminal_presentable.rb
 - lib/canopus/wrap_map.rb
 - sig/canopus.rbs
+- sig/command.rbs
 - sig/controller.rbs
+- sig/decoration.rbs
 - sig/display_stages.rbs
 - sig/lsp.rbs
 - sig/markdown.rbs
+- sig/panel.rbs
 - sig/performance_recorder.rbs
 - sig/search_services.rbs
 - sig/services.rbs