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 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
45 
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_types
121 } MirWindowType;
122 
123 typedef enum MirSurfaceState
124 {
125  mir_surface_state_unknown,
126  mir_surface_state_restored,
127  mir_surface_state_minimized,
128  mir_surface_state_maximized,
129  mir_surface_state_vertmaximized,
130  /* mir_surface_state_semimaximized,
131  Omitted for now, since it's functionally a subset of vertmaximized and
132  differs only in the X coordinate. */
133  mir_surface_state_fullscreen,
134  mir_surface_state_horizmaximized,
135  mir_surface_state_hidden,
136  mir_surface_states
137 }