Mir

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

Proposed by Alan Griffiths
Status: Work in progress
Proposed branch: lp:~alan-griffiths/mir/fix-1668651
Merge into: lp:mir
Diff against target: 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.
To merge this branch: bzr merge lp:~alan-griffiths/mir/fix-1668651
Reviewer Review Type Date Requested Status
Mir development team Pending
Review via email: mp+318593@code.launchpad.net

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).

To post a comment you must log in.

Unmerged revisions

526. By Alan Griffiths

Remove an unnecessary worker thread

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

[libmiral] Fix access to invalidated iterators, use of dead objects and racy test code.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added directory '.bzr-builddeb'
=== renamed directory '.bzr-builddeb' => '.bzr-builddeb.moved'
=== added file '.bzr-builddeb/default.conf'
--- .bzr-builddeb/default.conf 1970-01-01 00:00:00 +0000
+++ .bzr-builddeb/default.conf 2017-03-01 12:28:42 +0000
@@ -0,0 +1,2 @@
1[BUILDDEB]
2split = True
03
=== added file '.bzrignore'
--- .bzrignore 1970-01-01 00:00:00 +0000
+++ .bzrignore 2017-03-01 12:28:42 +0000
@@ -0,0 +1,3 @@
1include/mir/client/detail/mir_features.h
2include/miral/version.h
3.idea
04
=== renamed file '.bzrignore' => '.bzrignore.moved'
=== added file 'CMakeLists.txt'
--- CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ CMakeLists.txt 2017-03-01 12:28:42 +0000
@@ -0,0 +1,78 @@
1cmake_minimum_required(VERSION 3.1)
2project(miral)
3
4if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
5 set(CMAKE_INSTALL_PREFIX "/usr" CACHE PATH "/usr install prefix" FORCE)
6endif()
7
8include (GNUInstallDirs)
9include(CheckCXXCompilerFlag)
10
11cmake_policy(SET CMP0015 NEW)
12cmake_policy(SET CMP0022 NEW)
13
14set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
15
16set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
17set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
18
19set(CMAKE_CXX_STANDARD 14)
20set(CMAKE_CXX_STANDARD_REQUIRED on)
21set(CMAKE_CXX_EXTENSIONS off)
22
23set(CMAKE_C_STANDARD 99)
24set(CMAKE_C_STANDARD_REQUIRED on)
25set(CMAKE_C_EXTENSIONS off)
26
27set(MIRAL_COMPILER_FLAGS "-pthread -g -Werror -Wall -pedantic -Wextra -fPIC")
28set(MIRAL_LINKER_FLAGS "-Wl,-z,defs")
29
30set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${MIRAL_COMPILER_FLAGS}")
31set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${MIRAL_COMPILER_FLAGS} -Wnon-virtual-dtor")
32set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-long-long") # fix spurious FTBFS on X+O
33set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}")
34set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}")
35set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}")
36
37include(FindPkgConfig)
38
39pkg_check_modules(MIRCLIENT mirclient>=0.20 REQUIRED)
40
41include_directories(include SYSTEM ${MIRCLIENT_INCLUDE_DIRS})
42
43set(MIRAL_VERSION_MAJOR 1)
44set(MIRAL_VERSION_MINOR 3)
45set(MIRAL_VERSION_PATCH 0)
46
47set(MIRAL_VERSION ${MIRAL_VERSION_MAJOR}.${MIRAL_VERSION_MINOR}.${MIRAL_VERSION_PATCH})
48
49add_subdirectory(miral)
50add_subdirectory(miral-shell)
51add_subdirectory(miral-kiosk)
52
53pkg_check_modules(MIRTEST mirtest)
54if(NOT MIRTEST_FOUND)
55 message(WARNING "mirtest-dev package not installed - tests cannot be built")
56else()
57 if (MIRTEST_VERSION VERSION_LESS 0.24)
58 # building the tests is disabled by default because the mirtest-dev package is broken on xenial
59 # (lp:1583536 and lp:1603080)
60 option(MIRAL_ENABLE_TESTS "Build tests" off)
61 else()
62 option(MIRAL_ENABLE_TESTS "Build tests" on)
63 endif()
64
65if (MIRAL_ENABLE_TESTS)
66 enable_testing()
67 find_package(GMock REQUIRED)
68 add_subdirectory(test)
69endif()
70endif()
71
72include (cmake/Doxygen.cmake)
73
74if(TARGET doc)
75 add_custom_target(symbols
76 ${CMAKE_SOURCE_DIR}/scripts/process_doxygen_xml.py ${CMAKE_BINARY_DIR}/doc/xml/*.xml > ${CMAKE_SOURCE_DIR}/miral/symbols.map
77 DEPENDS doc)
78endif()
079
=== renamed file 'CMakeLists.txt' => 'CMakeLists.txt.moved'
=== added file 'COPYING'
--- COPYING 1970-01-01 00:00:00 +0000
+++ COPYING 2017-03-01 12:28:42 +0000
@@ -0,0 +1,674 @@
1 GNU GENERAL PUBLIC LICENSE
2 Version 3, 29 June 2007
3
4 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5 Everyone is permitted to copy and distribute verbatim copies
6 of this license document, but changing it is not allowed.
7
8 Preamble
9
10 The GNU General Public License is a free, copyleft license for
11software and other kinds of works.
12
13 The licenses for most software and other practical works are designed
14to take away your freedom to share and change the works. By contrast,
15the GNU General Public License is intended to guarantee your freedom to
16share and change all versions of a program--to make sure it remains free
17software for all its users. We, the Free Software Foundation, use the
18GNU General Public License for most of our software; it applies also to
19any other work released this way by its authors. You can apply it to
20your programs, too.
21
22 When we speak of free software, we are referring to freedom, not
23price. Our General Public Licenses are designed to make sure that you
24have the freedom to distribute copies of free software (and charge for
25them if you wish), that you receive source code or can get it if you
26want it, that you can change the software or use pieces of it in new
27free programs, and that you know you can do these things.
28
29 To protect your rights, we need to prevent others from denying you
30these rights or asking you to surrender the rights. Therefore, you have
31certain responsibilities if you distribute copies of the software, or if
32you modify it: responsibilities to respect the freedom of others.
33
34 For example, if you distribute copies of such a program, whether
35gratis or for a fee, you must pass on to the recipients the same
36freedoms that you received. You must make sure that they, too, receive
37or can get the source code. And you must show them these terms so they
38know their rights.
39
40 Developers that use the GNU GPL protect your rights with two steps:
41(1) assert copyright on the software, and (2) offer you this License
42giving you legal permission to copy, distribute and/or modify it.
43
44 For the developers' and authors' protection, the GPL clearly explains
45that there is no warranty for this free software. For both users' and
46authors' sake, the GPL requires that modified versions be marked as
47changed, so that their problems will not be attributed erroneously to
48authors of previous versions.
49
50 Some devices are designed to deny users access to install or run
51modified versions of the software inside them, although the manufacturer
52can do so. This is fundamentally incompatible with the aim of
53protecting users' freedom to change the software. The systematic
54pattern of such abuse occurs in the area of products for individuals to
55use, which is precisely where it is most unacceptable. Therefore, we
56have designed this version of the GPL to prohibit the practice for those
57products. If such problems arise substantially in other domains, we
58stand ready to extend this provision to those domains in future versions
59of the GPL, as needed to protect the freedom of users.
60
61 Finally, every program is threatened constantly by software patents.
62States should not allow patents to restrict development and use of
63software on general-purpose computers, but in those that do, we wish to
64avoid the special danger that patents applied to a free program could
65make it effectively proprietary. To prevent this, the GPL assures that
66patents cannot be used to render the program non-free.
67
68 The precise terms and conditions for copying, distribution and
69modification follow.
70
71 TERMS AND CONDITIONS
72
73 0. Definitions.
74
75 "This License" refers to version 3 of the GNU General Public License.
76
77 "Copyright" also means copyright-like laws that apply to other kinds of
78works, such as semiconductor masks.
79
80 "The Program" refers to any copyrightable work licensed under this
81License. Each licensee is addressed as "you". "Licensees" and
82"recipients" may be individuals or organizations.
83
84 To "modify" a work means to copy from or adapt all or part of the work
85in a fashion requiring copyright permission, other than the making of an
86exact copy. The resulting work is called a "modified version" of the
87earlier work or a work "based on" the earlier work.
88
89 A "covered work" means either the unmodified Program or a work based
90on the Program.
91
92 To "propagate" a work means to do anything with it that, without
93permission, would make you directly or secondarily liable for
94infringement under applicable copyright law, except executing it on a
95computer or modifying a private copy. Propagation includes copying,
96distribution (with or without modification), making available to the
97public, and in some countries other activities as well.
98
99 To "convey" a work means any kind of propagation that enables other
100parties to make or receive copies. Mere interaction with a user through
101a computer network, with no transfer of a copy, is not conveying.
102
103 An interactive user interface displays "Appropriate Legal Notices"
104to the extent that it includes a convenient and prominently visible
105feature that (1) displays an appropriate copyright notice, and (2)
106tells the user that there is no warranty for the work (except to the
107extent that warranties are provided), that licensees may convey the
108work under this License, and how to view a copy of this License. If
109the interface presents a list of user commands or options, such as a
110menu, a prominent item in the list meets this criterion.
111
112 1. Source Code.
113
114 The "source code" for a work means the preferred form of the work
115for making modifications to it. "Object code" means any non-source
116form of a work.
117
118 A "Standard Interface" means an interface that either is an official
119standard defined by a recognized standards body, or, in the case of
120interfaces specified for a particular programming language, one that
121is widely used among developers working in that language.
122
123 The "System Libraries" of an executable work include anything, other
124than the work as a whole, that (a) is included in the normal form of
125packaging a Major Component, but which is not part of that Major
126Component, and (b) serves only to enable use of the work with that
127Major Component, or to implement a Standard Interface for which an
128implementation is available to the public in source code form. A
129"Major Component", in this context, means a major essential component
130(kernel, window system, and so on) of the specific operating system
131(if any) on which the executable work runs, or a compiler used to
132produce the work, or an object code interpreter used to run it.
133
134 The "Corresponding Source" for a work in object code form means all
135the source code needed to generate, install, and (for an executable
136work) run the object code and to modify the work, including scripts to
137control those activities. However, it does not include the work's
138System Libraries, or general-purpose tools or generally available free
139programs which are used unmodified in performing those activities but
140which are not part of the work. For example, Corresponding Source
141includes interface definition files associated with source files for
142the work, and the source code for shared libraries and dynamically
143linked subprograms that the work is specifically designed to require,
144such as by intimate data communication or control flow between those
145subprograms and other parts of the work.
146
147 The Corresponding Source need not include anything that users
148can regenerate automatically from other parts of the Corresponding
149Source.
150
151 The Corresponding Source for a work in source code form is that
152same work.
153
154 2. Basic Permissions.
155
156 All rights granted under this License are granted for the term of
157copyright on the Program, and are irrevocable provided the stated
158conditions are met. This License explicitly affirms your unlimited
159permission to run the unmodified Program. The output from running a
160covered work is covered by this License only if the output, given its
161content, constitutes a covered work. This License acknowledges your
162rights of fair use or other equivalent, as provided by copyright law.
163
164 You may make, run and propagate covered works that you do not
165convey, without conditions so long as your license otherwise remains
166in force. You may convey covered works to others for the sole purpose
167of having them make modifications exclusively for you, or provide you
168with facilities for running those works, provided that you comply with
169the terms of this License in conveying all material for which you do
170not control copyright. Those thus making or running the covered works
171for you must do so exclusively on your behalf, under your direction
172and control, on terms that prohibit them from making any copies of
173your copyrighted material outside their relationship with you.
174
175 Conveying under any other circumstances is permitted solely under
176the conditions stated below. Sublicensing is not allowed; section 10
177makes it unnecessary.
178
179 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
181 No covered work shall be deemed part of an effective technological
182measure under any applicable law fulfilling obligations under article
18311 of the WIPO copyright treaty adopted on 20 December 1996, or
184similar laws prohibiting or restricting circumvention of such
185measures.
186
187 When you convey a covered work, you waive any legal power to forbid
188circumvention of technological measures to the extent such circumvention
189is effected by exercising rights under this License with respect to
190the covered work, and you disclaim any intention to limit operation or
191modification of the work as a means of enforcing, against the work's
192users, your or third parties' legal rights to forbid circumvention of
193technological measures.
194
195 4. Conveying Verbatim Copies.
196
197 You may convey verbatim copies of the Program's source code as you
198receive it, in any medium, provided that you conspicuously and
199appropriately publish on each copy an appropriate copyright notice;
200keep intact all notices stating that this License and any
201non-permissive terms added in accord with section 7 apply to the code;
202keep intact all notices of the absence of any warranty; and give all
203recipients a copy of this License along with the Program.
204
205 You may charge any price or no price for each copy that you convey,
206and you may offer support or warranty protection for a fee.
207
208 5. Conveying Modified Source Versions.
209
210 You may convey a work based on the Program, or the modifications to
211produce it from the Program, in the form of source code under the
212terms of section 4, provided that you also meet all of these conditions:
213
214 a) The work must carry prominent notices stating that you modified
215 it, and giving a relevant date.
216
217 b) The work must carry prominent notices stating that it is
218 released under this License and any conditions added under section
219 7. This requirement modifies the requirement in section 4 to
220 "keep intact all notices".
221
222 c) You must license the entire work, as a whole, under this
223 License to anyone who comes into possession of a copy. This
224 License will therefore apply, along with any applicable section 7
225 additional terms, to the whole of the work, and all its parts,
226 regardless of how they are packaged. This License gives no
227 permission to license the work in any other way, but it does not
228 invalidate such permission if you have separately received it.
229
230 d) If the work has interactive user interfaces, each must display
231 Appropriate Legal Notices; however, if the Program has interactive
232 interfaces that do not display Appropriate Legal Notices, your
233 work need not make them do so.
234
235 A compilation of a covered work with other separate and independent
236works, which are not by their nature extensions of the covered work,
237and which are not combined with it such as to form a larger program,
238in or on a volume of a storage or distribution medium, is called an
239"aggregate" if the compilation and its resulting copyright are not
240used to limit the access or legal rights of the compilation's users
241beyond what the individual works permit. Inclusion of a covered work
242in an aggregate does not cause this License to apply to the other
243parts of the aggregate.
244
245 6. Conveying Non-Source Forms.
246
247 You may convey a covered work in object code form under the terms
248of sections 4 and 5, provided that you also convey the
249machine-readable Corresponding Source under the terms of this License,
250in one of these ways:
251
252 a) Convey the object code in, or embodied in, a physical product
253 (including a physical distribution medium), accompanied by the
254 Corresponding Source fixed on a durable physical medium
255 customarily used for software interchange.
256
257 b) Convey the object code in, or embodied in, a physical product
258 (including a physical distribution medium), accompanied by a
259 written offer, valid for at least three years and valid for as
260 long as you offer spare parts or customer support for that product
261 model, to give anyone who possesses the object code either (1) a
262 copy of the Corresponding Source for all the software in the
263 product that is covered by this License, on a durable physical
264 medium customarily used for software interchange, for a price no
265 more than your reasonable cost of physically performing this
266 conveying of source, or (2) access to copy the
267 Corresponding Source from a network server at no charge.
268
269 c) Convey individual copies of the object code with a copy of the
270 written offer to provide the Corresponding Source. This
271 alternative is allowed only occasionally and noncommercially, and
272 only if you received the object code with such an offer, in accord
273 with subsection 6b.
274
275 d) Convey the object code by offering access from a designated
276 place (gratis or for a charge), and offer equivalent access to the
277 Corresponding Source in the same way through the same place at no
278 further charge. You need not require recipients to copy the
279 Corresponding Source along with the object code. If the place to
280 copy the object code is a network server, the Corresponding Source
281 may be on a different server (operated by you or a third party)
282 that supports equivalent copying facilities, provided you maintain
283 clear directions next to the object code saying where to find the
284 Corresponding Source. Regardless of what server hosts the
285 Corresponding Source, you remain obligated to ensure that it is
286 available for as long as needed to satisfy these requirements.
287
288 e) Convey the object code using peer-to-peer transmission, provided
289 you inform other peers where the object code and Corresponding
290 Source of the work are being offered to the general public at no
291 charge under subsection 6d.
292
293 A separable portion of the object code, whose source code is excluded
294from the Corresponding Source as a System Library, need not be
295included in conveying the object code work.
296
297 A "User Product" is either (1) a "consumer product", which means any
298tangible personal property which is normally used for personal, family,
299or household purposes, or (2) anything designed or sold for incorporation
300into a dwelling. In determining whether a product is a consumer product,
301doubtful cases shall be resolved in favor of coverage. For a particular
302product received by a particular user, "normally used" refers to a
303typical or common use of that class of product, regardless of the status
304of the particular user or of the way in which the particular user
305actually uses, or expects or is expected to use, the product. A product
306is a consumer product regardless of whether the product has substantial
307commercial, industrial or non-consumer uses, unless such uses represent
308the only significant mode of use of the product.
309
310 "Installation Information" for a User Product means any methods,
311procedures, authorization keys, or other information required to install
312and execute modified versions of a covered work in that User Product from
313a modified version of its Corresponding Source. The information must
314suffice to ensure that the continued functioning of the modified object
315code is in no case prevented or interfered with solely because
316modification has been made.
317
318 If you convey an object code work under this section in, or with, or
319specifically for use in, a User Product, and the conveying occurs as
320part of a transaction in which the right of possession and use of the
321User Product is transferred to the recipient in perpetuity or for a
322fixed term (regardless of how the transaction is characterized), the
323Corresponding Source conveyed under this section must be accompanied
324by the Installation Information. But this requirement does not apply
325if neither you nor any third party retains the ability to install
326modified object code on the User Product (for example, the work has
327been installed in ROM).
328
329 The requirement to provide Installation Information does not include a
330requirement to continue to provide support service, warranty, or updates
331for a work that has been modified or installed by the recipient, or for
332the User Product in which it has been modified or installed. Access to a
333network may be denied when the modification itself materially and
334adversely affects the operation of the network or violates the rules and
335protocols for communication across the network.
336
337 Corresponding Source conveyed, and Installation Information provided,
338in accord with this section must be in a format that is publicly
339documented (and with an implementation available to the public in
340source code form), and must require no special password or key for
341unpacking, reading or copying.
342
343 7. Additional Terms.
344
345 "Additional permissions" are terms that supplement the terms of this
346License by making exceptions from one or more of its conditions.
347Additional permissions that are applicable to the entire Program shall
348be treated as though they were included in this License, to the extent
349that they are valid under applicable law. If additional permissions
350apply only to part of the Program, that part may be used separately
351under those permissions, but the entire Program remains governed by
352this License without regard to the additional permissions.
353
354 When you convey a copy of a covered work, you may at your option
355remove any additional permissions from that copy, or from any part of
356it. (Additional permissions may be written to require their own
357removal in certain cases when you modify the work.) You may place
358additional permissions on material, added by you to a covered work,
359for which you have or can give appropriate copyright permission.
360
361 Notwithstanding any other provision of this License, for material you
362add to a covered work, you may (if authorized by the copyright holders of
363that material) supplement the terms of this License with terms:
364
365 a) Disclaiming warranty or limiting liability differently from the
366 terms of sections 15 and 16 of this License; or
367
368 b) Requiring preservation of specified reasonable legal notices or
369 author attributions in that material or in the Appropriate Legal
370 Notices displayed by works containing it; or
371
372 c) Prohibiting misrepresentation of the origin of that material, or
373 requiring that modified versions of such material be marked in
374 reasonable ways as different from the original version; or
375
376 d) Limiting the use for publicity purposes of names of licensors or
377 authors of the material; or
378
379 e) Declining to grant rights under trademark law for use of some
380 trade names, trademarks, or service marks; or
381
382 f) Requiring indemnification of licensors and authors of that
383 material by anyone who conveys the material (or modified versions of
384 it) with contractual assumptions of liability to the recipient, for
385 any liability that these contractual assumptions directly impose on
386 those licensors and authors.
387
388 All other non-permissive additional terms are considered "further
389restrictions" within the meaning of section 10. If the Program as you
390received it, or any part of it, contains a notice stating that it is
391governed by this License along with a term that is a further
392restriction, you may remove that term. If a license document contains
393a further restriction but permits relicensing or conveying under this
394License, you may add to a covered work material governed by the terms
395of that license document, provided that the further restriction does
396not survive such relicensing or conveying.
397
398 If you add terms to a covered work in accord with this section, you
399must place, in the relevant source files, a statement of the
400additional terms that apply to those files, or a notice indicating
401where to find the applicable terms.
402
403 Additional terms, permissive or non-permissive, may be stated in the
404form of a separately written license, or stated as exceptions;
405the above requirements apply either way.
406
407 8. Termination.
408
409 You may not propagate or modify a covered work except as expressly
410provided under this License. Any attempt otherwise to propagate or
411modify it is void, and will automatically terminate your rights under
412this License (including any patent licenses granted under the third
413paragraph of section 11).
414
415 However, if you cease all violation of this License, then your
416license from a particular copyright holder is reinstated (a)
417provisionally, unless and until the copyright holder explicitly and
418finally terminates your license, and (b) permanently, if the copyright
419holder fails to notify you of the violation by some reasonable means
420prior to 60 days after the cessation.
421
422 Moreover, your license from a particular copyright holder is
423reinstated permanently if the copyright holder notifies you of the
424violation by some reasonable means, this is the first time you have
425received notice of violation of this License (for any work) from that
426copyright holder, and you cure the violation prior to 30 days after
427your receipt of the notice.
428
429 Termination of your rights under this section does not terminate the
430licenses of parties who have received copies or rights from you under
431this License. If your rights have been terminated and not permanently
432reinstated, you do not qualify to receive new licenses for the same
433material under section 10.
434
435 9. Acceptance Not Required for Having Copies.
436
437 You are not required to accept this License in order to receive or
438run a copy of the Program. Ancillary propagation of a covered work
439occurring solely as a consequence of using peer-to-peer transmission
440to receive a copy likewise does not require acceptance. However,
441nothing other than this License grants you permission to propagate or
442modify any covered work. These actions infringe copyright if you do
443not accept this License. Therefore, by modifying or propagating a
444covered work, you indicate your acceptance of this License to do so.
445
446 10. Automatic Licensing of Downstream Recipients.
447
448 Each time you convey a covered work, the recipient automatically
449receives a license from the original licensors, to run, modify and
450propagate that work, subject to this License. You are not responsible
451for enforcing compliance by third parties with this License.
452
453 An "entity transaction" is a transaction transferring control of an
454organization, or substantially all assets of one, or subdividing an
455organization, or merging organizations. If propagation of a covered
456work results from an entity transaction, each party to that
457transaction who receives a copy of the work also receives whatever
458licenses to the work the party's predecessor in interest had or could
459give under the previous paragraph, plus a right to possession of the
460Corresponding Source of the work from the predecessor in interest, if
461the predecessor has it or can get it with reasonable efforts.
462
463 You may not impose any further restrictions on the exercise of the
464rights granted or affirmed under this License. For example, you may
465not impose a license fee, royalty, or other charge for exercise of
466rights granted under this License, and you may not initiate litigation
467(including a cross-claim or counterclaim in a lawsuit) alleging that
468any patent claim is infringed by making, using, selling, offering for
469sale, or importing the Program or any portion of it.
470
471 11. Patents.
472
473 A "contributor" is a copyright holder who authorizes use under this
474License of the Program or a work on which the Program is based. The
475work thus licensed is called the contributor's "contributor version".
476
477 A contributor's "essential patent claims" are all patent claims
478owned or controlled by the contributor, whether already acquired or
479hereafter acquired, that would be infringed by some manner, permitted
480by this License, of making, using, or selling its contributor version,
481but do not include claims that would be infringed only as a
482consequence of further modification of the contributor version. For
483purposes of this definition, "control" includes the right to grant
484patent sublicenses in a manner consistent with the requirements of
485this License.
486
487 Each contributor grants you a non-exclusive, worldwide, royalty-free
488patent license under the contributor's essential patent claims, to
489make, use, sell, offer for sale, import and otherwise run, modify and
490propagate the contents of its contributor version.
491
492 In the following three paragraphs, a "patent license" is any express
493agreement or commitment, however denominated, not to enforce a patent
494(such as an express permission to practice a patent or covenant not to
495sue for patent infringement). To "grant" such a patent license to a
496party means to make such an agreement or commitment not to enforce a
497patent against the party.
498
499 If you convey a covered work, knowingly relying on a patent license,
500and the Corresponding Source of the work is not available for anyone
501to copy, free of charge and under the terms of this License, through a
502publicly available network server or other readily accessible means,
503then you must either (1) cause the Corresponding Source to be so
504available, or (2) arrange to deprive yourself of the benefit of the
505patent license for this particular work, or (3) arrange, in a manner
506consistent with the requirements of this License, to extend the patent
507license to downstream recipients. "Knowingly relying" means you have
508actual knowledge that, but for the patent license, your conveying the
509covered work in a country, or your recipient's use of the covered work
510in a country, would infringe one or more identifiable patents in that
511country that you have reason to believe are valid.
512
513 If, pursuant to or in connection with a single transaction or
514arrangement, you convey, or propagate by procuring conveyance of, a
515covered work, and grant a patent license to some of the parties
516receiving the covered work authorizing them to use, propagate, modify
517or convey a specific copy of the covered work, then the patent license
518you grant is automatically extended to all recipients of the covered
519work and works based on it.
520
521 A patent license is "discriminatory" if it does not include within
522the scope of its coverage, prohibits the exercise of, or is
523conditioned on the non-exercise of one or more of the rights that are
524specifically granted under this License. You may not convey a covered
525work if you are a party to an arrangement with a third party that is
526in the business of distributing software, under which you make payment
527to the third party based on the extent of your activity of conveying
528the work, and under which the third party grants, to any of the
529parties who would receive the covered work from you, a discriminatory
530patent license (a) in connection with copies of the covered work
531conveyed by you (or copies made from those copies), or (b) primarily
532for and in connection with specific products or compilations that
533contain the covered work, unless you entered into that arrangement,
534or that patent license was granted, prior to 28 March 2007.
535
536 Nothing in this License shall be construed as excluding or limiting
537any implied license or other defenses to infringement that may
538otherwise be available to you under applicable patent law.
539
540 12. No Surrender of Others' Freedom.
541
542 If conditions are imposed on you (whether by court order, agreement or
543otherwise) that contradict the conditions of this License, they do not
544excuse you from the conditions of this License. If you cannot convey a
545covered work so as to satisfy simultaneously your obligations under this
546License and any other pertinent obligations, then as a consequence you may
547not convey it at all. For example, if you agree to terms that obligate you
548to collect a royalty for further conveying from those to whom you convey
549the Program, the only way you could satisfy both those terms and this
550License would be to refrain entirely from conveying the Program.
551
552 13. Use with the GNU Affero General Public License.
553
554 Notwithstanding any other provision of this License, you have
555permission to link or combine any covered work with a work licensed
556under version 3 of the GNU Affero General Public License into a single
557combined work, and to convey the resulting work. The terms of this
558License will continue to apply to the part which is the covered work,
559but the special requirements of the GNU Affero General Public License,
560section 13, concerning interaction through a network will apply to the
561combination as such.
562
563 14. Revised Versions of this License.
564
565 The Free Software Foundation may publish revised and/or new versions of
566the GNU General Public License from time to time. Such new versions will
567be similar in spirit to the present version, but may differ in detail to
568address new problems or concerns.
569
570 Each version is given a distinguishing version number. If the
571Program specifies that a certain numbered version of the GNU General
572Public License "or any later version" applies to it, you have the
573option of following the terms and conditions either of that numbered
574version or of any later version published by the Free Software
575Foundation. If the Program does not specify a version number of the
576GNU General Public License, you may choose any version ever published
577by the Free Software Foundation.
578
579 If the Program specifies that a proxy can decide which future
580versions of the GNU General Public License can be used, that proxy's
581public statement of acceptance of a version permanently authorizes you
582to choose that version for the Program.
583
584 Later license versions may give you additional or different
585permissions. However, no additional obligations are imposed on any
586author or copyright holder as a result of your choosing to follow a
587later version.
588
589 15. Disclaimer of Warranty.
590
591 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
600 16. Limitation of Liability.
601
602 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610SUCH DAMAGES.
611
612 17. Interpretation of Sections 15 and 16.
613
614 If the disclaimer of warranty and limitation of liability provided
615above cannot be given local legal effect according to their terms,
616reviewing courts shall apply local law that most closely approximates
617an absolute waiver of all civil liability in connection with the
618Program, unless a warranty or assumption of liability accompanies a
619copy of the Program in return for a fee.
620
621 END OF TERMS AND CONDITIONS
622
623 How to Apply These Terms to Your New Programs
624
625 If you develop a new program, and you want it to be of the greatest
626possible use to the public, the best way to achieve this is to make it
627free software which everyone can redistribute and change under these terms.
628
629 To do so, attach the following notices to the program. It is safest
630to attach them to the start of each source file to most effectively
631state the exclusion of warranty; and each file should have at least
632the "copyright" line and a pointer to where the full notice is found.
633
634 <one line to give the program's name and a brief idea of what it does.>
635 Copyright (C) <year> <name of author>
636
637 This program is free software: you can redistribute it and/or modify
638 it under the terms of the GNU General Public License as published by
639 the Free Software Foundation, either version 3 of the License, or
640 (at your option) any later version.
641
642 This program is distributed in the hope that it will be useful,
643 but WITHOUT ANY WARRANTY; without even the implied warranty of
644 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 GNU General Public License for more details.
646
647 You should have received a copy of the GNU General Public License
648 along with this program. If not, see <http://www.gnu.org/licenses/>.
649
650Also add information on how to contact you by electronic and paper mail.
651
652 If the program does terminal interaction, make it output a short
653notice like this when it starts in an interactive mode:
654
655 <program> Copyright (C) <year> <name of author>
656 This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 This is free software, and you are welcome to redistribute it
658 under certain conditions; type `show c' for details.
659
660The hypothetical commands `show w' and `show c' should show the appropriate
661parts of the General Public License. Of course, your program's commands
662might be different; for a GUI interface, you would use an "about box".
663
664 You should also get your employer (if you work as a programmer) or school,
665if any, to sign a "copyright disclaimer" for the program, if necessary.
666For more information on this, and how to apply and follow the GNU GPL, see
667<http://www.gnu.org/licenses/>.
668
669 The GNU General Public License does not permit incorporating your program
670into proprietary programs. If your program is a subroutine library, you
671may consider it more useful to permit linking proprietary applications with
672the library. If this is what you want to do, use the GNU Lesser General
673Public License instead of this License. But first, please read
674<http://www.gnu.org/philosophy/why-not-lgpl.html>.
0675
=== added file 'README.md'
--- README.md 1970-01-01 00:00:00 +0000
+++ README.md 2017-03-01 12:28:42 +0000
@@ -0,0 +1,46 @@
1Readme
2======
3
4MirAL - The Mir Abstraction Layer
5---------------------------------
6
7MirAL aims to provide a stable “abstraction layer” written over the top of the
8Mir server API that will provide a stable ABI. There are a number of other
9goals that can be addressed at the same time:
10
11 - The API can be considerably narrowed as a lot of things can be customized
12 that are of no interest to shell development;
13 - A more declarative design style can be follow than the implementation
14 focussed approach that the Mir server API follows; and,
15 - Common facilities that don’t belong in the Mir libraries can be provided.
16
17The Mir Abstraction Layer (miral) is a both a proof-of-concept and a
18work-in-progress but may be of interest as modern C++ codebase to experiment
19with.
20
21There are two significant components to the MirAL project:
22
23 - libmiral.so is the abstraction library itself
24 - miral-shell is an example shell demonstrating the use of libmiral
25
26See also:
27
28 - \ref getting_and_using_miral "Getting and using Miral"
29 - \ref tasks_for_the_interested_reader "Tasks for the interested reader"
30
31License
32-------
33This program is free software: you can redistribute it and/or modify
34it under the terms of the GNU General Public License version 3 as
35published by the Free Software Foundation.
36
37This program is distributed in the hope that it will be useful,
38but WITHOUT ANY WARRANTY; without even the implied warranty of
39MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40GNU General Public License for more details.
41
42You should have received a copy of the GNU General Public License
43along with this program. If not, see <http://www.gnu.org/licenses/>.
44
45\copyright Copyright © 2016-2017 Canonical Ltd.
46\author Alan Griffiths <alan@octopull.co.uk>
047
=== renamed file 'README.md' => 'README.md.moved'
=== added directory 'cmake'
=== renamed directory 'cmake' => 'cmake.moved'
=== added file 'cmake/Doxygen.cmake'
--- cmake/Doxygen.cmake 1970-01-01 00:00:00 +0000
+++ cmake/Doxygen.cmake 2017-03-01 12:28:42 +0000
@@ -0,0 +1,26 @@
1# Check if doxygen is present and add 'make doc' target
2find_package(Doxygen)
3
4option(
5 BUILD_DOXYGEN
6 "Build Doxygen documentation as part of the default build"
7 OFF
8)
9
10if(DOXYGEN_FOUND AND (DOXYGEN_VERSION VERSION_GREATER "1.8"))
11 message(STATUS "doxygen ${DOXYGEN_VERSION} (>= 1.8.0) available - enabling make target doc")
12 EXECUTE_PROCESS(COMMAND "date" "-u" OUTPUT_VARIABLE DATE_TODAY)
13 configure_file(doc/Doxyfile.in
14 ${PROJECT_BINARY_DIR}/Doxyfile @ONLY IMMEDIATE)
15 configure_file(doc/footer.html.in
16 ${PROJECT_BINARY_DIR}/doc/footer.html @ONLY IMMEDIATE)
17 configure_file(doc/extra.css
18 ${PROJECT_BINARY_DIR}/doc/extra.css @ONLY IMMEDIATE)
19 if (BUILD_DOXYGEN)
20 set(ALL "ALL")
21 endif()
22 add_custom_target(doc ${ALL}
23 COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
24 SOURCES ${PROJECT_BINARY_DIR}/Doxyfile)
25 install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/miral-doc/ OPTIONAL)
26endif()
027
=== added file 'cmake/FindGLESv2.cmake'
--- cmake/FindGLESv2.cmake 1970-01-01 00:00:00 +0000
+++ cmake/FindGLESv2.cmake 2017-03-01 12:28:42 +0000
@@ -0,0 +1,25 @@
1# - Try to find GLESv2
2# Once done this will define
3# GLESv2_FOUND - System has GLESv2
4# GLESv2_INCLUDE_DIRS - The GLESv2 include directories
5# GLESv2_LIBRARIES - The libraries needed to use GLESv2
6
7find_package(PkgConfig)
8pkg_check_modules(PC_GLESv2 QUIET glesv2)
9
10find_path(GLESv2_INCLUDE_DIR GLES2/gl2.h
11 HINTS ${PC_GLESv2_INCLUDEDIR} ${PC_GLESv2_INCLUDE_DIRS})
12
13find_library(GLESv2_LIBRARY GLESv2
14 HINTS ${PC_GLESv2_LIBDIR} ${PC_GLESv2_LIBRARY_DIRS})
15
16set(GLESv2_LIBRARIES ${GLESv2_LIBRARY})
17set(GLESv2_INCLUDE_DIRS ${GLESv2_INCLUDE_DIR})
18
19include(FindPackageHandleStandardArgs)
20# handle the QUIETLY and REQUIRED arguments and set GLESv2_FOUND to TRUE
21# if all listed variables are TRUE
22find_package_handle_standard_args(GLESv2 DEFAULT_MSG
23 GLESv2_LIBRARY GLESv2_INCLUDE_DIR)
24
25mark_as_advanced(GLESv2_INCLUDE_DIR GLESv2_LIBRARY)
026
=== added file 'cmake/FindPIL.cmake'
--- cmake/FindPIL.cmake 1970-01-01 00:00:00 +0000
+++ cmake/FindPIL.cmake 2017-03-01 12:28:42 +0000
@@ -0,0 +1,8 @@
1execute_process(
2 COMMAND python -c "from PIL import Image"
3 RESULT_VARIABLE HAVE_PIL
4)
5
6if (NOT ${HAVE_PIL} EQUAL 0)
7 message(FATAL_ERROR "Python Imaging Library (PIL) not found")
8endif()
09
=== added directory 'debian'
=== renamed directory 'debian' => 'debian.moved'
=== added file 'debian/changelog'
--- debian/changelog 1970-01-01 00:00:00 +0000
+++ debian/changelog 2017-03-01 12:28:42 +0000
@@ -0,0 +1,227 @@
1miral (1.3.0) UNRELEASED; urgency=medium
2
3 * New upstream release 1.3.0 (https://launchpad.net/miral/+milestone/1.3)
4
5 - ABI summary:
6 . miral ABI unchanged at 2
7 - Enhancements:
8 . [libmiral] Support for workspaces
9 . [miral-shell] Example workspaces implementation
10 . [miral-shell] Use background to show keyboard shortcuts
11 . [libmirclientcpp] A better description of libmirclientcpp-dev
12 . [libmirclientcpp] Prevent accidental double-release by deleting release
13 functions for handle classes
14 . [libmirclientcpp] Add RAII wrapper for MirDisplayConfig.
15 - Bugs fixed:
16 . [miral-shell] Workaround for crash on exit (LP: #1667645)
17
18 -- Alan Griffiths <alan.griffiths@canonical.com> Thu, 02 Feb 2017 17:26:54 +0000
19
20miral (1.2.0+17.04.20170215.1-0ubuntu1) zesty; urgency=medium
21
22 * New upstream release 1.2.0 (https://launchpad.net/miral/+milestone/1.2)
23
24 - ABI summary:
25 . miral ABI unchanged at 2
26 - Enhancements:
27 . New libmirclientcpp-dev package "C++ wrapper for libmirclient". (Split
28 from libmiral-dev)
29 . Give miral-app and miral-desktop a good default for -bindir
30 . More surface to window renaming to reflect Mir name changes
31 . Refresh the "Building and Using MirAL" doc
32 - Bugs fixed:
33 . Chrome-less shell hint does not work any more (LP: #1658117)
34 . WindowSpec::set_state() wrapper for mir_window_spec_set_state()
35 (LP: #1661256)
36 . "$ miral-app -kiosk" fails with "Unknown command line options:
37 --desktop_file_hint=miral-shell.desktop" (LP: #1660933)
38 . libmiral] Fix focus and movement rules for Input Method and Satellite
39 windows. (LP: #1660691)
40
41
42 -- Alan Griffiths <alan.griffiths@canonical.com> Wed, 15 Feb 2017 14:05:46 +0000
43
44miral (1.1.0+17.04.20170127-0ubuntu1) zesty; urgency=medium
45
46 [ Alan Griffiths ]
47 * New upstream release 1.1.0 (https://launchpad.net/miral/+milestone/1.1)
48 - ABI summary:
49 . miral ABI unchanged at 2
50 - Enhancements:
51 . Compatibility with Mir 0.26 and update API to use the new Mir types and
52 enums.
53 . Logging of exceptions added to --window-management-trace
54 . Rename WindowManagementPolicy::place_new_surface => place_new_window"
55 - Bugs fixed:
56 . top-level window is not raised along with its child (LP: #1658085)
57 . miral-shell depends on default cursor theme being installed
58 (LP: #1658159)
59
60 -- Cemil Azizoglu <cemil.azizoglu@canonical.com> Fri, 27 Jan 2017 03:02:28 +0000
61
62miral (1.0.2+17.04.20170118.1-0ubuntu1) zesty; urgency=medium
63
64 * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0)
65 - ABI summary:
66 . miral ABI unchanged at 2
67 - Enhancements:
68 - Bugs fixed:
69 . Let the policy decide how to handle "ready" for windows that can't have
70 focus (LP: #1652109)
71
72 -- Alan Griffiths <alan.griffiths@canonical.com> Wed, 18 Jan 2017 18:17:47 +0000
73
74miral (1.0.1+17.04.20161220-0ubuntu1) zesty; urgency=medium
75
76 * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0)
77 - ABI summary:
78 . miral ABI unchanged at 2
79 - Enhancements:
80 . None
81 - Bugs fixed:
82 . Workaround for a missing dependency in Mir packaging (LP: #1651391)
83 . Avoid double lock in WindowManagerTools::force_close() (LP: #1646735)
84 . Fix typo in miral-app script
85
86 -- Alan Griffiths <alan.griffiths@canonical.com> Tue, 20 Dec 2016 16:00:02 +0000
87
88miral (1.0.0+17.04.20161216-0ubuntu1) zesty; urgency=medium
89
90 [ Alan Griffiths ]
91 * New upstream release 1.0.0 (https://launchpad.net/miral/+milestone/1.0)
92 - ABI summary:
93 . miral ABI bumped to 2
94 - Enhancements:
95 . Allow the WM policy a say in inherited moves of child windows
96 . Remove deprecated APIs
97 . add miral-app script to launch examples hosted by an existing desktop
98 - Bugs fixed:
99 . Examples fail to start under Unity8 (LP: #1646431)
100 . [miral-shell --window-manager tiling] windows are not correctly
101 constrained to tiles (LP: #1646735)
102
103 -- Brandon Schaefer <brandon.schaefer@canonical.com> Fri, 16 Dec 2016 00:36:20 +0000
104
105miral (0.5.0+17.04.20161203-0ubuntu1) zesty; urgency=medium
106
107 * no change rebuild
108
109 -- Brandon Schaefer <brandon.schaefer@canonical.com> Sat, 03 Dec 2016 12:38:23 +0000
110
111miral (0.5.0+17.04.20161130-0ubuntu1) zesty; urgency=medium
112
113 * New upstream release 0.5.0 (https://launchpad.net/miral/+milestone/0.5)
114 - ABI summary:
115 . miral ABI unchanged at 1
116 - Enhancements:
117 . Add miral::DebugExtension allowing shells to enable & disable support
118 for debug extension API(s) dynamically
119 . Improve handling of fullscreen surfaces when switching outputs, or
120 specified output doesn't exist (any more)
121 . Initial tests and some fixes for tracking of active window.
122 . Document the order of windows passed to
123 WindowManagementPolicy::advise_raise() so clients can rely on it.
124 . [examples] Add miral-desktop script for launching a pseudo-desktop
125 . [examples] Add miral-screencast - a utility script to assist with
126 creating a screencast
127 . [examples: miral-shell --window-manager tiling] implement the layout
128 suggested in "Tasks for the interested reader"
129 . [examples: miral-shell --window-manager tiling] Don't place a tile
130 until the first window is ready
131 . [examples: miral-kiosk] Provide configuration options for kiosk:
132 --keymap --kiosk-maximize-root-windows & --kiosk-startup-apps-only
133 - Bugs fixed:
134 . Display configuration changes may cause "fatal errors" when there are
135 fullscreen windows (LP: #1640557)
136
137 -- Alan Griffiths <alan.griffiths@canonical.com> Wed, 30 Nov 2016 08:40:24 +0000
138
139miral (0.4.0+17.04.20161104-0ubuntu1) zesty; urgency=medium
140
141 * New upstream release 0.4.0 (https://launchpad.net/miral/+milestone/0.4)
142 - ABI summary:
143 . miral ABI unchanged at 1
144 - Enhancements:
145 . Add miral::WindowManagerTools::force_close(window) to forcefully close
146 a window (i.e. without a close request to the client)
147 . Add functions to manage Applications
148 . Add miral::CommandLineOption - enables the setting and processing of
149 configuration options. These may be supplied on the commandline, as
150 MIR_SERVER_XXX environment variables or in a config file.
151 . Add +options to the keymap configuration
152 . [miral-shell] Add window name to titlebars
153
154 -- Alan Griffiths <alan.griffiths@canonical.com> Fri, 04 Nov 2016 16:45:44 +0000
155
156miral (0.3.0+17.04.20161028-0ubuntu1) zesty; urgency=medium
157
158 * No change rebuild to target Xenial+Overlay
159
160 -- Alan Griffiths <alan.griffiths@canonical.com> Fri, 28 Oct 2016 16:03:16 +0000
161
162miral (0.3.0+17.04.20161024-0ubuntu1) zesty; urgency=medium
163
164 * New upstream release 0.3.0 (https://launchpad.net/miral/+milestone/0.3)
165 - ABI summary:
166 . miral ABI unchanged at 1
167 - Enhancements:
168 . Add miral-xrun as a better way to use Xmir
169 . Added miral/version.h to allow permit compile-time feature detection
170 . A convenient overload of WindowManagerTools::modify_window() that
171 doesn't require the WindowInfo
172 . Add userdata property to WindowSpecification and copy it to WindowInfo
173 . miral::Keymap - support for keyboard maps (either programatically
174 Keymap::set_keymap(), or via config --keymap)
175 - Bugs fixed:
176 . Crash after closing Qt dialog (LP: #1631958)
177 . tooltips positioned wrong with mir0.24 (LP: #1632325, LP: #1633052)
178 . Shell wants way to associate initially requested window creation state
179 with the window later created (#1629349)
180 . [Xmir] Alt+` switch between different apps not just windows
181 (LP: #1625849)
182 . miral-shell splash screen should be fullscreen.
183 . TitlebarWindowManagerPolicy::end_resize() should do nothing if not
184 resizing
185 . deduplicate logging of WindowSpecification::top_left
186
187 -- Alan Griffiths <alan.griffiths@canonical.com> Mon, 24 Oct 2016 15:25:46 +0000
188
189miral (0.2.0+16.10.20160930.1-0ubuntu1) yakkety; urgency=medium
190
191 * New upstream release 0.2.0 (https://launchpad.net/miral/+milestone/0.2)
192 - ABI summary:
193 . miral ABI unchanged at 1
194 - Enhancements:
195 . –window-management-trace option for debugging window management
196 . Enable cursor theme selection
197 . Improved resizing of size-constrained windows in miral-shell example
198 . Enable pointer confinement (where underlying Mir version >= 0.24)
199 . Enhanced "surface placement" request handling.
200 . Results of placement request notified to clients (where supported by
201 underlying Mir version >= 0.25)
202 - Bugs fixed:
203 . advise_focus_lost() isn't called when the active window is minimised/
204 hidden (LP: #1628594)
205 . miral should not change surface geometry because it got maximized
206 (LP: #1628630)
207 . TitlebarWindowManager: sometime the initial display of titlebars doesn't
208 happen (LP: #1628981)
209 . Dialogs with parents should be modal i.e. they receive focus when the
210 parent is clicked (LP: #1626659)
211 . Deadlock in default window manager when Ctrl+Alt+Backspace with a client
212 connected (LP: #1628482)
213 . Need to support pointer confinement in Mir and toolkits using Mir
214 (LP: #1590099)
215 . User can drag menus (and other inappropriate) surfaces (LP: #1616818)
216 . Starting qtcreator on miral-shell gives an orphan "titlebar"
217 (LP: #1628033)
218 . Mouse cursor disappears (or just never changes) when entering the
219 windows of Qt apps (LP: #1625853)
220
221 -- Alan Griffiths <alan.griffiths@canonical.com> Fri, 30 Sep 2016 13:18:17 +0000
222
223miral (0.1.0+16.10.20160919-0ubuntu1) yakkety; urgency=medium
224
225 * Initial release. (LP: #1613220)
226
227 -- Larry Price <larry.price@canonical.com> Mon, 19 Sep 2016 13:41:34 +0000
0228
=== added file 'debian/compat'
--- debian/compat 1970-01-01 00:00:00 +0000
+++ debian/compat 2017-03-01 12:28:42 +0000
@@ -0,0 +1,1 @@
19
02
=== added file 'debian/control'
--- debian/control 1970-01-01 00:00:00 +0000
+++ debian/control 2017-03-01 12:28:42 +0000
@@ -0,0 +1,90 @@
1Source: miral
2Section: x11
3Priority: optional
4Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
5XSBC-Original-Maintainer: Alan Griffiths <alan.griffiths@canonical.com>
6Build-Depends: cmake,
7 cmake-extras,
8 pkg-config,
9 debhelper (>= 9),
10 doxygen,
11 xsltproc,
12 graphviz,
13 pkg-config,
14 python-pil,
15 google-mock (>= 1.6.0+svn437),
16 python3:any,
17 libmirserver-dev,
18 libmirclient-dev,
19 mirtest-dev,
20 libglib2.0-dev,
21 libgles2-mesa-dev,
22 libfreetype6-dev,
23# The following workaround missing dependencies in Mir packages
24 uuid-dev,
25 libboost-system-dev,
26 libboost-filesystem-dev,
27 mir-test-tools,
28 mir-renderer-gl-dev,
29Standards-Version: 3.9.8
30Homepage: https://launchpad.net/miral
31# If you aren't a member of ~mir-team but need to upload packaging changes,
32# just go ahead. ~mir-team will notice and sync up the code again.
33Vcs-Bzr: https://code.launchpad.net/miral
34
35Package: libmiral2
36Section: libs
37Architecture: linux-any
38Multi-Arch: same
39Pre-Depends: ${misc:Pre-Depends}
40Depends: ${misc:Depends},
41 ${shlibs:Depends},
42Description: Display server for Ubuntu - ABI preserving abstraction layer
43 MirAL provides an ABI-stable abstraction layer for Mir based shells,
44 insulating them from mirserver ABI breaks.
45 .
46 Contains the shared library containing MirAL abstraction layer.
47
48Package: libmiral-dev
49Section: libdevel
50Architecture: linux-any
51Multi-Arch: same
52Pre-Depends: ${misc:Pre-Depends}
53Depends: libmiral2 (= ${binary:Version}),
54 libmirclientcpp-dev (= ${binary:Version}),
55 ${misc:Depends},
56Description: Developer files for the Mir ABI-stable abstraction layer
57 MirAL provides an ABI-stable abstraction layer for Mir based shells,
58 insulating them from mirserver ABI breaks.
59 .
60 Contains header files required for development using the MirAL abstraction
61 layer.
62
63Package: libmirclientcpp-dev
64Section: libdevel
65Architecture: linux-any
66Multi-Arch: same
67Pre-Depends: ${misc:Pre-Depends}
68Depends: libmirclient-dev,
69Description: A C++ wrapper for libmirclient-dev
70 Provides RAII (and other facilities) for Mir client library types.
71 .
72 Contains header files useful for C++ development against Mir.
73
74Package: miral-examples
75Architecture: linux-any
76Depends: ${misc:Depends},
77 ${shlibs:Depends},
78Recommends: dmz-cursor-theme,
79Description: Display server for Ubuntu - demonstration programs
80 MirAL provides an ABI-stable abstraction layer for Mir based shells,
81 insulating them from mirserver ABI breaks.
82 .
83 Contains demo applications that use the MirAL abstraction layer
84
85Package: miral-doc
86Section: doc
87Architecture: all
88Depends: ${misc:Depends},
89Description: API documentation for MirAL
90 This package installs the MirAL abstraction layer documentation.
091
=== added file 'debian/copyright'
--- debian/copyright 1970-01-01 00:00:00 +0000
+++ debian/copyright 2017-03-01 12:28:42 +0000
@@ -0,0 +1,24 @@
1Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2Upstream-Name: MirAL
3Upstream-Contact: Alan Griffiths <alan.griffiths@canonical.com>
4Source: https://launchpad.net/miral
5
6Files: *
7Copyright: 2016 Canonical Ltd.
8License: GPL-3
9
10License: GPL-3
11 This program is free software: you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation, version 3 of the License.
14 .
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19 .
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 .
23 On Debian systems, the full text of the GNU General Public License
24 version 3 can be found in the file /usr/share/common-licenses/GPL-3.
025
=== added file 'debian/libmiral-dev.install'
--- debian/libmiral-dev.install 1970-01-01 00:00:00 +0000
+++ debian/libmiral-dev.install 2017-03-01 12:28:42 +0000
@@ -0,0 +1,3 @@
1usr/include/miral/miral/*
2usr/lib/*/pkgconfig/miral.pc
3usr/lib/*/libmiral.so
04
=== added file 'debian/libmiral2.install'
--- debian/libmiral2.install 1970-01-01 00:00:00 +0000
+++ debian/libmiral2.install 2017-03-01 12:28:42 +0000
@@ -0,0 +1,1 @@
1usr/lib/*/libmiral.so.2
02
=== added file 'debian/libmiral2.symbols'
--- debian/libmiral2.symbols 1970-01-01 00:00:00 +0000
+++ debian/libmiral2.symbols 2017-03-01 12:28:42 +0000
@@ -0,0 +1,383 @@
1libmiral.so.2 libmiral2 #MINVER#
2 MIRAL_1.0@MIRAL_1.0 1.0.0
3 (c++)"miral::WindowInfo::height_inc(mir::geometry::detail::IntWrapper<mir::geometry::DeltaYTag>)@MIRAL_1.0" 1.0.0
4 (c++)"miral::WindowInfo::max_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0
5 (c++)"miral::WindowInfo::max_height(mir::geometry::detail::IntWrapper<mir::geometry::HeightTag>)@MIRAL_1.0" 1.0.0
6 (c++)"miral::WindowInfo::min_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0
7 (c++)"miral::WindowInfo::min_height(mir::geometry::detail::IntWrapper<mir::geometry::HeightTag>)@MIRAL_1.0" 1.0.0
8 (c++)"miral::WindowInfo::remove_child(miral::Window const&)@MIRAL_1.0" 1.0.0
9 (c++)"miral::WindowInfo::restore_rect(mir::geometry::Rectangle const&)@MIRAL_1.0" 1.0.0
10 (c++)"miral::WindowInfo::needs_titlebar(MirSurfaceType)@MIRAL_1.0" 1.0.0
11 (c++)"miral::WindowInfo::confine_pointer(MirPointerConfinementState)@MIRAL_1.0" 1.0.0
12 (c++)"miral::WindowInfo::preferred_orientation(MirOrientationMode)@MIRAL_1.0" 1.0.0
13 (c++)"miral::WindowInfo::name(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
14 (c++)"miral::WindowInfo::type(MirSurfaceType)@MIRAL_1.0" 1.0.0
15 (c++)"miral::WindowInfo::state(MirSurfaceState)@MIRAL_1.0" 1.0.0
16 (c++)"miral::WindowInfo::parent(miral::Window const&)@MIRAL_1.0" 1.0.0
17 (c++)"miral::WindowInfo::userdata(std::shared_ptr<void>)@MIRAL_1.0" 1.0.0
18 (c++)"miral::WindowInfo::add_child(miral::Window const&)@MIRAL_1.0" 1.0.0
19 (c++)"miral::WindowInfo::max_width(mir::geometry::detail::IntWrapper<mir::geometry::WidthTag>)@MIRAL_1.0" 1.0.0
20 (c++)"miral::WindowInfo::min_width(mir::geometry::detail::IntWrapper<mir::geometry::WidthTag>)@MIRAL_1.0" 1.0.0
21 (c++)"miral::WindowInfo::output_id(mir::optional_value<int>)@MIRAL_1.0" 1.0.0
22 (c++)"miral::WindowInfo::width_inc(mir::geometry::detail::IntWrapper<mir::geometry::DeltaXTag>)@MIRAL_1.0" 1.0.0
23 (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
24 (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
25 (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0
26 (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
27 (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
28 (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0
29 (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0
30 (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0
31 (c++)"miral::WindowInfo::operator=(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
32 (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
33 (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
34 (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0
35 (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0
36 (c++)"miral::SetTerminator::SetTerminator(std::function<void (int)> const&)@MIRAL_1.0" 1.0.0
37 (c++)"miral::SetTerminator::SetTerminator(std::function<void (int)> const&)@MIRAL_1.0" 1.0.0
38 (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0
39 (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0
40 (c++)"miral::DebugExtension::enable()@MIRAL_1.0" 1.0.0
41 (c++)"miral::DebugExtension::disable()@MIRAL_1.0" 1.0.0
42 (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0
43 (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0
44 (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0
45 (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0
46 (c++)"miral::DebugExtension::operator=(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0
47 (c++)"miral::AddInitCallback::AddInitCallback(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
48 (c++)"miral::AddInitCallback::AddInitCallback(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
49 (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0
50 (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0
51 (c++)"miral::ApplicationInfo::add_window(miral::Window const&)@MIRAL_1.0" 1.0.0
52 (c++)"miral::ApplicationInfo::remove_window(miral::Window const&)@MIRAL_1.0" 1.0.0
53 (c++)"miral::ApplicationInfo::userdata(std::shared_ptr<void>)@MIRAL_1.0" 1.0.0
54 (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0
55 (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr<mir::scene::Session> const&)@MIRAL_1.0" 1.0.0
56 (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0
57 (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0
58 (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr<mir::scene::Session> const&)@MIRAL_1.0" 1.0.0
59 (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0
60 (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0
61 (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0
62 (c++)"miral::ApplicationInfo::operator=(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0
63 (c++)"miral::AppendEventFilter::AppendEventFilter(std::function<int (MirEvent const*)> const&)@MIRAL_1.0" 1.0.0
64 (c++)"miral::AppendEventFilter::AppendEventFilter(std::function<int (MirEvent const*)> const&)@MIRAL_1.0" 1.0.0
65 (c++)"miral::AppendEventFilter::operator()(mir::Server&)@MIRAL_1.0" 1.0.0
66 (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0
67 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
68 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<bool> const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
69 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<int> const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
70 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, char const*)@MIRAL_1.0" 1.0.0
71 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
72 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (bool)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
73 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (bool)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, bool)@MIRAL_1.0" 1.0.0
74 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (double)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double)@MIRAL_1.0" 1.0.0
75 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (int)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int)@MIRAL_1.0" 1.0.0
76 (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0
77 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
78 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<bool> const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
79 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (mir::optional_value<int> const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
80 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, char const*)@MIRAL_1.0" 1.0.0
81 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
82 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (bool)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
83 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (bool)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, bool)@MIRAL_1.0" 1.0.0
84 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (double)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, double)@MIRAL_1.0" 1.0.0
85 (c++)"miral::CommandLineOption::CommandLineOption(std::function<void (int)>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int)@MIRAL_1.0" 1.0.0
86 (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0
87 (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0
88 (c++)"miral::CommandLineOption::operator=(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0
89 (c++)"miral::WindowManagerTools::raise_tree(miral::Window const&)@MIRAL_1.0" 1.0.0
90 (c++)"miral::WindowManagerTools::force_close(miral::Window const&)@MIRAL_1.0" 1.0.0
91 (c++)"miral::WindowManagerTools::modify_window(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
92 (c++)"miral::WindowManagerTools::modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
93 (c++)"miral::WindowManagerTools::active_display()@MIRAL_1.0" 1.0.0
94 (c++)"miral::WindowManagerTools::find_application(std::function<bool (miral::ApplicationInfo const&)> const&)@MIRAL_1.0" 1.0.0
95 (c++)"miral::WindowManagerTools::invoke_under_lock(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
96 (c++)"miral::WindowManagerTools::drag_active_window(mir::geometry::Displacement)@MIRAL_1.0" 1.0.0
97 (c++)"miral::WindowManagerTools::ask_client_to_close(miral::Window const&)@MIRAL_1.0" 1.0.0
98 (c++)"miral::WindowManagerTools::for_each_application(std::function<void (miral::ApplicationInfo&)> const&)@MIRAL_1.0" 1.0.0
99 (c++)"miral::WindowManagerTools::select_active_window(miral::Window const&)@MIRAL_1.0" 1.0.0
100 (c++)"miral::WindowManagerTools::focus_next_application()@MIRAL_1.0" 1.0.0
101 (c++)"miral::WindowManagerTools::focus_next_within_application()@MIRAL_1.0" 1.0.0
102 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0
103 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0
104 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0
105 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0
106 (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0
107 (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0
108 (c++)"miral::WindowManagerTools::operator=(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0
109 (c++)"miral::WindowSpecification::height_inc()@MIRAL_1.0" 1.0.0
110 (c++)"miral::WindowSpecification::input_mode()@MIRAL_1.0" 1.0.0
111 (c++)"miral::WindowSpecification::max_aspect()@MIRAL_1.0" 1.0.0
112 (c++)"miral::WindowSpecification::max_height()@MIRAL_1.0" 1.0.0
113 (c++)"miral::WindowSpecification::min_aspect()@MIRAL_1.0" 1.0.0
114 (c++)"miral::WindowSpecification::min_height()@MIRAL_1.0" 1.0.0
115 (c++)"miral::WindowSpecification::input_shape()@MIRAL_1.0" 1.0.0
116 (c++)"miral::WindowSpecification::shell_chrome()@MIRAL_1.0" 1.0.0
117 (c++)"miral::WindowSpecification::confine_pointer()@MIRAL_1.0" 1.0.0
118 (c++)"miral::WindowSpecification::placement_hints()@MIRAL_1.0" 1.0.0
119 (c++)"miral::WindowSpecification::preferred_orientation()@MIRAL_1.0" 1.0.0
120 (c++)"miral::WindowSpecification::window_placement_gravity()@MIRAL_1.0" 1.0.0
121 (c++)"miral::WindowSpecification::aux_rect_placement_offset()@MIRAL_1.0" 1.0.0
122 (c++)"miral::WindowSpecification::aux_rect_placement_gravity()@MIRAL_1.0" 1.0.0
123 (c++)"miral::WindowSpecification::name[abi:cxx11]()@MIRAL_1.0" 1.0.0
124 (c++)"miral::WindowSpecification::size()@MIRAL_1.0" 1.0.0
125 (c++)"miral::WindowSpecification::type()@MIRAL_1.0" 1.0.0
126 (c++)"miral::WindowSpecification::state()@MIRAL_1.0" 1.0.0
127 (c++)"miral::WindowSpecification::parent()@MIRAL_1.0" 1.0.0
128 (c++)"miral::WindowSpecification::aux_rect()@MIRAL_1.0" 1.0.0
129 (c++)"miral::WindowSpecification::top_left()@MIRAL_1.0" 1.0.0
130 (c++)"miral::WindowSpecification::userdata()@MIRAL_1.0" 1.0.0
131 (c++)"miral::WindowSpecification::max_width()@MIRAL_1.0" 1.0.0
132 (c++)"miral::WindowSpecification::min_width()@MIRAL_1.0" 1.0.0
133 (c++)"miral::WindowSpecification::output_id()@MIRAL_1.0" 1.0.0
134 (c++)"miral::WindowSpecification::width_inc()@MIRAL_1.0" 1.0.0
135 (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0
136 (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0
137 (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
138 (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0
139 (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0
140 (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0
141 (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
142 (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0
143 (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0
144 (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0
145 (c++)"miral::WindowSpecification::operator=(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
146 (c++)"miral::ActiveOutputsMonitor::add_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0
147 (c++)"miral::ActiveOutputsMonitor::delete_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0
148 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0
149 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0
150 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0
151 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0
152 (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0
153 (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0
154 (c++)"miral::ActiveOutputsMonitor::operator=(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0
155 (c++)"miral::ActiveOutputsMonitor::operator()(mir::Server&)@MIRAL_1.0" 1.0.0
156 (c++)"miral::ActiveOutputsListener::advise_output_end()@MIRAL_1.0" 1.0.0
157 (c++)"miral::ActiveOutputsListener::advise_output_begin()@MIRAL_1.0" 1.0.0
158 (c++)"miral::ActiveOutputsListener::advise_output_create(miral::Output const&)@MIRAL_1.0" 1.0.0
159 (c++)"miral::ActiveOutputsListener::advise_output_delete(miral::Output const&)@MIRAL_1.0" 1.0.0
160 (c++)"miral::ActiveOutputsListener::advise_output_update(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0
161 (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function<void (int, char const* const*)> const&)@MIRAL_1.0" 1.0.0
162 (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function<void (int, char const* const*)> const&)@MIRAL_1.0" 1.0.0
163 (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0
164 (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0
165 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::function<void (miral::toolkit::Connection)>, std::function<void (std::weak_ptr<mir::scene::Session>)>)@MIRAL_1.0" 1.0.0
166 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::function<void (miral::toolkit::Connection)>, std::function<void (std::weak_ptr<mir::scene::Session>)>)@MIRAL_1.0" 1.0.0
167 (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0
168 (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0
169 (c++)"miral::StartupInternalClient::operator()(mir::Server&)@MIRAL_1.0" 1.0.0
170 (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0
171 (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0
172 (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0
173 (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0
174 (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0
175 (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0
176 (c++)"miral::InternalClientLauncher::operator()(mir::Server&)@MIRAL_1.0" 1.0.0
177 (c++)"miral::WindowManagementPolicy::advise_end()@MIRAL_1.0" 1.0.0
178 (c++)"miral::WindowManagementPolicy::advise_begin()@MIRAL_1.0" 1.0.0
179 (c++)"miral::WindowManagementPolicy::advise_raise(std::vector<miral::Window, std::allocator<miral::Window> > const&)@MIRAL_1.0" 1.0.0
180 (c++)"miral::WindowManagementPolicy::advise_resize(miral::WindowInfo const&, mir::geometry::Size const&)@MIRAL_1.0" 1.0.0
181 (c++)"miral::WindowManagementPolicy::advise_move_to(miral::WindowInfo const&, mir::geometry::Point)@MIRAL_1.0" 1.0.0
182 (c++)"miral::WindowManagementPolicy::advise_new_app(miral::ApplicationInfo&)@MIRAL_1.0" 1.0.0
183 (c++)"miral::WindowManagementPolicy::advise_delete_app(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0
184 (c++)"miral::WindowManagementPolicy::advise_focus_lost(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
185 (c++)"miral::WindowManagementPolicy::advise_new_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
186 (c++)"miral::WindowManagementPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
187 (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirSurfaceState)@MIRAL_1.0" 1.0.0
188 (c++)"miral::WindowManagementPolicy::advise_delete_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
189 (c++)"miral::equivalent_display_area(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0
190 (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function<std::unique_ptr<miral::WindowManagementPolicy, std::default_delete<miral::WindowManagementPolicy> > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0
191 (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function<std::unique_ptr<miral::WindowManagementPolicy, std::default_delete<miral::WindowManagementPolicy> > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0
192 (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0
193 (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0
194 (c++)"miral::apply_lifecycle_state_to(std::shared_ptr<mir::scene::Session> const&, MirLifecycleState)@MIRAL_1.0" 1.0.0
195 (c++)"miral::CanonicalWindowManagerPolicy::place_new_surface(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
196 (c++)"miral::CanonicalWindowManagerPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0
197 (c++)"miral::CanonicalWindowManagerPolicy::handle_raise_window(miral::WindowInfo&)@MIRAL_1.0" 1.0.0
198 (c++)"miral::CanonicalWindowManagerPolicy::handle_window_ready(miral::WindowInfo&)@MIRAL_1.0" 1.0.0
199 (c++)"miral::CanonicalWindowManagerPolicy::handle_modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0
200 (c++)"miral::CanonicalWindowManagerPolicy::confirm_inherited_move(miral::WindowInfo const&, mir::geometry::Displacement)@MIRAL_1.0" 1.0.0
201 (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0
202 (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0
203 (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function<std::shared_ptr<miral::ApplicationAuthorizer> ()> const&)@MIRAL_1.0" 1.0.0
204 (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function<std::shared_ptr<miral::ApplicationAuthorizer> ()> const&)@MIRAL_1.0" 1.0.0
205 (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0
206 (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0
207 (c++)"miral::BasicSetApplicationAuthorizer::operator()(mir::Server&)@MIRAL_1.0" 1.0.0
208 (c++)"miral::display_configuration_options(mir::Server&)@MIRAL_1.0" 1.0.0
209 (c++)"miral::kill(std::shared_ptr<mir::scene::Session> const&, int)@MIRAL_1.0" 1.0.0
210 (c++)"miral::Keymap::set_keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
211 (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
212 (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0
213 (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0
214 (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_1.0" 1.0.0
215 (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0
216 (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0
217 (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0
218 (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0
219 (c++)"miral::Keymap::operator=(miral::Keymap const&)@MIRAL_1.0" 1.0.0
220 (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0
221 (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0
222 (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0
223 (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0
224 (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0
225 (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0
226 (c++)"miral::Output::operator=(miral::Output const&)@MIRAL_1.0" 1.0.0
227 (c++)"miral::Window::resize(mir::geometry::Size const&)@MIRAL_1.0" 1.0.0
228 (c++)"miral::Window::move_to(mir::geometry::Point)@MIRAL_1.0" 1.0.0
229 (c++)"miral::Window::Window(std::shared_ptr<mir::scene::Session> const&, std::shared_ptr<mir::scene::Surface> const&)@MIRAL_1.0" 1.0.0
230 (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0
231 (c++)"miral::Window::Window(std::shared_ptr<mir::scene::Session> const&, std::shared_ptr<mir::scene::Surface> const&)@MIRAL_1.0" 1.0.0
232 (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0
233 (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0
234 (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0
235 (c++)"miral::pid_of(std::shared_ptr<mir::scene::Session> const&)@MIRAL_1.0" 1.0.0
236 (c++)"miral::name_of[abi:cxx11](std::shared_ptr<mir::scene::Session> const&)@MIRAL_1.0" 1.0.0
237 (c++)"miral::MirRunner::add_stop_callback(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
238 (c++)"miral::MirRunner::add_start_callback(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
239 (c++)"miral::MirRunner::set_exception_handler(std::function<void ()> const&)@MIRAL_1.0" 1.0.0
240 (c++)"miral::MirRunner::stop()@MIRAL_1.0" 1.0.0
241 (c++)"miral::MirRunner::run_with(std::initializer_list<std::function<void (mir::Server&)> >)@MIRAL_1.0" 1.0.0
242 (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0
243 (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0
244 (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0
245 (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0
246 (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0
247 (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0
248 (c++)"miral::operator==(miral::Output::PhysicalSizeMM const&, miral::Output::PhysicalSizeMM const&)@MIRAL_1.0" 1.0.0
249 (c++)"miral::operator==(miral::Window const&, std::shared_ptr<mir::scene::Surface> const&)@MIRAL_1.0" 1.0.0
250 (c++)"miral::operator==(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.0.0
251 (c++)"miral::operator==(std::shared_ptr<mir::scene::Surface> const&, miral::Window const&)@MIRAL_1.0" 1.0.0
252 (c++)"miral::WindowInfo::height_inc() const@MIRAL_1.0" 1.0.0
253 (c++)"miral::WindowInfo::is_visible() const@MIRAL_1.0" 1.0.0
254 (c++)"miral::WindowInfo::max_aspect() const@MIRAL_1.0" 1.0.0
255 (c++)"miral::WindowInfo::max_height() const@MIRAL_1.0" 1.0.0
256 (c++)"miral::WindowInfo::min_aspect() const@MIRAL_1.0" 1.0.0
257 (c++)"miral::WindowInfo::min_height() const@MIRAL_1.0" 1.0.0
258 (c++)"miral::WindowInfo::can_morph_to(MirSurfaceType) const@MIRAL_1.0" 1.0.0
259 (c++)"miral::WindowInfo::restore_rect() const@MIRAL_1.0" 1.0.0
260 (c++)"miral::WindowInfo::can_be_active() const@MIRAL_1.0" 1.0.0
261 (c++)"miral::WindowInfo::has_output_id() const@MIRAL_1.0" 1.0.0
262 (c++)"miral::WindowInfo::confine_pointer() const@MIRAL_1.0" 1.0.0
263 (c++)"miral::WindowInfo::constrain_resize(mir::geometry::Point&, mir::geometry::Size&) const@MIRAL_1.0" 1.0.0
264 (c++)"miral::WindowInfo::must_have_parent() const@MIRAL_1.0" 1.0.0
265 (c++)"miral::WindowInfo::must_not_have_parent() const@MIRAL_1.0" 1.0.0
266 (c++)"miral::WindowInfo::preferred_orientation() const@MIRAL_1.0" 1.0.0
267 (c++)"miral::WindowInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0
268 (c++)"miral::WindowInfo::type() const@MIRAL_1.0" 1.0.0
269 (c++)"miral::WindowInfo::state() const@MIRAL_1.0" 1.0.0
270 (c++)"miral::WindowInfo::parent() const@MIRAL_1.0" 1.0.0
271 (c++)"miral::WindowInfo::window() const@MIRAL_1.0" 1.0.0
272 (c++)"miral::WindowInfo::children() const@MIRAL_1.0" 1.0.0
273 (c++)"miral::WindowInfo::userdata() const@MIRAL_1.0" 1.0.0
274 (c++)"miral::WindowInfo::max_width() const@MIRAL_1.0" 1.0.0
275 (c++)"miral::WindowInfo::min_width() const@MIRAL_1.0" 1.0.0
276 (c++)"miral::WindowInfo::output_id() const@MIRAL_1.0" 1.0.0
277 (c++)"miral::WindowInfo::width_inc() const@MIRAL_1.0" 1.0.0
278 (c++)"miral::CursorTheme::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
279 (c++)"miral::SetTerminator::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
280 (c++)"miral::DebugExtension::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
281 (c++)"miral::AddInitCallback::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
282 (c++)"miral::ApplicationInfo::application() const@MIRAL_1.0" 1.0.0
283 (c++)"miral::ApplicationInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0
284 (c++)"miral::ApplicationInfo::windows() const@MIRAL_1.0" 1.0.0
285 (c++)"miral::ApplicationInfo::userdata() const@MIRAL_1.0" 1.0.0
286 (c++)"miral::CommandLineOption::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
287 (c++)"miral::WindowManagerTools::active_window() const@MIRAL_1.0" 1.0.0
288 (c++)"miral::WindowManagerTools::id_for_window[abi:cxx11](miral::Window const&) const@MIRAL_1.0" 1.0.0
289 (c++)"miral::WindowManagerTools::count_applications() const@MIRAL_1.0" 1.0.0
290 (c++)"miral::WindowManagerTools::info_for_window_id(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const@MIRAL_1.0" 1.0.0
291 (c++)"miral::WindowManagerTools::place_and_size_for_state(miral::WindowSpecification&, miral::WindowInfo const&) const@MIRAL_1.0" 1.0.0
292 (c++)"miral::WindowManagerTools::info_for(miral::Window const&) const@MIRAL_1.0" 1.0.0
293 (c++)"miral::WindowManagerTools::info_for(std::weak_ptr<mir::scene::Session> const&) const@MIRAL_1.0" 1.0.0
294 (c++)"miral::WindowManagerTools::info_for(std::weak_ptr<mir::scene::Surface> const&) const@MIRAL_1.0" 1.0.0
295 (c++)"miral::WindowManagerTools::window_at(mir::geometry::Point) const@MIRAL_1.0" 1.0.0
296 (c++)"miral::WindowSpecification::height_inc() const@MIRAL_1.0" 1.0.0
297 (c++)"miral::WindowSpecification::input_mode() const@MIRAL_1.0" 1.0.0
298 (c++)"miral::WindowSpecification::max_aspect() const@MIRAL_1.0" 1.0.0
299 (c++)"miral::WindowSpecification::max_height() const@MIRAL_1.0" 1.0.0
300 (c++)"miral::WindowSpecification::min_aspect() const@MIRAL_1.0" 1.0.0
301 (c++)"miral::WindowSpecification::min_height() const@MIRAL_1.0" 1.0.0
302 (c++)"miral::WindowSpecification::input_shape() const@MIRAL_1.0" 1.0.0
303 (c++)"miral::WindowSpecification::shell_chrome() const@MIRAL_1.0" 1.0.0
304 (c++)"miral::WindowSpecification::confine_pointer() const@MIRAL_1.0" 1.0.0
305 (c++)"miral::WindowSpecification::placement_hints() const@MIRAL_1.0" 1.0.0
306 (c++)"miral::WindowSpecification::preferred_orientation() const@MIRAL_1.0" 1.0.0
307 (c++)"miral::WindowSpecification::window_placement_gravity() const@MIRAL_1.0" 1.0.0
308 (c++)"miral::WindowSpecification::aux_rect_placement_offset() const@MIRAL_1.0" 1.0.0
309 (c++)"miral::WindowSpecification::aux_rect_placement_gravity() const@MIRAL_1.0" 1.0.0
310 (c++)"miral::WindowSpecification::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0
311 (c++)"miral::WindowSpecification::size() const@MIRAL_1.0" 1.0.0
312 (c++)"miral::WindowSpecification::type() const@MIRAL_1.0" 1.0.0
313 (c++)"miral::WindowSpecification::state() const@MIRAL_1.0" 1.0.0
314 (c++)"miral::WindowSpecification::parent() const@MIRAL_1.0" 1.0.0
315 (c++)"miral::WindowSpecification::update(mir::scene::SurfaceCreationParameters&) const@MIRAL_1.0" 1.0.0
316 (c++)"miral::WindowSpecification::aux_rect() const@MIRAL_1.0" 1.0.0
317 (c++)"miral::WindowSpecification::top_left() const@MIRAL_1.0" 1.0.0
318 (c++)"miral::WindowSpecification::userdata() const@MIRAL_1.0" 1.0.0
319 (c++)"miral::WindowSpecification::max_width() const@MIRAL_1.0" 1.0.0
320 (c++)"miral::WindowSpecification::min_width() const@MIRAL_1.0" 1.0.0
321 (c++)"miral::WindowSpecification::output_id() const@MIRAL_1.0" 1.0.0
322 (c++)"miral::WindowSpecification::width_inc() const@MIRAL_1.0" 1.0.0
323 (c++)"miral::ActiveOutputsMonitor::process_outputs(std::function<void (std::vector<miral::Output, std::allocator<miral::Output> > const&)> const&) const@MIRAL_1.0" 1.0.0
324 (c++)"miral::WindowManagerOptions::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
325 (c++)"miral::SetCommandLineHandler::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
326 (c++)"miral::ApplicationCredentials::gid() const@MIRAL_1.0" 1.0.0
327 (c++)"miral::ApplicationCredentials::pid() const@MIRAL_1.0" 1.0.0
328 (c++)"miral::ApplicationCredentials::uid() const@MIRAL_1.0" 1.0.0
329 (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::function<void (miral::toolkit::Connection)> const&, std::function<void (std::weak_ptr<mir::scene::Session>)> const&) const@MIRAL_1.0" 1.0.0
330 (c++)"miral::SetWindowManagmentPolicy::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
331 (c++)"miral::BasicSetApplicationAuthorizer::the_application_authorizer() const@MIRAL_1.0" 1.0.0
332 (c++)"miral::Keymap::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0
333 (c++)"miral::Output::power_mode() const@MIRAL_1.0" 1.0.0
334 (c++)"miral::Output::form_factor() const@MIRAL_1.0" 1.0.0
335 (c++)"miral::Output::orientation() const@MIRAL_1.0" 1.0.0
336 (c++)"miral::Output::pixel_format() const@MIRAL_1.0" 1.0.0
337 (c++)"miral::Output::refresh_rate() const@MIRAL_1.0" 1.0.0
338 (c++)"miral::Output::is_same_output(miral::Output const&) const@MIRAL_1.0" 1.0.0
339 (c++)"miral::Output::physical_size_mm() const@MIRAL_1.0" 1.0.0
340 (c++)"miral::Output::type() const@MIRAL_1.0" 1.0.0
341 (c++)"miral::Output::used() const@MIRAL_1.0" 1.0.0
342 (c++)"miral::Output::scale() const@MIRAL_1.0" 1.0.0
343 (c++)"miral::Output::valid() const@MIRAL_1.0" 1.0.0
344 (c++)"miral::Output::extents() const@MIRAL_1.0" 1.0.0
345 (c++)"miral::Output::connected() const@MIRAL_1.0" 1.0.0
346 (c++)"miral::Window::application() const@MIRAL_1.0" 1.0.0
347 (c++)"miral::Window::size() const@MIRAL_1.0" 1.0.0
348 (c++)"miral::Window::top_left() const@MIRAL_1.0" 1.0.0
349 (c++)"miral::Window::operator std::shared_ptr<mir::scene::Surface>() const@MIRAL_1.0" 1.0.0
350 (c++)"miral::Window::operator std::weak_ptr<mir::scene::Surface>() const@MIRAL_1.0" 1.0.0
351 (c++)"miral::Window::operator bool() const@MIRAL_1.0" 1.0.0
352 (c++)"typeinfo for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0
353 (c++)"typeinfo for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0
354 (c++)"typeinfo for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0
355 (c++)"vtable for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0
356 (c++)"vtable for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0
357 (c++)"vtable for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0
358 MIRAL_1.1@MIRAL_1.1 1.1.0
359 (c++)"miral::WindowInfo::needs_titlebar(MirWindowType)@MIRAL_1.1" 1.1.0
360 (c++)"miral::WindowInfo::type(MirWindowType)@MIRAL_1.1" 1.1.0
361 (c++)"miral::WindowInfo::state(MirWindowState)@MIRAL_1.1" 1.1.0
362 (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirWindowState)@MIRAL_1.1" 1.1.0
363 (c++)"miral::WindowInfo::can_morph_to(MirWindowType) const@MIRAL_1.1" 1.1.0
364 (c++)"miral::CanonicalWindowManagerPolicy::place_new_window(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.1" 1.1.0
365 MIRAL_1.2@MIRAL_1.2 1.2.0
366 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::function<void (mir::client::Connection)>, std::function<void (std::weak_ptr<mir::scene::Session>)>)@MIRAL_1.2" 1.2.0
367 (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::function<void (mir::client::Connection)> const&, std::function<void (std::weak_ptr<mir::scene::Session>)> const&) const@MIRAL_1.2" 1.2.0
368 (c++)"miral::WindowInfo::shell_chrome(MirShellChrome)@MIRAL_1.2" 1.2.0
369 (c++)"miral::WindowInfo::shell_chrome() const@MIRAL_1.2" 1.2.0
370 (c++)"miral::WindowManagerTools::drag_window(miral::Window const&, mir::geometry::Displacement)@MIRAL_1.2" 1.2.0
371 (c++)"typeinfo for miral::ApplicationAuthorizer@MIRAL_1.0" 1.2.0
372 (c++)"typeinfo for miral::ApplicationAuthorizer1@MIRAL_1.2" 1.2.0
373 MIRAL_1.3@MIRAL_1.3 1.3.0
374 (c++)"miral::operator<(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.3.0
375 (c++)"miral::WindowManagerTools::create_workspace()@MIRAL_1.3" 1.3.0
376 (c++)"miral::WindowManagerTools::add_tree_to_workspace(miral::Window const&, std::shared_ptr<miral::Workspace> const&)@MIRAL_1.3" 1.3.0
377 (c++)"miral::WindowManagerTools::remove_tree_from_workspace(miral::Window const&, std::shared_ptr<miral::Workspace> const&)@MIRAL_1.3" 1.3.0
378 (c++)"miral::WorkspacePolicy::advise_adding_to_workspace(std::shared_ptr<miral::Workspace> const&, std::vector<miral::Window, std::allocator<miral::Window> > const&)@MIRAL_1.3" 1.3.0
379 (c++)"miral::WorkspacePolicy::advise_removing_from_workspace(std::shared_ptr<miral::Workspace> const&, std::vector<miral::Window, std::allocator<miral::Window> > const&)@MIRAL_1.3" 1.3.0
380 (c++)"miral::WindowManagerTools::for_each_window_in_workspace(std::shared_ptr<miral::Workspace> const&, std::function<void (miral::Window const&)> const&)@MIRAL_1.3" 1.3.0
381 (c++)"miral::WindowManagerTools::for_each_workspace_containing(miral::Window const&, std::function<void (std::shared_ptr<miral::Workspace> const&)> const&)@MIRAL_1.3" 1.3.0
382 (c++)"typeinfo for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0
383 (c++)"vtable for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0
0384
=== added file 'debian/libmirclientcpp-dev.install'
--- debian/libmirclientcpp-dev.install 1970-01-01 00:00:00 +0000
+++ debian/libmirclientcpp-dev.install 2017-03-01 12:28:42 +0000
@@ -0,0 +1,2 @@
1usr/include/miral/mir/*/*
2usr/lib/*/pkgconfig/mirclientcpp.pc
03
=== added file 'debian/miral-doc.install'
--- debian/miral-doc.install 1970-01-01 00:00:00 +0000
+++ debian/miral-doc.install 2017-03-01 12:28:42 +0000
@@ -0,0 +1,1 @@
1usr/share/doc/miral-doc/
02
=== added file 'debian/miral-examples.install'
--- debian/miral-examples.install 1970-01-01 00:00:00 +0000
+++ debian/miral-examples.install 2017-03-01 12:28:42 +0000
@@ -0,0 +1,9 @@
1usr/bin/miral-shell
2usr/bin/miral-run
3usr/bin/miral-kiosk
4usr/bin/miral-xrun
5usr/bin/miral-screencast
6usr/bin/miral-desktop
7usr/bin/miral-app
8usr/share/applications/miral-shell.desktop
9usr/share/icons/hicolor/scalable/apps/ubuntu-logo.svg
010
=== added file 'debian/rules'
--- debian/rules 1970-01-01 00:00:00 +0000
+++ debian/rules 2017-03-01 12:28:42 +0000
@@ -0,0 +1,26 @@
1#!/usr/bin/make -f
2
3DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH)
4
5export DPKG_GENSYMBOLS_CHECK_LEVEL = 4
6
7# GLPixelBuffer doesn't support big endian architectures
8testskip_architectures := s390x powerpc
9
10%:
11 dh $@ --parallel --fail-missing
12
13COMMON_CONFIGURE_OPTIONS = \
14 -DCMAKE_INSTALL_LIBEXECDIR="lib/$(DEB_HOST_MULTIARCH)/miral"
15
16override_dh_auto_configure:
17 dh_auto_configure -- $(COMMON_CONFIGURE_OPTIONS)
18
19# Only build the docs when we need them
20override_dh_auto_build-indep:
21 dh_auto_build -- doc
22
23override_dh_auto_test:
24ifneq ($(DEB_HOST_ARCH),$(findstring $(DEB_HOST_ARCH), $(testskip_architectures)))
25 dh_auto_test $@
26endif
027
=== added directory 'debian/tmp'
=== added directory 'doc'
=== renamed directory 'doc' => 'doc.moved'
=== added file 'doc/Doxyfile.in'
--- doc/Doxyfile.in 1970-01-01 00:00:00 +0000
+++ doc/Doxyfile.in 2017-03-01 12:28:42 +0000
@@ -0,0 +1,1926 @@
1# Doxyfile 1.8.4
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed
7# in front of the TAG it is preceding .
8# All text after a hash (#) is considered a comment and will be ignored.
9# The format is:
10# TAG = value [value, ...]
11# For lists items can also be appended using:
12# TAG += value [value, ...]
13# Values that contain spaces should be placed between quotes (" ").
14
15#---------------------------------------------------------------------------
16# Project related configuration options
17#---------------------------------------------------------------------------
18
19# This tag specifies the encoding used for all characters in the config file
20# that follow. The default is UTF-8 which is also the encoding used for all
21# text before the first occurrence of this tag. Doxygen uses libiconv (or the
22# iconv built into libc) for the transcoding. See
23# http://www.gnu.org/software/libiconv for the list of possible encodings.
24
25DOXYFILE_ENCODING = UTF-8
26
27# The PROJECT_NAME tag is a single word (or sequence of words) that should
28# identify the project. Note that if you do not use Doxywizard you need
29# to put quotes around the project name if it contains spaces.
30
31PROJECT_NAME = MirAL
32
33# The PROJECT_NUMBER tag can be used to enter a project or revision number.
34# This could be handy for archiving the generated documentation or
35# if some version control system is used.
36
37PROJECT_NUMBER =
38
39# Using the PROJECT_BRIEF tag one can provide an optional one line description
40# for a project that appears at the top of each page and should give viewer
41# a quick idea about the purpose of the project. Keep the description short.
42
43PROJECT_BRIEF =
44
45# With the PROJECT_LOGO tag one can specify an logo or icon that is
46# included in the documentation. The maximum height of the logo should not
47# exceed 55 pixels and the maximum width should not exceed 200 pixels.
48# Doxygen will copy the logo to the output directory.
49
50PROJECT_LOGO =
51
52# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
53# base path where the generated documentation will be put.
54# If a relative path is entered, it will be relative to the location
55# where doxygen was started. If left blank the current directory will be used.
56
57OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc
58
59# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
60# 4096 sub-directories (in 2 levels) under the output directory of each output
61# format and will distribute the generated files over these directories.
62# Enabling this option can be useful when feeding doxygen a huge amount of
63# source files, where putting all generated files in the same directory would
64# otherwise cause performance problems for the file system.
65
66CREATE_SUBDIRS = NO
67
68# The OUTPUT_LANGUAGE tag is used to specify the language in which all
69# documentation generated by doxygen is written. Doxygen will use this
70# information to generate all constant output in the proper language.
71# The default language is English, other supported languages are:
72# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
73# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
74# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
75# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
76# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
77# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
78
79OUTPUT_LANGUAGE = English
80
81# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
82# include brief member descriptions after the members that are listed in
83# the file and class documentation (similar to JavaDoc).
84# Set to NO to disable this.
85
86BRIEF_MEMBER_DESC = YES
87
88# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89# the brief description of a member or function before the detailed description.
90# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
91# brief descriptions will be completely suppressed.
92
93REPEAT_BRIEF = YES
94
95# This tag implements a quasi-intelligent brief description abbreviator
96# that is used to form the text in various listings. Each string
97# in this list, if found as the leading text of the brief description, will be
98# stripped from the text and the result after processing the whole list, is
99# used as the annotated text. Otherwise, the brief description is used as-is.
100# If left blank, the following values are used ("$name" is automatically
101# replaced with the name of the entity): "The $name class" "The $name widget"
102# "The $name file" "is" "provides" "specifies" "contains"
103# "represents" "a" "an" "the"
104
105ABBREVIATE_BRIEF = "The $name class" \
106 "The $name widget" \
107 "The $name file" \
108 is \
109 provides \
110 specifies \
111 contains \
112 represents \
113 a \
114 an \
115 the
116
117# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
118# Doxygen will generate a detailed section even if there is only a brief
119# description.
120
121ALWAYS_DETAILED_SEC = NO
122
123# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
124# inherited members of a class in the documentation of that class as if those
125# members were ordinary class members. Constructors, destructors and assignment
126# operators of the base classes will not be shown.
127
128INLINE_INHERITED_MEMB = NO
129
130# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
131# path before files name in the file list and in the header files. If set
132# to NO the shortest path that makes the file name unique will be used.
133
134FULL_PATH_NAMES = YES
135
136# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
137# can be used to strip a user-defined part of the path. Stripping is
138# only done if one of the specified strings matches the left-hand part of
139# the path. The tag can be used to show relative paths in the file list.
140# If left blank the directory from which doxygen is run is used as the
141# path to strip. Note that you specify absolute paths here, but also
142# relative paths, which will be relative from the directory where doxygen is
143# started.
144
145STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@
146
147# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
148# the path mentioned in the documentation of a class, which tells
149# the reader which header file to include in order to use a class.
150# If left blank only the name of the header file containing the class
151# definition is used. Otherwise one should specify the include paths that
152# are normally passed to the compiler using the -I flag.
153
154STRIP_FROM_INC_PATH = @CMAKE_CURRENT_SOURCE_DIR@/include
155
156# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
157# (but less readable) file names. This can be useful if your file system
158# doesn't support long names like on DOS, Mac, or CD-ROM.
159
160SHORT_NAMES = NO
161
162# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
163# will interpret the first line (until the first dot) of a JavaDoc-style
164# comment as the brief description. If set to NO, the JavaDoc
165# comments will behave just like regular Qt-style comments
166# (thus requiring an explicit @brief command for a brief description.)
167
168JAVADOC_AUTOBRIEF = YES
169
170# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
171# interpret the first line (until the first dot) of a Qt-style
172# comment as the brief description. If set to NO, the comments
173# will behave just like regular Qt-style comments (thus requiring
174# an explicit \brief command for a brief description.)
175
176QT_AUTOBRIEF = NO
177
178# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
179# treat a multi-line C++ special comment block (i.e. a block of //! or ///
180# comments) as a brief description. This used to be the default behaviour.
181# The new default is to treat a multi-line C++ comment block as a detailed
182# description. Set this tag to YES if you prefer the old behaviour instead.
183
184MULTILINE_CPP_IS_BRIEF = YES
185
186# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
187# member inherits the documentation from any documented member that it
188# re-implements.
189
190INHERIT_DOCS = YES
191
192# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
193# a new page for each member. If set to NO, the documentation of a member will
194# be part of the file/class/namespace that contains it.
195
196SEPARATE_MEMBER_PAGES = NO
197
198# The TAB_SIZE tag can be used to set the number of spaces in a tab.
199# Doxygen uses this value to replace tabs by spaces in code fragments.
200
201TAB_SIZE = 4
202
203# This tag can be used to specify a number of aliases that acts
204# as commands in the documentation. An alias has the form "name=value".
205# For example adding "sideeffect=\par Side Effects:\n" will allow you to
206# put the command \sideeffect (or @sideeffect) in the documentation, which
207# will result in a user-defined paragraph with heading "Side Effects:".
208# You can put \n's in the value part of an alias to insert newlines.
209
210ALIASES =
211
212# This tag can be used to specify a number of word-keyword mappings (TCL only).
213# A mapping has the form "name=value". For example adding
214# "class=itcl::class" will allow you to use the command class in the
215# itcl::class meaning.
216
217TCL_SUBST =
218
219# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
220# sources only. Doxygen will then generate output that is more tailored for C.
221# For instance, some of the names that are used will be different. The list
222# of all members will be omitted, etc.
223
224OPTIMIZE_OUTPUT_FOR_C = NO
225
226# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
227# sources only. Doxygen will then generate output that is more tailored for
228# Java. For instance, namespaces will be presented as packages, qualified
229# scopes will look different, etc.
230
231OPTIMIZE_OUTPUT_JAVA = NO
232
233# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
234# sources only. Doxygen will then generate output that is more tailored for
235# Fortran.
236
237OPTIMIZE_FOR_FORTRAN = NO
238
239# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
240# sources. Doxygen will then generate output that is tailored for
241# VHDL.
242
243OPTIMIZE_OUTPUT_VHDL = NO
244
245# Doxygen selects the parser to use depending on the extension of the files it
246# parses. With this tag you can assign which parser to use for a given
247# extension. Doxygen has a built-in mapping, but you can override or extend it
248# using this tag. The format is ext=language, where ext is a file extension,
249# and language is one of the parsers supported by doxygen: IDL, Java,
250# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
251# C++. For instance to make doxygen treat .inc files as Fortran files (default
252# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
253# that for custom extensions you also need to set FILE_PATTERNS otherwise the
254# files are not read by doxygen.
255
256EXTENSION_MAPPING =
257
258# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
259# comments according to the Markdown format, which allows for more readable
260# documentation. See http://daringfireball.net/projects/markdown/ for details.
261# The output of markdown processing is further processed by doxygen, so you
262# can mix doxygen, HTML, and XML commands with Markdown formatting.
263# Disable only in case of backward compatibilities issues.
264
265MARKDOWN_SUPPORT = YES
266
267# When enabled doxygen tries to link words that correspond to documented
268# classes, or namespaces to their corresponding documentation. Such a link can
269# be prevented in individual cases by by putting a % sign in front of the word
270# or globally by setting AUTOLINK_SUPPORT to NO.
271
272AUTOLINK_SUPPORT = YES
273
274# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
275# to include (a tag file for) the STL sources as input, then you should
276# set this tag to YES in order to let doxygen match functions declarations and
277# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
278# func(std::string) {}). This also makes the inheritance and collaboration
279# diagrams that involve STL classes more complete and accurate.
280
281BUILTIN_STL_SUPPORT = YES
282
283# If you use Microsoft's C++/CLI language, you should set this option to YES to
284# enable parsing support.
285
286CPP_CLI_SUPPORT = NO
287
288# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
289# Doxygen will parse them like normal C++ but will assume all classes use public
290# instead of private inheritance when no explicit protection keyword is present.
291
292SIP_SUPPORT = NO
293
294# For Microsoft's IDL there are propget and propput attributes to indicate
295# getter and setter methods for a property. Setting this option to YES (the
296# default) will make doxygen replace the get and set methods by a property in
297# the documentation. This will only work if the methods are indeed getting or
298# setting a simple type. If this is not the case, or you want to show the
299# methods anyway, you should set this option to NO.
300
301IDL_PROPERTY_SUPPORT = YES
302
303# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
304# tag is set to YES, then doxygen will reuse the documentation of the first
305# member in the group (if any) for the other members of the group. By default
306# all members of a group must be documented explicitly.
307
308DISTRIBUTE_GROUP_DOC = NO
309
310# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
311# the same type (for instance a group of public functions) to be put as a
312# subgroup of that type (e.g. under the Public Functions section). Set it to
313# NO to prevent subgrouping. Alternatively, this can be done per class using
314# the \nosubgrouping command.
315
316SUBGROUPING = YES
317
318# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
319# unions are shown inside the group in which they are included (e.g. using
320# @ingroup) instead of on a separate page (for HTML and Man pages) or
321# section (for LaTeX and RTF).
322
323INLINE_GROUPED_CLASSES = NO
324
325# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
326# unions with only public data fields or simple typedef fields will be shown
327# inline in the documentation of the scope in which they are defined (i.e. file,
328# namespace, or group documentation), provided this scope is documented. If set
329# to NO (the default), structs, classes, and unions are shown on a separate
330# page (for HTML and Man pages) or section (for LaTeX and RTF).
331
332INLINE_SIMPLE_STRUCTS = NO
333
334# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
335# is documented as struct, union, or enum with the name of the typedef. So
336# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
337# with name TypeT. When disabled the typedef will appear as a member of a file,
338# namespace, or class. And the struct will be named TypeS. This can typically
339# be useful for C code in case the coding convention dictates that all compound
340# types are typedef'ed and only the typedef is referenced, never the tag name.
341
342TYPEDEF_HIDES_STRUCT = NO
343
344# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
345# cache is used to resolve symbols given their name and scope. Since this can
346# be an expensive process and often the same symbol appear multiple times in
347# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
348# small doxygen will become slower. If the cache is too large, memory is wasted.
349# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid
350# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536
351# symbols.
352
353LOOKUP_CACHE_SIZE = 0
354
355#---------------------------------------------------------------------------
356# Build related configuration options
357#---------------------------------------------------------------------------
358
359# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
360# documentation are documented, even if no documentation was available.
361# Private class members and static file members will be hidden unless
362# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES
363
364EXTRACT_ALL = YES
365
366# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
367# will be included in the documentation.
368
369EXTRACT_PRIVATE = NO
370
371# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
372# scope will be included in the documentation.
373
374EXTRACT_PACKAGE = NO
375
376# If the EXTRACT_STATIC tag is set to YES all static members of a file
377# will be included in the documentation.
378
379EXTRACT_STATIC = NO
380
381# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
382# defined locally in source files will be included in the documentation.
383# If set to NO only classes defined in header files are included.
384
385EXTRACT_LOCAL_CLASSES = NO
386
387# This flag is only useful for Objective-C code. When set to YES local
388# methods, which are defined in the implementation section but not in
389# the interface are included in the documentation.
390# If set to NO (the default) only methods in the interface are included.
391
392EXTRACT_LOCAL_METHODS = NO
393
394# If this flag is set to YES, the members of anonymous namespaces will be
395# extracted and appear in the documentation as a namespace called
396# 'anonymous_namespace{file}', where file will be replaced with the base
397# name of the file that contains the anonymous namespace. By default
398# anonymous namespaces are hidden.
399
400EXTRACT_ANON_NSPACES = NO
401
402# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
403# undocumented members of documented classes, files or namespaces.
404# If set to NO (the default) these members will be included in the
405# various overviews, but no documentation section is generated.
406# This option has no effect if EXTRACT_ALL is enabled.
407
408HIDE_UNDOC_MEMBERS = NO
409
410# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
411# undocumented classes that are normally visible in the class hierarchy.
412# If set to NO (the default) these classes will be included in the various
413# overviews. This option has no effect if EXTRACT_ALL is enabled.
414
415HIDE_UNDOC_CLASSES = NO
416
417# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
418# friend (class|struct|union) declarations.
419# If set to NO (the default) these declarations will be included in the
420# documentation.
421
422HIDE_FRIEND_COMPOUNDS = NO
423
424# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
425# documentation blocks found inside the body of a function.
426# If set to NO (the default) these blocks will be appended to the
427# function's detailed documentation block.
428
429HIDE_IN_BODY_DOCS = NO
430
431# The INTERNAL_DOCS tag determines if documentation
432# that is typed after a \internal command is included. If the tag is set
433# to NO (the default) then the documentation will be excluded.
434# Set it to YES to include the internal documentation.
435
436INTERNAL_DOCS = NO
437
438# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
439# file names in lower-case letters. If set to YES upper-case letters are also
440# allowed. This is useful if you have classes or files whose names only differ
441# in case and if your file system supports case sensitive file names. Windows
442# and Mac users are advised to set this option to NO.
443
444CASE_SENSE_NAMES = NO
445
446# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
447# will show members with their full class and namespace scopes in the
448# documentation. If set to YES the scope will be hidden.
449
450HIDE_SCOPE_NAMES = NO
451
452# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
453# will put a list of the files that are included by a file in the documentation
454# of that file.
455
456SHOW_INCLUDE_FILES = YES
457
458# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
459# will list include files with double quotes in the documentation
460# rather than with sharp brackets.
461
462FORCE_LOCAL_INCLUDES = NO
463
464# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
465# is inserted in the documentation for inline members.
466
467INLINE_INFO = YES
468
469# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
470# will sort the (detailed) documentation of file and class members
471# alphabetically by member name. If set to NO the members will appear in
472# declaration order.
473
474SORT_MEMBER_DOCS = YES
475
476# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
477# brief documentation of file, namespace and class members alphabetically
478# by member name. If set to NO (the default) the members will appear in
479# declaration order.
480
481SORT_BRIEF_DOCS = NO
482
483# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
484# will sort the (brief and detailed) documentation of class members so that
485# constructors and destructors are listed first. If set to NO (the default)
486# the constructors will appear in the respective orders defined by
487# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
488# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
489# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
490
491SORT_MEMBERS_CTORS_1ST = NO
492
493# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
494# hierarchy of group names into alphabetical order. If set to NO (the default)
495# the group names will appear in their defined order.
496
497SORT_GROUP_NAMES = NO
498
499# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
500# sorted by fully-qualified names, including namespaces. If set to
501# NO (the default), the class list will be sorted only by class name,
502# not including the namespace part.
503# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
504# Note: This option applies only to the class list, not to the
505# alphabetical list.
506
507SORT_BY_SCOPE_NAME = NO
508
509# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
510# do proper type resolution of all parameters of a function it will reject a
511# match between the prototype and the implementation of a member function even
512# if there is only one candidate or it is obvious which candidate to choose
513# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
514# will still accept a match between prototype and implementation in such cases.
515
516STRICT_PROTO_MATCHING = NO
517
518# The GENERATE_TODOLIST tag can be used to enable (YES) or
519# disable (NO) the todo list. This list is created by putting \todo
520# commands in the documentation.
521
522GENERATE_TODOLIST = YES
523
524# The GENERATE_TESTLIST tag can be used to enable (YES) or
525# disable (NO) the test list. This list is created by putting \test
526# commands in the documentation.
527
528GENERATE_TESTLIST = YES
529
530# The GENERATE_BUGLIST tag can be used to enable (YES) or
531# disable (NO) the bug list. This list is created by putting \bug
532# commands in the documentation.
533
534GENERATE_BUGLIST = YES
535
536# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
537# disable (NO) the deprecated list. This list is created by putting
538# \deprecated commands in the documentation.
539
540GENERATE_DEPRECATEDLIST= YES
541
542# The ENABLED_SECTIONS tag can be used to enable conditional
543# documentation sections, marked by \if section-label ... \endif
544# and \cond section-label ... \endcond blocks.
545
546ENABLED_SECTIONS =
547
548# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
549# the initial value of a variable or macro consists of for it to appear in
550# the documentation. If the initializer consists of more lines than specified
551# here it will be hidden. Use a value of 0 to hide initializers completely.
552# The appearance of the initializer of individual variables and macros in the
553# documentation can be controlled using \showinitializer or \hideinitializer
554# command in the documentation regardless of this setting.
555
556MAX_INITIALIZER_LINES = 30
557
558# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
559# at the bottom of the documentation of classes and structs. If set to YES the
560# list will mention the files that were used to generate the documentation.
561
562SHOW_USED_FILES = YES
563
564# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
565# This will remove the Files entry from the Quick Index and from the
566# Folder Tree View (if specified). The default is YES.
567
568SHOW_FILES = YES
569
570# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
571# Namespaces page.
572# This will remove the Namespaces entry from the Quick Index
573# and from the Folder Tree View (if specified). The default is YES.
574
575SHOW_NAMESPACES = YES
576
577# The FILE_VERSION_FILTER tag can be used to specify a program or script that
578# doxygen should invoke to get the current version for each file (typically from
579# the version control system). Doxygen will invoke the program by executing (via
580# popen()) the command <command> <input-file>, where <command> is the value of
581# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
582# provided by doxygen. Whatever the program writes to standard output
583# is used as the file version. See the manual for examples.
584
585FILE_VERSION_FILTER =
586
587# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
588# by doxygen. The layout file controls the global structure of the generated
589# output files in an output format independent way. To create the layout file
590# that represents doxygen's defaults, run doxygen with the -l option.
591# You can optionally specify a file name after the option, if omitted
592# DoxygenLayout.xml will be used as the name of the layout file.
593
594LAYOUT_FILE =
595
596# The CITE_BIB_FILES tag can be used to specify one or more bib files
597# containing the references data. This must be a list of .bib files. The
598# .bib extension is automatically appended if omitted. Using this command
599# requires the bibtex tool to be installed. See also
600# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
601# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
602# feature you need bibtex and perl available in the search path. Do not use
603# file names with spaces, bibtex cannot handle them.
604
605CITE_BIB_FILES =
606
607#---------------------------------------------------------------------------
608# configuration options related to warning and progress messages
609#---------------------------------------------------------------------------
610
611# The QUIET tag can be used to turn on/off the messages that are generated
612# by doxygen. Possible values are YES and NO. If left blank NO is used.
613
614QUIET = NO
615
616# The WARNINGS tag can be used to turn on/off the warning messages that are
617# generated by doxygen. Possible values are YES and NO. If left blank
618# NO is used.
619
620WARNINGS = YES
621
622# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
623# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
624# automatically be disabled.
625
626WARN_IF_UNDOCUMENTED = YES
627
628# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
629# potential errors in the documentation, such as not documenting some
630# parameters in a documented function, or documenting parameters that
631# don't exist or using markup commands wrongly.
632
633WARN_IF_DOC_ERROR = YES
634
635# The WARN_NO_PARAMDOC option can be enabled to get warnings for
636# functions that are documented, but have no documentation for their parameters
637# or return value. If set to NO (the default) doxygen will only warn about
638# wrong or incomplete parameter documentation, but not about the absence of
639# documentation.
640
641WARN_NO_PARAMDOC = NO
642
643# The WARN_FORMAT tag determines the format of the warning messages that
644# doxygen can produce. The string should contain the $file, $line, and $text
645# tags, which will be replaced by the file and line number from which the
646# warning originated and the warning text. Optionally the format may contain
647# $version, which will be replaced by the version of the file (if it could
648# be obtained via FILE_VERSION_FILTER)
649
650WARN_FORMAT = "$file:$line: $text"
651
652# The WARN_LOGFILE tag can be used to specify a file to which warning
653# and error messages should be written. If left blank the output is written
654# to stderr.
655
656WARN_LOGFILE =
657
658#---------------------------------------------------------------------------
659# configuration options related to the input files
660#---------------------------------------------------------------------------
661
662# The INPUT tag can be used to specify the files and/or directories that contain
663# documented source files. You may enter file names like "myfile.cpp" or
664# directories like "/usr/src/myproject". Separate the files or directories
665# with spaces.
666
667INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc \
668 @CMAKE_CURRENT_SOURCE_DIR@/include \
669 @CMAKE_CURRENT_SOURCE_DIR@/getting_and_using_miral.md \
670 @CMAKE_CURRENT_SOURCE_DIR@/tasks_for_the_interested_reader.md
671
672# This tag can be used to specify the character encoding of the source files
673# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
674# also the default input encoding. Doxygen uses libiconv (or the iconv built
675# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
676# the list of possible encodings.
677
678INPUT_ENCODING = UTF-8
679
680# If the value of the INPUT tag contains directories, you can use the
681# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
682# and *.h) to filter out the source-files in the directories. If left
683# blank the following patterns are tested:
684# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
685# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
686# *.f90 *.f *.for *.vhd *.vhdl
687
688FILE_PATTERNS = *.c \
689 *.cc \
690 *.cxx \
691 *.cpp \
692 *.c++ \
693 *.d \
694 *.java \
695 *.ii \
696 *.ixx \
697 *.ipp \
698 *.i++ \
699 *.inl \
700 *.h \
701 *.hh \
702 *.hxx \
703 *.hpp \
704 *.h++ \
705 *.idl \
706 *.odl \
707 *.cs \
708 *.php \
709 *.php3 \
710 *.inc \
711 *.m \
712 *.markdown \
713 *.md \
714 *.mm \
715 *.dox \
716 *.py \
717 *.f90 \
718 *.f \
719 *.for \
720 *.vhd \
721 *.vhdl
722
723# The RECURSIVE tag can be used to turn specify whether or not subdirectories
724# should be searched for input files as well. Possible values are YES and NO.
725# If left blank NO is used.
726
727RECURSIVE = YES
728
729# The EXCLUDE tag can be used to specify files and/or directories that should be
730# excluded from the INPUT source files. This way you can easily exclude a
731# subdirectory from a directory tree whose root is specified with the INPUT tag.
732# Note that relative paths are relative to the directory from which doxygen is
733# run.
734
735EXCLUDE =
736
737# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
738# directories that are symbolic links (a Unix file system feature) are excluded
739# from the input.
740
741EXCLUDE_SYMLINKS = NO
742
743# If the value of the INPUT tag contains directories, you can use the
744# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
745# certain files from those directories. Note that the wildcards are matched
746# against the file with absolute path, so to exclude all test directories
747# for example use the pattern */test/*
748
749EXCLUDE_PATTERNS =
750
751# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
752# (namespaces, classes, functions, etc.) that should be excluded from the
753# output. The symbol name can be a fully qualified name, a word, or if the
754# wildcard * is used, a substring. Examples: ANamespace, AClass,
755# AClass::ANamespace, ANamespace::*Test
756
757EXCLUDE_SYMBOLS = miral::detail \
758 mir::* \
759 mir
760
761# The EXAMPLE_PATH tag can be used to specify one or more files or
762# directories that contain example code fragments that are included (see
763# the \include command).
764
765EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/miral-shell
766
767# If the value of the EXAMPLE_PATH tag contains directories, you can use the
768# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
769# and *.h) to filter out the source-files in the directories. If left
770# blank all files are included.
771
772EXAMPLE_PATTERNS = *
773
774# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
775# searched for input files to be used with the \include or \dontinclude
776# commands irrespective of the value of the RECURSIVE tag.
777# Possible values are YES and NO. If left blank NO is used.
778
779EXAMPLE_RECURSIVE = NO
780
781# The IMAGE_PATH tag can be used to specify one or more files or
782# directories that contain image that are included in the documentation (see
783# the \image command).
784
785IMAGE_PATH =
786
787# The INPUT_FILTER tag can be used to specify a program that doxygen should
788# invoke to filter for each input file. Doxygen will invoke the filter program
789# by executing (via popen()) the command <filter> <input-file>, where <filter>
790# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
791# input file. Doxygen will then use the output that the filter program writes
792# to standard output.
793# If FILTER_PATTERNS is specified, this tag will be ignored.
794# Note that the filter must not add or remove lines; it is applied before the
795# code is scanned, but not when the output code is generated. If lines are added
796# or removed, the anchors will not be placed correctly.
797
798INPUT_FILTER =
799
800# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
801# basis.
802# Doxygen will compare the file name with each pattern and apply the
803# filter if there is a match.
804# The filters are a list of the form:
805# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
806# info on how filters are used. If FILTER_PATTERNS is empty or if
807# non of the patterns match the file name, INPUT_FILTER is applied.
808
809FILTER_PATTERNS =
810
811# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
812# INPUT_FILTER) will be used to filter the input files when producing source
813# files to browse (i.e. when SOURCE_BROWSER is set to YES).
814
815FILTER_SOURCE_FILES = NO
816
817# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
818# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
819# and it is also possible to disable source filtering for a specific pattern
820# using *.ext= (so without naming a filter). This option only has effect when
821# FILTER_SOURCE_FILES is enabled.
822
823FILTER_SOURCE_PATTERNS =
824
825# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
826# is part of the input, its contents will be placed on the main page
827# (index.html). This can be useful if you have a project on for instance GitHub
828# and want reuse the introduction page also for the doxygen output.
829
830USE_MDFILE_AS_MAINPAGE =
831
832#---------------------------------------------------------------------------
833# configuration options related to source browsing
834#---------------------------------------------------------------------------
835
836# If the SOURCE_BROWSER tag is set to YES then a list of source files will
837# be generated. Documented entities will be cross-referenced with these sources.
838# Note: To get rid of all source code in the generated output, make sure also
839# VERBATIM_HEADERS is set to NO.
840
841SOURCE_BROWSER = NO
842
843# Setting the INLINE_SOURCES tag to YES will include the body
844# of functions and classes directly in the documentation.
845
846INLINE_SOURCES = NO
847
848# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
849# doxygen to hide any special comment blocks from generated source code
850# fragments. Normal C, C++ and Fortran comments will always remain visible.
851
852STRIP_CODE_COMMENTS = YES
853
854# If the REFERENCED_BY_RELATION tag is set to YES
855# then for each documented function all documented
856# functions referencing it will be listed.
857
858REFERENCED_BY_RELATION = NO
859
860# If the REFERENCES_RELATION tag is set to YES
861# then for each documented function all documented entities
862# called/used by that function will be listed.
863
864REFERENCES_RELATION = NO
865
866# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
867# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
868# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
869# link to the source code.
870# Otherwise they will link to the documentation.
871
872REFERENCES_LINK_SOURCE = YES
873
874# If the USE_HTAGS tag is set to YES then the references to source code
875# will point to the HTML generated by the htags(1) tool instead of doxygen
876# built-in source browser. The htags tool is part of GNU's global source
877# tagging system (see http://www.gnu.org/software/global/global.html). You
878# will need version 4.8.6 or higher.
879
880USE_HTAGS = NO
881
882# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
883# will generate a verbatim copy of the header file for each class for
884# which an include is specified. Set to NO to disable this.
885
886VERBATIM_HEADERS = YES
887
888#---------------------------------------------------------------------------
889# configuration options related to the alphabetical class index
890#---------------------------------------------------------------------------
891
892# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
893# of all compounds will be generated. Enable this if the project
894# contains a lot of classes, structs, unions or interfaces.
895
896ALPHABETICAL_INDEX = YES
897
898# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
899# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
900# in which this list will be split (can be a number in the range [1..20])
901
902COLS_IN_ALPHA_INDEX = 5
903
904# In case all classes in a project start with a common prefix, all
905# classes will be put under the same header in the alphabetical index.
906# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
907# should be ignored while generating the index headers.
908
909IGNORE_PREFIX =
910
911#---------------------------------------------------------------------------
912# configuration options related to the HTML output
913#---------------------------------------------------------------------------
914
915# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
916# generate HTML output.
917
918GENERATE_HTML = YES
919
920# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
921# If a relative path is entered the value of OUTPUT_DIRECTORY will be
922# put in front of it. If left blank `html' will be used as the default path.
923
924HTML_OUTPUT = html
925
926# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
927# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
928# doxygen will generate files with .html extension.
929
930HTML_FILE_EXTENSION = .html
931
932# The HTML_HEADER tag can be used to specify a personal HTML header for
933# each generated HTML page. If it is left blank doxygen will generate a
934# standard header. Note that when using a custom header you are responsible
935# for the proper inclusion of any scripts and style sheets that doxygen
936# needs, which is dependent on the configuration options used.
937# It is advised to generate a default header using "doxygen -w html
938# header.html footer.html stylesheet.css YourConfigFile" and then modify
939# that header. Note that the header is subject to change so you typically
940# have to redo this when upgrading to a newer version of doxygen or when
941# changing the value of configuration settings such as GENERATE_TREEVIEW!
942
943HTML_HEADER =
944
945# The HTML_FOOTER tag can be used to specify a personal HTML footer for
946# each generated HTML page. If it is left blank doxygen will generate a
947# standard footer.
948
949HTML_FOOTER = @CMAKE_BINARY_DIR@/doc/footer.html
950
951# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
952# style sheet that is used by each HTML page. It can be used to
953# fine-tune the look of the HTML output. If left blank doxygen will
954# generate a default style sheet. Note that it is recommended to use
955# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
956# tag will in the future become obsolete.
957
958HTML_STYLESHEET =
959
960# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
961# user-defined cascading style sheet that is included after the standard
962# style sheets created by doxygen. Using this option one can overrule
963# certain style aspects. This is preferred over using HTML_STYLESHEET
964# since it does not replace the standard style sheet and is therefor more
965# robust against future updates. Doxygen will copy the style sheet file to
966# the output directory.
967
968HTML_EXTRA_STYLESHEET = @CMAKE_BINARY_DIR@/doc/extra.css
969
970# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
971# other source files which should be copied to the HTML output directory. Note
972# that these files will be copied to the base HTML output directory. Use the
973# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
974# files. In the HTML_STYLESHEET file, use the file name only. Also note that
975# the files will be copied as-is; there are no commands or markers available.
976
977HTML_EXTRA_FILES =
978
979# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
980# Doxygen will adjust the colors in the style sheet and background images
981# according to this color. Hue is specified as an angle on a colorwheel,
982# see http://en.wikipedia.org/wiki/Hue for more information.
983# For instance the value 0 represents red, 60 is yellow, 120 is green,
984# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
985# The allowed range is 0 to 359.
986
987HTML_COLORSTYLE_HUE = 16
988
989# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
990# the colors in the HTML output. For a value of 0 the output will use
991# grayscales only. A value of 255 will produce the most vivid colors.
992
993HTML_COLORSTYLE_SAT = 240
994
995# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
996# the luminance component of the colors in the HTML output. Values below
997# 100 gradually make the output lighter, whereas values above 100 make
998# the output darker. The value divided by 100 is the actual gamma applied,
999# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1000# and 100 does not change the gamma.
1001
1002HTML_COLORSTYLE_GAMMA = 80
1003
1004# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1005# page will contain the date and time when the page was generated. Setting
1006# this to NO can help when comparing the output of multiple runs.
1007
1008HTML_TIMESTAMP = YES
1009
1010# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1011# documentation will contain sections that can be hidden and shown after the
1012# page has loaded.
1013
1014HTML_DYNAMIC_SECTIONS = NO
1015
1016# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1017# entries shown in the various tree structured indices initially; the user
1018# can expand and collapse entries dynamically later on. Doxygen will expand
1019# the tree to such a level that at most the specified number of entries are
1020# visible (unless a fully collapsed tree already exceeds this amount).
1021# So setting the number of entries 1 will produce a full collapsed tree by
1022# default. 0 is a special value representing an infinite number of entries
1023# and will result in a full expanded tree by default.
1024
1025HTML_INDEX_NUM_ENTRIES = 100
1026
1027# If the GENERATE_DOCSET tag is set to YES, additional index files
1028# will be generated that can be used as input for Apple's Xcode 3
1029# integrated development environment, introduced with OSX 10.5 (Leopard).
1030# To create a documentation set, doxygen will generate a Makefile in the
1031# HTML output directory. Running make will produce the docset in that
1032# directory and running "make install" will install the docset in
1033# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1034# it at startup.
1035# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1036# for more information.
1037
1038GENERATE_DOCSET = NO
1039
1040# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1041# feed. A documentation feed provides an umbrella under which multiple
1042# documentation sets from a single provider (such as a company or product suite)
1043# can be grouped.
1044
1045DOCSET_FEEDNAME = "Doxygen generated docs"
1046
1047# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1048# should uniquely identify the documentation set bundle. This should be a
1049# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1050# will append .docset to the name.
1051
1052DOCSET_BUNDLE_ID = org.doxygen.Project
1053
1054# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1055# identify the documentation publisher. This should be a reverse domain-name
1056# style string, e.g. com.mycompany.MyDocSet.documentation.
1057
1058DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1059
1060# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1061
1062DOCSET_PUBLISHER_NAME = Publisher
1063
1064# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1065# will be generated that can be used as input for tools like the
1066# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1067# of the generated HTML documentation.
1068
1069GENERATE_HTMLHELP = NO
1070
1071# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1072# be used to specify the file name of the resulting .chm file. You
1073# can add a path in front of the file if the result should not be
1074# written to the html output directory.
1075
1076CHM_FILE =
1077
1078# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1079# be used to specify the location (absolute path including file name) of
1080# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1081# the HTML help compiler on the generated index.hhp.
1082
1083HHC_LOCATION =
1084
1085# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1086# controls if a separate .chi index file is generated (YES) or that
1087# it should be included in the master .chm file (NO).
1088
1089GENERATE_CHI = NO
1090
1091# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1092# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1093# content.
1094
1095CHM_INDEX_ENCODING =
1096
1097# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1098# controls whether a binary table of contents is generated (YES) or a
1099# normal table of contents (NO) in the .chm file.
1100
1101BINARY_TOC = NO
1102
1103# The TOC_EXPAND flag can be set to YES to add extra items for group members
1104# to the contents of the HTML help documentation and to the tree view.
1105
1106TOC_EXPAND = NO
1107
1108# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1109# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1110# that can be used as input for Qt's qhelpgenerator to generate a
1111# Qt Compressed Help (.qch) of the generated HTML documentation.
1112
1113GENERATE_QHP = NO
1114
1115# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1116# be used to specify the file name of the resulting .qch file.
1117# The path specified is relative to the HTML output folder.
1118
1119QCH_FILE =
1120
1121# The QHP_NAMESPACE tag specifies the namespace to use when generating
1122# Qt Help Project output. For more information please see
1123# http://doc.trolltech.com/qthelpproject.html#namespace
1124
1125QHP_NAMESPACE = org.doxygen.Project
1126
1127# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1128# Qt Help Project output. For more information please see
1129# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1130
1131QHP_VIRTUAL_FOLDER = doc
1132
1133# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1134# add. For more information please see
1135# http://doc.trolltech.com/qthelpproject.html#custom-filters
1136
1137QHP_CUST_FILTER_NAME =
1138
1139# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1140# custom filter to add. For more information please see
1141# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1142# Qt Help Project / Custom Filters</a>.
1143
1144QHP_CUST_FILTER_ATTRS =
1145
1146# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1147# project's
1148# filter section matches.
1149# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1150# Qt Help Project / Filter Attributes</a>.
1151
1152QHP_SECT_FILTER_ATTRS =
1153
1154# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1155# be used to specify the location of Qt's qhelpgenerator.
1156# If non-empty doxygen will try to run qhelpgenerator on the generated
1157# .qhp file.
1158
1159QHG_LOCATION =
1160
1161# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1162# will be generated, which together with the HTML files, form an Eclipse help
1163# plugin. To install this plugin and make it available under the help contents
1164# menu in Eclipse, the contents of the directory containing the HTML and XML
1165# files needs to be copied into the plugins directory of eclipse. The name of
1166# the directory within the plugins directory should be the same as
1167# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1168# the help appears.
1169
1170GENERATE_ECLIPSEHELP = NO
1171
1172# A unique identifier for the eclipse help plugin. When installing the plugin
1173# the directory name containing the HTML and XML files should also have
1174# this name.
1175
1176ECLIPSE_DOC_ID = org.doxygen.Project
1177
1178# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1179# at top of each HTML page. The value NO (the default) enables the index and
1180# the value YES disables it. Since the tabs have the same information as the
1181# navigation tree you can set this option to NO if you already set
1182# GENERATE_TREEVIEW to YES.
1183
1184DISABLE_INDEX = NO
1185
1186# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1187# structure should be generated to display hierarchical information.
1188# If the tag value is set to YES, a side panel will be generated
1189# containing a tree-like index structure (just like the one that
1190# is generated for HTML Help). For this to work a browser that supports
1191# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1192# Windows users are probably better off using the HTML help feature.
1193# Since the tree basically has the same information as the tab index you
1194# could consider to set DISABLE_INDEX to NO when enabling this option.
1195
1196GENERATE_TREEVIEW = NO
1197
1198# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1199# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1200# documentation. Note that a value of 0 will completely suppress the enum
1201# values from appearing in the overview section.
1202
1203ENUM_VALUES_PER_LINE = 4
1204
1205# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1206# used to set the initial width (in pixels) of the frame in which the tree
1207# is shown.
1208
1209TREEVIEW_WIDTH = 250
1210
1211# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1212# links to external symbols imported via tag files in a separate window.
1213
1214EXT_LINKS_IN_WINDOW = NO
1215
1216# Use this tag to change the font size of Latex formulas included
1217# as images in the HTML documentation. The default is 10. Note that
1218# when you change the font size after a successful doxygen run you need
1219# to manually remove any form_*.png images from the HTML output directory
1220# to force them to be regenerated.
1221
1222FORMULA_FONTSIZE = 10
1223
1224# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1225# generated for formulas are transparent PNGs. Transparent PNGs are
1226# not supported properly for IE 6.0, but are supported on all modern browsers.
1227# Note that when changing this option you need to delete any form_*.png files
1228# in the HTML output before the changes have effect.
1229
1230FORMULA_TRANSPARENT = YES
1231
1232# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1233# (see http://www.mathjax.org) which uses client side Javascript for the
1234# rendering instead of using prerendered bitmaps. Use this if you do not
1235# have LaTeX installed or if you want to formulas look prettier in the HTML
1236# output. When enabled you may also need to install MathJax separately and
1237# configure the path to it using the MATHJAX_RELPATH option.
1238
1239USE_MATHJAX = NO
1240
1241# When MathJax is enabled you can set the default output format to be used for
1242# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1243# SVG. The default value is HTML-CSS, which is slower, but has the best
1244# compatibility.
1245
1246MATHJAX_FORMAT = HTML-CSS
1247
1248# When MathJax is enabled you need to specify the location relative to the
1249# HTML output directory using the MATHJAX_RELPATH option. The destination
1250# directory should contain the MathJax.js script. For instance, if the mathjax
1251# directory is located at the same level as the HTML output directory, then
1252# MATHJAX_RELPATH should be ../mathjax. The default value points to
1253# the MathJax Content Delivery Network so you can quickly see the result without
1254# installing MathJax.
1255# However, it is strongly recommended to install a local
1256# copy of MathJax from http://www.mathjax.org before deployment.
1257
1258MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1259
1260# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1261# names that should be enabled during MathJax rendering.
1262
1263MATHJAX_EXTENSIONS =
1264
1265# The MATHJAX_CODEFILE tag can be used to specify a file with javascript
1266# pieces of code that will be used on startup of the MathJax code.
1267
1268MATHJAX_CODEFILE =
1269
1270# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1271# for the HTML output. The underlying search engine uses javascript
1272# and DHTML and should work on any modern browser. Note that when using
1273# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1274# (GENERATE_DOCSET) there is already a search function so this one should
1275# typically be disabled. For large projects the javascript based search engine
1276# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1277
1278SEARCHENGINE = YES
1279
1280# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1281# implemented using a web server instead of a web client using Javascript.
1282# There are two flavours of web server based search depending on the
1283# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1284# searching and an index file used by the script. When EXTERNAL_SEARCH is
1285# enabled the indexing and searching needs to be provided by external tools.
1286# See the manual for details.
1287
1288SERVER_BASED_SEARCH = NO
1289
1290# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1291# script for searching. Instead the search results are written to an XML file
1292# which needs to be processed by an external indexer. Doxygen will invoke an
1293# external search engine pointed to by the SEARCHENGINE_URL option to obtain
1294# the search results. Doxygen ships with an example indexer (doxyindexer) and
1295# search engine (doxysearch.cgi) which are based on the open source search
1296# engine library Xapian. See the manual for configuration details.
1297
1298EXTERNAL_SEARCH = NO
1299
1300# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1301# which will returned the search results when EXTERNAL_SEARCH is enabled.
1302# Doxygen ships with an example search engine (doxysearch) which is based on
1303# the open source search engine library Xapian. See the manual for configuration
1304# details.
1305
1306SEARCHENGINE_URL =
1307
1308# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1309# search data is written to a file for indexing by an external tool. With the
1310# SEARCHDATA_FILE tag the name of this file can be specified.
1311
1312SEARCHDATA_FILE = searchdata.xml
1313
1314# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
1315# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1316# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1317# projects and redirect the results back to the right project.
1318
1319EXTERNAL_SEARCH_ID =
1320
1321# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1322# projects other than the one defined by this configuration file, but that are
1323# all added to the same external search index. Each project needs to have a
1324# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
1325# of to a relative location where the documentation can be found.
1326# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
1327
1328EXTRA_SEARCH_MAPPINGS =
1329
1330#---------------------------------------------------------------------------
1331# configuration options related to the LaTeX output
1332#---------------------------------------------------------------------------
1333
1334# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1335# generate Latex output.
1336
1337GENERATE_LATEX = NO
1338
1339# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1340# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1341# put in front of it. If left blank `latex' will be used as the default path.
1342
1343LATEX_OUTPUT = latex
1344
1345# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1346# invoked. If left blank `latex' will be used as the default command name.
1347# Note that when enabling USE_PDFLATEX this option is only used for
1348# generating bitmaps for formulas in the HTML output, but not in the
1349# Makefile that is written to the output directory.
1350
1351LATEX_CMD_NAME = latex
1352
1353# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1354# generate index for LaTeX. If left blank `makeindex' will be used as the
1355# default command name.
1356
1357MAKEINDEX_CMD_NAME = makeindex
1358
1359# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1360# LaTeX documents. This may be useful for small projects and may help to
1361# save some trees in general.
1362
1363COMPACT_LATEX = NO
1364
1365# The PAPER_TYPE tag can be used to set the paper type that is used
1366# by the printer. Possible values are: a4, letter, legal and
1367# executive. If left blank a4 will be used.
1368
1369PAPER_TYPE = a4
1370
1371# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1372# packages that should be included in the LaTeX output.
1373
1374EXTRA_PACKAGES =
1375
1376# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1377# the generated latex document. The header should contain everything until
1378# the first chapter. If it is left blank doxygen will generate a
1379# standard header. Notice: only use this tag if you know what you are doing!
1380
1381LATEX_HEADER =
1382
1383# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1384# the generated latex document. The footer should contain everything after
1385# the last chapter. If it is left blank doxygen will generate a
1386# standard footer. Notice: only use this tag if you know what you are doing!
1387
1388LATEX_FOOTER =
1389
1390# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
1391# or other source files which should be copied to the LaTeX output directory.
1392# Note that the files will be copied as-is; there are no commands or markers
1393# available.
1394
1395LATEX_EXTRA_FILES =
1396
1397# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1398# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1399# contain links (just like the HTML output) instead of page references
1400# This makes the output suitable for online browsing using a pdf viewer.
1401
1402PDF_HYPERLINKS = YES
1403
1404# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1405# plain latex in the generated Makefile. Set this option to YES to get a
1406# higher quality PDF documentation.
1407
1408USE_PDFLATEX = YES
1409
1410# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1411# command to the generated LaTeX files. This will instruct LaTeX to keep
1412# running if errors occur, instead of asking the user for help.
1413# This option is also used when generating formulas in HTML.
1414
1415LATEX_BATCHMODE = NO
1416
1417# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1418# include the index chapters (such as File Index, Compound Index, etc.)
1419# in the output.
1420
1421LATEX_HIDE_INDICES = NO
1422
1423# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1424# source code with syntax highlighting in the LaTeX output.
1425# Note that which sources are shown also depends on other settings
1426# such as SOURCE_BROWSER.
1427
1428LATEX_SOURCE_CODE = NO
1429
1430# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1431# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1432# http://en.wikipedia.org/wiki/BibTeX for more info.
1433
1434LATEX_BIB_STYLE = plain
1435
1436#---------------------------------------------------------------------------
1437# configuration options related to the RTF output
1438#---------------------------------------------------------------------------
1439
1440# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1441# The RTF output is optimized for Word 97 and may not look very pretty with
1442# other RTF readers or editors.
1443
1444GENERATE_RTF = NO
1445
1446# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1447# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1448# put in front of it. If left blank `rtf' will be used as the default path.
1449
1450RTF_OUTPUT = rtf
1451
1452# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1453# RTF documents. This may be useful for small projects and may help to
1454# save some trees in general.
1455
1456COMPACT_RTF = NO
1457
1458# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1459# will contain hyperlink fields. The RTF file will
1460# contain links (just like the HTML output) instead of page references.
1461# This makes the output suitable for online browsing using WORD or other
1462# programs which support those fields.
1463# Note: wordpad (write) and others do not support links.
1464
1465RTF_HYPERLINKS = NO
1466
1467# Load style sheet definitions from file. Syntax is similar to doxygen's
1468# config file, i.e. a series of assignments. You only have to provide
1469# replacements, missing definitions are set to their default value.
1470
1471RTF_STYLESHEET_FILE =
1472
1473# Set optional variables used in the generation of an rtf document.
1474# Syntax is similar to doxygen's config file.
1475
1476RTF_EXTENSIONS_FILE =
1477
1478#---------------------------------------------------------------------------
1479# configuration options related to the man page output
1480#---------------------------------------------------------------------------
1481
1482# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1483# generate man pages
1484
1485GENERATE_MAN = NO
1486
1487# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1488# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1489# put in front of it. If left blank `man' will be used as the default path.
1490
1491MAN_OUTPUT = man
1492
1493# The MAN_EXTENSION tag determines the extension that is added to
1494# the generated man pages (default is the subroutine's section .3)
1495
1496MAN_EXTENSION = .3
1497
1498# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1499# then it will generate one additional man file for each entity
1500# documented in the real man page(s). These additional files
1501# only source the real man page, but without them the man command
1502# would be unable to find the correct page. The default is NO.
1503
1504MAN_LINKS = NO
1505
1506#---------------------------------------------------------------------------
1507# configuration options related to the XML output
1508#---------------------------------------------------------------------------
1509
1510# If the GENERATE_XML tag is set to YES Doxygen will
1511# generate an XML file that captures the structure of
1512# the code including all documentation.
1513
1514GENERATE_XML = YES
1515
1516# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1517# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1518# put in front of it. If left blank `xml' will be used as the default path.
1519
1520XML_OUTPUT = xml
1521
1522# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1523# dump the program listings (including syntax highlighting
1524# and cross-referencing information) to the XML output. Note that
1525# enabling this will significantly increase the size of the XML output.
1526
1527XML_PROGRAMLISTING = YES
1528
1529#---------------------------------------------------------------------------
1530# configuration options related to the DOCBOOK output
1531#---------------------------------------------------------------------------
1532
1533# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
1534# that can be used to generate PDF.
1535
1536GENERATE_DOCBOOK = NO
1537
1538# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
1539# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1540# front of it. If left blank docbook will be used as the default path.
1541
1542DOCBOOK_OUTPUT = docbook
1543
1544#---------------------------------------------------------------------------
1545# configuration options for the AutoGen Definitions output
1546#---------------------------------------------------------------------------
1547
1548# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1549# generate an AutoGen Definitions (see autogen.sf.net) file
1550# that captures the structure of the code including all
1551# documentation. Note that this feature is still experimental
1552# and incomplete at the moment.
1553
1554GENERATE_AUTOGEN_DEF = NO
1555
1556#---------------------------------------------------------------------------
1557# configuration options related to the Perl module output
1558#---------------------------------------------------------------------------
1559
1560# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1561# generate a Perl module file that captures the structure of
1562# the code including all documentation. Note that this
1563# feature is still experimental and incomplete at the
1564# moment.
1565
1566GENERATE_PERLMOD = NO
1567
1568# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1569# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1570# to generate PDF and DVI output from the Perl module output.
1571
1572PERLMOD_LATEX = NO
1573
1574# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1575# nicely formatted so it can be parsed by a human reader.
1576# This is useful
1577# if you want to understand what is going on.
1578# On the other hand, if this
1579# tag is set to NO the size of the Perl module output will be much smaller
1580# and Perl will parse it just the same.
1581
1582PERLMOD_PRETTY = YES
1583
1584# The names of the make variables in the generated doxyrules.make file
1585# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1586# This is useful so different doxyrules.make files included by the same
1587# Makefile don't overwrite each other's variables.
1588
1589PERLMOD_MAKEVAR_PREFIX =
1590
1591#---------------------------------------------------------------------------
1592# Configuration options related to the preprocessor
1593#---------------------------------------------------------------------------
1594
1595# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1596# evaluate all C-preprocessor directives found in the sources and include
1597# files.
1598
1599ENABLE_PREPROCESSING = YES
1600
1601# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1602# names in the source code. If set to NO (the default) only conditional
1603# compilation will be performed. Macro expansion can be done in a controlled
1604# way by setting EXPAND_ONLY_PREDEF to YES.
1605
1606MACRO_EXPANSION = NO
1607
1608# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1609# then the macro expansion is limited to the macros specified with the
1610# PREDEFINED and EXPAND_AS_DEFINED tags.
1611
1612EXPAND_ONLY_PREDEF = NO
1613
1614# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1615# pointed to by INCLUDE_PATH will be searched when a #include is found.
1616
1617SEARCH_INCLUDES = YES
1618
1619# The INCLUDE_PATH tag can be used to specify one or more directories that
1620# contain include files that are not input files but should be processed by
1621# the preprocessor.
1622
1623INCLUDE_PATH =
1624
1625# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1626# patterns (like *.h and *.hpp) to filter out the header-files in the
1627# directories. If left blank, the patterns specified with FILE_PATTERNS will
1628# be used.
1629
1630INCLUDE_FILE_PATTERNS =
1631
1632# The PREDEFINED tag can be used to specify one or more macro names that
1633# are defined before the preprocessor is started (similar to the -D option of
1634# gcc). The argument of the tag is a list of macros of the form: name
1635# or name=definition (no spaces). If the definition and the = are
1636# omitted =1 is assumed. To prevent a macro definition from being
1637# undefined via #undef or recursively expanded use the := operator
1638# instead of the = operator.
1639
1640PREDEFINED = __cplusplus
1641
1642# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1643# this tag can be used to specify a list of macro names that should be expanded.
1644# The macro definition that is found in the sources will be used.
1645# Use the PREDEFINED tag if you want to use a different macro definition that
1646# overrules the definition found in the source code.
1647
1648EXPAND_AS_DEFINED =
1649
1650# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1651# doxygen's preprocessor will remove all references to function-like macros
1652# that are alone on a line, have an all uppercase name, and do not end with a
1653# semicolon, because these will confuse the parser if not removed.
1654
1655SKIP_FUNCTION_MACROS = YES
1656
1657#---------------------------------------------------------------------------
1658# Configuration::additions related to external references
1659#---------------------------------------------------------------------------
1660
1661# The TAGFILES option can be used to specify one or more tagfiles. For each
1662# tag file the location of the external documentation should be added. The
1663# format of a tag file without this location is as follows:
1664#
1665# TAGFILES = file1 file2 ...
1666# Adding location for the tag files is done as follows:
1667#
1668# TAGFILES = file1=loc1 "file2 = loc2" ...
1669# where "loc1" and "loc2" can be relative or absolute paths
1670# or URLs. Note that each tag file must have a unique name (where the name does
1671# NOT include the path). If a tag file is not located in the directory in which
1672# doxygen is run, you must also specify the path to the tagfile here.
1673
1674TAGFILES =
1675
1676# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1677# a tag file that is based on the input files it reads.
1678
1679GENERATE_TAGFILE =
1680
1681# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1682# in the class index. If set to NO only the inherited external classes
1683# will be listed.
1684
1685ALLEXTERNALS = NO
1686
1687# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1688# in the modules index. If set to NO, only the current project's groups will
1689# be listed.
1690
1691EXTERNAL_GROUPS = YES
1692
1693# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
1694# in the related pages index. If set to NO, only the current project's
1695# pages will be listed.
1696
1697EXTERNAL_PAGES = YES
1698
1699# The PERL_PATH should be the absolute path and name of the perl script
1700# interpreter (i.e. the result of `which perl').
1701
1702PERL_PATH = /usr/bin/perl
1703
1704#---------------------------------------------------------------------------
1705# Configuration options related to the dot tool
1706#---------------------------------------------------------------------------
1707
1708# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1709# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1710# or super classes. Setting the tag to NO turns the diagrams off. Note that
1711# this option also works with HAVE_DOT disabled, but it is recommended to
1712# install and use dot, since it yields more powerful graphs.
1713
1714CLASS_DIAGRAMS = YES
1715
1716# You can define message sequence charts within doxygen comments using the \msc
1717# command. Doxygen will then run the mscgen tool (see
1718# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1719# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1720# the mscgen tool resides. If left empty the tool is assumed to be found in the
1721# default search path.
1722
1723MSCGEN_PATH =
1724
1725# If set to YES, the inheritance and collaboration graphs will hide
1726# inheritance and usage relations if the target is undocumented
1727# or is not a class.
1728
1729HIDE_UNDOC_RELATIONS = YES
1730
1731# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1732# available from the path. This tool is part of Graphviz, a graph visualization
1733# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1734# have no effect if this option is set to NO (the default)
1735
1736HAVE_DOT = @DOXYGEN_DOT_FOUND@
1737
1738# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1739# allowed to run in parallel. When set to 0 (the default) doxygen will
1740# base this on the number of processors available in the system. You can set it
1741# explicitly to a value larger than 0 to get control over the balance
1742# between CPU load and processing speed.
1743