Module: Plushie::Protocol::Decode

Defined in:
lib/plushie/protocol/decode.rb

Overview

Inbound message decoding from the wire protocol.

Handles all response types and event families as defined in protocol.md. The canonical reference is: ~/projects/toddy-elixir/lib/plushie/protocol/decode.ex

See Also:

  • "Outgoing messages"

Class Method Summary collapse

Class Method Details

.decode(data, format = :msgpack) ⇒ Hash

Deserialize raw wire bytes into a Ruby hash.

Parameters:

  • data (String) —

    raw wire bytes

  • format (:msgpack, :json) (defaults to: :msgpack)

Returns:

  • (Hash) 


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/plushie/protocol/decode.rb', line 22

def decode(data, format = :msgpack)
  case format
  when :json
    JSON.parse(data)
  when :msgpack
    require "msgpack"
    MessagePack.unpack(data)
  end
rescue JSON::ParserError, MessagePack::MalformedFormatError,
  MessagePack::UnpackError, MessagePack::TypeError => e
  {"error" => e.message}
rescue ArgumentError => e
  # msgpack gem raises ArgumentError for some malformed inputs
  {"error" => e.message}
end

.decode_effect_response(msg) ⇒ Event::Effect

Decode an effect response (file dialog result, clipboard, etc.). Uses the status field per protocol.md: "ok", "cancelled", "error".

Parameters:

  • msg (Hash)

Returns:



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/plushie/protocol/decode.rb', line 475

def decode_effect_response(msg)
  result = case msg["status"]
  when "ok" then [:ok, msg["result"]]
  when "cancelled" then :cancelled
  when "error" then [:error, msg["error"]]
  else
    # Legacy fallback for older renderers
    if msg["error"]
      [:error, msg["error"]]
    elsif msg["cancelled"]
      :cancelled
    else
      [:ok, msg["result"] || msg["data"]]
    end
  end
  Event::Effect.new(request_id: msg["id"], result: result)
end

.decode_event(msg) ⇒ Event::*?

Decode an event message into the appropriate Event struct.

Parameters:

  • msg (Hash) —

    deserialized event message

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/plushie/protocol/decode.rb', line 80

def decode_event(msg)
  family = msg["family"]
  data = msg["data"] || {}

  case family

  # -- Widget events -> Event::Widget -----------------------------------

  when "click", "input", "submit", "toggle", "select",
    "slide", "slide_release", "paste", "option_hovered",
    "open", "close", "key_binding", "sort", "scroll",
    "canvas_element_enter", "canvas_element_leave",
    "canvas_element_click", "canvas_element_drag",
    "canvas_element_drag_end", "canvas_element_focused"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: family.to_sym, id: id,
      value: msg["value"], scope: scope, data: msg["data"]
    )

  # -- Mouse area events -> Event::MouseArea ----------------------------

  when "mouse_right_press", "mouse_right_release",
    "mouse_middle_press", "mouse_middle_release",
    "mouse_double_click", "mouse_enter", "mouse_exit"
    id, scope = split_scoped_id(msg["id"])
    type = family.delete_prefix("mouse_").to_sym
    Event::MouseArea.new(type: type, id: id, scope: scope)

  when "mouse_move"
    id, scope = split_scoped_id(msg["id"])
    Event::MouseArea.new(
      type: :move, id: id, scope: scope,
      x: data["x"], y: data["y"]
    )

  when "mouse_scroll"
    id, scope = split_scoped_id(msg["id"])
    Event::MouseArea.new(
      type: :scroll, id: id, scope: scope,
      delta_x: data["delta_x"], delta_y: data["delta_y"]
    )

  # -- Canvas events -> Event::Canvas -----------------------------------

  when "canvas_press", "canvas_release"
    id, scope = split_scoped_id(msg["id"])
    type = (family == "canvas_press") ? :press : :release
    Event::Canvas.new(
      type: type, id: id, scope: scope,
      x: data["x"], y: data["y"],
      button: data["button"] || "left"
    )

  when "canvas_move"
    id, scope = split_scoped_id(msg["id"])
    Event::Canvas.new(
      type: :move, id: id, scope: scope,
      x: data["x"], y: data["y"]
    )

  when "canvas_scroll"
    id, scope = split_scoped_id(msg["id"])
    Event::Canvas.new(
      type: :scroll, id: id, scope: scope,
      x: data["x"], y: data["y"],
      delta_x: data["delta_x"], delta_y: data["delta_y"]
    )

  # -- Pane events -> Event::Pane ---------------------------------------

  when "pane_resized"
    id, scope = split_scoped_id(msg["id"])
    Event::Pane.new(
      type: :resized, id: id, scope: scope,
      split: data["split"], ratio: data["ratio"]
    )

  when "pane_dragged"
    id, scope = split_scoped_id(msg["id"])
    Event::Pane.new(
      type: :dragged, id: id, scope: scope,
      pane: data["pane"], target: data["target"],
      action: Parsers.parse_pane_action(data["action"]),
      region: Parsers.parse_pane_region(data["region"]),
      edge: Parsers.parse_pane_region(data["edge"])
    )

  when "pane_clicked"
    id, scope = split_scoped_id(msg["id"])
    Event::Pane.new(
      type: :clicked, id: id, scope: scope,
      pane: data["pane"]
    )

  when "pane_focus_cycle"
    id, scope = split_scoped_id(msg["id"])
    Event::Pane.new(
      type: :focus_cycle, id: id, scope: scope,
      pane: data["pane"]
    )

  # -- Sensor events -> Event::Sensor -----------------------------------

  when "sensor_resize"
    id, scope = split_scoped_id(msg["id"])
    Event::Sensor.new(
      type: :resize, id: id, scope: scope,
      width: data["width"], height: data["height"]
    )

  # -- Keyboard events -> Event::Key ------------------------------------

  when "key_press"
    # Key data lives in data sub-object for subscription events,
    # or at the top level for direct events.
    kd = data.empty? ? msg : data
    Event::Key.new(
      type: :press,
      key: Keys.parse_key(kd["key"]),
      modified_key: Keys.parse_key(kd["modified_key"] || kd["key"]),
      physical_key: Keys.parse_physical_key(kd["physical_key"]),
      location: Keys.parse_location(kd["location"]),
      modifiers: parse_modifiers(msg["modifiers"] || kd["modifiers"] || {}),
      text: kd["text"],
      repeat: kd["repeat"] || false,
      captured: msg["captured"] || false
    )

  when "key_release"
    kd = data.empty? ? msg : data
    Event::Key.new(
      type: :release,
      key: Keys.parse_key(kd["key"]),
      modified_key: Keys.parse_key(kd["modified_key"] || kd["key"]),
      physical_key: Keys.parse_physical_key(kd["physical_key"]),
      location: Keys.parse_location(kd["location"]),
      modifiers: parse_modifiers(msg["modifiers"] || kd["modifiers"] || {}),
      text: nil,     # key_release never carries text
      repeat: false, # key_release never carries repeat
      captured: msg["captured"] || false
    )

  # -- Modifier events -> Event::Modifiers ------------------------------

  when "modifiers_changed"
    Event::Modifiers.new(
      modifiers: parse_modifiers(msg["modifiers"] || data["modifiers"] || {}),
      captured: msg["captured"] || false
    )

  # -- Mouse subscription events -> Event::Mouse -----------------------

  when "cursor_moved"
    Event::Mouse.new(
      type: :moved,
      x: data["x"], y: data["y"],
      captured: msg["captured"] || false
    )

  when "cursor_entered"
    Event::Mouse.new(type: :entered, captured: msg["captured"] || false)

  when "cursor_left"
    Event::Mouse.new(type: :left, captured: msg["captured"] || false)

  when "button_pressed"
    Event::Mouse.new(
      type: :button_pressed,
      button: Parsers.parse_mouse_button(msg["value"]),
      captured: msg["captured"] || false
    )

  when "button_released"
    Event::Mouse.new(
      type: :button_released,
      button: Parsers.parse_mouse_button(msg["value"]),
      captured: msg["captured"] || false
    )

  when "wheel_scrolled"
    Event::Mouse.new(
      type: :wheel_scrolled,
      delta_x: data["delta_x"], delta_y: data["delta_y"],
      unit: Parsers.parse_scroll_unit(data["unit"]),
      captured: msg["captured"] || false
    )

  # -- Touch events -> Event::Touch -------------------------------------

  when "finger_pressed", "finger_moved", "finger_lifted", "finger_lost"
    type = family.delete_prefix("finger_").to_sym
    Event::Touch.new(
      type: type,
      finger_id: data["id"],
      x: data["x"], y: data["y"],
      captured: msg["captured"] || false
    )

  # -- IME events -> Event::Ime -----------------------------------------

  when "ime_opened"
    id, scope = split_scoped_id(msg["id"])
    Event::Ime.new(type: :opened, id: id, scope: scope, captured: msg["captured"] || false)

  when "ime_preedit"
    id, scope = split_scoped_id(msg["id"])
    Event::Ime.new(
      type: :preedit, id: id, scope: scope,
      text: data["text"],
      cursor: parse_ime_cursor(data["cursor"]),
      captured: msg["captured"] || false
    )

  when "ime_commit"
    id, scope = split_scoped_id(msg["id"])
    Event::Ime.new(
      type: :commit, id: id, scope: scope,
      text: data["text"],
      captured: msg["captured"] || false
    )

  when "ime_closed"
    id, scope = split_scoped_id(msg["id"])
    Event::Ime.new(type: :closed, id: id, scope: scope, captured: msg["captured"] || false)

  # -- Window subscription events -> Event::Window ----------------------

  when "window_opened"
    pos = data["position"] || {}
    Event::Window.new(
      type: :opened, window_id: data["window_id"],
      x: pos["x"], y: pos["y"],
      width: data["width"], height: data["height"],
      scale_factor: data["scale_factor"]
    )

  when "window_closed"
    Event::Window.new(type: :closed, window_id: data["window_id"])

  when "window_close_requested"
    Event::Window.new(type: :close_requested, window_id: data["window_id"])

  when "window_moved"
    Event::Window.new(
      type: :moved, window_id: data["window_id"],
      x: data["x"], y: data["y"]
    )

  when "window_resized"
    Event::Window.new(
      type: :resized, window_id: data["window_id"],
      width: data["width"], height: data["height"]
    )

  when "window_focused"
    Event::Window.new(type: :focused, window_id: data["window_id"])

  when "window_unfocused"
    Event::Window.new(type: :unfocused, window_id: data["window_id"])

  when "window_rescaled"
    Event::Window.new(
      type: :rescaled, window_id: data["window_id"],
      scale_factor: data["scale_factor"]
    )

  when "file_hovered"
    Event::Window.new(
      type: :file_hovered, window_id: data["window_id"],
      path: data["path"]
    )

  when "file_dropped"
    Event::Window.new(
      type: :file_dropped, window_id: data["window_id"],
      path: data["path"]
    )

  when "files_hovered_left"
    Event::Window.new(type: :files_hovered_left, window_id: data["window_id"])

  # -- System events -> Event::System -----------------------------------

  when "animation_frame"
    Event::System.new(type: :animation_frame, data: data["timestamp"] || msg["value"])

  when "theme_changed"
    Event::System.new(type: :theme_changed, data: msg["value"] || data["mode"])

  when "all_windows_closed"
    Event::System.new(type: :all_windows_closed)

  when "error"
    Event::System.new(type: :error, data: data)

  when "announce"
    Event::System.new(type: :announce, data: data["text"])

  when "session_error"
    Event::System.new(
      type: :session_error,
      tag: msg["session"],
      data: data["error"] || data
    )

  when "session_closed"
    Event::System.new(
      type: :session_closed,
      tag: msg["session"],
      data: data["reason"] || data
    )

  # -- Canvas element/group focus events -> Event::Widget ----------------

  when "canvas_element_blurred"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: :canvas_element_blurred, id: id,
      value: nil, scope: scope, data: data
    )

  when "canvas_focused"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: :canvas_focused, id: id,
      value: nil, scope: scope, data: nil
    )

  when "canvas_blurred"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: :canvas_blurred, id: id,
      value: nil, scope: scope, data: nil
    )

  when "canvas_group_focused"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: :canvas_group_focused, id: id,
      value: nil, scope: scope, data: data
    )

  when "canvas_group_blurred"
    id, scope = split_scoped_id(msg["id"])
    Event::Widget.new(
      type: :canvas_group_blurred, id: id,
      value: nil, scope: scope, data: data
    )

  # -- Diagnostic events -> Event::System ---------------------------------

  when "diagnostic"
    Event::System.new(type: :diagnostic, data: data)

  # -- Fallback: extension/unknown events -> Event::Widget --------------

  else
    if msg["id"]
      id, scope = split_scoped_id(msg["id"])
      Event::Widget.new(
        type: family&.to_sym, id: id,
        value: msg["value"], scope: scope, data: msg["data"]
      )
    end
  end
end

.decode_hello(msg) ⇒ Hash

Decode the hello handshake message.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :protocol, :version, :name, :mode, :backend, :extensions, :transport



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/plushie/protocol/decode.rb', line 456

def decode_hello(msg)
  {
    type: :hello,
    session: msg["session"],
    protocol: msg["protocol"],
    version: msg["version"],
    name: msg["name"],
    mode: msg["mode"]&.to_sym,
    backend: msg["backend"],
    extensions: msg["extensions"] || [],
    transport: msg["transport"]
  }
end

.decode_interact_response(msg) ⇒ Hash

Decode an interact response (final response after all steps). Embedded events are decoded recursively.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :session, :events



526
527
528
529
530
531
532
533
534
 
# File 'lib/plushie/protocol/decode.rb', line 526

def decode_interact_response(msg)
  events = (msg["events"] || []).filter_map { |e| decode_event(e) }
  {
    type: :interact_response,
    id: msg["id"],
    session: msg["session"],
    events: events
  }
end

.decode_interact_step(msg) ⇒ Hash

Decode an interact step (intermediate events from headless mode). Embedded events are decoded recursively.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :session, :events



541
542
543
544
545
546
547
548
549
 
# File 'lib/plushie/protocol/decode.rb', line 541

def decode_interact_step(msg)
  events = (msg["events"] || []).filter_map { |e| decode_event(e) }
  {
    type: :interact_step,
    id: msg["id"],
    session: msg["session"],
    events: events
  }
end

.decode_message(data, format = :msgpack) ⇒ Event::*, ...

Decode a wire message into a typed Ruby struct or hash.

Dispatches on the "type" field to the appropriate decoder. Returns nil for decode errors.

Parameters:

  • data (String) —

    raw wire bytes

  • format (:msgpack, :json) (defaults to: :msgpack)

Returns:



46
47
48
49
50
 
# File 'lib/plushie/protocol/decode.rb', line 46

def decode_message(data, format = :msgpack)
  msg = decode(data, format)
  return nil if msg.key?("error")
  dispatch_message(msg)
end

.decode_op_query_response(msg) ⇒ Hash

Decode an op query response (tree_hash, find_focused, system_theme, etc.).

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :kind, :tag, :data



511
512
513
514
515
516
517
518
519
 
# File 'lib/plushie/protocol/decode.rb', line 511

def decode_op_query_response(msg)
  {
    type: :op_query_response,
    session: msg["session"],
    kind: msg["kind"]&.to_sym,
    tag: msg["tag"],
    data: msg["data"]
  }
end

.decode_query_response(msg) ⇒ Hash

Decode a query response (find, tree).

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :target, :data



497
498
499
500
501
502
503
504
505
 
# File 'lib/plushie/protocol/decode.rb', line 497

def decode_query_response(msg)
  {
    type: :query_response,
    session: msg["session"],
    id: msg["id"],
    target: msg["target"],
    data: msg["data"]
  }
end

.decode_reset_response(msg) ⇒ Hash

Decode a reset response.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :status



586
587
588
589
590
591
592
593
 
# File 'lib/plushie/protocol/decode.rb', line 586

def decode_reset_response(msg)
  {
    type: :reset_response,
    session: msg["session"],
    id: msg["id"],
    status: msg["status"]
  }
end

.decode_screenshot_response(msg) ⇒ Hash

Decode a screenshot response.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :name, :hash, :width, :height, :rgba



569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/plushie/protocol/decode.rb', line 569

def decode_screenshot_response(msg)
  {
    type: :screenshot_response,
    session: msg["session"],
    id: msg["id"],
    name: msg["name"],
    hash: msg["hash"],
    width: msg["width"],
    height: msg["height"],
    rgba: msg["rgba"]
  }
end

.decode_tree_hash_response(msg) ⇒ Hash

Decode a tree hash response.

Parameters:

  • msg (Hash)

Returns:

  • (Hash) —

    with :type, :id, :name, :hash



555
556
557
558
559
560
561
562
563
 
# File 'lib/plushie/protocol/decode.rb', line 555

def decode_tree_hash_response(msg)
  {
    type: :tree_hash_response,
    session: msg["session"],
    id: msg["id"],
    name: msg["name"],
    hash: msg["hash"]
  }
end

.dispatch_message(msg) ⇒ Event::*, ...

Dispatch an already-deserialized message hash.

Parameters:

  • msg (Hash) —

    deserialized message with string keys

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/plushie/protocol/decode.rb', line 56

def dispatch_message(msg)
  case msg["type"]
  when "event" then decode_event(msg)
  when "hello" then decode_hello(msg)
  when "effect_response" then decode_effect_response(msg)
  when "query_response" then decode_query_response(msg)
  when "op_query_response" then decode_op_query_response(msg)
  when "interact_response" then decode_interact_response(msg)
  when "interact_step" then decode_interact_step(msg)
  when "tree_hash_response" then decode_tree_hash_response(msg)
  when "screenshot_response" then decode_screenshot_response(msg)
  when "reset_response" then decode_reset_response(msg)
  else msg
  end
end

.parse_ime_cursor(cursor) ⇒ Array(Integer, Integer)?

Parse an IME cursor position from the wire format.

Parameters:

  • cursor (Hash, Array, nil) —

    cursor data from the renderer

Returns:

  • (Array(Integer, Integer), nil) —

    [start, end] or nil



630
631
632
633
634
635
 
# File 'lib/plushie/protocol/decode.rb', line 630

def parse_ime_cursor(cursor)
  case cursor
  when Hash then [cursor["start"], cursor["end"]]
  when Array then cursor
  end
end

.parse_modifiers(mods) ⇒ Hash

Parse a modifiers hash from the wire format.

Parameters:

  • mods (Hash) —

    wire modifiers (string keys)

Returns:

  • (Hash) —

    frozen hash with symbol keys



616
617
618
619
620
621
622
623
624
625
 
# File 'lib/plushie/protocol/decode.rb', line 616

def parse_modifiers(mods)
  return {shift: false, ctrl: false, alt: false, logo: false, command: false}.freeze if mods.nil? || mods.empty?
  {
    shift: mods["shift"] || false,
    ctrl: mods["ctrl"] || false,
    alt: mods["alt"] || false,
    logo: mods["logo"] || false,
    command: mods["command"] || false
  }.freeze
end

.split_scoped_id(full_id) ⇒ Array(String, Array<String>)

Split a scoped wire ID into local ID and scope array. Wire sends "sidebar/form/save"; we split to id: "save", scope: "form", "sidebar".

Parameters:

  • full_id (String, nil)

Returns:

  • (Array(String, Array<String>)) 


605
606
607
608
609
610
 
# File 'lib/plushie/protocol/decode.rb', line 605

def split_scoped_id(full_id)
  return [full_id.to_s, []] unless full_id&.include?("/")
  parts = full_id.split("/")
  id = parts.pop
  [id, parts.reverse]
end