# Merge lp:~alan-griffiths/mir/fix-1668651 into lp:mir

Proposed by Alan Griffiths
Status: Work in progress lp:~alan-griffiths/mir/fix-1668651 lp:mir 25322 lines (+24516/-0) (has conflicts)155 files modified.bzr-builddeb/default.conf (+2/-0).bzrignore (+3/-0)CMakeLists.txt (+78/-0)COPYING (+674/-0)README.md (+46/-0)cmake/Doxygen.cmake (+26/-0)cmake/FindGLESv2.cmake (+25/-0)cmake/FindPIL.cmake (+8/-0)debian/changelog (+227/-0)debian/compat (+1/-0)debian/control (+90/-0)debian/copyright (+24/-0)debian/libmiral-dev.install (+3/-0)debian/libmiral2.install (+1/-0)debian/libmiral2.symbols (+383/-0)debian/libmirclientcpp-dev.install (+2/-0)debian/miral-doc.install (+1/-0)debian/miral-examples.install (+9/-0)debian/rules (+26/-0)doc/Doxyfile.in (+1926/-0)doc/extra.css (+40/-0)doc/footer.html.in (+5/-0)doc/introducing_the_miral_api.md (+25/-0)doc/mainpage.md (+54/-0)getting_and_using_miral.md (+179/-0)include/mir/client/connection.h (+54/-0)include/mir/client/detail/mir_forward_compatibility.h (+172/-0)include/mir/client/display_config.h (+83/-0)include/mir/client/window.h (+65/-0)include/mir/client/window_id.h (+65/-0)include/mir/client/window_spec.h (+329/-0)include/miral/active_outputs.h (+73/-0)include/miral/add_init_callback.h (+47/-0)include/miral/append_event_filter.h (+44/-0)include/miral/application.h (+42/-0)include/miral/application_authorizer.h (+102/-0)include/miral/application_info.h (+55/-0)include/miral/canonical_window_manager.h (+59/-0)include/miral/command_line_option.h (+100/-0)include/miral/cursor_theme.h (+44/-0)include/miral/debug_extension.h (+47/-0)include/miral/display_configuration_option.h (+30/-0)include/miral/internal_client.h (+88/-0)include/miral/keymap.h (+58/-0)include/miral/output.h (+113/-0)include/miral/runner.h (+74/-0)include/miral/set_command_line_hander.h (+50/-0)include/miral/set_terminator.h (+47/-0)include/miral/set_window_managment_policy.h (+54/-0)include/miral/window.h (+82/-0)include/miral/window_info.h (+130/-0)include/miral/window_management_options.h (+65/-0)include/miral/window_management_policy.h (+196/-0)include/miral/window_manager_tools.h (+230/-0)include/miral/window_specification.h (+136/-0)include/miral/workspace_policy.h (+88/-0)miral-kiosk/CMakeLists.txt (+11/-0)miral-kiosk/kiosk_main.cpp (+101/-0)miral-kiosk/kiosk_window_manager.cpp (+144/-0)miral-kiosk/kiosk_window_manager.h (+56/-0)miral-kiosk/sw_splash.cpp (+151/-0)miral-kiosk/sw_splash.h (+44/-0)miral-shell/CMakeLists.txt (+64/-0)miral-shell/decoration_provider.cpp (+571/-0)miral-shell/decoration_provider.h (+112/-0)miral-shell/desktop/CMakeLists.txt (+12/-0)miral-shell/desktop/miral-shell.desktop.in (+18/-0)miral-shell/desktop/ubuntu-logo.svg (+27/-0)miral-shell/miral-app.sh (+53/-0)miral-shell/miral-desktop.sh (+45/-0)miral-shell/miral-run.sh (+6/-0)miral-shell/miral-screencast.sh (+48/-0)miral-shell/miral-xrun.sh (+14/-0)miral-shell/shell_main.cpp (+94/-0)miral-shell/spinner/CMakeLists.txt (+66/-0)miral-shell/spinner/eglapp.cpp (+164/-0)miral-shell/spinner/eglapp.h (+33/-0)miral-shell/spinner/eglspinner.cpp (+370/-0)miral-shell/spinner/miregl.cpp (+248/-0)miral-shell/spinner/miregl.h (+69/-0)miral-shell/spinner/png2header.py (+87/-0)miral-shell/spinner/splash.h (+45/-0)miral-shell/tiling_window_manager.cpp (+677/-0)miral-shell/tiling_window_manager.h (+141/-0)miral-shell/titlebar_config.cpp (+38/-0)miral-shell/titlebar_config.h (+30/-0)miral-shell/titlebar_window_manager.cpp (+754/-0)miral-shell/titlebar_window_manager.h (+132/-0)miral/CMakeLists.txt (+124/-0)miral/active_outputs.cpp (+236/-0)miral/add_init_callback.cpp (+33/-0)miral/append_event_filter.cpp (+48/-0)miral/application.cpp (+51/-0)miral/application_authorizer.cpp (+129/-0)miral/application_info.cpp (+99/-0)miral/basic_window_manager.cpp (+1971/-0)miral/basic_window_manager.h (+226/-0)miral/both_versions.h (+38/-0)miral/canonical_window_manager.cpp (+77/-0)miral/command_line_option.cpp (+199/-0)miral/coordinate_translator.cpp (+51/-0)miral/coordinate_translator.h (+52/-0)miral/cursor_theme.cpp (+55/-0)miral/debug_extension.cpp (+51/-0)miral/display_configuration_option.cpp (+115/-0)miral/internal_client.cpp (+176/-0)miral/keymap.cpp (+189/-0)miral/mir_features.h.in (+29/-0)miral/miral.pc.in (+9/-0)miral/mirclientcpp.pc.in (+7/-0)miral/mru_window_list.cpp (+66/-0)miral/mru_window_list.h (+46/-0)miral/output.cpp (+118/-0)miral/runner.cpp (+284/-0)miral/set_command_line_hander.cpp (+33/-0)miral/set_terminator.cpp (+33/-0)miral/set_window_managment_policy.cpp (+68/-0)miral/symbols.map (+397/-0)miral/version.h.in (+67/-0)miral/window.cpp (+127/-0)miral/window_info.cpp (+594/-0)miral/window_management_options.cpp (+93/-0)miral/window_management_policy.cpp (+37/-0)miral/window_management_trace.cpp (+739/-0)miral/window_management_trace.h (+139/-0)miral/window_manager_tools.cpp (+123/-0)miral/window_manager_tools_implementation.h (+101/-0)miral/window_specification.cpp (+644/-0)miral/workspace_policy.cpp (+29/-0)miral/xcursor.c (+899/-0)miral/xcursor.h (+62/-0)miral/xcursor_loader.cpp (+227/-0)miral/xcursor_loader.h (+66/-0)scripts/filter_symbols_diff.sh (+2/-0)scripts/process_doxygen_xml.py (+600/-0)tasks_for_the_interested_reader.md (+79/-0)test/CMakeLists.txt (+74/-0)test/active_outputs.cpp (+205/-0)test/active_window.cpp (+378/-0)test/display_reconfiguration.cpp (+89/-0)test/drag_active_window.cpp (+155/-0)test/modify_window_state.cpp (+107/-0)test/mru_window_list.cpp (+193/-0)test/raise_tree.cpp (+95/-0)test/runner.cpp (+49/-0)test/select_active_window.cpp (+123/-0)test/test_server.cpp (+202/-0)test/test_server.h (+91/-0)test/test_window_manager_tools.h (+179/-0)test/window_id.cpp (+156/-0)test/window_placement.cpp (+554/-0)test/window_placement_anchors_to_parent.cpp (+208/-0)test/window_placement_client_api.cpp (+159/-0)test/window_properties.cpp (+153/-0)test/workspaces.cpp (+603/-0) Conflict adding file .bzr-builddeb. Moved existing file to .bzr-builddeb.moved. Conflict adding file .bzrignore. Moved existing file to .bzrignore.moved. Conflict adding file CMakeLists.txt. Moved existing file to CMakeLists.txt.moved. Conflict adding file README.md. Moved existing file to README.md.moved. Conflict adding file cmake. Moved existing file to cmake.moved. Conflict adding file debian. Moved existing file to debian.moved. Conflict adding file doc. Moved existing file to doc.moved. Conflict adding file include. Moved existing file to include.moved.  bzr merge lp:~alan-griffiths/mir/fix-1668651
Reviewer Review Type Date Requested Status
Mir development team Pending

### Commit message

Untangle part of the (largely hidden) miral-shell shutdown mess.

### Description of the change

Untangle part of the miral-shell shutdown mess.

Closing the server caused the internal client to kill the server with SIGHUP which "just" resulted in an EXIT_FAILURE.

The server now closes cleanly (but the client code doesn't clear down correctly - working on that in a follow-up).

## Unmerged revisions

526. By Alan Griffiths

525. By Alan Griffiths

Don't kill the server with a SIGHUP

524. By Alan Griffiths

Don't treat workaround window as a titlebar

523. By Alan Griffiths

Update debian/changelog

522. By Alan Griffiths

[mirclientcpp] Avoid unnecessary include of deprecated functions

521. By Alan Griffiths

[libmiral] Fix initialization order so that policies can allocate workspaces when constructed

520. By Alan Griffiths

[libmiral] Workaround for server crash (LP: #1667645)

519. By Alan Griffiths

[libmirclientcpp] Prevent accidental double-release by deleting release functions for handle classes

518. By Alan Griffiths

[miral-kiosk] Use libmirclientcpp where possible

517. By Alan Griffiths

 1 === added directory '.bzr-builddeb' 2 === renamed directory '.bzr-builddeb' => '.bzr-builddeb.moved' 3 === added file '.bzr-builddeb/default.conf' 4 --- .bzr-builddeb/default.conf 1970-01-01 00:00:00 +0000 5 +++ .bzr-builddeb/default.conf 2017-03-01 12:28:42 +0000 6 @@ -0,0 +1,2 @@ 7 +[BUILDDEB] 8 +split = True 9 10 === added file '.bzrignore' 11 --- .bzrignore 1970-01-01 00:00:00 +0000 12 +++ .bzrignore 2017-03-01 12:28:42 +0000 13 @@ -0,0 +1,3 @@ 14 +include/mir/client/detail/mir_features.h 15 +include/miral/version.h 16 +.idea 17 18 === renamed file '.bzrignore' => '.bzrignore.moved' 19 === added file 'CMakeLists.txt' 20 --- CMakeLists.txt 1970-01-01 00:00:00 +0000 21 +++ CMakeLists.txt 2017-03-01 12:28:42 +0000 22 @@ -0,0 +1,78 @@ 23 +cmake_minimum_required(VERSION 3.1) 24 +project(miral) 25 + 26 +if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) 27 + set(CMAKE_INSTALL_PREFIX "/usr" CACHE PATH "/usr install prefix" FORCE) 28 +endif() 29 + 30 +include (GNUInstallDirs) 31 +include(CheckCXXCompilerFlag) 32 + 33 +cmake_policy(SET CMP0015 NEW) 34 +cmake_policy(SET CMP0022 NEW) 35 + 36 +set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH}${CMAKE_CURRENT_SOURCE_DIR}/cmake) 37 + 38 +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 39 +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY${CMAKE_BINARY_DIR}/lib) 40 + 41 +set(CMAKE_CXX_STANDARD 14) 42 +set(CMAKE_CXX_STANDARD_REQUIRED on) 43 +set(CMAKE_CXX_EXTENSIONS off) 44 + 45 +set(CMAKE_C_STANDARD 99) 46 +set(CMAKE_C_STANDARD_REQUIRED on) 47 +set(CMAKE_C_EXTENSIONS off) 48 + 49 +set(MIRAL_COMPILER_FLAGS "-pthread -g -Werror -Wall -pedantic -Wextra -fPIC") 50 +set(MIRAL_LINKER_FLAGS "-Wl,-z,defs") 51 + 52 +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}${MIRAL_COMPILER_FLAGS}") 53 +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}${MIRAL_COMPILER_FLAGS} -Wnon-virtual-dtor") 54 +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-long-long") # fix spurious FTBFS on X+O 55 +set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 56 +set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 57 +set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 58 + 59 +include(FindPkgConfig) 60 + 61 +pkg_check_modules(MIRCLIENT mirclient>=0.20 REQUIRED) 62 + 63 +include_directories(include SYSTEM${MIRCLIENT_INCLUDE_DIRS}) 64 + 65 +set(MIRAL_VERSION_MAJOR 1) 66 +set(MIRAL_VERSION_MINOR 3) 67 +set(MIRAL_VERSION_PATCH 0) 68 + 69 +set(MIRAL_VERSION ${MIRAL_VERSION_MAJOR}.${MIRAL_VERSION_MINOR}.${MIRAL_VERSION_PATCH}) 70 + 71 +add_subdirectory(miral) 72 +add_subdirectory(miral-shell) 73 +add_subdirectory(miral-kiosk) 74 + 75 +pkg_check_modules(MIRTEST mirtest) 76 +if(NOT MIRTEST_FOUND) 77 + message(WARNING "mirtest-dev package not installed - tests cannot be built") 78 +else() 79 + if (MIRTEST_VERSION VERSION_LESS 0.24) 80 + # building the tests is disabled by default because the mirtest-dev package is broken on xenial 81 + # (lp:1583536 and lp:1603080) 82 + option(MIRAL_ENABLE_TESTS "Build tests" off) 83 + else() 84 + option(MIRAL_ENABLE_TESTS "Build tests" on) 85 + endif() 86 + 87 +if (MIRAL_ENABLE_TESTS) 88 + enable_testing() 89 + find_package(GMock REQUIRED) 90 + add_subdirectory(test) 91 +endif() 92 +endif() 93 + 94 +include (cmake/Doxygen.cmake) 95 + 96 +if(TARGET doc) 97 + add_custom_target(symbols 98 +${CMAKE_SOURCE_DIR}/scripts/process_doxygen_xml.py ${CMAKE_BINARY_DIR}/doc/xml/*.xml >${CMAKE_SOURCE_DIR}/miral/symbols.map 99 + DEPENDS doc) 100 +endif() 101 102 === renamed file 'CMakeLists.txt' => 'CMakeLists.txt.moved' 103 === added file 'COPYING' 104 --- COPYING 1970-01-01 00:00:00 +0000 105 +++ COPYING 2017-03-01 12:28:42 +0000 106 @@ -0,0 +1,674 @@ 107 + GNU GENERAL PUBLIC LICENSE 108 + Version 3, 29 June 2007 109 + 110 + Copyright (C) 2007 Free Software Foundation, Inc. 111 + Everyone is permitted to copy and distribute verbatim copies 112 + of this license document, but changing it is not allowed. 113 + 114 + Preamble 115 + 116 + The GNU General Public License is a free, copyleft license for 117 +software and other kinds of works. 118 + 119 + The licenses for most software and other practical works are designed 120 +to take away your freedom to share and change the works. By contrast, 121 +the GNU General Public License is intended to guarantee your freedom to 122 +share and change all versions of a program--to make sure it remains free 123 +software for all its users. We, the Free Software Foundation, use the 124 +GNU General Public License for most of our software; it applies also to 125 +any other work released this way by its authors. You can apply it to 126 +your programs, too. 127 + 128 + When we speak of free software, we are referring to freedom, not 129 +price. Our General Public Licenses are designed to make sure that you 130 +have the freedom to distribute copies of free software (and charge for 131 +them if you wish), that you receive source code or can get it if you 132 +want it, that you can change the software or use pieces of it in new 133 +free programs, and that you know you can do these things. 134 + 135 + To protect your rights, we need to prevent others from denying you 136 +these rights or asking you to surrender the rights. Therefore, you have 137 +certain responsibilities if you distribute copies of the software, or if 138 +you modify it: responsibilities to respect the freedom of others. 139 + 140 + For example, if you distribute copies of such a program, whether 141 +gratis or for a fee, you must pass on to the recipients the same 142 +freedoms that you received. You must make sure that they, too, receive 143 +or can get the source code. And you must show them these terms so they 144 +know their rights. 145 + 146 + Developers that use the GNU GPL protect your rights with two steps: 147 +(1) assert copyright on the software, and (2) offer you this License 148 +giving you legal permission to copy, distribute and/or modify it. 149 + 150 + For the developers' and authors' protection, the GPL clearly explains 151 +that there is no warranty for this free software. For both users' and 152 +authors' sake, the GPL requires that modified versions be marked as 153 +changed, so that their problems will not be attributed erroneously to 154 +authors of previous versions. 155 + 156 + Some devices are designed to deny users access to install or run 157 +modified versions of the software inside them, although the manufacturer 158 +can do so. This is fundamentally incompatible with the aim of 159 +protecting users' freedom to change the software. The systematic 160 +pattern of such abuse occurs in the area of products for individuals to 161 +use, which is precisely where it is most unacceptable. Therefore, we 162 +have designed this version of the GPL to prohibit the practice for those 163 +products. If such problems arise substantially in other domains, we 164 +stand ready to extend this provision to those domains in future versions 165 +of the GPL, as needed to protect the freedom of users. 166 + 167 + Finally, every program is threatened constantly by software patents. 168 +States should not allow patents to restrict development and use of 169 +software on general-purpose computers, but in those that do, we wish to 170 +avoid the special danger that patents applied to a free program could 171 +make it effectively proprietary. To prevent this, the GPL assures that 172 +patents cannot be used to render the program non-free. 173 + 174 + The precise terms and conditions for copying, distribution and 175 +modification follow. 176 + 177 + TERMS AND CONDITIONS 178 + 179 + 0. Definitions. 180 + 181 + "This License" refers to version 3 of the GNU General Public License. 182 + 183 + "Copyright" also means copyright-like laws that apply to other kinds of 184 +works, such as semiconductor masks. 185 + 186 + "The Program" refers to any copyrightable work licensed under this 187 +License. Each licensee is addressed as "you". "Licensees" and 188 +"recipients" may be individuals or organizations. 189 + 190 + To "modify" a work means to copy from or adapt all or part of the work 191 +in a fashion requiring copyright permission, other than the making of an 192 +exact copy. The resulting work is called a "modified version" of the 193 +earlier work or a work "based on" the earlier work. 194 + 195 + A "covered work" means either the unmodified Program or a work based 196 +on the Program. 197 + 198 + To "propagate" a work means to do anything with it that, without 199 +permission, would make you directly or secondarily liable for 200 +infringement under applicable copyright law, except executing it on a 201 +computer or modifying a private copy. Propagation includes copying, 202 +distribution (with or without modification), making available to the 203 +public, and in some countries other activities as well. 204 + 205 + To "convey" a work means any kind of propagation that enables other 206 +parties to make or receive copies. Mere interaction with a user through 207 +a computer network, with no transfer of a copy, is not conveying. 208 + 209 + An interactive user interface displays "Appropriate Legal Notices" 210 +to the extent that it includes a convenient and prominently visible 211 +feature that (1) displays an appropriate copyright notice, and (2) 212 +tells the user that there is no warranty for the work (except to the 213 +extent that warranties are provided), that licensees may convey the 214 +work under this License, and how to view a copy of this License. If 215 +the interface presents a list of user commands or options, such as a 216 +menu, a prominent item in the list meets this criterion. 217 + 218 + 1. Source Code. 219 + 220 + The "source code" for a work means the preferred form of the work 221 +for making modifications to it. "Object code" means any non-source 222 +form of a work. 223 + 224 + A "Standard Interface" means an interface that either is an official 225 +standard defined by a recognized standards body, or, in the case of 226 +interfaces specified for a particular programming language, one that 227 +is widely used among developers working in that language. 228 + 229 + The "System Libraries" of an executable work include anything, other 230 +than the work as a whole, that (a) is included in the normal form of 231 +packaging a Major Component, but which is not part of that Major 232 +Component, and (b) serves only to enable use of the work with that 233 +Major Component, or to implement a Standard Interface for which an 234 +implementation is available to the public in source code form. A 235 +"Major Component", in this context, means a major essential component 236 +(kernel, window system, and so on) of the specific operating system 237 +(if any) on which the executable work runs, or a compiler used to 238 +produce the work, or an object code interpreter used to run it. 239 + 240 + The "Corresponding Source" for a work in object code form means all 241 +the source code needed to generate, install, and (for an executable 242 +work) run the object code and to modify the work, including scripts to 243 +control those activities. However, it does not include the work's 244 +System Libraries, or general-purpose tools or generally available free 245 +programs which are used unmodified in performing those activities but 246 +which are not part of the work. For example, Corresponding Source 247 +includes interface definition files associated with source files for 248 +the work, and the source code for shared libraries and dynamically 249 +linked subprograms that the work is specifically designed to require, 250 +such as by intimate data communication or control flow between those 251 +subprograms and other parts of the work. 252 + 253 + The Corresponding Source need not include anything that users 254 +can regenerate automatically from other parts of the Corresponding 255 +Source. 256 + 257 + The Corresponding Source for a work in source code form is that 258 +same work. 259 + 260 + 2. Basic Permissions. 261 + 262 + All rights granted under this License are granted for the term of 263 +copyright on the Program, and are irrevocable provided the stated 264 +conditions are met. This License explicitly affirms your unlimited 265 +permission to run the unmodified Program. The output from running a 266 +covered work is covered by this License only if the output, given its 267 +content, constitutes a covered work. This License acknowledges your 268 +rights of fair use or other equivalent, as provided by copyright law. 269 + 270 + You may make, run and propagate covered works that you do not 271 +convey, without conditions so long as your license otherwise remains 272 +in force. You may convey covered works to others for the sole purpose 273 +of having them make modifications exclusively for you, or provide you 274 +with facilities for running those works, provided that you comply with 275 +the terms of this License in conveying all material for which you do 276 +not control copyright. Those thus making or running the covered works 277 +for you must do so exclusively on your behalf, under your direction 278 +and control, on terms that prohibit them from making any copies of 279 +your copyrighted material outside their relationship with you. 280 + 281 + Conveying under any other circumstances is permitted solely under 282 +the conditions stated below. Sublicensing is not allowed; section 10 283 +makes it unnecessary. 284 + 285 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 286 + 287 + No covered work shall be deemed part of an effective technological 288 +measure under any applicable law fulfilling obligations under article 289 +11 of the WIPO copyright treaty adopted on 20 December 1996, or 290 +similar laws prohibiting or restricting circumvention of such 291 +measures. 292 + 293 + When you convey a covered work, you waive any legal power to forbid 294 +circumvention of technological measures to the extent such circumvention 295 +is effected by exercising rights under this License with respect to 296 +the covered work, and you disclaim any intention to limit operation or 297 +modification of the work as a means of enforcing, against the work's 298 +users, your or third parties' legal rights to forbid circumvention of 299 +technological measures. 300 + 301 + 4. Conveying Verbatim Copies. 302 + 303 + You may convey verbatim copies of the Program's source code as you 304 +receive it, in any medium, provided that you conspicuously and 305 +appropriately publish on each copy an appropriate copyright notice; 306 +keep intact all notices stating that this License and any 307 +non-permissive terms added in accord with section 7 apply to the code; 308 +keep intact all notices of the absence of any warranty; and give all 309 +recipients a copy of this License along with the Program. 310 + 311 + You may charge any price or no price for each copy that you convey, 312 +and you may offer support or warranty protection for a fee. 313 + 314 + 5. Conveying Modified Source Versions. 315 + 316 + You may convey a work based on the Program, or the modifications to 317 +produce it from the Program, in the form of source code under the 318 +terms of section 4, provided that you also meet all of these conditions: 319 + 320 + a) The work must carry prominent notices stating that you modified 321 + it, and giving a relevant date. 322 + 323 + b) The work must carry prominent notices stating that it is 324 + released under this License and any conditions added under section 325 + 7. This requirement modifies the requirement in section 4 to 326 + "keep intact all notices". 327 + 328 + c) You must license the entire work, as a whole, under this 329 + License to anyone who comes into possession of a copy. This 330 + License will therefore apply, along with any applicable section 7 331 + additional terms, to the whole of the work, and all its parts, 332 + regardless of how they are packaged. This License gives no 333 + permission to license the work in any other way, but it does not 334 + invalidate such permission if you have separately received it. 335 + 336 + d) If the work has interactive user interfaces, each must display 337 + Appropriate Legal Notices; however, if the Program has interactive 338 + interfaces that do not display Appropriate Legal Notices, your 339 + work need not make them do so. 340 + 341 + A compilation of a covered work with other separate and independent 342 +works, which are not by their nature extensions of the covered work, 343 +and which are not combined with it such as to form a larger program, 344 +in or on a volume of a storage or distribution medium, is called an 345 +"aggregate" if the compilation and its resulting copyright are not 346 +used to limit the access or legal rights of the compilation's users 347 +beyond what the individual works permit. Inclusion of a covered work 348 +in an aggregate does not cause this License to apply to the other 349 +parts of the aggregate. 350 + 351 + 6. Conveying Non-Source Forms. 352 + 353 + You may convey a covered work in object code form under the terms 354 +of sections 4 and 5, provided that you also convey the 355 +machine-readable Corresponding Source under the terms of this License, 356 +in one of these ways: 357 + 358 + a) Convey the object code in, or embodied in, a physical product 359 + (including a physical distribution medium), accompanied by the 360 + Corresponding Source fixed on a durable physical medium 361 + customarily used for software interchange. 362 + 363 + b) Convey the object code in, or embodied in, a physical product 364 + (including a physical distribution medium), accompanied by a 365 + written offer, valid for at least three years and valid for as 366 + long as you offer spare parts or customer support for that product 367 + model, to give anyone who possesses the object code either (1) a 368 + copy of the Corresponding Source for all the software in the 369 + product that is covered by this License, on a durable physical 370 + medium customarily used for software interchange, for a price no 371 + more than your reasonable cost of physically performing this 372 + conveying of source, or (2) access to copy the 373 + Corresponding Source from a network server at no charge. 374 + 375 + c) Convey individual copies of the object code with a copy of the 376 + written offer to provide the Corresponding Source. This 377 + alternative is allowed only occasionally and noncommercially, and 378 + only if you received the object code with such an offer, in accord 379 + with subsection 6b. 380 + 381 + d) Convey the object code by offering access from a designated 382 + place (gratis or for a charge), and offer equivalent access to the 383 + Corresponding Source in the same way through the same place at no 384 + further charge. You need not require recipients to copy the 385 + Corresponding Source along with the object code. If the place to 386 + copy the object code is a network server, the Corresponding Source 387 + may be on a different server (operated by you or a third party) 388 + that supports equivalent copying facilities, provided you maintain 389 + clear directions next to the object code saying where to find the 390 + Corresponding Source. Regardless of what server hosts the 391 + Corresponding Source, you remain obligated to ensure that it is 392 + available for as long as needed to satisfy these requirements. 393 + 394 + e) Convey the object code using peer-to-peer transmission, provided 395 + you inform other peers where the object code and Corresponding 396 + Source of the work are being offered to the general public at no 397 + charge under subsection 6d. 398 + 399 + A separable portion of the object code, whose source code is excluded 400 +from the Corresponding Source as a System Library, need not be 401 +included in conveying the object code work. 402 + 403 + A "User Product" is either (1) a "consumer product", which means any 404 +tangible personal property which is normally used for personal, family, 405 +or household purposes, or (2) anything designed or sold for incorporation 406 +into a dwelling. In determining whether a product is a consumer product, 407 +doubtful cases shall be resolved in favor of coverage. For a particular 408 +product received by a particular user, "normally used" refers to a 409 +typical or common use of that class of product, regardless of the status 410 +of the particular user or of the way in which the particular user 411 +actually uses, or expects or is expected to use, the product. A product 412 +is a consumer product regardless of whether the product has substantial 413 +commercial, industrial or non-consumer uses, unless such uses represent 414 +the only significant mode of use of the product. 415 + 416 + "Installation Information" for a User Product means any methods, 417 +procedures, authorization keys, or other information required to install 418 +and execute modified versions of a covered work in that User Product from 419 +a modified version of its Corresponding Source. The information must 420 +suffice to ensure that the continued functioning of the modified object 421 +code is in no case prevented or interfered with solely because 422 +modification has been made. 423 + 424 + If you convey an object code work under this section in, or with, or 425 +specifically for use in, a User Product, and the conveying occurs as 426 +part of a transaction in which the right of possession and use of the 427 +User Product is transferred to the recipient in perpetuity or for a 428 +fixed term (regardless of how the transaction is characterized), the 429 +Corresponding Source conveyed under this section must be accompanied 430 +by the Installation Information. But this requirement does not apply 431 +if neither you nor any third party retains the ability to install 432 +modified object code on the User Product (for example, the work has 433 +been installed in ROM). 434 + 435 + The requirement to provide Installation Information does not include a 436 +requirement to continue to provide support service, warranty, or updates 437 +for a work that has been modified or installed by the recipient, or for 438 +the User Product in which it has been modified or installed. Access to a 439 +network may be denied when the modification itself materially and 440 +adversely affects the operation of the network or violates the rules and 441 +protocols for communication across the network. 442 + 443 + Corresponding Source conveyed, and Installation Information provided, 444 +in accord with this section must be in a format that is publicly 445 +documented (and with an implementation available to the public in 446 +source code form), and must require no special password or key for 447 +unpacking, reading or copying. 448 + 449 + 7. Additional Terms. 450 + 451 + "Additional permissions" are terms that supplement the terms of this 452 +License by making exceptions from one or more of its conditions. 453 +Additional permissions that are applicable to the entire Program shall 454 +be treated as though they were included in this License, to the extent 455 +that they are valid under applicable law. If additional permissions 456 +apply only to part of the Program, that part may be used separately 457 +under those permissions, but the entire Program remains governed by 458 +this License without regard to the additional permissions. 459 + 460 + When you convey a copy of a covered work, you may at your option 461 +remove any additional permissions from that copy, or from any part of 462 +it. (Additional permissions may be written to require their own 463 +removal in certain cases when you modify the work.) You may place 464 +additional permissions on material, added by you to a covered work, 465 +for which you have or can give appropriate copyright permission. 466 + 467 + Notwithstanding any other provision of this License, for material you 468 +add to a covered work, you may (if authorized by the copyright holders of 469 +that material) supplement the terms of this License with terms: 470 + 471 + a) Disclaiming warranty or limiting liability differently from the 472 + terms of sections 15 and 16 of this License; or 473 + 474 + b) Requiring preservation of specified reasonable legal notices or 475 + author attributions in that material or in the Appropriate Legal 476 + Notices displayed by works containing it; or 477 + 478 + c) Prohibiting misrepresentation of the origin of that material, or 479 + requiring that modified versions of such material be marked in 480 + reasonable ways as different from the original version; or 481 + 482 + d) Limiting the use for publicity purposes of names of licensors or 483 + authors of the material; or 484 + 485 + e) Declining to grant rights under trademark law for use of some 486 + trade names, trademarks, or service marks; or 487 + 488 + f) Requiring indemnification of licensors and authors of that 489 + material by anyone who conveys the material (or modified versions of 490 + it) with contractual assumptions of liability to the recipient, for 491 + any liability that these contractual assumptions directly impose on 492 + those licensors and authors. 493 + 494 + All other non-permissive additional terms are considered "further 495 +restrictions" within the meaning of section 10. If the Program as you 496 +received it, or any part of it, contains a notice stating that it is 497 +governed by this License along with a term that is a further 498 +restriction, you may remove that term. If a license document contains 499 +a further restriction but permits relicensing or conveying under this 500 +License, you may add to a covered work material governed by the terms 501 +of that license document, provided that the further restriction does 502 +not survive such relicensing or conveying. 503 + 504 + If you add terms to a covered work in accord with this section, you 505 +must place, in the relevant source files, a statement of the 506 +additional terms that apply to those files, or a notice indicating 507 +where to find the applicable terms. 508 + 509 + Additional terms, permissive or non-permissive, may be stated in the 510 +form of a separately written license, or stated as exceptions; 511 +the above requirements apply either way. 512 + 513 + 8. Termination. 514 + 515 + You may not propagate or modify a covered work except as expressly 516 +provided under this License. Any attempt otherwise to propagate or 517 +modify it is void, and will automatically terminate your rights under 518 +this License (including any patent licenses granted under the third 519 +paragraph of section 11). 520 + 521 + However, if you cease all violation of this License, then your 522 +license from a particular copyright holder is reinstated (a) 523 +provisionally, unless and until the copyright holder explicitly and 524 +finally terminates your license, and (b) permanently, if the copyright 525 +holder fails to notify you of the violation by some reasonable means 526 +prior to 60 days after the cessation. 527 + 528 + Moreover, your license from a particular copyright holder is 529 +reinstated permanently if the copyright holder notifies you of the 530 +violation by some reasonable means, this is the first time you have 531 +received notice of violation of this License (for any work) from that 532 +copyright holder, and you cure the violation prior to 30 days after 533 +your receipt of the notice. 534 + 535 + Termination of your rights under this section does not terminate the 536 +licenses of parties who have received copies or rights from you under 537 +this License. If your rights have been terminated and not permanently 538 +reinstated, you do not qualify to receive new licenses for the same 539 +material under section 10. 540 + 541 + 9. Acceptance Not Required for Having Copies. 542 + 543 + You are not required to accept this License in order to receive or 544 +run a copy of the Program. Ancillary propagation of a covered work 545 +occurring solely as a consequence of using peer-to-peer transmission 546 +to receive a copy likewise does not require acceptance. However, 547 +nothing other than this License grants you permission to propagate or 548 +modify any covered work. These actions infringe copyright if you do 549 +not accept this License. Therefore, by modifying or propagating a 550 +covered work, you indicate your acceptance of this License to do so. 551 + 552 + 10. Automatic Licensing of Downstream Recipients. 553 + 554 + Each time you convey a covered work, the recipient automatically 555 +receives a license from the original licensors, to run, modify and 556 +propagate that work, subject to this License. You are not responsible 557 +for enforcing compliance by third parties with this License. 558 + 559 + An "entity transaction" is a transaction transferring control of an 560 +organization, or substantially all assets of one, or subdividing an 561 +organization, or merging organizations. If propagation of a covered 562 +work results from an entity transaction, each party to that 563 +transaction who receives a copy of the work also receives whatever 564 +licenses to the work the party's predecessor in interest had or could 565 +give under the previous paragraph, plus a right to possession of the 566 +Corresponding Source of the work from the predecessor in interest, if 567 +the predecessor has it or can get it with reasonable efforts. 568 + 569 + You may not impose any further restrictions on the exercise of the 570 +rights granted or affirmed under this License. For example, you may 571 +not impose a license fee, royalty, or other charge for exercise of 572 +rights granted under this License, and you may not initiate litigation 573 +(including a cross-claim or counterclaim in a lawsuit) alleging that 574 +any patent claim is infringed by making, using, selling, offering for 575 +sale, or importing the Program or any portion of it. 576 + 577 + 11. Patents. 578 + 579 + A "contributor" is a copyright holder who authorizes use under this 580 +License of the Program or a work on which the Program is based. The 581 +work thus licensed is called the contributor's "contributor version". 582 + 583 + A contributor's "essential patent claims" are all patent claims 584 +owned or controlled by the contributor, whether already acquired or 585 +hereafter acquired, that would be infringed by some manner, permitted 586 +by this License, of making, using, or selling its contributor version, 587 +but do not include claims that would be infringed only as a 588 +consequence of further modification of the contributor version. For 589 +purposes of this definition, "control" includes the right to grant 590 +patent sublicenses in a manner consistent with the requirements of 591 +this License. 592 + 593 + Each contributor grants you a non-exclusive, worldwide, royalty-free 594 +patent license under the contributor's essential patent claims, to 595 +make, use, sell, offer for sale, import and otherwise run, modify and 596 +propagate the contents of its contributor version. 597 + 598 + In the following three paragraphs, a "patent license" is any express 599 +agreement or commitment, however denominated, not to enforce a patent 600 +(such as an express permission to practice a patent or covenant not to 601 +sue for patent infringement). To "grant" such a patent license to a 602 +party means to make such an agreement or commitment not to enforce a 603 +patent against the party. 604 + 605 + If you convey a covered work, knowingly relying on a patent license, 606 +and the Corresponding Source of the work is not available for anyone 607 +to copy, free of charge and under the terms of this License, through a 608 +publicly available network server or other readily accessible means, 609 +then you must either (1) cause the Corresponding Source to be so 610 +available, or (2) arrange to deprive yourself of the benefit of the 611 +patent license for this particular work, or (3) arrange, in a manner 612 +consistent with the requirements of this License, to extend the patent 613 +license to downstream recipients. "Knowingly relying" means you have 614 +actual knowledge that, but for the patent license, your conveying the 615 +covered work in a country, or your recipient's use of the covered work 616 +in a country, would infringe one or more identifiable patents in that 617 +country that you have reason to believe are valid. 618 + 619 + If, pursuant to or in connection with a single transaction or 620 +arrangement, you convey, or propagate by procuring conveyance of, a 621 +covered work, and grant a patent license to some of the parties 622 +receiving the covered work authorizing them to use, propagate, modify 623 +or convey a specific copy of the covered work, then the patent license 624 +you grant is automatically extended to all recipients of the covered 625 +work and works based on it. 626 + 627 + A patent license is "discriminatory" if it does not include within 628 +the scope of its coverage, prohibits the exercise of, or is 629 +conditioned on the non-exercise of one or more of the rights that are 630 +specifically granted under this License. You may not convey a covered 631 +work if you are a party to an arrangement with a third party that is 632 +in the business of distributing software, under which you make payment 633 +to the third party based on the extent of your activity of conveying 634 +the work, and under which the third party grants, to any of the 635 +parties who would receive the covered work from you, a discriminatory 636 +patent license (a) in connection with copies of the covered work 637 +conveyed by you (or copies made from those copies), or (b) primarily 638 +for and in connection with specific products or compilations that 639 +contain the covered work, unless you entered into that arrangement, 640 +or that patent license was granted, prior to 28 March 2007. 641 + 642 + Nothing in this License shall be construed as excluding or limiting 643 +any implied license or other defenses to infringement that may 644 +otherwise be available to you under applicable patent law. 645 + 646 + 12. No Surrender of Others' Freedom. 647 + 648 + If conditions are imposed on you (whether by court order, agreement or 649 +otherwise) that contradict the conditions of this License, they do not 650 +excuse you from the conditions of this License. If you cannot convey a 651 +covered work so as to satisfy simultaneously your obligations under this 652 +License and any other pertinent obligations, then as a consequence you may 653 +not convey it at all. For example, if you agree to terms that obligate you 654 +to collect a royalty for further conveying from those to whom you convey 655 +the Program, the only way you could satisfy both those terms and this 656 +License would be to refrain entirely from conveying the Program. 657 + 658 + 13. Use with the GNU Affero General Public License. 659 + 660 + Notwithstanding any other provision of this License, you have 661 +permission to link or combine any covered work with a work licensed 662 +under version 3 of the GNU Affero General Public License into a single 663 +combined work, and to convey the resulting work. The terms of this 664 +License will continue to apply to the part which is the covered work, 665 +but the special requirements of the GNU Affero General Public License, 666 +section 13, concerning interaction through a network will apply to the 667 +combination as such. 668 + 669 + 14. Revised Versions of this License. 670 + 671 + The Free Software Foundation may publish revised and/or new versions of 672 +the GNU General Public License from time to time. Such new versions will 673 +be similar in spirit to the present version, but may differ in detail to 674 +address new problems or concerns. 675 + 676 + Each version is given a distinguishing version number. If the 677 +Program specifies that a certain numbered version of the GNU General 678 +Public License "or any later version" applies to it, you have the 679 +option of following the terms and conditions either of that numbered 680 +version or of any later version published by the Free Software 681 +Foundation. If the Program does not specify a version number of the 682 +GNU General Public License, you may choose any version ever published 683 +by the Free Software Foundation. 684 + 685 + If the Program specifies that a proxy can decide which future 686 +versions of the GNU General Public License can be used, that proxy's 687 +public statement of acceptance of a version permanently authorizes you 688 +to choose that version for the Program. 689 + 690 + Later license versions may give you additional or different 691 +permissions. However, no additional obligations are imposed on any 692 +author or copyright holder as a result of your choosing to follow a 693 +later version. 694 + 695 + 15. Disclaimer of Warranty. 696 + 697 + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 698 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 699 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 700 +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 701 +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 702 +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 703 +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 704 +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 705 + 706 + 16. Limitation of Liability. 707 + 708 + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 709 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 710 +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 711 +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 712 +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 713 +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 714 +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 715 +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 716 +SUCH DAMAGES. 717 + 718 + 17. Interpretation of Sections 15 and 16. 719 + 720 + If the disclaimer of warranty and limitation of liability provided 721 +above cannot be given local legal effect according to their terms, 722 +reviewing courts shall apply local law that most closely approximates 723 +an absolute waiver of all civil liability in connection with the 724 +Program, unless a warranty or assumption of liability accompanies a 725 +copy of the Program in return for a fee. 726 + 727 + END OF TERMS AND CONDITIONS 728 + 729 + How to Apply These Terms to Your New Programs 730 + 731 + If you develop a new program, and you want it to be of the greatest 732 +possible use to the public, the best way to achieve this is to make it 733 +free software which everyone can redistribute and change under these terms. 734 + 735 + To do so, attach the following notices to the program. It is safest 736 +to attach them to the start of each source file to most effectively 737 +state the exclusion of warranty; and each file should have at least 738 +the "copyright" line and a pointer to where the full notice is found. 739 + 740 + 741 + Copyright (C) 742 + 743 + This program is free software: you can redistribute it and/or modify 744 + it under the terms of the GNU General Public License as published by 745 + the Free Software Foundation, either version 3 of the License, or 746 + (at your option) any later version. 747 + 748 + This program is distributed in the hope that it will be useful, 749 + but WITHOUT ANY WARRANTY; without even the implied warranty of 750 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 751 + GNU General Public License for more details. 752 + 753 + You should have received a copy of the GNU General Public License 754 + along with this program. If not, see . 755 + 756 +Also add information on how to contact you by electronic and paper mail. 757 + 758 + If the program does terminal interaction, make it output a short 759 +notice like this when it starts in an interactive mode: 760 + 761 + Copyright (C) 762 + This program comes with ABSOLUTELY NO WARRANTY; for details type show w'. 763 + This is free software, and you are welcome to redistribute it 764 + under certain conditions; type show c' for details. 765 + 766 +The hypothetical commands show w' and show c' should show the appropriate 767 +parts of the General Public License. Of course, your program's commands 768 +might be different; for a GUI interface, you would use an "about box". 769 + 770 + You should also get your employer (if you work as a programmer) or school, 771 +if any, to sign a "copyright disclaimer" for the program, if necessary. 772 +For more information on this, and how to apply and follow the GNU GPL, see 773 +. 774 + 775 + The GNU General Public License does not permit incorporating your program 776 +into proprietary programs. If your program is a subroutine library, you 777 +may consider it more useful to permit linking proprietary applications with 778 +the library. If this is what you want to do, use the GNU Lesser General 779 +Public License instead of this License. But first, please read 780 +. 781 782 === added file 'README.md' 783 --- README.md 1970-01-01 00:00:00 +0000 784 +++ README.md 2017-03-01 12:28:42 +0000 785 @@ -0,0 +1,46 @@ 786 +Readme 787 +====== 788 + 789 +MirAL - The Mir Abstraction Layer 790 +--------------------------------- 791 + 792 +MirAL aims to provide a stable “abstraction layer” written over the top of the 793 +Mir server API that will provide a stable ABI. There are a number of other 794 +goals that can be addressed at the same time: 795 + 796 + - The API can be considerably narrowed as a lot of things can be customized 797 + that are of no interest to shell development; 798 + - A more declarative design style can be follow than the implementation 799 + focussed approach that the Mir server API follows; and, 800 + - Common facilities that don’t belong in the Mir libraries can be provided. 801 + 802 +The Mir Abstraction Layer (miral) is a both a proof-of-concept and a 803 +work-in-progress but may be of interest as modern C++ codebase to experiment 804 +with. 805 + 806 +There are two significant components to the MirAL project: 807 + 808 + - libmiral.so is the abstraction library itself 809 + - miral-shell is an example shell demonstrating the use of libmiral 810 + 811 +See also: 812 + 813 + - \ref getting_and_using_miral "Getting and using Miral" 814 + - \ref tasks_for_the_interested_reader "Tasks for the interested reader" 815 + 816 +License 817 +------- 818 +This program is free software: you can redistribute it and/or modify 819 +it under the terms of the GNU General Public License version 3 as 820 +published by the Free Software Foundation. 821 + 822 +This program is distributed in the hope that it will be useful, 823 +but WITHOUT ANY WARRANTY; without even the implied warranty of 824 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 825 +GNU General Public License for more details. 826 + 827 +You should have received a copy of the GNU General Public License 828 +along with this program. If not, see . 829 + 830 +\copyright Copyright © 2016-2017 Canonical Ltd. 831 +\author Alan Griffiths 832 833 === renamed file 'README.md' => 'README.md.moved' 834 === added directory 'cmake' 835 === renamed directory 'cmake' => 'cmake.moved' 836 === added file 'cmake/Doxygen.cmake' 837 --- cmake/Doxygen.cmake 1970-01-01 00:00:00 +0000 838 +++ cmake/Doxygen.cmake 2017-03-01 12:28:42 +0000 839 @@ -0,0 +1,26 @@ 840 +# Check if doxygen is present and add 'make doc' target 841 +find_package(Doxygen) 842 + 843 +option( 844 + BUILD_DOXYGEN 845 + "Build Doxygen documentation as part of the default build" 846 + OFF 847 +) 848 + 849 +if(DOXYGEN_FOUND AND (DOXYGEN_VERSION VERSION_GREATER "1.8")) 850 + message(STATUS "doxygen ${DOXYGEN_VERSION} (>= 1.8.0) available - enabling make target doc") 851 + EXECUTE_PROCESS(COMMAND "date" "-u" OUTPUT_VARIABLE DATE_TODAY) 852 + configure_file(doc/Doxyfile.in 853 +${PROJECT_BINARY_DIR}/Doxyfile @ONLY IMMEDIATE) 854 + configure_file(doc/footer.html.in 855 + ${PROJECT_BINARY_DIR}/doc/footer.html @ONLY IMMEDIATE) 856 + configure_file(doc/extra.css 857 +${PROJECT_BINARY_DIR}/doc/extra.css @ONLY IMMEDIATE) 858 + if (BUILD_DOXYGEN) 859 + set(ALL "ALL") 860 + endif() 861 + add_custom_target(doc ${ALL} 862 + COMMAND${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile 863 + SOURCES${PROJECT_BINARY_DIR}/Doxyfile) 864 + install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html DESTINATION${CMAKE_INSTALL_PREFIX}/share/doc/miral-doc/ OPTIONAL) 865 +endif() 866 867 === added file 'cmake/FindGLESv2.cmake' 868 --- cmake/FindGLESv2.cmake 1970-01-01 00:00:00 +0000 869 +++ cmake/FindGLESv2.cmake 2017-03-01 12:28:42 +0000 870 @@ -0,0 +1,25 @@ 871 +# - Try to find GLESv2 872 +# Once done this will define 873 +# GLESv2_FOUND - System has GLESv2 874 +# GLESv2_INCLUDE_DIRS - The GLESv2 include directories 875 +# GLESv2_LIBRARIES - The libraries needed to use GLESv2 876 + 877 +find_package(PkgConfig) 878 +pkg_check_modules(PC_GLESv2 QUIET glesv2) 879 + 880 +find_path(GLESv2_INCLUDE_DIR GLES2/gl2.h 881 + HINTS ${PC_GLESv2_INCLUDEDIR}${PC_GLESv2_INCLUDE_DIRS}) 882 + 883 +find_library(GLESv2_LIBRARY GLESv2 884 + HINTS ${PC_GLESv2_LIBDIR}${PC_GLESv2_LIBRARY_DIRS}) 885 + 886 +set(GLESv2_LIBRARIES ${GLESv2_LIBRARY}) 887 +set(GLESv2_INCLUDE_DIRS${GLESv2_INCLUDE_DIR}) 888 + 889 +include(FindPackageHandleStandardArgs) 890 +# handle the QUIETLY and REQUIRED arguments and set GLESv2_FOUND to TRUE 891 +# if all listed variables are TRUE 892 +find_package_handle_standard_args(GLESv2 DEFAULT_MSG 893 + GLESv2_LIBRARY GLESv2_INCLUDE_DIR) 894 + 895 +mark_as_advanced(GLESv2_INCLUDE_DIR GLESv2_LIBRARY) 896 897 === added file 'cmake/FindPIL.cmake' 898 --- cmake/FindPIL.cmake 1970-01-01 00:00:00 +0000 899 +++ cmake/FindPIL.cmake 2017-03-01 12:28:42 +0000 900 @@ -0,0 +1,8 @@ 901 +execute_process( 902 + COMMAND python -c "from PIL import Image" 903 + RESULT_VARIABLE HAVE_PIL 904 +) 905 + 906 +if (NOT ${HAVE_PIL} EQUAL 0) 907 + message(FATAL_ERROR "Python Imaging Library (PIL) not found") 908 +endif() 909 910 === added directory 'debian' 911 === renamed directory 'debian' => 'debian.moved' 912 === added file 'debian/changelog' 913 --- debian/changelog 1970-01-01 00:00:00 +0000 914 +++ debian/changelog 2017-03-01 12:28:42 +0000 915 @@ -0,0 +1,227 @@ 916 +miral (1.3.0) UNRELEASED; urgency=medium 917 + 918 + * New upstream release 1.3.0 (https://launchpad.net/miral/+milestone/1.3) 919 + 920 + - ABI summary: 921 + . miral ABI unchanged at 2 922 + - Enhancements: 923 + . [libmiral] Support for workspaces 924 + . [miral-shell] Example workspaces implementation 925 + . [miral-shell] Use background to show keyboard shortcuts 926 + . [libmirclientcpp] A better description of libmirclientcpp-dev 927 + . [libmirclientcpp] Prevent accidental double-release by deleting release 928 + functions for handle classes 929 + . [libmirclientcpp] Add RAII wrapper for MirDisplayConfig. 930 + - Bugs fixed: 931 + . [miral-shell] Workaround for crash on exit (LP: #1667645) 932 + 933 + -- Alan Griffiths Thu, 02 Feb 2017 17:26:54 +0000 934 + 935 +miral (1.2.0+17.04.20170215.1-0ubuntu1) zesty; urgency=medium 936 + 937 + * New upstream release 1.2.0 (https://launchpad.net/miral/+milestone/1.2) 938 + 939 + - ABI summary: 940 + . miral ABI unchanged at 2 941 + - Enhancements: 942 + . New libmirclientcpp-dev package "C++ wrapper for libmirclient". (Split 943 + from libmiral-dev) 944 + . Give miral-app and miral-desktop a good default for -bindir 945 + . More surface to window renaming to reflect Mir name changes 946 + . Refresh the "Building and Using MirAL" doc 947 + - Bugs fixed: 948 + . Chrome-less shell hint does not work any more (LP: #1658117) 949 + . WindowSpec::set_state() wrapper for mir_window_spec_set_state() 950 + (LP: #1661256) 951 + . "$ miral-app -kiosk" fails with "Unknown command line options: 952 + --desktop_file_hint=miral-shell.desktop" (LP: #1660933) 953 + . libmiral] Fix focus and movement rules for Input Method and Satellite 954 + windows. (LP: #1660691) 955 + 956 + 957 + -- Alan Griffiths Wed, 15 Feb 2017 14:05:46 +0000 958 + 959 +miral (1.1.0+17.04.20170127-0ubuntu1) zesty; urgency=medium 960 + 961 + [ Alan Griffiths ] 962 + * New upstream release 1.1.0 (https://launchpad.net/miral/+milestone/1.1) 963 + - ABI summary: 964 + . miral ABI unchanged at 2 965 + - Enhancements: 966 + . Compatibility with Mir 0.26 and update API to use the new Mir types and 967 + enums. 968 + . Logging of exceptions added to --window-management-trace 969 + . Rename WindowManagementPolicy::place_new_surface => place_new_window" 970 + - Bugs fixed: 971 + . top-level window is not raised along with its child (LP: #1658085) 972 + . miral-shell depends on default cursor theme being installed 973 + (LP: #1658159) 974 + 975 + -- Cemil Azizoglu Fri, 27 Jan 2017 03:02:28 +0000 976 + 977 +miral (1.0.2+17.04.20170118.1-0ubuntu1) zesty; urgency=medium 978 + 979 + * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0) 980 + - ABI summary: 981 + . miral ABI unchanged at 2 982 + - Enhancements: 983 + - Bugs fixed: 984 + . Let the policy decide how to handle "ready" for windows that can't have 985 + focus (LP: #1652109) 986 + 987 + -- Alan Griffiths Wed, 18 Jan 2017 18:17:47 +0000 988 + 989 +miral (1.0.1+17.04.20161220-0ubuntu1) zesty; urgency=medium 990 + 991 + * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0) 992 + - ABI summary: 993 + . miral ABI unchanged at 2 994 + - Enhancements: 995 + . None 996 + - Bugs fixed: 997 + . Workaround for a missing dependency in Mir packaging (LP: #1651391) 998 + . Avoid double lock in WindowManagerTools::force_close() (LP: #1646735) 999 + . Fix typo in miral-app script 1000 + 1001 + -- Alan Griffiths Tue, 20 Dec 2016 16:00:02 +0000 1002 + 1003 +miral (1.0.0+17.04.20161216-0ubuntu1) zesty; urgency=medium 1004 + 1005 + [ Alan Griffiths ] 1006 + * New upstream release 1.0.0 (https://launchpad.net/miral/+milestone/1.0) 1007 + - ABI summary: 1008 + . miral ABI bumped to 2 1009 + - Enhancements: 1010 + . Allow the WM policy a say in inherited moves of child windows 1011 + . Remove deprecated APIs 1012 + . add miral-app script to launch examples hosted by an existing desktop 1013 + - Bugs fixed: 1014 + . Examples fail to start under Unity8 (LP: #1646431) 1015 + . [miral-shell --window-manager tiling] windows are not correctly 1016 + constrained to tiles (LP: #1646735) 1017 + 1018 + -- Brandon Schaefer Fri, 16 Dec 2016 00:36:20 +0000 1019 + 1020 +miral (0.5.0+17.04.20161203-0ubuntu1) zesty; urgency=medium 1021 + 1022 + * no change rebuild 1023 + 1024 + -- Brandon Schaefer Sat, 03 Dec 2016 12:38:23 +0000 1025 + 1026 +miral (0.5.0+17.04.20161130-0ubuntu1) zesty; urgency=medium 1027 + 1028 + * New upstream release 0.5.0 (https://launchpad.net/miral/+milestone/0.5) 1029 + - ABI summary: 1030 + . miral ABI unchanged at 1 1031 + - Enhancements: 1032 + . Add miral::DebugExtension allowing shells to enable & disable support 1033 + for debug extension API(s) dynamically 1034 + . Improve handling of fullscreen surfaces when switching outputs, or 1035 + specified output doesn't exist (any more) 1036 + . Initial tests and some fixes for tracking of active window. 1037 + . Document the order of windows passed to 1038 + WindowManagementPolicy::advise_raise() so clients can rely on it. 1039 + . [examples] Add miral-desktop script for launching a pseudo-desktop 1040 + . [examples] Add miral-screencast - a utility script to assist with 1041 + creating a screencast 1042 + . [examples: miral-shell --window-manager tiling] implement the layout 1043 + suggested in "Tasks for the interested reader" 1044 + . [examples: miral-shell --window-manager tiling] Don't place a tile 1045 + until the first window is ready 1046 + . [examples: miral-kiosk] Provide configuration options for kiosk: 1047 + --keymap --kiosk-maximize-root-windows & --kiosk-startup-apps-only 1048 + - Bugs fixed: 1049 + . Display configuration changes may cause "fatal errors" when there are 1050 + fullscreen windows (LP: #1640557) 1051 + 1052 + -- Alan Griffiths Wed, 30 Nov 2016 08:40:24 +0000 1053 + 1054 +miral (0.4.0+17.04.20161104-0ubuntu1) zesty; urgency=medium 1055 + 1056 + * New upstream release 0.4.0 (https://launchpad.net/miral/+milestone/0.4) 1057 + - ABI summary: 1058 + . miral ABI unchanged at 1 1059 + - Enhancements: 1060 + . Add miral::WindowManagerTools::force_close(window) to forcefully close 1061 + a window (i.e. without a close request to the client) 1062 + . Add functions to manage Applications 1063 + . Add miral::CommandLineOption - enables the setting and processing of 1064 + configuration options. These may be supplied on the commandline, as 1065 + MIR_SERVER_XXX environment variables or in a config file. 1066 + . Add +options to the keymap configuration 1067 + . [miral-shell] Add window name to titlebars 1068 + 1069 + -- Alan Griffiths Fri, 04 Nov 2016 16:45:44 +0000 1070 + 1071 +miral (0.3.0+17.04.20161028-0ubuntu1) zesty; urgency=medium 1072 + 1073 + * No change rebuild to target Xenial+Overlay 1074 + 1075 + -- Alan Griffiths Fri, 28 Oct 2016 16:03:16 +0000 1076 + 1077 +miral (0.3.0+17.04.20161024-0ubuntu1) zesty; urgency=medium 1078 + 1079 + * New upstream release 0.3.0 (https://launchpad.net/miral/+milestone/0.3) 1080 + - ABI summary: 1081 + . miral ABI unchanged at 1 1082 + - Enhancements: 1083 + . Add miral-xrun as a better way to use Xmir 1084 + . Added miral/version.h to allow permit compile-time feature detection 1085 + . A convenient overload of WindowManagerTools::modify_window() that 1086 + doesn't require the WindowInfo 1087 + . Add userdata property to WindowSpecification and copy it to WindowInfo 1088 + . miral::Keymap - support for keyboard maps (either programatically 1089 + Keymap::set_keymap(), or via config --keymap) 1090 + - Bugs fixed: 1091 + . Crash after closing Qt dialog (LP: #1631958) 1092 + . tooltips positioned wrong with mir0.24 (LP: #1632325, LP: #1633052) 1093 + . Shell wants way to associate initially requested window creation state 1094 + with the window later created (#1629349) 1095 + . [Xmir] Alt+ switch between different apps not just windows 1096 + (LP: #1625849) 1097 + . miral-shell splash screen should be fullscreen. 1098 + . TitlebarWindowManagerPolicy::end_resize() should do nothing if not 1099 + resizing 1100 + . deduplicate logging of WindowSpecification::top_left 1101 + 1102 + -- Alan Griffiths Mon, 24 Oct 2016 15:25:46 +0000 1103 + 1104 +miral (0.2.0+16.10.20160930.1-0ubuntu1) yakkety; urgency=medium 1105 + 1106 + * New upstream release 0.2.0 (https://launchpad.net/miral/+milestone/0.2) 1107 + - ABI summary: 1108 + . miral ABI unchanged at 1 1109 + - Enhancements: 1110 + . –window-management-trace option for debugging window management 1111 + . Enable cursor theme selection 1112 + . Improved resizing of size-constrained windows in miral-shell example 1113 + . Enable pointer confinement (where underlying Mir version >= 0.24) 1114 + . Enhanced "surface placement" request handling. 1115 + . Results of placement request notified to clients (where supported by 1116 + underlying Mir version >= 0.25) 1117 + - Bugs fixed: 1118 + . advise_focus_lost() isn't called when the active window is minimised/ 1119 + hidden (LP: #1628594) 1120 + . miral should not change surface geometry because it got maximized 1121 + (LP: #1628630) 1122 + . TitlebarWindowManager: sometime the initial display of titlebars doesn't 1123 + happen (LP: #1628981) 1124 + . Dialogs with parents should be modal i.e. they receive focus when the 1125 + parent is clicked (LP: #1626659) 1126 + . Deadlock in default window manager when Ctrl+Alt+Backspace with a client 1127 + connected (LP: #1628482) 1128 + . Need to support pointer confinement in Mir and toolkits using Mir 1129 + (LP: #1590099) 1130 + . User can drag menus (and other inappropriate) surfaces (LP: #1616818) 1131 + . Starting qtcreator on miral-shell gives an orphan "titlebar" 1132 + (LP: #1628033) 1133 + . Mouse cursor disappears (or just never changes) when entering the 1134 + windows of Qt apps (LP: #1625853) 1135 + 1136 + -- Alan Griffiths Fri, 30 Sep 2016 13:18:17 +0000 1137 + 1138 +miral (0.1.0+16.10.20160919-0ubuntu1) yakkety; urgency=medium 1139 + 1140 + * Initial release. (LP: #1613220) 1141 + 1142 + -- Larry Price Mon, 19 Sep 2016 13:41:34 +0000 1143 1144 === added file 'debian/compat' 1145 --- debian/compat 1970-01-01 00:00:00 +0000 1146 +++ debian/compat 2017-03-01 12:28:42 +0000 1147 @@ -0,0 +1,1 @@ 1148 +9 1149 1150 === added file 'debian/control' 1151 --- debian/control 1970-01-01 00:00:00 +0000 1152 +++ debian/control 2017-03-01 12:28:42 +0000 1153 @@ -0,0 +1,90 @@ 1154 +Source: miral 1155 +Section: x11 1156 +Priority: optional 1157 +Maintainer: Ubuntu Developers 1158 +XSBC-Original-Maintainer: Alan Griffiths 1159 +Build-Depends: cmake, 1160 + cmake-extras, 1161 + pkg-config, 1162 + debhelper (>= 9), 1163 + doxygen, 1164 + xsltproc, 1165 + graphviz, 1166 + pkg-config, 1167 + python-pil, 1168 + google-mock (>= 1.6.0+svn437), 1169 + python3:any, 1170 + libmirserver-dev, 1171 + libmirclient-dev, 1172 + mirtest-dev, 1173 + libglib2.0-dev, 1174 + libgles2-mesa-dev, 1175 + libfreetype6-dev, 1176 +# The following workaround missing dependencies in Mir packages 1177 + uuid-dev, 1178 + libboost-system-dev, 1179 + libboost-filesystem-dev, 1180 + mir-test-tools, 1181 + mir-renderer-gl-dev, 1182 +Standards-Version: 3.9.8 1183 +Homepage: https://launchpad.net/miral 1184 +# If you aren't a member of ~mir-team but need to upload packaging changes, 1185 +# just go ahead. ~mir-team will notice and sync up the code again. 1186 +Vcs-Bzr: https://code.launchpad.net/miral 1187 + 1188 +Package: libmiral2 1189 +Section: libs 1190 +Architecture: linux-any 1191 +Multi-Arch: same 1192 +Pre-Depends: ${misc:Pre-Depends} 1193 +Depends:${misc:Depends}, 1194 + ${shlibs:Depends}, 1195 +Description: Display server for Ubuntu - ABI preserving abstraction layer 1196 + MirAL provides an ABI-stable abstraction layer for Mir based shells, 1197 + insulating them from mirserver ABI breaks. 1198 + . 1199 + Contains the shared library containing MirAL abstraction layer. 1200 + 1201 +Package: libmiral-dev 1202 +Section: libdevel 1203 +Architecture: linux-any 1204 +Multi-Arch: same 1205 +Pre-Depends:${misc:Pre-Depends} 1206 +Depends: libmiral2 (= ${binary:Version}), 1207 + libmirclientcpp-dev (=${binary:Version}), 1208 + ${misc:Depends}, 1209 +Description: Developer files for the Mir ABI-stable abstraction layer 1210 + MirAL provides an ABI-stable abstraction layer for Mir based shells, 1211 + insulating them from mirserver ABI breaks. 1212 + . 1213 + Contains header files required for development using the MirAL abstraction 1214 + layer. 1215 + 1216 +Package: libmirclientcpp-dev 1217 +Section: libdevel 1218 +Architecture: linux-any 1219 +Multi-Arch: same 1220 +Pre-Depends:${misc:Pre-Depends} 1221 +Depends: libmirclient-dev, 1222 +Description: A C++ wrapper for libmirclient-dev 1223 + Provides RAII (and other facilities) for Mir client library types. 1224 + . 1225 + Contains header files useful for C++ development against Mir. 1226 + 1227 +Package: miral-examples 1228 +Architecture: linux-any 1229 +Depends: ${misc:Depends}, 1230 +${shlibs:Depends}, 1231 +Recommends: dmz-cursor-theme, 1232 +Description: Display server for Ubuntu - demonstration programs 1233 + MirAL provides an ABI-stable abstraction layer for Mir based shells, 1234 + insulating them from mirserver ABI breaks. 1235 + . 1236 + Contains demo applications that use the MirAL abstraction layer 1237 + 1238 +Package: miral-doc 1239 +Section: doc 1240 +Architecture: all 1241 +Depends: ${misc:Depends}, 1242 +Description: API documentation for MirAL 1243 + This package installs the MirAL abstraction layer documentation. 1244 1245 === added file 'debian/copyright' 1246 --- debian/copyright 1970-01-01 00:00:00 +0000 1247 +++ debian/copyright 2017-03-01 12:28:42 +0000 1248 @@ -0,0 +1,24 @@ 1249 +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 1250 +Upstream-Name: MirAL 1251 +Upstream-Contact: Alan Griffiths 1252 +Source: https://launchpad.net/miral 1253 + 1254 +Files: * 1255 +Copyright: 2016 Canonical Ltd. 1256 +License: GPL-3 1257 + 1258 +License: GPL-3 1259 + This program is free software: you can redistribute it and/or modify 1260 + it under the terms of the GNU General Public License as published by 1261 + the Free Software Foundation, version 3 of the License. 1262 + . 1263 + This program is distributed in the hope that it will be useful, 1264 + but WITHOUT ANY WARRANTY; without even the implied warranty of 1265 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1266 + GNU General Public License for more details. 1267 + . 1268 + You should have received a copy of the GNU General Public License 1269 + along with this program. If not, see . 1270 + . 1271 + On Debian systems, the full text of the GNU General Public License 1272 + version 3 can be found in the file /usr/share/common-licenses/GPL-3. 1273 1274 === added file 'debian/libmiral-dev.install' 1275 --- debian/libmiral-dev.install 1970-01-01 00:00:00 +0000 1276 +++ debian/libmiral-dev.install 2017-03-01 12:28:42 +0000 1277 @@ -0,0 +1,3 @@ 1278 +usr/include/miral/miral/* 1279 +usr/lib/*/pkgconfig/miral.pc 1280 +usr/lib/*/libmiral.so 1281 1282 === added file 'debian/libmiral2.install' 1283 --- debian/libmiral2.install 1970-01-01 00:00:00 +0000 1284 +++ debian/libmiral2.install 2017-03-01 12:28:42 +0000 1285 @@ -0,0 +1,1 @@ 1286 +usr/lib/*/libmiral.so.2 1287 1288 === added file 'debian/libmiral2.symbols' 1289 --- debian/libmiral2.symbols 1970-01-01 00:00:00 +0000 1290 +++ debian/libmiral2.symbols 2017-03-01 12:28:42 +0000 1291 @@ -0,0 +1,383 @@ 1292 +libmiral.so.2 libmiral2 #MINVER# 1293 + MIRAL_1.0@MIRAL_1.0 1.0.0 1294 + (c++)"miral::WindowInfo::height_inc(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1295 + (c++)"miral::WindowInfo::max_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0 1296 + (c++)"miral::WindowInfo::max_height(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1297 + (c++)"miral::WindowInfo::min_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0 1298 + (c++)"miral::WindowInfo::min_height(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1299 + (c++)"miral::WindowInfo::remove_child(miral::Window const&)@MIRAL_1.0" 1.0.0 1300 + (c++)"miral::WindowInfo::restore_rect(mir::geometry::Rectangle const&)@MIRAL_1.0" 1.0.0 1301 + (c++)"miral::WindowInfo::needs_titlebar(MirSurfaceType)@MIRAL_1.0" 1.0.0 1302 + (c++)"miral::WindowInfo::confine_pointer(MirPointerConfinementState)@MIRAL_1.0" 1.0.0 1303 + (c++)"miral::WindowInfo::preferred_orientation(MirOrientationMode)@MIRAL_1.0" 1.0.0 1304 + (c++)"miral::WindowInfo::name(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1305 + (c++)"miral::WindowInfo::type(MirSurfaceType)@MIRAL_1.0" 1.0.0 1306 + (c++)"miral::WindowInfo::state(MirSurfaceState)@MIRAL_1.0" 1.0.0 1307 + (c++)"miral::WindowInfo::parent(miral::Window const&)@MIRAL_1.0" 1.0.0 1308 + (c++)"miral::WindowInfo::userdata(std::shared_ptr)@MIRAL_1.0" 1.0.0 1309 + (c++)"miral::WindowInfo::add_child(miral::Window const&)@MIRAL_1.0" 1.0.0 1310 + (c++)"miral::WindowInfo::max_width(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1311 + (c++)"miral::WindowInfo::min_width(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1312 + (c++)"miral::WindowInfo::output_id(mir::optional_value)@MIRAL_1.0" 1.0.0 1313 + (c++)"miral::WindowInfo::width_inc(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1314 + (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1315 + (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1316 + (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0 1317 + (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1318 + (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1319 + (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0 1320 + (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0 1321 + (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0 1322 + (c++)"miral::WindowInfo::operator=(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1323 + (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1324 + (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1325 + (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0 1326 + (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0 1327 + (c++)"miral::SetTerminator::SetTerminator(std::function const&)@MIRAL_1.0" 1.0.0 1328 + (c++)"miral::SetTerminator::SetTerminator(std::function const&)@MIRAL_1.0" 1.0.0 1329 + (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0 1330 + (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0 1331 + (c++)"miral::DebugExtension::enable()@MIRAL_1.0" 1.0.0 1332 + (c++)"miral::DebugExtension::disable()@MIRAL_1.0" 1.0.0 1333 + (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1334 + (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0 1335 + (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1336 + (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0 1337 + (c++)"miral::DebugExtension::operator=(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1338 + (c++)"miral::AddInitCallback::AddInitCallback(std::function const&)@MIRAL_1.0" 1.0.0 1339 + (c++)"miral::AddInitCallback::AddInitCallback(std::function const&)@MIRAL_1.0" 1.0.0 1340 + (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0 1341 + (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0 1342 + (c++)"miral::ApplicationInfo::add_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1343 + (c++)"miral::ApplicationInfo::remove_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1344 + (c++)"miral::ApplicationInfo::userdata(std::shared_ptr)@MIRAL_1.0" 1.0.0 1345 + (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1346 + (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1347 + (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0 1348 + (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1349 + (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1350 + (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0 1351 + (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0 1352 + (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0 1353 + (c++)"miral::ApplicationInfo::operator=(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1354 + (c++)"miral::AppendEventFilter::AppendEventFilter(std::function const&)@MIRAL_1.0" 1.0.0 1355 + (c++)"miral::AppendEventFilter::AppendEventFilter(std::function const&)@MIRAL_1.0" 1.0.0 1356 + (c++)"miral::AppendEventFilter::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1357 + (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1358 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1359 + (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1360 + (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1361 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, char const*)@MIRAL_1.0" 1.0.0 1362 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1363 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1364 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, bool)@MIRAL_1.0" 1.0.0 1365 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, double)@MIRAL_1.0" 1.0.0 1366 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, int)@MIRAL_1.0" 1.0.0 1367 + (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1368 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1369 + (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1370 + (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1371 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, char const*)@MIRAL_1.0" 1.0.0 1372 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1373 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1374 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, bool)@MIRAL_1.0" 1.0.0 1375 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, double)@MIRAL_1.0" 1.0.0 1376 + (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, int)@MIRAL_1.0" 1.0.0 1377 + (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0 1378 + (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0 1379 + (c++)"miral::CommandLineOption::operator=(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1380 + (c++)"miral::WindowManagerTools::raise_tree(miral::Window const&)@MIRAL_1.0" 1.0.0 1381 + (c++)"miral::WindowManagerTools::force_close(miral::Window const&)@MIRAL_1.0" 1.0.0 1382 + (c++)"miral::WindowManagerTools::modify_window(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1383 + (c++)"miral::WindowManagerTools::modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1384 + (c++)"miral::WindowManagerTools::active_display()@MIRAL_1.0" 1.0.0 1385 + (c++)"miral::WindowManagerTools::find_application(std::function const&)@MIRAL_1.0" 1.0.0 1386 + (c++)"miral::WindowManagerTools::invoke_under_lock(std::function const&)@MIRAL_1.0" 1.0.0 1387 + (c++)"miral::WindowManagerTools::drag_active_window(mir::geometry::Displacement)@MIRAL_1.0" 1.0.0 1388 + (c++)"miral::WindowManagerTools::ask_client_to_close(miral::Window const&)@MIRAL_1.0" 1.0.0 1389 + (c++)"miral::WindowManagerTools::for_each_application(std::function const&)@MIRAL_1.0" 1.0.0 1390 + (c++)"miral::WindowManagerTools::select_active_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1391 + (c++)"miral::WindowManagerTools::focus_next_application()@MIRAL_1.0" 1.0.0 1392 + (c++)"miral::WindowManagerTools::focus_next_within_application()@MIRAL_1.0" 1.0.0 1393 + (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0 1394 + (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1395 + (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0 1396 + (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1397 + (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0 1398 + (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0 1399 + (c++)"miral::WindowManagerTools::operator=(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1400 + (c++)"miral::WindowSpecification::height_inc()@MIRAL_1.0" 1.0.0 1401 + (c++)"miral::WindowSpecification::input_mode()@MIRAL_1.0" 1.0.0 1402 + (c++)"miral::WindowSpecification::max_aspect()@MIRAL_1.0" 1.0.0 1403 + (c++)"miral::WindowSpecification::max_height()@MIRAL_1.0" 1.0.0 1404 + (c++)"miral::WindowSpecification::min_aspect()@MIRAL_1.0" 1.0.0 1405 + (c++)"miral::WindowSpecification::min_height()@MIRAL_1.0" 1.0.0 1406 + (c++)"miral::WindowSpecification::input_shape()@MIRAL_1.0" 1.0.0 1407 + (c++)"miral::WindowSpecification::shell_chrome()@MIRAL_1.0" 1.0.0 1408 + (c++)"miral::WindowSpecification::confine_pointer()@MIRAL_1.0" 1.0.0 1409 + (c++)"miral::WindowSpecification::placement_hints()@MIRAL_1.0" 1.0.0 1410 + (c++)"miral::WindowSpecification::preferred_orientation()@MIRAL_1.0" 1.0.0 1411 + (c++)"miral::WindowSpecification::window_placement_gravity()@MIRAL_1.0" 1.0.0 1412 + (c++)"miral::WindowSpecification::aux_rect_placement_offset()@MIRAL_1.0" 1.0.0 1413 + (c++)"miral::WindowSpecification::aux_rect_placement_gravity()@MIRAL_1.0" 1.0.0 1414 + (c++)"miral::WindowSpecification::name[abi:cxx11]()@MIRAL_1.0" 1.0.0 1415 + (c++)"miral::WindowSpecification::size()@MIRAL_1.0" 1.0.0 1416 + (c++)"miral::WindowSpecification::type()@MIRAL_1.0" 1.0.0 1417 + (c++)"miral::WindowSpecification::state()@MIRAL_1.0" 1.0.0 1418 + (c++)"miral::WindowSpecification::parent()@MIRAL_1.0" 1.0.0 1419 + (c++)"miral::WindowSpecification::aux_rect()@MIRAL_1.0" 1.0.0 1420 + (c++)"miral::WindowSpecification::top_left()@MIRAL_1.0" 1.0.0 1421 + (c++)"miral::WindowSpecification::userdata()@MIRAL_1.0" 1.0.0 1422 + (c++)"miral::WindowSpecification::max_width()@MIRAL_1.0" 1.0.0 1423 + (c++)"miral::WindowSpecification::min_width()@MIRAL_1.0" 1.0.0 1424 + (c++)"miral::WindowSpecification::output_id()@MIRAL_1.0" 1.0.0 1425 + (c++)"miral::WindowSpecification::width_inc()@MIRAL_1.0" 1.0.0 1426 + (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0 1427 + (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0 1428 + (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1429 + (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0 1430 + (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0 1431 + (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0 1432 + (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1433 + (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0 1434 + (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0 1435 + (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0 1436 + (c++)"miral::WindowSpecification::operator=(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1437 + (c++)"miral::ActiveOutputsMonitor::add_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0 1438 + (c++)"miral::ActiveOutputsMonitor::delete_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0 1439 + (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1440 + (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1441 + (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1442 + (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1443 + (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1444 + (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1445 + (c++)"miral::ActiveOutputsMonitor::operator=(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1446 + (c++)"miral::ActiveOutputsMonitor::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1447 + (c++)"miral::ActiveOutputsListener::advise_output_end()@MIRAL_1.0" 1.0.0 1448 + (c++)"miral::ActiveOutputsListener::advise_output_begin()@MIRAL_1.0" 1.0.0 1449 + (c++)"miral::ActiveOutputsListener::advise_output_create(miral::Output const&)@MIRAL_1.0" 1.0.0 1450 + (c++)"miral::ActiveOutputsListener::advise_output_delete(miral::Output const&)@MIRAL_1.0" 1.0.0 1451 + (c++)"miral::ActiveOutputsListener::advise_output_update(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0 1452 + (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function const&)@MIRAL_1.0" 1.0.0 1453 + (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function const&)@MIRAL_1.0" 1.0.0 1454 + (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0 1455 + (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0 1456 + (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.0" 1.0.0 1457 + (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.0" 1.0.0 1458 + (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0 1459 + (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0 1460 + (c++)"miral::StartupInternalClient::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1461 + (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0 1462 + (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0 1463 + (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0 1464 + (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0 1465 + (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0 1466 + (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0 1467 + (c++)"miral::InternalClientLauncher::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1468 + (c++)"miral::WindowManagementPolicy::advise_end()@MIRAL_1.0" 1.0.0 1469 + (c++)"miral::WindowManagementPolicy::advise_begin()@MIRAL_1.0" 1.0.0 1470 + (c++)"miral::WindowManagementPolicy::advise_raise(std::vector > const&)@MIRAL_1.0" 1.0.0 1471 + (c++)"miral::WindowManagementPolicy::advise_resize(miral::WindowInfo const&, mir::geometry::Size const&)@MIRAL_1.0" 1.0.0 1472 + (c++)"miral::WindowManagementPolicy::advise_move_to(miral::WindowInfo const&, mir::geometry::Point)@MIRAL_1.0" 1.0.0 1473 + (c++)"miral::WindowManagementPolicy::advise_new_app(miral::ApplicationInfo&)@MIRAL_1.0" 1.0.0 1474 + (c++)"miral::WindowManagementPolicy::advise_delete_app(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1475 + (c++)"miral::WindowManagementPolicy::advise_focus_lost(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1476 + (c++)"miral::WindowManagementPolicy::advise_new_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1477 + (c++)"miral::WindowManagementPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1478 + (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirSurfaceState)@MIRAL_1.0" 1.0.0 1479 + (c++)"miral::WindowManagementPolicy::advise_delete_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1480 + (c++)"miral::equivalent_display_area(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0 1481 + (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0 1482 + (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0 1483 + (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0 1484 + (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0 1485 + (c++)"miral::apply_lifecycle_state_to(std::shared_ptr const&, MirLifecycleState)@MIRAL_1.0" 1.0.0 1486 + (c++)"miral::CanonicalWindowManagerPolicy::place_new_surface(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1487 + (c++)"miral::CanonicalWindowManagerPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1488 + (c++)"miral::CanonicalWindowManagerPolicy::handle_raise_window(miral::WindowInfo&)@MIRAL_1.0" 1.0.0 1489 + (c++)"miral::CanonicalWindowManagerPolicy::handle_window_ready(miral::WindowInfo&)@MIRAL_1.0" 1.0.0 1490 + (c++)"miral::CanonicalWindowManagerPolicy::handle_modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1491 + (c++)"miral::CanonicalWindowManagerPolicy::confirm_inherited_move(miral::WindowInfo const&, mir::geometry::Displacement)@MIRAL_1.0" 1.0.0 1492 + (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1493 + (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1494 + (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function ()> const&)@MIRAL_1.0" 1.0.0 1495 + (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function ()> const&)@MIRAL_1.0" 1.0.0 1496 + (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0 1497 + (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0 1498 + (c++)"miral::BasicSetApplicationAuthorizer::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1499 + (c++)"miral::display_configuration_options(mir::Server&)@MIRAL_1.0" 1.0.0 1500 + (c++)"miral::kill(std::shared_ptr const&, int)@MIRAL_1.0" 1.0.0 1501 + (c++)"miral::Keymap::set_keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1502 + (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1503 + (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1504 + (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0 1505 + (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1506 + (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1507 + (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0 1508 + (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0 1509 + (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0 1510 + (c++)"miral::Keymap::operator=(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1511 + (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0 1512 + (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0 1513 + (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0 1514 + (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0 1515 + (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0 1516 + (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0 1517 + (c++)"miral::Output::operator=(miral::Output const&)@MIRAL_1.0" 1.0.0 1518 + (c++)"miral::Window::resize(mir::geometry::Size const&)@MIRAL_1.0" 1.0.0 1519 + (c++)"miral::Window::move_to(mir::geometry::Point)@MIRAL_1.0" 1.0.0 1520 + (c++)"miral::Window::Window(std::shared_ptr const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1521 + (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0 1522 + (c++)"miral::Window::Window(std::shared_ptr const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1523 + (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0 1524 + (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0 1525 + (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0 1526 + (c++)"miral::pid_of(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1527 + (c++)"miral::name_of[abi:cxx11](std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1528 + (c++)"miral::MirRunner::add_stop_callback(std::function const&)@MIRAL_1.0" 1.0.0 1529 + (c++)"miral::MirRunner::add_start_callback(std::function const&)@MIRAL_1.0" 1.0.0 1530 + (c++)"miral::MirRunner::set_exception_handler(std::function const&)@MIRAL_1.0" 1.0.0 1531 + (c++)"miral::MirRunner::stop()@MIRAL_1.0" 1.0.0 1532 + (c++)"miral::MirRunner::run_with(std::initializer_list >)@MIRAL_1.0" 1.0.0 1533 + (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0 1534 + (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0 1535 + (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0 1536 + (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0 1537 + (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0 1538 + (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0 1539 + (c++)"miral::operator==(miral::Output::PhysicalSizeMM const&, miral::Output::PhysicalSizeMM const&)@MIRAL_1.0" 1.0.0 1540 + (c++)"miral::operator==(miral::Window const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1541 + (c++)"miral::operator==(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.0.0 1542 + (c++)"miral::operator==(std::shared_ptr const&, miral::Window const&)@MIRAL_1.0" 1.0.0 1543 + (c++)"miral::WindowInfo::height_inc() const@MIRAL_1.0" 1.0.0 1544 + (c++)"miral::WindowInfo::is_visible() const@MIRAL_1.0" 1.0.0 1545 + (c++)"miral::WindowInfo::max_aspect() const@MIRAL_1.0" 1.0.0 1546 + (c++)"miral::WindowInfo::max_height() const@MIRAL_1.0" 1.0.0 1547 + (c++)"miral::WindowInfo::min_aspect() const@MIRAL_1.0" 1.0.0 1548 + (c++)"miral::WindowInfo::min_height() const@MIRAL_1.0" 1.0.0 1549 + (c++)"miral::WindowInfo::can_morph_to(MirSurfaceType) const@MIRAL_1.0" 1.0.0 1550 + (c++)"miral::WindowInfo::restore_rect() const@MIRAL_1.0" 1.0.0 1551 + (c++)"miral::WindowInfo::can_be_active() const@MIRAL_1.0" 1.0.0 1552 + (c++)"miral::WindowInfo::has_output_id() const@MIRAL_1.0" 1.0.0 1553 + (c++)"miral::WindowInfo::confine_pointer() const@MIRAL_1.0" 1.0.0 1554 + (c++)"miral::WindowInfo::constrain_resize(mir::geometry::Point&, mir::geometry::Size&) const@MIRAL_1.0" 1.0.0 1555 + (c++)"miral::WindowInfo::must_have_parent() const@MIRAL_1.0" 1.0.0 1556 + (c++)"miral::WindowInfo::must_not_have_parent() const@MIRAL_1.0" 1.0.0 1557 + (c++)"miral::WindowInfo::preferred_orientation() const@MIRAL_1.0" 1.0.0 1558 + (c++)"miral::WindowInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1559 + (c++)"miral::WindowInfo::type() const@MIRAL_1.0" 1.0.0 1560 + (c++)"miral::WindowInfo::state() const@MIRAL_1.0" 1.0.0 1561 + (c++)"miral::WindowInfo::parent() const@MIRAL_1.0" 1.0.0 1562 + (c++)"miral::WindowInfo::window() const@MIRAL_1.0" 1.0.0 1563 + (c++)"miral::WindowInfo::children() const@MIRAL_1.0" 1.0.0 1564 + (c++)"miral::WindowInfo::userdata() const@MIRAL_1.0" 1.0.0 1565 + (c++)"miral::WindowInfo::max_width() const@MIRAL_1.0" 1.0.0 1566 + (c++)"miral::WindowInfo::min_width() const@MIRAL_1.0" 1.0.0 1567 + (c++)"miral::WindowInfo::output_id() const@MIRAL_1.0" 1.0.0 1568 + (c++)"miral::WindowInfo::width_inc() const@MIRAL_1.0" 1.0.0 1569 + (c++)"miral::CursorTheme::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1570 + (c++)"miral::SetTerminator::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1571 + (c++)"miral::DebugExtension::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1572 + (c++)"miral::AddInitCallback::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1573 + (c++)"miral::ApplicationInfo::application() const@MIRAL_1.0" 1.0.0 1574 + (c++)"miral::ApplicationInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1575 + (c++)"miral::ApplicationInfo::windows() const@MIRAL_1.0" 1.0.0 1576 + (c++)"miral::ApplicationInfo::userdata() const@MIRAL_1.0" 1.0.0 1577 + (c++)"miral::CommandLineOption::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1578 + (c++)"miral::WindowManagerTools::active_window() const@MIRAL_1.0" 1.0.0 1579 + (c++)"miral::WindowManagerTools::id_for_window[abi:cxx11](miral::Window const&) const@MIRAL_1.0" 1.0.0 1580 + (c++)"miral::WindowManagerTools::count_applications() const@MIRAL_1.0" 1.0.0 1581 + (c++)"miral::WindowManagerTools::info_for_window_id(std::__cxx11::basic_string, std::allocator > const&) const@MIRAL_1.0" 1.0.0 1582 + (c++)"miral::WindowManagerTools::place_and_size_for_state(miral::WindowSpecification&, miral::WindowInfo const&) const@MIRAL_1.0" 1.0.0 1583 + (c++)"miral::WindowManagerTools::info_for(miral::Window const&) const@MIRAL_1.0" 1.0.0 1584 + (c++)"miral::WindowManagerTools::info_for(std::weak_ptr const&) const@MIRAL_1.0" 1.0.0 1585 + (c++)"miral::WindowManagerTools::info_for(std::weak_ptr const&) const@MIRAL_1.0" 1.0.0 1586 + (c++)"miral::WindowManagerTools::window_at(mir::geometry::Point) const@MIRAL_1.0" 1.0.0 1587 + (c++)"miral::WindowSpecification::height_inc() const@MIRAL_1.0" 1.0.0 1588 + (c++)"miral::WindowSpecification::input_mode() const@MIRAL_1.0" 1.0.0 1589 + (c++)"miral::WindowSpecification::max_aspect() const@MIRAL_1.0" 1.0.0 1590 + (c++)"miral::WindowSpecification::max_height() const@MIRAL_1.0" 1.0.0 1591 + (c++)"miral::WindowSpecification::min_aspect() const@MIRAL_1.0" 1.0.0 1592 + (c++)"miral::WindowSpecification::min_height() const@MIRAL_1.0" 1.0.0 1593 + (c++)"miral::WindowSpecification::input_shape() const@MIRAL_1.0" 1.0.0 1594 + (c++)"miral::WindowSpecification::shell_chrome() const@MIRAL_1.0" 1.0.0 1595 + (c++)"miral::WindowSpecification::confine_pointer() const@MIRAL_1.0" 1.0.0 1596 + (c++)"miral::WindowSpecification::placement_hints() const@MIRAL_1.0" 1.0.0 1597 + (c++)"miral::WindowSpecification::preferred_orientation() const@MIRAL_1.0" 1.0.0 1598 + (c++)"miral::WindowSpecification::window_placement_gravity() const@MIRAL_1.0" 1.0.0 1599 + (c++)"miral::WindowSpecification::aux_rect_placement_offset() const@MIRAL_1.0" 1.0.0 1600 + (c++)"miral::WindowSpecification::aux_rect_placement_gravity() const@MIRAL_1.0" 1.0.0 1601 + (c++)"miral::WindowSpecification::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1602 + (c++)"miral::WindowSpecification::size() const@MIRAL_1.0" 1.0.0 1603 + (c++)"miral::WindowSpecification::type() const@MIRAL_1.0" 1.0.0 1604 + (c++)"miral::WindowSpecification::state() const@MIRAL_1.0" 1.0.0 1605 + (c++)"miral::WindowSpecification::parent() const@MIRAL_1.0" 1.0.0 1606 + (c++)"miral::WindowSpecification::update(mir::scene::SurfaceCreationParameters&) const@MIRAL_1.0" 1.0.0 1607 + (c++)"miral::WindowSpecification::aux_rect() const@MIRAL_1.0" 1.0.0 1608 + (c++)"miral::WindowSpecification::top_left() const@MIRAL_1.0" 1.0.0 1609 + (c++)"miral::WindowSpecification::userdata() const@MIRAL_1.0" 1.0.0 1610 + (c++)"miral::WindowSpecification::max_width() const@MIRAL_1.0" 1.0.0 1611 + (c++)"miral::WindowSpecification::min_width() const@MIRAL_1.0" 1.0.0 1612 + (c++)"miral::WindowSpecification::output_id() const@MIRAL_1.0" 1.0.0 1613 + (c++)"miral::WindowSpecification::width_inc() const@MIRAL_1.0" 1.0.0 1614 + (c++)"miral::ActiveOutputsMonitor::process_outputs(std::function > const&)> const&) const@MIRAL_1.0" 1.0.0 1615 + (c++)"miral::WindowManagerOptions::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1616 + (c++)"miral::SetCommandLineHandler::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1617 + (c++)"miral::ApplicationCredentials::gid() const@MIRAL_1.0" 1.0.0 1618 + (c++)"miral::ApplicationCredentials::pid() const@MIRAL_1.0" 1.0.0 1619 + (c++)"miral::ApplicationCredentials::uid() const@MIRAL_1.0" 1.0.0 1620 + (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string, std::allocator > const&, std::function const&, std::function)> const&) const@MIRAL_1.0" 1.0.0 1621 + (c++)"miral::SetWindowManagmentPolicy::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1622 + (c++)"miral::BasicSetApplicationAuthorizer::the_application_authorizer() const@MIRAL_1.0" 1.0.0 1623 + (c++)"miral::Keymap::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1624 + (c++)"miral::Output::power_mode() const@MIRAL_1.0" 1.0.0 1625 + (c++)"miral::Output::form_factor() const@MIRAL_1.0" 1.0.0 1626 + (c++)"miral::Output::orientation() const@MIRAL_1.0" 1.0.0 1627 + (c++)"miral::Output::pixel_format() const@MIRAL_1.0" 1.0.0 1628 + (c++)"miral::Output::refresh_rate() const@MIRAL_1.0" 1.0.0 1629 + (c++)"miral::Output::is_same_output(miral::Output const&) const@MIRAL_1.0" 1.0.0 1630 + (c++)"miral::Output::physical_size_mm() const@MIRAL_1.0" 1.0.0 1631 + (c++)"miral::Output::type() const@MIRAL_1.0" 1.0.0 1632 + (c++)"miral::Output::used() const@MIRAL_1.0" 1.0.0 1633 + (c++)"miral::Output::scale() const@MIRAL_1.0" 1.0.0 1634 + (c++)"miral::Output::valid() const@MIRAL_1.0" 1.0.0 1635 + (c++)"miral::Output::extents() const@MIRAL_1.0" 1.0.0 1636 + (c++)"miral::Output::connected() const@MIRAL_1.0" 1.0.0 1637 + (c++)"miral::Window::application() const@MIRAL_1.0" 1.0.0 1638 + (c++)"miral::Window::size() const@MIRAL_1.0" 1.0.0 1639 + (c++)"miral::Window::top_left() const@MIRAL_1.0" 1.0.0 1640 + (c++)"miral::Window::operator std::shared_ptr() const@MIRAL_1.0" 1.0.0 1641 + (c++)"miral::Window::operator std::weak_ptr() const@MIRAL_1.0" 1.0.0 1642 + (c++)"miral::Window::operator bool() const@MIRAL_1.0" 1.0.0 1643 + (c++)"typeinfo for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0 1644 + (c++)"typeinfo for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0 1645 + (c++)"typeinfo for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0 1646 + (c++)"vtable for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0 1647 + (c++)"vtable for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0 1648 + (c++)"vtable for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0 1649 + MIRAL_1.1@MIRAL_1.1 1.1.0 1650 + (c++)"miral::WindowInfo::needs_titlebar(MirWindowType)@MIRAL_1.1" 1.1.0 1651 + (c++)"miral::WindowInfo::type(MirWindowType)@MIRAL_1.1" 1.1.0 1652 + (c++)"miral::WindowInfo::state(MirWindowState)@MIRAL_1.1" 1.1.0 1653 + (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirWindowState)@MIRAL_1.1" 1.1.0 1654 + (c++)"miral::WindowInfo::can_morph_to(MirWindowType) const@MIRAL_1.1" 1.1.0 1655 + (c++)"miral::CanonicalWindowManagerPolicy::place_new_window(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.1" 1.1.0 1656 + MIRAL_1.2@MIRAL_1.2 1.2.0 1657 + (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.2" 1.2.0 1658 + (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string, std::allocator > const&, std::function const&, std::function)> const&) const@MIRAL_1.2" 1.2.0 1659 + (c++)"miral::WindowInfo::shell_chrome(MirShellChrome)@MIRAL_1.2" 1.2.0 1660 + (c++)"miral::WindowInfo::shell_chrome() const@MIRAL_1.2" 1.2.0 1661 + (c++)"miral::WindowManagerTools::drag_window(miral::Window const&, mir::geometry::Displacement)@MIRAL_1.2" 1.2.0 1662 + (c++)"typeinfo for miral::ApplicationAuthorizer@MIRAL_1.0" 1.2.0 1663 + (c++)"typeinfo for miral::ApplicationAuthorizer1@MIRAL_1.2" 1.2.0 1664 + MIRAL_1.3@MIRAL_1.3 1.3.0 1665 + (c++)"miral::operator<(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.3.0 1666 + (c++)"miral::WindowManagerTools::create_workspace()@MIRAL_1.3" 1.3.0 1667 + (c++)"miral::WindowManagerTools::add_tree_to_workspace(miral::Window const&, std::shared_ptr const&)@MIRAL_1.3" 1.3.0 1668 + (c++)"miral::WindowManagerTools::remove_tree_from_workspace(miral::Window const&, std::shared_ptr const&)@MIRAL_1.3" 1.3.0 1669 + (c++)"miral::WorkspacePolicy::advise_adding_to_workspace(std::shared_ptr const&, std::vector > const&)@MIRAL_1.3" 1.3.0 1670 + (c++)"miral::WorkspacePolicy::advise_removing_from_workspace(std::shared_ptr const&, std::vector > const&)@MIRAL_1.3" 1.3.0 1671 + (c++)"miral::WindowManagerTools::for_each_window_in_workspace(std::shared_ptr const&, std::function const&)@MIRAL_1.3" 1.3.0 1672 + (c++)"miral::WindowManagerTools::for_each_workspace_containing(miral::Window const&, std::function const&)> const&)@MIRAL_1.3" 1.3.0 1673 + (c++)"typeinfo for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0 1674 + (c++)"vtable for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0 1675 1676 === added file 'debian/libmirclientcpp-dev.install' 1677 --- debian/libmirclientcpp-dev.install 1970-01-01 00:00:00 +0000 1678 +++ debian/libmirclientcpp-dev.install 2017-03-01 12:28:42 +0000 1679 @@ -0,0 +1,2 @@ 1680 +usr/include/miral/mir/*/* 1681 +usr/lib/*/pkgconfig/mirclientcpp.pc 1682 1683 === added file 'debian/miral-doc.install' 1684 --- debian/miral-doc.install 1970-01-01 00:00:00 +0000 1685 +++ debian/miral-doc.install 2017-03-01 12:28:42 +0000 1686 @@ -0,0 +1,1 @@ 1687 +usr/share/doc/miral-doc/ 1688 1689 === added file 'debian/miral-examples.install' 1690 --- debian/miral-examples.install 1970-01-01 00:00:00 +0000 1691 +++ debian/miral-examples.install 2017-03-01 12:28:42 +0000 1692 @@ -0,0 +1,9 @@ 1693 +usr/bin/miral-shell 1694 +usr/bin/miral-run 1695 +usr/bin/miral-kiosk 1696 +usr/bin/miral-xrun 1697 +usr/bin/miral-screencast 1698 +usr/bin/miral-desktop 1699 +usr/bin/miral-app 1700 +usr/share/applications/miral-shell.desktop 1701 +usr/share/icons/hicolor/scalable/apps/ubuntu-logo.svg 1702 1703 === added file 'debian/rules' 1704 --- debian/rules 1970-01-01 00:00:00 +0000 1705 +++ debian/rules 2017-03-01 12:28:42 +0000 1706 @@ -0,0 +1,26 @@ 1707 +#!/usr/bin/make -f 1708 + 1709 +DEB_HOST_MULTIARCH ?=$(shell dpkg-architecture -qDEB_HOST_MULTIARCH) 1710 + 1711 +export DPKG_GENSYMBOLS_CHECK_LEVEL = 4 1712 + 1713 +# GLPixelBuffer doesn't support big endian architectures 1714 +testskip_architectures := s390x powerpc 1715 + 1716 +%: 1717 + dh $@ --parallel --fail-missing 1718 + 1719 +COMMON_CONFIGURE_OPTIONS = \ 1720 + -DCMAKE_INSTALL_LIBEXECDIR="lib/$(DEB_HOST_MULTIARCH)/miral" 1721 + 1722 +override_dh_auto_configure: 1723 + dh_auto_configure -- $(COMMON_CONFIGURE_OPTIONS) 1724 + 1725 +# Only build the docs when we need them 1726 +override_dh_auto_build-indep: 1727 + dh_auto_build -- doc 1728 + 1729 +override_dh_auto_test: 1730 +ifneq ($(DEB_HOST_ARCH),$(findstring$(DEB_HOST_ARCH), $(testskip_architectures))) 1731 + dh_auto_test$@ 1732 +endif 1733 1734 === added directory 'debian/tmp' 1735 === added directory 'doc' 1736 === renamed directory 'doc' => 'doc.moved' 1737 === added file 'doc/Doxyfile.in' 1738 --- doc/Doxyfile.in 1970-01-01 00:00:00 +0000 1739 +++ doc/Doxyfile.in 2017-03-01 12:28:42 +0000 1740 @@ -0,0 +1,1926 @@ 1741 +# Doxyfile 1.8.4 1742 + 1743 +# This file describes the settings to be used by the documentation system 1744 +# doxygen (www.doxygen.org) for a project. 1745 +# 1746 +# All text after a double hash (##) is considered a comment and is placed 1747 +# in front of the TAG it is preceding . 1748 +# All text after a hash (#) is considered a comment and will be ignored. 1749 +# The format is: 1750 +# TAG = value [value, ...] 1751 +# For lists items can also be appended using: 1752 +# TAG += value [value, ...] 1753 +# Values that contain spaces should be placed between quotes (" "). 1754 + 1755 +#--------------------------------------------------------------------------- 1756 +# Project related configuration options 1757 +#--------------------------------------------------------------------------- 1758 + 1759 +# This tag specifies the encoding used for all characters in the config file 1760 +# that follow. The default is UTF-8 which is also the encoding used for all 1761 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the 1762 +# iconv built into libc) for the transcoding. See 1763 +# http://www.gnu.org/software/libiconv for the list of possible encodings. 1764 + 1765 +DOXYFILE_ENCODING = UTF-8 1766 + 1767 +# The PROJECT_NAME tag is a single word (or sequence of words) that should 1768 +# identify the project. Note that if you do not use Doxywizard you need 1769 +# to put quotes around the project name if it contains spaces. 1770 + 1771 +PROJECT_NAME = MirAL 1772 + 1773 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. 1774 +# This could be handy for archiving the generated documentation or 1775 +# if some version control system is used. 1776 + 1777 +PROJECT_NUMBER = 1778 + 1779 +# Using the PROJECT_BRIEF tag one can provide an optional one line description 1780 +# for a project that appears at the top of each page and should give viewer 1781 +# a quick idea about the purpose of the project. Keep the description short. 1782 + 1783 +PROJECT_BRIEF = 1784 + 1785 +# With the PROJECT_LOGO tag one can specify an logo or icon that is 1786 +# included in the documentation. The maximum height of the logo should not 1787 +# exceed 55 pixels and the maximum width should not exceed 200 pixels. 1788 +# Doxygen will copy the logo to the output directory. 1789 + 1790 +PROJECT_LOGO = 1791 + 1792 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 1793 +# base path where the generated documentation will be put. 1794 +# If a relative path is entered, it will be relative to the location 1795 +# where doxygen was started. If left blank the current directory will be used. 1796 + 1797 +OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc 1798 + 1799 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 1800 +# 4096 sub-directories (in 2 levels) under the output directory of each output 1801 +# format and will distribute the generated files over these directories. 1802 +# Enabling this option can be useful when feeding doxygen a huge amount of 1803 +# source files, where putting all generated files in the same directory would 1804 +# otherwise cause performance problems for the file system. 1805 + 1806 +CREATE_SUBDIRS = NO 1807 + 1808 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all 1809 +# documentation generated by doxygen is written. Doxygen will use this 1810 +# information to generate all constant output in the proper language. 1811 +# The default language is English, other supported languages are: 1812 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 1813 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 1814 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 1815 +# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian, 1816 +# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, 1817 +# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 1818 + 1819 +OUTPUT_LANGUAGE = English 1820 + 1821 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 1822 +# include brief member descriptions after the members that are listed in 1823 +# the file and class documentation (similar to JavaDoc). 1824 +# Set to NO to disable this. 1825 + 1826 +BRIEF_MEMBER_DESC = YES 1827 + 1828 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 1829 +# the brief description of a member or function before the detailed description. 1830 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 1831 +# brief descriptions will be completely suppressed. 1832 + 1833 +REPEAT_BRIEF = YES 1834 + 1835 +# This tag implements a quasi-intelligent brief description abbreviator 1836 +# that is used to form the text in various listings. Each string 1837 +# in this list, if found as the leading text of the brief description, will be 1838 +# stripped from the text and the result after processing the whole list, is 1839 +# used as the annotated text. Otherwise, the brief description is used as-is. 1840 +# If left blank, the following values are used ("$name" is automatically 1841 +# replaced with the name of the entity): "The$name class" "The $name widget" 1842 +# "The$name file" "is" "provides" "specifies" "contains" 1843 +# "represents" "a" "an" "the" 1844 + 1845 +ABBREVIATE_BRIEF = "The $name class" \ 1846 + "The$name widget" \ 1847 + "The $name file" \ 1848 + is \ 1849 + provides \ 1850 + specifies \ 1851 + contains \ 1852 + represents \ 1853 + a \ 1854 + an \ 1855 + the 1856 + 1857 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 1858 +# Doxygen will generate a detailed section even if there is only a brief 1859 +# description. 1860 + 1861 +ALWAYS_DETAILED_SEC = NO 1862 + 1863 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 1864 +# inherited members of a class in the documentation of that class as if those 1865 +# members were ordinary class members. Constructors, destructors and assignment 1866 +# operators of the base classes will not be shown. 1867 + 1868 +INLINE_INHERITED_MEMB = NO 1869 + 1870 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 1871 +# path before files name in the file list and in the header files. If set 1872 +# to NO the shortest path that makes the file name unique will be used. 1873 + 1874 +FULL_PATH_NAMES = YES 1875 + 1876 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 1877 +# can be used to strip a user-defined part of the path. Stripping is 1878 +# only done if one of the specified strings matches the left-hand part of 1879 +# the path. The tag can be used to show relative paths in the file list. 1880 +# If left blank the directory from which doxygen is run is used as the 1881 +# path to strip. Note that you specify absolute paths here, but also 1882 +# relative paths, which will be relative from the directory where doxygen is 1883 +# started. 1884 + 1885 +STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@ 1886 + 1887 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 1888 +# the path mentioned in the documentation of a class, which tells 1889 +# the reader which header file to include in order to use a class. 1890 +# If left blank only the name of the header file containing the class 1891 +# definition is used. Otherwise one should specify the include paths that 1892 +# are normally passed to the compiler using the -I flag. 1893 + 1894 +STRIP_FROM_INC_PATH = @CMAKE_CURRENT_SOURCE_DIR@/include 1895 + 1896 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 1897 +# (but less readable) file names. This can be useful if your file system 1898 +# doesn't support long names like on DOS, Mac, or CD-ROM. 1899 + 1900 +SHORT_NAMES = NO 1901 + 1902 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 1903 +# will interpret the first line (until the first dot) of a JavaDoc-style 1904 +# comment as the brief description. If set to NO, the JavaDoc 1905 +# comments will behave just like regular Qt-style comments 1906 +# (thus requiring an explicit @brief command for a brief description.) 1907 + 1908 +JAVADOC_AUTOBRIEF = YES 1909 + 1910 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 1911 +# interpret the first line (until the first dot) of a Qt-style 1912 +# comment as the brief description. If set to NO, the comments 1913 +# will behave just like regular Qt-style comments (thus requiring 1914 +# an explicit \brief command for a brief description.) 1915 + 1916 +QT_AUTOBRIEF = NO 1917 + 1918 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 1919 +# treat a multi-line C++ special comment block (i.e. a block of //! or /// 1920 +# comments) as a brief description. This used to be the default behaviour. 1921 +# The new default is to treat a multi-line C++ comment block as a detailed 1922 +# description. Set this tag to YES if you prefer the old behaviour instead. 1923 + 1924 +MULTILINE_CPP_IS_BRIEF = YES 1925 + 1926 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 1927 +# member inherits the documentation from any documented member that it 1928 +# re-implements. 1929 + 1930 +INHERIT_DOCS = YES 1931 + 1932 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 1933 +# a new page for each member. If set to NO, the documentation of a member will 1934 +# be part of the file/class/namespace that contains it. 1935 + 1936 +SEPARATE_MEMBER_PAGES = NO 1937 + 1938 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. 1939 +# Doxygen uses this value to replace tabs by spaces in code fragments. 1940 + 1941 +TAB_SIZE = 4 1942 + 1943 +# This tag can be used to specify a number of aliases that acts 1944 +# as commands in the documentation. An alias has the form "name=value". 1945 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to 1946 +# put the command \sideeffect (or @sideeffect) in the documentation, which 1947 +# will result in a user-defined paragraph with heading "Side Effects:". 1948 +# You can put \n's in the value part of an alias to insert newlines. 1949 + 1950 +ALIASES = 1951 + 1952 +# This tag can be used to specify a number of word-keyword mappings (TCL only). 1953 +# A mapping has the form "name=value". For example adding 1954 +# "class=itcl::class" will allow you to use the command class in the 1955 +# itcl::class meaning. 1956 + 1957 +TCL_SUBST = 1958 + 1959 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 1960 +# sources only. Doxygen will then generate output that is more tailored for C. 1961 +# For instance, some of the names that are used will be different. The list 1962 +# of all members will be omitted, etc. 1963 + 1964 +OPTIMIZE_OUTPUT_FOR_C = NO 1965 + 1966 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 1967 +# sources only. Doxygen will then generate output that is more tailored for 1968 +# Java. For instance, namespaces will be presented as packages, qualified 1969 +# scopes will look different, etc. 1970 + 1971 +OPTIMIZE_OUTPUT_JAVA = NO 1972 + 1973 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 1974 +# sources only. Doxygen will then generate output that is more tailored for 1975 +# Fortran. 1976 + 1977 +OPTIMIZE_FOR_FORTRAN = NO 1978 + 1979 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 1980 +# sources. Doxygen will then generate output that is tailored for 1981 +# VHDL. 1982 + 1983 +OPTIMIZE_OUTPUT_VHDL = NO 1984 + 1985 +# Doxygen selects the parser to use depending on the extension of the files it 1986 +# parses. With this tag you can assign which parser to use for a given 1987 +# extension. Doxygen has a built-in mapping, but you can override or extend it 1988 +# using this tag. The format is ext=language, where ext is a file extension, 1989 +# and language is one of the parsers supported by doxygen: IDL, Java, 1990 +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 1991 +# C++. For instance to make doxygen treat .inc files as Fortran files (default 1992 +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 1993 +# that for custom extensions you also need to set FILE_PATTERNS otherwise the 1994 +# files are not read by doxygen. 1995 + 1996 +EXTENSION_MAPPING = 1997 + 1998 +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 1999 +# comments according to the Markdown format, which allows for more readable 2000 +# documentation. See http://daringfireball.net/projects/markdown/ for details. 2001 +# The output of markdown processing is further processed by doxygen, so you 2002 +# can mix doxygen, HTML, and XML commands with Markdown formatting. 2003 +# Disable only in case of backward compatibilities issues. 2004 + 2005 +MARKDOWN_SUPPORT = YES 2006 + 2007 +# When enabled doxygen tries to link words that correspond to documented 2008 +# classes, or namespaces to their corresponding documentation. Such a link can 2009 +# be prevented in individual cases by by putting a % sign in front of the word 2010 +# or globally by setting AUTOLINK_SUPPORT to NO. 2011 + 2012 +AUTOLINK_SUPPORT = YES 2013 + 2014 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 2015 +# to include (a tag file for) the STL sources as input, then you should 2016 +# set this tag to YES in order to let doxygen match functions declarations and 2017 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 2018 +# func(std::string) {}). This also makes the inheritance and collaboration 2019 +# diagrams that involve STL classes more complete and accurate. 2020 + 2021 +BUILTIN_STL_SUPPORT = YES 2022 + 2023 +# If you use Microsoft's C++/CLI language, you should set this option to YES to 2024 +# enable parsing support. 2025 + 2026 +CPP_CLI_SUPPORT = NO 2027 + 2028 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 2029 +# Doxygen will parse them like normal C++ but will assume all classes use public 2030 +# instead of private inheritance when no explicit protection keyword is present. 2031 + 2032 +SIP_SUPPORT = NO 2033 + 2034 +# For Microsoft's IDL there are propget and propput attributes to indicate 2035 +# getter and setter methods for a property. Setting this option to YES (the 2036 +# default) will make doxygen replace the get and set methods by a property in 2037 +# the documentation. This will only work if the methods are indeed getting or 2038 +# setting a simple type. If this is not the case, or you want to show the 2039 +# methods anyway, you should set this option to NO. 2040 + 2041 +IDL_PROPERTY_SUPPORT = YES 2042 + 2043 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 2044 +# tag is set to YES, then doxygen will reuse the documentation of the first 2045 +# member in the group (if any) for the other members of the group. By default 2046 +# all members of a group must be documented explicitly. 2047 + 2048 +DISTRIBUTE_GROUP_DOC = NO 2049 + 2050 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 2051 +# the same type (for instance a group of public functions) to be put as a 2052 +# subgroup of that type (e.g. under the Public Functions section). Set it to 2053 +# NO to prevent subgrouping. Alternatively, this can be done per class using 2054 +# the \nosubgrouping command. 2055 + 2056 +SUBGROUPING = YES 2057 + 2058 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 2059 +# unions are shown inside the group in which they are included (e.g. using 2060 +# @ingroup) instead of on a separate page (for HTML and Man pages) or 2061 +# section (for LaTeX and RTF). 2062 + 2063 +INLINE_GROUPED_CLASSES = NO 2064 + 2065 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 2066 +# unions with only public data fields or simple typedef fields will be shown 2067 +# inline in the documentation of the scope in which they are defined (i.e. file, 2068 +# namespace, or group documentation), provided this scope is documented. If set 2069 +# to NO (the default), structs, classes, and unions are shown on a separate 2070 +# page (for HTML and Man pages) or section (for LaTeX and RTF). 2071 + 2072 +INLINE_SIMPLE_STRUCTS = NO 2073 + 2074 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 2075 +# is documented as struct, union, or enum with the name of the typedef. So 2076 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 2077 +# with name TypeT. When disabled the typedef will appear as a member of a file, 2078 +# namespace, or class. And the struct will be named TypeS. This can typically 2079 +# be useful for C code in case the coding convention dictates that all compound 2080 +# types are typedef'ed and only the typedef is referenced, never the tag name. 2081 + 2082 +TYPEDEF_HIDES_STRUCT = NO 2083 + 2084 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 2085 +# cache is used to resolve symbols given their name and scope. Since this can 2086 +# be an expensive process and often the same symbol appear multiple times in 2087 +# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too 2088 +# small doxygen will become slower. If the cache is too large, memory is wasted. 2089 +# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid 2090 +# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536 2091 +# symbols. 2092 + 2093 +LOOKUP_CACHE_SIZE = 0 2094 + 2095 +#--------------------------------------------------------------------------- 2096 +# Build related configuration options 2097 +#--------------------------------------------------------------------------- 2098 + 2099 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 2100 +# documentation are documented, even if no documentation was available. 2101 +# Private class members and static file members will be hidden unless 2102 +# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES 2103 + 2104 +EXTRACT_ALL = YES 2105 + 2106 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 2107 +# will be included in the documentation. 2108 + 2109 +EXTRACT_PRIVATE = NO 2110 + 2111 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 2112 +# scope will be included in the documentation. 2113 + 2114 +EXTRACT_PACKAGE = NO 2115 + 2116 +# If the EXTRACT_STATIC tag is set to YES all static members of a file 2117 +# will be included in the documentation. 2118 + 2119 +EXTRACT_STATIC = NO 2120 + 2121 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 2122 +# defined locally in source files will be included in the documentation. 2123 +# If set to NO only classes defined in header files are included. 2124 + 2125 +EXTRACT_LOCAL_CLASSES = NO 2126 + 2127 +# This flag is only useful for Objective-C code. When set to YES local 2128 +# methods, which are defined in the implementation section but not in 2129 +# the interface are included in the documentation. 2130 +# If set to NO (the default) only methods in the interface are included. 2131 + 2132 +EXTRACT_LOCAL_METHODS = NO 2133 + 2134 +# If this flag is set to YES, the members of anonymous namespaces will be 2135 +# extracted and appear in the documentation as a namespace called 2136 +# 'anonymous_namespace{file}', where file will be replaced with the base 2137 +# name of the file that contains the anonymous namespace. By default 2138 +# anonymous namespaces are hidden. 2139 + 2140 +EXTRACT_ANON_NSPACES = NO 2141 + 2142 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 2143 +# undocumented members of documented classes, files or namespaces. 2144 +# If set to NO (the default) these members will be included in the 2145 +# various overviews, but no documentation section is generated. 2146 +# This option has no effect if EXTRACT_ALL is enabled. 2147 + 2148 +HIDE_UNDOC_MEMBERS = NO 2149 + 2150 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 2151 +# undocumented classes that are normally visible in the class hierarchy. 2152 +# If set to NO (the default) these classes will be included in the various 2153 +# overviews. This option has no effect if EXTRACT_ALL is enabled. 2154 + 2155 +HIDE_UNDOC_CLASSES = NO 2156 + 2157 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 2158 +# friend (class|struct|union) declarations. 2159 +# If set to NO (the default) these declarations will be included in the 2160 +# documentation. 2161 + 2162 +HIDE_FRIEND_COMPOUNDS = NO 2163 + 2164 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 2165 +# documentation blocks found inside the body of a function. 2166 +# If set to NO (the default) these blocks will be appended to the 2167 +# function's detailed documentation block. 2168 + 2169 +HIDE_IN_BODY_DOCS = NO 2170 + 2171 +# The INTERNAL_DOCS tag determines if documentation 2172 +# that is typed after a \internal command is included. If the tag is set 2173 +# to NO (the default) then the documentation will be excluded. 2174 +# Set it to YES to include the internal documentation. 2175 + 2176 +INTERNAL_DOCS = NO 2177 + 2178 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 2179 +# file names in lower-case letters. If set to YES upper-case letters are also 2180 +# allowed. This is useful if you have classes or files whose names only differ 2181 +# in case and if your file system supports case sensitive file names. Windows 2182 +# and Mac users are advised to set this option to NO. 2183 + 2184 +CASE_SENSE_NAMES = NO 2185 + 2186 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 2187 +# will show members with their full class and namespace scopes in the 2188 +# documentation. If set to YES the scope will be hidden. 2189 + 2190 +HIDE_SCOPE_NAMES = NO 2191 + 2192 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 2193 +# will put a list of the files that are included by a file in the documentation 2194 +# of that file. 2195 + 2196 +SHOW_INCLUDE_FILES = YES 2197 + 2198 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 2199 +# will list include files with double quotes in the documentation 2200 +# rather than with sharp brackets. 2201 + 2202 +FORCE_LOCAL_INCLUDES = NO 2203 + 2204 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 2205 +# is inserted in the documentation for inline members. 2206 + 2207 +INLINE_INFO = YES 2208 + 2209 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 2210 +# will sort the (detailed) documentation of file and class members 2211 +# alphabetically by member name. If set to NO the members will appear in 2212 +# declaration order. 2213 + 2214 +SORT_MEMBER_DOCS = YES 2215 + 2216 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 2217 +# brief documentation of file, namespace and class members alphabetically 2218 +# by member name. If set to NO (the default) the members will appear in 2219 +# declaration order. 2220 + 2221 +SORT_BRIEF_DOCS = NO 2222 + 2223 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 2224 +# will sort the (brief and detailed) documentation of class members so that 2225 +# constructors and destructors are listed first. If set to NO (the default) 2226 +# the constructors will appear in the respective orders defined by 2227 +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 2228 +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 2229 +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 2230 + 2231 +SORT_MEMBERS_CTORS_1ST = NO 2232 + 2233 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 2234 +# hierarchy of group names into alphabetical order. If set to NO (the default) 2235 +# the group names will appear in their defined order. 2236 + 2237 +SORT_GROUP_NAMES = NO 2238 + 2239 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 2240 +# sorted by fully-qualified names, including namespaces. If set to 2241 +# NO (the default), the class list will be sorted only by class name, 2242 +# not including the namespace part. 2243 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 2244 +# Note: This option applies only to the class list, not to the 2245 +# alphabetical list. 2246 + 2247 +SORT_BY_SCOPE_NAME = NO 2248 + 2249 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 2250 +# do proper type resolution of all parameters of a function it will reject a 2251 +# match between the prototype and the implementation of a member function even 2252 +# if there is only one candidate or it is obvious which candidate to choose 2253 +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 2254 +# will still accept a match between prototype and implementation in such cases. 2255 + 2256 +STRICT_PROTO_MATCHING = NO 2257 + 2258 +# The GENERATE_TODOLIST tag can be used to enable (YES) or 2259 +# disable (NO) the todo list. This list is created by putting \todo 2260 +# commands in the documentation. 2261 + 2262 +GENERATE_TODOLIST = YES 2263 + 2264 +# The GENERATE_TESTLIST tag can be used to enable (YES) or 2265 +# disable (NO) the test list. This list is created by putting \test 2266 +# commands in the documentation. 2267 + 2268 +GENERATE_TESTLIST = YES 2269 + 2270 +# The GENERATE_BUGLIST tag can be used to enable (YES) or 2271 +# disable (NO) the bug list. This list is created by putting \bug 2272 +# commands in the documentation. 2273 + 2274 +GENERATE_BUGLIST = YES 2275 + 2276 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 2277 +# disable (NO) the deprecated list. This list is created by putting 2278 +# \deprecated commands in the documentation. 2279 + 2280 +GENERATE_DEPRECATEDLIST= YES 2281 + 2282 +# The ENABLED_SECTIONS tag can be used to enable conditional 2283 +# documentation sections, marked by \if section-label ... \endif 2284 +# and \cond section-label ... \endcond blocks. 2285 + 2286 +ENABLED_SECTIONS = 2287 + 2288 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 2289 +# the initial value of a variable or macro consists of for it to appear in 2290 +# the documentation. If the initializer consists of more lines than specified 2291 +# here it will be hidden. Use a value of 0 to hide initializers completely. 2292 +# The appearance of the initializer of individual variables and macros in the 2293 +# documentation can be controlled using \showinitializer or \hideinitializer 2294 +# command in the documentation regardless of this setting. 2295 + 2296 +MAX_INITIALIZER_LINES = 30 2297 + 2298 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 2299 +# at the bottom of the documentation of classes and structs. If set to YES the 2300 +# list will mention the files that were used to generate the documentation. 2301 + 2302 +SHOW_USED_FILES = YES 2303 + 2304 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 2305 +# This will remove the Files entry from the Quick Index and from the 2306 +# Folder Tree View (if specified). The default is YES. 2307 + 2308 +SHOW_FILES = YES 2309 + 2310 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 2311 +# Namespaces page. 2312 +# This will remove the Namespaces entry from the Quick Index 2313 +# and from the Folder Tree View (if specified). The default is YES. 2314 + 2315 +SHOW_NAMESPACES = YES 2316 + 2317 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that 2318 +# doxygen should invoke to get the current version for each file (typically from 2319 +# the version control system). Doxygen will invoke the program by executing (via 2320 +# popen()) the command , where is the value of 2321 +# the FILE_VERSION_FILTER tag, and is the name of an input file 2322 +# provided by doxygen. Whatever the program writes to standard output 2323 +# is used as the file version. See the manual for examples. 2324 + 2325 +FILE_VERSION_FILTER = 2326 + 2327 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 2328 +# by doxygen. The layout file controls the global structure of the generated 2329 +# output files in an output format independent way. To create the layout file 2330 +# that represents doxygen's defaults, run doxygen with the -l option. 2331 +# You can optionally specify a file name after the option, if omitted 2332 +# DoxygenLayout.xml will be used as the name of the layout file. 2333 + 2334 +LAYOUT_FILE = 2335 + 2336 +# The CITE_BIB_FILES tag can be used to specify one or more bib files 2337 +# containing the references data. This must be a list of .bib files. The 2338 +# .bib extension is automatically appended if omitted. Using this command 2339 +# requires the bibtex tool to be installed. See also 2340 +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 2341 +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 2342 +# feature you need bibtex and perl available in the search path. Do not use 2343 +# file names with spaces, bibtex cannot handle them. 2344 + 2345 +CITE_BIB_FILES = 2346 + 2347 +#--------------------------------------------------------------------------- 2348 +# configuration options related to warning and progress messages 2349 +#--------------------------------------------------------------------------- 2350 + 2351 +# The QUIET tag can be used to turn on/off the messages that are generated 2352 +# by doxygen. Possible values are YES and NO. If left blank NO is used. 2353 + 2354 +QUIET = NO 2355 + 2356 +# The WARNINGS tag can be used to turn on/off the warning messages that are 2357 +# generated by doxygen. Possible values are YES and NO. If left blank 2358 +# NO is used. 2359 + 2360 +WARNINGS = YES 2361 + 2362 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 2363 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 2364 +# automatically be disabled. 2365 + 2366 +WARN_IF_UNDOCUMENTED = YES 2367 + 2368 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 2369 +# potential errors in the documentation, such as not documenting some 2370 +# parameters in a documented function, or documenting parameters that 2371 +# don't exist or using markup commands wrongly. 2372 + 2373 +WARN_IF_DOC_ERROR = YES 2374 + 2375 +# The WARN_NO_PARAMDOC option can be enabled to get warnings for 2376 +# functions that are documented, but have no documentation for their parameters 2377 +# or return value. If set to NO (the default) doxygen will only warn about 2378 +# wrong or incomplete parameter documentation, but not about the absence of 2379 +# documentation. 2380 + 2381 +WARN_NO_PARAMDOC = NO 2382 + 2383 +# The WARN_FORMAT tag determines the format of the warning messages that 2384 +# doxygen can produce. The string should contain the$file, $line, and$text 2385 +# tags, which will be replaced by the file and line number from which the 2386 +# warning originated and the warning text. Optionally the format may contain 2387 +# $version, which will be replaced by the version of the file (if it could 2388 +# be obtained via FILE_VERSION_FILTER) 2389 + 2390 +WARN_FORMAT = "$file:$line:$text" 2391 + 2392 +# The WARN_LOGFILE tag can be used to specify a file to which warning 2393 +# and error messages should be written. If left blank the output is written 2394 +# to stderr. 2395 + 2396 +WARN_LOGFILE = 2397 + 2398 +#--------------------------------------------------------------------------- 2399 +# configuration options related to the input files 2400 +#--------------------------------------------------------------------------- 2401 + 2402 +# The INPUT tag can be used to specify the files and/or directories that contain 2403 +# documented source files. You may enter file names like "myfile.cpp" or 2404 +# directories like "/usr/src/myproject". Separate the files or directories 2405 +# with spaces. 2406 + 2407 +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc \ 2408 + @CMAKE_CURRENT_SOURCE_DIR@/include \ 2409 + @CMAKE_CURRENT_SOURCE_DIR@/getting_and_using_miral.md \ 2410 + @CMAKE_CURRENT_SOURCE_DIR@/tasks_for_the_interested_reader.md 2411 + 2412 +# This tag can be used to specify the character encoding of the source files 2413 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 2414 +# also the default input encoding. Doxygen uses libiconv (or the iconv built 2415 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 2416 +# the list of possible encodings. 2417 + 2418 +INPUT_ENCODING = UTF-8 2419 + 2420 +# If the value of the INPUT tag contains directories, you can use the 2421 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2422 +# and *.h) to filter out the source-files in the directories. If left 2423 +# blank the following patterns are tested: 2424 +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 2425 +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 2426 +# *.f90 *.f *.for *.vhd *.vhdl 2427 + 2428 +FILE_PATTERNS = *.c \ 2429 + *.cc \ 2430 + *.cxx \ 2431 + *.cpp \ 2432 + *.c++ \ 2433 + *.d \ 2434 + *.java \ 2435 + *.ii \ 2436 + *.ixx \ 2437 + *.ipp \ 2438 + *.i++ \ 2439 + *.inl \ 2440 + *.h \ 2441 + *.hh \ 2442 + *.hxx \ 2443 + *.hpp \ 2444 + *.h++ \ 2445 + *.idl \ 2446 + *.odl \ 2447 + *.cs \ 2448 + *.php \ 2449 + *.php3 \ 2450 + *.inc \ 2451 + *.m \ 2452 + *.markdown \ 2453 + *.md \ 2454 + *.mm \ 2455 + *.dox \ 2456 + *.py \ 2457 + *.f90 \ 2458 + *.f \ 2459 + *.for \ 2460 + *.vhd \ 2461 + *.vhdl 2462 + 2463 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories 2464 +# should be searched for input files as well. Possible values are YES and NO. 2465 +# If left blank NO is used. 2466 + 2467 +RECURSIVE = YES 2468 + 2469 +# The EXCLUDE tag can be used to specify files and/or directories that should be 2470 +# excluded from the INPUT source files. This way you can easily exclude a 2471 +# subdirectory from a directory tree whose root is specified with the INPUT tag. 2472 +# Note that relative paths are relative to the directory from which doxygen is 2473 +# run. 2474 + 2475 +EXCLUDE = 2476 + 2477 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 2478 +# directories that are symbolic links (a Unix file system feature) are excluded 2479 +# from the input. 2480 + 2481 +EXCLUDE_SYMLINKS = NO 2482 + 2483 +# If the value of the INPUT tag contains directories, you can use the 2484 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 2485 +# certain files from those directories. Note that the wildcards are matched 2486 +# against the file with absolute path, so to exclude all test directories 2487 +# for example use the pattern */test/* 2488 + 2489 +EXCLUDE_PATTERNS = 2490 + 2491 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 2492 +# (namespaces, classes, functions, etc.) that should be excluded from the 2493 +# output. The symbol name can be a fully qualified name, a word, or if the 2494 +# wildcard * is used, a substring. Examples: ANamespace, AClass, 2495 +# AClass::ANamespace, ANamespace::*Test 2496 + 2497 +EXCLUDE_SYMBOLS = miral::detail \ 2498 + mir::* \ 2499 + mir 2500 + 2501 +# The EXAMPLE_PATH tag can be used to specify one or more files or 2502 +# directories that contain example code fragments that are included (see 2503 +# the \include command). 2504 + 2505 +EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/miral-shell 2506 + 2507 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the 2508 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2509 +# and *.h) to filter out the source-files in the directories. If left 2510 +# blank all files are included. 2511 + 2512 +EXAMPLE_PATTERNS = * 2513 + 2514 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 2515 +# searched for input files to be used with the \include or \dontinclude 2516 +# commands irrespective of the value of the RECURSIVE tag. 2517 +# Possible values are YES and NO. If left blank NO is used. 2518 + 2519 +EXAMPLE_RECURSIVE = NO 2520 + 2521 +# The IMAGE_PATH tag can be used to specify one or more files or 2522 +# directories that contain image that are included in the documentation (see 2523 +# the \image command). 2524 + 2525 +IMAGE_PATH = 2526 + 2527 +# The INPUT_FILTER tag can be used to specify a program that doxygen should 2528 +# invoke to filter for each input file. Doxygen will invoke the filter program 2529 +# by executing (via popen()) the command , where 2530 +# is the value of the INPUT_FILTER tag, and is the name of an 2531 +# input file. Doxygen will then use the output that the filter program writes 2532 +# to standard output. 2533 +# If FILTER_PATTERNS is specified, this tag will be ignored. 2534 +# Note that the filter must not add or remove lines; it is applied before the 2535 +# code is scanned, but not when the output code is generated. If lines are added 2536 +# or removed, the anchors will not be placed correctly. 2537 + 2538 +INPUT_FILTER = 2539 + 2540 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 2541 +# basis. 2542 +# Doxygen will compare the file name with each pattern and apply the 2543 +# filter if there is a match. 2544 +# The filters are a list of the form: 2545 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 2546 +# info on how filters are used. If FILTER_PATTERNS is empty or if 2547 +# non of the patterns match the file name, INPUT_FILTER is applied. 2548 + 2549 +FILTER_PATTERNS = 2550 + 2551 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 2552 +# INPUT_FILTER) will be used to filter the input files when producing source 2553 +# files to browse (i.e. when SOURCE_BROWSER is set to YES). 2554 + 2555 +FILTER_SOURCE_FILES = NO 2556 + 2557 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 2558 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 2559 +# and it is also possible to disable source filtering for a specific pattern 2560 +# using *.ext= (so without naming a filter). This option only has effect when 2561 +# FILTER_SOURCE_FILES is enabled. 2562 + 2563 +FILTER_SOURCE_PATTERNS = 2564 + 2565 +# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 2566 +# is part of the input, its contents will be placed on the main page 2567 +# (index.html). This can be useful if you have a project on for instance GitHub 2568 +# and want reuse the introduction page also for the doxygen output. 2569 + 2570 +USE_MDFILE_AS_MAINPAGE = 2571 + 2572 +#--------------------------------------------------------------------------- 2573 +# configuration options related to source browsing 2574 +#--------------------------------------------------------------------------- 2575 + 2576 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will 2577 +# be generated. Documented entities will be cross-referenced with these sources. 2578 +# Note: To get rid of all source code in the generated output, make sure also 2579 +# VERBATIM_HEADERS is set to NO. 2580 + 2581 +SOURCE_BROWSER = NO 2582 + 2583 +# Setting the INLINE_SOURCES tag to YES will include the body 2584 +# of functions and classes directly in the documentation. 2585 + 2586 +INLINE_SOURCES = NO 2587 + 2588 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 2589 +# doxygen to hide any special comment blocks from generated source code 2590 +# fragments. Normal C, C++ and Fortran comments will always remain visible. 2591 + 2592 +STRIP_CODE_COMMENTS = YES 2593 + 2594 +# If the REFERENCED_BY_RELATION tag is set to YES 2595 +# then for each documented function all documented 2596 +# functions referencing it will be listed. 2597 + 2598 +REFERENCED_BY_RELATION = NO 2599 + 2600 +# If the REFERENCES_RELATION tag is set to YES 2601 +# then for each documented function all documented entities 2602 +# called/used by that function will be listed. 2603 + 2604 +REFERENCES_RELATION = NO 2605 + 2606 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 2607 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 2608 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 2609 +# link to the source code. 2610 +# Otherwise they will link to the documentation. 2611 + 2612 +REFERENCES_LINK_SOURCE = YES 2613 + 2614 +# If the USE_HTAGS tag is set to YES then the references to source code 2615 +# will point to the HTML generated by the htags(1) tool instead of doxygen 2616 +# built-in source browser. The htags tool is part of GNU's global source 2617 +# tagging system (see http://www.gnu.org/software/global/global.html). You 2618 +# will need version 4.8.6 or higher. 2619 + 2620 +USE_HTAGS = NO 2621 + 2622 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 2623 +# will generate a verbatim copy of the header file for each class for 2624 +# which an include is specified. Set to NO to disable this. 2625 + 2626 +VERBATIM_HEADERS = YES 2627 + 2628 +#--------------------------------------------------------------------------- 2629 +# configuration options related to the alphabetical class index 2630 +#--------------------------------------------------------------------------- 2631 + 2632 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 2633 +# of all compounds will be generated. Enable this if the project 2634 +# contains a lot of classes, structs, unions or interfaces. 2635 + 2636 +ALPHABETICAL_INDEX = YES 2637 + 2638 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 2639 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 2640 +# in which this list will be split (can be a number in the range [1..20]) 2641 + 2642 +COLS_IN_ALPHA_INDEX = 5 2643 + 2644 +# In case all classes in a project start with a common prefix, all 2645 +# classes will be put under the same header in the alphabetical index. 2646 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 2647 +# should be ignored while generating the index headers. 2648 + 2649 +IGNORE_PREFIX = 2650 + 2651 +#--------------------------------------------------------------------------- 2652 +# configuration options related to the HTML output 2653 +#--------------------------------------------------------------------------- 2654 + 2655 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 2656 +# generate HTML output. 2657 + 2658 +GENERATE_HTML = YES 2659 + 2660 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 2661 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 2662 +# put in front of it. If left blank html' will be used as the default path. 2663 + 2664 +HTML_OUTPUT = html 2665 + 2666 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 2667 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 2668 +# doxygen will generate files with .html extension. 2669 + 2670 +HTML_FILE_EXTENSION = .html 2671 + 2672 +# The HTML_HEADER tag can be used to specify a personal HTML header for 2673 +# each generated HTML page. If it is left blank doxygen will generate a 2674 +# standard header. Note that when using a custom header you are responsible 2675 +# for the proper inclusion of any scripts and style sheets that doxygen 2676 +# needs, which is dependent on the configuration options used. 2677 +# It is advised to generate a default header using "doxygen -w html 2678 +# header.html footer.html stylesheet.css YourConfigFile" and then modify 2679 +# that header. Note that the header is subject to change so you typically 2680 +# have to redo this when upgrading to a newer version of doxygen or when 2681 +# changing the value of configuration settings such as GENERATE_TREEVIEW! 2682 + 2683 +HTML_HEADER = 2684 + 2685 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for 2686 +# each generated HTML page. If it is left blank doxygen will generate a 2687 +# standard footer. 2688 + 2689 +HTML_FOOTER = @CMAKE_BINARY_DIR@/doc/footer.html 2690 + 2691 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 2692 +# style sheet that is used by each HTML page. It can be used to 2693 +# fine-tune the look of the HTML output. If left blank doxygen will 2694 +# generate a default style sheet. Note that it is recommended to use 2695 +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 2696 +# tag will in the future become obsolete. 2697 + 2698 +HTML_STYLESHEET = 2699 + 2700 +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 2701 +# user-defined cascading style sheet that is included after the standard 2702 +# style sheets created by doxygen. Using this option one can overrule 2703 +# certain style aspects. This is preferred over using HTML_STYLESHEET 2704 +# since it does not replace the standard style sheet and is therefor more 2705 +# robust against future updates. Doxygen will copy the style sheet file to 2706 +# the output directory. 2707 + 2708 +HTML_EXTRA_STYLESHEET = @CMAKE_BINARY_DIR@/doc/extra.css 2709 + 2710 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 2711 +# other source files which should be copied to the HTML output directory. Note 2712 +# that these files will be copied to the base HTML output directory. Use the 2713 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 2714 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that 2715 +# the files will be copied as-is; there are no commands or markers available. 2716 + 2717 +HTML_EXTRA_FILES = 2718 + 2719 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 2720 +# Doxygen will adjust the colors in the style sheet and background images 2721 +# according to this color. Hue is specified as an angle on a colorwheel, 2722 +# see http://en.wikipedia.org/wiki/Hue for more information. 2723 +# For instance the value 0 represents red, 60 is yellow, 120 is green, 2724 +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 2725 +# The allowed range is 0 to 359. 2726 + 2727 +HTML_COLORSTYLE_HUE = 16 2728 + 2729 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 2730 +# the colors in the HTML output. For a value of 0 the output will use 2731 +# grayscales only. A value of 255 will produce the most vivid colors. 2732 + 2733 +HTML_COLORSTYLE_SAT = 240 2734 + 2735 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 2736 +# the luminance component of the colors in the HTML output. Values below 2737 +# 100 gradually make the output lighter, whereas values above 100 make 2738 +# the output darker. The value divided by 100 is the actual gamma applied, 2739 +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 2740 +# and 100 does not change the gamma. 2741 + 2742 +HTML_COLORSTYLE_GAMMA = 80 2743 + 2744 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 2745 +# page will contain the date and time when the page was generated. Setting 2746 +# this to NO can help when comparing the output of multiple runs. 2747 + 2748 +HTML_TIMESTAMP = YES 2749 + 2750 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 2751 +# documentation will contain sections that can be hidden and shown after the 2752 +# page has loaded. 2753 + 2754 +HTML_DYNAMIC_SECTIONS = NO 2755 + 2756 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 2757 +# entries shown in the various tree structured indices initially; the user 2758 +# can expand and collapse entries dynamically later on. Doxygen will expand 2759 +# the tree to such a level that at most the specified number of entries are 2760 +# visible (unless a fully collapsed tree already exceeds this amount). 2761 +# So setting the number of entries 1 will produce a full collapsed tree by 2762 +# default. 0 is a special value representing an infinite number of entries 2763 +# and will result in a full expanded tree by default. 2764 + 2765 +HTML_INDEX_NUM_ENTRIES = 100 2766 + 2767 +# If the GENERATE_DOCSET tag is set to YES, additional index files 2768 +# will be generated that can be used as input for Apple's Xcode 3 2769 +# integrated development environment, introduced with OSX 10.5 (Leopard). 2770 +# To create a documentation set, doxygen will generate a Makefile in the 2771 +# HTML output directory. Running make will produce the docset in that 2772 +# directory and running "make install" will install the docset in 2773 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 2774 +# it at startup. 2775 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 2776 +# for more information. 2777 + 2778 +GENERATE_DOCSET = NO 2779 + 2780 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 2781 +# feed. A documentation feed provides an umbrella under which multiple 2782 +# documentation sets from a single provider (such as a company or product suite) 2783 +# can be grouped. 2784 + 2785 +DOCSET_FEEDNAME = "Doxygen generated docs" 2786 + 2787 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 2788 +# should uniquely identify the documentation set bundle. This should be a 2789 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 2790 +# will append .docset to the name. 2791 + 2792 +DOCSET_BUNDLE_ID = org.doxygen.Project 2793 + 2794 +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 2795 +# identify the documentation publisher. This should be a reverse domain-name 2796 +# style string, e.g. com.mycompany.MyDocSet.documentation. 2797 + 2798 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher 2799 + 2800 +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 2801 + 2802 +DOCSET_PUBLISHER_NAME = Publisher 2803 + 2804 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files 2805 +# will be generated that can be used as input for tools like the 2806 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 2807 +# of the generated HTML documentation. 2808 + 2809 +GENERATE_HTMLHELP = NO 2810 + 2811 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 2812 +# be used to specify the file name of the resulting .chm file. You 2813 +# can add a path in front of the file if the result should not be 2814 +# written to the html output directory. 2815 + 2816 +CHM_FILE = 2817 + 2818 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 2819 +# be used to specify the location (absolute path including file name) of 2820 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 2821 +# the HTML help compiler on the generated index.hhp. 2822 + 2823 +HHC_LOCATION = 2824 + 2825 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 2826 +# controls if a separate .chi index file is generated (YES) or that 2827 +# it should be included in the master .chm file (NO). 2828 + 2829 +GENERATE_CHI = NO 2830 + 2831 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 2832 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file 2833 +# content. 2834 + 2835 +CHM_INDEX_ENCODING = 2836 + 2837 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 2838 +# controls whether a binary table of contents is generated (YES) or a 2839 +# normal table of contents (NO) in the .chm file. 2840 + 2841 +BINARY_TOC = NO 2842 + 2843 +# The TOC_EXPAND flag can be set to YES to add extra items for group members 2844 +# to the contents of the HTML help documentation and to the tree view. 2845 + 2846 +TOC_EXPAND = NO 2847 + 2848 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 2849 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 2850 +# that can be used as input for Qt's qhelpgenerator to generate a 2851 +# Qt Compressed Help (.qch) of the generated HTML documentation. 2852 + 2853 +GENERATE_QHP = NO 2854 + 2855 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 2856 +# be used to specify the file name of the resulting .qch file. 2857 +# The path specified is relative to the HTML output folder. 2858 + 2859 +QCH_FILE = 2860 + 2861 +# The QHP_NAMESPACE tag specifies the namespace to use when generating 2862 +# Qt Help Project output. For more information please see 2863 +# http://doc.trolltech.com/qthelpproject.html#namespace 2864 + 2865 +QHP_NAMESPACE = org.doxygen.Project 2866 + 2867 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 2868 +# Qt Help Project output. For more information please see 2869 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders 2870 + 2871 +QHP_VIRTUAL_FOLDER = doc 2872 + 2873 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 2874 +# add. For more information please see 2875 +# http://doc.trolltech.com/qthelpproject.html#custom-filters 2876 + 2877 +QHP_CUST_FILTER_NAME = 2878 + 2879 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 2880 +# custom filter to add. For more information please see 2881 +# 2882 +# Qt Help Project / Custom Filters. 2883 + 2884 +QHP_CUST_FILTER_ATTRS = 2885 + 2886 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 2887 +# project's 2888 +# filter section matches. 2889 +# 2890 +# Qt Help Project / Filter Attributes. 2891 + 2892 +QHP_SECT_FILTER_ATTRS = 2893 + 2894 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 2895 +# be used to specify the location of Qt's qhelpgenerator. 2896 +# If non-empty doxygen will try to run qhelpgenerator on the generated 2897 +# .qhp file. 2898 + 2899 +QHG_LOCATION = 2900 + 2901 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 2902 +# will be generated, which together with the HTML files, form an Eclipse help 2903 +# plugin. To install this plugin and make it available under the help contents 2904 +# menu in Eclipse, the contents of the directory containing the HTML and XML 2905 +# files needs to be copied into the plugins directory of eclipse. The name of 2906 +# the directory within the plugins directory should be the same as 2907 +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 2908 +# the help appears. 2909 + 2910 +GENERATE_ECLIPSEHELP = NO 2911 + 2912 +# A unique identifier for the eclipse help plugin. When installing the plugin 2913 +# the directory name containing the HTML and XML files should also have 2914 +# this name. 2915 + 2916 +ECLIPSE_DOC_ID = org.doxygen.Project 2917 + 2918 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 2919 +# at top of each HTML page. The value NO (the default) enables the index and 2920 +# the value YES disables it. Since the tabs have the same information as the 2921 +# navigation tree you can set this option to NO if you already set 2922 +# GENERATE_TREEVIEW to YES. 2923 + 2924 +DISABLE_INDEX = NO 2925 + 2926 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 2927 +# structure should be generated to display hierarchical information. 2928 +# If the tag value is set to YES, a side panel will be generated 2929 +# containing a tree-like index structure (just like the one that 2930 +# is generated for HTML Help). For this to work a browser that supports 2931 +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 2932 +# Windows users are probably better off using the HTML help feature. 2933 +# Since the tree basically has the same information as the tab index you 2934 +# could consider to set DISABLE_INDEX to NO when enabling this option. 2935 + 2936 +GENERATE_TREEVIEW = NO 2937 + 2938 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 2939 +# (range [0,1..20]) that doxygen will group on one line in the generated HTML 2940 +# documentation. Note that a value of 0 will completely suppress the enum 2941 +# values from appearing in the overview section. 2942 + 2943 +ENUM_VALUES_PER_LINE = 4 2944 + 2945 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 2946 +# used to set the initial width (in pixels) of the frame in which the tree 2947 +# is shown. 2948 + 2949 +TREEVIEW_WIDTH = 250 2950 + 2951 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 2952 +# links to external symbols imported via tag files in a separate window. 2953 + 2954 +EXT_LINKS_IN_WINDOW = NO 2955 + 2956 +# Use this tag to change the font size of Latex formulas included 2957 +# as images in the HTML documentation. The default is 10. Note that 2958 +# when you change the font size after a successful doxygen run you need 2959 +# to manually remove any form_*.png images from the HTML output directory 2960 +# to force them to be regenerated. 2961 + 2962 +FORMULA_FONTSIZE = 10 2963 + 2964 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images 2965 +# generated for formulas are transparent PNGs. Transparent PNGs are 2966 +# not supported properly for IE 6.0, but are supported on all modern browsers. 2967 +# Note that when changing this option you need to delete any form_*.png files 2968 +# in the HTML output before the changes have effect. 2969 + 2970 +FORMULA_TRANSPARENT = YES 2971 + 2972 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 2973 +# (see http://www.mathjax.org) which uses client side Javascript for the 2974 +# rendering instead of using prerendered bitmaps. Use this if you do not 2975 +# have LaTeX installed or if you want to formulas look prettier in the HTML 2976 +# output. When enabled you may also need to install MathJax separately and 2977 +# configure the path to it using the MATHJAX_RELPATH option. 2978 + 2979 +USE_MATHJAX = NO 2980 + 2981 +# When MathJax is enabled you can set the default output format to be used for 2982 +# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 2983 +# SVG. The default value is HTML-CSS, which is slower, but has the best 2984 +# compatibility. 2985 + 2986 +MATHJAX_FORMAT = HTML-CSS 2987 + 2988 +# When MathJax is enabled you need to specify the location relative to the 2989 +# HTML output directory using the MATHJAX_RELPATH option. The destination 2990 +# directory should contain the MathJax.js script. For instance, if the mathjax 2991 +# directory is located at the same level as the HTML output directory, then 2992 +# MATHJAX_RELPATH should be ../mathjax. The default value points to 2993 +# the MathJax Content Delivery Network so you can quickly see the result without 2994 +# installing MathJax. 2995 +# However, it is strongly recommended to install a local 2996 +# copy of MathJax from http://www.mathjax.org before deployment. 2997 + 2998 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 2999 + 3000 +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 3001 +# names that should be enabled during MathJax rendering. 3002 + 3003 +MATHJAX_EXTENSIONS = 3004 + 3005 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript 3006 +# pieces of code that will be used on startup of the MathJax code. 3007 + 3008 +MATHJAX_CODEFILE = 3009 + 3010 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box 3011 +# for the HTML output. The underlying search engine uses javascript 3012 +# and DHTML and should work on any modern browser. Note that when using 3013 +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 3014 +# (GENERATE_DOCSET) there is already a search function so this one should 3015 +# typically be disabled. For large projects the javascript based search engine 3016 +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 3017 + 3018 +SEARCHENGINE = YES 3019 + 3020 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 3021 +# implemented using a web server instead of a web client using Javascript. 3022 +# There are two flavours of web server based search depending on the 3023 +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 3024 +# searching and an index file used by the script. When EXTERNAL_SEARCH is 3025 +# enabled the indexing and searching needs to be provided by external tools. 3026 +# See the manual for details. 3027 + 3028 +SERVER_BASED_SEARCH = NO 3029 + 3030 +# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 3031 +# script for searching. Instead the search results are written to an XML file 3032 +# which needs to be processed by an external indexer. Doxygen will invoke an 3033 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain 3034 +# the search results. Doxygen ships with an example indexer (doxyindexer) and 3035 +# search engine (doxysearch.cgi) which are based on the open source search 3036 +# engine library Xapian. See the manual for configuration details. 3037 + 3038 +EXTERNAL_SEARCH = NO 3039 + 3040 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server 3041 +# which will returned the search results when EXTERNAL_SEARCH is enabled. 3042 +# Doxygen ships with an example search engine (doxysearch) which is based on 3043 +# the open source search engine library Xapian. See the manual for configuration 3044 +# details. 3045 + 3046 +SEARCHENGINE_URL = 3047 + 3048 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 3049 +# search data is written to a file for indexing by an external tool. With the 3050 +# SEARCHDATA_FILE tag the name of this file can be specified. 3051 + 3052 +SEARCHDATA_FILE = searchdata.xml 3053 + 3054 +# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 3055 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 3056 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 3057 +# projects and redirect the results back to the right project. 3058 + 3059 +EXTERNAL_SEARCH_ID = 3060 + 3061 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 3062 +# projects other than the one defined by this configuration file, but that are 3063 +# all added to the same external search index. Each project needs to have a 3064 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 3065 +# of to a relative location where the documentation can be found. 3066 +# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 3067 + 3068 +EXTRA_SEARCH_MAPPINGS = 3069 + 3070 +#--------------------------------------------------------------------------- 3071 +# configuration options related to the LaTeX output 3072 +#--------------------------------------------------------------------------- 3073 + 3074 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 3075 +# generate Latex output. 3076 + 3077 +GENERATE_LATEX = NO 3078 + 3079 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 3080 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 3081 +# put in front of it. If left blank latex' will be used as the default path. 3082 + 3083 +LATEX_OUTPUT = latex 3084 + 3085 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 3086 +# invoked. If left blank latex' will be used as the default command name. 3087 +# Note that when enabling USE_PDFLATEX this option is only used for 3088 +# generating bitmaps for formulas in the HTML output, but not in the 3089 +# Makefile that is written to the output directory. 3090 + 3091 +LATEX_CMD_NAME = latex 3092 + 3093 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 3094 +# generate index for LaTeX. If left blank makeindex' will be used as the 3095 +# default command name. 3096 + 3097 +MAKEINDEX_CMD_NAME = makeindex 3098 + 3099 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 3100 +# LaTeX documents. This may be useful for small projects and may help to 3101 +# save some trees in general. 3102 + 3103 +COMPACT_LATEX = NO 3104 + 3105 +# The PAPER_TYPE tag can be used to set the paper type that is used 3106 +# by the printer. Possible values are: a4, letter, legal and 3107 +# executive. If left blank a4 will be used. 3108 + 3109 +PAPER_TYPE = a4 3110 + 3111 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 3112 +# packages that should be included in the LaTeX output. 3113 + 3114 +EXTRA_PACKAGES = 3115 + 3116 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 3117 +# the generated latex document. The header should contain everything until 3118 +# the first chapter. If it is left blank doxygen will generate a 3119 +# standard header. Notice: only use this tag if you know what you are doing! 3120 + 3121 +LATEX_HEADER = 3122 + 3123 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 3124 +# the generated latex document. The footer should contain everything after 3125 +# the last chapter. If it is left blank doxygen will generate a 3126 +# standard footer. Notice: only use this tag if you know what you are doing! 3127 + 3128 +LATEX_FOOTER = 3129 + 3130 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images 3131 +# or other source files which should be copied to the LaTeX output directory. 3132 +# Note that the files will be copied as-is; there are no commands or markers 3133 +# available. 3134 + 3135 +LATEX_EXTRA_FILES = 3136 + 3137 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 3138 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will 3139 +# contain links (just like the HTML output) instead of page references 3140 +# This makes the output suitable for online browsing using a pdf viewer. 3141 + 3142 +PDF_HYPERLINKS = YES 3143 + 3144 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 3145 +# plain latex in the generated Makefile. Set this option to YES to get a 3146 +# higher quality PDF documentation. 3147 + 3148 +USE_PDFLATEX = YES 3149 + 3150 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 3151 +# command to the generated LaTeX files. This will instruct LaTeX to keep 3152 +# running if errors occur, instead of asking the user for help. 3153 +# This option is also used when generating formulas in HTML. 3154 + 3155 +LATEX_BATCHMODE = NO 3156 + 3157 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not 3158 +# include the index chapters (such as File Index, Compound Index, etc.) 3159 +# in the output. 3160 + 3161 +LATEX_HIDE_INDICES = NO 3162 + 3163 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include 3164 +# source code with syntax highlighting in the LaTeX output. 3165 +# Note that which sources are shown also depends on other settings 3166 +# such as SOURCE_BROWSER. 3167 + 3168 +LATEX_SOURCE_CODE = NO 3169 + 3170 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 3171 +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 3172 +# http://en.wikipedia.org/wiki/BibTeX for more info. 3173 + 3174 +LATEX_BIB_STYLE = plain 3175 + 3176 +#--------------------------------------------------------------------------- 3177 +# configuration options related to the RTF output 3178 +#--------------------------------------------------------------------------- 3179 + 3180 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 3181 +# The RTF output is optimized for Word 97 and may not look very pretty with 3182 +# other RTF readers or editors. 3183 + 3184 +GENERATE_RTF = NO 3185 + 3186 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 3187 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 3188 +# put in front of it. If left blank rtf' will be used as the default path. 3189 + 3190 +RTF_OUTPUT = rtf 3191 + 3192 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 3193 +# RTF documents. This may be useful for small projects and may help to 3194 +# save some trees in general. 3195 + 3196 +COMPACT_RTF = NO 3197 + 3198 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 3199 +# will contain hyperlink fields. The RTF file will 3200 +# contain links (just like the HTML output) instead of page references. 3201 +# This makes the output suitable for online browsing using WORD or other 3202 +# programs which support those fields. 3203 +# Note: wordpad (write) and others do not support links. 3204 + 3205 +RTF_HYPERLINKS = NO 3206 + 3207 +# Load style sheet definitions from file. Syntax is similar to doxygen's 3208 +# config file, i.e. a series of assignments. You only have to provide 3209 +# replacements, missing definitions are set to their default value. 3210 + 3211 +RTF_STYLESHEET_FILE = 3212 + 3213 +# Set optional variables used in the generation of an rtf document. 3214 +# Syntax is similar to doxygen's config file. 3215 + 3216 +RTF_EXTENSIONS_FILE = 3217 + 3218 +#--------------------------------------------------------------------------- 3219 +# configuration options related to the man page output 3220 +#--------------------------------------------------------------------------- 3221 + 3222 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 3223 +# generate man pages 3224 + 3225 +GENERATE_MAN = NO 3226 + 3227 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. 3228 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 3229 +# put in front of it. If left blank man' will be used as the default path. 3230 + 3231 +MAN_OUTPUT = man 3232 + 3233 +# The MAN_EXTENSION tag determines the extension that is added to 3234 +# the generated man pages (default is the subroutine's section .3) 3235 + 3236 +MAN_EXTENSION = .3 3237 + 3238 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 3239 +# then it will generate one additional man file for each entity 3240 +# documented in the real man page(s). These additional files 3241 +# only source the real man page, but without them the man command 3242 +# would be unable to find the correct page. The default is NO. 3243 + 3244 +MAN_LINKS = NO 3245 + 3246 +#--------------------------------------------------------------------------- 3247 +# configuration options related to the XML output 3248 +#--------------------------------------------------------------------------- 3249 + 3250 +# If the GENERATE_XML tag is set to YES Doxygen will 3251 +# generate an XML file that captures the structure of 3252 +# the code including all documentation. 3253 + 3254 +GENERATE_XML = YES 3255 + 3256 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. 3257 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be 3258 +# put in front of it. If left blank xml' will be used as the default path. 3259 + 3260 +XML_OUTPUT = xml 3261 + 3262 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 3263 +# dump the program listings (including syntax highlighting 3264 +# and cross-referencing information) to the XML output. Note that 3265 +# enabling this will significantly increase the size of the XML output. 3266 + 3267 +XML_PROGRAMLISTING = YES 3268 + 3269 +#--------------------------------------------------------------------------- 3270 +# configuration options related to the DOCBOOK output 3271 +#--------------------------------------------------------------------------- 3272 + 3273 +# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files 3274 +# that can be used to generate PDF. 3275 + 3276 +GENERATE_DOCBOOK = NO 3277 + 3278 +# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put. 3279 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 3280 +# front of it. If left blank docbook will be used as the default path. 3281 + 3282 +DOCBOOK_OUTPUT = docbook 3283 + 3284 +#--------------------------------------------------------------------------- 3285 +# configuration options for the AutoGen Definitions output 3286 +#--------------------------------------------------------------------------- 3287 + 3288 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 3289 +# generate an AutoGen Definitions (see autogen.sf.net) file 3290 +# that captures the structure of the code including all 3291 +# documentation. Note that this feature is still experimental 3292 +# and incomplete at the moment. 3293 + 3294 +GENERATE_AUTOGEN_DEF = NO 3295 + 3296 +#--------------------------------------------------------------------------- 3297 +# configuration options related to the Perl module output 3298 +#--------------------------------------------------------------------------- 3299 + 3300 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will 3301 +# generate a Perl module file that captures the structure of 3302 +# the code including all documentation. Note that this 3303 +# feature is still experimental and incomplete at the 3304 +# moment. 3305 + 3306 +GENERATE_PERLMOD = NO 3307 + 3308 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 3309 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able 3310 +# to generate PDF and DVI output from the Perl module output. 3311 + 3312 +PERLMOD_LATEX = NO 3313 + 3314 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 3315 +# nicely formatted so it can be parsed by a human reader. 3316 +# This is useful 3317 +# if you want to understand what is going on. 3318 +# On the other hand, if this 3319 +# tag is set to NO the size of the Perl module output will be much smaller 3320 +# and Perl will parse it just the same. 3321 + 3322 +PERLMOD_PRETTY = YES 3323 + 3324 +# The names of the make variables in the generated doxyrules.make file 3325 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 3326 +# This is useful so different doxyrules.make files included by the same 3327 +# Makefile don't overwrite each other's variables. 3328 + 3329 +PERLMOD_MAKEVAR_PREFIX = 3330 + 3331 +#--------------------------------------------------------------------------- 3332 +# Configuration options related to the preprocessor 3333 +#--------------------------------------------------------------------------- 3334 + 3335 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 3336 +# evaluate all C-preprocessor directives found in the sources and include 3337 +# files. 3338 + 3339 +ENABLE_PREPROCESSING = YES 3340 + 3341 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 3342 +# names in the source code. If set to NO (the default) only conditional 3343 +# compilation will be performed. Macro expansion can be done in a controlled 3344 +# way by setting EXPAND_ONLY_PREDEF to YES. 3345 + 3346 +MACRO_EXPANSION = NO 3347 + 3348 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 3349 +# then the macro expansion is limited to the macros specified with the 3350 +# PREDEFINED and EXPAND_AS_DEFINED tags. 3351 + 3352 +EXPAND_ONLY_PREDEF = NO 3353 + 3354 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 3355 +# pointed to by INCLUDE_PATH will be searched when a #include is found. 3356 + 3357 +SEARCH_INCLUDES = YES 3358 + 3359 +# The INCLUDE_PATH tag can be used to specify one or more directories that 3360 +# contain include files that are not input files but should be processed by 3361 +# the preprocessor. 3362 + 3363 +INCLUDE_PATH = 3364 + 3365 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 3366 +# patterns (like *.h and *.hpp) to filter out the header-files in the 3367 +# directories. If left blank, the patterns specified with FILE_PATTERNS will 3368 +# be used. 3369 + 3370 +INCLUDE_FILE_PATTERNS = 3371 + 3372 +# The PREDEFINED tag can be used to specify one or more macro names that 3373 +# are defined before the preprocessor is started (similar to the -D option of 3374 +# gcc). The argument of the tag is a list of macros of the form: name 3375 +# or name=definition (no spaces). If the definition and the = are 3376 +# omitted =1 is assumed. To prevent a macro definition from being 3377 +# undefined via #undef or recursively expanded use the := operator 3378 +# instead of the = operator. 3379 + 3380 +PREDEFINED = __cplusplus 3381 + 3382 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 3383 +# this tag can be used to specify a list of macro names that should be expanded. 3384 +# The macro definition that is found in the sources will be used. 3385 +# Use the PREDEFINED tag if you want to use a different macro definition that 3386 +# overrules the definition found in the source code. 3387 + 3388 +EXPAND_AS_DEFINED = 3389 + 3390 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 3391 +# doxygen's preprocessor will remove all references to function-like macros 3392 +# that are alone on a line, have an all uppercase name, and do not end with a 3393 +# semicolon, because these will confuse the parser if not removed. 3394 + 3395 +SKIP_FUNCTION_MACROS = YES 3396 + 3397 +#--------------------------------------------------------------------------- 3398 +# Configuration::additions related to external references 3399 +#--------------------------------------------------------------------------- 3400 + 3401 +# The TAGFILES option can be used to specify one or more tagfiles. For each 3402 +# tag file the location of the external documentation should be added. The 3403 +# format of a tag file without this location is as follows: 3404 +# 3405 +# TAGFILES = file1 file2 ... 3406 +# Adding location for the tag files is done as follows: 3407 +# 3408 +# TAGFILES = file1=loc1 "file2 = loc2" ... 3409 +# where "loc1" and "loc2" can be relative or absolute paths 3410 +# or URLs. Note that each tag file must have a unique name (where the name does 3411 +# NOT include the path). If a tag file is not located in the directory in which 3412 +# doxygen is run, you must also specify the path to the tagfile here. 3413 + 3414 +TAGFILES = 3415 + 3416 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create 3417 +# a tag file that is based on the input files it reads. 3418 + 3419 +GENERATE_TAGFILE = 3420 + 3421 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed 3422 +# in the class index. If set to NO only the inherited external classes 3423 +# will be listed. 3424 + 3425 +ALLEXTERNALS = NO 3426 + 3427 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 3428 +# in the modules index. If set to NO, only the current project's groups will 3429 +# be listed. 3430 + 3431 +EXTERNAL_GROUPS = YES 3432 + 3433 +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed 3434 +# in the related pages index. If set to NO, only the current project's 3435 +# pages will be listed. 3436 + 3437 +EXTERNAL_PAGES = YES 3438 + 3439 +# The PERL_PATH should be the absolute path and name of the perl script 3440 +# interpreter (i.e. the result of which perl'). 3441 + 3442 +PERL_PATH = /usr/bin/perl 3443 + 3444 +#--------------------------------------------------------------------------- 3445 +# Configuration options related to the dot tool 3446 +#--------------------------------------------------------------------------- 3447 + 3448 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 3449 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 3450 +# or super classes. Setting the tag to NO turns the diagrams off. Note that 3451 +# this option also works with HAVE_DOT disabled, but it is recommended to 3452 +# install and use dot, since it yields more powerful graphs. 3453 + 3454 +CLASS_DIAGRAMS = YES 3455 + 3456 +# You can define message sequence charts within doxygen comments using the \msc 3457 +# command. Doxygen will then run the mscgen tool (see 3458 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 3459 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where 3460 +# the mscgen tool resides. If left empty the tool is assumed to be found in the 3461 +# default search path. 3462 + 3463 +MSCGEN_PATH = 3464 + 3465 +# If set to YES, the inheritance and collaboration graphs will hide 3466 +# inheritance and usage relations if the target is undocumented 3467 +# or is not a class. 3468 + 3469 +HIDE_UNDOC_RELATIONS = YES 3470 + 3471 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 3472 +# available from the path. This tool is part of Graphviz, a graph visualization 3473 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section 3474 +# have no effect if this option is set to NO (the default) 3475 + 3476 +HAVE_DOT = @DOXYGEN_DOT_FOUND@ 3477 + 3478 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 3479 +# allowed to run in parallel. When set to 0 (the default) doxygen will 3480 +# base this on the number of processors available in the system. You can set it 3481 +# explicitly to a value larger than 0 to get control over the balance 3482 +# between CPU load and processing speed. 3483 + 3484 +DOT_NUM_THREADS = 0 3485 + 3486 +# By default doxygen will use the Helvetica font for all dot files that 3487 +# doxygen generates. When you want a differently looking font you can specify 3488 +# the font name using DOT_FONTNAME. You need to make sure dot is able to find 3489 +# the font, which can be done by putting it in a standard location or by setting 3490 +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 3491 +# directory containing the font. 3492 + 3493 +DOT_FONTNAME = Arial 3494 + 3495 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 3496 +# The default size is 10pt. 3497 + 3498 +DOT_FONTSIZE = 10 3499 + 3500 +# By default doxygen will tell dot to use the Helvetica font. 3501 +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 3502 +# set the path where dot can find it. 3503 + 3504 +DOT_FONTPATH = 3505 + 3506 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 3507 +# will generate a graph for each documented class showing the direct and 3508 +# indirect inheritance relations. Setting this tag to YES will force the 3509 +# CLASS_DIAGRAMS tag to NO. 3510 + 3511 +CLASS_GRAPH = YES 3512 + 3513 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 3514 +# will generate a graph for each documented class showing the direct and 3515 +# indirect implementation dependencies (inheritance, containment, and 3516 +# class references variables) of the class with other documented classes. 3517 + 3518 +COLLABORATION_GRAPH = NO 3519 + 3520 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 3521 +# will generate a graph for groups, showing the direct groups dependencies 3522 + 3523 +GROUP_GRAPHS = YES 3524 + 3525 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 3526 +# collaboration diagrams in a style similar to the OMG's Unified Modeling 3527 +# Language. 3528 + 3529 +UML_LOOK = NO 3530 + 3531 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside 3532 +# the class node. If there are many fields or methods and many nodes the 3533 +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 3534 +# threshold limits the number of items for each type to make the size more 3535 +# manageable. Set this to 0 for no limit. Note that the threshold may be 3536 +# exceeded by 50% before the limit is enforced. 3537 + 3538 +UML_LIMIT_NUM_FIELDS = 10 3539 + 3540 +# If set to YES, the inheritance and collaboration graphs will show the 3541 +# relations between templates and their instances. 3542 + 3543 +TEMPLATE_RELATIONS = NO 3544 + 3545 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 3546 +# tags are set to YES then doxygen will generate a graph for each documented 3547 +# file showing the direct and indirect include dependencies of the file with 3548 +# other documented files. 3549 + 3550 +INCLUDE_GRAPH = YES 3551 + 3552 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 3553 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 3554 +# documented header file showing the documented files that directly or 3555 +# indirectly include this file. 3556 + 3557 +INCLUDED_BY_GRAPH = YES 3558 + 3559 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then 3560 +# doxygen will generate a call dependency graph for every global function 3561 +# or class method. Note that enabling this option will significantly increase 3562 +# the time of a run. So in most cases it will be better to enable call graphs 3563 +# for selected functions only using the \callgraph command. 3564 + 3565 +CALL_GRAPH = NO 3566 + 3567 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 3568 +# doxygen will generate a caller dependency graph for every global function 3569 +# or class method. Note that enabling this option will significantly increase 3570 +# the time of a run. So in most cases it will be better to enable caller 3571 +# graphs for selected functions only using the \callergraph command. 3572 + 3573 +CALLER_GRAPH = NO 3574 + 3575 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 3576 +# will generate a graphical hierarchy of all classes instead of a textual one. 3577 + 3578 +GRAPHICAL_HIERARCHY = YES 3579 + 3580 +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 3581 +# then doxygen will show the dependencies a directory has on other directories 3582 +# in a graphical way. The dependency relations are determined by the #include 3583 +# relations between the files in the directories. 3584 + 3585 +DIRECTORY_GRAPH = YES 3586 + 3587 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 3588 +# generated by dot. Possible values are svg, png, jpg, or gif. 3589 +# If left blank png will be used. If you choose svg you need to set 3590 +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 3591 +# visible in IE 9+ (other browsers do not have this requirement). 3592 + 3593 +DOT_IMAGE_FORMAT = svg 3594 + 3595 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 3596 +# enable generation of interactive SVG images that allow zooming and panning. 3597 +# Note that this requires a modern browser other than Internet Explorer. 3598 +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 3599 +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 3600 +# visible. Older versions of IE do not have SVG support. 3601 + 3602 +INTERACTIVE_SVG = NO 3603 + 3604 +# The tag DOT_PATH can be used to specify the path where the dot tool can be 3605 +# found. If left blank, it is assumed the dot tool can be found in the path. 3606 + 3607 +DOT_PATH = 3608 + 3609 +# The DOTFILE_DIRS tag can be used to specify one or more directories that 3610 +# contain dot files that are included in the documentation (see the 3611 +# \dotfile command). 3612 + 3613 +DOTFILE_DIRS = 3614 + 3615 +# The MSCFILE_DIRS tag can be used to specify one or more directories that 3616 +# contain msc files that are included in the documentation (see the 3617 +# \mscfile command). 3618 + 3619 +MSCFILE_DIRS = 3620 + 3621 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 3622 +# nodes that will be shown in the graph. If the number of nodes in a graph 3623 +# becomes larger than this value, doxygen will truncate the graph, which is 3624 +# visualized by representing a node as a red box. Note that doxygen if the 3625 +# number of direct children of the root node in a graph is already larger than 3626 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 3627 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 3628 + 3629 +DOT_GRAPH_MAX_NODES = 50 3630 + 3631 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 3632 +# graphs generated by dot. A depth value of 3 means that only nodes reachable 3633 +# from the root by following a path via at most 3 edges will be shown. Nodes 3634 +# that lay further from the root node will be omitted. Note that setting this 3635 +# option to 1 or 2 may greatly reduce the computation time needed for large 3636 +# code bases. Also note that the size of a graph can be further restricted by 3637 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 3638 + 3639 +MAX_DOT_GRAPH_DEPTH = 0 3640 + 3641 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 3642 +# background. This is disabled by default, because dot on Windows does not 3643 +# seem to support this out of the box. Warning: Depending on the platform used, 3644 +# enabling this option may lead to badly anti-aliased labels on the edges of 3645 +# a graph (i.e. they become hard to read). 3646 + 3647 +DOT_TRANSPARENT = NO 3648 + 3649 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 3650 +# files in one run (i.e. multiple -o and -T options on the command line). This 3651 +# makes dot run faster, but since only newer versions of dot (>1.8.10) 3652 +# support this, this feature is disabled by default. 3653 + 3654 +DOT_MULTI_TARGETS = NO 3655 + 3656 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 3657 +# generate a legend page explaining the meaning of the various boxes and 3658 +# arrows in the dot generated graphs. 3659 + 3660 +GENERATE_LEGEND = YES 3661 + 3662 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 3663 +# remove the intermediate dot files that are used to generate 3664 +# the various graphs. 3665 + 3666 +DOT_CLEANUP = YES 3667 3668 === added file 'doc/extra.css' 3669 --- doc/extra.css 1970-01-01 00:00:00 +0000 3670 +++ doc/extra.css 2017-03-01 12:28:42 +0000 3671 @@ -0,0 +1,40 @@ 3672 +body, table, div, p, dl { 3673 + font: 400 14px/19px Ubuntu,Arial,sans-serif; 3674 +} 3675 + 3676 +#projectname 3677 +{ 3678 + font: 300% Ubuntu,Arial,sans-serif; 3679 + margin: 0px; 3680 + padding: 2px 0px; 3681 +} 3682 + 3683 +#projectbrief 3684 +{ 3685 + font: 120% Ubuntu,Arial,sans-serif; 3686 + margin: 0px; 3687 + padding: 0px; 3688 +} 3689 + 3690 +#projectnumber 3691 +{ 3692 + font: 50% Ubuntu,Arial,sans-serif; 3693 + margin: 0px; 3694 + padding: 0px; 3695 +} 3696 + 3697 +div.toc li { 3698 + background: url("bdwn.png") no-repeat scroll 0 5px transparent; 3699 + font: 10px/1.2 Ubuntu,Arial,sans-serif; 3700 + margin-top: 5px; 3701 + padding-left: 10px; 3702 + padding-top: 2px; 3703 +} 3704 + 3705 +div.toc h3 { 3706 + font: bold 12px/1.2 Ubuntu,Arial,FreeSans,sans-serif; 3707 + color: #E24106; 3708 + border-bottom: 0 none; 3709 + margin: 0; 3710 +} 3711 + 3712 3713 === added file 'doc/footer.html.in' 3714 --- doc/footer.html.in 1970-01-01 00:00:00 +0000 3715 +++ doc/footer.html.in 2017-03-01 12:28:42 +0000 3716 @@ -0,0 +1,5 @@ 3717 + 3718 + Copyright © 2016 Canonical Ltd. 3719 +Generated on @DATE_TODAY@ 3720 + 3721 + 3722 3723 === added file 'doc/introducing_the_miral_api.md' 3724 --- doc/introducing_the_miral_api.md 1970-01-01 00:00:00 +0000 3725 +++ doc/introducing_the_miral_api.md 2017-03-01 12:28:42 +0000 3726 @@ -0,0 +1,25 @@ 3727 +Introducing the Miral API {#introducing_the_miral_api} 3728 +========================= 3729 + 3730 +The main() program 3731 +------------------ 3732 + 3733 +The main() program from miral-shell looks like this: 3734 + 3735 +\include shell_main.cpp 3736 + 3737 +This shell is providing TitlebarWindowManagerPolicy, TilingWindowManagerPolicy 3738 +and SpinnerSplash. The rest is from MirAL. 3739 + 3740 +If you look for the corresponding code in lp:qtmir and lp:mir you’ll find it 3741 +less clear, more verbose and scattered over multiple files. 3742 + 3743 +A shell has to provide a window management policy (miral-shell provides two: 3744 +TitlebarWindowManagerPolicy and TilingWindowManagerPolicy). A window management 3745 +policy needs to implement the \ref miral::WindowManagementPolicy interface for 3746 +handling a set of window management events. 3747 + 3748 +The way these events are handled determines the behaviour of the shell. 3749 + 3750 +The \ref miral::WindowManagerTools interface provides the principle methods for 3751 +a window management policy to control Mir. 3752 3753 === added file 'doc/mainpage.md' 3754 --- doc/mainpage.md 1970-01-01 00:00:00 +0000 3755 +++ doc/mainpage.md 2017-03-01 12:28:42 +0000 3756 @@ -0,0 +1,54 @@ 3757 +Welcome to MirAL {#mainpage} 3758 +================ 3759 + 3760 +MirAL is an ABI stable abstraction layer over Mir (and some working examples). 3761 + 3762 +Why MirAL? 3763 +---------- 3764 + 3765 +Mir is a library for writing Linux display servers and shells that are 3766 +independent of the underlying graphics stack. It fits into a similar role as an 3767 +X server or Weston (a Wayland server) but was initially motivated by Canonical’s 3768 +vision of "convergent" computing. 3769 + 3770 +The Mir project has had some success in meeting Canonical’s immediate needs – 3771 +it is running in the Ubuntu Touch phones and tablets, and as an experimental 3772 +option for running the Unity8 shell on the desktop. But because of the 3773 +concentration of effort on delivering the features needed for this internal use 3774 +it hasn’t really addressed the needs of potential users outside of Canonical. 3775 + 3776 +Mir provides two APIs for users: the "client" API is for applications that run 3777 +on Mir and that is largely used by toolkits. There is support for Mir in the GTK 3778 +and Qt toolkits, and in SDL. This works pretty well and the Mir client API has 3779 +remained backwards compatible for a couple of years and can do so for the 3780 +foreseeable future. 3781 + 3782 +The problem is that the server-side ABI compatibility is broken by almost every 3783 +release of Mir. This isn’t a big problem for Canonical, as the API is fairly 3784 +stable and both Mir and Unity8 are in rapid development: rebuilding Unity8 3785 +every time Mir is released is a small overhead. But for independent developers 3786 +the lack of a stable ABI is problematic as they cannot easily synchronize their 3787 +releases to updates of Mir. 3788 + 3789 +MirAL is the answer to this: It offers an "abstraction layer" written over the 3790 +top of the current Mir server API that will provide a stable ABI. There are a 3791 +number of other goals that can be addressed at the same time: 3792 + 3793 + - The API can be considerably narrowed as a lot of things can be customized 3794 + that are of no interest to shell development; 3795 + - A more declarative design style can be followed than the implementation 3796 + focused approach that the Mir server API follows; and, 3797 + - Common facilities can be provided that don’t belong in the Mir libraries. 3798 + 3799 +Mir is supported on a range of platforms including phones, tablets and desktops. 3800 +There is also work to provide it as a "snap" in the "internet of things". The 3801 +miral-shell already works in all these environments (for a suitably forgiving 3802 +value of "works") and is an early opportunity to learn about this alternative 3803 +to X11. 3804 + 3805 +Notes for Developers 3806 +-------------------- 3807 + 3808 + - \ref getting_and_using_miral 3809 + - \ref introducing_the_miral_api 3810 + - \ref tasks_for_the_interested_reader 3811 \ No newline at end of file 3812 3813 === added file 'getting_and_using_miral.md' 3814 --- getting_and_using_miral.md 1970-01-01 00:00:00 +0000 3815 +++ getting_and_using_miral.md 2017-03-01 12:28:42 +0000 3816 @@ -0,0 +1,179 @@ 3817 +Getting and Using MirAL {#getting_and_using_miral} 3818 +======================= 3819 + 3820 +Getting MirAL 3821 +------------- 3822 + 3823 +Depending upon your needs you can: 3824 + 3825 +1. Install and use the MirAL examples [Using MirAL examples]; 3826 +2. Use MirAL to develop your own Mir server [Using MirAL for development]; or, 3827 +3. Build MirAL yourself [Building MirAL]. 3828 + 3829 +Using MirAL examples 3830 +-------------------- 3831 + 3832 +You can install the MirAL examples as follows: 3833 + 3834 +$ sudo apt install libmiral-examples 3835 + $sudo apt install mir-graphics-drivers-desktop qtubuntu-desktop 3836 + 3837 +For convenient testing there's a "miral-app" script that wraps the commands used 3838 +in the last section to start the server and then launches the gnome-terminal (as 3839 +the current user): 3840 + 3841 +$ miral-app 3842 + 3843 +To run independently of X11 you need to grant access to the graphics hardware 3844 +(by running as root) and specify a VT to run in. There's a "miral-desktop" 3845 +script that wraps to start the server (as root) and then launch gnome-terminal 3846 +(as the current user): 3847 + 3848 + $miral-desktop 3849 + 3850 +For more options see [Options when running the MirAL example shell] below. 3851 + 3852 +### Running applications on MirAL 3853 + 3854 +If you use the command-line launched by miral-app or miral-desktop native Mir 3855 +applications (which include native Mir clients and those that use SDL or the 3856 +GTK+, Qt toolkits) can be started as usual: 3857 + 3858 +$ sudo apt install mir-demos kate neverball 3859 + $mir_demo_client_egltriangle 3860 +$ gedit 3861 + $kate 3862 +$ neverball 3863 + 3864 +From outside the MirAL session GTK+, Qt and SDL applications can still be run 3865 +using the miral-run script: 3866 + 3867 + $miral-run gedit 3868 +$ miral-run 7kaa 3869 + 3870 +### Running for X11 applications 3871 + 3872 +If you want to run X11 applications that do not have native Mir support in the 3873 +toolkit they use then the answer is Xmir: an X11 server that runs on Mir. First 3874 +you need Xmir installed: 3875 + 3876 + $sudo apt install xmir 3877 + 3878 +Then once you have started a miral shell (as above) you can use miral-xrun to 3879 +run applications under Xmir: 3880 + 3881 +$ miral-xrun firefox 3882 + 3883 +This automatically starts a Xmir X11 server on a new $DISPLAY for the 3884 +application to use. You can use miral-xrun both from a command-line outside the 3885 +miral-shell or, for example, from the terminal running in the shell. 3886 + 3887 +### Options when running the MirAL example shell 3888 + 3889 +#### Script Options 3890 + 3891 +Both the "miral-app" and "miral-desktop" scripts provide options for using an 3892 +alternative example shell (miral-kiosk) and an alternative to gnome-terminal. 3893 + 3894 + -kiosk use miral-kiosk instead of miral-shell 3895 + -launcher use instead of 3896 + 'gnome-terminal --app-id com.canonical.miral.Terminal' 3897 + 3898 +In addition miral-desktop has the option to set the VT that is used: 3899 + 3900 + -vt set the virtual terminal [4] 3901 + 3902 +There are some additional options (listed with "-h") but those are the important 3903 +ones. 3904 + 3905 +#### MirAL Options 3906 + 3907 +The scripts can also be used to pass options to MirAL: they pass everything on 3908 +the command-line following the first thing they don't understand. These can be 3909 +listed by miral-shell --help. Most of these options are inherited from Mir, 3910 +but the following MirAL specific are likely to be of interest: 3911 + 3912 + --window-management-trace log trace message 3913 + 3914 +Probably the main use for MirAL is to test window-management (either of a 3915 +toolkit or of a server) and this logs all calls to and from the window 3916 +management policy. This option is supported directly in the MirAL library and 3917 +works for any MirAL based shell - even one you write yourself. 3918 + 3919 + --keymap arg (=us) keymap [+[+]] 3920 + , e,g, "gb" or "cz+qwerty" or 3921 + "de++compose:caps" 3922 + 3923 +For those of us not in the USA this is very useful. Both the -shell and -kiosk 3924 +examples support this option. 3925 + 3926 + --window-manager arg (=titlebar) window management strategy 3927 + [{titlebar|tiling|system-compositor}] 3928 + 3929 +Is only supported by miral-shell and its main use is to allow an alternative 3930 +"tiling" window manager to be selected. 3931 + 3932 +Using MirAL for development 3933 +--------------------------- 3934 + 3935 +Install the headers and libraries for using libmiral in development: 3936 + 3937 +$ sudo apt install libmiral-dev 3938 + 3939 +A miral.pc file is provided for use with pkg-config or other tools. For 3940 +example: pkg-config --cflags miral` 3941 + 3942 +The MirAL documentation can be installed and read like this: 3943 + 3944 + $sudo apt install miral-doc 3945 +$ xdg-open /usr/share/doc/miral-doc/html/index.html 3946 + 3947 +Building MirAL 3948 +-------------- 3949 + 3950 +These instructions assume that you’re using Ubuntu 16.04LTS or later, I’ve not 3951 +earlier Ubuntu versions or other distributions. 3952 + 3953 +You’ll need a few development and utility packages installed, along with the 3954 +Mir graphics drivers: 3955 + 3956 + $sudo apt install devscripts equivs bzr 3957 +$ sudo apt install mir-graphics-drivers-desktop 3958 + 3959 +(If you’re working on a phone or tablet use mir-graphics-drivers-android in 3960 +place of mir-graphics-drivers-desktop.) 3961 + 3962 +With these installed you can checkout and build miral: 3963 + 3964 + $bzr branch lp:miral 3965 +$ sudo mk-build-deps -i 3966 + $mkdir miral/build 3967 +$ cd miral/build 3968 + $cmake .. 3969 +$ make 3970 + 3971 +This creates libmiral.so in the lib directory and an example shell 3972 +(miral-shell) in the bin directory. This can be run directly: 3973 + 3974 + $bin/miral-shell 3975 + 3976 +With the default options this runs in a window on X (which is convenient for 3977 +development). 3978 + 3979 +The miral-shell example is simple, don’t expect to see a sophisticated launcher 3980 +by default. You can start mir apps from the command-line. For example: 3981 + 3982 +$ bin/miral-run gnome-terminal 3983 + 3984 +That’s right, a lot of standard GTK+ applications will “just work” (the GDK 3985 +toolkit has a Mir backend). Any that assume the existence of an X11 and bypass 3986 +the toolkit my making X11 protocol calls will have problems though. 3987 + 3988 +To exit from miral-shell press Ctrl-Alt-BkSp. 3989 + 3990 +You can install the MirAL examples, headers and libraries you've built with: 3991 + 3992 + \$ sudo make install 3993 + 3994 +Otherwise, you just need to add "bin/" to the beginning of the commands shown 3995 +in the previous section. 3996 3997 === added directory 'include' 3998 === renamed directory 'include' => 'include.moved' 3999 === added directory 'include/mir' 4000 === added directory 'include/mir/client' 4001 === added file 'include/mir/client/connection.h' 4002 --- include/mir/client/connection.h 1970-01-01 00:00:00 +0000 4003 +++ include/mir/client/connection.h 2017-03-01 12:28:42 +0000 4004 @@ -0,0 +1,54 @@ 4005 +/* 4006 + * Copyright © 2016 Canonical Ltd. 4007 + * 4008 + * This program is free software: you can redistribute it and/or modify it 4009 + * under the terms of the GNU General Public License version 3, 4010 + * as published by the Free Software Foundation. 4011 + * 4012 + * This program is distributed in the hope that it will be useful, 4013 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4014 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4015 + * GNU General Public License for more details. 4016 + * 4017 + * You should have received a copy of the GNU General Public License 4018 + * along with this program. If not, see . 4019 + * 4020 + * Authored by: Alan Griffiths 4021 + */ 4022 + 4023 +#ifndef MIR_CLIENT_CONNECTION_H 4024 +#define MIR_CLIENT_CONNECTION_H 4025 + 4026 +#include 4027 + 4028 +#include 4029 + 4030 +namespace mir 4031 +{ 4032 +/// Convenient C++ wrappers around the Mir toolkit API. 4033 +/// 4034 +/// These wrappers are intentionally inline adapters: the compiled code depend directly on the Mir toolkit API. 4035 +namespace client 4036 +{ 4037 +/// Handle class for MirConnection - provides automatic reference counting. 4038 +class Connection 4039 +{ 4040 +public: 4041 + Connection() = default; 4042 + explicit Connection(MirConnection* connection) : self{connection, deleter} {} 4043 + 4044 + operator MirConnection*() const { return self.get(); } 4045 + 4046 + void reset() { self.reset(); } 4047 + 4048 +private: 4049 + static void deleter(MirConnection* connection) { mir_connection_release(connection); } 4050 + std::shared_ptr self; 4051 +}; 4052 + 4053 +// Provide a deleted overload to avoid double release "accidents". 4054 +void mir_connection_release(Connection const& connection) = delete; 4055 +} 4056 +} 4057 + 4058 +#endif //MIR_CLIENT_CONNECTION_H 4059 4060 === added directory 'include/mir/client/detail' 4061 === added file 'include/mir/client/detail/mir_forward_compatibility.h' 4062 --- include/mir/client/detail/mir_forward_compatibility.h 1970-01-01 00:00:00 +0000 4063 +++ include/mir/client/detail/mir_forward_compatibility.h 2017-03-01 12:28:42 +0000 4064 @@ -0,0 +1,172 @@ 4065 +/* 4066 + * Copyright © 2016 Canonical Ltd. 4067 + * 4068 + * This program is free software: you can redistribute it and/or modify it 4069 + * under the terms of the GNU General Public License version 3, 4070 + * as published by the Free Software Foundation. 4071 + * 4072 + * This program is distributed in the hope that it will be useful, 4073 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4074 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4075 + * GNU General Public License for more details. 4076 + * 4077 + * You should have received a copy of the GNU General Public License 4078 + * along with this program. If not, see . 4079 + * 4080 + * Authored by: Alan Griffiths 4081 + */ 4082 + 4083 +#ifndef MIRAL_MIR_FORWARD_COMPATIBILITY_H 4084 +#define MIRAL_MIR_FORWARD_COMPATIBILITY_H 4085 + 4086 +#include 4087 +#include 4088 +#include 4089 + 4090 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4091 +using MirWindowAttrib = MirSurfaceAttrib; 4092 +auto const mir_window_attrib_type = mir_surface_attrib_type; 4093 +auto const mir_window_attrib_state = mir_surface_attrib_state; 4094 +auto const mir_window_attrib_swapinterval = mir_surface_attrib_swapinterval; 4095 +auto const mir_window_attrib_focus = mir_surface_attrib_focus; 4096 +auto const mir_window_attrib_dpi = mir_surface_attrib_dpi; 4097 +auto const mir_window_attrib_visibility = mir_surface_attrib_visibility; 4098 +auto const mir_window_attrib_preferred_orientation = mir_surface_attrib_preferred_orientation; 4099 +auto const mir_window_attribs = mir_surface_attribs; 4100 + 4101 +using MirWindowType = MirSurfaceType; 4102 +auto const mir_window_type_normal = mir_surface_type_normal; 4103 +auto const mir_window_type_utility = mir_surface_type_utility; 4104 +auto const mir_window_type_dialog = mir_surface_type_dialog; 4105 +auto const mir_window_type_gloss = mir_surface_type_gloss; 4106 +auto const mir_window_type_freestyle = mir_surface_type_freestyle; 4107 +auto const mir_window_type_menu = mir_surface_type_menu; 4108 +auto const mir_window_type_inputmethod = mir_surface_type_inputmethod; 4109 +auto const mir_window_type_satellite = mir_surface_type_satellite; 4110 +auto const mir_window_type_tip = mir_surface_type_tip; 4111 +auto const mir_window_types = mir_surface_types; 4112 + 4113 +using MirWindowState = MirSurfaceState; 4114 +auto const mir_window_state_unknown = mir_surface_state_unknown; 4115 +auto const mir_window_state_restored = mir_surface_state_restored; 4116 +auto const mir_window_state_minimized = mir_surface_state_minimized; 4117 +auto const mir_window_state_maximized = mir_surface_state_maximized; 4118 +auto const mir_window_state_vertmaximized = mir_surface_state_vertmaximized; 4119 +auto const mir_window_state_fullscreen = mir_surface_state_fullscreen; 4120 +auto const mir_window_state_horizmaximized = mir_surface_state_horizmaximized; 4121 +auto const mir_window_state_hidden = mir_surface_state_hidden; 4122 +auto const mir_window_states = mir_surface_states; 4123 + 4124 +typedef struct MirSurface MirWindow; 4125 +typedef struct MirSurfaceParameters MirWindowParameters; 4126 +typedef struct MirSurfacePlacementEvent MirWindowPlacementEvent; 4127 +typedef struct MirSurfaceSpec MirWindowSpec; 4128 +#endif 4129 + 4130 + 4131 +// Types that don't exist in earlier versions of Mir's client 4132 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 4, 0) 4133 + 4134 +// Inspired by GdkGravity 4135 +/** 4136 + * Reference point for aligning a surface relative to a rectangle. 4137 + * Each element (surface and rectangle) has a MirPlacementGravity assigned. 4138 + */ 4139 +typedef enum MirPlacementGravity 4140 +{ 4141 + /// the reference point is at the center. 4142 + mir_placement_gravity_center = 0, 4143 + 4144 + /// the reference point is at the middle of the left edge. 4145 + mir_placement_gravity_west = 1 << 0, 4146 + 4147 + /// the reference point is at the middle of the right edge. 4148 + mir_placement_gravity_east = 1 << 1, 4149 + 4150 + /// the reference point is in the middle of the top edge. 4151 + mir_placement_gravity_north = 1 << 2, 4152 + 4153 + /// the reference point is at the middle of the lower edge. 4154 + mir_placement_gravity_south = 1 << 3, 4155 + 4156 + /// the reference point is at the top left corner. 4157 + mir_placement_gravity_northwest = mir_placement_gravity_north | mir_placement_gravity_west, 4158 + 4159 + /// the reference point is at the top right corner. 4160 + mir_placement_gravity_northeast = mir_placement_gravity_north | mir_placement_gravity_east, 4161 + 4162 + /// the reference point is at the lower left corner. 4163 + mir_placement_gravity_southwest = mir_placement_gravity_south | mir_placement_gravity_west, 4164 + 4165 + /// the reference point is at the lower right corner. 4166 + mir_placement_gravity_southeast = mir_placement_gravity_south | mir_placement_gravity_east 4167 +} MirPlacementGravity; 4168 + 4169 +// Inspired by GdkAnchorHints 4170 +/** 4171 + * Positioning hints for aligning a window relative to a rectangle. 4172 + * 4173 + * These hints determine how the window should be positioned in the case that 4174 + * the surface would fall off-screen if placed in its ideal position. 4175 + * 4176 + * For example, \p mir_placement_hints_flip_x will invert the x component of 4177 + * \p aux_rect_placement_offset and replace \p mir_placement_gravity_northwest 4178 + * with \p mir_placement_gravity_northeast and vice versa if the window extends 4179 + * beyond the left or right edges of the monitor. 4180 + * 4181 + * If \p mir_placement_hints_slide_x is set, the window can be shifted 4182 + * horizontally to fit on-screen. 4183 + * 4184 + * If \p mir_placement_hints_resize_x is set, the window can be shrunken 4185 + * horizontally to fit. 4186 + * 4187 + * If \p mir_placement_hints_antipodes is set then the rect gravity may be 4188 + * substituted with the opposite corner (e.g. \p mir_placement_gravity_northeast 4189 + * to \p mir_placement_gravity_southwest) in combination with other options. 4190 + * 4191 + * When multiple flags are set, flipping should take precedence over sliding, 4192 + * which should take precedence over resizing. 4193 + */ 4194 +typedef enum MirPlacementHints 4195 +{ 4196 + /// allow flipping anchors horizontally 4197 + mir_placement_hints_flip_x = 1 << 0, 4198 + 4199 + /// allow flipping anchors vertically 4200 + mir_placement_hints_flip_y = 1 << 1, 4201 + 4202 + /// allow sliding window horizontally 4203 + mir_placement_hints_slide_x = 1 << 2, 4204 + 4205 + /// allow sliding window vertically 4206 + mir_placement_hints_slide_y = 1 << 3, 4207 + 4208 + /// allow resizing window horizontally 4209 + mir_placement_hints_resize_x = 1 << 4, 4210 + 4211 + /// allow resizing window vertically 4212 + mir_placement_hints_resize_y = 1 << 5, 4213 + 4214 + /// allow flipping aux_anchor to opposite corner 4215 + mir_placement_hints_antipodes= 1 << 6, 4216 + 4217 + /// allow flipping anchors on both axes 4218 + mir_placement_hints_flip_any = mir_placement_hints_flip_x|mir_placement_hints_flip_y, 4219 + 4220 + /// allow sliding window on both axes 4221 + mir_placement_hints_slide_any = mir_placement_hints_slide_x|mir_placement_hints_slide_y, 4222 + 4223 + /// allow resizing window on both axes 4224 + mir_placement_hints_resize_any = mir_placement_hints_resize_x|mir_placement_hints_resize_y, 4225 +} MirPlacementHints; 4226 +#endif 4227 + 4228 +#if !MIRAL_MIR_DEFINES_POINTER_CONFINEMENT 4229 +typedef enum MirPointerConfinementState 4230 +{ 4231 + mir_pointer_unconfined, 4232 + mir_pointer_confined_to_surface, 4233 +} MirPointerConfinementState; 4234 +#endif 4235 + 4236 +#endif //MIRAL_MIR_FORWARD_COMPATIBILITY_H 4237 4238 === added file 'include/mir/client/display_config.h' 4239 --- include/mir/client/display_config.h 1970-01-01 00:00:00 +0000 4240 +++ include/mir/client/display_config.h 2017-03-01 12:28:42 +0000 4241 @@ -0,0 +1,83 @@ 4242 +/* 4243 + * Copyright © 2017 Canonical Ltd. 4244 + * 4245 + * This program is free software: you can redistribute it and/or modify it 4246 + * under the terms of the GNU General Public License version 3, 4247 + * as published by the Free Software Foundation. 4248 + * 4249 + * This program is distributed in the hope that it will be useful, 4250 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4251 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4252 + * GNU General Public License for more details. 4253 + * 4254 + * You should have received a copy of the GNU General Public License 4255 + * along with this program. If not, see . 4256 + * 4257 + * Authored by: Alan Griffiths 4258 + */ 4259 + 4260 +#ifndef MIR_CLIENT_DISPLAY_CONFIG_H 4261 +#define MIR_CLIENT_DISPLAY_CONFIG_H 4262 + 4263 +#include 4264 +#include 4265 +#include 4266 + 4267 +#include 4268 +#include 4269 + 4270 +namespace mir 4271 +{ 4272 +/// Convenient C++ wrappers around the Mir toolkit API. 4273 +/// 4274 +/// These wrappers are intentionally inline adapters: the compiled code depend directly on the Mir toolkit API. 4275 +namespace client 4276 +{ 4277 +class DisplayConfig 4278 +{ 4279 +public: 4280 + DisplayConfig() = default; 4281 + 4282 + explicit DisplayConfig(MirDisplayConfig* config) : self{config, deleter} {} 4283 + 4284 + explicit DisplayConfig(MirConnection* connection) : 4285 + self{mir_connection_create_display_configuration(connection), deleter} {} 4286 + 4287 + operator MirDisplayConfig*() { return self.get(); } 4288 + 4289 + operator MirDisplayConfig const*() const { return self.get(); } 4290 + 4291 + void reset() { self.reset(); } 4292 + 4293 + void for_each_output(std::function const& enumerator) const 4294 + { 4295 + auto const count = mir_display_config_get_num_outputs(*this); 4296 + 4297 + for (int i = 0; i != count; ++i) 4298 + enumerator(mir_display_config_get_output(*this, i)); 4299 + } 4300 + 4301 +#if MIR_DEFINES_DISPLAY_CONFIG_GET_MUTABLE_OUTPUT 4302 + // Is it worthwhile to emulate this functionality for Mir 0.21? 4303 + // Too many API gaps I think. 4304 + void for_each_output(std::function const& enumerator) 4305 + { 4306 + auto const count = mir_display_config_get_num_outputs(*this); 4307 + 4308 + for (int i = 0; i != count; ++i) 4309 + enumerator(mir_display_config_get_mutable_output(*this, i)); 4310 + } 4311 +#endif 4312 + 4313 +private: 4314 + static void deleter(MirDisplayConfig* config) { mir_display_config_release(config); } 4315 + 4316 + std::shared_ptr self; 4317 +}; 4318 + 4319 +// Provide a deleted overload to avoid double release "accidents". 4320 +void mir_display_config_release(DisplayConfig const& config) = delete; 4321 +} 4322 +} 4323 + 4324 +#endif //MIR_CLIENT_DISPLAY_CONFIG_H 4325 4326 === added file 'include/mir/client/window.h' 4327 --- include/mir/client/window.h 1970-01-01 00:00:00 +0000 4328 +++ include/mir/client/window.h 2017-03-01 12:28:42 +0000 4329 @@ -0,0 +1,65 @@ 4330 +/* 4331 + * Copyright © 2016-2017 Canonical Ltd. 4332 + * 4333 + * This program is free software: you can redistribute it and/or modify it 4334 + * under the terms of the GNU General Public License version 3, 4335 + * as published by the Free Software Foundation. 4336 + * 4337 + * This program is distributed in the hope that it will be useful, 4338 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4339 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4340 + * GNU General Public License for more details. 4341 + * 4342 + * You should have received a copy of the GNU General Public License 4343 + * along with this program. If not, see . 4344 + * 4345 + * Authored by: Alan Griffiths 4346 + */ 4347 + 4348 +#ifndef MIR_CLIENT_WINDOW_H 4349 +#define MIR_CLIENT_WINDOW_H 4350 + 4351 +#include 4352 + 4353 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4354 +#include 4355 +auto const mir_window_release_sync = mir_surface_release_sync; 4356 +auto const mir_window_release = mir_surface_release; 4357 +auto const mir_window_get_buffer_stream = mir_surface_get_buffer_stream; 4358 +auto const mir_window_is_valid = mir_surface_is_valid; 4359 +auto const mir_window_get_error_message = mir_surface_get_error_message; 4360 +auto const mir_window_set_state = mir_surface_set_state; 4361 +#else 4362 +#include 4363 +#endif 4364 + 4365 +#include 4366 + 4367 +namespace mir 4368 +{ 4369 +namespace client 4370 +{ 4371 +/// Handle class for MirWindow - provides automatic reference counting. 4372 +class Window 4373 +{ 4374 +public: 4375 + Window() = default; 4376 + explicit Window(MirWindow* spec) : self{spec, deleter} {} 4377 + 4378 + 4379 + operator MirWindow*() const { return self.get(); } 4380 + 4381 + void reset() { self.reset(); } 4382 + 4383 +private: 4384 + static void deleter(MirWindow* window) { mir_window_release_sync(window); } 4385 + std::shared_ptr self; 4386 +}; 4387 + 4388 +// Provide a deleted overload to avoid double release "accidents". 4389 +void mir_window_release_sync(Window const& window) = delete; 4390 +void mir_surface_release_sync(Window const& window) = delete; 4391 +} 4392 +} 4393 + 4394 +#endif //MIR_CLIENT_WINDOW_H 4395 4396 === added file 'include/mir/client/window_id.h' 4397 --- include/mir/client/window_id.h 1970-01-01 00:00:00 +0000 4398 +++ include/mir/client/window_id.h 2017-03-01 12:28:42 +0000 4399 @@ -0,0 +1,65 @@ 4400 +/* 4401 + * Copyright © 2016 Canonical Ltd. 4402 + * 4403 + * This program is free software: you can redistribute it and/or modify it 4404 + * under the terms of the GNU General Public License version 3, 4405 + * as published by the Free Software Foundation. 4406 + * 4407 + * This program is distributed in the hope that it will be useful, 4408 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4409 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4410 + * GNU General Public License for more details. 4411 + * 4412 + * You should have received a copy of the GNU General Public License 4413 + * along with this program. If not, see . 4414 + * 4415 + * Authored by: Alan Griffiths 4416 + */ 4417 + 4418 +#ifndef MIR_CLIENT_WINDOW_ID_H 4419 +#define MIR_CLIENT_WINDOW_ID_H 4420 + 4421 +#include 4422 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4423 +#include 4424 +auto const mir_window_request_window_id_sync = mir_surface_request_persistent_id_sync; 4425 +#else 4426 +#include 4427 +#endif 4428 + 4429 +#if MIR_CLIENT_API_VERSION < MIR_VERSION_NUMBER(0, 26, 1) 4430 +#if MIR_CLIENT_VERSION == MIR_VERSION_NUMBER(3, 5, 0) 4431 +#include 4432 +auto const mir_window_request_window_id_sync = mir_window_request_persistent_id_sync; 4433 +#endif 4434 +auto const mir_window_id_as_string = mir_persistent_id_as_string; 4435 +auto const mir_window_id_release = mir_persistent_id_release; 4436 +typedef struct MirPersistentId MirWindowId; 4437 +#else 4438 +#include 4439 +#endif 4440 + 4441 +#include 4442 + 4443 +namespace mir 4444 +{ 4445 +namespace client 4446 +{ 4447 +/// Handle class for MirWindowId - provides automatic reference counting 4448 +class WindowId 4449 +{ 4450 +public: 4451 + explicit WindowId(MirWindowId* id) : self{id, deleter} {} 4452 + 4453 + explicit WindowId(MirWindow* window) : WindowId{mir_window_request_window_id_sync(window)} {} 4454 + 4455 + auto c_str() const -> char const* { return mir_window_id_as_string(self.get()); } 4456 + 4457 +private: 4458 + static void deleter(MirWindowId* id) { mir_window_id_release(id); } 4459 + std::shared_ptr self; 4460 +}; 4461 +} 4462 +} 4463 + 4464 +#endif //MIR_CLIENT_WINDOW_ID_H 4465 4466 === added file 'include/mir/client/window_spec.h' 4467 --- include/mir/client/window_spec.h 1970-01-01 00:00:00 +0000 4468 +++ include/mir/client/window_spec.h 2017-03-01 12:28:42 +0000 4469 @@ -0,0 +1,329 @@ 4470 +/* 4471 + * Copyright © 2016-2017 Canonical Ltd. 4472 + * 4473 + * This program is free software: you can redistribute it and/or modify it 4474 + * under the terms of the GNU General Public License version 3, 4475 + * as published by the Free Software Foundation. 4476 + * 4477 + * This program is distributed in the hope that it will be useful, 4478 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4479 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4480 + * GNU General Public License for more details. 4481 + * 4482 + * You should have received a copy of the GNU General Public License 4483 + * along with this program. If not, see . 4484 + * 4485 + * Authored by: Alan Griffiths 4486 + */ 4487 + 4488 +#ifndef MIR_CLIENT_WINDOW_SPEC_H 4489 +#define MIR_CLIENT_WINDOW_SPEC_H 4490 + 4491 +#include 4492 +#include 4493 + 4494 +#include 4495 + 4496 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4497 +#include 4498 +#else 4499 +#include 4500 +#endif 4501 + 4502 +#include 4503 + 4504 +// Forward compatibility hacks for earlier Mir versions 4505 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4506 +using MirWindowCallback = mir_surface_callback; 4507 +using MirWindowEventCallback = mir_surface_event_callback; 4508 +auto const mir_create_window_spec = mir_connection_create_spec_for_changes; 4509 +auto const mir_window_spec_set_event_handler = mir_surface_spec_set_event_handler; 4510 +auto const mir_window_spec_set_name = mir_surface_spec_set_name; 4511 +auto const mir_window_spec_set_width = mir_surface_spec_set_width; 4512 +auto const mir_window_spec_set_height = mir_surface_spec_set_height; 4513 +auto const mir_window_spec_set_width_increment = mir_surface_spec_set_width_increment; 4514 +auto const mir_window_spec_set_height_increment = mir_surface_spec_set_height_increment; 4515 +auto const mir_window_spec_set_buffer_usage = mir_surface_spec_set_buffer_usage; 4516 +auto const mir_window_spec_set_pixel_format = mir_surface_spec_set_pixel_format; 4517 +auto const mir_window_spec_set_type = mir_surface_spec_set_type; 4518 +auto const mir_window_spec_set_shell_chrome = mir_surface_spec_set_shell_chrome; 4519 +auto const mir_window_spec_set_min_width = mir_surface_spec_set_min_width; 4520 +auto const mir_window_spec_set_min_height = mir_surface_spec_set_min_height; 4521 +auto const mir_window_spec_set_max_width = mir_surface_spec_set_max_width; 4522 +auto const mir_window_spec_set_max_height = mir_surface_spec_set_max_height; 4523 +auto const mir_window_spec_set_parent = mir_surface_spec_set_parent; 4524 +auto const mir_window_spec_set_state = mir_surface_spec_set_state; 4525 +auto const mir_window_spec_set_fullscreen_on_output = mir_surface_spec_set_fullscreen_on_output; 4526 +auto const mir_create_window = mir_surface_create; 4527 +auto const mir_create_window_sync = mir_surface_create_sync; 4528 +auto const mir_window_apply_spec = mir_surface_apply_spec; 4529 +auto const mir_window_spec_release = mir_surface_spec_release; 4530 + 4531 +#if MIR_CLIENT_VERSION >= MIR_VERSION_NUMBER(3, 4, 0) 4532 +auto const mir_window_spec_set_placement = mir_surface_spec_set_placement; 4533 +#endif 4534 +#endif 4535 + 4536 +namespace mir 4537 +{ 4538 +namespace client 4539 +{ 4540 +/// Handle class for MirWindowSpec - provides automatic reference counting, method chaining. 4541 +class WindowSpec 4542 +{ 4543 +public: 4544 + explicit WindowSpec(MirWindowSpec* spec) : self{spec, deleter} {} 4545 + 4546 + static auto for_normal_window(MirConnection* connection, int width, int height, MirPixelFormat format) -> WindowSpec 4547 + { 4548 +#if MIR_CLIENT_VERSION <= MIR_VERSION_NUMBER(3, 4, 0) 4549 + return WindowSpec{mir_connection_create_spec_for_normal_surface(connection, width, height, format)}; 4550 +#else 4551 + auto spec = WindowSpec{mir_create_normal_window_spec(connection, width, height)}; 4552 + mir_window_spec_set_pixel_format(spec, format); 4553 + return spec; 4554 +#endif 4555 + } 4556 + 4557 +#if MIR_CLIENT_VERSION > MIR_VERSION_NUMBER(3, 4, 0) 4558 + static auto for_normal_window(MirConnection* connection, int width, int height) -> WindowSpec 4559 + { 4560 + return WindowSpec{mir_create_normal_window_spec(connection, width, height)}; 4561 + } 4562 +#endif 4563 + 4564 + static auto for_menu(MirConnection* connection, 4565 + int width, 4566 + int height, 4567 + MirPixelFormat format, 4568 + MirWindow* parent, 4569 + MirRectangle* rect, 4570 + MirEdgeAttachment edge) -> WindowSpec 4571 + { 4572 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4573 + return WindowSpec{mir_connection_create_spec_for_menu(connection, width, height, format, parent, rect, edge)}; 4574 +#else 4575 + auto spec = WindowSpec{mir_create_menu_window_spec(connection, width, height, parent, rect, edge)}; 4576 + mir_window_spec_set_pixel_format(spec, format); 4577 + return spec; 4578 +#endif 4579 + } 4580 + 4581 +#if MIR_CLIENT_VERSION >= MIR_VERSION_NUMBER(3, 4, 0) 4582 + static auto for_tip(MirConnection* connection, 4583 + int width, 4584 + int height, 4585 + MirPixelFormat format, 4586 + MirWindow* parent, 4587 + MirRectangle* rect, 4588 + MirEdgeAttachment edge) -> WindowSpec 4589 + { 4590 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4591 + return WindowSpec{mir_connection_create_spec_for_tip(connection, width, height, format, parent, rect, edge)}; 4592 +#else 4593 + auto spec = WindowSpec{mir_create_tip_window_spec(connection, width, height, parent, rect, edge)}; 4594 + mir_window_spec_set_pixel_format(spec, format); 4595 + return spec; 4596 +#endif 4597 + } 4598 +#endif 4599 + 4600 + static auto for_dialog(MirConnection* connection, 4601 + int width, 4602 + int height, 4603 + MirPixelFormat format)-> WindowSpec 4604 + { 4605 +#if MIR_CLIENT_VERSION < MIR_VERSION_NUMBER(3, 5, 0) 4606 + return WindowSpec{mir_connection_create_spec_for_dialog(connection, width, height, format)}; 4607 +#else 4608 + auto spec = WindowSpec{mir_create_dialog_window_spec(connection, width, height)}; 4609 + mir_window_spec_set_pixel_format(spec, format); 4610 + return spec; 4611 +#endif 4612 + } 4613 + 4614 + static auto for_dialog(MirConnection* connection, 4615 + int width, 4616 + int height, 4617 + MirPixelFormat format, 4618 + MirWindow* parent) -> WindowSpec 4619 + { 4620 + return for_dialog(connection, width, height, format).set_parent(parent); 4621 + } 4622 + 4623 + static auto for_input_method(MirConnection* connection, int width, int height, MirWindow* parent) 4624 + { 4625 +#if MIR_CLIENT_VERSION >= MIR_VERSION_NUMBER(3, 5, 0) 4626 + auto spec = WindowSpec{mir_create_input_method_window_spec(connection, width, height)} 4627 +#else 4628 + auto spec = WindowSpec{mir_create_surface_spec(connection)} 4629 + .set_buffer_usage(mir_buffer_usage_hardware) // Required protobuf field for create_window() 4630 + .set_pixel_format(mir_pixel_format_invalid) // Required protobuf field for create_window() 4631 + .set_size(width, height) 4632 + .set_type(mir_window_type_inputmethod) 4633 +#endif 4634 + .set_parent(parent); 4635 + return spec; 4636 + } 4637 + 4638 + static auto for_satellite(MirConnection* connection, int width, int height, MirWindow* parent) 4639 + { 4640 + // There's no mir_create_satellite_window_spec() 4641 + return WindowSpec{mir_create_window_spec(connection)} 4642 + .set_buffer_usage(mir_buffer_usage_hardware) // Required protobuf field for create_window() 4643 + .set_pixel_format(mir_pixel_format_invalid) // Required protobuf field for create_window() 4644 + .set_size(width, height) 4645 + .set_type(mir_window_type_satellite) 4646 + .set_parent(parent); 4647 + } 4648 + 4649 + static auto for_gloss(MirConnection* connection, int width, int height) 4650 + { 4651 + // There's no mir_create_gloss_window_spec() 4652 + return WindowSpec{mir_create_window_spec(connection)} 4653 + .set_buffer_usage(mir_buffer_usage_hardware) // Required protobuf field for create_window() 4654 + .set_pixel_format(mir_pixel_format_invalid) // Required protobuf field for create_window() 4655 + .set_size(width, height) 4656 + .set_type(mir_window_type_gloss); 4657 + } 4658 + 4659 + static auto for_changes(MirConnection* connection) -> WindowSpec 4660 + { 4661 + return WindowSpec{mir_create_window_spec(connection)}; 4662 + } 4663 + 4664 + auto set_buffer_usage(MirBufferUsage usage) -> WindowSpec& 4665 + { 4666 + mir_window_spec_set_buffer_usage(*this, usage); 4667 + return *this; 4668 + } 4669 + 4670 + auto set_pixel_format(MirPixelFormat format) -> WindowSpec& 4671 + { 4672 + mir_window_spec_set_pixel_format(*this, format); 4673 + return *this; 4674 + } 4675 + 4676 + auto set_type(MirWindowType type) -> WindowSpec& 4677 + { 4678 + mir_window_spec_set_type(*this, type); 4679 + return *this; 4680 + } 4681 + 4682 + auto set_shell_chrome(MirShellChrome chrome) -> WindowSpec& 4683 + { 4684 + mir_window_spec_set_shell_chrome(*this, chrome); 4685 + return *this; 4686 + } 4687 + 4688 + auto set_min_size(int min_width, int min_height) -> WindowSpec& 4689 + { 4690 + mir_window_spec_set_min_width(*this, min_width); 4691 + mir_window_spec_set_min_height(*this, min_height); 4692 + return *this; 4693 + } 4694 + 4695 + auto set_max_size(int max_width, int max_height) -> WindowSpec& 4696 + { 4697 + mir_window_spec_set_max_width(*this, max_width); 4698 + mir_window_spec_set_max_height(*this, max_height); 4699 + return *this; 4700 + } 4701 + 4702 + auto set_size_inc(int width_inc, int height_inc) -> WindowSpec& 4703 + { 4704 + mir_window_spec_set_width_increment(*this, width_inc); 4705 + mir_window_spec_set_height_increment(*this, height_inc); 4706 + return *this; 4707 + } 4708 + 4709 + auto set_size(int width, int height) -> WindowSpec& 4710 + { 4711 + mir_window_spec_set_width(*this, width); 4712 + mir_window_spec_set_height(*this, height); 4713 + return *this; 4714 + } 4715 + 4716 + auto set_name(char const* name) -> WindowSpec& 4717 + { 4718 + mir_window_spec_set_name(*this, name); 4719 + return *this; 4720 + } 4721 + 4722 + auto set_event_handler(MirWindowEventCallback callback, void* context) -> WindowSpec& 4723 + { 4724 + mir_window_spec_set_event_handler(*this, callback, context); 4725 + return *this; 4726 + } 4727 + 4728 + auto set_fullscreen_on_output(uint32_t output_id) -> WindowSpec& 4729 + { 4730 + mir_window_spec_set_fullscreen_on_output(*this, output_id); 4731 + return *this; 4732 + } 4733 + 4734 +#if MIR_CLIENT_VERSION >= MIR_VERSION_NUMBER(3, 4, 0) 4735 + auto set_placement(const MirRectangle* rect, 4736 + MirPlacementGravity rect_gravity, 4737 + MirPlacementGravity surface_gravity, 4738 + MirPlacementHints placement_hints, 4739 + int offset_dx, 4740 + int offset_dy) -> WindowSpec& 4741 + { 4742 + mir_window_spec_set_placement(*this, rect, rect_gravity, surface_gravity, placement_hints, offset_dx, offset_dy); 4743 + return *this; 4744 + } 4745 +#else 4746 + auto set_placement(const MirRectangle* /*rect*/, 4747 + MirPlacementGravity /*rect_gravity*/, 4748 + MirPlacementGravity /*surface_gravity*/, 4749 + MirPlacementHints /*placement_hints*/, 4750 + int /*offset_dx*/, 4751 + int /*offset_dy*/) -> WindowSpec& 4752 + { 4753 + return *this; 4754 + } 4755 +#endif 4756 + 4757 + auto set_parent(MirWindow* parent) -> WindowSpec& 4758 + { 4759 + mir_window_spec_set_parent(*this, parent); 4760 + return *this; 4761 + } 4762 + 4763 + auto set_state(MirWindowState state) -> WindowSpec& 4764 + { 4765 + mir_window_spec_set_state(*this, state); 4766 + return *this; 4767 + } 4768 + 4769 + template 4770 + void create_window(void (* callback)(MirWindow*, Context*), Context* context) const 4771 + { 4772 + mir_create_window(*this, reinterpret_cast(callback), context); 4773 + } 4774 + 4775 + auto create_window() const -> Window 4776 + { 4777 + return Window{mir_create_window_sync(*this)}; 4778 + } 4779 + 4780 + void apply_to(MirWindow* window) const 4781 + { 4782 + mir_window_apply_spec(window, *this); 4783 + } 4784 + 4785 + operator MirWindowSpec*() const { return self.get(); } 4786 + 4787 +private: 4788 + static void deleter(MirWindowSpec* spec) { mir_window_spec_release(spec); } 4789 + std::shared_ptr self; 4790 +}; 4791 + 4792 +// Provide a deleted overload to avoid double release "accidents". 4793 +void mir_window_spec_release(WindowSpec const& spec) = delete; 4794 +void mir_surface_spec_release(WindowSpec const& spec) = delete; 4795 +} 4796 +} 4797 + 4798 +#endif //MIRAL_TOOLKIT_WINDOW_SPEC_H_H 4799 4800 === added directory 'include/miral' 4801 === added file 'include/miral/active_outputs.h' 4802 --- include/miral/active_outputs.h 1970-01-01 00:00:00 +0000 4803 +++ include/miral/active_outputs.h 2017-03-01 12:28:42 +0000 4804 @@ -0,0 +1,73 @@ 4805 +/* 4806 + * Copyright © 2016 Canonical Ltd. 4807 + * 4808 + * This program is free software: you can redistribute it and/or modify it 4809 + * under the terms of the GNU General Public License version 3, 4810 + * as published by the Free Software Foundation. 4811 + * 4812 + * This program is distributed in the hope that it will be useful, 4813 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4814 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4815 + * GNU General Public License for more details. 4816 + * 4817 + * You should have received a copy of the GNU General Public License 4818 + * along with this program. If not, see . 4819 + * 4820 + * Authored by: Alan Griffiths 4821 + */ 4822 + 4823 +#ifndef MIRAL_ACTIVE_OUTPUTS_H 4824 +#define MIRAL_ACTIVE_OUTPUTS_H 4825 + 4826 +#include 4827 +#include 4828 + 4829 +namespace mir { class Server; } 4830 + 4831 +namespace miral 4832 +{ 4833 +class Output; 4834 + 4835 +class ActiveOutputsListener 4836 +{ 4837 +public: 4838 + ActiveOutputsListener() = default; 4839 + 4840 + /// before any related calls begin 4841 + virtual void advise_output_begin(); 4842 + 4843 + /// after any related calls end 4844 + virtual void advise_output_end(); 4845 + 4846 + virtual void advise_output_create(Output const& output); 4847 + virtual void advise_output_update(Output const& updated, Output const& original); 4848 + virtual void advise_output_delete(Output const& output); 4849 + 4850 +protected: 4851 + virtual ~ActiveOutputsListener() = default; 4852 + ActiveOutputsListener(ActiveOutputsListener const&) = delete; 4853 + ActiveOutputsListener operator=(ActiveOutputsListener const&) = delete; 4854 +}; 4855 + 4856 +class ActiveOutputsMonitor 4857 +{ 4858 +public: 4859 + ActiveOutputsMonitor(); 4860 + ~ActiveOutputsMonitor(); 4861 + ActiveOutputsMonitor(ActiveOutputsMonitor const&); 4862 + ActiveOutputsMonitor& operator=(ActiveOutputsMonitor const&); 4863 + 4864 + void add_listener(ActiveOutputsListener* listener); 4865 + void delete_listener(ActiveOutputsListener* listener); 4866 + 4867 + void operator()(mir::Server& server); 4868 + 4869 + void process_outputs(std::function const& outputs)> const& functor) const; 4870 + 4871 +private: 4872 + struct Self; 4873 + std::shared_ptr self; 4874 +}; 4875 +} 4876 + 4877 +#endif //MIRAL_ACTIVE_OUTPUTS_H 4878 4879 === added file 'include/miral/add_init_callback.h' 4880 --- include/miral/add_init_callback.h 1970-01-01 00:00:00 +0000 4881 +++ include/miral/add_init_callback.h 2017-03-01 12:28:42 +0000 4882 @@ -0,0 +1,47 @@ 4883 +/* 4884 + * Copyright © 2016 Canonical Ltd. 4885 + * 4886 + * This program is free software: you can redistribute it and/or modify it 4887 + * under the terms of the GNU General Public License version 3, 4888 + * as published by the Free Software Foundation. 4889 + * 4890 + * This program is distributed in the hope that it will be useful, 4891 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4892 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4893 + * GNU General Public License for more details. 4894 + * 4895 + * You should have received a copy of the GNU General Public License 4896 + * along with this program. If not, see . 4897 + * 4898 + * Authored by: Alan Griffiths 4899 + */ 4900 + 4901 +#ifndef MIRAL_ADD_INIT_CALLBACK_H 4902 +#define MIRAL_ADD_INIT_CALLBACK_H 4903 + 4904 +#include 4905 + 4906 +namespace mir { class Server; } 4907 + 4908 +namespace miral 4909 +{ 4910 +/// Add a callback to be invoked when the server has been initialized, but 4911 +/// before it starts. 4912 +/// If multiple callbacks are added they will be invoked in the sequence added. 4913 +class AddInitCallback 4914 +{ 4915 +public: 4916 + using Callback = std::function; 4917 + 4918 + explicit AddInitCallback(Callback const& callback); 4919 + ~AddInitCallback(); 4920 + 4921 + void operator()(mir::Server& server) const; 4922 + 4923 +private: 4924 + Callback callback; 4925 +}; 4926 +} 4927 + 4928 + 4929 +#endif //MIRAL_ADD_INIT_CALLBACK_H 4930 4931 === added file 'include/miral/append_event_filter.h' 4932 --- include/miral/append_event_filter.h 1970-01-01 00:00:00 +0000 4933 +++ include/miral/append_event_filter.h 2017-03-01 12:28:42 +0000 4934 @@ -0,0 +1,44 @@ 4935 +/* 4936 + * Copyright © 2016 Canonical Ltd. 4937 + * 4938 + * This program is free software: you can redistribute it and/or modify it 4939 + * under the terms of the GNU General Public License version 3, 4940 + * as published by the Free Software Foundation. 4941 + * 4942 + * This program is distributed in the hope that it will be useful, 4943 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4944 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4945 + * GNU General Public License for more details. 4946 + * 4947 + * You should have received a copy of the GNU General Public License 4948 + * along with this program. If not, see . 4949 + * 4950 + * Authored by: Alan Griffiths 4951 + */ 4952 + 4953 +#ifndef MIRAL_APPEND_EVENT_FILTER_H 4954 +#define MIRAL_APPEND_EVENT_FILTER_H 4955 + 4956 +#include 4957 + 4958 +#include 4959 +#include 4960 + 4961 +namespace mir { class Server; } 4962 + 4963 +namespace miral 4964 +{ 4965 +class AppendEventFilter 4966 +{ 4967 +public: 4968 + AppendEventFilter(std::function const& filter); 4969 + 4970 + void operator()(mir::Server& server); 4971 + 4972 +private: 4973 + class Filter; 4974 + std::shared_ptr const filter; 4975 +}; 4976 +} 4977 + 4978 +#endif //MIRAL_APPEND_EVENT_FILTER_H 4979 4980 === added file 'include/miral/application.h' 4981 --- include/miral/application.h 1970-01-01 00:00:00 +0000 4982 +++ include/miral/application.h 2017-03-01 12:28:42 +0000 4983 @@ -0,0 +1,42 @@ 4984 +/* 4985 + * Copyright © 2016 Canonical Ltd. 4986 + * 4987 + * This program is free software: you can redistribute it and/or modify it 4988 + * under the terms of the GNU General Public License version 3, 4989 + * as published by the Free Software Foundation. 4990 + * 4991 + * This program is distributed in the hope that it will be useful, 4992 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 4993 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 4994 + * GNU General Public License for more details. 4995 + * 4996 + * You should have received a copy of the GNU General Public License 4997 + * along with this program. If not, see . 4998 + * 4999 + * Authored by: Alan Griffiths 5000 + */