Sha256: a35a5d081957c7ef9017760516398e9593b3fbf81a8c71e357d251de1200870b

Contents?: true

Size: 1.9 KB

Versions: 69

Compression:

Stored size: 1.9 KB

Contents

#Debug Dump UI
The `int_debug_dump_ui` dumps the view-controller, view, and spot hierarchy. This is used in viewers like the *Seagull* client. This is a very expensive
message as it sends back a `if_event` with the name `debug_dump_ui_res` and the address `-333` with a very large payload of many embedded hashes.

##Hash linked list
The payload returned in `int_debug_dump_ui` is a *linked* list of sorts; There is a basic type of node that looks like:

```js
Node {
  children: [Node],
  type: "$node_class"
}
```

Ontop of the base node, the type defines a child class of the node:

  * `vc` - View Controller
    * `name` - The name of the view controller (human friendly)
    * `action` - Current action name (human friendly)
    * `ptr` - The base pointer of this view controller
    * `events` - A list of events that the current action is capabable of handling
  * `view` - View
    * `name` - The name of the view
    * `ptr` - The pointer to the view
  * `spot` - Spot inside a view controller's root view
    * `name` - The name of the spot
    * `ptr` - The pointer of this spot location

Note that all view controllers have one `main` spot, this is actually just the `view` (Every view has a view controller, and vice versa).  So technically,
the spots beyond the `main` spot are actually children of the view managed by the view controller.
Another way to say that is that all `vc`'s will have one child and it will be a view.'

Example payload:

```ruby
{
  type: "spot",
  name: "root",
  ptr: 0,
  children: [
    {
      name: "dashboard"
      type: "vc",
      action: "index",
      view: "dashboard",
      ptr: 2,
      children: [
        {
          type: "view",
          name: "container (main)",
          ptr: 3
          children: [
            {
              type: "spot",
              name: "content",
              ptr: 4,
              children: []
            }
          ]
        }
      ]
    }
  ]
}
```

Version data entries

69 entries across 69 versions & 1 rubygems

Version Path
flok-0.0.105 docs/mod/debug/dump_ui.md
flok-0.0.103 docs/mod/debug/dump_ui.md
flok-0.0.102 docs/mod/debug/dump_ui.md
flok-0.0.101 docs/mod/debug/dump_ui.md
flok-0.0.100 docs/mod/debug/dump_ui.md
flok-0.0.99 docs/mod/debug/dump_ui.md
flok-0.0.98 docs/mod/debug/dump_ui.md
flok-0.0.97 docs/mod/debug/dump_ui.md
flok-0.0.96 docs/mod/debug/dump_ui.md
flok-0.0.95 docs/mod/debug/dump_ui.md
flok-0.0.94 docs/mod/debug/dump_ui.md
flok-0.0.93 docs/mod/debug/dump_ui.md
flok-0.0.92 docs/mod/debug/dump_ui.md
flok-0.0.91 docs/mod/debug/dump_ui.md
flok-0.0.90 docs/mod/debug/dump_ui.md
flok-0.0.89 docs/mod/debug/dump_ui.md
flok-0.0.88 docs/mod/debug/dump_ui.md
flok-0.0.87 docs/mod/debug/dump_ui.md
flok-0.0.86 docs/mod/debug/dump_ui.md
flok-0.0.85 docs/mod/debug/dump_ui.md