Mir
common.h
Go to the documentation of this file.
1 /*
2  * Simple definitions common to client and server.
3  *
4  * Copyright © 2013-2016 Canonical Ltd.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License version 2 or 3 as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: Daniel van Vugt <daniel.van.vugt@canonical.com>
19  */
20 
21 #ifndef MIR_COMMON_H_
22 #define MIR_COMMON_H_
23 
24 #include <mir_toolkit/deprecations.h>
25 
26 //for clang
27 #ifndef __has_feature
28  #define __has_feature(x) 0 // Compatibility with non-clang
29 #endif
30 
31 //for clang
32 #ifndef __has_extension
33  #define __has_extension __has_feature // Compatibility with pre-3.0
34 #endif
35 
36 #if __GNUC__ >= 6 || \
37  (__has_extension(attribute_deprecated_with_message) && \
38  __has_extension(enumerator_attributes))
39  #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
40  ENUM MIR_FOR_REMOVAL_IN_VERSION_1("Use " #INSTEAD " instead")
41 #else
42  #define MIR_DEPRECATED_ENUM(ENUM, INSTEAD) \
43  ENUM
44 #endif
49 /* This is C code. Not C++. */
50 
55 typedef enum MirSurfaceAttrib
56 {
57  /* Do not specify values...code relies on 0...N ordering. */
58  mir_surface_attrib_type,
59  mir_surface_attrib_state,
60  mir_surface_attrib_swapinterval,
64  mir_surface_attrib_focus,
65  mir_surface_attrib_dpi,
66  mir_surface_attrib_visibility,
67  mir_surface_attrib_preferred_orientation,
68  /* Must be last */
69  mir_surface_attribs
70 } MirSurfaceAttrib MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowAttrib");
71 
76 typedef enum MirWindowAttrib
77 {
78  /* Do not specify values...code relies on 0...N ordering. */
79  mir_window_attrib_type,
80  mir_window_attrib_state,
81  mir_window_attrib_swapinterval,
85  mir_window_attrib_focus,
86  mir_window_attrib_dpi,
87  mir_window_attrib_visibility,
88  mir_window_attrib_preferred_orientation,
89  /* Must be last */
90  mir_window_attribs
91 } MirWindowAttrib;
92 
93 typedef enum MirSurfaceType
94 {
95  mir_surface_type_normal,
96  mir_surface_type_utility,
97  mir_surface_type_dialog,
98  mir_surface_type_overlay,
99  mir_surface_type_gloss = mir_surface_type_overlay,
100  mir_surface_type_freestyle,
101  mir_surface_type_popover,
102  mir_surface_type_menu = mir_surface_type_popover,
103  mir_surface_type_inputmethod,
104  mir_surface_type_satellite,
105  mir_surface_type_tip,
106  mir_surface_types
107 } MirSurfaceType MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowType");
108 
109 typedef enum MirWindowType
110 {
111  mir_window_type_normal,
112  mir_window_type_utility,
113  mir_window_type_dialog,
114  mir_window_type_gloss,
115  mir_window_type_freestyle,
116  mir_window_type_menu,
117  mir_window_type_inputmethod,
118  mir_window_type_satellite,
119  mir_window_type_tip,
120  mir_window_type_decoration,
121  mir_window_types
122 } MirWindowType;
123 
124 typedef enum MirSurfaceState
125 {
126  mir_surface_state_unknown,
127  mir_surface_state_restored,
128  mir_surface_state_minimized,
129  mir_surface_state_maximized,
130  mir_surface_state_vertmaximized,
131  /* mir_surface_state_semimaximized,
132  Omitted for now, since it's functionally a subset of vertmaximized and
133  differs only in the X coordinate. */
134  mir_surface_state_fullscreen,
135  mir_surface_state_horizmaximized,
136  mir_surface_state_hidden,
137  mir_surface_state_attached,
138  mir_surface_states
139 } MirSurfaceState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowState");
140 
141 typedef enum MirWindowState
142 {
143  mir_window_state_unknown,
144  mir_window_state_restored,
145  mir_window_state_minimized,
146  mir_window_state_maximized,
147  mir_window_state_vertmaximized,
148  /* mir_window_state_semimaximized,
149  Omitted for now, since it's functionally a subset of vertmaximized and
150  differs only in the X coordinate. */
151  mir_window_state_fullscreen,
152  mir_window_state_horizmaximized,
153  mir_window_state_hidden,
154  mir_window_state_attached,
155  mir_window_states
156 } MirWindowState;
157 
158 typedef enum MirSurfaceFocusState
159 {
160  mir_surface_unfocused = 0,
161  mir_surface_focused
162 } MirSurfaceFocusState MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
163 
164 typedef enum MirWindowFocusState
165 {
166  mir_window_focus_state_unfocused = 0,
167  mir_window_focus_state_focused
168 } MirWindowFocusState;
169 
170 typedef enum MirSurfaceVisibility
171 {
172  mir_surface_visibility_occluded = 0,
173  mir_surface_visibility_exposed
174 } MirSurfaceVisibility MIR_FOR_REMOVAL_IN_VERSION_1("use MirWindowFocusState");
175 
176 typedef enum MirWindowVisibility
177 {
178  mir_window_visibility_occluded = 0,
179  mir_window_visibility_exposed
180 } MirWindowVisibility;
181 
182 typedef enum MirLifecycleState
183 {
184  mir_lifecycle_state_will_suspend,
185  mir_lifecycle_state_resumed,
186  mir_lifecycle_connection_lost
187 } MirLifecycleState;
188 
189 typedef enum MirPowerMode
190 {
191  mir_power_mode_on, /* Display in use. */
192  mir_power_mode_standby, /* Blanked, low power. */
193  mir_power_mode_suspend, /* Blanked, lowest power. */
194  mir_power_mode_off /* Powered down. */
195 } MirPowerMode;
196 
197 typedef enum MirOutputType
198 {
199  mir_output_type_unknown = 0, /* DRM_MODE_CONNECTOR_Unknown */
200  mir_output_type_vga = 1, /* DRM_MODE_CONNECTOR_VGA */
201  mir_output_type_dvii = 2, /* DRM_MODE_CONNECTOR_DVII */
202  mir_output_type_dvid = 3, /* DRM_MODE_CONNECTOR_DVID */
203  mir_output_type_dvia = 4, /* DRM_MODE_CONNECTOR_DVIA */
204  mir_output_type_composite = 5, /* DRM_MODE_CONNECTOR_Composite */
205  mir_output_type_svideo = 6, /* DRM_MODE_CONNECTOR_SVIDEO */
206  mir_output_type_lvds = 7, /* DRM_MODE_CONNECTOR_LVDS */
207  mir_output_type_component = 8, /* DRM_MODE_CONNECTOR_Component */
208  mir_output_type_ninepindin = 9, /* DRM_MODE_CONNECTOR_9PinDIN */
209  mir_output_type_displayport = 10, /* DRM_MODE_CONNECTOR_DisplayPort */
210  mir_output_type_hdmia = 11, /* DRM_MODE_CONNECTOR_HDMIA */
211  mir_output_type_hdmib = 12, /* DRM_MODE_CONNECTOR_HDMIB */
212  mir_output_type_tv = 13, /* DRM_MODE_CONNECTOR_TV */
213  mir_output_type_edp = 14, /* DRM_MODE_CONNECTOR_eDP */
214  mir_output_type_virtual = 15, /* DRM_MODE_CONNECTOR_VIRTUAL */
215  mir_output_type_dsi = 16, /* DRM_MODE_CONNECTOR_DSI */
216  mir_output_type_dpi = 17, /* DRM_MODE_CONNECTOR_DPI */
217 } MirOutputType;
218 
219 typedef enum MirPromptSessionState
220 {
221  mir_prompt_session_state_stopped = 0,
222  mir_prompt_session_state_started,
223  mir_prompt_session_state_suspended
224 } MirPromptSessionState;
225 
244 typedef enum MirPixelFormat
245 {
246  mir_pixel_format_invalid = 0,
247  mir_pixel_format_abgr_8888 = 1,
248  mir_pixel_format_xbgr_8888 = 2,
249  mir_pixel_format_argb_8888 = 3,
250  mir_pixel_format_xrgb_8888 = 4,
251  mir_pixel_format_bgr_888 = 5,
252  mir_pixel_format_rgb_888 = 6,
253  mir_pixel_format_rgb_565 = 7,
254  mir_pixel_format_rgba_5551 = 8,
255  mir_pixel_format_rgba_4444 = 9,
256  /*
257  * TODO: Big endian support would require additional formats in order to
258  * composite software surfaces using OpenGL (GL_RGBA/GL_BGRA_EXT):
259  * mir_pixel_format_rgb[ax]_8888
260  * mir_pixel_format_bgr[ax]_8888
261  */
262  mir_pixel_formats /* Note: This is always max format + 1 */
263 } MirPixelFormat;
264 
265 /* This could be improved... https://bugs.launchpad.net/mir/+bug/1236254 */
266 #define MIR_BYTES_PER_PIXEL(f) ((f) == mir_pixel_format_bgr_888 ? 3 : \
267  (f) == mir_pixel_format_rgb_888 ? 3 : \
268  (f) == mir_pixel_format_rgb_565 ? 2 : \
269  (f) == mir_pixel_format_rgba_5551 ? 2 : \
270  (f) == mir_pixel_format_rgba_4444 ? 2 : \
271  4)
272 
274 typedef enum MirOrientation
275 {
276  mir_orientation_normal = 0,
277  mir_orientation_left = 90,
278  mir_orientation_inverted = 180,
279  mir_orientation_right = 270
280 } MirOrientation;
281 
283 typedef enum MirMirrorMode
284 {
285  mir_mirror_mode_none,
286  mir_mirror_mode_vertical,
287  mir_mirror_mode_horizontal
288 } MirMirrorMode;
289 
290 typedef enum MirOrientationMode
291 {
292  mir_orientation_mode_portrait = 1 << 0,
293  mir_orientation_mode_landscape = 1 << 1,
294  mir_orientation_mode_portrait_inverted = 1 << 2,
295  mir_orientation_mode_landscape_inverted = 1 << 3,
296  mir_orientation_mode_portrait_any = mir_orientation_mode_portrait |
297  mir_orientation_mode_portrait_inverted,
298  mir_orientation_mode_landscape_any = mir_orientation_mode_landscape |
299  mir_orientation_mode_landscape_inverted,
300  mir_orientation_mode_any = mir_orientation_mode_portrait_any |
301  mir_orientation_mode_landscape_any
302 } MirOrientationMode;
303 
304 typedef enum MirEdgeAttachment
305 {
306  mir_edge_attachment_vertical = 1 << 0,
307  mir_edge_attachment_horizontal = 1 << 1,
308  mir_edge_attachment_any = mir_edge_attachment_vertical |
309  mir_edge_attachment_horizontal
310 } MirEdgeAttachment;
311 
312 // Inspired by GdkGravity
317 typedef enum MirPlacementGravity
318 {
320  mir_placement_gravity_center = 0,
321 
323  mir_placement_gravity_west = 1 << 0,
324 
326  mir_placement_gravity_east = 1 << 1,
327 
329  mir_placement_gravity_north = 1 << 2,
330 
332  mir_placement_gravity_south = 1 << 3,
333 
335  mir_placement_gravity_northwest = mir_placement_gravity_north | mir_placement_gravity_west,
336 
338  mir_placement_gravity_northeast = mir_placement_gravity_north | mir_placement_