summaryrefslogtreecommitdiffstats
path: root/data/spice-protocol.vapi
blob: cca03edbf2a581cfc9fa4ba1cf480ceceeed135e (plain)
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
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
namespace SpiceProtocol {
	[CCode (cprefix = "Controller", cheader_filename = "spice/controller_prot.h")]
	namespace Controller {
		[CCode (cname = "CONTROLLER_MAGIC")]
		public const uint32 MAGIC;
		[CCode (cname = "CONTROLLER_VERSION")]
		public const int VERSION;

		[Compact]
		public struct InitHeader {
			uint32 magic;
			uint32 version;
			uint32 size;
		}

		[Compact]
		public struct Init {
			InitHeader base;
			uint64 credentials;
			uint32 flags;
		}

		[CCode (cprefix = "CONTROLLER_FLAG_")]
		[Flags]
		public enum Flag {
			EXCLUSIVE,
		}

		[Compact]
		public struct Msg {
			uint32 id;
			uint32 size;
		}

		[CCode (cprefix = "CONTROLLER_")]
		public enum MsgId {
			//external app -> spice client
			HOST,
			PORT,
			SPORT,
			PASSWORD,

			SECURE_CHANNELS,
			DISABLE_CHANNELS,

			TLS_CIPHERS,
			CA_FILE,
			HOST_SUBJECT,

			FULL_SCREEN,
			SET_TITLE,

			CREATE_MENU,
			DELETE_MENU,

			HOTKEYS,
			SEND_CAD,

			CONNECT,
			SHOW,
			HIDE,

			ENABLE_SMARTCARD,

			ENABLE_USB,
			ENABLE_USB_AUTOSHARE,
			USB_FILTER,

			PROXY,

			//spice client -> external app
			MENU_ITEM_CLICK,

			COLOR_DEPTH,
			DISABLE_EFFECTS,
		}

		[CCode (cname = "unsigned int", cprefix = "CONTROLLER_", has_type_id = false)]
		[Flags]
		public enum Display {
			SET_FULL_SCREEN,
			AUTO_DISPLAY_RES,
		}

		[Compact]
		[CCode (cname = "ControllerValue")]
		public struct MsgValue: Msg {
			Msg base;
			uint32 value;
		}

		[Compact]
		[CCode (cname = "ControllerData")]
		public struct MsgData {
			Msg base;
			uint8 data[0];
		}

		[CCode (cname = "CONTROLLER_MENU_ITEM_DELIMITER")]
		public static string MENU_ITEM_DELIMITER;
		[CCode (cname = "CONTROLLER_MENU_PARAM_DELIMITER")]
		public static string MENU_PARAM_DELIMITER;

		[CCode (cname = "SPICE_MENU_INTERNAL_ID_BASE")]
		public static int MENU_INTERNAL_ID_BASE;
		[CCode (cname = "SPICE_MENU_INTERNAL_ID_SHIFT")]
		public static int MENU_INTERNAL_ID_SHIFT;

		[CCode (cprefix = "CONTROLLER_MENU_FLAGS_", cname = "unsigned int", has_type_id = false)]
		[Flags]
		public enum MenuFlags {
			SEPARATOR,
			DISABLED,
			POPUP,
			CHECKED,
			GRAYED,
		}
	}

    [CCode (cprefix = "FrgMenu", cheader_filename = "spice/foreign_menu_prot.h")]
    namespace ForeignMenu {
        [CCode (cname = "FOREIGN_MENU_MAGIC")]
        public const uint32 MAGIC;
        [CCode (cname = "FOREIGN_MENU_VERSION")]
        public const int VERSION;

        [Compact]
        public struct InitHeader {
            uint32 magic;
            uint32 version;
            uint32 size;
        }

        [Compact]
        [CCode (has_destroy_function = false)]
        public struct Init {
            InitHeader base;
            uint64 credentials;
            string title; // utf8
        }

        [Compact]
        public struct Msg {
            uint32 id;
            uint32 size;
        }

        [CCode (cprefix = "FOREIGN_MENU_", cname = "int")]
        public enum MsgId {
            //external app -> spice client
            SET_TITLE,
            ADD_ITEM,
            MODIFY_ITEM,
            REMOVE_ITEM,
            CLEAR,

            //spice client -> external app
            ITEM_EVENT,
            APP_ACTIVATED,
            APP_DEACTIVATED,
        }

        [Compact]
        [CCode (cname = "FrgMenuSetTitle")]
        public struct SetTitle {
            Msg base;
            string string; // utf8
        }

        [CCode (cprefix = "FOREIGN_MENU_ITEM_TYPE_", cname = "unsigned int", has_type_id = false)]
        [Flags]
        public enum MenuFlags {
            CHECKED,
            DIM,
            SEPARATOR
        }

        [Compact]
        [CCode (cname = "FrgMenuAddItem")]
        public struct AddItem {
            Msg base;
            uint32 id;
            uint32 type;
            uint32 position;
            string string; // utf8
        }

        [Compact]
        [CCode (cname = "FrgMenuRmItem")]
        public struct RmItem {
            Msg base;
            uint32 id;
        }

        [CCode (cprefix = "FOREIGN_MENU_EVENT_", cname = "int")]
        public enum EventType {
            CLICK,
            CHECKED,
            UNCHECKED,
        }

        [Compact]
        [CCode (cname = "FrgMenuEvent")]
        public struct Event {
            Msg base;
            uint32 id;
            uint32 action;
        }
    }
}