Merge lp:~saviq/unity/phablet.drop-unity-api into lp:unity/phablet
- phablet.drop-unity-api
- Merge into phablet
Status: | Merged |
---|---|
Approved by: | Michael Zanetti |
Approved revision: | no longer in the source branch. |
Merged at revision: | 730 |
Proposed branch: | lp:~saviq/unity/phablet.drop-unity-api |
Merge into: | lp:unity/phablet |
Diff against target: |
7762 lines (+0/-7328) 67 files modified
CMakeLists.txt (+0/-63) CTestCustom.cmake.in (+0/-16) debian/control (+0/-25) debian/libunity-api-dev.install (+0/-3) debian/libunity-api-doc.install (+0/-1) debian/libunity-api.install (+0/-1) doc/Doxyfile.in (+0/-1826) include/CMakeLists.txt (+0/-4) include/unity/CMakeLists.txt (+0/-10) include/unity/Exception.h (+0/-158) include/unity/UnityExceptions.h (+0/-258) include/unity/api/CMakeLists.txt (+0/-12) include/unity/api/Version.h.in (+0/-103) include/unity/config.h (+0/-30) include/unity/internal/ExceptionImpl.h (+0/-60) include/unity/internal/UnityExceptionsImpl.h (+0/-95) include/unity/scopes/CMakeLists.txt (+0/-6) include/unity/util/CMakeLists.txt (+0/-6) include/unity/util/Daemon.h (+0/-129) include/unity/util/DefinesPtrs.h (+0/-89) include/unity/util/FileIO.h (+0/-40) include/unity/util/NonCopyable.h (+0/-89) include/unity/util/internal/DaemonImpl.h (+0/-67) include/unity/util/internal/ResourcePtr.h (+0/-793) src/CMakeLists.txt (+0/-14) src/libunity-api.pc.in (+0/-23) src/unity/CMakeLists.txt (+0/-10) src/unity/Exception.cpp (+0/-145) src/unity/UnityExceptions.cpp (+0/-246) src/unity/api/CMakeLists.txt (+0/-8) src/unity/api/Version.cpp (+0/-59) src/unity/api/internal/CMakeLists.txt (+0/-4) src/unity/api/scopes/CMakeLists.txt (+0/-6) src/unity/api/scopes/internal/CMakeLists.txt (+0/-4) src/unity/internal/CMakeLists.txt (+0/-6) src/unity/internal/ExceptionImpl.cpp (+0/-244) src/unity/internal/UnityExceptionsImpl.cpp (+0/-126) src/unity/util/CMakeLists.txt (+0/-8) src/unity/util/Daemon.cpp (+0/-89) src/unity/util/FileIO.cpp (+0/-106) src/unity/util/internal/CMakeLists.txt (+0/-5) src/unity/util/internal/DaemonImpl.cpp (+0/-271) tests/CMakeLists.txt (+0/-3) tests/cleanincludes/CMakeLists.txt (+0/-2) tests/cleanincludes/includechecker.py (+0/-74) tests/gtest/CMakeLists.txt (+0/-18) tests/gtest/libgtest/CMakeLists.txt (+0/-13) tests/gtest/unity/CMakeLists.txt (+0/-8) tests/gtest/unity/Exceptions_test.cpp (+0/-536) tests/gtest/unity/api/CMakeLists.txt (+0/-1) tests/gtest/unity/api/Version/CMakeLists.txt (+0/-4) tests/gtest/unity/api/Version/Version_test.cpp (+0/-31) tests/gtest/unity/util/CMakeLists.txt (+0/-4) tests/gtest/unity/util/Daemon/CMakeLists.txt (+0/-4) tests/gtest/unity/util/Daemon/Daemon_test.cpp (+0/-353) tests/gtest/unity/util/Daemon/daemon-tester.py (+0/-57) tests/gtest/unity/util/DefinesPtrs/CMakeLists.txt (+0/-4) tests/gtest/unity/util/DefinesPtrs/DefinesPtrs_test.cpp (+0/-45) tests/gtest/unity/util/FileIO/CMakeLists.txt (+0/-4) tests/gtest/unity/util/FileIO/FileIO_test.cpp (+0/-71) tests/gtest/unity/util/internal/CMakeLists.txt (+0/-1) tests/gtest/unity/util/internal/ResourcePtr/CMakeLists.txt (+0/-4) tests/gtest/unity/util/internal/ResourcePtr/ResourcePtr_test.cpp (+0/-529) tests/headers/CMakeLists.txt (+0/-34) tests/headers/check_public_headers.py (+0/-99) tests/headers/compile_headers.py (+0/-158) valgrind-suppress (+0/-13) |
To merge this branch: | bzr merge lp:~saviq/unity/phablet.drop-unity-api |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Michael Zanetti (community) | Approve | ||
PS Jenkins bot (community) | continuous-integration | Approve | |
Review via email: mp+166019@code.launchpad.net |
Commit message
drop unity-api parts that have been split away to lp:unity-api
Description of the change
The unity-api parts were split away to lp:unity-api.
PS Jenkins bot (ps-jenkins) wrote : | # |
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:698
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:699
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:700
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild:
http://
Michael Zanetti (mzanetti) wrote : | # |
looks good to me and makes it saucy :)
Preview Diff
1 | === modified file 'CMakeLists.txt' | |||
2 | --- CMakeLists.txt 2013-05-28 09:06:22 +0000 | |||
3 | +++ CMakeLists.txt 2013-06-04 09:01:26 +0000 | |||
4 | @@ -47,29 +47,11 @@ | |||
5 | 47 | add_custom_target(cppcheck COMMAND cppcheck --enable=all -q --error-exitcode=2 | 47 | add_custom_target(cppcheck COMMAND cppcheck --enable=all -q --error-exitcode=2 |
6 | 48 | ${CMAKE_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/tests) | 48 | ${CMAKE_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/tests) |
7 | 49 | 49 | ||
8 | 50 | # | ||
9 | 51 | # Definitions for testing with valgrind. | ||
10 | 52 | # | ||
11 | 53 | |||
12 | 54 | configure_file(CTestCustom.cmake.in CTestCustom.cmake) # Tests in CTestCustom.cmake are skipped for valgrind | ||
13 | 55 | |||
14 | 56 | find_program(MEMORYCHECK_COMMAND NAMES valgrind) | ||
15 | 57 | if (MEMORYCHECK_COMMAND) | ||
16 | 58 | set(MEMORYCHECK_COMMAND_OPTIONS | ||
17 | 59 | "--suppressions=${CMAKE_SOURCE_DIR}/valgrind-suppress --leak-check=full --num-callers=40 --error-exitcode=3" | ||
18 | 60 | ) | ||
19 | 61 | add_custom_target(valgrind DEPENDS NightlyMemCheck) | ||
20 | 62 | else() | ||
21 | 63 | message(WARNING "Cannot find valgrind: valgrind target will not be available") | ||
22 | 64 | endif() | ||
23 | 65 | |||
24 | 66 | |||
25 | 67 | include(FindPkgConfig) | 50 | include(FindPkgConfig) |
26 | 68 | find_package(Qt5Qml) | 51 | find_package(Qt5Qml) |
27 | 69 | find_package(Qt5Quick) | 52 | find_package(Qt5Quick) |
28 | 70 | find_package(Qt5Gui) | 53 | find_package(Qt5Gui) |
29 | 71 | find_package(Qt5DBus) | 54 | find_package(Qt5DBus) |
30 | 72 | find_package(Boost 1.49.0 COMPONENTS regex REQUIRED) | ||
31 | 73 | 55 | ||
32 | 74 | # Standard install paths | 56 | # Standard install paths |
33 | 75 | include(GNUInstallDirs) | 57 | include(GNUInstallDirs) |
34 | @@ -80,17 +62,10 @@ | |||
35 | 80 | 62 | ||
36 | 81 | include_directories( | 63 | include_directories( |
37 | 82 | ${CMAKE_CURRENT_BINARY_DIR} | 64 | ${CMAKE_CURRENT_BINARY_DIR} |
38 | 83 | ${CMAKE_CURRENT_BINARY_DIR}/include | ||
39 | 84 | ${CMAKE_CURRENT_SOURCE_DIR} | 65 | ${CMAKE_CURRENT_SOURCE_DIR} |
40 | 85 | ${CMAKE_CURRENT_SOURCE_DIR}/include | ||
41 | 86 | ${Qt5Gui_PRIVATE_INCLUDE_DIRS} | 66 | ${Qt5Gui_PRIVATE_INCLUDE_DIRS} |
42 | 87 | ) | 67 | ) |
43 | 88 | 68 | ||
44 | 89 | # When building the library, we set the default symbol visibility | ||
45 | 90 | # to "hidden", so we don't export things by default. | ||
46 | 91 | # Exported functions and classes are prefixed by a UNITY_API macro, | ||
47 | 92 | # which explicitly exports a symbol if UNITY_DLL_EXPORTS is defined. | ||
48 | 93 | add_definitions(-DUNITY_DLL_EXPORTS) | ||
49 | 94 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") | 69 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") |
50 | 95 | 70 | ||
51 | 96 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fno-permissive -pedantic -Wall -Wextra") | 71 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fno-permissive -pedantic -Wall -Wextra") |
52 | @@ -109,21 +84,6 @@ | |||
53 | 109 | # "signals" and "slots" | 84 | # "signals" and "slots" |
54 | 110 | add_definitions(-DQT_NO_KEYWORDS) | 85 | add_definitions(-DQT_NO_KEYWORDS) |
55 | 111 | 86 | ||
56 | 112 | # API version | ||
57 | 113 | set(UNITY_API_MAJOR 0) | ||
58 | 114 | set(UNITY_API_MINOR 1) | ||
59 | 115 | set(UNITY_API_MICRO 0) | ||
60 | 116 | set(UNITY_API_VERSION "${UNITY_API_MAJOR}.${UNITY_API_MINOR}.${UNITY_API_MICRO}") | ||
61 | 117 | |||
62 | 118 | # API library | ||
63 | 119 | set(UNITY_API_LIB unity-api) | ||
64 | 120 | |||
65 | 121 | # Other libraries we depend on | ||
66 | 122 | set(OTHER_API_LIBS ) | ||
67 | 123 | |||
68 | 124 | # All the libraries we need to link a normal executable that uses the Unity API | ||
69 | 125 | set(LIBS ${UNITY_API_LIB} ${OTHER_API_LIBS}) | ||
70 | 126 | |||
71 | 127 | # Tests | 87 | # Tests |
72 | 128 | include(CTest) | 88 | include(CTest) |
73 | 129 | enable_testing() | 89 | enable_testing() |
74 | @@ -171,9 +131,7 @@ | |||
75 | 171 | ) | 131 | ) |
76 | 172 | 132 | ||
77 | 173 | # add subdirectories to build | 133 | # add subdirectories to build |
78 | 174 | add_subdirectory(include) | ||
79 | 175 | add_subdirectory(plugins) | 134 | add_subdirectory(plugins) |
80 | 176 | add_subdirectory(src) | ||
81 | 177 | 135 | ||
82 | 178 | # install subdirectories | 136 | # install subdirectories |
83 | 179 | set(QML_DIRS | 137 | set(QML_DIRS |
84 | @@ -203,27 +161,6 @@ | |||
85 | 203 | ) | 161 | ) |
86 | 204 | 162 | ||
87 | 205 | # | 163 | # |
88 | 206 | # Documentation | ||
89 | 207 | # | ||
90 | 208 | |||
91 | 209 | find_package(Doxygen) | ||
92 | 210 | find_program(DOT_EXECUTABLE dot /usr/bin) | ||
93 | 211 | if (NOT DOXYGEN_FOUND OR NOT DOT_EXECUTABLE) | ||
94 | 212 | message(WARNING "Cannot generate documentation: doxygen and/or graphviz not found") | ||
95 | 213 | else() | ||
96 | 214 | configure_file(${PROJECT_SOURCE_DIR}/doc/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY IMMEDIATE) | ||
97 | 215 | add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB}/index.html | ||
98 | 216 | COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile | ||
99 | 217 | DEPENDS ${PROJECT_BINARY_DIR}/doc/Doxyfile | ||
100 | 218 | ${UNITY_API_LIB_SRC} | ||
101 | 219 | ${UNITY_API_LIB_HDRS}) | ||
102 | 220 | add_custom_target(doc ALL | ||
103 | 221 | DEPENDS ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB}/index.html) | ||
104 | 222 | install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/lib${UNITY_API_LIB} | ||
105 | 223 | DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc) | ||
106 | 224 | endif() | ||
107 | 225 | |||
108 | 226 | # | ||
109 | 227 | # Translation | 164 | # Translation |
110 | 228 | # | 165 | # |
111 | 229 | add_subdirectory(po) | 166 | add_subdirectory(po) |
112 | 230 | 167 | ||
113 | === removed file 'CTestCustom.cmake.in' | |||
114 | --- CTestCustom.cmake.in 2013-04-16 02:37:02 +0000 | |||
115 | +++ CTestCustom.cmake.in 1970-01-01 00:00:00 +0000 | |||
116 | @@ -1,16 +0,0 @@ | |||
117 | 1 | # | ||
118 | 2 | # Tests listed here will not be run by the valgrind target. | ||
119 | 3 | # | ||
120 | 4 | |||
121 | 5 | SET(CTEST_CUSTOM_MEMCHECK_IGNORE | ||
122 | 6 | cleanincludes | ||
123 | 7 | testAnimationControllerWithSignals | ||
124 | 8 | testCarousel | ||
125 | 9 | testClock | ||
126 | 10 | testCrossFadeImage | ||
127 | 11 | testIndicatorItem | ||
128 | 12 | testMathLocal | ||
129 | 13 | testRatingStars | ||
130 | 14 | testSideStage | ||
131 | 15 | testTimeLocal | ||
132 | 16 | whitespace) | ||
133 | 17 | 0 | ||
134 | === modified file 'debian/control' | |||
135 | --- debian/control 2013-05-31 00:55:24 +0000 | |||
136 | +++ debian/control 2013-06-04 09:01:26 +0000 | |||
137 | @@ -4,16 +4,11 @@ | |||
138 | 4 | Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com> | 4 | Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com> |
139 | 5 | Build-Depends: cmake, | 5 | Build-Depends: cmake, |
140 | 6 | debhelper (>= 9), | 6 | debhelper (>= 9), |
141 | 7 | doxygen, | ||
142 | 8 | graphviz, | ||
143 | 9 | libboost-regex1.49-dev (>= 1.49), | ||
144 | 10 | libboost1.49-dev (>= 1.49), | ||
145 | 11 | libc6-dev, | 7 | libc6-dev, |
146 | 12 | libdee-qt5-dev (>= 3.0), | 8 | libdee-qt5-dev (>= 3.0), |
147 | 13 | libgl1-mesa-dev[!armhf] | libgl-dev[!armhf], | 9 | libgl1-mesa-dev[!armhf] | libgl-dev[!armhf], |
148 | 14 | libgl1-mesa-dri, | 10 | libgl1-mesa-dri, |
149 | 15 | libgles2-mesa-dev[armhf], | 11 | libgles2-mesa-dev[armhf], |
150 | 16 | libgtest-dev, | ||
151 | 17 | libhud-client2-dev, | 12 | libhud-client2-dev, |
152 | 18 | libpulse-dev, | 13 | libpulse-dev, |
153 | 19 | libunity-core-6.0-dev, | 14 | libunity-core-6.0-dev, |
154 | @@ -74,23 +69,3 @@ | |||
155 | 74 | ${shlibs:Depends}, | 69 | ${shlibs:Depends}, |
156 | 75 | Description: Test package for the shell | 70 | Description: Test package for the shell |
157 | 76 | Autopilot tests for the qml-phone-shell package | 71 | Autopilot tests for the qml-phone-shell package |
158 | 77 | |||
159 | 78 | Package: libunity-api | ||
160 | 79 | Architecture: all | ||
161 | 80 | Depends: ${misc:Depends}, ${shlibs:Depends} | ||
162 | 81 | Description: API for shell integration | ||
163 | 82 | Library to integrate with the Unity shell | ||
164 | 83 | |||
165 | 84 | Package: libunity-api-dev | ||
166 | 85 | Architecture: all | ||
167 | 86 | Depends: libboost1.49-dev (>= 1.49), | ||
168 | 87 | libunity-api (= ${binary:Version}), | ||
169 | 88 | ${misc:Depends}, | ||
170 | 89 | Description: Header files for Unity API | ||
171 | 90 | Library to integrate with the Unity shell (dev files) | ||
172 | 91 | |||
173 | 92 | Package: libunity-api-doc | ||
174 | 93 | Architecture: all | ||
175 | 94 | Depends: ${misc:Depends} | ||
176 | 95 | Description: Documentation for Unity API | ||
177 | 96 | Library to integrate with the Unity shell (documentation) | ||
178 | 97 | 72 | ||
179 | === removed file 'debian/libunity-api-dev.install' | |||
180 | --- debian/libunity-api-dev.install 2013-04-19 01:18:29 +0000 | |||
181 | +++ debian/libunity-api-dev.install 1970-01-01 00:00:00 +0000 | |||
182 | @@ -1,3 +0,0 @@ | |||
183 | 1 | usr/include/unity/* | ||
184 | 2 | usr/lib/libunity-api.so | ||
185 | 3 | usr/lib/pkgconfig/libunity-api.pc | ||
186 | 4 | 0 | ||
187 | === removed file 'debian/libunity-api-doc.install' | |||
188 | --- debian/libunity-api-doc.install 2013-04-19 01:18:29 +0000 | |||
189 | +++ debian/libunity-api-doc.install 1970-01-01 00:00:00 +0000 | |||
190 | @@ -1,1 +0,0 @@ | |||
191 | 1 | usr/share/doc/libunity-api/* | ||
192 | 2 | 0 | ||
193 | === removed file 'debian/libunity-api.install' | |||
194 | --- debian/libunity-api.install 2013-04-09 03:34:17 +0000 | |||
195 | +++ debian/libunity-api.install 1970-01-01 00:00:00 +0000 | |||
196 | @@ -1,1 +0,0 @@ | |||
197 | 1 | usr/lib/libunity-api.so.* | ||
198 | 2 | 0 | ||
199 | === removed file 'doc/Doxyfile.in' | |||
200 | --- doc/Doxyfile.in 2013-04-19 01:05:08 +0000 | |||
201 | +++ doc/Doxyfile.in 1970-01-01 00:00:00 +0000 | |||
202 | @@ -1,1826 +0,0 @@ | |||
203 | 1 | # Doxyfile 1.8.1.2 | ||
204 | 2 | |||
205 | 3 | # This file describes the settings to be used by the documentation system | ||
206 | 4 | # doxygen (www.doxygen.org) for a project | ||
207 | 5 | # | ||
208 | 6 | # All text after a hash (#) is considered a comment and will be ignored | ||
209 | 7 | # The format is: | ||
210 | 8 | # TAG = value [value, ...] | ||
211 | 9 | # For lists items can also be appended using: | ||
212 | 10 | # TAG += value [value, ...] | ||
213 | 11 | # Values that contain spaces should be placed between quotes (" ") | ||
214 | 12 | |||
215 | 13 | #--------------------------------------------------------------------------- | ||
216 | 14 | # Project related configuration options | ||
217 | 15 | #--------------------------------------------------------------------------- | ||
218 | 16 | |||
219 | 17 | # This tag specifies the encoding used for all characters in the config file | ||
220 | 18 | # that follow. The default is UTF-8 which is also the encoding used for all | ||
221 | 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | ||
222 | 20 | # iconv built into libc) for the transcoding. See | ||
223 | 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. | ||
224 | 22 | |||
225 | 23 | DOXYFILE_ENCODING = UTF-8 | ||
226 | 24 | |||
227 | 25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should | ||
228 | 26 | # identify the project. Note that if you do not use Doxywizard you need | ||
229 | 27 | # to put quotes around the project name if it contains spaces. | ||
230 | 28 | |||
231 | 29 | PROJECT_NAME = "My Project" | ||
232 | 30 | |||
233 | 31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. | ||
234 | 32 | # This could be handy for archiving the generated documentation or | ||
235 | 33 | # if some version control system is used. | ||
236 | 34 | |||
237 | 35 | PROJECT_NUMBER = | ||
238 | 36 | |||
239 | 37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description | ||
240 | 38 | # for a project that appears at the top of each page and should give viewer | ||
241 | 39 | # a quick idea about the purpose of the project. Keep the description short. | ||
242 | 40 | |||
243 | 41 | PROJECT_BRIEF = | ||
244 | 42 | |||
245 | 43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is | ||
246 | 44 | # included in the documentation. The maximum height of the logo should not | ||
247 | 45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels. | ||
248 | 46 | # Doxygen will copy the logo to the output directory. | ||
249 | 47 | |||
250 | 48 | PROJECT_LOGO = | ||
251 | 49 | |||
252 | 50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | ||
253 | 51 | # base path where the generated documentation will be put. | ||
254 | 52 | # If a relative path is entered, it will be relative to the location | ||
255 | 53 | # where doxygen was started. If left blank the current directory will be used. | ||
256 | 54 | |||
257 | 55 | OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc | ||
258 | 56 | |||
259 | 57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | ||
260 | 58 | # 4096 sub-directories (in 2 levels) under the output directory of each output | ||
261 | 59 | # format and will distribute the generated files over these directories. | ||
262 | 60 | # Enabling this option can be useful when feeding doxygen a huge amount of | ||
263 | 61 | # source files, where putting all generated files in the same directory would | ||
264 | 62 | # otherwise cause performance problems for the file system. | ||
265 | 63 | |||
266 | 64 | CREATE_SUBDIRS = NO | ||
267 | 65 | |||
268 | 66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | ||
269 | 67 | # documentation generated by doxygen is written. Doxygen will use this | ||
270 | 68 | # information to generate all constant output in the proper language. | ||
271 | 69 | # The default language is English, other supported languages are: | ||
272 | 70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | ||
273 | 71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, | ||
274 | 72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | ||
275 | 73 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | ||
276 | 74 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, | ||
277 | 75 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | ||
278 | 76 | |||
279 | 77 | OUTPUT_LANGUAGE = English | ||
280 | 78 | |||
281 | 79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | ||
282 | 80 | # include brief member descriptions after the members that are listed in | ||
283 | 81 | # the file and class documentation (similar to JavaDoc). | ||
284 | 82 | # Set to NO to disable this. | ||
285 | 83 | |||
286 | 84 | BRIEF_MEMBER_DESC = YES | ||
287 | 85 | |||
288 | 86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | ||
289 | 87 | # the brief description of a member or function before the detailed description. | ||
290 | 88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||
291 | 89 | # brief descriptions will be completely suppressed. | ||
292 | 90 | |||
293 | 91 | REPEAT_BRIEF = YES | ||
294 | 92 | |||
295 | 93 | # This tag implements a quasi-intelligent brief description abbreviator | ||
296 | 94 | # that is used to form the text in various listings. Each string | ||
297 | 95 | # in this list, if found as the leading text of the brief description, will be | ||
298 | 96 | # stripped from the text and the result after processing the whole list, is | ||
299 | 97 | # used as the annotated text. Otherwise, the brief description is used as-is. | ||
300 | 98 | # If left blank, the following values are used ("$name" is automatically | ||
301 | 99 | # replaced with the name of the entity): "The $name class" "The $name widget" | ||
302 | 100 | # "The $name file" "is" "provides" "specifies" "contains" | ||
303 | 101 | # "represents" "a" "an" "the" | ||
304 | 102 | |||
305 | 103 | ABBREVIATE_BRIEF = "The $name class" \ | ||
306 | 104 | "The $name widget" \ | ||
307 | 105 | "The $name file" \ | ||
308 | 106 | is \ | ||
309 | 107 | provides \ | ||
310 | 108 | specifies \ | ||
311 | 109 | contains \ | ||
312 | 110 | represents \ | ||
313 | 111 | a \ | ||
314 | 112 | an \ | ||
315 | 113 | the | ||
316 | 114 | |||
317 | 115 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
318 | 116 | # Doxygen will generate a detailed section even if there is only a brief | ||
319 | 117 | # description. | ||
320 | 118 | |||
321 | 119 | ALWAYS_DETAILED_SEC = NO | ||
322 | 120 | |||
323 | 121 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | ||
324 | 122 | # inherited members of a class in the documentation of that class as if those | ||
325 | 123 | # members were ordinary class members. Constructors, destructors and assignment | ||
326 | 124 | # operators of the base classes will not be shown. | ||
327 | 125 | |||
328 | 126 | INLINE_INHERITED_MEMB = NO | ||
329 | 127 | |||
330 | 128 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | ||
331 | 129 | # path before files name in the file list and in the header files. If set | ||
332 | 130 | # to NO the shortest path that makes the file name unique will be used. | ||
333 | 131 | |||
334 | 132 | FULL_PATH_NAMES = YES | ||
335 | 133 | |||
336 | 134 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | ||
337 | 135 | # can be used to strip a user-defined part of the path. Stripping is | ||
338 | 136 | # only done if one of the specified strings matches the left-hand part of | ||
339 | 137 | # the path. The tag can be used to show relative paths in the file list. | ||
340 | 138 | # If left blank the directory from which doxygen is run is used as the | ||
341 | 139 | # path to strip. | ||
342 | 140 | |||
343 | 141 | STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@ | ||
344 | 142 | |||
345 | 143 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | ||
346 | 144 | # the path mentioned in the documentation of a class, which tells | ||
347 | 145 | # the reader which header file to include in order to use a class. | ||
348 | 146 | # If left blank only the name of the header file containing the class | ||
349 | 147 | # definition is used. Otherwise one should specify the include paths that | ||
350 | 148 | # are normally passed to the compiler using the -I flag. | ||
351 | 149 | |||
352 | 150 | STRIP_FROM_INC_PATH = @PROJECT_SOURCE_DIR@/include @PROJECT_BINARY_DIR@/include | ||
353 | 151 | |||
354 | 152 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | ||
355 | 153 | # (but less readable) file names. This can be useful if your file system | ||
356 | 154 | # doesn't support long names like on DOS, Mac, or CD-ROM. | ||
357 | 155 | |||
358 | 156 | SHORT_NAMES = NO | ||
359 | 157 | |||
360 | 158 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | ||
361 | 159 | # will interpret the first line (until the first dot) of a JavaDoc-style | ||
362 | 160 | # comment as the brief description. If set to NO, the JavaDoc | ||
363 | 161 | # comments will behave just like regular Qt-style comments | ||
364 | 162 | # (thus requiring an explicit @brief command for a brief description.) | ||
365 | 163 | |||
366 | 164 | JAVADOC_AUTOBRIEF = NO | ||
367 | 165 | |||
368 | 166 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will | ||
369 | 167 | # interpret the first line (until the first dot) of a Qt-style | ||
370 | 168 | # comment as the brief description. If set to NO, the comments | ||
371 | 169 | # will behave just like regular Qt-style comments (thus requiring | ||
372 | 170 | # an explicit \brief command for a brief description.) | ||
373 | 171 | |||
374 | 172 | QT_AUTOBRIEF = NO | ||
375 | 173 | |||
376 | 174 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | ||
377 | 175 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | ||
378 | 176 | # comments) as a brief description. This used to be the default behaviour. | ||
379 | 177 | # The new default is to treat a multi-line C++ comment block as a detailed | ||
380 | 178 | # description. Set this tag to YES if you prefer the old behaviour instead. | ||
381 | 179 | |||
382 | 180 | MULTILINE_CPP_IS_BRIEF = NO | ||
383 | 181 | |||
384 | 182 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | ||
385 | 183 | # member inherits the documentation from any documented member that it | ||
386 | 184 | # re-implements. | ||
387 | 185 | |||
388 | 186 | INHERIT_DOCS = YES | ||
389 | 187 | |||
390 | 188 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | ||
391 | 189 | # a new page for each member. If set to NO, the documentation of a member will | ||
392 | 190 | # be part of the file/class/namespace that contains it. | ||
393 | 191 | |||
394 | 192 | SEPARATE_MEMBER_PAGES = NO | ||
395 | 193 | |||
396 | 194 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | ||
397 | 195 | # Doxygen uses this value to replace tabs by spaces in code fragments. | ||
398 | 196 | |||
399 | 197 | TAB_SIZE = 8 | ||
400 | 198 | |||
401 | 199 | # This tag can be used to specify a number of aliases that acts | ||
402 | 200 | # as commands in the documentation. An alias has the form "name=value". | ||
403 | 201 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | ||
404 | 202 | # put the command \sideeffect (or @sideeffect) in the documentation, which | ||
405 | 203 | # will result in a user-defined paragraph with heading "Side Effects:". | ||
406 | 204 | # You can put \n's in the value part of an alias to insert newlines. | ||
407 | 205 | |||
408 | 206 | ALIASES = | ||
409 | 207 | |||
410 | 208 | # This tag can be used to specify a number of word-keyword mappings (TCL only). | ||
411 | 209 | # A mapping has the form "name=value". For example adding | ||
412 | 210 | # "class=itcl::class" will allow you to use the command class in the | ||
413 | 211 | # itcl::class meaning. | ||
414 | 212 | |||
415 | 213 | TCL_SUBST = | ||
416 | 214 | |||
417 | 215 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C | ||
418 | 216 | # sources only. Doxygen will then generate output that is more tailored for C. | ||
419 | 217 | # For instance, some of the names that are used will be different. The list | ||
420 | 218 | # of all members will be omitted, etc. | ||
421 | 219 | |||
422 | 220 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
423 | 221 | |||
424 | 222 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java | ||
425 | 223 | # sources only. Doxygen will then generate output that is more tailored for | ||
426 | 224 | # Java. For instance, namespaces will be presented as packages, qualified | ||
427 | 225 | # scopes will look different, etc. | ||
428 | 226 | |||
429 | 227 | OPTIMIZE_OUTPUT_JAVA = NO | ||
430 | 228 | |||
431 | 229 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | ||
432 | 230 | # sources only. Doxygen will then generate output that is more tailored for | ||
433 | 231 | # Fortran. | ||
434 | 232 | |||
435 | 233 | OPTIMIZE_FOR_FORTRAN = NO | ||
436 | 234 | |||
437 | 235 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | ||
438 | 236 | # sources. Doxygen will then generate output that is tailored for | ||
439 | 237 | # VHDL. | ||
440 | 238 | |||
441 | 239 | OPTIMIZE_OUTPUT_VHDL = NO | ||
442 | 240 | |||
443 | 241 | # Doxygen selects the parser to use depending on the extension of the files it | ||
444 | 242 | # parses. With this tag you can assign which parser to use for a given extension. | ||
445 | 243 | # Doxygen has a built-in mapping, but you can override or extend it using this | ||
446 | 244 | # tag. The format is ext=language, where ext is a file extension, and language | ||
447 | 245 | # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, | ||
448 | 246 | # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make | ||
449 | 247 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C | ||
450 | 248 | # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions | ||
451 | 249 | # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. | ||
452 | 250 | |||
453 | 251 | EXTENSION_MAPPING = | ||
454 | 252 | |||
455 | 253 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all | ||
456 | 254 | # comments according to the Markdown format, which allows for more readable | ||
457 | 255 | # documentation. See http://daringfireball.net/projects/markdown/ for details. | ||
458 | 256 | # The output of markdown processing is further processed by doxygen, so you | ||
459 | 257 | # can mix doxygen, HTML, and XML commands with Markdown formatting. | ||
460 | 258 | # Disable only in case of backward compatibilities issues. | ||
461 | 259 | |||
462 | 260 | MARKDOWN_SUPPORT = YES | ||
463 | 261 | |||
464 | 262 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | ||
465 | 263 | # to include (a tag file for) the STL sources as input, then you should | ||
466 | 264 | # set this tag to YES in order to let doxygen match functions declarations and | ||
467 | 265 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | ||
468 | 266 | # func(std::string) {}). This also makes the inheritance and collaboration | ||
469 | 267 | # diagrams that involve STL classes more complete and accurate. | ||
470 | 268 | |||
471 | 269 | BUILTIN_STL_SUPPORT = NO | ||
472 | 270 | |||
473 | 271 | # If you use Microsoft's C++/CLI language, you should set this option to YES to | ||
474 | 272 | # enable parsing support. | ||
475 | 273 | |||
476 | 274 | CPP_CLI_SUPPORT = NO | ||
477 | 275 | |||
478 | 276 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | ||
479 | 277 | # Doxygen will parse them like normal C++ but will assume all classes use public | ||
480 | 278 | # instead of private inheritance when no explicit protection keyword is present. | ||
481 | 279 | |||
482 | 280 | SIP_SUPPORT = NO | ||
483 | 281 | |||
484 | 282 | # For Microsoft's IDL there are propget and propput attributes to indicate getter | ||
485 | 283 | # and setter methods for a property. Setting this option to YES (the default) | ||
486 | 284 | # will make doxygen replace the get and set methods by a property in the | ||
487 | 285 | # documentation. This will only work if the methods are indeed getting or | ||
488 | 286 | # setting a simple type. If this is not the case, or you want to show the | ||
489 | 287 | # methods anyway, you should set this option to NO. | ||
490 | 288 | |||
491 | 289 | IDL_PROPERTY_SUPPORT = YES | ||
492 | 290 | |||
493 | 291 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
494 | 292 | # tag is set to YES, then doxygen will reuse the documentation of the first | ||
495 | 293 | # member in the group (if any) for the other members of the group. By default | ||
496 | 294 | # all members of a group must be documented explicitly. | ||
497 | 295 | |||
498 | 296 | DISTRIBUTE_GROUP_DOC = NO | ||
499 | 297 | |||
500 | 298 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | ||
501 | 299 | # the same type (for instance a group of public functions) to be put as a | ||
502 | 300 | # subgroup of that type (e.g. under the Public Functions section). Set it to | ||
503 | 301 | # NO to prevent subgrouping. Alternatively, this can be done per class using | ||
504 | 302 | # the \nosubgrouping command. | ||
505 | 303 | |||
506 | 304 | SUBGROUPING = YES | ||
507 | 305 | |||
508 | 306 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and | ||
509 | 307 | # unions are shown inside the group in which they are included (e.g. using | ||
510 | 308 | # @ingroup) instead of on a separate page (for HTML and Man pages) or | ||
511 | 309 | # section (for LaTeX and RTF). | ||
512 | 310 | |||
513 | 311 | INLINE_GROUPED_CLASSES = NO | ||
514 | 312 | |||
515 | 313 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and | ||
516 | 314 | # unions with only public data fields will be shown inline in the documentation | ||
517 | 315 | # of the scope in which they are defined (i.e. file, namespace, or group | ||
518 | 316 | # documentation), provided this scope is documented. If set to NO (the default), | ||
519 | 317 | # structs, classes, and unions are shown on a separate page (for HTML and Man | ||
520 | 318 | # pages) or section (for LaTeX and RTF). | ||
521 | 319 | |||
522 | 320 | INLINE_SIMPLE_STRUCTS = NO | ||
523 | 321 | |||
524 | 322 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | ||
525 | 323 | # is documented as struct, union, or enum with the name of the typedef. So | ||
526 | 324 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
527 | 325 | # with name TypeT. When disabled the typedef will appear as a member of a file, | ||
528 | 326 | # namespace, or class. And the struct will be named TypeS. This can typically | ||
529 | 327 | # be useful for C code in case the coding convention dictates that all compound | ||
530 | 328 | # types are typedef'ed and only the typedef is referenced, never the tag name. | ||
531 | 329 | |||
532 | 330 | TYPEDEF_HIDES_STRUCT = NO | ||
533 | 331 | |||
534 | 332 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | ||
535 | 333 | # determine which symbols to keep in memory and which to flush to disk. | ||
536 | 334 | # When the cache is full, less often used symbols will be written to disk. | ||
537 | 335 | # For small to medium size projects (<1000 input files) the default value is | ||
538 | 336 | # probably good enough. For larger projects a too small cache size can cause | ||
539 | 337 | # doxygen to be busy swapping symbols to and from disk most of the time | ||
540 | 338 | # causing a significant performance penalty. | ||
541 | 339 | # If the system has enough physical memory increasing the cache will improve the | ||
542 | 340 | # performance by keeping more symbols in memory. Note that the value works on | ||
543 | 341 | # a logarithmic scale so increasing the size by one will roughly double the | ||
544 | 342 | # memory usage. The cache size is given by this formula: | ||
545 | 343 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||
546 | 344 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||
547 | 345 | |||
548 | 346 | SYMBOL_CACHE_SIZE = 0 | ||
549 | 347 | |||
550 | 348 | # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be | ||
551 | 349 | # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given | ||
552 | 350 | # their name and scope. Since this can be an expensive process and often the | ||
553 | 351 | # same symbol appear multiple times in the code, doxygen keeps a cache of | ||
554 | 352 | # pre-resolved symbols. If the cache is too small doxygen will become slower. | ||
555 | 353 | # If the cache is too large, memory is wasted. The cache size is given by this | ||
556 | 354 | # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||
557 | 355 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||
558 | 356 | |||
559 | 357 | LOOKUP_CACHE_SIZE = 0 | ||
560 | 358 | |||
561 | 359 | #--------------------------------------------------------------------------- | ||
562 | 360 | # Build related configuration options | ||
563 | 361 | #--------------------------------------------------------------------------- | ||
564 | 362 | |||
565 | 363 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | ||
566 | 364 | # documentation are documented, even if no documentation was available. | ||
567 | 365 | # Private class members and static file members will be hidden unless | ||
568 | 366 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | ||
569 | 367 | |||
570 | 368 | EXTRACT_ALL = NO | ||
571 | 369 | |||
572 | 370 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | ||
573 | 371 | # will be included in the documentation. | ||
574 | 372 | |||
575 | 373 | EXTRACT_PRIVATE = NO | ||
576 | 374 | |||
577 | 375 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal | ||
578 | 376 | # scope will be included in the documentation. | ||
579 | 377 | |||
580 | 378 | EXTRACT_PACKAGE = NO | ||
581 | 379 | |||
582 | 380 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | ||
583 | 381 | # will be included in the documentation. | ||
584 | 382 | |||
585 | 383 | EXTRACT_STATIC = NO | ||
586 | 384 | |||
587 | 385 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | ||
588 | 386 | # defined locally in source files will be included in the documentation. | ||
589 | 387 | # If set to NO only classes defined in header files are included. | ||
590 | 388 | |||
591 | 389 | EXTRACT_LOCAL_CLASSES = YES | ||
592 | 390 | |||
593 | 391 | # This flag is only useful for Objective-C code. When set to YES local | ||
594 | 392 | # methods, which are defined in the implementation section but not in | ||
595 | 393 | # the interface are included in the documentation. | ||
596 | 394 | # If set to NO (the default) only methods in the interface are included. | ||
597 | 395 | |||
598 | 396 | EXTRACT_LOCAL_METHODS = NO | ||
599 | 397 | |||
600 | 398 | # If this flag is set to YES, the members of anonymous namespaces will be | ||
601 | 399 | # extracted and appear in the documentation as a namespace called | ||
602 | 400 | # 'anonymous_namespace{file}', where file will be replaced with the base | ||
603 | 401 | # name of the file that contains the anonymous namespace. By default | ||
604 | 402 | # anonymous namespaces are hidden. | ||
605 | 403 | |||
606 | 404 | EXTRACT_ANON_NSPACES = NO | ||
607 | 405 | |||
608 | 406 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | ||
609 | 407 | # undocumented members of documented classes, files or namespaces. | ||
610 | 408 | # If set to NO (the default) these members will be included in the | ||
611 | 409 | # various overviews, but no documentation section is generated. | ||
612 | 410 | # This option has no effect if EXTRACT_ALL is enabled. | ||
613 | 411 | |||
614 | 412 | HIDE_UNDOC_MEMBERS = NO | ||
615 | 413 | |||
616 | 414 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | ||
617 | 415 | # undocumented classes that are normally visible in the class hierarchy. | ||
618 | 416 | # If set to NO (the default) these classes will be included in the various | ||
619 | 417 | # overviews. This option has no effect if EXTRACT_ALL is enabled. | ||
620 | 418 | |||
621 | 419 | HIDE_UNDOC_CLASSES = NO | ||
622 | 420 | |||
623 | 421 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | ||
624 | 422 | # friend (class|struct|union) declarations. | ||
625 | 423 | # If set to NO (the default) these declarations will be included in the | ||
626 | 424 | # documentation. | ||
627 | 425 | |||
628 | 426 | HIDE_FRIEND_COMPOUNDS = NO | ||
629 | 427 | |||
630 | 428 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | ||
631 | 429 | # documentation blocks found inside the body of a function. | ||
632 | 430 | # If set to NO (the default) these blocks will be appended to the | ||
633 | 431 | # function's detailed documentation block. | ||
634 | 432 | |||
635 | 433 | HIDE_IN_BODY_DOCS = NO | ||
636 | 434 | |||
637 | 435 | # The INTERNAL_DOCS tag determines if documentation | ||
638 | 436 | # that is typed after a \internal command is included. If the tag is set | ||
639 | 437 | # to NO (the default) then the documentation will be excluded. | ||
640 | 438 | # Set it to YES to include the internal documentation. | ||
641 | 439 | |||
642 | 440 | INTERNAL_DOCS = NO | ||
643 | 441 | |||
644 | 442 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | ||
645 | 443 | # file names in lower-case letters. If set to YES upper-case letters are also | ||
646 | 444 | # allowed. This is useful if you have classes or files whose names only differ | ||
647 | 445 | # in case and if your file system supports case sensitive file names. Windows | ||
648 | 446 | # and Mac users are advised to set this option to NO. | ||
649 | 447 | |||
650 | 448 | CASE_SENSE_NAMES = NO | ||
651 | 449 | |||
652 | 450 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | ||
653 | 451 | # will show members with their full class and namespace scopes in the | ||
654 | 452 | # documentation. If set to YES the scope will be hidden. | ||
655 | 453 | |||
656 | 454 | HIDE_SCOPE_NAMES = NO | ||
657 | 455 | |||
658 | 456 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | ||
659 | 457 | # will put a list of the files that are included by a file in the documentation | ||
660 | 458 | # of that file. | ||
661 | 459 | |||
662 | 460 | SHOW_INCLUDE_FILES = YES | ||
663 | 461 | |||
664 | 462 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen | ||
665 | 463 | # will list include files with double quotes in the documentation | ||
666 | 464 | # rather than with sharp brackets. | ||
667 | 465 | |||
668 | 466 | FORCE_LOCAL_INCLUDES = NO | ||
669 | 467 | |||
670 | 468 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | ||
671 | 469 | # is inserted in the documentation for inline members. | ||
672 | 470 | |||
673 | 471 | INLINE_INFO = YES | ||
674 | 472 | |||
675 | 473 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | ||
676 | 474 | # will sort the (detailed) documentation of file and class members | ||
677 | 475 | # alphabetically by member name. If set to NO the members will appear in | ||
678 | 476 | # declaration order. | ||
679 | 477 | |||
680 | 478 | SORT_MEMBER_DOCS = YES | ||
681 | 479 | |||
682 | 480 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | ||
683 | 481 | # brief documentation of file, namespace and class members alphabetically | ||
684 | 482 | # by member name. If set to NO (the default) the members will appear in | ||
685 | 483 | # declaration order. | ||
686 | 484 | |||
687 | 485 | SORT_BRIEF_DOCS = NO | ||
688 | 486 | |||
689 | 487 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen | ||
690 | 488 | # will sort the (brief and detailed) documentation of class members so that | ||
691 | 489 | # constructors and destructors are listed first. If set to NO (the default) | ||
692 | 490 | # the constructors will appear in the respective orders defined by | ||
693 | 491 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. | ||
694 | 492 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO | ||
695 | 493 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. | ||
696 | 494 | |||
697 | 495 | SORT_MEMBERS_CTORS_1ST = NO | ||
698 | 496 | |||
699 | 497 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | ||
700 | 498 | # hierarchy of group names into alphabetical order. If set to NO (the default) | ||
701 | 499 | # the group names will appear in their defined order. | ||
702 | 500 | |||
703 | 501 | SORT_GROUP_NAMES = NO | ||
704 | 502 | |||
705 | 503 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | ||
706 | 504 | # sorted by fully-qualified names, including namespaces. If set to | ||
707 | 505 | # NO (the default), the class list will be sorted only by class name, | ||
708 | 506 | # not including the namespace part. | ||
709 | 507 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | ||
710 | 508 | # Note: This option applies only to the class list, not to the | ||
711 | 509 | # alphabetical list. | ||
712 | 510 | |||
713 | 511 | SORT_BY_SCOPE_NAME = NO | ||
714 | 512 | |||
715 | 513 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to | ||
716 | 514 | # do proper type resolution of all parameters of a function it will reject a | ||
717 | 515 | # match between the prototype and the implementation of a member function even | ||
718 | 516 | # if there is only one candidate or it is obvious which candidate to choose | ||
719 | 517 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen | ||
720 | 518 | # will still accept a match between prototype and implementation in such cases. | ||
721 | 519 | |||
722 | 520 | STRICT_PROTO_MATCHING = NO | ||
723 | 521 | |||
724 | 522 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | ||
725 | 523 | # disable (NO) the todo list. This list is created by putting \todo | ||
726 | 524 | # commands in the documentation. | ||
727 | 525 | |||
728 | 526 | GENERATE_TODOLIST = YES | ||
729 | 527 | |||
730 | 528 | # The GENERATE_TESTLIST tag can be used to enable (YES) or | ||
731 | 529 | # disable (NO) the test list. This list is created by putting \test | ||
732 | 530 | # commands in the documentation. | ||
733 | 531 | |||
734 | 532 | GENERATE_TESTLIST = YES | ||
735 | 533 | |||
736 | 534 | # The GENERATE_BUGLIST tag can be used to enable (YES) or | ||
737 | 535 | # disable (NO) the bug list. This list is created by putting \bug | ||
738 | 536 | # commands in the documentation. | ||
739 | 537 | |||
740 | 538 | GENERATE_BUGLIST = YES | ||
741 | 539 | |||
742 | 540 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | ||
743 | 541 | # disable (NO) the deprecated list. This list is created by putting | ||
744 | 542 | # \deprecated commands in the documentation. | ||
745 | 543 | |||
746 | 544 | GENERATE_DEPRECATEDLIST= YES | ||
747 | 545 | |||
748 | 546 | # The ENABLED_SECTIONS tag can be used to enable conditional | ||
749 | 547 | # documentation sections, marked by \if sectionname ... \endif. | ||
750 | 548 | |||
751 | 549 | ENABLED_SECTIONS = | ||
752 | 550 | |||
753 | 551 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | ||
754 | 552 | # the initial value of a variable or macro consists of for it to appear in | ||
755 | 553 | # the documentation. If the initializer consists of more lines than specified | ||
756 | 554 | # here it will be hidden. Use a value of 0 to hide initializers completely. | ||
757 | 555 | # The appearance of the initializer of individual variables and macros in the | ||
758 | 556 | # documentation can be controlled using \showinitializer or \hideinitializer | ||
759 | 557 | # command in the documentation regardless of this setting. | ||
760 | 558 | |||
761 | 559 | MAX_INITIALIZER_LINES = 30 | ||
762 | 560 | |||
763 | 561 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | ||
764 | 562 | # at the bottom of the documentation of classes and structs. If set to YES the | ||
765 | 563 | # list will mention the files that were used to generate the documentation. | ||
766 | 564 | |||
767 | 565 | SHOW_USED_FILES = YES | ||
768 | 566 | |||
769 | 567 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | ||
770 | 568 | # This will remove the Files entry from the Quick Index and from the | ||
771 | 569 | # Folder Tree View (if specified). The default is YES. | ||
772 | 570 | |||
773 | 571 | SHOW_FILES = YES | ||
774 | 572 | |||
775 | 573 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | ||
776 | 574 | # Namespaces page. This will remove the Namespaces entry from the Quick Index | ||
777 | 575 | # and from the Folder Tree View (if specified). The default is YES. | ||
778 | 576 | |||
779 | 577 | SHOW_NAMESPACES = YES | ||
780 | 578 | |||
781 | 579 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | ||
782 | 580 | # doxygen should invoke to get the current version for each file (typically from | ||
783 | 581 | # the version control system). Doxygen will invoke the program by executing (via | ||
784 | 582 | # popen()) the command <command> <input-file>, where <command> is the value of | ||
785 | 583 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | ||
786 | 584 | # provided by doxygen. Whatever the program writes to standard output | ||
787 | 585 | # is used as the file version. See the manual for examples. | ||
788 | 586 | |||
789 | 587 | FILE_VERSION_FILTER = | ||
790 | 588 | |||
791 | 589 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | ||
792 | 590 | # by doxygen. The layout file controls the global structure of the generated | ||
793 | 591 | # output files in an output format independent way. To create the layout file | ||
794 | 592 | # that represents doxygen's defaults, run doxygen with the -l option. | ||
795 | 593 | # You can optionally specify a file name after the option, if omitted | ||
796 | 594 | # DoxygenLayout.xml will be used as the name of the layout file. | ||
797 | 595 | |||
798 | 596 | LAYOUT_FILE = | ||
799 | 597 | |||
800 | 598 | # The CITE_BIB_FILES tag can be used to specify one or more bib files | ||
801 | 599 | # containing the references data. This must be a list of .bib files. The | ||
802 | 600 | # .bib extension is automatically appended if omitted. Using this command | ||
803 | 601 | # requires the bibtex tool to be installed. See also | ||
804 | 602 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style | ||
805 | 603 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this | ||
806 | 604 | # feature you need bibtex and perl available in the search path. | ||
807 | 605 | |||
808 | 606 | CITE_BIB_FILES = | ||
809 | 607 | |||
810 | 608 | #--------------------------------------------------------------------------- | ||
811 | 609 | # configuration options related to warning and progress messages | ||
812 | 610 | #--------------------------------------------------------------------------- | ||
813 | 611 | |||
814 | 612 | # The QUIET tag can be used to turn on/off the messages that are generated | ||
815 | 613 | # by doxygen. Possible values are YES and NO. If left blank NO is used. | ||
816 | 614 | |||
817 | 615 | QUIET = YES | ||
818 | 616 | |||
819 | 617 | # The WARNINGS tag can be used to turn on/off the warning messages that are | ||
820 | 618 | # generated by doxygen. Possible values are YES and NO. If left blank | ||
821 | 619 | # NO is used. | ||
822 | 620 | |||
823 | 621 | WARNINGS = YES | ||
824 | 622 | |||
825 | 623 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | ||
826 | 624 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | ||
827 | 625 | # automatically be disabled. | ||
828 | 626 | |||
829 | 627 | WARN_IF_UNDOCUMENTED = YES | ||
830 | 628 | |||
831 | 629 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | ||
832 | 630 | # potential errors in the documentation, such as not documenting some | ||
833 | 631 | # parameters in a documented function, or documenting parameters that | ||
834 | 632 | # don't exist or using markup commands wrongly. | ||
835 | 633 | |||
836 | 634 | WARN_IF_DOC_ERROR = YES | ||
837 | 635 | |||
838 | 636 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for | ||
839 | 637 | # functions that are documented, but have no documentation for their parameters | ||
840 | 638 | # or return value. If set to NO (the default) doxygen will only warn about | ||
841 | 639 | # wrong or incomplete parameter documentation, but not about the absence of | ||
842 | 640 | # documentation. | ||
843 | 641 | |||
844 | 642 | WARN_NO_PARAMDOC = NO | ||
845 | 643 | |||
846 | 644 | # The WARN_FORMAT tag determines the format of the warning messages that | ||
847 | 645 | # doxygen can produce. The string should contain the $file, $line, and $text | ||
848 | 646 | # tags, which will be replaced by the file and line number from which the | ||
849 | 647 | # warning originated and the warning text. Optionally the format may contain | ||
850 | 648 | # $version, which will be replaced by the version of the file (if it could | ||
851 | 649 | # be obtained via FILE_VERSION_FILTER) | ||
852 | 650 | |||
853 | 651 | WARN_FORMAT = "$file:$line: $text" | ||
854 | 652 | |||
855 | 653 | # The WARN_LOGFILE tag can be used to specify a file to which warning | ||
856 | 654 | # and error messages should be written. If left blank the output is written | ||
857 | 655 | # to stderr. | ||
858 | 656 | |||
859 | 657 | WARN_LOGFILE = | ||
860 | 658 | |||
861 | 659 | #--------------------------------------------------------------------------- | ||
862 | 660 | # configuration options related to the input files | ||
863 | 661 | #--------------------------------------------------------------------------- | ||
864 | 662 | |||
865 | 663 | # The INPUT tag can be used to specify the files and/or directories that contain | ||
866 | 664 | # documented source files. You may enter file names like "myfile.cpp" or | ||
867 | 665 | # directories like "/usr/src/myproject". Separate the files or directories | ||
868 | 666 | # with spaces. | ||
869 | 667 | |||
870 | 668 | INPUT = @PROJECT_BINARY_DIR@/include @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@/src | ||
871 | 669 | |||
872 | 670 | # This tag can be used to specify the character encoding of the source files | ||
873 | 671 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | ||
874 | 672 | # also the default input encoding. Doxygen uses libiconv (or the iconv built | ||
875 | 673 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | ||
876 | 674 | # the list of possible encodings. | ||
877 | 675 | |||
878 | 676 | INPUT_ENCODING = UTF-8 | ||
879 | 677 | |||
880 | 678 | # If the value of the INPUT tag contains directories, you can use the | ||
881 | 679 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
882 | 680 | # and *.h) to filter out the source-files in the directories. If left | ||
883 | 681 | # blank the following patterns are tested: | ||
884 | 682 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | ||
885 | 683 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | ||
886 | 684 | # *.f90 *.f *.for *.vhd *.vhdl | ||
887 | 685 | |||
888 | 686 | FILE_PATTERNS = *.c \ | ||
889 | 687 | *.cc \ | ||
890 | 688 | *.cxx \ | ||
891 | 689 | *.cpp \ | ||
892 | 690 | *.c++ \ | ||
893 | 691 | *.d \ | ||
894 | 692 | *.java \ | ||
895 | 693 | *.ii \ | ||
896 | 694 | *.ixx \ | ||
897 | 695 | *.ipp \ | ||
898 | 696 | *.i++ \ | ||
899 | 697 | *.inl \ | ||
900 | 698 | *.h \ | ||
901 | 699 | *.hh \ | ||
902 | 700 | *.hxx \ | ||
903 | 701 | *.hpp \ | ||
904 | 702 | *.h++ \ | ||
905 | 703 | *.idl \ | ||
906 | 704 | *.odl \ | ||
907 | 705 | *.cs \ | ||
908 | 706 | *.php \ | ||
909 | 707 | *.php3 \ | ||
910 | 708 | *.inc \ | ||
911 | 709 | *.m \ | ||
912 | 710 | *.markdown \ | ||
913 | 711 | *.md \ | ||
914 | 712 | *.mm \ | ||
915 | 713 | *.dox \ | ||
916 | 714 | *.py \ | ||
917 | 715 | *.f90 \ | ||
918 | 716 | *.f \ | ||
919 | 717 | *.for \ | ||
920 | 718 | *.vhd \ | ||
921 | 719 | *.vhdl | ||
922 | 720 | |||
923 | 721 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | ||
924 | 722 | # should be searched for input files as well. Possible values are YES and NO. | ||
925 | 723 | # If left blank NO is used. | ||
926 | 724 | |||
927 | 725 | RECURSIVE = YES | ||
928 | 726 | |||
929 | 727 | # The EXCLUDE tag can be used to specify files and/or directories that should be | ||
930 | 728 | # excluded from the INPUT source files. This way you can easily exclude a | ||
931 | 729 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | ||
932 | 730 | # Note that relative paths are relative to the directory from which doxygen is | ||
933 | 731 | # run. | ||
934 | 732 | |||
935 | 733 | EXCLUDE = | ||
936 | 734 | |||
937 | 735 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or | ||
938 | 736 | # directories that are symbolic links (a Unix file system feature) are excluded | ||
939 | 737 | # from the input. | ||
940 | 738 | |||
941 | 739 | EXCLUDE_SYMLINKS = NO | ||
942 | 740 | |||
943 | 741 | # If the value of the INPUT tag contains directories, you can use the | ||
944 | 742 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | ||
945 | 743 | # certain files from those directories. Note that the wildcards are matched | ||
946 | 744 | # against the file with absolute path, so to exclude all test directories | ||
947 | 745 | # for example use the pattern */test/* | ||
948 | 746 | |||
949 | 747 | EXCLUDE_PATTERNS = */internal/* | ||
950 | 748 | |||
951 | 749 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | ||
952 | 750 | # (namespaces, classes, functions, etc.) that should be excluded from the | ||
953 | 751 | # output. The symbol name can be a fully qualified name, a word, or if the | ||
954 | 752 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | ||
955 | 753 | # AClass::ANamespace, ANamespace::*Test | ||
956 | 754 | |||
957 | 755 | EXCLUDE_SYMBOLS = | ||
958 | 756 | |||
959 | 757 | # The EXAMPLE_PATH tag can be used to specify one or more files or | ||
960 | 758 | # directories that contain example code fragments that are included (see | ||
961 | 759 | # the \include command). | ||
962 | 760 | |||
963 | 761 | EXAMPLE_PATH = | ||
964 | 762 | |||
965 | 763 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | ||
966 | 764 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
967 | 765 | # and *.h) to filter out the source-files in the directories. If left | ||
968 | 766 | # blank all files are included. | ||
969 | 767 | |||
970 | 768 | EXAMPLE_PATTERNS = * | ||
971 | 769 | |||
972 | 770 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | ||
973 | 771 | # searched for input files to be used with the \include or \dontinclude | ||
974 | 772 | # commands irrespective of the value of the RECURSIVE tag. | ||
975 | 773 | # Possible values are YES and NO. If left blank NO is used. | ||
976 | 774 | |||
977 | 775 | EXAMPLE_RECURSIVE = NO | ||
978 | 776 | |||
979 | 777 | # The IMAGE_PATH tag can be used to specify one or more files or | ||
980 | 778 | # directories that contain image that are included in the documentation (see | ||
981 | 779 | # the \image command). | ||
982 | 780 | |||
983 | 781 | IMAGE_PATH = | ||
984 | 782 | |||
985 | 783 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | ||
986 | 784 | # invoke to filter for each input file. Doxygen will invoke the filter program | ||
987 | 785 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | ||
988 | 786 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | ||
989 | 787 | # input file. Doxygen will then use the output that the filter program writes | ||
990 | 788 | # to standard output. If FILTER_PATTERNS is specified, this tag will be | ||
991 | 789 | # ignored. | ||
992 | 790 | |||
993 | 791 | INPUT_FILTER = | ||
994 | 792 | |||
995 | 793 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | ||
996 | 794 | # basis. Doxygen will compare the file name with each pattern and apply the | ||
997 | 795 | # filter if there is a match. The filters are a list of the form: | ||
998 | 796 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | ||
999 | 797 | # info on how filters are used. If FILTER_PATTERNS is empty or if | ||
1000 | 798 | # non of the patterns match the file name, INPUT_FILTER is applied. | ||
1001 | 799 | |||
1002 | 800 | FILTER_PATTERNS = | ||
1003 | 801 | |||
1004 | 802 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
1005 | 803 | # INPUT_FILTER) will be used to filter the input files when producing source | ||
1006 | 804 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
1007 | 805 | |||
1008 | 806 | FILTER_SOURCE_FILES = NO | ||
1009 | 807 | |||
1010 | 808 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
1011 | 809 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) | ||
1012 | 810 | # and it is also possible to disable source filtering for a specific pattern | ||
1013 | 811 | # using *.ext= (so without naming a filter). This option only has effect when | ||
1014 | 812 | # FILTER_SOURCE_FILES is enabled. | ||
1015 | 813 | |||
1016 | 814 | FILTER_SOURCE_PATTERNS = | ||
1017 | 815 | |||
1018 | 816 | #--------------------------------------------------------------------------- | ||
1019 | 817 | # configuration options related to source browsing | ||
1020 | 818 | #--------------------------------------------------------------------------- | ||
1021 | 819 | |||
1022 | 820 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | ||
1023 | 821 | # be generated. Documented entities will be cross-referenced with these sources. | ||
1024 | 822 | # Note: To get rid of all source code in the generated output, make sure also | ||
1025 | 823 | # VERBATIM_HEADERS is set to NO. | ||
1026 | 824 | |||
1027 | 825 | SOURCE_BROWSER = NO | ||
1028 | 826 | |||
1029 | 827 | # Setting the INLINE_SOURCES tag to YES will include the body | ||
1030 | 828 | # of functions and classes directly in the documentation. | ||
1031 | 829 | |||
1032 | 830 | INLINE_SOURCES = NO | ||
1033 | 831 | |||
1034 | 832 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | ||
1035 | 833 | # doxygen to hide any special comment blocks from generated source code | ||
1036 | 834 | # fragments. Normal C, C++ and Fortran comments will always remain visible. | ||
1037 | 835 | |||
1038 | 836 | STRIP_CODE_COMMENTS = YES | ||
1039 | 837 | |||
1040 | 838 | # If the REFERENCED_BY_RELATION tag is set to YES | ||
1041 | 839 | # then for each documented function all documented | ||
1042 | 840 | # functions referencing it will be listed. | ||
1043 | 841 | |||
1044 | 842 | REFERENCED_BY_RELATION = NO | ||
1045 | 843 | |||
1046 | 844 | # If the REFERENCES_RELATION tag is set to YES | ||
1047 | 845 | # then for each documented function all documented entities | ||
1048 | 846 | # called/used by that function will be listed. | ||
1049 | 847 | |||
1050 | 848 | REFERENCES_RELATION = NO | ||
1051 | 849 | |||
1052 | 850 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | ||
1053 | 851 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | ||
1054 | 852 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | ||
1055 | 853 | # link to the source code. Otherwise they will link to the documentation. | ||
1056 | 854 | |||
1057 | 855 | REFERENCES_LINK_SOURCE = YES | ||
1058 | 856 | |||
1059 | 857 | # If the USE_HTAGS tag is set to YES then the references to source code | ||
1060 | 858 | # will point to the HTML generated by the htags(1) tool instead of doxygen | ||
1061 | 859 | # built-in source browser. The htags tool is part of GNU's global source | ||
1062 | 860 | # tagging system (see http://www.gnu.org/software/global/global.html). You | ||
1063 | 861 | # will need version 4.8.6 or higher. | ||
1064 | 862 | |||
1065 | 863 | USE_HTAGS = NO | ||
1066 | 864 | |||
1067 | 865 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | ||
1068 | 866 | # will generate a verbatim copy of the header file for each class for | ||
1069 | 867 | # which an include is specified. Set to NO to disable this. | ||
1070 | 868 | |||
1071 | 869 | VERBATIM_HEADERS = YES | ||
1072 | 870 | |||
1073 | 871 | #--------------------------------------------------------------------------- | ||
1074 | 872 | # configuration options related to the alphabetical class index | ||
1075 | 873 | #--------------------------------------------------------------------------- | ||
1076 | 874 | |||
1077 | 875 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | ||
1078 | 876 | # of all compounds will be generated. Enable this if the project | ||
1079 | 877 | # contains a lot of classes, structs, unions or interfaces. | ||
1080 | 878 | |||
1081 | 879 | ALPHABETICAL_INDEX = YES | ||
1082 | 880 | |||
1083 | 881 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | ||
1084 | 882 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | ||
1085 | 883 | # in which this list will be split (can be a number in the range [1..20]) | ||
1086 | 884 | |||
1087 | 885 | COLS_IN_ALPHA_INDEX = 5 | ||
1088 | 886 | |||
1089 | 887 | # In case all classes in a project start with a common prefix, all | ||
1090 | 888 | # classes will be put under the same header in the alphabetical index. | ||
1091 | 889 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | ||
1092 | 890 | # should be ignored while generating the index headers. | ||
1093 | 891 | |||
1094 | 892 | IGNORE_PREFIX = | ||
1095 | 893 | |||
1096 | 894 | #--------------------------------------------------------------------------- | ||
1097 | 895 | # configuration options related to the HTML output | ||
1098 | 896 | #--------------------------------------------------------------------------- | ||
1099 | 897 | |||
1100 | 898 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | ||
1101 | 899 | # generate HTML output. | ||
1102 | 900 | |||
1103 | 901 | GENERATE_HTML = YES | ||
1104 | 902 | |||
1105 | 903 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | ||
1106 | 904 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1107 | 905 | # put in front of it. If left blank `html' will be used as the default path. | ||
1108 | 906 | |||
1109 | 907 | HTML_OUTPUT = lib@UNITY_API_LIB@ | ||
1110 | 908 | |||
1111 | 909 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | ||
1112 | 910 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | ||
1113 | 911 | # doxygen will generate files with .html extension. | ||
1114 | 912 | |||
1115 | 913 | HTML_FILE_EXTENSION = .html | ||
1116 | 914 | |||
1117 | 915 | # The HTML_HEADER tag can be used to specify a personal HTML header for | ||
1118 | 916 | # each generated HTML page. If it is left blank doxygen will generate a | ||
1119 | 917 | # standard header. Note that when using a custom header you are responsible | ||
1120 | 918 | # for the proper inclusion of any scripts and style sheets that doxygen | ||
1121 | 919 | # needs, which is dependent on the configuration options used. | ||
1122 | 920 | # It is advised to generate a default header using "doxygen -w html | ||
1123 | 921 | # header.html footer.html stylesheet.css YourConfigFile" and then modify | ||
1124 | 922 | # that header. Note that the header is subject to change so you typically | ||
1125 | 923 | # have to redo this when upgrading to a newer version of doxygen or when | ||
1126 | 924 | # changing the value of configuration settings such as GENERATE_TREEVIEW! | ||
1127 | 925 | |||
1128 | 926 | HTML_HEADER = | ||
1129 | 927 | |||
1130 | 928 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | ||
1131 | 929 | # each generated HTML page. If it is left blank doxygen will generate a | ||
1132 | 930 | # standard footer. | ||
1133 | 931 | |||
1134 | 932 | HTML_FOOTER = | ||
1135 | 933 | |||
1136 | 934 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | ||
1137 | 935 | # style sheet that is used by each HTML page. It can be used to | ||
1138 | 936 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | ||
1139 | 937 | # will generate a default style sheet. Note that doxygen will try to copy | ||
1140 | 938 | # the style sheet file to the HTML output directory, so don't put your own | ||
1141 | 939 | # style sheet in the HTML output directory as well, or it will be erased! | ||
1142 | 940 | |||
1143 | 941 | HTML_STYLESHEET = | ||
1144 | 942 | |||
1145 | 943 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | ||
1146 | 944 | # other source files which should be copied to the HTML output directory. Note | ||
1147 | 945 | # that these files will be copied to the base HTML output directory. Use the | ||
1148 | 946 | # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | ||
1149 | 947 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that | ||
1150 | 948 | # the files will be copied as-is; there are no commands or markers available. | ||
1151 | 949 | |||
1152 | 950 | HTML_EXTRA_FILES = | ||
1153 | 951 | |||
1154 | 952 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | ||
1155 | 953 | # Doxygen will adjust the colors in the style sheet and background images | ||
1156 | 954 | # according to this color. Hue is specified as an angle on a colorwheel, | ||
1157 | 955 | # see http://en.wikipedia.org/wiki/Hue for more information. | ||
1158 | 956 | # For instance the value 0 represents red, 60 is yellow, 120 is green, | ||
1159 | 957 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | ||
1160 | 958 | # The allowed range is 0 to 359. | ||
1161 | 959 | |||
1162 | 960 | HTML_COLORSTYLE_HUE = 220 | ||
1163 | 961 | |||
1164 | 962 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of | ||
1165 | 963 | # the colors in the HTML output. For a value of 0 the output will use | ||
1166 | 964 | # grayscales only. A value of 255 will produce the most vivid colors. | ||
1167 | 965 | |||
1168 | 966 | HTML_COLORSTYLE_SAT = 100 | ||
1169 | 967 | |||
1170 | 968 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to | ||
1171 | 969 | # the luminance component of the colors in the HTML output. Values below | ||
1172 | 970 | # 100 gradually make the output lighter, whereas values above 100 make | ||
1173 | 971 | # the output darker. The value divided by 100 is the actual gamma applied, | ||
1174 | 972 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, | ||
1175 | 973 | # and 100 does not change the gamma. | ||
1176 | 974 | |||
1177 | 975 | HTML_COLORSTYLE_GAMMA = 80 | ||
1178 | 976 | |||
1179 | 977 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | ||
1180 | 978 | # page will contain the date and time when the page was generated. Setting | ||
1181 | 979 | # this to NO can help when comparing the output of multiple runs. | ||
1182 | 980 | |||
1183 | 981 | HTML_TIMESTAMP = YES | ||
1184 | 982 | |||
1185 | 983 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
1186 | 984 | # documentation will contain sections that can be hidden and shown after the | ||
1187 | 985 | # page has loaded. | ||
1188 | 986 | |||
1189 | 987 | HTML_DYNAMIC_SECTIONS = NO | ||
1190 | 988 | |||
1191 | 989 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of | ||
1192 | 990 | # entries shown in the various tree structured indices initially; the user | ||
1193 | 991 | # can expand and collapse entries dynamically later on. Doxygen will expand | ||
1194 | 992 | # the tree to such a level that at most the specified number of entries are | ||
1195 | 993 | # visible (unless a fully collapsed tree already exceeds this amount). | ||
1196 | 994 | # So setting the number of entries 1 will produce a full collapsed tree by | ||
1197 | 995 | # default. 0 is a special value representing an infinite number of entries | ||
1198 | 996 | # and will result in a full expanded tree by default. | ||
1199 | 997 | |||
1200 | 998 | HTML_INDEX_NUM_ENTRIES = 100 | ||
1201 | 999 | |||
1202 | 1000 | # If the GENERATE_DOCSET tag is set to YES, additional index files | ||
1203 | 1001 | # will be generated that can be used as input for Apple's Xcode 3 | ||
1204 | 1002 | # integrated development environment, introduced with OSX 10.5 (Leopard). | ||
1205 | 1003 | # To create a documentation set, doxygen will generate a Makefile in the | ||
1206 | 1004 | # HTML output directory. Running make will produce the docset in that | ||
1207 | 1005 | # directory and running "make install" will install the docset in | ||
1208 | 1006 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
1209 | 1007 | # it at startup. | ||
1210 | 1008 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | ||
1211 | 1009 | # for more information. | ||
1212 | 1010 | |||
1213 | 1011 | GENERATE_DOCSET = NO | ||
1214 | 1012 | |||
1215 | 1013 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | ||
1216 | 1014 | # feed. A documentation feed provides an umbrella under which multiple | ||
1217 | 1015 | # documentation sets from a single provider (such as a company or product suite) | ||
1218 | 1016 | # can be grouped. | ||
1219 | 1017 | |||
1220 | 1018 | DOCSET_FEEDNAME = "Doxygen generated docs" | ||
1221 | 1019 | |||
1222 | 1020 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | ||
1223 | 1021 | # should uniquely identify the documentation set bundle. This should be a | ||
1224 | 1022 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | ||
1225 | 1023 | # will append .docset to the name. | ||
1226 | 1024 | |||
1227 | 1025 | DOCSET_BUNDLE_ID = org.doxygen.Project | ||
1228 | 1026 | |||
1229 | 1027 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify | ||
1230 | 1028 | # the documentation publisher. This should be a reverse domain-name style | ||
1231 | 1029 | # string, e.g. com.mycompany.MyDocSet.documentation. | ||
1232 | 1030 | |||
1233 | 1031 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | ||
1234 | 1032 | |||
1235 | 1033 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | ||
1236 | 1034 | |||
1237 | 1035 | DOCSET_PUBLISHER_NAME = Publisher | ||
1238 | 1036 | |||
1239 | 1037 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | ||
1240 | 1038 | # will be generated that can be used as input for tools like the | ||
1241 | 1039 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | ||
1242 | 1040 | # of the generated HTML documentation. | ||
1243 | 1041 | |||
1244 | 1042 | GENERATE_HTMLHELP = NO | ||
1245 | 1043 | |||
1246 | 1044 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | ||
1247 | 1045 | # be used to specify the file name of the resulting .chm file. You | ||
1248 | 1046 | # can add a path in front of the file if the result should not be | ||
1249 | 1047 | # written to the html output directory. | ||
1250 | 1048 | |||
1251 | 1049 | CHM_FILE = | ||
1252 | 1050 | |||
1253 | 1051 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | ||
1254 | 1052 | # be used to specify the location (absolute path including file name) of | ||
1255 | 1053 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | ||
1256 | 1054 | # the HTML help compiler on the generated index.hhp. | ||
1257 | 1055 | |||
1258 | 1056 | HHC_LOCATION = | ||
1259 | 1057 | |||
1260 | 1058 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | ||
1261 | 1059 | # controls if a separate .chi index file is generated (YES) or that | ||
1262 | 1060 | # it should be included in the master .chm file (NO). | ||
1263 | 1061 | |||
1264 | 1062 | GENERATE_CHI = NO | ||
1265 | 1063 | |||
1266 | 1064 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | ||
1267 | 1065 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | ||
1268 | 1066 | # content. | ||
1269 | 1067 | |||
1270 | 1068 | CHM_INDEX_ENCODING = | ||
1271 | 1069 | |||
1272 | 1070 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | ||
1273 | 1071 | # controls whether a binary table of contents is generated (YES) or a | ||
1274 | 1072 | # normal table of contents (NO) in the .chm file. | ||
1275 | 1073 | |||
1276 | 1074 | BINARY_TOC = NO | ||
1277 | 1075 | |||
1278 | 1076 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | ||
1279 | 1077 | # to the contents of the HTML help documentation and to the tree view. | ||
1280 | 1078 | |||
1281 | 1079 | TOC_EXPAND = NO | ||
1282 | 1080 | |||
1283 | 1081 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | ||
1284 | 1082 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated | ||
1285 | 1083 | # that can be used as input for Qt's qhelpgenerator to generate a | ||
1286 | 1084 | # Qt Compressed Help (.qch) of the generated HTML documentation. | ||
1287 | 1085 | |||
1288 | 1086 | GENERATE_QHP = NO | ||
1289 | 1087 | |||
1290 | 1088 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can | ||
1291 | 1089 | # be used to specify the file name of the resulting .qch file. | ||
1292 | 1090 | # The path specified is relative to the HTML output folder. | ||
1293 | 1091 | |||
1294 | 1092 | QCH_FILE = | ||
1295 | 1093 | |||
1296 | 1094 | # The QHP_NAMESPACE tag specifies the namespace to use when generating | ||
1297 | 1095 | # Qt Help Project output. For more information please see | ||
1298 | 1096 | # http://doc.trolltech.com/qthelpproject.html#namespace | ||
1299 | 1097 | |||
1300 | 1098 | QHP_NAMESPACE = org.doxygen.Project | ||
1301 | 1099 | |||
1302 | 1100 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | ||
1303 | 1101 | # Qt Help Project output. For more information please see | ||
1304 | 1102 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders | ||
1305 | 1103 | |||
1306 | 1104 | QHP_VIRTUAL_FOLDER = doc | ||
1307 | 1105 | |||
1308 | 1106 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to | ||
1309 | 1107 | # add. For more information please see | ||
1310 | 1108 | # http://doc.trolltech.com/qthelpproject.html#custom-filters | ||
1311 | 1109 | |||
1312 | 1110 | QHP_CUST_FILTER_NAME = | ||
1313 | 1111 | |||
1314 | 1112 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the | ||
1315 | 1113 | # custom filter to add. For more information please see | ||
1316 | 1114 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> | ||
1317 | 1115 | # Qt Help Project / Custom Filters</a>. | ||
1318 | 1116 | |||
1319 | 1117 | QHP_CUST_FILTER_ATTRS = | ||
1320 | 1118 | |||
1321 | 1119 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | ||
1322 | 1120 | # project's | ||
1323 | 1121 | # filter section matches. | ||
1324 | 1122 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> | ||
1325 | 1123 | # Qt Help Project / Filter Attributes</a>. | ||
1326 | 1124 | |||
1327 | 1125 | QHP_SECT_FILTER_ATTRS = | ||
1328 | 1126 | |||
1329 | 1127 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | ||
1330 | 1128 | # be used to specify the location of Qt's qhelpgenerator. | ||
1331 | 1129 | # If non-empty doxygen will try to run qhelpgenerator on the generated | ||
1332 | 1130 | # .qhp file. | ||
1333 | 1131 | |||
1334 | 1132 | QHG_LOCATION = | ||
1335 | 1133 | |||
1336 | 1134 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files | ||
1337 | 1135 | # will be generated, which together with the HTML files, form an Eclipse help | ||
1338 | 1136 | # plugin. To install this plugin and make it available under the help contents | ||
1339 | 1137 | # menu in Eclipse, the contents of the directory containing the HTML and XML | ||
1340 | 1138 | # files needs to be copied into the plugins directory of eclipse. The name of | ||
1341 | 1139 | # the directory within the plugins directory should be the same as | ||
1342 | 1140 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before | ||
1343 | 1141 | # the help appears. | ||
1344 | 1142 | |||
1345 | 1143 | GENERATE_ECLIPSEHELP = NO | ||
1346 | 1144 | |||
1347 | 1145 | # A unique identifier for the eclipse help plugin. When installing the plugin | ||
1348 | 1146 | # the directory name containing the HTML and XML files should also have | ||
1349 | 1147 | # this name. | ||
1350 | 1148 | |||
1351 | 1149 | ECLIPSE_DOC_ID = org.doxygen.Project | ||
1352 | 1150 | |||
1353 | 1151 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) | ||
1354 | 1152 | # at top of each HTML page. The value NO (the default) enables the index and | ||
1355 | 1153 | # the value YES disables it. Since the tabs have the same information as the | ||
1356 | 1154 | # navigation tree you can set this option to NO if you already set | ||
1357 | 1155 | # GENERATE_TREEVIEW to YES. | ||
1358 | 1156 | |||
1359 | 1157 | DISABLE_INDEX = NO | ||
1360 | 1158 | |||
1361 | 1159 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | ||
1362 | 1160 | # structure should be generated to display hierarchical information. | ||
1363 | 1161 | # If the tag value is set to YES, a side panel will be generated | ||
1364 | 1162 | # containing a tree-like index structure (just like the one that | ||
1365 | 1163 | # is generated for HTML Help). For this to work a browser that supports | ||
1366 | 1164 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | ||
1367 | 1165 | # Windows users are probably better off using the HTML help feature. | ||
1368 | 1166 | # Since the tree basically has the same information as the tab index you | ||
1369 | 1167 | # could consider to set DISABLE_INDEX to NO when enabling this option. | ||
1370 | 1168 | |||
1371 | 1169 | GENERATE_TREEVIEW = YES | ||
1372 | 1170 | |||
1373 | 1171 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values | ||
1374 | 1172 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML | ||
1375 | 1173 | # documentation. Note that a value of 0 will completely suppress the enum | ||
1376 | 1174 | # values from appearing in the overview section. | ||
1377 | 1175 | |||
1378 | 1176 | ENUM_VALUES_PER_LINE = 4 | ||
1379 | 1177 | |||
1380 | 1178 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | ||
1381 | 1179 | # used to set the initial width (in pixels) of the frame in which the tree | ||
1382 | 1180 | # is shown. | ||
1383 | 1181 | |||
1384 | 1182 | TREEVIEW_WIDTH = 250 | ||
1385 | 1183 | |||
1386 | 1184 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open | ||
1387 | 1185 | # links to external symbols imported via tag files in a separate window. | ||
1388 | 1186 | |||
1389 | 1187 | EXT_LINKS_IN_WINDOW = NO | ||
1390 | 1188 | |||
1391 | 1189 | # Use this tag to change the font size of Latex formulas included | ||
1392 | 1190 | # as images in the HTML documentation. The default is 10. Note that | ||
1393 | 1191 | # when you change the font size after a successful doxygen run you need | ||
1394 | 1192 | # to manually remove any form_*.png images from the HTML output directory | ||
1395 | 1193 | # to force them to be regenerated. | ||
1396 | 1194 | |||
1397 | 1195 | FORMULA_FONTSIZE = 10 | ||
1398 | 1196 | |||
1399 | 1197 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | ||
1400 | 1198 | # generated for formulas are transparent PNGs. Transparent PNGs are | ||
1401 | 1199 | # not supported properly for IE 6.0, but are supported on all modern browsers. | ||
1402 | 1200 | # Note that when changing this option you need to delete any form_*.png files | ||
1403 | 1201 | # in the HTML output before the changes have effect. | ||
1404 | 1202 | |||
1405 | 1203 | FORMULA_TRANSPARENT = YES | ||
1406 | 1204 | |||
1407 | 1205 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax | ||
1408 | 1206 | # (see http://www.mathjax.org) which uses client side Javascript for the | ||
1409 | 1207 | # rendering instead of using prerendered bitmaps. Use this if you do not | ||
1410 | 1208 | # have LaTeX installed or if you want to formulas look prettier in the HTML | ||
1411 | 1209 | # output. When enabled you may also need to install MathJax separately and | ||
1412 | 1210 | # configure the path to it using the MATHJAX_RELPATH option. | ||
1413 | 1211 | |||
1414 | 1212 | USE_MATHJAX = NO | ||
1415 | 1213 | |||
1416 | 1214 | # When MathJax is enabled you need to specify the location relative to the | ||
1417 | 1215 | # HTML output directory using the MATHJAX_RELPATH option. The destination | ||
1418 | 1216 | # directory should contain the MathJax.js script. For instance, if the mathjax | ||
1419 | 1217 | # directory is located at the same level as the HTML output directory, then | ||
1420 | 1218 | # MATHJAX_RELPATH should be ../mathjax. The default value points to | ||
1421 | 1219 | # the MathJax Content Delivery Network so you can quickly see the result without | ||
1422 | 1220 | # installing MathJax. However, it is strongly recommended to install a local | ||
1423 | 1221 | # copy of MathJax from http://www.mathjax.org before deployment. | ||
1424 | 1222 | |||
1425 | 1223 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | ||
1426 | 1224 | |||
1427 | 1225 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension | ||
1428 | 1226 | # names that should be enabled during MathJax rendering. | ||
1429 | 1227 | |||
1430 | 1228 | MATHJAX_EXTENSIONS = | ||
1431 | 1229 | |||
1432 | 1230 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box | ||
1433 | 1231 | # for the HTML output. The underlying search engine uses javascript | ||
1434 | 1232 | # and DHTML and should work on any modern browser. Note that when using | ||
1435 | 1233 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | ||
1436 | 1234 | # (GENERATE_DOCSET) there is already a search function so this one should | ||
1437 | 1235 | # typically be disabled. For large projects the javascript based search engine | ||
1438 | 1236 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. | ||
1439 | 1237 | |||
1440 | 1238 | SEARCHENGINE = YES | ||
1441 | 1239 | |||
1442 | 1240 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||
1443 | 1241 | # implemented using a PHP enabled web server instead of at the web client | ||
1444 | 1242 | # using Javascript. Doxygen will generate the search PHP script and index | ||
1445 | 1243 | # file to put on the web server. The advantage of the server | ||
1446 | 1244 | # based approach is that it scales better to large projects and allows | ||
1447 | 1245 | # full text search. The disadvantages are that it is more difficult to setup | ||
1448 | 1246 | # and does not have live searching capabilities. | ||
1449 | 1247 | |||
1450 | 1248 | SERVER_BASED_SEARCH = NO | ||
1451 | 1249 | |||
1452 | 1250 | #--------------------------------------------------------------------------- | ||
1453 | 1251 | # configuration options related to the LaTeX output | ||
1454 | 1252 | #--------------------------------------------------------------------------- | ||
1455 | 1253 | |||
1456 | 1254 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | ||
1457 | 1255 | # generate Latex output. | ||
1458 | 1256 | |||
1459 | 1257 | GENERATE_LATEX = NO | ||
1460 | 1258 | |||
1461 | 1259 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | ||
1462 | 1260 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1463 | 1261 | # put in front of it. If left blank `latex' will be used as the default path. | ||
1464 | 1262 | |||
1465 | 1263 | LATEX_OUTPUT = latex | ||
1466 | 1264 | |||
1467 | 1265 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
1468 | 1266 | # invoked. If left blank `latex' will be used as the default command name. | ||
1469 | 1267 | # Note that when enabling USE_PDFLATEX this option is only used for | ||
1470 | 1268 | # generating bitmaps for formulas in the HTML output, but not in the | ||
1471 | 1269 | # Makefile that is written to the output directory. | ||
1472 | 1270 | |||
1473 | 1271 | LATEX_CMD_NAME = latex | ||
1474 | 1272 | |||
1475 | 1273 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | ||
1476 | 1274 | # generate index for LaTeX. If left blank `makeindex' will be used as the | ||
1477 | 1275 | # default command name. | ||
1478 | 1276 | |||
1479 | 1277 | MAKEINDEX_CMD_NAME = makeindex | ||
1480 | 1278 | |||
1481 | 1279 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | ||
1482 | 1280 | # LaTeX documents. This may be useful for small projects and may help to | ||
1483 | 1281 | # save some trees in general. | ||
1484 | 1282 | |||
1485 | 1283 | COMPACT_LATEX = NO | ||
1486 | 1284 | |||
1487 | 1285 | # The PAPER_TYPE tag can be used to set the paper type that is used | ||
1488 | 1286 | # by the printer. Possible values are: a4, letter, legal and | ||
1489 | 1287 | # executive. If left blank a4wide will be used. | ||
1490 | 1288 | |||
1491 | 1289 | PAPER_TYPE = a4 | ||
1492 | 1290 | |||
1493 | 1291 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | ||
1494 | 1292 | # packages that should be included in the LaTeX output. | ||
1495 | 1293 | |||
1496 | 1294 | EXTRA_PACKAGES = | ||
1497 | 1295 | |||
1498 | 1296 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | ||
1499 | 1297 | # the generated latex document. The header should contain everything until | ||
1500 | 1298 | # the first chapter. If it is left blank doxygen will generate a | ||
1501 | 1299 | # standard header. Notice: only use this tag if you know what you are doing! | ||
1502 | 1300 | |||
1503 | 1301 | LATEX_HEADER = | ||
1504 | 1302 | |||
1505 | 1303 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | ||
1506 | 1304 | # the generated latex document. The footer should contain everything after | ||
1507 | 1305 | # the last chapter. If it is left blank doxygen will generate a | ||
1508 | 1306 | # standard footer. Notice: only use this tag if you know what you are doing! | ||
1509 | 1307 | |||
1510 | 1308 | LATEX_FOOTER = | ||
1511 | 1309 | |||
1512 | 1310 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | ||
1513 | 1311 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | ||
1514 | 1312 | # contain links (just like the HTML output) instead of page references | ||
1515 | 1313 | # This makes the output suitable for online browsing using a pdf viewer. | ||
1516 | 1314 | |||
1517 | 1315 | PDF_HYPERLINKS = YES | ||
1518 | 1316 | |||
1519 | 1317 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | ||
1520 | 1318 | # plain latex in the generated Makefile. Set this option to YES to get a | ||
1521 | 1319 | # higher quality PDF documentation. | ||
1522 | 1320 | |||
1523 | 1321 | USE_PDFLATEX = YES | ||
1524 | 1322 | |||
1525 | 1323 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | ||
1526 | 1324 | # command to the generated LaTeX files. This will instruct LaTeX to keep | ||
1527 | 1325 | # running if errors occur, instead of asking the user for help. | ||
1528 | 1326 | # This option is also used when generating formulas in HTML. | ||
1529 | 1327 | |||
1530 | 1328 | LATEX_BATCHMODE = NO | ||
1531 | 1329 | |||
1532 | 1330 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not | ||
1533 | 1331 | # include the index chapters (such as File Index, Compound Index, etc.) | ||
1534 | 1332 | # in the output. | ||
1535 | 1333 | |||
1536 | 1334 | LATEX_HIDE_INDICES = NO | ||
1537 | 1335 | |||
1538 | 1336 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include | ||
1539 | 1337 | # source code with syntax highlighting in the LaTeX output. | ||
1540 | 1338 | # Note that which sources are shown also depends on other settings | ||
1541 | 1339 | # such as SOURCE_BROWSER. | ||
1542 | 1340 | |||
1543 | 1341 | LATEX_SOURCE_CODE = NO | ||
1544 | 1342 | |||
1545 | 1343 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||
1546 | 1344 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See | ||
1547 | 1345 | # http://en.wikipedia.org/wiki/BibTeX for more info. | ||
1548 | 1346 | |||
1549 | 1347 | LATEX_BIB_STYLE = plain | ||
1550 | 1348 | |||
1551 | 1349 | #--------------------------------------------------------------------------- | ||
1552 | 1350 | # configuration options related to the RTF output | ||
1553 | 1351 | #--------------------------------------------------------------------------- | ||
1554 | 1352 | |||
1555 | 1353 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | ||
1556 | 1354 | # The RTF output is optimized for Word 97 and may not look very pretty with | ||
1557 | 1355 | # other RTF readers or editors. | ||
1558 | 1356 | |||
1559 | 1357 | GENERATE_RTF = NO | ||
1560 | 1358 | |||
1561 | 1359 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | ||
1562 | 1360 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1563 | 1361 | # put in front of it. If left blank `rtf' will be used as the default path. | ||
1564 | 1362 | |||
1565 | 1363 | RTF_OUTPUT = rtf | ||
1566 | 1364 | |||
1567 | 1365 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | ||
1568 | 1366 | # RTF documents. This may be useful for small projects and may help to | ||
1569 | 1367 | # save some trees in general. | ||
1570 | 1368 | |||
1571 | 1369 | COMPACT_RTF = NO | ||
1572 | 1370 | |||
1573 | 1371 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | ||
1574 | 1372 | # will contain hyperlink fields. The RTF file will | ||
1575 | 1373 | # contain links (just like the HTML output) instead of page references. | ||
1576 | 1374 | # This makes the output suitable for online browsing using WORD or other | ||
1577 | 1375 | # programs which support those fields. | ||
1578 | 1376 | # Note: wordpad (write) and others do not support links. | ||
1579 | 1377 | |||
1580 | 1378 | RTF_HYPERLINKS = NO | ||
1581 | 1379 | |||
1582 | 1380 | # Load style sheet definitions from file. Syntax is similar to doxygen's | ||
1583 | 1381 | # config file, i.e. a series of assignments. You only have to provide | ||
1584 | 1382 | # replacements, missing definitions are set to their default value. | ||
1585 | 1383 | |||
1586 | 1384 | RTF_STYLESHEET_FILE = | ||
1587 | 1385 | |||
1588 | 1386 | # Set optional variables used in the generation of an rtf document. | ||
1589 | 1387 | # Syntax is similar to doxygen's config file. | ||
1590 | 1388 | |||
1591 | 1389 | RTF_EXTENSIONS_FILE = | ||
1592 | 1390 | |||
1593 | 1391 | #--------------------------------------------------------------------------- | ||
1594 | 1392 | # configuration options related to the man page output | ||
1595 | 1393 | #--------------------------------------------------------------------------- | ||
1596 | 1394 | |||
1597 | 1395 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | ||
1598 | 1396 | # generate man pages | ||
1599 | 1397 | |||
1600 | 1398 | GENERATE_MAN = NO | ||
1601 | 1399 | |||
1602 | 1400 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | ||
1603 | 1401 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1604 | 1402 | # put in front of it. If left blank `man' will be used as the default path. | ||
1605 | 1403 | |||
1606 | 1404 | MAN_OUTPUT = man | ||
1607 | 1405 | |||
1608 | 1406 | # The MAN_EXTENSION tag determines the extension that is added to | ||
1609 | 1407 | # the generated man pages (default is the subroutine's section .3) | ||
1610 | 1408 | |||
1611 | 1409 | MAN_EXTENSION = .3 | ||
1612 | 1410 | |||
1613 | 1411 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | ||
1614 | 1412 | # then it will generate one additional man file for each entity | ||
1615 | 1413 | # documented in the real man page(s). These additional files | ||
1616 | 1414 | # only source the real man page, but without them the man command | ||
1617 | 1415 | # would be unable to find the correct page. The default is NO. | ||
1618 | 1416 | |||
1619 | 1417 | MAN_LINKS = NO | ||
1620 | 1418 | |||
1621 | 1419 | #--------------------------------------------------------------------------- | ||
1622 | 1420 | # configuration options related to the XML output | ||
1623 | 1421 | #--------------------------------------------------------------------------- | ||
1624 | 1422 | |||
1625 | 1423 | # If the GENERATE_XML tag is set to YES Doxygen will | ||
1626 | 1424 | # generate an XML file that captures the structure of | ||
1627 | 1425 | # the code including all documentation. | ||
1628 | 1426 | |||
1629 | 1427 | GENERATE_XML = NO | ||
1630 | 1428 | |||
1631 | 1429 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. | ||
1632 | 1430 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1633 | 1431 | # put in front of it. If left blank `xml' will be used as the default path. | ||
1634 | 1432 | |||
1635 | 1433 | XML_OUTPUT = xml | ||
1636 | 1434 | |||
1637 | 1435 | # The XML_SCHEMA tag can be used to specify an XML schema, | ||
1638 | 1436 | # which can be used by a validating XML parser to check the | ||
1639 | 1437 | # syntax of the XML files. | ||
1640 | 1438 | |||
1641 | 1439 | XML_SCHEMA = | ||
1642 | 1440 | |||
1643 | 1441 | # The XML_DTD tag can be used to specify an XML DTD, | ||
1644 | 1442 | # which can be used by a validating XML parser to check the | ||
1645 | 1443 | # syntax of the XML files. | ||
1646 | 1444 | |||
1647 | 1445 | XML_DTD = | ||
1648 | 1446 | |||
1649 | 1447 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | ||
1650 | 1448 | # dump the program listings (including syntax highlighting | ||
1651 | 1449 | # and cross-referencing information) to the XML output. Note that | ||
1652 | 1450 | # enabling this will significantly increase the size of the XML output. | ||
1653 | 1451 | |||
1654 | 1452 | XML_PROGRAMLISTING = YES | ||
1655 | 1453 | |||
1656 | 1454 | #--------------------------------------------------------------------------- | ||
1657 | 1455 | # configuration options for the AutoGen Definitions output | ||
1658 | 1456 | #--------------------------------------------------------------------------- | ||
1659 | 1457 | |||
1660 | 1458 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | ||
1661 | 1459 | # generate an AutoGen Definitions (see autogen.sf.net) file | ||
1662 | 1460 | # that captures the structure of the code including all | ||
1663 | 1461 | # documentation. Note that this feature is still experimental | ||
1664 | 1462 | # and incomplete at the moment. | ||
1665 | 1463 | |||
1666 | 1464 | GENERATE_AUTOGEN_DEF = NO | ||
1667 | 1465 | |||
1668 | 1466 | #--------------------------------------------------------------------------- | ||
1669 | 1467 | # configuration options related to the Perl module output | ||
1670 | 1468 | #--------------------------------------------------------------------------- | ||
1671 | 1469 | |||
1672 | 1470 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | ||
1673 | 1471 | # generate a Perl module file that captures the structure of | ||
1674 | 1472 | # the code including all documentation. Note that this | ||
1675 | 1473 | # feature is still experimental and incomplete at the | ||
1676 | 1474 | # moment. | ||
1677 | 1475 | |||
1678 | 1476 | GENERATE_PERLMOD = NO | ||
1679 | 1477 | |||
1680 | 1478 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | ||
1681 | 1479 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | ||
1682 | 1480 | # to generate PDF and DVI output from the Perl module output. | ||
1683 | 1481 | |||
1684 | 1482 | PERLMOD_LATEX = NO | ||
1685 | 1483 | |||
1686 | 1484 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | ||
1687 | 1485 | # nicely formatted so it can be parsed by a human reader. This is useful | ||
1688 | 1486 | # if you want to understand what is going on. On the other hand, if this | ||
1689 | 1487 | # tag is set to NO the size of the Perl module output will be much smaller | ||
1690 | 1488 | # and Perl will parse it just the same. | ||
1691 | 1489 | |||
1692 | 1490 | PERLMOD_PRETTY = YES | ||
1693 | 1491 | |||
1694 | 1492 | # The names of the make variables in the generated doxyrules.make file | ||
1695 | 1493 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | ||
1696 | 1494 | # This is useful so different doxyrules.make files included by the same | ||
1697 | 1495 | # Makefile don't overwrite each other's variables. | ||
1698 | 1496 | |||
1699 | 1497 | PERLMOD_MAKEVAR_PREFIX = | ||
1700 | 1498 | |||
1701 | 1499 | #--------------------------------------------------------------------------- | ||
1702 | 1500 | # Configuration options related to the preprocessor | ||
1703 | 1501 | #--------------------------------------------------------------------------- | ||
1704 | 1502 | |||
1705 | 1503 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | ||
1706 | 1504 | # evaluate all C-preprocessor directives found in the sources and include | ||
1707 | 1505 | # files. | ||
1708 | 1506 | |||
1709 | 1507 | ENABLE_PREPROCESSING = YES | ||
1710 | 1508 | |||
1711 | 1509 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | ||
1712 | 1510 | # names in the source code. If set to NO (the default) only conditional | ||
1713 | 1511 | # compilation will be performed. Macro expansion can be done in a controlled | ||
1714 | 1512 | # way by setting EXPAND_ONLY_PREDEF to YES. | ||
1715 | 1513 | |||
1716 | 1514 | MACRO_EXPANSION = NO | ||
1717 | 1515 | |||
1718 | 1516 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | ||
1719 | 1517 | # then the macro expansion is limited to the macros specified with the | ||
1720 | 1518 | # PREDEFINED and EXPAND_AS_DEFINED tags. | ||
1721 | 1519 | |||
1722 | 1520 | EXPAND_ONLY_PREDEF = NO | ||
1723 | 1521 | |||
1724 | 1522 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | ||
1725 | 1523 | # pointed to by INCLUDE_PATH will be searched when a #include is found. | ||
1726 | 1524 | |||
1727 | 1525 | SEARCH_INCLUDES = YES | ||
1728 | 1526 | |||
1729 | 1527 | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||
1730 | 1528 | # contain include files that are not input files but should be processed by | ||
1731 | 1529 | # the preprocessor. | ||
1732 | 1530 | |||
1733 | 1531 | INCLUDE_PATH = | ||
1734 | 1532 | |||
1735 | 1533 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||
1736 | 1534 | # patterns (like *.h and *.hpp) to filter out the header-files in the | ||
1737 | 1535 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | ||
1738 | 1536 | # be used. | ||
1739 | 1537 | |||
1740 | 1538 | INCLUDE_FILE_PATTERNS = | ||
1741 | 1539 | |||
1742 | 1540 | # The PREDEFINED tag can be used to specify one or more macro names that | ||
1743 | 1541 | # are defined before the preprocessor is started (similar to the -D option of | ||
1744 | 1542 | # gcc). The argument of the tag is a list of macros of the form: name | ||
1745 | 1543 | # or name=definition (no spaces). If the definition and the = are | ||
1746 | 1544 | # omitted =1 is assumed. To prevent a macro definition from being | ||
1747 | 1545 | # undefined via #undef or recursively expanded use the := operator | ||
1748 | 1546 | # instead of the = operator. | ||
1749 | 1547 | |||
1750 | 1548 | PREDEFINED = | ||
1751 | 1549 | |||
1752 | 1550 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | ||
1753 | 1551 | # this tag can be used to specify a list of macro names that should be expanded. | ||
1754 | 1552 | # The macro definition that is found in the sources will be used. | ||
1755 | 1553 | # Use the PREDEFINED tag if you want to use a different macro definition that | ||
1756 | 1554 | # overrules the definition found in the source code. | ||
1757 | 1555 | |||
1758 | 1556 | EXPAND_AS_DEFINED = | ||
1759 | 1557 | |||
1760 | 1558 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | ||
1761 | 1559 | # doxygen's preprocessor will remove all references to function-like macros | ||
1762 | 1560 | # that are alone on a line, have an all uppercase name, and do not end with a | ||
1763 | 1561 | # semicolon, because these will confuse the parser if not removed. | ||
1764 | 1562 | |||
1765 | 1563 | SKIP_FUNCTION_MACROS = YES | ||
1766 | 1564 | |||
1767 | 1565 | #--------------------------------------------------------------------------- | ||
1768 | 1566 | # Configuration::additions related to external references | ||
1769 | 1567 | #--------------------------------------------------------------------------- | ||
1770 | 1568 | |||
1771 | 1569 | # The TAGFILES option can be used to specify one or more tagfiles. For each | ||
1772 | 1570 | # tag file the location of the external documentation should be added. The | ||
1773 | 1571 | # format of a tag file without this location is as follows: | ||
1774 | 1572 | # TAGFILES = file1 file2 ... | ||
1775 | 1573 | # Adding location for the tag files is done as follows: | ||
1776 | 1574 | # TAGFILES = file1=loc1 "file2 = loc2" ... | ||
1777 | 1575 | # where "loc1" and "loc2" can be relative or absolute paths | ||
1778 | 1576 | # or URLs. Note that each tag file must have a unique name (where the name does | ||
1779 | 1577 | # NOT include the path). If a tag file is not located in the directory in which | ||
1780 | 1578 | # doxygen is run, you must also specify the path to the tagfile here. | ||
1781 | 1579 | |||
1782 | 1580 | TAGFILES = | ||
1783 | 1581 | |||
1784 | 1582 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | ||
1785 | 1583 | # a tag file that is based on the input files it reads. | ||
1786 | 1584 | |||
1787 | 1585 | GENERATE_TAGFILE = | ||
1788 | 1586 | |||
1789 | 1587 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | ||
1790 | 1588 | # in the class index. If set to NO only the inherited external classes | ||
1791 | 1589 | # will be listed. | ||
1792 | 1590 | |||
1793 | 1591 | ALLEXTERNALS = NO | ||
1794 | 1592 | |||
1795 | 1593 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | ||
1796 | 1594 | # in the modules index. If set to NO, only the current project's groups will | ||
1797 | 1595 | # be listed. | ||
1798 | 1596 | |||
1799 | 1597 | EXTERNAL_GROUPS = YES | ||
1800 | 1598 | |||
1801 | 1599 | # The PERL_PATH should be the absolute path and name of the perl script | ||
1802 | 1600 | # interpreter (i.e. the result of `which perl'). | ||
1803 | 1601 | |||
1804 | 1602 | PERL_PATH = /usr/bin/perl | ||
1805 | 1603 | |||
1806 | 1604 | #--------------------------------------------------------------------------- | ||
1807 | 1605 | # Configuration options related to the dot tool | ||
1808 | 1606 | #--------------------------------------------------------------------------- | ||
1809 | 1607 | |||
1810 | 1608 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | ||
1811 | 1609 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | ||
1812 | 1610 | # or super classes. Setting the tag to NO turns the diagrams off. Note that | ||
1813 | 1611 | # this option also works with HAVE_DOT disabled, but it is recommended to | ||
1814 | 1612 | # install and use dot, since it yields more powerful graphs. | ||
1815 | 1613 | |||
1816 | 1614 | CLASS_DIAGRAMS = YES | ||
1817 | 1615 | |||
1818 | 1616 | # You can define message sequence charts within doxygen comments using the \msc | ||
1819 | 1617 | # command. Doxygen will then run the mscgen tool (see | ||
1820 | 1618 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | ||
1821 | 1619 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | ||
1822 | 1620 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | ||
1823 | 1621 | # default search path. | ||
1824 | 1622 | |||
1825 | 1623 | DOT_PATH = @DOXYGEN_DOT_PATH@ | ||
1826 | 1624 | |||
1827 | 1625 | # If set to YES, the inheritance and collaboration graphs will hide | ||
1828 | 1626 | # inheritance and usage relations if the target is undocumented | ||
1829 | 1627 | # or is not a class. | ||
1830 | 1628 | |||
1831 | 1629 | HIDE_UNDOC_RELATIONS = YES | ||
1832 | 1630 | |||
1833 | 1631 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | ||
1834 | 1632 | # available from the path. This tool is part of Graphviz, a graph visualization | ||
1835 | 1633 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | ||
1836 | 1634 | # have no effect if this option is set to NO (the default) | ||
1837 | 1635 | |||
1838 | 1636 | HAVE_DOT = YES | ||
1839 | 1637 | |||
1840 | 1638 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | ||
1841 | 1639 | # allowed to run in parallel. When set to 0 (the default) doxygen will | ||
1842 | 1640 | # base this on the number of processors available in the system. You can set it | ||
1843 | 1641 | # explicitly to a value larger than 0 to get control over the balance | ||
1844 | 1642 | # between CPU load and processing speed. | ||
1845 | 1643 | |||
1846 | 1644 | DOT_NUM_THREADS = 0 | ||
1847 | 1645 | |||
1848 | 1646 | # By default doxygen will use the Helvetica font for all dot files that | ||
1849 | 1647 | # doxygen generates. When you want a differently looking font you can specify | ||
1850 | 1648 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find | ||
1851 | 1649 | # the font, which can be done by putting it in a standard location or by setting | ||
1852 | 1650 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | ||
1853 | 1651 | # directory containing the font. | ||
1854 | 1652 | |||
1855 | 1653 | DOT_FONTNAME = Helvetica | ||
1856 | 1654 | |||
1857 | 1655 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | ||
1858 | 1656 | # The default size is 10pt. | ||
1859 | 1657 | |||
1860 | 1658 | DOT_FONTSIZE = 10 | ||
1861 | 1659 | |||
1862 | 1660 | # By default doxygen will tell dot to use the Helvetica font. | ||
1863 | 1661 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to | ||
1864 | 1662 | # set the path where dot can find it. | ||
1865 | 1663 | |||
1866 | 1664 | DOT_FONTPATH = | ||
1867 | 1665 | |||
1868 | 1666 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1869 | 1667 | # will generate a graph for each documented class showing the direct and | ||
1870 | 1668 | # indirect inheritance relations. Setting this tag to YES will force the | ||
1871 | 1669 | # CLASS_DIAGRAMS tag to NO. | ||
1872 | 1670 | |||
1873 | 1671 | CLASS_GRAPH = YES | ||
1874 | 1672 | |||
1875 | 1673 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1876 | 1674 | # will generate a graph for each documented class showing the direct and | ||
1877 | 1675 | # indirect implementation dependencies (inheritance, containment, and | ||
1878 | 1676 | # class references variables) of the class with other documented classes. | ||
1879 | 1677 | |||
1880 | 1678 | COLLABORATION_GRAPH = YES | ||
1881 | 1679 | |||
1882 | 1680 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | ||
1883 | 1681 | # will generate a graph for groups, showing the direct groups dependencies | ||
1884 | 1682 | |||
1885 | 1683 | GROUP_GRAPHS = YES | ||
1886 | 1684 | |||
1887 | 1685 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | ||
1888 | 1686 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | ||
1889 | 1687 | # Language. | ||
1890 | 1688 | |||
1891 | 1689 | UML_LOOK = NO | ||
1892 | 1690 | |||
1893 | 1691 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside | ||
1894 | 1692 | # the class node. If there are many fields or methods and many nodes the | ||
1895 | 1693 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS | ||
1896 | 1694 | # threshold limits the number of items for each type to make the size more | ||
1897 | 1695 | # managable. Set this to 0 for no limit. Note that the threshold may be | ||
1898 | 1696 | # exceeded by 50% before the limit is enforced. | ||
1899 | 1697 | |||
1900 | 1698 | UML_LIMIT_NUM_FIELDS = 10 | ||
1901 | 1699 | |||
1902 | 1700 | # If set to YES, the inheritance and collaboration graphs will show the | ||
1903 | 1701 | # relations between templates and their instances. | ||
1904 | 1702 | |||
1905 | 1703 | TEMPLATE_RELATIONS = NO | ||
1906 | 1704 | |||
1907 | 1705 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | ||
1908 | 1706 | # tags are set to YES then doxygen will generate a graph for each documented | ||
1909 | 1707 | # file showing the direct and indirect include dependencies of the file with | ||
1910 | 1708 | # other documented files. | ||
1911 | 1709 | |||
1912 | 1710 | INCLUDE_GRAPH = YES | ||
1913 | 1711 | |||
1914 | 1712 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | ||
1915 | 1713 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | ||
1916 | 1714 | # documented header file showing the documented files that directly or | ||
1917 | 1715 | # indirectly include this file. | ||
1918 | 1716 | |||
1919 | 1717 | INCLUDED_BY_GRAPH = YES | ||
1920 | 1718 | |||
1921 | 1719 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then | ||
1922 | 1720 | # doxygen will generate a call dependency graph for every global function | ||
1923 | 1721 | # or class method. Note that enabling this option will significantly increase | ||
1924 | 1722 | # the time of a run. So in most cases it will be better to enable call graphs | ||
1925 | 1723 | # for selected functions only using the \callgraph command. | ||
1926 | 1724 | |||
1927 | 1725 | CALL_GRAPH = NO | ||
1928 | 1726 | |||
1929 | 1727 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | ||
1930 | 1728 | # doxygen will generate a caller dependency graph for every global function | ||
1931 | 1729 | # or class method. Note that enabling this option will significantly increase | ||
1932 | 1730 | # the time of a run. So in most cases it will be better to enable caller | ||
1933 | 1731 | # graphs for selected functions only using the \callergraph command. | ||
1934 | 1732 | |||
1935 | 1733 | CALLER_GRAPH = NO | ||
1936 | 1734 | |||
1937 | 1735 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | ||
1938 | 1736 | # will generate a graphical hierarchy of all classes instead of a textual one. | ||
1939 | 1737 | |||
1940 | 1738 | GRAPHICAL_HIERARCHY = YES | ||
1941 | 1739 | |||
1942 | 1740 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES | ||
1943 | 1741 | # then doxygen will show the dependencies a directory has on other directories | ||
1944 | 1742 | # in a graphical way. The dependency relations are determined by the #include | ||
1945 | 1743 | # relations between the files in the directories. | ||
1946 | 1744 | |||
1947 | 1745 | DIRECTORY_GRAPH = YES | ||
1948 | 1746 | |||
1949 | 1747 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
1950 | 1748 | # generated by dot. Possible values are svg, png, jpg, or gif. | ||
1951 | 1749 | # If left blank png will be used. If you choose svg you need to set | ||
1952 | 1750 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1953 | 1751 | # visible in IE 9+ (other browsers do not have this requirement). | ||
1954 | 1752 | |||
1955 | 1753 | DOT_IMAGE_FORMAT = png | ||
1956 | 1754 | |||
1957 | 1755 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to | ||
1958 | 1756 | # enable generation of interactive SVG images that allow zooming and panning. | ||
1959 | 1757 | # Note that this requires a modern browser other than Internet Explorer. | ||
1960 | 1758 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you | ||
1961 | 1759 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1962 | 1760 | # visible. Older versions of IE do not have SVG support. | ||
1963 | 1761 | |||
1964 | 1762 | INTERACTIVE_SVG = NO | ||
1965 | 1763 | |||
1966 | 1764 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | ||
1967 | 1765 | # found. If left blank, it is assumed the dot tool can be found in the path. | ||
1968 | 1766 | |||
1969 | 1767 | DOT_PATH = | ||
1970 | 1768 | |||
1971 | 1769 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
1972 | 1770 | # contain dot files that are included in the documentation (see the | ||
1973 | 1771 | # \dotfile command). | ||
1974 | 1772 | |||
1975 | 1773 | DOTFILE_DIRS = | ||
1976 | 1774 | |||
1977 | 1775 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
1978 | 1776 | # contain msc files that are included in the documentation (see the | ||
1979 | 1777 | # \mscfile command). | ||
1980 | 1778 | |||
1981 | 1779 | MSCFILE_DIRS = | ||
1982 | 1780 | |||
1983 | 1781 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | ||
1984 | 1782 | # nodes that will be shown in the graph. If the number of nodes in a graph | ||
1985 | 1783 | # becomes larger than this value, doxygen will truncate the graph, which is | ||
1986 | 1784 | # visualized by representing a node as a red box. Note that doxygen if the | ||
1987 | 1785 | # number of direct children of the root node in a graph is already larger than | ||
1988 | 1786 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | ||
1989 | 1787 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
1990 | 1788 | |||
1991 | 1789 | DOT_GRAPH_MAX_NODES = 50 | ||
1992 | 1790 | |||
1993 | 1791 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | ||
1994 | 1792 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | ||
1995 | 1793 | # from the root by following a path via at most 3 edges will be shown. Nodes | ||
1996 | 1794 | # that lay further from the root node will be omitted. Note that setting this | ||
1997 | 1795 | # option to 1 or 2 may greatly reduce the computation time needed for large | ||
1998 | 1796 | # code bases. Also note that the size of a graph can be further restricted by | ||
1999 | 1797 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
2000 | 1798 | |||
2001 | 1799 | MAX_DOT_GRAPH_DEPTH = 0 | ||
2002 | 1800 | |||
2003 | 1801 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
2004 | 1802 | # background. This is disabled by default, because dot on Windows does not | ||
2005 | 1803 | # seem to support this out of the box. Warning: Depending on the platform used, | ||
2006 | 1804 | # enabling this option may lead to badly anti-aliased labels on the edges of | ||
2007 | 1805 | # a graph (i.e. they become hard to read). | ||
2008 | 1806 | |||
2009 | 1807 | DOT_TRANSPARENT = NO | ||
2010 | 1808 | |||
2011 | 1809 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | ||
2012 | 1810 | # files in one run (i.e. multiple -o and -T options on the command line). This | ||
2013 | 1811 | # makes dot run faster, but since only newer versions of dot (>1.8.10) | ||
2014 | 1812 | # support this, this feature is disabled by default. | ||
2015 | 1813 | |||
2016 | 1814 | DOT_MULTI_TARGETS = NO | ||
2017 | 1815 | |||
2018 | 1816 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | ||
2019 | 1817 | # generate a legend page explaining the meaning of the various boxes and | ||
2020 | 1818 | # arrows in the dot generated graphs. | ||
2021 | 1819 | |||
2022 | 1820 | GENERATE_LEGEND = YES | ||
2023 | 1821 | |||
2024 | 1822 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | ||
2025 | 1823 | # remove the intermediate dot files that are used to generate | ||
2026 | 1824 | # the various graphs. | ||
2027 | 1825 | |||
2028 | 1826 | DOT_CLEANUP = YES | ||
2029 | 1827 | 0 | ||
2030 | === removed directory 'include' | |||
2031 | === removed file 'include/CMakeLists.txt' | |||
2032 | --- include/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
2033 | +++ include/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
2034 | @@ -1,4 +0,0 @@ | |||
2035 | 1 | set(HDR_INSTALL_DIR include) | ||
2036 | 2 | add_subdirectory(unity) | ||
2037 | 3 | |||
2038 | 4 | set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} PARENT_SCOPE) | ||
2039 | 5 | 0 | ||
2040 | === removed directory 'include/unity' | |||
2041 | === removed file 'include/unity/CMakeLists.txt' | |||
2042 | --- include/unity/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
2043 | +++ include/unity/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
2044 | @@ -1,10 +0,0 @@ | |||
2045 | 1 | add_subdirectory(api) | ||
2046 | 2 | add_subdirectory(scopes) | ||
2047 | 3 | add_subdirectory(util) | ||
2048 | 4 | |||
2049 | 5 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") | ||
2050 | 6 | file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") | ||
2051 | 7 | |||
2052 | 8 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity) | ||
2053 | 9 | |||
2054 | 10 | set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) | ||
2055 | 11 | 0 | ||
2056 | === removed file 'include/unity/Exception.h' | |||
2057 | --- include/unity/Exception.h 2013-04-17 02:18:48 +0000 | |||
2058 | +++ include/unity/Exception.h 1970-01-01 00:00:00 +0000 | |||
2059 | @@ -1,158 +0,0 @@ | |||
2060 | 1 | /* | ||
2061 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2062 | 3 | * | ||
2063 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2064 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2065 | 6 | * published by the Free Software Foundation. | ||
2066 | 7 | * | ||
2067 | 8 | * This program is distributed in the hope that it will be useful, | ||
2068 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2069 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2070 | 11 | * GNU General Public License for more details. | ||
2071 | 12 | * | ||
2072 | 13 | * You should have received a copy of the GNU General Public License | ||
2073 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2074 | 15 | * | ||
2075 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2076 | 17 | */ | ||
2077 | 18 | |||
2078 | 19 | #ifndef UNITY_EXCEPTION_H | ||
2079 | 20 | #define UNITY_EXCEPTION_H | ||
2080 | 21 | |||
2081 | 22 | #include <unity/config.h> | ||
2082 | 23 | |||
2083 | 24 | #include <exception> | ||
2084 | 25 | #include <string> | ||
2085 | 26 | #include <memory> | ||
2086 | 27 | |||
2087 | 28 | namespace unity | ||
2088 | 29 | { | ||
2089 | 30 | |||
2090 | 31 | namespace internal | ||
2091 | 32 | { | ||
2092 | 33 | class ExceptionImpl; | ||
2093 | 34 | } | ||
2094 | 35 | |||
2095 | 36 | // TODO: It probably would be best to split this into a base and ImplBase, with the derived part in the internal | ||
2096 | 37 | // namespace and declaring self(), the constructor, and pimpl(). That's because the Impl for the exception | ||
2097 | 38 | // is in the internal namespace, so public API clients can use Exception instances, but they cannot | ||
2098 | 39 | // create new derived exceptions because the Impl classes are internal to Unity. | ||
2099 | 40 | |||
2100 | 41 | /** | ||
2101 | 42 | \brief Abstract base class for all Unity exceptions. | ||
2102 | 43 | |||
2103 | 44 | This class is the base class for all Unity exceptions. Besides providing a common base class for | ||
2104 | 45 | structured exception handling, this class provides features to capture nested exceptions (for | ||
2105 | 46 | exceptions that are re-thrown) and to chain exceptions into an exception history that allows | ||
2106 | 47 | a number of exceptions to be remembered before throwing a new exception. | ||
2107 | 48 | |||
2108 | 49 | The exception nesting is provided by the derivation from <code>std::nested_exception</code>. If you | ||
2109 | 50 | catch an exception and throw another exception from the catch handler, the caught exception | ||
2110 | 51 | is automatically preserved; you can access nested exceptions by calling the <code>nested_ptr()</code> and | ||
2111 | 52 | <code>rethrow_nested()</code> member functions of <code>std::nested_exception</code>. | ||
2112 | 53 | |||
2113 | 54 | In addition, you can remember one or more exceptions by calling remember(). This is useful in situations | ||
2114 | 55 | where you need perform a number of actions that may fail with an error code, and you do not want to | ||
2115 | 56 | throw an exception until all of the actions have been attempted. This is particularly useful in shutdown | ||
2116 | 57 | scenarios, where it is often impossible to recover from an error, but it is still desirable to try to | ||
2117 | 58 | shut down as much as possible before reporting or logging the errors: | ||
2118 | 59 | |||
2119 | 60 | ~~~ | ||
2120 | 61 | void | ||
2121 | 62 | shutdown() | ||
2122 | 63 | { | ||
2123 | 64 | using namespace std; | ||
2124 | 65 | |||
2125 | 66 | exception_ptr ep; | ||
2126 | 67 | |||
2127 | 68 | try | ||
2128 | 69 | { | ||
2129 | 70 | shutdown_action_1(); | ||
2130 | 71 | } | ||
2131 | 72 | catch (SomeException const&) | ||
2132 | 73 | { | ||
2133 | 74 | ep = make_exception_ptr(current_exception()); | ||
2134 | 75 | } | ||
2135 | 76 | |||
2136 | 77 | try | ||
2137 | 78 | { | ||
2138 | 79 | shutdown_action_2(); | ||
2139 | 80 | } | ||
2140 | 81 | catch (SomeOtherException const&) | ||
2141 | 82 | { | ||
2142 | 83 | ep = e.remember(ep); | ||
2143 | 84 | } | ||
2144 | 85 | |||
2145 | 86 | int err = shutdown_action_3(); | ||
2146 | 87 | if (err != 0) | ||
2147 | 88 | { | ||
2148 | 89 | try | ||
2149 | 90 | { | ||
2150 | 91 | throw YetAnotherException(err); | ||
2151 | 92 | } | ||
2152 | 93 | catch (YetAnotherException const& e) | ||
2153 | 94 | { | ||
2154 | 95 | ep = e.remember(ep); | ||
2155 | 96 | } | ||
2156 | 97 | } | ||
2157 | 98 | |||
2158 | 99 | if (ep) | ||
2159 | 100 | { | ||
2160 | 101 | rethrow_exception(ep); | ||
2161 | 102 | } | ||
2162 | 103 | } | ||
2163 | 104 | ~~~ | ||
2164 | 105 | |||
2165 | 106 | Calling to_string() on a caught exception returns a string with the entire exception history (both nested and | ||
2166 | 107 | chained). | ||
2167 | 108 | |||
2168 | 109 | */ | ||
2169 | 110 | |||
2170 | 111 | class UNITY_API Exception : public std::exception, public std::nested_exception | ||
2171 | 112 | { | ||
2172 | 113 | public: | ||
2173 | 114 | //! @cond | ||
2174 | 115 | Exception(Exception const&); | ||
2175 | 116 | Exception& operator=(Exception const&); | ||
2176 | 117 | virtual ~Exception() noexcept; | ||
2177 | 118 | //! @endcond | ||
2178 | 119 | |||
2179 | 120 | /** | ||
2180 | 121 | \brief Returns the name of the exception. | ||
2181 | 122 | |||
2182 | 123 | Derived classes must override what() to return <i>only</i> the (fully-qualified) name of the derived | ||
2183 | 124 | exception. If the derived class sets a reason string (or contains other details), it should <i>not</i> | ||
2184 | 125 | include the reason or details as part of the string return returned by what(). | ||
2185 | 126 | */ | ||
2186 | 127 | virtual char const* what() const noexcept = 0; | ||
2187 | 128 | |||
2188 | 129 | virtual std::string reason() const; | ||
2189 | 130 | |||
2190 | 131 | virtual std::string to_string(std::string const& indent = " ") const; | ||
2191 | 132 | virtual std::string to_string(int indent_level, std::string const& indent) const; | ||
2192 | 133 | |||
2193 | 134 | std::exception_ptr remember(std::exception_ptr earlier_exception); | ||
2194 | 135 | std::exception_ptr get_earlier() const noexcept; | ||
2195 | 136 | |||
2196 | 137 | /** | ||
2197 | 138 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2198 | 139 | |||
2199 | 140 | \note Derived exceptions must implement this member function so the implemention of remember() | ||
2200 | 141 | (provided by this abstract base class) can return a <code>std::exception_ptr</code> to its own derived exception. | ||
2201 | 142 | */ | ||
2202 | 143 | virtual std::exception_ptr self() const = 0; | ||
2203 | 144 | |||
2204 | 145 | protected: | ||
2205 | 146 | //! @cond | ||
2206 | 147 | Exception(std::shared_ptr<internal::ExceptionImpl> const& derived); | ||
2207 | 148 | internal::ExceptionImpl* pimpl() const noexcept; // No need to reimplement in derived | ||
2208 | 149 | //! @endcond | ||
2209 | 150 | |||
2210 | 151 | private: | ||
2211 | 152 | std::shared_ptr<internal::ExceptionImpl> p_; // shared_ptr instead of unique_ptr because | ||
2212 | 153 | // exceptions must be copyable | ||
2213 | 154 | }; | ||
2214 | 155 | |||
2215 | 156 | } // namespace unity | ||
2216 | 157 | |||
2217 | 158 | #endif | ||
2218 | 159 | 0 | ||
2219 | === removed file 'include/unity/UnityExceptions.h' | |||
2220 | --- include/unity/UnityExceptions.h 2013-04-17 02:18:48 +0000 | |||
2221 | +++ include/unity/UnityExceptions.h 1970-01-01 00:00:00 +0000 | |||
2222 | @@ -1,258 +0,0 @@ | |||
2223 | 1 | /* | ||
2224 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2225 | 3 | * | ||
2226 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2227 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2228 | 6 | * published by the Free Software Foundation. | ||
2229 | 7 | * | ||
2230 | 8 | * This program is distributed in the hope that it will be useful, | ||
2231 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2232 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2233 | 11 | * GNU General Public License for more details. | ||
2234 | 12 | * | ||
2235 | 13 | * You should have received a copy of the GNU General Public License | ||
2236 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2237 | 15 | * | ||
2238 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2239 | 17 | */ | ||
2240 | 18 | |||
2241 | 19 | #ifndef UNITY_EXCEPTIONS_H | ||
2242 | 20 | #define UNITY_EXCEPTIONS_H | ||
2243 | 21 | |||
2244 | 22 | #include <unity/Exception.h> | ||
2245 | 23 | |||
2246 | 24 | namespace unity | ||
2247 | 25 | { | ||
2248 | 26 | |||
2249 | 27 | namespace internal | ||
2250 | 28 | { | ||
2251 | 29 | class InvalidArgumentExceptionImpl; | ||
2252 | 30 | } | ||
2253 | 31 | |||
2254 | 32 | /** | ||
2255 | 33 | \brief Exception to indicate that an invalid argument was passed to a function, such as passing <code>nullptr</code> | ||
2256 | 34 | when the function expects the argument to be non-null. | ||
2257 | 35 | */ | ||
2258 | 36 | |||
2259 | 37 | class UNITY_API InvalidArgumentException : public Exception | ||
2260 | 38 | { | ||
2261 | 39 | public: | ||
2262 | 40 | /** | ||
2263 | 41 | \brief Constructs the exception. | ||
2264 | 42 | \param reason Further details about the cause of the exception. | ||
2265 | 43 | */ | ||
2266 | 44 | explicit InvalidArgumentException(std::string const& reason); | ||
2267 | 45 | //! @cond | ||
2268 | 46 | InvalidArgumentException(InvalidArgumentException const&); | ||
2269 | 47 | InvalidArgumentException& operator=(InvalidArgumentException const&); | ||
2270 | 48 | virtual ~InvalidArgumentException() noexcept; | ||
2271 | 49 | //! @endcond | ||
2272 | 50 | |||
2273 | 51 | /** | ||
2274 | 52 | \brief Returns the fully-qualified name of the exception. | ||
2275 | 53 | */ | ||
2276 | 54 | virtual char const* what() const noexcept override; | ||
2277 | 55 | |||
2278 | 56 | /** | ||
2279 | 57 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2280 | 58 | */ | ||
2281 | 59 | virtual std::exception_ptr self() const override; | ||
2282 | 60 | }; | ||
2283 | 61 | |||
2284 | 62 | namespace internal | ||
2285 | 63 | { | ||
2286 | 64 | class LogicExceptionImpl; | ||
2287 | 65 | } | ||
2288 | 66 | |||
2289 | 67 | /** | ||
2290 | 68 | \brief Exception to indicate a logic error, such as driving the API incorrectly, such as calling methods | ||
2291 | 69 | in the wrong worder. | ||
2292 | 70 | */ | ||
2293 | 71 | |||
2294 | 72 | class UNITY_API LogicException : public Exception | ||
2295 | 73 | { | ||
2296 | 74 | public: | ||
2297 | 75 | /** | ||
2298 | 76 | \brief Constructs the exception. | ||
2299 | 77 | \param reason Further details about the cause of the exception. | ||
2300 | 78 | */ | ||
2301 | 79 | explicit LogicException(std::string const& reason); | ||
2302 | 80 | //! @cond | ||
2303 | 81 | LogicException(LogicException const&); | ||
2304 | 82 | LogicException& operator=(LogicException const&); | ||
2305 | 83 | virtual ~LogicException() noexcept; | ||
2306 | 84 | //! @endcond | ||
2307 | 85 | |||
2308 | 86 | /** | ||
2309 | 87 | \brief Returns the fully-qualified name of the exception. | ||
2310 | 88 | */ | ||
2311 | 89 | virtual char const* what() const noexcept override; | ||
2312 | 90 | |||
2313 | 91 | /** | ||
2314 | 92 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2315 | 93 | */ | ||
2316 | 94 | virtual std::exception_ptr self() const override; | ||
2317 | 95 | }; | ||
2318 | 96 | |||
2319 | 97 | namespace internal | ||
2320 | 98 | { | ||
2321 | 99 | class ShutdownExceptionImpl; | ||
2322 | 100 | } | ||
2323 | 101 | |||
2324 | 102 | /** | ||
2325 | 103 | \brief Exception to indicate errors during shutdown. | ||
2326 | 104 | |||
2327 | 105 | Usually, it is not possible to handle or recover | ||
2328 | 106 | from errors that arise during shutdown. This exception is thrown once all possible shutdown actions | ||
2329 | 107 | have been carried out and provides information about anything that went wrong via the exception | ||
2330 | 108 | chaining mechanism of the unity::Exception base class. | ||
2331 | 109 | */ | ||
2332 | 110 | |||
2333 | 111 | class UNITY_API ShutdownException : public Exception | ||
2334 | 112 | { | ||
2335 | 113 | public: | ||
2336 | 114 | /** | ||
2337 | 115 | \brief Constructs the exception. | ||
2338 | 116 | \param reason Further details about the cause of the exception. | ||
2339 | 117 | */ | ||
2340 | 118 | explicit ShutdownException(std::string const& reason); | ||
2341 | 119 | //! @cond | ||
2342 | 120 | ShutdownException(ShutdownException const&); | ||
2343 | 121 | ShutdownException& operator=(ShutdownException const&); | ||
2344 | 122 | virtual ~ShutdownException() noexcept; | ||
2345 | 123 | //! @endcond | ||
2346 | 124 | |||
2347 | 125 | /** | ||
2348 | 126 | \brief Returns the fully-qualified name of the exception. | ||
2349 | 127 | */ | ||
2350 | 128 | virtual char const* what() const noexcept override; | ||
2351 | 129 | |||
2352 | 130 | /** | ||
2353 | 131 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2354 | 132 | */ | ||
2355 | 133 | virtual std::exception_ptr self() const override; | ||
2356 | 134 | }; | ||
2357 | 135 | |||
2358 | 136 | namespace internal | ||
2359 | 137 | { | ||
2360 | 138 | class FileExceptionImpl; | ||
2361 | 139 | } | ||
2362 | 140 | |||
2363 | 141 | /** | ||
2364 | 142 | \brief Exception to indicate file I/O errors, such as failure to open or write to a file. | ||
2365 | 143 | */ | ||
2366 | 144 | |||
2367 | 145 | class UNITY_API FileException : public Exception | ||
2368 | 146 | { | ||
2369 | 147 | public: | ||
2370 | 148 | /** | ||
2371 | 149 | \brief Constructs the exception. | ||
2372 | 150 | */ | ||
2373 | 151 | /** | ||
2374 | 152 | \brief Constructs the exception from a reason string and and error number. | ||
2375 | 153 | \param reason Further details about the cause of the exception. | ||
2376 | 154 | \param err The UNIX <code>errno</code> value for the error. | ||
2377 | 155 | */ | ||
2378 | 156 | FileException(std::string const& reason, int err); | ||
2379 | 157 | //! @cond | ||
2380 | 158 | FileException(FileException const&); | ||
2381 | 159 | FileException& operator=(FileException const&); | ||
2382 | 160 | virtual ~FileException() noexcept; | ||
2383 | 161 | //! @endcond | ||
2384 | 162 | |||
2385 | 163 | /** | ||
2386 | 164 | \brief Returns the fully-qualified name of the exception. | ||
2387 | 165 | */ | ||
2388 | 166 | virtual char const* what() const noexcept override; | ||
2389 | 167 | |||
2390 | 168 | /** | ||
2391 | 169 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2392 | 170 | */ | ||
2393 | 171 | virtual std::exception_ptr self() const override; | ||
2394 | 172 | |||
2395 | 173 | /** | ||
2396 | 174 | \return Returns the error number that was passed to the constructor. | ||
2397 | 175 | */ | ||
2398 | 176 | int error() const noexcept; | ||
2399 | 177 | }; | ||
2400 | 178 | |||
2401 | 179 | namespace internal | ||
2402 | 180 | { | ||
2403 | 181 | class SyscallExceptionImpl; | ||
2404 | 182 | } | ||
2405 | 183 | |||
2406 | 184 | /** | ||
2407 | 185 | \brief Exception to indicate system or library call errors that set <code>errno</code>. | ||
2408 | 186 | */ | ||
2409 | 187 | |||
2410 | 188 | class UNITY_API SyscallException : public Exception | ||
2411 | 189 | { | ||
2412 | 190 | public: | ||
2413 | 191 | /** | ||
2414 | 192 | \brief Constructs the exception. | ||
2415 | 193 | */ | ||
2416 | 194 | /** | ||
2417 | 195 | \brief Constructs the exception from a reason string and and error number. | ||
2418 | 196 | \param reason Further details about the cause of the exception. | ||
2419 | 197 | \param err The UNIX <code>errno</code> value for the error. | ||
2420 | 198 | */ | ||
2421 | 199 | SyscallException(std::string const& reason, int err); | ||
2422 | 200 | //! @cond | ||
2423 | 201 | SyscallException(SyscallException const&); | ||
2424 | 202 | SyscallException& operator=(SyscallException const&); | ||
2425 | 203 | virtual ~SyscallException() noexcept; | ||
2426 | 204 | //! @endcond | ||
2427 | 205 | |||
2428 | 206 | /** | ||
2429 | 207 | \brief Returns the fully-qualified name of the exception. | ||
2430 | 208 | */ | ||
2431 | 209 | virtual char const* what() const noexcept override; | ||
2432 | 210 | |||
2433 | 211 | /** | ||
2434 | 212 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2435 | 213 | */ | ||
2436 | 214 | virtual std::exception_ptr self() const override; | ||
2437 | 215 | |||
2438 | 216 | /** | ||
2439 | 217 | \return Returns the error number that was passed to the constructor. | ||
2440 | 218 | */ | ||
2441 | 219 | int error() const noexcept; | ||
2442 | 220 | }; | ||
2443 | 221 | |||
2444 | 222 | namespace internal | ||
2445 | 223 | { | ||
2446 | 224 | class ResourceExceptionImpl; | ||
2447 | 225 | } | ||
2448 | 226 | |||
2449 | 227 | /** | ||
2450 | 228 | \brief Exception for miscellaneous errors, such as failure of a third-party library or hitting resource limitations. | ||
2451 | 229 | */ | ||
2452 | 230 | |||
2453 | 231 | class UNITY_API ResourceException : public Exception | ||
2454 | 232 | { | ||
2455 | 233 | public: | ||
2456 | 234 | /** | ||
2457 | 235 | \brief Constructs the exception. | ||
2458 | 236 | \param reason Further details about the cause of the exception. | ||
2459 | 237 | */ | ||
2460 | 238 | ResourceException(std::string const& reason); | ||
2461 | 239 | //! @cond | ||
2462 | 240 | ResourceException(ResourceException const&); | ||
2463 | 241 | ResourceException& operator=(ResourceException const&); | ||
2464 | 242 | virtual ~ResourceException() noexcept; | ||
2465 | 243 | //! @endcond | ||
2466 | 244 | |||
2467 | 245 | /** | ||
2468 | 246 | \brief Returns the fully-qualified name of the exception. | ||
2469 | 247 | */ | ||
2470 | 248 | virtual char const* what() const noexcept override; | ||
2471 | 249 | |||
2472 | 250 | /** | ||
2473 | 251 | \brief Returns a <code>std::exception_ptr</code> to <code>this</code>. | ||
2474 | 252 | */ | ||
2475 | 253 | virtual std::exception_ptr self() const override; | ||
2476 | 254 | }; | ||
2477 | 255 | |||
2478 | 256 | } // namespace unity | ||
2479 | 257 | |||
2480 | 258 | #endif | ||
2481 | 259 | 0 | ||
2482 | === removed directory 'include/unity/api' | |||
2483 | === removed file 'include/unity/api/CMakeLists.txt' | |||
2484 | --- include/unity/api/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
2485 | +++ include/unity/api/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
2486 | @@ -1,12 +0,0 @@ | |||
2487 | 1 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") | ||
2488 | 2 | file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") | ||
2489 | 3 | |||
2490 | 4 | # | ||
2491 | 5 | # Generated headers | ||
2492 | 6 | # | ||
2493 | 7 | configure_file(Version.h.in Version.h) | ||
2494 | 8 | set(headers ${headers} ${CMAKE_CURRENT_BINARY_DIR}/Version.h) | ||
2495 | 9 | |||
2496 | 10 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity/api) | ||
2497 | 11 | |||
2498 | 12 | set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) | ||
2499 | 13 | 0 | ||
2500 | === removed file 'include/unity/api/Version.h.in' | |||
2501 | --- include/unity/api/Version.h.in 2013-04-18 00:06:43 +0000 | |||
2502 | +++ include/unity/api/Version.h.in 1970-01-01 00:00:00 +0000 | |||
2503 | @@ -1,103 +0,0 @@ | |||
2504 | 1 | // | ||
2505 | 2 | // DO NOT EDIT Version.h (this file)! It is generated from Version.h.in. | ||
2506 | 3 | // | ||
2507 | 4 | |||
2508 | 5 | /* | ||
2509 | 6 | * Copyright (C) 2013 Canonical Ltd | ||
2510 | 7 | * | ||
2511 | 8 | * This program is free software: you can redistribute it and/or modify | ||
2512 | 9 | * it under the terms of the GNU General Public License version 3 as | ||
2513 | 10 | * published by the Free Software Foundation. | ||
2514 | 11 | * | ||
2515 | 12 | * This program is distributed in the hope that it will be useful, | ||
2516 | 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2517 | 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2518 | 15 | * GNU General Public License for more details. | ||
2519 | 16 | * | ||
2520 | 17 | * You should have received a copy of the GNU General Public License | ||
2521 | 18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2522 | 19 | * | ||
2523 | 20 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2524 | 21 | */ | ||
2525 | 22 | |||
2526 | 23 | #include <unity/config.h> | ||
2527 | 24 | |||
2528 | 25 | #ifndef UNITY_API_VERSION_H | ||
2529 | 26 | #define UNITY_API_VERSION_H | ||
2530 | 27 | |||
2531 | 28 | #define UNITY_API_VERSION_MAJOR @UNITY_API_MAJOR@ | ||
2532 | 29 | #define UNITY_API_VERSION_MINOR @UNITY_API_MINOR@ | ||
2533 | 30 | #define UNITY_API_VERSION_MICRO @UNITY_API_MICRO@ | ||
2534 | 31 | |||
2535 | 32 | #define UNITY_API_VERSION_STRING "@UNITY_API_VERSION@" | ||
2536 | 33 | |||
2537 | 34 | namespace unity | ||
2538 | 35 | { | ||
2539 | 36 | |||
2540 | 37 | namespace api | ||
2541 | 38 | { | ||
2542 | 39 | |||
2543 | 40 | /** | ||
2544 | 41 | \brief Class to obtain version information for the Unity API at run time. | ||
2545 | 42 | |||
2546 | 43 | Version information is represented as | ||
2547 | 44 | <i><<code>major</code>></i>.<i><<code>minor</code>></i>.<i><<code>micro</code>></i>. | ||
2548 | 45 | |||
2549 | 46 | Releases that differ in the major or minor version number are binary incompatible. | ||
2550 | 47 | |||
2551 | 48 | Releases of the library that differ only in the micro version number are binary compatible with older releases, | ||
2552 | 49 | so client code does not need to be recompiled to use the newer library version. | ||
2553 | 50 | |||
2554 | 51 | A different minor version is compatible at the API level, that is, it may add new APIs, but does not change existing | ||
2555 | 52 | ones. API clients must be recompiled for a new minor version. | ||
2556 | 53 | |||
2557 | 54 | A different major version indicates incompatible API changes. | ||
2558 | 55 | */ | ||
2559 | 56 | |||
2560 | 57 | // Version could be a namespace instead of a class, but that requires a lower-case name, | ||
2561 | 58 | // which is inconsistent with the remainder of the API. | ||
2562 | 59 | |||
2563 | 60 | class UNITY_API Version | ||
2564 | 61 | { | ||
2565 | 62 | public: | ||
2566 | 63 | /** | ||
2567 | 64 | \brief Returns the major version number of the Unity API library. | ||
2568 | 65 | |||
2569 | 66 | The major version number is also available as the macro <code>UNITY_API_VERSION_MAJOR</code>. | ||
2570 | 67 | */ | ||
2571 | 68 | static int major_version(); | ||
2572 | 69 | |||
2573 | 70 | /** | ||
2574 | 71 | \brief Returns the minor version number of the Unity API library. | ||
2575 | 72 | |||
2576 | 73 | The minor version number is also available as the macro <code>UNITY_API_VERSION_MINOR</code>. | ||
2577 | 74 | */ | ||
2578 | 75 | static int minor_version(); | ||
2579 | 76 | |||
2580 | 77 | /** | ||
2581 | 78 | \brief Returns the micro version number of the Unity API library. | ||
2582 | 79 | |||
2583 | 80 | The micro version number is also available as the macro <code>UNITY_API_VERSION_MICRO</code>. | ||
2584 | 81 | */ | ||
2585 | 82 | static int micro_version(); | ||
2586 | 83 | |||
2587 | 84 | /** | ||
2588 | 85 | \brief Returns the Unity API version as a string in the format | ||
2589 | 86 | <i><<code>major</code>></i>.<i><<code>minor</code>></i>.<i><<code>micro</code>></i>. | ||
2590 | 87 | |||
2591 | 88 | The version string is also available as the macro <code>UNITY_API_VERSION_STRING</code>. | ||
2592 | 89 | */ | ||
2593 | 90 | static const char* str(); // Returns "major.minor.micro" | ||
2594 | 91 | |||
2595 | 92 | // TODO: Add methods to report compiler version and compiler flags | ||
2596 | 93 | |||
2597 | 94 | private: | ||
2598 | 95 | Version() = delete; | ||
2599 | 96 | ~Version() = delete; | ||
2600 | 97 | }; | ||
2601 | 98 | |||
2602 | 99 | } // namespace api | ||
2603 | 100 | |||
2604 | 101 | } // namespace unity | ||
2605 | 102 | |||
2606 | 103 | #endif | ||
2607 | 104 | 0 | ||
2608 | === removed directory 'include/unity/api/internal' | |||
2609 | === removed file 'include/unity/config.h' | |||
2610 | --- include/unity/config.h 2013-04-08 03:05:05 +0000 | |||
2611 | +++ include/unity/config.h 1970-01-01 00:00:00 +0000 | |||
2612 | @@ -1,30 +0,0 @@ | |||
2613 | 1 | /* | ||
2614 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2615 | 3 | * | ||
2616 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2617 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2618 | 6 | * published by the Free Software Foundation. | ||
2619 | 7 | * | ||
2620 | 8 | * This program is distributed in the hope that it will be useful, | ||
2621 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2622 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2623 | 11 | * GNU General Public License for more details. | ||
2624 | 12 | * | ||
2625 | 13 | * You should have received a copy of the GNU General Public License | ||
2626 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2627 | 15 | * | ||
2628 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2629 | 17 | */ | ||
2630 | 18 | |||
2631 | 19 | #ifndef UNITY_CONFIG_H | ||
2632 | 20 | #define UNITY_CONFIG_H | ||
2633 | 21 | |||
2634 | 22 | #define UNITY_HELPER_DLL_EXPORT __attribute__ ((visibility ("default"))) | ||
2635 | 23 | |||
2636 | 24 | #ifdef UNITY_DLL_EXPORTS // Defined if we are building the Unity API library | ||
2637 | 25 | #define UNITY_API UNITY_HELPER_DLL_EXPORT | ||
2638 | 26 | #else | ||
2639 | 27 | #define UNITY_API /**/ | ||
2640 | 28 | #endif | ||
2641 | 29 | |||
2642 | 30 | #endif | ||
2643 | 31 | 0 | ||
2644 | === removed directory 'include/unity/internal' | |||
2645 | === removed file 'include/unity/internal/ExceptionImpl.h' | |||
2646 | --- include/unity/internal/ExceptionImpl.h 2013-04-04 02:16:16 +0000 | |||
2647 | +++ include/unity/internal/ExceptionImpl.h 1970-01-01 00:00:00 +0000 | |||
2648 | @@ -1,60 +0,0 @@ | |||
2649 | 1 | /* | ||
2650 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2651 | 3 | * | ||
2652 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2653 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2654 | 6 | * published by the Free Software Foundation. | ||
2655 | 7 | * | ||
2656 | 8 | * This program is distributed in the hope that it will be useful, | ||
2657 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2658 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2659 | 11 | * GNU General Public License for more details. | ||
2660 | 12 | * | ||
2661 | 13 | * You should have received a copy of the GNU General Public License | ||
2662 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2663 | 15 | * | ||
2664 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2665 | 17 | */ | ||
2666 | 18 | |||
2667 | 19 | #ifndef UNITY_INTERNAL_EXCEPTIONIMPL_H | ||
2668 | 20 | #define UNITY_INTERNAL_EXCEPTIONIMPL_H | ||
2669 | 21 | |||
2670 | 22 | #include <unity/util/NonCopyable.h> | ||
2671 | 23 | |||
2672 | 24 | #include <string> | ||
2673 | 25 | #include <exception> | ||
2674 | 26 | |||
2675 | 27 | namespace unity | ||
2676 | 28 | { | ||
2677 | 29 | |||
2678 | 30 | class Exception; | ||
2679 | 31 | |||
2680 | 32 | namespace internal | ||
2681 | 33 | { | ||
2682 | 34 | |||
2683 | 35 | class ExceptionImpl : private util::NonCopyable | ||
2684 | 36 | { | ||
2685 | 37 | public: | ||
2686 | 38 | explicit ExceptionImpl(std::string const& reason); | ||
2687 | 39 | |||
2688 | 40 | virtual char const* what() const noexcept = 0; | ||
2689 | 41 | virtual std::string reason() const; | ||
2690 | 42 | virtual std::string to_string(std::nested_exception const& nested, int indent_level, std::string const& indent) const; | ||
2691 | 43 | |||
2692 | 44 | std::exception_ptr remember(unity::Exception const* env, std::exception_ptr earlier_exception); | ||
2693 | 45 | std::exception_ptr remember(unity::Exception const* env, Exception const& earlier_exception); | ||
2694 | 46 | std::exception_ptr get_earlier() const noexcept; | ||
2695 | 47 | |||
2696 | 48 | protected: | ||
2697 | 49 | virtual ~ExceptionImpl() noexcept; | ||
2698 | 50 | |||
2699 | 51 | private: | ||
2700 | 52 | std::string const reason_; | ||
2701 | 53 | std::exception_ptr previous_; | ||
2702 | 54 | }; | ||
2703 | 55 | |||
2704 | 56 | } // namespace internal | ||
2705 | 57 | |||
2706 | 58 | } // namespace unity | ||
2707 | 59 | |||
2708 | 60 | #endif | ||
2709 | 61 | 0 | ||
2710 | === removed file 'include/unity/internal/UnityExceptionsImpl.h' | |||
2711 | --- include/unity/internal/UnityExceptionsImpl.h 2013-04-04 02:16:16 +0000 | |||
2712 | +++ include/unity/internal/UnityExceptionsImpl.h 1970-01-01 00:00:00 +0000 | |||
2713 | @@ -1,95 +0,0 @@ | |||
2714 | 1 | /* | ||
2715 | 2 | * Copyright (C) 2012 Canonical Ltd | ||
2716 | 3 | * | ||
2717 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2718 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2719 | 6 | * published by the Free Software Foundation. | ||
2720 | 7 | * | ||
2721 | 8 | * This program is distributed in the hope that it will be useful, | ||
2722 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2723 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2724 | 11 | * GNU General Public License for more details. | ||
2725 | 12 | * | ||
2726 | 13 | * You should have received a copy of the GNU General Public License | ||
2727 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2728 | 15 | * | ||
2729 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2730 | 17 | */ | ||
2731 | 18 | |||
2732 | 19 | #ifndef UNITY_INTERNAL_UNITYEXCEPTIONSIMPL_H | ||
2733 | 20 | #define UNITY_INTERNAL_UNITYEXCEPTIONSIMPL_H | ||
2734 | 21 | |||
2735 | 22 | #include <unity/internal/ExceptionImpl.h> | ||
2736 | 23 | |||
2737 | 24 | #include <string> | ||
2738 | 25 | #include <exception> | ||
2739 | 26 | |||
2740 | 27 | namespace unity | ||
2741 | 28 | { | ||
2742 | 29 | |||
2743 | 30 | class Exception; | ||
2744 | 31 | |||
2745 | 32 | namespace internal | ||
2746 | 33 | { | ||
2747 | 34 | |||
2748 | 35 | class InvalidArgumentExceptionImpl : public ExceptionImpl | ||
2749 | 36 | { | ||
2750 | 37 | public: | ||
2751 | 38 | InvalidArgumentExceptionImpl(std::string const& reason); | ||
2752 | 39 | |||
2753 | 40 | virtual char const* what() const noexcept override; | ||
2754 | 41 | }; | ||
2755 | 42 | |||
2756 | 43 | class LogicExceptionImpl : public ExceptionImpl | ||
2757 | 44 | { | ||
2758 | 45 | public: | ||
2759 | 46 | LogicExceptionImpl(std::string const& reason); | ||
2760 | 47 | |||
2761 | 48 | virtual char const* what() const noexcept override; | ||
2762 | 49 | }; | ||
2763 | 50 | |||
2764 | 51 | class ShutdownExceptionImpl : public ExceptionImpl | ||
2765 | 52 | { | ||
2766 | 53 | public: | ||
2767 | 54 | ShutdownExceptionImpl(std::string const& reason); | ||
2768 | 55 | |||
2769 | 56 | virtual char const* what() const noexcept override; | ||
2770 | 57 | }; | ||
2771 | 58 | |||
2772 | 59 | class FileExceptionImpl : public ExceptionImpl | ||
2773 | 60 | { | ||
2774 | 61 | public: | ||
2775 | 62 | FileExceptionImpl(std::string const& reason, int err); | ||
2776 | 63 | |||
2777 | 64 | virtual char const* what() const noexcept override; | ||
2778 | 65 | int error() const noexcept; | ||
2779 | 66 | |||
2780 | 67 | private: | ||
2781 | 68 | int errno_; | ||
2782 | 69 | }; | ||
2783 | 70 | |||
2784 | 71 | class SyscallExceptionImpl : public ExceptionImpl | ||
2785 | 72 | { | ||
2786 | 73 | public: | ||
2787 | 74 | SyscallExceptionImpl(std::string const& reason, int err); | ||
2788 | 75 | |||
2789 | 76 | virtual char const* what() const noexcept override; | ||
2790 | 77 | int error() const noexcept; | ||
2791 | 78 | |||
2792 | 79 | private: | ||
2793 | 80 | int const errno_; | ||
2794 | 81 | }; | ||
2795 | 82 | |||
2796 | 83 | class ResourceExceptionImpl : public ExceptionImpl | ||
2797 | 84 | { | ||
2798 | 85 | public: | ||
2799 | 86 | ResourceExceptionImpl(std::string const& reason); | ||
2800 | 87 | |||
2801 | 88 | virtual char const* what() const noexcept override; | ||
2802 | 89 | }; | ||
2803 | 90 | |||
2804 | 91 | } // namespace internal | ||
2805 | 92 | |||
2806 | 93 | } // namespace unity | ||
2807 | 94 | |||
2808 | 95 | #endif | ||
2809 | 96 | 0 | ||
2810 | === removed directory 'include/unity/scopes' | |||
2811 | === removed file 'include/unity/scopes/CMakeLists.txt' | |||
2812 | --- include/unity/scopes/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
2813 | +++ include/unity/scopes/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
2814 | @@ -1,6 +0,0 @@ | |||
2815 | 1 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") | ||
2816 | 2 | file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") | ||
2817 | 3 | |||
2818 | 4 | install(FILES ${headers} DESTINATION include/unity/scopes) | ||
2819 | 5 | |||
2820 | 6 | set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) | ||
2821 | 7 | 0 | ||
2822 | === removed directory 'include/unity/scopes/internal' | |||
2823 | === removed directory 'include/unity/util' | |||
2824 | === removed file 'include/unity/util/CMakeLists.txt' | |||
2825 | --- include/unity/util/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
2826 | +++ include/unity/util/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
2827 | @@ -1,6 +0,0 @@ | |||
2828 | 1 | file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h") | ||
2829 | 2 | file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h") | ||
2830 | 3 | |||
2831 | 4 | install(FILES ${headers} DESTINATION ${HDR_INSTALL_DIR}/unity/util) | ||
2832 | 5 | |||
2833 | 6 | set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE) | ||
2834 | 7 | 0 | ||
2835 | === removed file 'include/unity/util/Daemon.h' | |||
2836 | --- include/unity/util/Daemon.h 2013-04-08 03:05:05 +0000 | |||
2837 | +++ include/unity/util/Daemon.h 1970-01-01 00:00:00 +0000 | |||
2838 | @@ -1,129 +0,0 @@ | |||
2839 | 1 | /* | ||
2840 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2841 | 3 | * | ||
2842 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2843 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2844 | 6 | * published by the Free Software Foundation. | ||
2845 | 7 | * | ||
2846 | 8 | * This program is distributed in the hope that it will be useful, | ||
2847 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2848 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2849 | 11 | * GNU General Public License for more details. | ||
2850 | 12 | * | ||
2851 | 13 | * You should have received a copy of the GNU General Public License | ||
2852 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2853 | 15 | * | ||
2854 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2855 | 17 | */ | ||
2856 | 18 | |||
2857 | 19 | #ifndef UNITY_UTIL_DAEMON_H | ||
2858 | 20 | #define UNITY_UTIL_DAEMON_H | ||
2859 | 21 | |||
2860 | 22 | #include <unity/util/DefinesPtrs.h> | ||
2861 | 23 | #include <unity/util/NonCopyable.h> | ||
2862 | 24 | |||
2863 | 25 | #include <sys/types.h> | ||
2864 | 26 | |||
2865 | 27 | namespace unity | ||
2866 | 28 | { | ||
2867 | 29 | |||
2868 | 30 | namespace util | ||
2869 | 31 | { | ||
2870 | 32 | |||
2871 | 33 | namespace internal | ||
2872 | 34 | { | ||
2873 | 35 | class DaemonImpl; | ||
2874 | 36 | } | ||
2875 | 37 | |||
2876 | 38 | /** | ||
2877 | 39 | \class Daemon | ||
2878 | 40 | \brief Helper class to turn a process into a daemon. | ||
2879 | 41 | |||
2880 | 42 | To turn a process into a daemon, instantiate this class and call daemonize_me(). | ||
2881 | 43 | |||
2882 | 44 | The new process becomes a session leader without a control terminal. The standard | ||
2883 | 45 | file descriptors (<code>stdin</code>, <code>stdout</code>, and stderr) are closed | ||
2884 | 46 | and re-opened to <code>/dev/null</code>. | ||
2885 | 47 | |||
2886 | 48 | By default, any file descriptors (other than the standard three) that are open in the process | ||
2887 | 49 | remain open to the same destinations in the daemon. If you want to have other descriptors closed, call | ||
2888 | 50 | close_fds() before calling daemonize_me(). This will close all file descriptors > 2. | ||
2889 | 51 | |||
2890 | 52 | By default, the signal disposition of the daemon is unchanged. To reset all signals to their | ||
2891 | 53 | default disposition, call reset_signals() before calling daemonize_me(). | ||
2892 | 54 | |||
2893 | 55 | By default, the umask of the daemon is unchanged. To set a different umask, call set_umask() | ||
2894 | 56 | before calling daemonize_me(). | ||
2895 | 57 | |||
2896 | 58 | By default, the working directory of the daemon is unchanged. To run the daemon with a different | ||
2897 | 59 | working directory, call set_working_dir() before calling daemonize_me(). Note that the working | ||
2898 | 60 | directory should be set to a path that is in the root file system. If the working directory | ||
2899 | 61 | is in any other file system, that file system cannot be unmounted while the daemon is running. | ||
2900 | 62 | |||
2901 | 63 | Note: This class is not async signal-safe. Do not call daemonize_me() from a a signal handler. | ||
2902 | 64 | */ | ||
2903 | 65 | |||
2904 | 66 | class UNITY_API Daemon final : public util::DefinesPtrs<Daemon>, private NonCopyable | ||
2905 | 67 | { | ||
2906 | 68 | public: | ||
2907 | 69 | /** | ||
2908 | 70 | \brief Create a Daemon instance. | ||
2909 | 71 | \return A <code>unique_ptr</code> to the instance. | ||
2910 | 72 | */ | ||
2911 | 73 | static UPtr create(); | ||
2912 | 74 | |||
2913 | 75 | /** | ||
2914 | 76 | \brief Causes daemonize_me() to close all open file descriptors other than the standard file | ||
2915 | 77 | descriptors (which are connected <code>/dev/null</code>). | ||
2916 | 78 | */ | ||
2917 | 79 | void close_fds() noexcept; | ||
2918 | 80 | |||
2919 | 81 | /** | ||
2920 | 82 | \brief Causes daemonize_me() to reset all signals to their default behavior. | ||
2921 | 83 | */ | ||
2922 | 84 | void reset_signals() noexcept; | ||
2923 | 85 | |||
2924 | 86 | /** | ||
2925 | 87 | \brief Causes daemonize_me() to set the umask. | ||
2926 | 88 | \param mask The umask for the daemon process. | ||
2927 | 89 | */ | ||
2928 | 90 | void set_umask(mode_t mask) noexcept; | ||
2929 | 91 | |||
2930 | 92 | /** | ||
2931 | 93 | \brief Causes daemonize_me() to set the working directory. | ||
2932 | 94 | \param working_directory The working directory for the daemon process. | ||
2933 | 95 | \throws SyscallException The process could not change the working directory to the specified directory. | ||
2934 | 96 | \note Daemon processes should set their working to "/" or to a directory that is part of the root file system. | ||
2935 | 97 | Otherwise, the file system containing the daemon's working directory cannot be unmounted without first | ||
2936 | 98 | killing the daemon process. | ||
2937 | 99 | */ | ||
2938 | 100 | void set_working_directory(std::string const& working_directory); | ||
2939 | 101 | |||
2940 | 102 | /** | ||
2941 | 103 | \brief Turns the calling process into a daemon. | ||
2942 | 104 | |||
2943 | 105 | By default, daemonize_me() leaves open file descriptors, signal disposition, umask, and working | ||
2944 | 106 | directory unchanged. Call the corresponding member function before calling daemonize_me() to | ||
2945 | 107 | change this behavior as appropriate. | ||
2946 | 108 | |||
2947 | 109 | \note Calling daemonize_me() more than once is safe; any changes to file descriptors, signal disposition, | ||
2948 | 110 | umask, or working directory as requested by calling the other member functions will be correctly set | ||
2949 | 111 | for the calling process. However, daemonize_me() is not a cheap call because it calls <code>fork()</code>; | ||
2950 | 112 | the normal use pattern is to create a Daemon instance, select the desired settings, call daemonize_me(), | ||
2951 | 113 | and let the instance go out of scope. | ||
2952 | 114 | */ | ||
2953 | 115 | void daemonize_me(); | ||
2954 | 116 | |||
2955 | 117 | ~Daemon() noexcept; | ||
2956 | 118 | |||
2957 | 119 | private: | ||
2958 | 120 | Daemon(); // Class is final, instantiation only via create() | ||
2959 | 121 | |||
2960 | 122 | std::unique_ptr<internal::DaemonImpl> p_; | ||
2961 | 123 | }; | ||
2962 | 124 | |||
2963 | 125 | } // namespace util | ||
2964 | 126 | |||
2965 | 127 | } // namespace unity | ||
2966 | 128 | |||
2967 | 129 | #endif | ||
2968 | 130 | 0 | ||
2969 | === removed file 'include/unity/util/DefinesPtrs.h' | |||
2970 | --- include/unity/util/DefinesPtrs.h 2013-04-09 02:00:18 +0000 | |||
2971 | +++ include/unity/util/DefinesPtrs.h 1970-01-01 00:00:00 +0000 | |||
2972 | @@ -1,89 +0,0 @@ | |||
2973 | 1 | /* | ||
2974 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
2975 | 3 | * | ||
2976 | 4 | * This program is free software: you can redistribute it and/or modify | ||
2977 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
2978 | 6 | * published by the Free Software Foundation. | ||
2979 | 7 | * | ||
2980 | 8 | * This program is distributed in the hope that it will be useful, | ||
2981 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
2982 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
2983 | 11 | * GNU General Public License for more details. | ||
2984 | 12 | * | ||
2985 | 13 | * You should have received a copy of the GNU General Public License | ||
2986 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
2987 | 15 | * | ||
2988 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
2989 | 17 | */ | ||
2990 | 18 | |||
2991 | 19 | #ifndef UNITY_UTIL_DEFINESPTRS_H | ||
2992 | 20 | #define UNITY_UTIL_DEFINESPTRS_H | ||
2993 | 21 | |||
2994 | 22 | #include <memory> | ||
2995 | 23 | |||
2996 | 24 | namespace unity | ||
2997 | 25 | { | ||
2998 | 26 | |||
2999 | 27 | namespace util | ||
3000 | 28 | { | ||
3001 | 29 | |||
3002 | 30 | /** | ||
3003 | 31 | \brief Helper template to inject smart pointer definitions into a class. | ||
3004 | 32 | |||
3005 | 33 | This template injects type definitions for smart pointer types into a class. It is useful to | ||
3006 | 34 | establish a common naming convention for smart pointers across a project. | ||
3007 | 35 | |||
3008 | 36 | You can use the template as follows. Note that the template parameter is the name of the class | ||
3009 | 37 | being defined ("curiously recurring template pattern"). | ||
3010 | 38 | |||
3011 | 39 | ~~~ | ||
3012 | 40 | * class MyClass : public util::DefinesPtrs<MyClass> | ||
3013 | 41 | * { | ||
3014 | 42 | * public: | ||
3015 | 43 | * // MyClass now provides public typedefs for SPtr, SCPtr, UPtr, and UCPtr. | ||
3016 | 44 | * // ... | ||
3017 | 45 | * }; | ||
3018 | 46 | ~~~ | ||
3019 | 47 | |||
3020 | 48 | Callers of <code>MyClass</code> can now, for example, write | ||
3021 | 49 | |||
3022 | 50 | ~~~ | ||
3023 | 51 | * MyClass::UPtr p(new MyClass); | ||
3024 | 52 | ~~~ | ||
3025 | 53 | |||
3026 | 54 | */ | ||
3027 | 55 | |||
3028 | 56 | template <typename T> | ||
3029 | 57 | class DefinesPtrs | ||
3030 | 58 | { | ||
3031 | 59 | public: | ||
3032 | 60 | /** | ||
3033 | 61 | A <code>std::shared_ptr</code> to a non-constant instance. | ||
3034 | 62 | */ | ||
3035 | 63 | typedef std::shared_ptr<T> SPtr; | ||
3036 | 64 | |||
3037 | 65 | /** | ||
3038 | 66 | A <code>std::shared_ptr</code> to a constant instance. | ||
3039 | 67 | */ | ||
3040 | 68 | typedef std::shared_ptr<T const> SCPtr; | ||
3041 | 69 | |||
3042 | 70 | /** | ||
3043 | 71 | A <code>std::unique_ptr</code> to a non-constant instance. | ||
3044 | 72 | */ | ||
3045 | 73 | typedef std::unique_ptr<T> UPtr; | ||
3046 | 74 | |||
3047 | 75 | /** | ||
3048 | 76 | A <code>std::unique_ptr</code> to a constant instance. | ||
3049 | 77 | */ | ||
3050 | 78 | typedef std::unique_ptr<T const> UCPtr; | ||
3051 | 79 | |||
3052 | 80 | protected: // Not meant to be instantiated stand-alone | ||
3053 | 81 | DefinesPtrs() = default; | ||
3054 | 82 | virtual ~DefinesPtrs() = default; | ||
3055 | 83 | }; | ||
3056 | 84 | |||
3057 | 85 | } // namespace util | ||
3058 | 86 | |||
3059 | 87 | } // namespace unity | ||
3060 | 88 | |||
3061 | 89 | #endif | ||
3062 | 90 | 0 | ||
3063 | === removed file 'include/unity/util/FileIO.h' | |||
3064 | --- include/unity/util/FileIO.h 2013-04-08 03:05:05 +0000 | |||
3065 | +++ include/unity/util/FileIO.h 1970-01-01 00:00:00 +0000 | |||
3066 | @@ -1,40 +0,0 @@ | |||
3067 | 1 | /* | ||
3068 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
3069 | 3 | * | ||
3070 | 4 | * This program is free software: you can redistribute it and/or modify | ||
3071 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
3072 | 6 | * published by the Free Software Foundation. | ||
3073 | 7 | * | ||
3074 | 8 | * This program is distributed in the hope that it will be useful, | ||
3075 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
3076 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
3077 | 11 | * GNU General Public License for more details. | ||
3078 | 12 | * | ||
3079 | 13 | * You should have received a copy of the GNU General Public License | ||
3080 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
3081 | 15 | * | ||
3082 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
3083 | 17 | */ | ||
3084 | 18 | |||
3085 | 19 | #ifndef UNITY_UTIL_FILEIO_H | ||
3086 | 20 | #define UNITY_UTIL_FILEIO_H | ||
3087 | 21 | |||
3088 | 22 | #include <unity/config.h> | ||
3089 | 23 | |||
3090 | 24 | #include <string> | ||
3091 | 25 | #include <vector> | ||
3092 | 26 | |||
3093 | 27 | namespace unity | ||
3094 | 28 | { | ||
3095 | 29 | |||
3096 | 30 | namespace util | ||
3097 | 31 | { | ||
3098 | 32 | |||
3099 | 33 | UNITY_API std::string read_text_file(std::string const& filename); | ||
3100 | 34 | UNITY_API std::vector<uint8_t> read_binary_file(std::string const& filename); | ||
3101 | 35 | |||
3102 | 36 | } // namespace util | ||
3103 | 37 | |||
3104 | 38 | } // namespace unity | ||
3105 | 39 | |||
3106 | 40 | #endif | ||
3107 | 41 | 0 | ||
3108 | === removed file 'include/unity/util/NonCopyable.h' | |||
3109 | --- include/unity/util/NonCopyable.h 2013-04-08 03:05:05 +0000 | |||
3110 | +++ include/unity/util/NonCopyable.h 1970-01-01 00:00:00 +0000 | |||
3111 | @@ -1,89 +0,0 @@ | |||
3112 | 1 | /* | ||
3113 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
3114 | 3 | * | ||
3115 | 4 | * This program is free software: you can redistribute it and/or modify | ||
3116 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
3117 | 6 | * published by the Free Software Foundation. | ||
3118 | 7 | * | ||
3119 | 8 | * This program is distributed in the hope that it will be useful, | ||
3120 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
3121 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
3122 | 11 | * GNU General Public License for more details. | ||
3123 | 12 | * | ||
3124 | 13 | * You should have received a copy of the GNU General Public License | ||
3125 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
3126 | 15 | * | ||
3127 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
3128 | 17 | */ | ||
3129 | 18 | |||
3130 | 19 | // | ||
3131 | 20 | // Simple class to disable copy and assignment. (Provided here to avoid having to use | ||
3132 | 21 | // the equivalent boost version.) | ||
3133 | 22 | // | ||
3134 | 23 | // Use like this: | ||
3135 | 24 | // | ||
3136 | 25 | // class MyClass : private util::NonCopyable | ||
3137 | 26 | // { | ||
3138 | 27 | // // ... | ||
3139 | 28 | // }; | ||
3140 | 29 | // | ||
3141 | 30 | |||
3142 | 31 | #ifndef UNITY_UTIL_NONCOPYABLE_H | ||
3143 | 32 | #define UNITY_UTIL_NONCOPYABLE_H | ||
3144 | 33 | |||
3145 | 34 | #include <unity/config.h> | ||
3146 | 35 | |||
3147 | 36 | namespace unity | ||
3148 | 37 | { | ||
3149 | 38 | |||
3150 | 39 | namespace util | ||
3151 | 40 | { | ||
3152 | 41 | |||
3153 | 42 | namespace NonCopyable_ // Prevent unintended ADL | ||
3154 | 43 | { | ||
3155 | 44 | |||
3156 | 45 | /** | ||
3157 | 46 | \brief Helper class to prevent a class from being copied. | ||
3158 | 47 | |||
3159 | 48 | This class disables the copy constructor and assignment operator of a class to prevent it from being copied. | ||
3160 | 49 | This makes the fact that a class is not copyable immediately visible on reading the class definition, | ||
3161 | 50 | rather than having to read through the entire class to look for a copy constructor and assignment operator | ||
3162 | 51 | in the private section, or having to look for <code> = delete;</code> on the corresponding definitions. | ||
3163 | 52 | |||
3164 | 53 | To use the class, use private inheritance: | ||
3165 | 54 | ~~~ | ||
3166 | 55 | * class MyClass : private unity::util::NonCopyable | ||
3167 | 56 | * { | ||
3168 | 57 | * public: | ||
3169 | 58 | * // MyClass cannot be copied now | ||
3170 | 59 | * // ... | ||
3171 | 60 | * }; | ||
3172 | 61 | ~~~ | ||
3173 | 62 | |||
3174 | 63 | \note Do not use public or protected inheritance for this class. Private inheritance prevents accidental polymorphism, such as | ||
3175 | 64 | ~~~ | ||
3176 | 65 | * void some_method(NonCopyable& param); // Bad, permits unrelated classes to be passed | ||
3177 | 66 | ~~~ | ||
3178 | 67 | |||
3179 | 68 | */ | ||
3180 | 69 | |||
3181 | 70 | class UNITY_API NonCopyable | ||
3182 | 71 | { | ||
3183 | 72 | protected: | ||
3184 | 73 | NonCopyable() = default; | ||
3185 | 74 | ~NonCopyable() = default; | ||
3186 | 75 | |||
3187 | 76 | private: | ||
3188 | 77 | NonCopyable(NonCopyable const&) = delete; | ||
3189 | 78 | NonCopyable& operator=(NonCopyable const&) = delete; | ||
3190 | 79 | }; | ||
3191 | 80 | |||
3192 | 81 | } // namespace NonCopyable_ | ||
3193 | 82 | |||
3194 | 83 | typedef NonCopyable_::NonCopyable NonCopyable; | ||
3195 | 84 | |||
3196 | 85 | } // namespace util | ||
3197 | 86 | |||
3198 | 87 | } // namespace unity | ||
3199 | 88 | |||
3200 | 89 | #endif | ||
3201 | 90 | 0 | ||
3202 | === removed directory 'include/unity/util/internal' | |||
3203 | === removed file 'include/unity/util/internal/DaemonImpl.h' | |||
3204 | --- include/unity/util/internal/DaemonImpl.h 2013-04-04 02:16:16 +0000 | |||
3205 | +++ include/unity/util/internal/DaemonImpl.h 1970-01-01 00:00:00 +0000 | |||
3206 | @@ -1,67 +0,0 @@ | |||
3207 | 1 | /* | ||
3208 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
3209 | 3 | * | ||
3210 | 4 | * This program is free software: you can redistribute it and/or modify | ||
3211 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
3212 | 6 | * published by the Free Software Foundation. | ||
3213 | 7 | * | ||
3214 | 8 | * This program is distributed in the hope that it will be useful, | ||
3215 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
3216 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
3217 | 11 | * GNU General Public License for more details. | ||
3218 | 12 | * | ||
3219 | 13 | * You should have received a copy of the GNU General Public License | ||
3220 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
3221 | 15 | * | ||
3222 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
3223 | 17 | */ | ||
3224 | 18 | |||
3225 | 19 | #ifndef UNITY_UTIL_DAEMONIMPL_H | ||
3226 | 20 | #define UNITY_UTIL_DAEMONIMPL_H | ||
3227 | 21 | |||
3228 | 22 | #include <unity/UnityExceptions.h> | ||
3229 | 23 | #include <unity/util/NonCopyable.h> | ||
3230 | 24 | |||
3231 | 25 | #include <sys/types.h> | ||
3232 | 26 | |||
3233 | 27 | #include <string> | ||
3234 | 28 | |||
3235 | 29 | namespace unity | ||
3236 | 30 | { | ||
3237 | 31 | |||
3238 | 32 | namespace util | ||
3239 | 33 | { | ||
3240 | 34 | |||
3241 | 35 | namespace internal | ||
3242 | 36 | { | ||
3243 | 37 | |||
3244 | 38 | class DaemonImpl final : private NonCopyable | ||
3245 | 39 | { | ||
3246 | 40 | public: | ||
3247 | 41 | DaemonImpl(); | ||
3248 | 42 | ~DaemonImpl() = default; | ||
3249 | 43 | |||
3250 | 44 | void close_fds() noexcept; | ||
3251 | 45 | void reset_signals() noexcept; | ||
3252 | 46 | void set_umask(mode_t mask) noexcept; | ||
3253 | 47 | void set_working_directory(std::string const& working_directory); | ||
3254 | 48 | |||
3255 | 49 | void daemonize_me(); | ||
3256 | 50 | |||
3257 | 51 | private: | ||
3258 | 52 | bool close_fds_; | ||
3259 | 53 | bool reset_signals_; | ||
3260 | 54 | bool set_umask_; | ||
3261 | 55 | mode_t umask_; | ||
3262 | 56 | std::string working_directory_; | ||
3263 | 57 | |||
3264 | 58 | void close_open_files() noexcept; | ||
3265 | 59 | }; | ||
3266 | 60 | |||
3267 | 61 | } // namespace internal | ||
3268 | 62 | |||
3269 | 63 | } // namespace util | ||
3270 | 64 | |||
3271 | 65 | } // namespace unity | ||
3272 | 66 | |||
3273 | 67 | #endif | ||
3274 | 68 | 0 | ||
3275 | === removed file 'include/unity/util/internal/ResourcePtr.h' | |||
3276 | --- include/unity/util/internal/ResourcePtr.h 2013-04-10 03:39:55 +0000 | |||
3277 | +++ include/unity/util/internal/ResourcePtr.h 1970-01-01 00:00:00 +0000 | |||
3278 | @@ -1,793 +0,0 @@ | |||
3279 | 1 | /* | ||
3280 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
3281 | 3 | * | ||
3282 | 4 | * This program is free software: you can redistribute it and/or modify | ||
3283 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
3284 | 6 | * published by the Free Software Foundation. | ||
3285 | 7 | * | ||
3286 | 8 | * This program is distributed in the hope that it will be useful, | ||
3287 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
3288 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
3289 | 11 | * GNU General Public License for more details. | ||
3290 | 12 | * | ||
3291 | 13 | * You should have received a copy of the GNU General Public License | ||
3292 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
3293 | 15 | * | ||
3294 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
3295 | 17 | */ | ||
3296 | 18 | |||
3297 | 19 | #ifndef UNITY_UTIL_INTERNAL_RESOURCEPTR_H | ||
3298 | 20 | #define UNITY_UTIL_INTERNAL_RESOURCEPTR_H | ||
3299 | 21 | |||
3300 | 22 | #include <unity/util/NonCopyable.h> | ||
3301 | 23 | |||
3302 | 24 | #include <boost/type_traits.hpp> | ||
3303 | 25 | |||
3304 | 26 | #include <mutex> | ||
3305 | 27 | |||
3306 | 28 | namespace unity | ||
3307 | 29 | { | ||
3308 | 30 | |||
3309 | 31 | namespace util | ||
3310 | 32 | { | ||
3311 | 33 | |||
3312 | 34 | namespace internal | ||
3313 | 35 | { | ||
3314 | 36 | |||
3315 | 37 | namespace | ||
3316 | 38 | { | ||
3317 | 39 | |||
3318 | 40 | // Simple helper class so we can adopt a lock without inconvenient syntax. | ||
3319 | 41 | |||
3320 | 42 | template<typename T> | ||
3321 | 43 | class LockAdopter | ||
3322 | 44 | { | ||
3323 | 45 | public: | ||
3324 | 46 | LockAdopter(T& mutex) noexcept | ||
3325 | 47 | : m_(mutex, std::adopt_lock) | ||
3326 | 48 | { | ||
3327 | 49 | assert(!mutex.try_lock()); // Mutex must be locked to be adoptable. | ||
3328 | 50 | } | ||
3329 | 51 | |||
3330 | 52 | private: | ||
3331 | 53 | std::unique_lock<T> m_; | ||
3332 | 54 | }; | ||
3333 | 55 | |||
3334 | 56 | } // namespace | ||
3335 | 57 | |||
3336 | 58 | /** | ||
3337 | 59 | \brief Class to guarantee deallocation of arbitrary resources. | ||
3338 | 60 | |||
3339 | 61 | ResourcePtr is a generalized resource pointer that guarantees deallocation. | ||
3340 | 62 | It is intended for arbitrary pairs of allocate/deallocate functions, such | ||
3341 | 63 | as <code>XCreateDisplay</code>/<code>XDestroyDisplay</code>. | ||
3342 | 64 | |||
3343 | 65 | The resource managed by this class must be default-constructible, copy-constructible, and assignable. | ||
3344 | 66 | |||
3345 | 67 | ResourcePtr essentially does what <code>std::unique_ptr</code> does, but it works with opaque types | ||
3346 | 68 | and resource allocation functions that do not return a pointer type, such as <code>open()</code>. | ||
3347 | 69 | |||
3348 | 70 | ResourcePtr is thread-safe. | ||
3349 | 71 | |||
3350 | 72 | \note Do not use reset() to set the resource to the "no resource allocated" state. | ||
3351 | 73 | Instead, call dealloc() to do this. ResourcePtr has no idea | ||
3352 | 74 | what a "not allocated" resource value looks like and therefore cannot test | ||
3353 | 75 | for it. If you use reset() to install a "no resource allocated" value for | ||
3354 | 76 | for the resource, the deleter will eventually be called with this value | ||
3355 | 77 | as its argument. Whether this is benign or not depends on the deleter. For | ||
3356 | 78 | example, <code>XFree()</code> must not be called with a <code>nullptr</code> argument. | ||
3357 | 79 | |||
3358 | 80 | \note Do not call get() or release() if no resource is currently allocated. | ||
3359 | 81 | Doing so throws <code>std::logic_error</code>. | ||
3360 | 82 | |||
3361 | 83 | Here is an example that shows how to use this for a <code>glXCreateContext</code>/<code>GLXDestroyContext</code> pair. | ||
3362 | 84 | The returned <code>GLXContext</code> is a pointer to an opaque type; <code>std::unique_ptr</code> cannot be used | ||
3363 | 85 | for this, even with a custom deleter, because the signatures of the allocator and deallocator | ||
3364 | 86 | do not match <code>unique_ptr</code>'s expectations. | ||
3365 | 87 | |||
3366 | 88 | ~~~ | ||
3367 | 89 | ResourcePtr<GLXContext, std::function<void(GLXContext)>> context = | ||
3368 | 90 | std::bind(&glXDestroyContext, display_, std::placeholders::_1); | ||
3369 | 91 | ~~~ | ||
3370 | 92 | |||
3371 | 93 | display_ is declared as | ||
3372 | 94 | |||
3373 | 95 | ~~~ | ||
3374 | 96 | Display* display_; | ||
3375 | 97 | ~~~ | ||
3376 | 98 | |||
3377 | 99 | in this case. | ||
3378 | 100 | |||
3379 | 101 | The deleter for the resource can return any type (including int, such as returned by <code>XDestroyWindow()</code>), | ||
3380 | 102 | and it must accept a single argument of the resource type (<code>GLXContext</code> in this example). | ||
3381 | 103 | |||
3382 | 104 | <code>glXDestroyContext()</code> expects the display pointer as the first argument so, for this example, | ||
3383 | 105 | <code>std::bind</code> converts the binary <code>glXDestroyContext()</code> function into a | ||
3384 | 106 | unary function suitable as the deleter. | ||
3385 | 107 | |||
3386 | 108 | Rather than mucking around with <code>std::bind</code>, it is often easier to use a lambda. For example: | ||
3387 | 109 | |||
3388 | 110 | ~~~ | ||
3389 | 111 | ResourcePtr<GLXContext, std::function<void(GLXContext)>> context = | ||
3390 | 112 | [this](GLXContext c) { this->dealloc_GLXContext(c); }; | ||
3391 | 113 | ~~~ | ||
3392 | 114 | |||
3393 | 115 | This calls a member function <code>dealloc_GLXContext()</code> that, in turn calls <code>glXDestroyContext()</code> | ||
3394 | 116 | and supplies the display parameter. | ||
3395 | 117 | |||
3396 | 118 | \note Even though you can use ResourcePtr to deallocate dynamic memory, doing so is discouraged. | ||
3397 | 119 | Use <code>std::unique_ptr</code> instead, which is better suited to the task. | ||
3398 | 120 | */ | ||
3399 | 121 | |||
3400 | 122 | // TODO: Discuss throwing deleters and requirements (copy constructible, etc.) on deleter. | ||
3401 | 123 | |||
3402 | 124 | template<typename R, typename D> | ||
3403 | 125 | class ResourcePtr final : private NonCopyable | ||
3404 | 126 | { | ||
3405 | 127 | public: | ||
3406 | 128 | /** | ||
3407 | 129 | \typedef element_type | ||
3408 | 130 | The type of resource managed by this ResourcePtr. | ||
3409 | 131 | */ | ||
3410 | 132 | typedef R element_type; | ||
3411 | 133 | |||
3412 | 134 | /** | ||
3413 | 135 | \typedef deleter_type | ||
3414 | 136 | A function object or lvalue reference to a function or function object. The ResourcePtr | ||
3415 | 137 | calls this to deallocate the resource. | ||
3416 | 138 | */ | ||
3417 | 139 | typedef D deleter_type; | ||
3418 | 140 | |||
3419 | 141 | explicit ResourcePtr(D d); | ||
3420 | 142 | ResourcePtr(R r, D d); | ||
3421 | 143 | ResourcePtr(ResourcePtr&& r); | ||
3422 | 144 | ResourcePtr& operator=(ResourcePtr&& r); | ||
3423 | 145 | ~ResourcePtr() noexcept; | ||
3424 | 146 | |||
3425 | 147 | void swap(ResourcePtr& other); | ||
3426 | 148 | |||
3427 | 149 | void reset(R r); | ||
3428 | 150 | R release(); | ||
3429 | 151 | void dealloc(); | ||
3430 | 152 | |||
3431 | 153 | R get() const; | ||
3432 | 154 | bool has_resource() const noexcept; | ||
3433 | 155 | explicit operator bool() const noexcept; | ||
3434 | 156 | D& get_deleter() noexcept; | ||
3435 | 157 | D const& get_deleter() const noexcept; | ||
3436 | 158 | |||
3437 | 159 | typename std::enable_if<boost::has_equal_to<R>::value, bool>::type | ||
3438 | 160 | operator==(ResourcePtr const& rhs) const; | ||
3439 | 161 | |||
3440 | 162 | typename std::enable_if<boost::has_equal_to<R>::value, bool>::type | ||
3441 | 163 | operator!=(ResourcePtr const& rhs) const; | ||
3442 | 164 | |||
3443 | 165 | typename std::enable_if<boost::has_less<R>::value, bool>::type | ||
3444 | 166 | operator<(ResourcePtr const& rhs) const; | ||
3445 | 167 | |||
3446 | 168 | typename std::enable_if<boost::has_less<R>::value && | ||
3447 | 169 | boost::has_equal_to<R>::value, bool>::type | ||
3448 | 170 | operator<=(ResourcePtr const& rhs) const; | ||
3449 | 171 | |||
3450 | 172 | typename std::enable_if<boost::has_less<R>::value && | ||
3451 | 173 | boost::has_equal_to<R>::value, bool>::type | ||
3452 | 174 | operator>(ResourcePtr const& rhs) const; | ||
3453 | 175 | |||
3454 | 176 | typename std::enable_if<boost::has_less<R>::value, bool>::type | ||
3455 | 177 | operator>=(ResourcePtr const& rhs) const; | ||
3456 | 178 | |||
3457 | 179 | private: | ||
3458 | 180 | R resource_; // The managed resource. | ||
3459 | 181 | D delete_; // The deleter to call. | ||
3460 | 182 | bool initialized_; // True while we have a resource assigned. | ||
3461 | 183 | mutable std::mutex m_; // Protects this instance. | ||
3462 | 184 | |||
3463 | 185 | typedef std::lock_guard<decltype(m_)> AutoLock; | ||
3464 | 186 | typedef LockAdopter<decltype(m_)> AdoptLock; | ||
3465 | 187 | }; | ||
3466 | 188 | |||
3467 | 189 | /** | ||
3468 | 190 | Constructs a ResourcePtr with the specified deleter. No resource is held, so a call to has_resource() | ||
3469 | 191 | after constructing a ResourcePtr this way returns <code>false</code>. | ||
3470 | 192 | */ | ||
3471 | 193 | |||
3472 | 194 | template<typename R, typename D> | ||
3473 | 195 | ResourcePtr<R, D>:: | ||
3474 | 196 | ResourcePtr(D d) | ||
3475 | 197 | : delete_(d), initialized_(false) | ||
3476 | 198 | { | ||
3477 | 199 | } | ||
3478 | 200 | |||
3479 | 201 | /** | ||
3480 | 202 | Constructs a ResourcePtr with the specified resource and deleter. has_resource() returns <code>true</code> after | ||
3481 | 203 | calling this constructor. | ||
3482 | 204 | |||
3483 | 205 | \note It is legal to pass a resource that represents the "not allocated" state. For example, the | ||
3484 | 206 | following code passes the value <code>-1</code> to <code>close()</code> if the call to <code>open()</code> fails: | ||
3485 | 207 | |||
3486 | 208 | ~~~ | ||
3487 | 209 | ResourcePtr<int, decltype(&::close)> fd(::open("/somefile", O_RDONLY), ::close); | ||
3488 | 210 | ~~~ | ||
3489 | 211 | When the ResourcePtr goes out of scope, this results in a call to <code>close(-1)</code>. In this case, | ||
3490 | 212 | the call with an invalid file descriptor is harmless (but causes noise from diagnostic tools, such as | ||
3491 | 213 | <code>valgrind</code>). However, depending on the specific deleter, passing an invalid value to the deleter may | ||
3492 | 214 | have more serious consequences. | ||
3493 | 215 | |||
3494 | 216 | To avoid the problem, you can delay initialization of the ResourcePtr until you know that the | ||
3495 | 217 | resource was successfully allocated, for example: | ||
3496 | 218 | ~~~ | ||
3497 | 219 | int tmp_fd = ::open(filename.c_str(), O_RDONLY); | ||
3498 | 220 | if (tmp_fd == -1) | ||
3499 | 221 | { | ||
3500 | 222 | throw FileException(filename.c_str()); | ||
3501 | 223 | } | ||
3502 | 224 | util::internal::ResourcePtr<int, decltype(&::close)> fd(tmp_fd, ::close(fd)); | ||
3503 | 225 | ~~~ | ||
3504 | 226 | Alternatively, you can use a deleter function that tests the resource value | ||
3505 | 227 | for validity and avoids calling the deleter with an invalid value: | ||
3506 | 228 | ~~~ | ||
3507 | 229 | util::internal::ResourcePtr<int, std::function<void(int)>> fd( | ||
3508 | 230 | ::open(filename.c_str(), O_RDONLY), | ||
3509 | 231 | [](int fd) { if (fd != -1) ::close(fd); } | ||
3510 | 232 | ); | ||
3511 | 233 | ~~~ | ||
3512 | 234 | Note that, with the second approach, a call to get() will succeed and return -1 rather than throwing an | ||
3513 | 235 | exception, so the first approach is the recommended one. | ||
3514 | 236 | */ | ||
3515 | 237 | |||
3516 | 238 | template<typename R, typename D> | ||
3517 | 239 | ResourcePtr<R, D>:: | ||
3518 | 240 | ResourcePtr(R r, D d) | ||
3519 | 241 | : resource_(r), delete_(d), initialized_(true) | ||
3520 | 242 | { | ||
3521 | 243 | } | ||
3522 | 244 | |||
3523 | 245 | /** | ||
3524 | 246 | Constructs a ResourcePtr by transferring ownership from <code>r</code> to <code>this</code>. | ||
3525 | 247 | |||
3526 | 248 | If the resource's move or copy constructor throws, the exception is propagated to the caller. | ||
3527 | 249 | The strong exception guarantee is preserved if it is provided by the resource. | ||
3528 | 250 | */ | ||
3529 | 251 | // TODO: Mark as nothrow if the resource has a nothrow move constructor or nothrow copy constructor | ||
3530 | 252 | |||
3531 | 253 | template<typename R, typename D> | ||
3532 | 254 | ResourcePtr<R, D>:: | ||
3533 | 255 | ResourcePtr(ResourcePtr<R, D>&& r) | ||
3534 | 256 | : resource_(std::move(r.resource_)), delete_(r.delete_), initialized_(r.initialized_) | ||
3535 | 257 | { | ||
3536 | 258 | r.initialized_ = false; // Stop r from deleting its resource, if it held any. No need to lock: r is a temporary. | ||
3537 | 259 | } | ||
3538 | 260 | |||
3539 | 261 | /** | ||
3540 | 262 | Assigns the resource held by <code>r</code>, transferring ownership. After the transfer, | ||
3541 | 263 | <code>r.has_resource()</code> returns <code>false</code>, and <code>this.has_resource()</code> returns | ||
3542 | 264 | the value of <code>r.has_resource()</code> prior to the assignment. | ||
3543 | 265 | */ | ||
3544 | 266 | // TODO: document exception safety behavior | ||
3545 | 267 | |||
3546 | 268 | template<typename R, typename D> | ||
3547 | 269 | ResourcePtr<R, D>& | ||
3548 | 270 | ResourcePtr<R, D>:: | ||
3549 | 271 | operator=(ResourcePtr&& r) | ||
3550 | 272 | { | ||
3551 | 273 | AutoLock lock(m_); | ||
3552 | 274 | |||
3553 | 275 | if (initialized_) // If we hold a resource, deallocate it first. | ||
3554 | 276 | { | ||
3555 | 277 | initialized_ = false; // If the deleter throws, we will not try it again for the same resource. | ||
3556 | 278 | delete_(resource_); // Delete our own resource. | ||
3557 | 279 | } | ||
3558 | 280 | |||
3559 | 281 | // r is a temporary, so we don't need to lock it. | ||
3560 | 282 | |||
3561 | 283 | resource_ = std::move(r.resource_); | ||
3562 | 284 | initialized_ = r.initialized_; | ||
3563 | 285 | r.initialized_ = false; // Stop r from deleting its resource, if it held any. | ||
3564 | 286 | delete_ = r.delete_; | ||
3565 | 287 | |||
3566 | 288 | return *this; | ||
3567 | 289 | } | ||
3568 | 290 | |||
3569 | 291 | /** | ||
3570 | 292 | Destroys the ResourcePtr. If a resource is held, it calls the deleter for the current resource (if any). | ||
3571 | 293 | */ | ||
3572 | 294 | |||
3573 | 295 | template<typename R, typename D> | ||
3574 | 296 | ResourcePtr<R, D>:: | ||
3575 | 297 | ~ResourcePtr() noexcept | ||
3576 | 298 | { | ||
3577 | 299 | try | ||
3578 | 300 | { | ||
3579 | 301 | dealloc(); | ||
3580 | 302 | } | ||
3581 | 303 | catch (...) | ||
3582 | 304 | { | ||
3583 | 305 | } | ||
3584 | 306 | } | ||
3585 | 307 | |||
3586 | 308 | /** | ||
3587 | 309 | Swaps the resource and deleter of <code>this</code> with the resource and deleter of <code>other</code> | ||
3588 | 310 | using argument dependent lookup (ADL). | ||
3589 | 311 | |||
3590 | 312 | If the underlying swap throws an exception, that exception is propagated to the caller, and the resource | ||
3591 | 313 | held by the ResourcePtr is unchanged. | ||
3592 | 314 | */ | ||
3593 | 315 | // TODO Split this into throw and no-throw versions depending on the underlying swap? | ||
3594 | 316 | |||
3595 | 317 | template<typename R, typename D> | ||
3596 | 318 | void | ||
3597 | 319 | ResourcePtr<R, D>:: | ||
3598 | 320 | swap(ResourcePtr& other) | ||
3599 | 321 | { | ||
3600 | 322 | if (this == &other) // This is necessary to avoid deadlock for self-swap | ||
3601 | 323 | { | ||
3602 | 324 | return; | ||
3603 | 325 | } | ||
3604 | 326 | |||
3605 | 327 | std::lock(m_, other.m_); | ||
3606 | 328 | AdoptLock left(m_); | ||
3607 | 329 | AdoptLock right(other.m_); | ||
3608 | 330 | |||
3609 | 331 | using std::swap; // Enable ADL | ||
3610 | 332 | swap(resource_, other.resource_); | ||
3611 | 333 | swap(delete_, other.delete_); | ||
3612 | 334 | swap(initialized_, other.initialized_); | ||
3613 | 335 | } | ||
3614 | 336 | |||
3615 | 337 | // The non-member swap() must be in the same namespace as ResourcePtr, so it will work with ADL. And, once it is | ||
3616 | 338 | // defined here, there is no point in adding a specialization to namespace std any longer, because ADL | ||
3617 | 339 | // will find it here anyway. | ||
3618 | 340 | |||
3619 | 341 | /** | ||
3620 | 342 | Swaps the resource and deleter of <code>lhs</code> with the resource and deleter of <code>rhs</code> | ||
3621 | 343 | by calling <code>lhs.swap(rhs)</code>. | ||
3622 | 344 | |||
3623 | 345 | If the underlying swap throws an exception, that exception is propagated to the caller, and the resource | ||
3624 | 346 | held by the ResourcePtr is unchanged. | ||
3625 | 347 | */ | ||
3626 | 348 | // TODO Split this into throw and no-throw versions depending on the underlying swap? | ||
3627 | 349 | |||
3628 | 350 | template<typename R, typename D> | ||
3629 | 351 | void | ||
3630 | 352 | swap(unity::util::internal::ResourcePtr<R, D>& lhs, unity::util::internal::ResourcePtr<R, D>& rhs) | ||
3631 | 353 | { | ||
3632 | 354 | lhs.swap(rhs); | ||
3633 | 355 | } | ||
3634 | 356 | |||
3635 | 357 | /** | ||
3636 | 358 | Assigns a new resource to <code>this</code>, first deallocating the current resource (if any). | ||
3637 | 359 | |||
3638 | 360 | If the deleter for the current resource throws an exception, the exception is propagated to the caller. In this | ||
3639 | 361 | case, the transfer of <code>r</code> to <code>this</code> is still carried out so, after the call to reset(), | ||
3640 | 362 | <code>this</code> manages <code>r</code>, whether the deleter throws or not. (If the deleter <i>does</i> throw, | ||
3641 | 363 | no attempt is made to call the deleter again for the same resource.) | ||
3642 | 364 | */ | ||
3643 | 365 | |||
3644 | 366 | template<typename R, typename D> | ||
3645 | 367 | void | ||
3646 | 368 | ResourcePtr<R, D>:: | ||
3647 | 369 | reset(R r) | ||
3648 | 370 | { | ||
3649 | 371 | AutoLock lock(m_); | ||
3650 | 372 | |||
3651 | 373 | bool has_old = initialized_; | ||
3652 | 374 | R old_resource; | ||
3653 | 375 | |||
3654 | 376 | if (has_old) | ||
3655 | 377 | { | ||
3656 | 378 | old_resource = resource_; | ||
3657 | 379 | } | ||
3658 | 380 | resource_ = r; | ||
3659 | 381 | initialized_ = true; // If the deleter throws, we still satisfy the postcondition: resource_ == r. | ||
3660 | 382 | if (has_old) | ||
3661 | 383 | { | ||
3662 | 384 | delete_(old_resource); | ||
3663 | 385 | } | ||
3664 | 386 | } | ||
3665 | 387 | |||
3666 | 388 | /** | ||
3667 | 389 | Releases ownership of the current resource without calling the deleter. | ||
3668 | 390 | \return The current resource. | ||
3669 | 391 | \throw std::logic_error if has_resource() is false. | ||
3670 | 392 | */ | ||
3671 | 393 | |||
3672 | 394 | template<typename R, typename D> | ||
3673 | 395 | inline | ||
3674 | 396 | R | ||
3675 | 397 | ResourcePtr<R, D>:: | ||
3676 | 398 | release() | ||
3677 | 399 | { | ||
3678 | 400 | AutoLock lock(m_); | ||
3679 | 401 | |||
3680 | 402 | if (!initialized_) | ||
3681 | 403 | { | ||
3682 | 404 | throw std::logic_error("release() called on ResourcePtr without resource"); | ||
3683 | 405 | } | ||
3684 | 406 | initialized_ = false; | ||
3685 | 407 | return resource_; | ||
3686 | 408 | } | ||
3687 | 409 | |||
3688 | 410 | /** | ||
3689 | 411 | Calls the deleter for the current resource. | ||
3690 | 412 | |||
3691 | 413 | If the deleter throws, the resource is considered in the "not allocated" state, | ||
3692 | 414 | that is, no attempt is made to call the deleter again for this resource. | ||
3693 | 415 | */ | ||
3694 | 416 | |||
3695 | 417 | template<typename R, typename D> | ||
3696 | 418 | void | ||
3697 | 419 | ResourcePtr<R, D>:: | ||
3698 | 420 | dealloc() | ||
3699 | 421 | { | ||
3700 | 422 | AutoLock lock(m_); | ||
3701 | 423 | |||
3702 | 424 | if (!initialized_) | ||
3703 | 425 | { | ||
3704 | 426 | return; | ||
3705 | 427 | } | ||
3706 | 428 | initialized_ = false; // If the deleter throws, we will not try it again for the same resource. | ||
3707 | 429 | delete_(resource_); | ||
3708 | 430 | } | ||
3709 | 431 | |||
3710 | 432 | /** | ||
3711 | 433 | Returns the current resource. If no resource is currently held, get() throws <code>std::logic_error</code>. | ||
3712 | 434 | \return The current resource (if any). | ||
3713 | 435 | |||
3714 | 436 | If the resource's copy constructor throws an exception, that exception is propagated to the caller. | ||
3715 | 437 | |||
3716 | 438 | \throw std::logic_error if has_resource() is false. | ||
3717 | 439 | */ | ||
3718 | 440 | |||
3719 | 441 | template<typename R, typename D> | ||
3720 | 442 | inline | ||
3721 | 443 | R | ||
3722 | 444 | ResourcePtr<R, D>:: | ||
3723 | 445 | get() const | ||
3724 | 446 | { | ||
3725 | 447 | AutoLock lock(m_); | ||
3726 | 448 | |||
3727 | 449 | if (!initialized_) | ||
3728 | 450 | { | ||
3729 | 451 | throw std::logic_error("get() called on ResourcePtr without resource"); | ||
3730 | 452 | } | ||
3731 | 453 | return resource_; | ||
3732 | 454 | } | ||
3733 | 455 | |||
3734 | 456 | /** | ||
3735 | 457 | \return <code>true</code> if <code>this</code> currently manages a resource; <code>false</code>, otherwise. | ||
3736 | 458 | */ | ||
3737 | 459 | |||
3738 | 460 | template<typename R, typename D> | ||
3739 | 461 | inline | ||
3740 | 462 | bool | ||
3741 | 463 | ResourcePtr<R, D>:: | ||
3742 | 464 | has_resource() const noexcept | ||
3743 | 465 | { | ||
3744 | 466 | AutoLock lock(m_); | ||
3745 | 467 | return initialized_; | ||
3746 | 468 | } | ||
3747 | 469 | |||
3748 | 470 | /** | ||
3749 | 471 | Synonym for has_resource(). | ||
3750 | 472 | */ | ||
3751 | 473 | |||
3752 | 474 | template<typename R, typename D> | ||
3753 | 475 | inline | ||
3754 | 476 | ResourcePtr<R, D>:: | ||
3755 | 477 | operator bool() const noexcept | ||
3756 | 478 | { | ||
3757 | 479 | return has_resource(); | ||
3758 | 480 | } | ||
3759 | 481 | |||
3760 | 482 | /** | ||
3761 | 483 | \return The deleter for the resource. | ||
3762 | 484 | */ | ||
3763 | 485 | |||
3764 | 486 | template<typename R, typename D> | ||
3765 | 487 | inline | ||
3766 | 488 | D& | ||
3767 | 489 | ResourcePtr<R, D>:: | ||
3768 | 490 | get_deleter() noexcept | ||
3769 | 491 | { | ||
3770 | 492 | AutoLock lock(m_); | ||
3771 | 493 | return delete_; | ||
3772 | 494 | } | ||
3773 | 495 | |||
3774 | 496 | /** | ||
3775 | 497 | \return The deleter for the resource. | ||
3776 | 498 | */ | ||
3777 | 499 | |||
3778 | 500 | template<typename R, typename D> | ||
3779 | 501 | inline | ||
3780 | 502 | D const& | ||
3781 | 503 | ResourcePtr<R, D>:: | ||
3782 | 504 | get_deleter() const noexcept | ||
3783 | 505 | { | ||
3784 | 506 | AutoLock lock(m_); | ||
3785 | 507 | return delete_; | ||
3786 | 508 | } | ||
3787 | 509 | |||
3788 | 510 | /** | ||
3789 | 511 | \brief Compares two instances for equality by calling the corresponding operator on the resource. | ||
3790 | 512 | |||
3791 | 513 | Two instances that do not hold a resource are equal. An instance that does not hold a resource is not equal | ||
3792 | 514 | to any instance that holds a resource. | ||
3793 | 515 | |||
3794 | 516 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3795 | 517 | |||
3796 | 518 | \note This operator is available only if the underlying resource provides <code>operator==</code>. | ||
3797 | 519 | */ | ||
3798 | 520 | |||
3799 | 521 | template<typename R, typename D> | ||
3800 | 522 | typename std::enable_if<boost::has_equal_to<R>::value, bool>::type | ||
3801 | 523 | ResourcePtr<R, D>:: | ||
3802 | 524 | operator==(ResourcePtr<R, D> const& rhs) const | ||
3803 | 525 | { | ||
3804 | 526 | if (this == &rhs) // This is necessary to avoid deadlock for self-comparison | ||
3805 | 527 | { | ||
3806 | 528 | return true; | ||
3807 | 529 | } | ||
3808 | 530 | |||
3809 | 531 | std::lock(m_, rhs.m_); | ||
3810 | 532 | AdoptLock left(m_); | ||
3811 | 533 | AdoptLock right(rhs.m_); | ||
3812 | 534 | |||
3813 | 535 | if (!initialized_) | ||
3814 | 536 | { | ||
3815 | 537 | return !rhs.initialized_; // Equal if both are not initialized | ||
3816 | 538 | } | ||
3817 | 539 | else if (!rhs.initialized_) | ||
3818 | 540 | { | ||
3819 | 541 | return false; // Not equal if lhs initialized, but rhs not initialized | ||
3820 | 542 | } | ||
3821 | 543 | else | ||
3822 | 544 | { | ||
3823 | 545 | return resource_ == rhs.resource_; | ||
3824 | 546 | } | ||
3825 | 547 | } | ||
3826 | 548 | |||
3827 | 549 | /** | ||
3828 | 550 | \brief Compares two instances for inequality by calling the corresponding operator on the resource. | ||
3829 | 551 | |||
3830 | 552 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3831 | 553 | |||
3832 | 554 | \note This operator is available only if the underlying resource provides <code>operator!=</code>. | ||
3833 | 555 | */ | ||
3834 | 556 | |||
3835 | 557 | template<typename R, typename D> | ||
3836 | 558 | inline | ||
3837 | 559 | typename std::enable_if<boost::has_equal_to<R>::value, bool>::type | ||
3838 | 560 | ResourcePtr<R, D>:: | ||
3839 | 561 | operator!=(ResourcePtr<R, D> const& rhs) const | ||
3840 | 562 | { | ||
3841 | 563 | return !(*this == rhs); | ||
3842 | 564 | } | ||
3843 | 565 | |||
3844 | 566 | /** | ||
3845 | 567 | \brief Returns <code>true</code> if <code>this</code> is less than <code>rhs</code> by calling the | ||
3846 | 568 | corresponding operator on the resource. | ||
3847 | 569 | |||
3848 | 570 | An instance that does not hold a resource is less than any instance that holds a resource. | ||
3849 | 571 | |||
3850 | 572 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3851 | 573 | |||
3852 | 574 | \note This operator is available only if the underlying resource provides <code>operator\<</code>. | ||
3853 | 575 | */ | ||
3854 | 576 | |||
3855 | 577 | template<typename R, typename D> | ||
3856 | 578 | typename std::enable_if<boost::has_less<R>::value, bool>::type | ||
3857 | 579 | ResourcePtr<R, D>:: | ||
3858 | 580 | operator<(ResourcePtr<R, D> const& rhs) const | ||
3859 | 581 | { | ||
3860 | 582 | if (this == &rhs) // This is necessary to avoid deadlock for self-comparison | ||
3861 | 583 | { | ||
3862 | 584 | return false; | ||
3863 | 585 | } | ||
3864 | 586 | |||
3865 | 587 | std::lock(m_, rhs.m_); | ||
3866 | 588 | AdoptLock left(m_); | ||
3867 | 589 | AdoptLock right(rhs.m_); | ||
3868 | 590 | |||
3869 | 591 | if (!initialized_) | ||
3870 | 592 | { | ||
3871 | 593 | return rhs.initialized_; // Not initialized is less than initialized | ||
3872 | 594 | } | ||
3873 | 595 | else if (!rhs.initialized_) // Initialized is not less than not initialized | ||
3874 | 596 | { | ||
3875 | 597 | return false; | ||
3876 | 598 | } | ||
3877 | 599 | else | ||
3878 | 600 | { | ||
3879 | 601 | return resource_ < rhs.resource_; | ||
3880 | 602 | } | ||
3881 | 603 | } | ||
3882 | 604 | |||
3883 | 605 | /** | ||
3884 | 606 | \brief Returns <code>true</code> if <code>this</code> is less than or equal to <code>rhs</code> by calling the | ||
3885 | 607 | corresponding operator on the resource. | ||
3886 | 608 | |||
3887 | 609 | An instance that does not hold a resource is less than any instance that holds a resource. | ||
3888 | 610 | Two instances that do not hold a resource are equal. | ||
3889 | 611 | |||
3890 | 612 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3891 | 613 | |||
3892 | 614 | \note This operator is available only if the underlying resource provides <code>operator\<=</code>. | ||
3893 | 615 | */ | ||
3894 | 616 | |||
3895 | 617 | template<typename R, typename D> | ||
3896 | 618 | typename std::enable_if<boost::has_less<R>::value && boost::has_equal_to<R>::value, bool>::type | ||
3897 | 619 | ResourcePtr<R, D>:: | ||
3898 | 620 | operator<=(ResourcePtr<R, D> const& rhs) const | ||
3899 | 621 | { | ||
3900 | 622 | if (this == &rhs) // This is necessary to avoid deadlock for self-comparison | ||
3901 | 623 | { | ||
3902 | 624 | return true; | ||
3903 | 625 | } | ||
3904 | 626 | |||
3905 | 627 | // We can't just write: | ||
3906 | 628 | // | ||
3907 | 629 | // return *this < rhs || *this == rhs; | ||
3908 | 630 | // | ||
3909 | 631 | // because that creates a race condition: the locks would be released and | ||
3910 | 632 | // re-aquired in between the two comparisons. | ||
3911 | 633 | |||
3912 | 634 | std::lock(m_, rhs.m_); | ||
3913 | 635 | AdoptLock left(m_); | ||
3914 | 636 | AdoptLock right(rhs.m_); | ||
3915 | 637 | |||
3916 | 638 | return resource_ < rhs.resource_ || resource_ == rhs.resource_; | ||
3917 | 639 | } | ||
3918 | 640 | |||
3919 | 641 | /** | ||
3920 | 642 | \brief Returns <code>true</code> if <code>this</code> is greater than <code>rhs</code> by calling the | ||
3921 | 643 | corresponding operator on the resource. | ||
3922 | 644 | |||
3923 | 645 | An instance that holds a resource is greater than any instance that does not hold a resource. | ||
3924 | 646 | |||
3925 | 647 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3926 | 648 | |||
3927 | 649 | \note This operator is available only if the underlying resource provides <code>operator\></code>. | ||
3928 | 650 | */ | ||
3929 | 651 | |||
3930 | 652 | template<typename R, typename D> | ||
3931 | 653 | inline | ||
3932 | 654 | typename std::enable_if<boost::has_less<R>::value && boost::has_equal_to<R>::value, bool>::type | ||
3933 | 655 | ResourcePtr<R, D>:: | ||
3934 | 656 | operator>(ResourcePtr<R, D> const& rhs) const | ||
3935 | 657 | { | ||
3936 | 658 | return !(*this <= rhs); | ||
3937 | 659 | } | ||
3938 | 660 | |||
3939 | 661 | /** | ||
3940 | 662 | \brief Returns <code>true</code> if <code>this</code> is greater than or equal to <code>rhs</code> by calling the | ||
3941 | 663 | corresponding operator on the resource. | ||
3942 | 664 | |||
3943 | 665 | An instance that holds a resource is greater than any instance that does not hold a resource. | ||
3944 | 666 | Two instances that do not hold a resource are equal. | ||
3945 | 667 | |||
3946 | 668 | If the underlying operator throws an exception, that exception is propagated to the caller. | ||
3947 | 669 | |||
3948 | 670 | \note This operator is available only if the underlying resource provides <code>operator\>=</code>. | ||
3949 | 671 | */ | ||
3950 | 672 | |||
3951 | 673 | template<typename R, typename D> | ||
3952 | 674 | inline | ||
3953 | 675 | typename std::enable_if<boost::has_less<R>::value, bool>::type | ||
3954 | 676 | ResourcePtr<R, D>:: | ||
3955 | 677 | operator>=(ResourcePtr<R, D> const& rhs) const | ||
3956 | 678 | { | ||
3957 | 679 | return !(*this < rhs); | ||
3958 | 680 | } | ||
3959 | 681 | |||
3960 | 682 | } // namespace internal | ||
3961 | 683 | |||
3962 | 684 | } // namespace util | ||
3963 | 685 | |||
3964 | 686 | } // namespace unity | ||
3965 | 687 | |||
3966 | 688 | // Specializations in namespace std, so we play nicely with STL and metaprogramming. | ||
3967 | 689 | |||
3968 | 690 | namespace std | ||
3969 | 691 | { | ||
3970 | 692 | |||
3971 | 693 | /** | ||
3972 | 694 | \brief Function object for equality comparison. | ||
3973 | 695 | */ | ||
3974 | 696 | |||
3975 | 697 | template<typename R, typename D> | ||
3976 | 698 | struct equal_to<unity::util::internal::ResourcePtr<R, D>> | ||
3977 | 699 | { | ||
3978 | 700 | /** | ||
3979 | 701 | Invokes <code>operator==</code> on <code>lhs</code>. | ||
3980 | 702 | */ | ||
3981 | 703 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
3982 | 704 | { | ||
3983 | 705 | return lhs == rhs; | ||
3984 | 706 | } | ||
3985 | 707 | }; | ||
3986 | 708 | |||
3987 | 709 | /** | ||
3988 | 710 | \brief Function object for inequality comparison. | ||
3989 | 711 | */ | ||
3990 | 712 | |||
3991 | 713 | template<typename R, typename D> | ||
3992 | 714 | struct not_equal_to<unity::util::internal::ResourcePtr<R, D>> | ||
3993 | 715 | { | ||
3994 | 716 | /** | ||
3995 | 717 | Invokes <code>operator!=</code> on <code>lhs</code>. | ||
3996 | 718 | */ | ||
3997 | 719 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
3998 | 720 | { | ||
3999 | 721 | return lhs != rhs; | ||
4000 | 722 | } | ||
4001 | 723 | }; | ||
4002 | 724 | |||
4003 | 725 | /** | ||
4004 | 726 | \brief Function object for less than comparison. | ||
4005 | 727 | */ | ||
4006 | 728 | |||
4007 | 729 | template<typename R, typename D> | ||
4008 | 730 | struct less<unity::util::internal::ResourcePtr<R, D>> | ||
4009 | 731 | { | ||
4010 | 732 | /** | ||
4011 | 733 | Invokes <code>operator\<</code> on <code>lhs</code>. | ||
4012 | 734 | */ | ||
4013 | 735 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
4014 | 736 | { | ||
4015 | 737 | return lhs < rhs; | ||
4016 | 738 | } | ||
4017 | 739 | }; | ||
4018 | 740 | |||
4019 | 741 | /** | ||
4020 | 742 | \brief Function object for less than or equal comparison. | ||
4021 | 743 | */ | ||
4022 | 744 | |||
4023 | 745 | template<typename R, typename D> | ||
4024 | 746 | struct less_equal<unity::util::internal::ResourcePtr<R, D>> | ||
4025 | 747 | { | ||
4026 | 748 | /** | ||
4027 | 749 | Invokes <code>operator\<=</code> on <code>lhs</code>. | ||
4028 | 750 | */ | ||
4029 | 751 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
4030 | 752 | { | ||
4031 | 753 | return lhs <= rhs; | ||
4032 | 754 | } | ||
4033 | 755 | }; | ||
4034 | 756 | |||
4035 | 757 | /** | ||
4036 | 758 | \brief Function object for greater than comparison. | ||
4037 | 759 | */ | ||
4038 | 760 | |||
4039 | 761 | template<typename R, typename D> | ||
4040 | 762 | struct greater<unity::util::internal::ResourcePtr<R, D>> | ||
4041 | 763 | { | ||
4042 | 764 | /** | ||
4043 | 765 | Invokes <code>operator\></code> on <code>lhs</code>. | ||
4044 | 766 | */ | ||
4045 | 767 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
4046 | 768 | { | ||
4047 | 769 | return lhs > rhs; | ||
4048 | 770 | } | ||
4049 | 771 | }; | ||
4050 | 772 | |||
4051 | 773 | /** | ||
4052 | 774 | \brief Function object for less than or equal comparison. | ||
4053 | 775 | */ | ||
4054 | 776 | |||
4055 | 777 | template<typename R, typename D> | ||
4056 | 778 | struct greater_equal<unity::util::internal::ResourcePtr<R, D>> | ||
4057 | 779 | { | ||
4058 | 780 | /** | ||
4059 | 781 | Invokes <code>operator\>=</code> on <code>lhs</code>. | ||
4060 | 782 | */ | ||
4061 | 783 | bool operator()(unity::util::internal::ResourcePtr<R, D> const& lhs, unity::util::internal::ResourcePtr<R, D> const& rhs) const | ||
4062 | 784 | { | ||
4063 | 785 | return lhs >= rhs; | ||
4064 | 786 | } | ||
4065 | 787 | }; | ||
4066 | 788 | |||
4067 | 789 | // TODO: provide hash if std::hash<R> exists. | ||
4068 | 790 | |||
4069 | 791 | } // namespace std | ||
4070 | 792 | |||
4071 | 793 | #endif | ||
4072 | 794 | 0 | ||
4073 | === removed directory 'src' | |||
4074 | === removed file 'src/CMakeLists.txt' | |||
4075 | --- src/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
4076 | +++ src/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4077 | @@ -1,14 +0,0 @@ | |||
4078 | 1 | add_subdirectory(unity) | ||
4079 | 2 | |||
4080 | 3 | add_library(${UNITY_API_LIB} SHARED ${UNITY_API_LIB_SRC}) | ||
4081 | 4 | set_target_properties(${UNITY_API_LIB} PROPERTIES | ||
4082 | 5 | VERSION "${UNITY_API_MAJOR}.${UNITY_API_MINOR}" | ||
4083 | 6 | SOVERSION "${UNITY_API_MAJOR}.${UNITY_API_MINOR}" | ||
4084 | 7 | ) | ||
4085 | 8 | |||
4086 | 9 | install(TARGETS ${UNITY_API_LIB} LIBRARY DESTINATION lib) | ||
4087 | 10 | |||
4088 | 11 | configure_file(lib${UNITY_API_LIB}.pc.in lib${UNITY_API_LIB}.pc @ONLY) | ||
4089 | 12 | install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${UNITY_API_LIB}.pc DESTINATION lib/pkgconfig) | ||
4090 | 13 | |||
4091 | 14 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${UNITY_SRC} PARENT_SCOPE) | ||
4092 | 15 | 0 | ||
4093 | === removed file 'src/libunity-api.pc.in' | |||
4094 | --- src/libunity-api.pc.in 2013-04-09 03:34:17 +0000 | |||
4095 | +++ src/libunity-api.pc.in 1970-01-01 00:00:00 +0000 | |||
4096 | @@ -1,23 +0,0 @@ | |||
4097 | 1 | # | ||
4098 | 2 | # Copyright (C) 2013 Canonical Ltd | ||
4099 | 3 | # | ||
4100 | 4 | # This program is free software: you can redistribute it and/or modify | ||
4101 | 5 | # it under the terms of the GNU General Public License version 3 as | ||
4102 | 6 | # published by the Free Software Foundation. | ||
4103 | 7 | # | ||
4104 | 8 | # This program is distributed in the hope that it will be useful, | ||
4105 | 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4106 | 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4107 | 11 | # GNU General Public License for more details. | ||
4108 | 12 | # | ||
4109 | 13 | # You should have received a copy of the GNU General Public License | ||
4110 | 14 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4111 | 15 | # | ||
4112 | 16 | # Authored by: Michi Henning <michi.henning@canonical.com> | ||
4113 | 17 | # | ||
4114 | 18 | |||
4115 | 19 | Name: lib@UNITY_API_LIB@ | ||
4116 | 20 | Description: Unity API library | ||
4117 | 21 | Version: @UNITY_API_MAJOR@.@UNITY_API_MINOR@ | ||
4118 | 22 | Libs: -L@CMAKE_INSTALL_PREFIX@/lib -lunity-api | ||
4119 | 23 | Cflags: -I@CMAKE_INSTALL_PREFIX@/include | ||
4120 | 24 | 0 | ||
4121 | === removed directory 'src/unity' | |||
4122 | === removed file 'src/unity/CMakeLists.txt' | |||
4123 | --- src/unity/CMakeLists.txt 2013-04-16 00:25:34 +0000 | |||
4124 | +++ src/unity/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4125 | @@ -1,10 +0,0 @@ | |||
4126 | 1 | add_subdirectory(api) | ||
4127 | 2 | add_subdirectory(internal) | ||
4128 | 3 | add_subdirectory(util) | ||
4129 | 4 | |||
4130 | 5 | set(UNITY_SRC | ||
4131 | 6 | ${CMAKE_CURRENT_SOURCE_DIR}/Exception.cpp | ||
4132 | 7 | ${CMAKE_CURRENT_SOURCE_DIR}/UnityExceptions.cpp | ||
4133 | 8 | ) | ||
4134 | 9 | |||
4135 | 10 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${UNITY_SRC} PARENT_SCOPE) | ||
4136 | 11 | 0 | ||
4137 | === removed file 'src/unity/Exception.cpp' | |||
4138 | --- src/unity/Exception.cpp 2013-04-17 02:18:48 +0000 | |||
4139 | +++ src/unity/Exception.cpp 1970-01-01 00:00:00 +0000 | |||
4140 | @@ -1,145 +0,0 @@ | |||
4141 | 1 | /* | ||
4142 | 2 | * Copyright (C) 2012 Canonical Ltd | ||
4143 | 3 | * | ||
4144 | 4 | * This program is free software: you can redistribute it and/or modify | ||
4145 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
4146 | 6 | * published by the Free Software Foundation. | ||
4147 | 7 | * | ||
4148 | 8 | * This program is distributed in the hope that it will be useful, | ||
4149 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4150 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4151 | 11 | * GNU General Public License for more details. | ||
4152 | 12 | * | ||
4153 | 13 | * You should have received a copy of the GNU General Public License | ||
4154 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4155 | 15 | * | ||
4156 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
4157 | 17 | */ | ||
4158 | 18 | |||
4159 | 19 | #include <unity/Exception.h> | ||
4160 | 20 | #include <unity/internal/ExceptionImpl.h> | ||
4161 | 21 | |||
4162 | 22 | using namespace std; | ||
4163 | 23 | |||
4164 | 24 | namespace unity | ||
4165 | 25 | { | ||
4166 | 26 | |||
4167 | 27 | //! @cond | ||
4168 | 28 | |||
4169 | 29 | Exception:: | ||
4170 | 30 | Exception(shared_ptr<internal::ExceptionImpl> const& derived) | ||
4171 | 31 | : p_(derived) | ||
4172 | 32 | { | ||
4173 | 33 | } | ||
4174 | 34 | |||
4175 | 35 | Exception:: | ||
4176 | 36 | Exception(Exception const&) = default; | ||
4177 | 37 | |||
4178 | 38 | Exception& | ||
4179 | 39 | Exception:: | ||
4180 | 40 | operator=(Exception const&) = default; | ||
4181 | 41 | |||
4182 | 42 | Exception:: | ||
4183 | 43 | ~Exception() noexcept = default; | ||
4184 | 44 | |||
4185 | 45 | //! @endcond | ||
4186 | 46 | |||
4187 | 47 | /** | ||
4188 | 48 | \brief Returns the reason set by the derived class's constructor (empty string if none). | ||
4189 | 49 | |||
4190 | 50 | Derived classes should include any other state information, such as the value of data members or | ||
4191 | 51 | other relevant detail in the <code>reason</code> string they pass to the protected constructor. | ||
4192 | 52 | */ | ||
4193 | 53 | |||
4194 | 54 | string | ||
4195 | 55 | Exception:: | ||
4196 | 56 | reason() const | ||
4197 | 57 | { | ||
4198 | 58 | return p_->reason(); | ||
4199 | 59 | } | ||
4200 | 60 | |||
4201 | 61 | /** | ||
4202 | 62 | Returns a string describing the exception, including any exceptions that were nested or chained. | ||
4203 | 63 | |||
4204 | 64 | Nested exceptions are indented according to their nesting level. If the exception contains chained | ||
4205 | 65 | exceptions, these are shown in oldest-to-newest order. | ||
4206 | 66 | |||
4207 | 67 | \param indent This controls the amount of indenting per level. The default indent is four spaces. | ||
4208 | 68 | \return The string describing the exception. | ||
4209 | 69 | |||
4210 | 70 | \note The default implementation of this member function calls <code>to_string(0, indent)</code>. | ||
4211 | 71 | */ | ||
4212 | 72 | |||
4213 | 73 | string | ||
4214 | 74 | Exception:: | ||
4215 | 75 | to_string(std::string const& indent) const | ||
4216 | 76 | { | ||
4217 | 77 | return p_->to_string(*this, 0, indent); | ||
4218 | 78 | } | ||
4219 | 79 | |||
4220 | 80 | /** | ||
4221 | 81 | Returns a string describing the exception, including any exceptions that were nested or chained. | ||
4222 | 82 | |||
4223 | 83 | Nested exceptions are indented according to their nesting level. If the exception contains chained | ||
4224 | 84 | exceptions, these are shown in oldest-to-newest order. | ||
4225 | 85 | |||
4226 | 86 | \param indent_level This controls the indent level. The value <code>0</code> indicates | ||
4227 | 87 | the outermost level (no indent). | ||
4228 | 88 | \param indent This controls the amount of indenting per level. The passed string is prependended | ||
4229 | 89 | <i><code>indent_level</code></i> times to each line. | ||
4230 | 90 | \return The string describing the exception. | ||
4231 | 91 | |||
4232 | 92 | \note This member function has a default implementation, so derived classes do not need to override it | ||
4233 | 93 | unless they want to change the formatting of the returned string. | ||
4234 | 94 | */ | ||
4235 | 95 | |||
4236 | 96 | string | ||
4237 | 97 | Exception:: | ||
4238 | 98 | to_string(int indent_level, std::string const& indent) const | ||
4239 | 99 | { | ||
4240 | 100 | return p_->to_string(*this, indent_level, indent); | ||
4241 | 101 | } | ||
4242 | 102 | |||
4243 | 103 | /** | ||
4244 | 104 | Adds an exception to the exception history chain. | ||
4245 | 105 | |||
4246 | 106 | \param earlier_exception The parameter must be a <code>nullptr</code> or a <code>std::exception_ptr</code> | ||
4247 | 107 | to an exception that was remembered earlier. This allows a sequence of exceptions to be remembered without | ||
4248 | 108 | having to throw them and is useful for example, in shutdown scenarios where any one of a sequence of steps | ||
4249 | 109 | can fail, but we want to continue and try all the following steps and only throw after all of them have been | ||
4250 | 110 | tried. In this case, each step that fails can add itself to the sequence of remembered exceptions, and finally | ||
4251 | 111 | throw something like <code>ShutdownException</code>. | ||
4252 | 112 | \return A <code>std::exception_ptr</code> to <code>this</code>. | ||
4253 | 113 | */ | ||
4254 | 114 | |||
4255 | 115 | exception_ptr | ||
4256 | 116 | Exception:: | ||
4257 | 117 | remember(exception_ptr earlier_exception) | ||
4258 | 118 | { | ||
4259 | 119 | return p_->remember(this, earlier_exception); | ||
4260 | 120 | } | ||
4261 | 121 | |||
4262 | 122 | /** | ||
4263 | 123 | Returns the previous exception. | ||
4264 | 124 | \return Returns the next-older remembered exception, or <code>nullptr</code>, if none. | ||
4265 | 125 | */ | ||
4266 | 126 | |||
4267 | 127 | exception_ptr | ||
4268 | 128 | Exception:: | ||
4269 | 129 | get_earlier() const noexcept | ||
4270 | 130 | { | ||
4271 | 131 | return p_->get_earlier(); | ||
4272 | 132 | } | ||
4273 | 133 | |||
4274 | 134 | //! @cond | ||
4275 | 135 | |||
4276 | 136 | internal::ExceptionImpl* | ||
4277 | 137 | Exception:: | ||
4278 | 138 | pimpl() const noexcept | ||
4279 | 139 | { | ||
4280 | 140 | return p_.get(); | ||
4281 | 141 | } | ||
4282 | 142 | |||
4283 | 143 | //! @endcond | ||
4284 | 144 | |||
4285 | 145 | } // namespace unity | ||
4286 | 146 | 0 | ||
4287 | === removed file 'src/unity/UnityExceptions.cpp' | |||
4288 | --- src/unity/UnityExceptions.cpp 2013-04-04 02:16:16 +0000 | |||
4289 | +++ src/unity/UnityExceptions.cpp 1970-01-01 00:00:00 +0000 | |||
4290 | @@ -1,246 +0,0 @@ | |||
4291 | 1 | /* | ||
4292 | 2 | * Copyright (C) 2012 Canonical Ltd | ||
4293 | 3 | * | ||
4294 | 4 | * This program is free software: you can redistribute it and/or modify | ||
4295 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
4296 | 6 | * published by the Free Software Foundation. | ||
4297 | 7 | * | ||
4298 | 8 | * This program is distributed in the hope that it will be useful, | ||
4299 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4300 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4301 | 11 | * GNU General Public License for more details. | ||
4302 | 12 | * | ||
4303 | 13 | * You should have received a copy of the GNU General Public License | ||
4304 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4305 | 15 | * | ||
4306 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
4307 | 17 | */ | ||
4308 | 18 | |||
4309 | 19 | #include <unity/UnityExceptions.h> | ||
4310 | 20 | #include <unity/internal/UnityExceptionsImpl.h> | ||
4311 | 21 | |||
4312 | 22 | using namespace std; | ||
4313 | 23 | |||
4314 | 24 | namespace unity | ||
4315 | 25 | { | ||
4316 | 26 | |||
4317 | 27 | InvalidArgumentException:: | ||
4318 | 28 | InvalidArgumentException(string const& reason) | ||
4319 | 29 | : Exception(make_shared<internal::InvalidArgumentExceptionImpl>(reason)) | ||
4320 | 30 | { | ||
4321 | 31 | } | ||
4322 | 32 | |||
4323 | 33 | InvalidArgumentException:: | ||
4324 | 34 | InvalidArgumentException(InvalidArgumentException const&) = default; | ||
4325 | 35 | |||
4326 | 36 | //! @cond | ||
4327 | 37 | |||
4328 | 38 | InvalidArgumentException& | ||
4329 | 39 | InvalidArgumentException:: | ||
4330 | 40 | operator=(InvalidArgumentException const&) = default; | ||
4331 | 41 | |||
4332 | 42 | |||
4333 | 43 | InvalidArgumentException:: | ||
4334 | 44 | ~InvalidArgumentException() noexcept = default; | ||
4335 | 45 | |||
4336 | 46 | //! @endcond | ||
4337 | 47 | |||
4338 | 48 | char const* | ||
4339 | 49 | InvalidArgumentException:: | ||
4340 | 50 | what() const noexcept | ||
4341 | 51 | { | ||
4342 | 52 | return dynamic_cast<internal::InvalidArgumentExceptionImpl*>(pimpl())->what(); | ||
4343 | 53 | } | ||
4344 | 54 | |||
4345 | 55 | exception_ptr | ||
4346 | 56 | InvalidArgumentException:: | ||
4347 | 57 | self() const | ||
4348 | 58 | { | ||
4349 | 59 | return make_exception_ptr(*this); | ||
4350 | 60 | } | ||
4351 | 61 | |||
4352 | 62 | LogicException:: | ||
4353 | 63 | LogicException(string const& reason) | ||
4354 | 64 | : Exception(make_shared<internal::LogicExceptionImpl>(reason)) | ||
4355 | 65 | { | ||
4356 | 66 | } | ||
4357 | 67 | |||
4358 | 68 | LogicException:: | ||
4359 | 69 | LogicException(LogicException const&) = default; | ||
4360 | 70 | |||
4361 | 71 | //! @cond | ||
4362 | 72 | |||
4363 | 73 | LogicException& | ||
4364 | 74 | LogicException:: | ||
4365 | 75 | operator=(LogicException const&) = default; | ||
4366 | 76 | |||
4367 | 77 | LogicException:: | ||
4368 | 78 | ~LogicException() noexcept = default; | ||
4369 | 79 | |||
4370 | 80 | //! @endcond | ||
4371 | 81 | |||
4372 | 82 | char const* | ||
4373 | 83 | LogicException:: | ||
4374 | 84 | what() const noexcept | ||
4375 | 85 | { | ||
4376 | 86 | return dynamic_cast<internal::LogicExceptionImpl*>(pimpl())->what(); | ||
4377 | 87 | } | ||
4378 | 88 | |||
4379 | 89 | exception_ptr | ||
4380 | 90 | LogicException:: | ||
4381 | 91 | self() const | ||
4382 | 92 | { | ||
4383 | 93 | return make_exception_ptr(*this); | ||
4384 | 94 | } | ||
4385 | 95 | |||
4386 | 96 | ShutdownException:: | ||
4387 | 97 | ShutdownException(string const& reason) | ||
4388 | 98 | : Exception(make_shared<internal::ShutdownExceptionImpl>(reason)) | ||
4389 | 99 | { | ||
4390 | 100 | } | ||
4391 | 101 | |||
4392 | 102 | ShutdownException:: | ||
4393 | 103 | ShutdownException(ShutdownException const&) = default; | ||
4394 | 104 | |||
4395 | 105 | //! @cond | ||
4396 | 106 | |||
4397 | 107 | ShutdownException& | ||
4398 | 108 | ShutdownException:: | ||
4399 | 109 | operator=(ShutdownException const&) = default; | ||
4400 | 110 | |||
4401 | 111 | ShutdownException:: | ||
4402 | 112 | ~ShutdownException() noexcept = default; | ||
4403 | 113 | |||
4404 | 114 | //! @endcond | ||
4405 | 115 | |||
4406 | 116 | char const* | ||
4407 | 117 | ShutdownException:: | ||
4408 | 118 | what() const noexcept | ||
4409 | 119 | { | ||
4410 | 120 | return dynamic_cast<internal::ShutdownExceptionImpl*>(pimpl())->what(); | ||
4411 | 121 | } | ||
4412 | 122 | |||
4413 | 123 | exception_ptr | ||
4414 | 124 | ShutdownException:: | ||
4415 | 125 | self() const | ||
4416 | 126 | { | ||
4417 | 127 | return make_exception_ptr(*this); | ||
4418 | 128 | } | ||
4419 | 129 | |||
4420 | 130 | FileException:: | ||
4421 | 131 | FileException(string const& reason, int err) | ||
4422 | 132 | : Exception(make_shared<internal::FileExceptionImpl>(reason, err)) | ||
4423 | 133 | { | ||
4424 | 134 | } | ||
4425 | 135 | |||
4426 | 136 | FileException:: | ||
4427 | 137 | FileException(FileException const&) = default; | ||
4428 | 138 | |||
4429 | 139 | //! @cond | ||
4430 | 140 | |||
4431 | 141 | FileException& | ||
4432 | 142 | FileException:: | ||
4433 | 143 | operator=(FileException const&) = default; | ||
4434 | 144 | |||
4435 | 145 | FileException:: | ||
4436 | 146 | ~FileException() noexcept = default; | ||
4437 | 147 | |||
4438 | 148 | //! @endcond | ||
4439 | 149 | |||
4440 | 150 | char const* | ||
4441 | 151 | FileException:: | ||
4442 | 152 | what() const noexcept | ||
4443 | 153 | { | ||
4444 | 154 | return dynamic_cast<internal::FileExceptionImpl*>(pimpl())->what(); | ||
4445 | 155 | } | ||
4446 | 156 | |||
4447 | 157 | int | ||
4448 | 158 | FileException:: | ||
4449 | 159 | error() const noexcept | ||
4450 | 160 | { | ||
4451 | 161 | return dynamic_cast<internal::FileExceptionImpl*>(pimpl())->error(); | ||
4452 | 162 | } | ||
4453 | 163 | |||
4454 | 164 | exception_ptr | ||
4455 | 165 | FileException:: | ||
4456 | 166 | self() const | ||
4457 | 167 | { | ||
4458 | 168 | return make_exception_ptr(*this); | ||
4459 | 169 | } | ||
4460 | 170 | |||
4461 | 171 | SyscallException:: | ||
4462 | 172 | SyscallException(string const& reason, int err) | ||
4463 | 173 | : Exception(make_shared<internal::SyscallExceptionImpl>(reason, err)) | ||
4464 | 174 | { | ||
4465 | 175 | } | ||
4466 | 176 | |||
4467 | 177 | SyscallException:: | ||
4468 | 178 | SyscallException(SyscallException const&) = default; | ||
4469 | 179 | |||
4470 | 180 | //! @cond | ||
4471 | 181 | |||
4472 | 182 | SyscallException& | ||
4473 | 183 | SyscallException:: | ||
4474 | 184 | operator=(SyscallException const&) = default; | ||
4475 | 185 | |||
4476 | 186 | SyscallException:: | ||
4477 | 187 | ~SyscallException() noexcept = default; | ||
4478 | 188 | |||
4479 | 189 | //! @endcond | ||
4480 | 190 | |||
4481 | 191 | char const* | ||
4482 | 192 | SyscallException:: | ||
4483 | 193 | what() const noexcept | ||
4484 | 194 | { | ||
4485 | 195 | return dynamic_cast<internal::SyscallExceptionImpl*>(pimpl())->what(); | ||
4486 | 196 | } | ||
4487 | 197 | |||
4488 | 198 | int | ||
4489 | 199 | SyscallException:: | ||
4490 | 200 | error() const noexcept | ||
4491 | 201 | { | ||
4492 | 202 | return dynamic_cast<internal::SyscallExceptionImpl*>(pimpl())->error(); | ||
4493 | 203 | } | ||
4494 | 204 | |||
4495 | 205 | exception_ptr | ||
4496 | 206 | SyscallException:: | ||
4497 | 207 | self() const | ||
4498 | 208 | { | ||
4499 | 209 | return make_exception_ptr(*this); | ||
4500 | 210 | } | ||
4501 | 211 | |||
4502 | 212 | ResourceException:: | ||
4503 | 213 | ResourceException(string const& reason) | ||
4504 | 214 | : Exception(make_shared<internal::ResourceExceptionImpl>(reason)) | ||
4505 | 215 | { | ||
4506 | 216 | } | ||
4507 | 217 | |||
4508 | 218 | ResourceException:: | ||
4509 | 219 | ResourceException(ResourceException const&) = default; | ||
4510 | 220 | |||
4511 | 221 | //! @cond | ||
4512 | 222 | |||
4513 | 223 | ResourceException& | ||
4514 | 224 | ResourceException:: | ||
4515 | 225 | operator=(ResourceException const&) = default; | ||
4516 | 226 | |||
4517 | 227 | ResourceException:: | ||
4518 | 228 | ~ResourceException() noexcept = default; | ||
4519 | 229 | |||
4520 | 230 | //! @endcond | ||
4521 | 231 | |||
4522 | 232 | char const* | ||
4523 | 233 | ResourceException:: | ||
4524 | 234 | what() const noexcept | ||
4525 | 235 | { | ||
4526 | 236 | return dynamic_cast<internal::ResourceExceptionImpl*>(pimpl())->what(); | ||
4527 | 237 | } | ||
4528 | 238 | |||
4529 | 239 | exception_ptr | ||
4530 | 240 | ResourceException:: | ||
4531 | 241 | self() const | ||
4532 | 242 | { | ||
4533 | 243 | return make_exception_ptr(*this); | ||
4534 | 244 | } | ||
4535 | 245 | |||
4536 | 246 | } // namespace unity | ||
4537 | 247 | 0 | ||
4538 | === removed directory 'src/unity/api' | |||
4539 | === removed file 'src/unity/api/CMakeLists.txt' | |||
4540 | --- src/unity/api/CMakeLists.txt 2013-04-16 00:25:34 +0000 | |||
4541 | +++ src/unity/api/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4542 | @@ -1,8 +0,0 @@ | |||
4543 | 1 | add_subdirectory(internal) | ||
4544 | 2 | add_subdirectory(scopes) | ||
4545 | 3 | |||
4546 | 4 | set(API_SRC | ||
4547 | 5 | ${CMAKE_CURRENT_SOURCE_DIR}/Version.cpp | ||
4548 | 6 | ) | ||
4549 | 7 | |||
4550 | 8 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${API_SRC} PARENT_SCOPE) | ||
4551 | 9 | 0 | ||
4552 | === removed file 'src/unity/api/Version.cpp' | |||
4553 | --- src/unity/api/Version.cpp 2013-04-04 02:16:16 +0000 | |||
4554 | +++ src/unity/api/Version.cpp 1970-01-01 00:00:00 +0000 | |||
4555 | @@ -1,59 +0,0 @@ | |||
4556 | 1 | /* | ||
4557 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
4558 | 3 | * | ||
4559 | 4 | * This program is free software: you can redistribute it and/or modify | ||
4560 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
4561 | 6 | * published by the Free Software Foundation. | ||
4562 | 7 | * | ||
4563 | 8 | * This program is distributed in the hope that it will be useful, | ||
4564 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4565 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4566 | 11 | * GNU General Public License for more details. | ||
4567 | 12 | * | ||
4568 | 13 | * You should have received a copy of the GNU General Public License | ||
4569 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4570 | 15 | * | ||
4571 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
4572 | 17 | */ | ||
4573 | 18 | |||
4574 | 19 | #include <unity/api/Version.h> | ||
4575 | 20 | |||
4576 | 21 | using namespace std; | ||
4577 | 22 | |||
4578 | 23 | namespace unity | ||
4579 | 24 | { | ||
4580 | 25 | |||
4581 | 26 | namespace api | ||
4582 | 27 | { | ||
4583 | 28 | |||
4584 | 29 | int | ||
4585 | 30 | Version:: | ||
4586 | 31 | major_version() | ||
4587 | 32 | { | ||
4588 | 33 | return UNITY_API_VERSION_MAJOR; | ||
4589 | 34 | } | ||
4590 | 35 | |||
4591 | 36 | int | ||
4592 | 37 | Version:: | ||
4593 | 38 | minor_version() | ||
4594 | 39 | { | ||
4595 | 40 | return UNITY_API_VERSION_MINOR; | ||
4596 | 41 | } | ||
4597 | 42 | |||
4598 | 43 | int | ||
4599 | 44 | Version:: | ||
4600 | 45 | micro_version() | ||
4601 | 46 | { | ||
4602 | 47 | return UNITY_API_VERSION_MICRO; | ||
4603 | 48 | } | ||
4604 | 49 | |||
4605 | 50 | char const* | ||
4606 | 51 | Version:: | ||
4607 | 52 | str() | ||
4608 | 53 | { | ||
4609 | 54 | return UNITY_API_VERSION_STRING; | ||
4610 | 55 | } | ||
4611 | 56 | |||
4612 | 57 | } // namespace api | ||
4613 | 58 | |||
4614 | 59 | } // namespace unity | ||
4615 | 60 | 0 | ||
4616 | === removed directory 'src/unity/api/internal' | |||
4617 | === removed file 'src/unity/api/internal/CMakeLists.txt' | |||
4618 | --- src/unity/api/internal/CMakeLists.txt 2013-04-16 00:25:34 +0000 | |||
4619 | +++ src/unity/api/internal/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4620 | @@ -1,4 +0,0 @@ | |||
4621 | 1 | set(API_INTERNAL_SRC | ||
4622 | 2 | ) | ||
4623 | 3 | |||
4624 | 4 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${API_INTERNAL_SRC} PARENT_SCOPE) | ||
4625 | 5 | 0 | ||
4626 | === removed directory 'src/unity/api/scopes' | |||
4627 | === removed file 'src/unity/api/scopes/CMakeLists.txt' | |||
4628 | --- src/unity/api/scopes/CMakeLists.txt 2013-04-16 00:25:34 +0000 | |||
4629 | +++ src/unity/api/scopes/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4630 | @@ -1,6 +0,0 @@ | |||
4631 | 1 | add_subdirectory(internal) | ||
4632 | 2 | |||
4633 | 3 | set(SCOPES_SRC | ||
4634 | 4 | ) | ||
4635 | 5 | |||
4636 | 6 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${SCOPES_SRC} PARENT_SCOPE) | ||
4637 | 7 | 0 | ||
4638 | === removed directory 'src/unity/api/scopes/internal' | |||
4639 | === removed file 'src/unity/api/scopes/internal/CMakeLists.txt' | |||
4640 | --- src/unity/api/scopes/internal/CMakeLists.txt 2013-04-22 18:14:52 +0000 | |||
4641 | +++ src/unity/api/scopes/internal/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4642 | @@ -1,4 +0,0 @@ | |||
4643 | 1 | set(SCOPES_INTERNAL_SRC | ||
4644 | 2 | ) | ||
4645 | 3 | |||
4646 | 4 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${SCOPES_INTERNAL_SRC} PARENT_SCOPE) | ||
4647 | 5 | 0 | ||
4648 | === removed directory 'src/unity/internal' | |||
4649 | === removed file 'src/unity/internal/CMakeLists.txt' | |||
4650 | --- src/unity/internal/CMakeLists.txt 2013-04-16 00:25:34 +0000 | |||
4651 | +++ src/unity/internal/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
4652 | @@ -1,6 +0,0 @@ | |||
4653 | 1 | set(UNITY_INTERNAL_SRC | ||
4654 | 2 | ${CMAKE_CURRENT_SOURCE_DIR}/ExceptionImpl.cpp | ||
4655 | 3 | ${CMAKE_CURRENT_SOURCE_DIR}/UnityExceptionsImpl.cpp | ||
4656 | 4 | ) | ||
4657 | 5 | |||
4658 | 6 | set(UNITY_API_LIB_SRC ${UNITY_API_LIB_SRC} ${UNITY_INTERNAL_SRC} PARENT_SCOPE) | ||
4659 | 7 | 0 | ||
4660 | === removed file 'src/unity/internal/ExceptionImpl.cpp' | |||
4661 | --- src/unity/internal/ExceptionImpl.cpp 2013-04-04 02:16:16 +0000 | |||
4662 | +++ src/unity/internal/ExceptionImpl.cpp 1970-01-01 00:00:00 +0000 | |||
4663 | @@ -1,244 +0,0 @@ | |||
4664 | 1 | /* | ||
4665 | 2 | * Copyright (C) 2013 Canonical Ltd | ||
4666 | 3 | * | ||
4667 | 4 | * This program is free software: you can redistribute it and/or modify | ||
4668 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
4669 | 6 | * published by the Free Software Foundation. | ||
4670 | 7 | * | ||
4671 | 8 | * This program is distributed in the hope that it will be useful, | ||
4672 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4673 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4674 | 11 | * GNU General Public License for more details. | ||
4675 | 12 | * | ||
4676 | 13 | * You should have received a copy of the GNU General Public License | ||
4677 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4678 | 15 | * | ||
4679 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
4680 | 17 | */ | ||
4681 | 18 | |||
4682 | 19 | #include <unity/internal/ExceptionImpl.h> | ||
4683 | 20 | #include <unity/Exception.h> | ||
4684 | 21 | |||
4685 | 22 | using namespace std; | ||
4686 | 23 | |||
4687 | 24 | namespace unity | ||
4688 | 25 | { | ||
4689 | 26 | |||
4690 | 27 | namespace internal | ||
4691 | 28 | { | ||
4692 | 29 | |||
4693 | 30 | ExceptionImpl:: | ||
4694 | 31 | ExceptionImpl(string const& reason) | ||
4695 | 32 | : reason_(reason) | ||
4696 | 33 | { | ||
4697 | 34 | } | ||
4698 | 35 | |||
4699 | 36 | ExceptionImpl:: | ||
4700 | 37 | ~ExceptionImpl() noexcept = default; | ||
4701 | 38 | |||
4702 | 39 | string | ||
4703 | 40 | ExceptionImpl:: | ||
4704 | 41 | reason() const | ||
4705 | 42 | { | ||
4706 | 43 | return reason_; | ||
4707 | 44 | } | ||
4708 | 45 | |||
4709 | 46 | namespace | ||
4710 | 47 | { | ||
4711 | 48 | |||
4712 | 49 | // | ||
4713 | 50 | // Return the margin string for the indent level and indent. | ||
4714 | 51 | // | ||
4715 | 52 | |||
4716 | 53 | string | ||
4717 | 54 | get_margin(int indent_level, string const& indent) | ||
4718 | 55 | { | ||
4719 | 56 | string margin; | ||
4720 | 57 | for (int i = 0; i < indent_level; ++i) | ||
4721 | 58 | { | ||
4722 | 59 | margin += indent; | ||
4723 | 60 | } | ||
4724 | 61 | return margin; | ||
4725 | 62 | } | ||
4726 | 63 | |||
4727 | 64 | // | ||
4728 | 65 | // Follow the nested exceptions that were rethrown along the call stack, printing them into s. | ||
4729 | 66 | // | ||
4730 | 67 | |||
4731 | 68 | void | ||
4732 | 69 | print_name_and_reason(string& s, nested_exception const& nested) | ||
4733 | 70 | { | ||
4734 | 71 | // Add the what() string if this is a std::exception. | ||
4735 | 72 | |||
4736 | 73 | std::exception const* std_exception = dynamic_cast<std::exception const*>(&nested); | ||
4737 | 74 | if (std_exception) | ||
4738 | 75 | { | ||
4739 | 76 | s += std_exception->what(); | ||
4740 | 77 | } | ||
4741 | 78 | |||
4742 | 79 | // Add the reason if this is a unity::Exception. | ||
4743 | 80 | |||
4744 | 81 | unity::Exception const* unity_exception = dynamic_cast<unity::Exception const*>(&nested); | ||
4745 | 82 | if (unity_exception) | ||
4746 | 83 | { | ||
4747 | 84 | string reason = unity_exception->reason(); | ||
4748 | 85 | if (!reason.empty()) | ||
4749 | 86 | { | ||
4750 | 87 | s += ": " + reason; | ||
4751 | 88 | } | ||
4752 | 89 | } | ||
4753 | 90 | |||
4754 | 91 | // Append info about unknown std::exception and std::nested_exception. | ||
4755 | 92 | |||
4756 | 93 | if (!unity_exception) | ||
4757 | 94 | { | ||
4758 | 95 | if (std_exception) | ||
4759 | 96 | { | ||
4760 | 97 | s += " (derived from std::exception and std::nested_exception)"; | ||
4761 | 98 | } | ||
4762 | 99 | else | ||
4763 | 100 | { | ||
4764 | 101 | s += "std::nested_exception"; | ||
4765 | 102 | } | ||
4766 | 103 | } | ||
4767 | 104 | } | ||
4768 | 105 | |||
4769 | 106 | void | ||
4770 | 107 | follow_nested(string& s, nested_exception const& nested, int indent_level, std::string const& indent) | ||
4771 | 108 | { | ||
4772 | 109 | if (nested.nested_ptr()) | ||
4773 | 110 | { | ||
4774 | 111 | string margin = get_margin(indent_level, indent); | ||
4775 | 112 | |||
4776 | 113 | s += ":\n"; | ||
4777 | 114 | try | ||
4778 | 115 | { | ||
4779 | 116 | nested.rethrow_nested(); | ||
4780 | 117 | } | ||
4781 | 118 | catch (std::nested_exception const& e) | ||
4782 | 119 | { | ||
4783 | 120 | unity::Exception const* ge = dynamic_cast<unity::Exception const*>(&e); | ||
4784 | 121 | if (ge) | ||
4785 | 122 | { | ||
4786 | 123 | s += ge->to_string(indent_level + 1, indent); | ||
4787 | 124 | } | ||
4788 | 125 | else | ||
4789 | 126 | { | ||
4790 | 127 | s += margin + indent; | ||
4791 | 128 | print_name_and_reason(s, e); | ||
4792 | 129 | follow_nested(s, e, indent_level + 1, indent); | ||
4793 | 130 | } | ||
4794 | 131 | } | ||
4795 | 132 | catch (std::exception const& e) | ||
4796 | 133 | { | ||
4797 | 134 | s += margin + indent; | ||
4798 | 135 | s += e.what(); // Can show only what() for std::exception. | ||
4799 | 136 | } | ||
4800 | 137 | catch (...) | ||
4801 | 138 | { | ||
4802 | 139 | s += margin + indent; | ||
4803 | 140 | s += "unknown exception"; // Best we can do for an exception whose type we don't know. | ||
4804 | 141 | } | ||
4805 | 142 | } | ||
4806 | 143 | } | ||
4807 | 144 | |||
4808 | 145 | // | ||
4809 | 146 | // Follow the history chain and print each exception in the chain. | ||
4810 | 147 | // | ||
4811 | 148 | |||
4812 | 149 | void | ||
4813 | 150 | follow_history(string& s, int& count, unity::Exception const& e, int indent_level, std::string const& indent) | ||
4814 | 151 | { | ||
4815 | 152 | if (!e.get_earlier()) | ||
4816 | 153 | { | ||
4817 | 154 | count = 1; // We have reached the oldest exception; set exception generation count and terminate recursion. | ||
4818 | 155 | } | ||
4819 | 156 | else | ||
4820 | 157 | { | ||
4821 | 158 | try | ||
4822 | 159 | { | ||
4823 | 160 | rethrow_exception(e.get_earlier()); | ||
4824 | 161 | } | ||
4825 | 162 | catch (unity::Exception const& e) | ||
4826 | 163 | { | ||
4827 | 164 | // Recurse along the chain until we hit the end, then, as we pop back up the levels, we increment the | ||
4828 | 165 | // count and print it as a generation number for the exception information. | ||
4829 | 166 | // A bit like the "kicks" in "Inception", except that the deepest level is level 1... | ||
4830 | 167 | |||
4831 | 168 | follow_history(s, count, e, indent_level, indent); | ||
4832 | 169 | } | ||
4833 | 170 | ++count; | ||
4834 | 171 | } | ||
4835 | 172 | |||
4836 | 173 | // Show info for this exception. | ||
4837 | 174 | |||
4838 | 175 | s += "\n" + get_margin(indent_level, indent) + "Exception #"; | ||
4839 | 176 | s += to_string(count) + ":\n"; | ||
4840 | 177 | s += get_margin(indent_level, indent) + indent; | ||
4841 | 178 | print_name_and_reason(s, e); | ||
4842 | 179 | follow_nested(s, e, indent_level + 1, indent); | ||
4843 | 180 | } | ||
4844 | 181 | |||
4845 | 182 | } // namespace | ||
4846 | 183 | |||
4847 | 184 | string | ||
4848 | 185 | ExceptionImpl:: | ||
4849 | 186 | to_string(nested_exception const& nested, int indent_level, string const& indent) const | ||
4850 | 187 | { | ||
4851 | 188 | string margin = get_margin(indent_level, indent); | ||
4852 | 189 | string s = margin; | ||
4853 | 190 | s += what(); | ||
4854 | 191 | |||
4855 | 192 | string r = reason(); | ||
4856 | 193 | if (!r.empty()) | ||
4857 | 194 | { | ||
4858 | 195 | s += ": " + r; | ||
4859 | 196 | } | ||
4860 | 197 | |||
4861 | 198 | // Check whether there is an exception history and print each exception in the history. | ||
4862 | 199 | |||
4863 | 200 | unity::Exception const* unity_exception(dynamic_cast<unity::Exception const*>(&nested)); | ||
4864 | 201 | if (unity_exception && unity_exception->get_earlier()) | ||
4865 | 202 | { | ||
4866 | 203 | s += "\n" + margin + indent + "Exception history:"; | ||
4867 | 204 | try | ||
4868 | 205 | { | ||
4869 | 206 | rethrow_exception(unity_exception->get_earlier()); | ||
4870 | 207 | } | ||
4871 | 208 | catch (unity::Exception const& e) | ||
4872 | 209 | { | ||
4873 | 210 | int count; | ||
4874 | 211 | follow_history(s, count, e, indent_level + 2, indent); | ||
4875 | 212 | } | ||
4876 | 213 | } | ||
4877 | 214 | |||
4878 | 215 | // Print this and any nested exceptions. | ||
4879 | 216 | |||
4880 | 217 | follow_nested(s, nested, indent_level, indent); | ||
4881 | 218 | |||
4882 | 219 | return s; | ||
4883 | 220 | } | ||
4884 | 221 | |||
4885 | 222 | exception_ptr | ||
4886 | 223 | ExceptionImpl:: | ||
4887 | 224 | remember(Exception const* env, exception_ptr earlier_exception) | ||
4888 | 225 | { | ||
4889 | 226 | // Doesn't prevent loops, but protects against accidental self-assignment. | ||
4890 | 227 | |||
4891 | 228 | if (previous_ != earlier_exception) | ||
4892 | 229 | { | ||
4893 | 230 | previous_ = earlier_exception; | ||
4894 | 231 | } | ||
4895 | 232 | return env->self(); | ||
4896 | 233 | } | ||
4897 | 234 | |||
4898 | 235 | exception_ptr | ||
4899 | 236 | ExceptionImpl:: | ||
4900 | 237 | get_earlier() const noexcept | ||
4901 | 238 | { | ||
4902 | 239 | return previous_; | ||
4903 | 240 | } | ||
4904 | 241 | |||
4905 | 242 | } // namespace internal | ||
4906 | 243 | |||
4907 | 244 | } // namespace unity | ||
4908 | 245 | 0 | ||
4909 | === removed file 'src/unity/internal/UnityExceptionsImpl.cpp' | |||
4910 | --- src/unity/internal/UnityExceptionsImpl.cpp 2013-04-04 02:16:16 +0000 | |||
4911 | +++ src/unity/internal/UnityExceptionsImpl.cpp 1970-01-01 00:00:00 +0000 | |||
4912 | @@ -1,126 +0,0 @@ | |||
4913 | 1 | /* | ||
4914 | 2 | * Copyright (C) 2012 Canonical Ltd | ||
4915 | 3 | * | ||
4916 | 4 | * This program is free software: you can redistribute it and/or modify | ||
4917 | 5 | * it under the terms of the GNU General Public License version 3 as | ||
4918 | 6 | * published by the Free Software Foundation. | ||
4919 | 7 | * | ||
4920 | 8 | * This program is distributed in the hope that it will be useful, | ||
4921 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
4922 | 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
4923 | 11 | * GNU General Public License for more details. | ||
4924 | 12 | * | ||
4925 | 13 | * You should have received a copy of the GNU General Public License | ||
4926 | 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
4927 | 15 | * | ||
4928 | 16 | * Authored by: Michi Henning <michi.henning@canonical.com> | ||
4929 | 17 | */ | ||
4930 | 18 | |||
4931 | 19 | #include <unity/internal/UnityExceptionsImpl.h> | ||
4932 | 20 | |||
4933 | 21 | using namespace std; | ||
4934 | 22 | |||
4935 | 23 | namespace unity | ||
4936 | 24 | { | ||
4937 | 25 | |||
4938 | 26 | namespace internal | ||
4939 | 27 | { | ||
4940 | 28 | |||
4941 | 29 | InvalidArgumentExceptionImpl:: | ||
4942 | 30 | InvalidArgumentExceptionImpl(string const& reason) | ||
4943 | 31 | : ExceptionImpl(reason) | ||
4944 | 32 | { | ||
4945 | 33 | } | ||
4946 | 34 | |||
4947 | 35 | char const* | ||
4948 | 36 | InvalidArgumentExceptionImpl:: | ||
4949 | 37 | what() const noexcept | ||
4950 | 38 | { | ||
4951 | 39 | return "unity::InvalidArgumentException"; | ||
4952 | 40 | } | ||
4953 | 41 | |||
4954 | 42 | LogicExceptionImpl:: | ||
4955 | 43 | LogicExceptionImpl(string const& reason) | ||
4956 | 44 | : ExceptionImpl(reason) | ||
4957 | 45 | { | ||
4958 | 46 | } | ||
4959 | 47 | |||
4960 | 48 | char const* | ||
4961 | 49 | LogicExceptionImpl:: | ||
4962 | 50 | what() const noexcept | ||
4963 | 51 | { | ||
4964 | 52 | return "unity::LogicException"; | ||
4965 | 53 | } | ||
4966 | 54 | |||
4967 | 55 | ShutdownExceptionImpl:: | ||
4968 | 56 | ShutdownExceptionImpl(string const& reason) | ||
4969 | 57 | : ExceptionImpl(reason) | ||
4970 | 58 | { | ||
4971 | 59 | } | ||
4972 | 60 | |||
4973 | 61 | char const* | ||
4974 | 62 | ShutdownExceptionImpl:: | ||
4975 | 63 | what() const noexcept | ||
4976 | 64 | { | ||
4977 | 65 | return "unity::ShutdownException"; | ||
4978 | 66 | } | ||
4979 | 67 | |||
4980 | 68 | FileExceptionImpl:: | ||
4981 | 69 | FileExceptionImpl(string const& reason, int err) | ||
4982 | 70 | : ExceptionImpl(reason + (err == 0 ? "" : " (errno = " + std::to_string(err) + ")")) | ||
4983 | 71 | , errno_(err) | ||
4984 | 72 | { | ||
4985 | 73 | } | ||
4986 | 74 | |||
4987 | 75 | char const* | ||
4988 | 76 | FileExceptionImpl:: | ||
4989 | 77 | what() const noexcept | ||
4990 | 78 | { | ||
4991 | 79 | return "unity::FileException"; | ||
4992 | 80 | } | ||
4993 | 81 | |||
4994 | 82 | int | ||
4995 | 83 | FileExceptionImpl:: | ||
4996 | 84 | error() const noexcept | ||
4997 | 85 | { | ||
4998 | 86 | return errno_; | ||
4999 | 87 | } | ||
5000 | 88 |
PASSED: Continuous integration, rev:698 jenkins. qa.ubuntu. com/job/ unity-phablet- ci/1053/ s-jenkins: 8080/job/ unity-phablet- qmluitests/ 1043 jenkins. qa.ubuntu. com/job/ unity-phablet- raring- armhf-ci/ 928 jenkins. qa.ubuntu. com/job/ unity-phablet- raring- armhf-ci/ 928/artifact/ work/output/ *zip*/output. zip jenkins. qa.ubuntu. com/job/ unity-phablet- raring- i386-ci/ 932 jenkins. qa.ubuntu. com/job/ generic- mediumtests- runner/ 1698
http://
Executed test runs:
SUCCESS: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
Click here to trigger a rebuild: s-jenkins: 8080/job/ unity-phablet- ci/1053/ rebuild
http://