yonderboy/net-spec.yml at master · profmaad/yonderboy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
commands:
  - command: spawn-renderer
    source: [ controller ]
    target: hosts-manager
    description: Spawns off a new rendering process using the default engine

  - command: open-uri
    source: [ controller ]
    target: renderer-host
    description: Tells the renderer to retrieve and render the given URI
    required:
      - { name: renderer-id, type: renderer }
      - { name: uri, type: string, description: The URI to load }

  - command: go-back
    source: [ controller ]
    target: renderer-host
    description: Tells the renderer to go back one item in its history
    required:
      - { name: renderer-id, type: renderer }

  - command: go-forward
    source: [ controller ]
    target: renderer-host
    description: Tells the renderer to go forward one item in its history
    required:
      - { name: renderer-id, type: renderer }

  - command: reload-page
    source: [ controller ]
    target: renderer-host
    description: Tells the renderer to reload the currently displayed page
    required:
      - { name: renderer-id, type: renderer }
    optional:
      - { name: bypass-cache, type: boolean, description: do not use the cache }

  - command: connect-view-to-renderer
    source: [ controller ]
    target: display-manager
    description: Hooks up a view to a renderer, so that the renderers results are shown in the view and can be controlled
    required:
      - { name: viewer-id, type: viewer }
      - { name: view-id, type: view }
      - { name: renderer-id, type: renderer }

  - command: quit-server
    source: [ controller ]
    target: server-controller
    description: Results in a (hopefully) graceful shutdown of the server

  - command: search-in-page
    source: [ controller ]
    target: renderer-host
    description: Tells the renderer to start a search in the currently loaded page
    required:
      - { name: renderer-id, type: renderer }
      - { name: text, type: string, description: the text to search for }
    optional:
      - { name: case-sensitive, type: boolean, description: make the search case-sensitive }
      - { name: backwards, type: boolean, description: search backwards through the page }
      - { name: wrap-around, type: boolean, description: wrap the search at the end of the page }
    response:
      optional:
      - { name: text-found, type: boolean, description: the text was found in the page }

signals:
  - status: load-started
    source: [ renderer ]
    description: The renderer started loading a resource
    required:
      - { name: uri, type: string, description: the resource that started loading }

  - status: load-finished
    source: [ renderer ]
    description: The renderer finished loading a resource
    required:
      - { name: uri, type: string, description: the resource that finished loading }

  - status: load-failed
    source: [ renderer ]
    description: The renderer encountered an error loading a resource

  - status: progress-changed
    source: [ renderer ]
    description: The resource loading progress changed
    required:
      - { name: progress, type: numeric, description: current progress in the range 0-1 }

  - status: hovering-over-link
    source: [ renderer ]
    description: The mouse cursor is currently hovering over a link
    required:
      - { name: uri, type: string, description: the uri of the link }
    optional:
      - { name: title, type: string, description: the links title }

  - status: not-hovering-over-link
    source: [ renderer ]
    description: The mouse cursor stopped hovering over a link