1
=== modified file 'CMakeLists.txt'
2
--- CMakeLists.txt	2016-12-06 20:24:14 +0000
3
+++ CMakeLists.txt	2017-03-22 21:22:50 +0000
4
@@ -1,6 +1,7 @@
5
1
cmake_minimum_required(VERSION 3.0.2)
1
cmake_minimum_required(VERSION 3.0.2)
6
2
project(messaging-framework VERSION "0.1" LANGUAGES C CXX)
2
project(messaging-framework VERSION "0.1" LANGUAGES C CXX)
7
3
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
3
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
8
4
set(IS_MF_BUILD "1")
9
4
5
10
5
# Select a pedantic set of compiler flags and enable C++11 support.
6
# Select a pedantic set of compiler flags and enable C++11 support.
11
6
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-deprecated-register -Wno-extra-semi -Wno-gnu-zero-variadic-macro-arguments -fvisibility=hidden")
7
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-deprecated-register -Wno-extra-semi -Wno-gnu-zero-variadic-macro-arguments -fvisibility=hidden")
12
@@ -97,4 +98,5 @@
13
97
add_subdirectory(doc)
98
add_subdirectory(doc)
14
98
add_subdirectory(include)
99
add_subdirectory(include)
15
99
add_subdirectory(src)
100
add_subdirectory(src)
16
101
add_subdirectory(examples)
17
100
add_subdirectory(tests)
102
add_subdirectory(tests)
18
101
103
19
=== modified file 'debian/control.in'
20
--- debian/control.in	2017-03-22 21:22:50 +0000
21
+++ debian/control.in	2017-03-22 21:22:50 +0000
22
@@ -46,3 +46,9 @@
23
46
 This layer communicates third party plugins with systems like
46
 This layer communicates third party plugins with systems like
24
47
 telepathy allowing changing the system by other without having
47
 telepathy allowing changing the system by other without having
25
48
 to modify the plugins
48
 to modify the plugins
26
49
27
50
Package: mfw-plugin-dummy
28
51
Architecture: any
29
52
Depends: ${misc:Depends}, ${shlibs:Depends}
30
53
Description: Ubuntu Messaging Framework Dummy Plugin
31
54
 A plugin for messaging fw implementing Dummy protocol
32
49
55
33
=== added file 'debian/mfw-plugin-dummy.install'
34
--- debian/mfw-plugin-dummy.install	1970-01-01 00:00:00 +0000
35
+++ debian/mfw-plugin-dummy.install	2017-03-22 21:22:50 +0000
36
@@ -0,0 +1,6 @@
37
1
usr/lib/*/messaging-framework/libmfw-plugin-dummy.so* 
38
2
usr/share/dbus-1/services/org.freedesktop.Telepathy.ConnectionManager.dummy.service
39
3
usr/share/telephony-service/protocols/dummy.protocol
40
4
usr/share/dummy/assets/dummy-background.png
41
5
usr/share/dummy/assets/dummy.png
42
6
usr/share/telepathy/managers/dummy.manager
43
0
7
44
=== added directory 'examples'
45
=== added file 'examples/CMakeLists.txt'
46
--- examples/CMakeLists.txt	1970-01-01 00:00:00 +0000
47
+++ examples/CMakeLists.txt	2017-03-22 21:22:50 +0000
48
@@ -0,0 +1,1 @@
49
1
add_subdirectory(mfw-plugin-dummy)
50
0
2
51
=== added directory 'examples/mfw-plugin-dummy'
52
=== added file 'examples/mfw-plugin-dummy/CMakeLists.txt'
53
--- examples/mfw-plugin-dummy/CMakeLists.txt	1970-01-01 00:00:00 +0000
54
+++ examples/mfw-plugin-dummy/CMakeLists.txt	2017-03-22 21:22:50 +0000
55
@@ -0,0 +1,61 @@
56
1
if (NOT IS_MF_BUILD)
57
2
    project(mfw-plugin-dummy C CXX)
58
3
    cmake_minimum_required(VERSION 2.8.10)
59
4
    set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
60
5
61
6
    # Select a pedantic set of compiler flags and enable C++11 support.
62
7
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-deprecated-register -Wno-extra-semi -Wno-gnu-zero-variadic-macro-arguments -fvisibility=hidden")
63
8
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall -fno-strict-aliasing -fvisibility=hidden -fvisibility-inlines-hidden -Wextra -Wno-deprecated-register -Wno-extra-semi -Wno-gnu-zero-variadic-macro-arguments -ggdb -O0")
64
9
    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined")
65
10
    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
66
11
67
12
    # Store in CMAKE_DEB_HOST_ARCH var the current build architecture
68
13
    execute_process(COMMAND
69
14
      dpkg-architecture
70
15
        -qDEB_HOST_ARCH
71
16
      OUTPUT_VARIABLE
72
17
        CMAKE_DEB_HOST_ARCH
73
18
      OUTPUT_STRIP_TRAILING_WHITESPACE
74
19
    )
75
20
76
21
    # Include the entire CTest functionality, specifically for MakeNightlyMemCheck.
77
22
    include(CTest)
78
23
    include(GNUInstallDirs)
79
24
80
25
    find_package(Boost COMPONENTS filesystem program_options system REQUIRED)
81
26
    find_package(GLog)
82
27
    find_package(PkgConfig)
83
28
    find_package(Qt5Core REQUIRED)
84
29
    find_package(Qt5DBus REQUIRED)
85
30
    find_package(Threads)
86
31
    pkg_check_modules(PROCESS_CPP process-cpp REQUIRED)
87
32
    pkg_check_modules(MESSAGING_FW REQUIRED messaging-framework1)
88
33
endif()
89
34
90
35
set(CMAKE_INCLUDE_CURRENT_DIR ON)
91
36
92
37
set(SO_VERSION_MAJOR "1")
93
38
set(SO_VERSION_MINOR "1")
94
39
set(SO_VERSION_PATCH "0")
95
40
set(SO_VERSION "${SO_VERSION_MAJOR}.${SO_VERSION_MINOR}.${SO_VERSION_PATCH}")
96
41
97
42
option(CLICK_MODE "Installs to a contained location" on)
98
43
option(ACCEPTANCE_MODE "Enables the acceptance tests" off)
99
44
100
45
if (${ACCEPTANCE_MODE})
101
46
    set(CTEST_CONFIGURATION_TYPE acceptance)
102
47
endif()
103
48
include_directories(
104
49
  ${MESSAGING_FW_INCLUDE_DIRS}
105
50
  ${CMAKE_CURRENT_SOURCE_DIR}/include
106
51
  ${CMAKE_SOURCE_DIR}/include
107
52
  ${Boost_INCLUDE_DIRS}
108
53
  ${GLog_INCLUDE_DIR}
109
54
  ${CPPNETLIB_INCLUDE_DIRS}
110
55
)
111
56
112
57
add_subdirectory(data)
113
58
add_subdirectory(doc)
114
59
add_subdirectory(include)
115
60
add_subdirectory(src)
116
61
117
0
62
118
=== added directory 'examples/mfw-plugin-dummy/cmake'
119
=== added file 'examples/mfw-plugin-dummy/cmake/EnableCoverageReport.cmake'
120
--- examples/mfw-plugin-dummy/cmake/EnableCoverageReport.cmake	1970-01-01 00:00:00 +0000
121
+++ examples/mfw-plugin-dummy/cmake/EnableCoverageReport.cmake	2017-03-22 21:22:50 +0000
122
@@ -0,0 +1,153 @@
123
1
# - Creates a special coverage build type and target on GCC.
124
2
#
125
3
# Defines a function ENABLE_COVERAGE_REPORT which generates the coverage target
126
4
# for selected targets. Optional arguments to this function are used to filter
127
5
# unwanted results using globbing expressions. Moreover targets with tests for
128
6
# the source code can be specified to trigger regenerating the report if the
129
7
# test has changed
130
8
#
131
9
# ENABLE_COVERAGE_REPORT(TARGETS target... [FILTER filter...] [TESTS test targets...])
132
10
#
133
11
# To generate a coverage report first build the project with
134
12
# CMAKE_BUILD_TYPE=coverage, then call make test and afterwards make coverage.
135
13
#
136
14
# The coverage report is based on gcov. Depending on the availability of lcov
137
15
# a HTML report will be generated and/or an XML report of gcovr is found.
138
16
# The generated coverage target executes all found solutions. Special targets
139
17
# exist to create e.g. only the xml report: coverage-xml. 
140
18
#
141
19
# Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
142
20
#
143
21
# This program is free software; you can redistribute it
144
22
# and/or modify it under the terms of the GNU General
145
23
# Public License as published by the Free Software Foundation;
146
24
# either version 2, or (at your option)
147
25
# any later version.
148
26
#
149
27
# This program is distributed in the hope that it will be useful,
150
28
# but WITHOUT ANY WARRANTY; without even the implied warranty of
151
29
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
152
30
# GNU General Public License for more details.
153
31
#
154
32
155
33
INCLUDE(ParseArguments)
156
34
157
35
FIND_PACKAGE(Lcov)
158
36
FIND_PACKAGE(gcovr)
159
37
160
38
FUNCTION(ENABLE_COVERAGE_REPORT)
161
39
    
162
40
    # argument parsing
163
41
    PARSE_ARGUMENTS(ARG "FILTER;TARGETS;TESTS" "" ${ARGN})
164
42
    
165
43
    SET(COVERAGE_RAW_FILE "${CMAKE_BINARY_DIR}/coverage.raw.info")
166
44
    SET(COVERAGE_FILTERED_FILE "${CMAKE_BINARY_DIR}/coverage.info")
167
45
    SET(COVERAGE_REPORT_DIR "${CMAKE_BINARY_DIR}/coveragereport")
168
46
    SET(COVERAGE_XML_FILE "${CMAKE_BINARY_DIR}/coverage.xml")
169
47
    SET(COVERAGE_XML_COMMAND_FILE "${CMAKE_BINARY_DIR}/coverage-xml.cmake")
170
48
    
171
49
    # decide if there is any tool to create coverage data
172
50
    SET(TOOL_FOUND FALSE)
173
51
    IF(LCOV_FOUND OR GCOVR_FOUND)
174
52
        SET(TOOL_FOUND TRUE)
175
53
    ENDIF()
176
54
    IF(NOT TOOL_FOUND)
177
55
        MESSAGE(STATUS "Cannot enable coverage targets because neither lcov nor gcovr are found.")
178
56
    ENDIF()
179
57
    
180
58
    STRING(TOLOWER "${CMAKE_BUILD_TYPE}" COVERAGE_BUILD_TYPE)
181
59
    IF(CMAKE_COMPILER_IS_GNUCXX AND TOOL_FOUND AND "${COVERAGE_BUILD_TYPE}" MATCHES "coverage")
182
60
    
183
61
        MESSAGE(STATUS "Coverage support enabled for targets: ${ARG_TARGETS}")
184
62
    
185
63
        # create coverage build type
186
64
        SET(CMAKE_CXX_FLAGS_COVERAGE ${CMAKE_CXX_FLAGS_DEBUG} PARENT_SCOPE)
187
65
        SET(CMAKE_C_FLAGS_COVERAGE ${CMAKE_C_FLAGS_DEBUG} PARENT_SCOPE)
188
66
        SET(CMAKE_CONFIGURATION_TYPES ${CMAKE_CONFIGURATION_TYPES} coverage PARENT_SCOPE)
189
67
    
190
68
        # instrument targets
191
69
        SET_TARGET_PROPERTIES(${ARG_TARGETS} PROPERTIES COMPILE_FLAGS --coverage
192
70
                                                        LINK_FLAGS --coverage)
193
71
    
194
72
        # html report
195
73
        IF (LCOV_FOUND)
196
74
        
197
75
            MESSAGE(STATUS "Enabling HTML coverage report")
198
76
    
199
77
            # set up coverage target
200
78
            
201
79
            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_RAW_FILE}
202
80
                               COMMAND ${LCOV_EXECUTABLE} -c -d ${CMAKE_BINARY_DIR} -o ${COVERAGE_RAW_FILE}
203
81
                               WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
204
82
                               COMMENT "Collecting coverage data"
205
83
                               DEPENDS ${ARG_TARGETS} ${ARG_TESTS}
206
84
                               VERBATIM)
207
85
            
208
86
            # filter unwanted stuff
209
87
            LIST(LENGTH ARG_FILTER FILTER_LENGTH)
210
88
            IF(${FILTER_LENGTH} GREATER 0)
211
89
                SET(FILTER COMMAND ${LCOV_EXECUTABLE})
212
90
                FOREACH(F ${ARG_FILTER})
213
91
                    SET(FILTER ${FILTER} -r ${COVERAGE_FILTERED_FILE} ${F})
214
92
                ENDFOREACH()
215
93
                SET(FILTER ${FILTER} -o ${COVERAGE_FILTERED_FILE})
216
94
            ELSE()
217
95
                SET(FILTER "")
218
96
            ENDIF()
219
97
            
220
98
            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_FILTERED_FILE}
221
99
                               COMMAND ${LCOV_EXECUTABLE} -e ${COVERAGE_RAW_FILE} "${CMAKE_SOURCE_DIR}*"  -o ${COVERAGE_FILTERED_FILE}
222
100
                               ${FILTER}
223
101
                               DEPENDS ${COVERAGE_RAW_FILE}
224
102
                               COMMENT "Filtering recorded coverage data for project-relevant entries"
225
103
                               VERBATIM)
226
104
            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_REPORT_DIR}
227
105
                               COMMAND ${CMAKE_COMMAND} -E make_directory ${COVERAGE_REPORT_DIR}
228
106
                               COMMAND ${GENHTML_EXECUTABLE} --legend --show-details -t "${PROJECT_NAME} test coverage" -o ${COVERAGE_REPORT_DIR} ${COVERAGE_FILTERED_FILE}
229
107
                               DEPENDS ${COVERAGE_FILTERED_FILE}
230
108
                               COMMENT "Generating HTML coverage report in ${COVERAGE_REPORT_DIR}"
231
109
                               VERBATIM)
232
110
                               
233
111
            ADD_CUSTOM_TARGET(coverage-html
234
112
                              DEPENDS ${COVERAGE_REPORT_DIR})
235
113
                              
236
114
        ENDIF()
237
115
        
238
116
        # xml coverage report
239
117
        IF(GCOVR_FOUND)
240
118
        
241
119
            MESSAGE(STATUS "Enabling XML coverage report")
242
120
        
243
121
            # gcovr cannot write directly to a file so the execution needs to
244
122
            # be wrapped in a cmake file that generates the file output
245
123
            FILE(WRITE ${COVERAGE_XML_COMMAND_FILE}
246
124
                 "SET(ENV{LANG} en)\n")
247
125
            FILE(APPEND ${COVERAGE_XML_COMMAND_FILE}
248
126
                "EXECUTE_PROCESS(COMMAND \"${GCOVR_EXECUTABLE}\" --exclude=tests.* --exclude=obj-.* --exclude=cmake.* -x -r \"${CMAKE_SOURCE_DIR}\" OUTPUT_FILE \"${COVERAGE_XML_FILE}\" WORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\")\n")
249
127
        
250
128
            ADD_CUSTOM_COMMAND(OUTPUT ${COVERAGE_XML_FILE}
251
129
                               COMMAND ${CMAKE_COMMAND} ARGS -P ${COVERAGE_XML_COMMAND_FILE}
252
130
                               COMMENT "Generating coverage XML report"
253
131
                               VERBATIM)
254
132
                               
255
133
            ADD_CUSTOM_TARGET(coverage-xml
256
134
                              DEPENDS ${COVERAGE_XML_FILE})
257
135
        
258
136
        ENDIF()
259
137
        
260
138
        # provide a global coverage target executing both steps if available
261
139
        SET(GLOBAL_DEPENDS "")
262
140
        IF(LCOV_FOUND)
263
141
            LIST(APPEND GLOBAL_DEPENDS ${COVERAGE_REPORT_DIR})
264
142
        ENDIF()
265
143
        IF(GCOVR_FOUND)
266
144
            LIST(APPEND GLOBAL_DEPENDS ${COVERAGE_XML_FILE})
267
145
        ENDIF()
268
146
        IF(LCOV_FOUND OR GCOVR_FOUND)
269
147
            ADD_CUSTOM_TARGET(coverage
270
148
                              DEPENDS ${GLOBAL_DEPENDS})
271
149
        ENDIF()
272
150
                          
273
151
    ENDIF()
274
152
275
153
ENDFUNCTION()   
276
0
154
277
=== added file 'examples/mfw-plugin-dummy/cmake/FindGLog.cmake'
278
--- examples/mfw-plugin-dummy/cmake/FindGLog.cmake	1970-01-01 00:00:00 +0000
279
+++ examples/mfw-plugin-dummy/cmake/FindGLog.cmake	2017-03-22 21:22:50 +0000
280
@@ -0,0 +1,14 @@
281
1
if (GLog_INCLUDE_DIR)
282
2
  # Already in cache, be silent
283
3
  set(GLog_FIND_QUIETLY TRUE)
284
4
endif ()
285
5
286
6
find_path(GLog_INCLUDE_DIR glog/logging.h)
287
7
288
8
find_library(GLog_LIBRARY libglog.so
289
9
             HINTS /usr/lib/arm-linux-gnueabihf/)
290
10
291
11
include(FindPackageHandleStandardArgs)
292
12
find_package_handle_standard_args(GLog DEFAULT_MSG GLog_LIBRARY GLog_INCLUDE_DIR)
293
13
294
14
mark_as_advanced(GLog_LIBRARY GLog_INCLUDE_DIR)
295
0
15
296
=== added file 'examples/mfw-plugin-dummy/cmake/FindLcov.cmake'
297
--- examples/mfw-plugin-dummy/cmake/FindLcov.cmake	1970-01-01 00:00:00 +0000
298
+++ examples/mfw-plugin-dummy/cmake/FindLcov.cmake	2017-03-22 21:22:50 +0000
299
@@ -0,0 +1,29 @@
300
1
# - Find lcov 
301
2
# Will define:
302
3
#
303
4
# LCOV_EXECUTABLE - the lcov binary
304
5
# GENHTML_EXECUTABLE - the genhtml executable
305
6
#
306
7
# Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
307
8
#
308
9
# This program is free software; you can redistribute it
309
10
# and/or modify it under the terms of the GNU General
310
11
# Public License as published by the Free Software Foundation;
311
12
# either version 2, or (at your option)
312
13
# any later version.
313
14
#
314
15
# This program is distributed in the hope that it will be useful,
315
16
# but WITHOUT ANY WARRANTY; without even the implied warranty of
316
17
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
317
18
# GNU General Public License for more details.
318
19
#
319
20
320
21
INCLUDE(FindPackageHandleStandardArgs)
321
22
322
23
FIND_PROGRAM(LCOV_EXECUTABLE lcov)
323
24
FIND_PROGRAM(GENHTML_EXECUTABLE genhtml)
324
25
325
26
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Lcov DEFAULT_MSG LCOV_EXECUTABLE GENHTML_EXECUTABLE)
326
27
327
28
# only visible in advanced view
328
29
MARK_AS_ADVANCED(LCOV_EXECUTABLE GENHTML_EXECUTABLE)
329
0
30
330
=== added file 'examples/mfw-plugin-dummy/cmake/Findgcovr.cmake'
331
--- examples/mfw-plugin-dummy/cmake/Findgcovr.cmake	1970-01-01 00:00:00 +0000
332
+++ examples/mfw-plugin-dummy/cmake/Findgcovr.cmake	2017-03-22 21:22:50 +0000
333
@@ -0,0 +1,31 @@
334
1
# - Find gcovr scrip 
335
2
# Will define:
336
3
#
337
4
# GCOVR_EXECUTABLE - the gcovr script
338
5
#
339
6
# Uses:
340
7
#
341
8
# GCOVR_ROOT - root to search for the script
342
9
#
343
10
# Copyright (C) 2011 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
344
11
#
345
12
# This program is free software; you can redistribute it
346
13
# and/or modify it under the terms of the GNU General
347
14
# Public License as published by the Free Software Foundation;
348
15
# either version 2, or (at your option)
349
16
# any later version.
350
17
#
351
18
# This program is distributed in the hope that it will be useful,
352
19
# but WITHOUT ANY WARRANTY; without even the implied warranty of
353
20
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
354
21
# GNU General Public License for more details.
355
22
#
356
23
357
24
INCLUDE(FindPackageHandleStandardArgs)
358
25
359
26
FIND_PROGRAM(GCOVR_EXECUTABLE gcovr HINTS ${GCOVR_ROOT} "${GCOVR_ROOT}/bin")
360
27
361
28
FIND_PACKAGE_HANDLE_STANDARD_ARGS(gcovr DEFAULT_MSG GCOVR_EXECUTABLE)
362
29
363
30
# only visible in advanced view
364
31
MARK_AS_ADVANCED(GCOVR_EXECUTABLE)
365
0
32
366
=== added file 'examples/mfw-plugin-dummy/cmake/LibFindMacros.cmake'
367
--- examples/mfw-plugin-dummy/cmake/LibFindMacros.cmake	1970-01-01 00:00:00 +0000
368
+++ examples/mfw-plugin-dummy/cmake/LibFindMacros.cmake	2017-03-22 21:22:50 +0000
369
@@ -0,0 +1,112 @@
370
1
# Version 1.0 (2013-04-12)
371
2
# Public Domain, originally written by Lasse Kärkkäinen <tronic@zi.fi>
372
3
# Published at http://www.cmake.org/Wiki/CMake:How_To_Find_Libraries
373
4
374
5
# If you improve the script, please modify the forementioned wiki page because
375
6
# I no longer maintain my scripts (hosted as static files at zi.fi). Feel free
376
7
# to remove this entire header if you use real version control instead.
377
8
378
9
# Changelog:
379
10
# 2013-04-12  Added version number (1.0) and this header, no other changes
380
11
# 2009-10-08  Originally published
381
12
382
13
383
14
# Works the same as find_package, but forwards the "REQUIRED" and "QUIET" arguments
384
15
# used for the current package. For this to work, the first parameter must be the
385
16
# prefix of the current package, then the prefix of the new package etc, which are
386
17
# passed to find_package.
387
18
macro (libfind_package PREFIX)
388
19
  set (LIBFIND_PACKAGE_ARGS ${ARGN})
389
20
  if (${PREFIX}_FIND_QUIETLY)
390
21
    set (LIBFIND_PACKAGE_ARGS ${LIBFIND_PACKAGE_ARGS} QUIET)
391
22
  endif (${PREFIX}_FIND_QUIETLY)
392
23
  if (${PREFIX}_FIND_REQUIRED)
393
24
    set (LIBFIND_PACKAGE_ARGS ${LIBFIND_PACKAGE_ARGS} REQUIRED)
394
25
  endif (${PREFIX}_FIND_REQUIRED)
395
26
  find_package(${LIBFIND_PACKAGE_ARGS})
396
27
endmacro (libfind_package)
397
28
398
29
# CMake developers made the UsePkgConfig system deprecated in the same release (2.6)
399
30
# where they added pkg_check_modules. Consequently I need to support both in my scripts
400
31
# to avoid those deprecated warnings. Here's a helper that does just that.
401
32
# Works identically to pkg_check_modules, except that no checks are needed prior to use.
402
33
macro (libfind_pkg_check_modules PREFIX PKGNAME)
403
34
  if (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
404
35
    include(UsePkgConfig)
405
36
    pkgconfig(${PKGNAME} ${PREFIX}_INCLUDE_DIRS ${PREFIX}_LIBRARY_DIRS ${PREFIX}_LDFLAGS ${PREFIX}_CFLAGS)
406
37
  else (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
407
38
    find_package(PkgConfig)
408
39
    if (PKG_CONFIG_FOUND)
409
40
      pkg_check_modules(${PREFIX} ${PKGNAME})
410
41
    endif (PKG_CONFIG_FOUND)
411
42
  endif (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4)
412
43
endmacro (libfind_pkg_check_modules)
413
44
414
45
# Do the final processing once the paths have been detected.
415
46
# If include dirs are needed, ${PREFIX}_PROCESS_INCLUDES should be set to contain
416
47
# all the variables, each of which contain one include directory.
417
48
# Ditto for ${PREFIX}_PROCESS_LIBS and library files.
418
49
# Will set ${PREFIX}_FOUND, ${PREFIX}_INCLUDE_DIRS and ${PREFIX}_LIBRARIES.
419
50
# Also handles errors in case library detection was required, etc.
420
51
macro (libfind_process PREFIX)
421
52
  # Skip processing if already processed during this run
422
53
  if (NOT ${PREFIX}_FOUND)
423
54
    # Start with the assumption that the library was found
424
55
    set (${PREFIX}_FOUND TRUE)
425
56
426
57
    # Process all includes and set _FOUND to false if any are missing
427
58
    foreach (i ${${PREFIX}_PROCESS_INCLUDES})
428
59
      if (${i})
429
60
        set (${PREFIX}_INCLUDE_DIRS ${${PREFIX}_INCLUDE_DIRS} ${${i}})
430
61
        mark_as_advanced(${i})
431
62
      else (${i})
432
63
        set (${PREFIX}_FOUND FALSE)
433
64
      endif (${i})
434
65
    endforeach (i)
435
66
436
67
    # Process all libraries and set _FOUND to false if any are missing
437
68
    foreach (i ${${PREFIX}_PROCESS_LIBS})
438
69
      if (${i})
439
70
        set (${PREFIX}_LIBRARIES ${${PREFIX}_LIBRARIES} ${${i}})
440
71
        mark_as_advanced(${i})
441
72
      else (${i})
442
73
        set (${PREFIX}_FOUND FALSE)
443
74
      endif (${i})
444
75
    endforeach (i)
445
76
446
77
    # Print message and/or exit on fatal error
447
78
    if (${PREFIX}_FOUND)
448
79
      if (NOT ${PREFIX}_FIND_QUIETLY)
449
80
        message (STATUS "Found ${PREFIX} ${${PREFIX}_VERSION}")
450
81
      endif (NOT ${PREFIX}_FIND_QUIETLY)
451
82
    else (${PREFIX}_FOUND)
452
83
      if (${PREFIX}_FIND_REQUIRED)
453
84
        foreach (i ${${PREFIX}_PROCESS_INCLUDES} ${${PREFIX}_PROCESS_LIBS})
454
85
          message("${i}=${${i}}")
455
86
        endforeach (i)
456
87
        message (FATAL_ERROR "Required library ${PREFIX} NOT FOUND.\nInstall the library (dev version) and try again. If the library is already installed, use ccmake to set the missing variables manually.")
457
88
      endif (${PREFIX}_FIND_REQUIRED)
458
89
    endif (${PREFIX}_FOUND)
459
90
  endif (NOT ${PREFIX}_FOUND)
460
91
endmacro (libfind_process)
461
92
462
93
macro(libfind_library PREFIX basename)
463
94
  set(TMP "")
464
95
  if(MSVC80)
465
96
    set(TMP -vc80)
466
97
  endif(MSVC80)
467
98
  if(MSVC90)
468
99
    set(TMP -vc90)
469
100
  endif(MSVC90)
470
101
  set(${PREFIX}_LIBNAMES ${basename}${TMP})
471
102
  if(${ARGC} GREATER 2)
472
103
    set(${PREFIX}_LIBNAMES ${basename}${TMP}-${ARGV2})
473
104
    string(REGEX REPLACE "\\." "_" TMP ${${PREFIX}_LIBNAMES})
474
105
    set(${PREFIX}_LIBNAMES ${${PREFIX}_LIBNAMES} ${TMP})
475
106
  endif(${ARGC} GREATER 2)
476
107
  find_library(${PREFIX}_LIBRARY
477
108
    NAMES ${${PREFIX}_LIBNAMES}
478
109
    PATHS ${${PREFIX}_PKGCONF_LIBRARY_DIRS}
479
110
  )
480
111
endmacro(libfind_library)
481
112
482
0
113
483
=== added file 'examples/mfw-plugin-dummy/cmake/ParseArguments.cmake'
484
--- examples/mfw-plugin-dummy/cmake/ParseArguments.cmake	1970-01-01 00:00:00 +0000
485
+++ examples/mfw-plugin-dummy/cmake/ParseArguments.cmake	2017-03-22 21:22:50 +0000
486
@@ -0,0 +1,52 @@
487
1
# Parse arguments passed to a function into several lists separated by
488
2
# upper-case identifiers and options that do not have an associated list e.g.:
489
3
#
490
4
# SET(arguments
491
5
#   hello OPTION3 world
492
6
#   LIST3 foo bar
493
7
#   OPTION2
494
8
#   LIST1 fuz baz
495
9
#   )
496
10
# PARSE_ARGUMENTS(ARG "LIST1;LIST2;LIST3" "OPTION1;OPTION2;OPTION3" ${arguments})
497
11
#
498
12
# results in 7 distinct variables:
499
13
#  * ARG_DEFAULT_ARGS: hello;world
500
14
#  * ARG_LIST1: fuz;baz
501
15
#  * ARG_LIST2:
502
16
#  * ARG_LIST3: foo;bar
503
17
#  * ARG_OPTION1: FALSE
504
18
#  * ARG_OPTION2: TRUE
505
19
#  * ARG_OPTION3: TRUE
506
20
#
507
21
# taken from http://www.cmake.org/Wiki/CMakeMacroParseArguments 
508
22
509
23
MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
510
24
    SET(DEFAULT_ARGS)
511
25
    FOREACH(arg_name ${arg_names})    
512
26
        SET(${prefix}_${arg_name})
513
27
    ENDFOREACH(arg_name)
514
28
    FOREACH(option ${option_names})
515
29
        SET(${prefix}_${option} FALSE)
516
30
    ENDFOREACH(option)
517
31
    
518
32
    SET(current_arg_name DEFAULT_ARGS)
519
33
    SET(current_arg_list)
520
34
    FOREACH(arg ${ARGN})            
521
35
        SET(larg_names ${arg_names})    
522
36
        LIST(FIND larg_names "${arg}" is_arg_name)                   
523
37
        IF (is_arg_name GREATER -1)
524
38
            SET(${prefix}_${current_arg_name} ${current_arg_list})
525
39
            SET(current_arg_name ${arg})
526
40
            SET(current_arg_list)
527
41
        ELSE (is_arg_name GREATER -1)
528
42
            SET(loption_names ${option_names})    
529
43
            LIST(FIND loption_names "${arg}" is_option)            
530
44
            IF (is_option GREATER -1)
531
45
                SET(${prefix}_${arg} TRUE)
532
46
            ELSE (is_option GREATER -1)
533
47
                SET(current_arg_list ${current_arg_list} ${arg})
534
48
            ENDIF (is_option GREATER -1)
535
49
        ENDIF (is_arg_name GREATER -1)
536
50
    ENDFOREACH(arg)
537
51
    SET(${prefix}_${current_arg_name} ${current_arg_list})
538
52
ENDMACRO(PARSE_ARGUMENTS)
539
0
53
540
=== added directory 'examples/mfw-plugin-dummy/data'
541
=== added file 'examples/mfw-plugin-dummy/data/CMakeLists.txt'
542
--- examples/mfw-plugin-dummy/data/CMakeLists.txt	1970-01-01 00:00:00 +0000
543
+++ examples/mfw-plugin-dummy/data/CMakeLists.txt	2017-03-22 21:22:50 +0000
544
@@ -0,0 +1,63 @@
545
1
if (NOT IS_MF_BUILD)
546
2
    # glob files to be shown in qt-creator
547
3
    file(GLOB MANAGER_FILES *.manager)
548
4
    file(GLOB SERVICE_FILES *.service)
549
5
    file(GLOB PNG_FILES *.png)
550
6
    add_custom_target(manager_files_plugin ALL SOURCES ${MANAGER_FILES})
551
7
    add_custom_target(service_files_plugin ALL SOURCES ${SERVICE_FILES})
552
8
    add_custom_target(png_files_plugin ALL SOURCES ${PNG_FILES})
553
9
    add_custom_target(schema_files_plugin ALL SOURCES ${SCHEMA_FILES})
554
10
    add_custom_target(info_files_plugin ALL SOURCES ${INFO_FILES})
555
11
556
12
    # uninstall target
557
13
    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
558
14
                   "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
559
15
                   IMMEDIATE @ONLY)
560
16
    add_custom_target(uninstall "${CMAKE_COMMAND}"
561
17
                      -P "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake")
562
18
563
19
endif()
564
20
565
21
###########################################
566
22
# Messaging-fw data and configuration files
567
23
###########################################
568
24
569
25
# Compose the pkg-config file needed to find the library using that tool
570
26
set(PREFIX "${CMAKE_INSTALL_PREFIX}") # /usr
571
27
set(LIBDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") # /usr/lib
572
28
set(INCLUDEDIR "${CMAKE_INSTALL_PREFIX}/include") # /usr/include
573
29
574
30
#############################################
575
31
# Dummy plugin data and configuration files
576
32
#############################################
577
33
578
34
set(CM dummy)
579
35
set(PROTOCOL dummy)
580
36
# DUMMY_DATADIR is used in dummy.protocol.in
581
37
set(DUMMY_DATADIR ${CMAKE_INSTALL_DATADIR}/${CM})
582
38
583
39
configure_file(
584
40
    ${CM}.service.in
585
41
    org.freedesktop.Telepathy.ConnectionManager.${CM}.service
586
42
)
587
43
configure_file(
588
44
    ${PROTOCOL}.protocol.in
589
45
    ${PROTOCOL}.protocol)
590
46
591
47
configure_file(
592
48
    ${CM}.manager.in
593
49
    ${CM}.manager)
594
50
595
51
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/org.freedesktop.Telepathy.ConnectionManager.${CM}.service
596
52
    DESTINATION share/dbus-1/services)
597
53
598
54
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROTOCOL}.protocol
599
55
    DESTINATION share/telephony-service/protocols)
600
56
601
57
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${CM}.manager
602
58
    DESTINATION share/telepathy/managers)
603
59
604
60
# background and protocol icons to be displayed in the UI
605
61
install(FILES dummy-background.png dummy.png
606
62
    DESTINATION ${DUMMY_DATADIR}/assets)
607
63
608
0
64
609
=== added file 'examples/mfw-plugin-dummy/data/cmake_uninstall.cmake.in'
610
--- examples/mfw-plugin-dummy/data/cmake_uninstall.cmake.in	1970-01-01 00:00:00 +0000
611
+++ examples/mfw-plugin-dummy/data/cmake_uninstall.cmake.in	2017-03-22 21:22:50 +0000
612
@@ -0,0 +1,22 @@
613
1
IF(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")
614
2
    MESSAGE(FATAL_ERROR "Cannot find install manifest: \"@CMAKE_BINARY_DIR@/install_manifest.txt\"")
615
3
ENDIF(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")
616
4
617
5
FILE(READ "@CMAKE_BINARY_DIR@/install_manifest.txt" files)
618
6
STRING(REGEX REPLACE "\n" ";" files "${files}")
619
7
FOREACH(file ${files})
620
8
    MESSAGE(STATUS "Uninstalling \"$ENV{DESTDIR}${file}\"")
621
9
    IF(EXISTS "$ENV{DESTDIR}${file}")
622
10
        EXEC_PROGRAM(
623
11
            "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
624
12
            OUTPUT_VARIABLE rm_out
625
13
            RETURN_VALUE rm_retval
626
14
        )
627
15
        IF(NOT "${rm_retval}" STREQUAL 0)
628
16
            MESSAGE(FATAL_ERROR "Problem when removing \"$ENV{DESTDIR}${file}\"")
629
17
        ENDIF(NOT "${rm_retval}" STREQUAL 0)
630
18
    ELSE(EXISTS "$ENV{DESTDIR}${file}")
631
19
        MESSAGE(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.")
632
20
    ENDIF(EXISTS "$ENV{DESTDIR}${file}")
633
21
ENDFOREACH(file)
634
22
635
0
23
636
=== added file 'examples/mfw-plugin-dummy/data/dummy-background.png'
637
1
Binary files examples/mfw-plugin-dummy/data/dummy-background.png	1970-01-01 00:00:00 +0000 and examples/mfw-plugin-dummy/data/dummy-background.png	2017-03-22 21:22:50 +0000 differ
24
Binary files examples/mfw-plugin-dummy/data/dummy-background.png	1970-01-01 00:00:00 +0000 and examples/mfw-plugin-dummy/data/dummy-background.png	2017-03-22 21:22:50 +0000 differ
638
=== added file 'examples/mfw-plugin-dummy/data/dummy.manager.in'
639
--- examples/mfw-plugin-dummy/data/dummy.manager.in	1970-01-01 00:00:00 +0000
640
+++ examples/mfw-plugin-dummy/data/dummy.manager.in	2017-03-22 21:22:50 +0000
641
@@ -0,0 +1,10 @@
642
1
[ConnectionManager]
643
2
Name = @CM@
644
3
BusName = org.freedesktop.Telepathy.ConnectionManager.@CM@
645
4
ObjectPath = /org/freedesktop/Telepathy/ConnectionManager/@CM@
646
5
647
6
[Protocol @PROTOCOL@]
648
7
param-account=s required register
649
8
param-password=s secret
650
9
Interfaces=org.freedesktop.Telepathy.Protocol.Interface.Addressing;
651
10
ConnectionInterfaces=org.freedesktop.Telepathy.Connection.Interface.Requests;org.freedesktop.Telepathy.Connection.Interface.Contacts;org.freedesktop.Telepathy.Connection.Interface.SimplePresence;
652
0
11
653
=== added file 'examples/mfw-plugin-dummy/data/dummy.png'
654
1
Binary files examples/mfw-plugin-dummy/data/dummy.png	1970-01-01 00:00:00 +0000 and examples/mfw-plugin-dummy/data/dummy.png	2017-03-22 21:22:50 +0000 differ
12
Binary files examples/mfw-plugin-dummy/data/dummy.png	1970-01-01 00:00:00 +0000 and examples/mfw-plugin-dummy/data/dummy.png	2017-03-22 21:22:50 +0000 differ
655
=== added file 'examples/mfw-plugin-dummy/data/dummy.protocol.in'
656
--- examples/mfw-plugin-dummy/data/dummy.protocol.in	1970-01-01 00:00:00 +0000
657
+++ examples/mfw-plugin-dummy/data/dummy.protocol.in	2017-03-22 21:22:50 +0000
658
@@ -0,0 +1,16 @@
659
1
[Protocol]
660
2
Name=@PROTOCOL@
661
3
Features=text
662
4
FallbackProtocol=
663
5
BackgroundImage=@CMAKE_INSTALL_PREFIX@/@DUMMY_DATADIR@/assets/dummy-background.png
664
6
Icon=@CMAKE_INSTALL_PREFIX@/@DUMMY_DATADIR@/assets/dummy.png
665
7
ServiceName=Dummy
666
8
ServiceDisplayName=Dummy
667
9
ShowOnSelector=1
668
10
ShowOnlineStatus=0
669
11
JoinExistingChannels=1
670
12
ReturnToSend=1
671
13
EnableAttachments=0
672
14
EnableRejoin=1
673
15
EnableTabCompletion=1
674
16
LeaveRoomsOnClose=1
675
0
17
676
=== added file 'examples/mfw-plugin-dummy/data/dummy.service.in'
677
--- examples/mfw-plugin-dummy/data/dummy.service.in	1970-01-01 00:00:00 +0000
678
+++ examples/mfw-plugin-dummy/data/dummy.service.in	2017-03-22 21:22:50 +0000
679
@@ -0,0 +1,3 @@
680
1
[D-BUS Service]
681
2
Name=org.freedesktop.Telepathy.ConnectionManager.@CM@
682
3
Exec=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@/messaging-framework-runner --connection-manager-name @CM@ --protocol-name @PROTOCOL@ --connector messaging::PluginConnector --PluginConnector::path=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@/messaging-framework/libmfw-plugin-@CM@.so
683
0
4
684
=== added directory 'examples/mfw-plugin-dummy/debian'
685
=== added file 'examples/mfw-plugin-dummy/debian/changelog'
686
--- examples/mfw-plugin-dummy/debian/changelog	1970-01-01 00:00:00 +0000
687
+++ examples/mfw-plugin-dummy/debian/changelog	2017-03-22 21:22:50 +0000
688
@@ -0,0 +1,5 @@
689
1
mfw-plugin-dummy (0.1) xenial; urgency=medium
690
2
691
3
  * Initial release
692
4
693
5
 -- Developer Of Dummy Protocol <developer@dummyprotocol.com>  Mon, 05 Dec 2016 10:50:40 -0200
694
0
6
695
=== added file 'examples/mfw-plugin-dummy/debian/compat'
696
--- examples/mfw-plugin-dummy/debian/compat	1970-01-01 00:00:00 +0000
697
+++ examples/mfw-plugin-dummy/debian/compat	2017-03-22 21:22:50 +0000
698
@@ -0,0 +1,1 @@
699
1
9
700
0
2
701
=== added file 'examples/mfw-plugin-dummy/debian/control'
702
--- examples/mfw-plugin-dummy/debian/control	1970-01-01 00:00:00 +0000
703
+++ examples/mfw-plugin-dummy/debian/control	2017-03-22 21:22:50 +0000
704
@@ -0,0 +1,31 @@
705
1
Source: mfw-plugin-dummy
706
2
Priority: optional
707
3
Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
708
4
Build-Depends: cmake,
709
5
               debhelper (>= 9),
710
6
               doxygen,
711
7
               gcovr,
712
8
               google-mock,
713
9
               lcov,
714
10
               libboost-dev,
715
11
               libboost-filesystem-dev,
716
12
               libboost-program-options-dev,
717
13
               libboost-system-dev,
718
14
               libdbus-cpp-dev,
719
15
               libgoogle-glog-dev,
720
16
               libmessaging-framework-dev,
721
17
               libprocess-cpp-dev,
722
18
	       libtelepathy-qt5-dev,
723
19
               pkg-config,
724
20
               qtbase5-dev,
725
21
	       libcppnetlib-dev,
726
22
Standards-Version: 3.9.5
727
23
Section: libs
728
24
Homepage: https://launchpad.net/mfw-plugin-dummy
729
25
Vcs-Bzr: https://code.launchpad.net/
730
26
731
27
Package: mfw-plugin-dummy
732
28
Architecture: any
733
29
Depends: ${misc:Depends}, ${shlibs:Depends}
734
30
Description: Ubuntu Messaging Framework Dummy Plugin
735
31
 A plugin for messaging fw implementing Dummy protocol
736
0
32
737
=== added file 'examples/mfw-plugin-dummy/debian/copyright'
738
--- examples/mfw-plugin-dummy/debian/copyright	1970-01-01 00:00:00 +0000
739
+++ examples/mfw-plugin-dummy/debian/copyright	2017-03-22 21:22:50 +0000
740
@@ -0,0 +1,22 @@
741
1
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
742
2
Upstream-Name: mfw-plugin-dummy
743
3
Source: https://launchpad.net/mfw-plugin-dummy
744
4
745
5
Files: *
746
6
Copyright: 2016 Canonical Ltd.
747
7
License: LGPL-3.0
748
8
 This package is free software; you can redistribute it and/or
749
9
 modify it under the terms of the GNU Lesser General Public
750
10
 License as published by the Free Software Foundation, version 3 of
751
11
 the License.
752
12
 .
753
13
 This package is distributed in the hope that it will be useful,
754
14
 but WITHOUT ANY WARRANTY; without even the implied warranty of
755
15
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
756
16
 Lesser General Public License for more details.
757
17
 .
758
18
 You should have received a copy of the GNU General Public License
759
19
 along with this program. If not, see <http://www.gnu.org/licenses/>.
760
20
 .
761
21
 On Debian systems, the complete text of the GNU Lesser General
762
22
 Public License can be found in /usr/share/common-licenses/LGPL-3.
763
0
23
764
=== added file 'examples/mfw-plugin-dummy/debian/rules'
765
--- examples/mfw-plugin-dummy/debian/rules	1970-01-01 00:00:00 +0000
766
+++ examples/mfw-plugin-dummy/debian/rules	2017-03-22 21:22:50 +0000
767
@@ -0,0 +1,19 @@
768
1
#!/usr/bin/make -f
769
2
# -*- makefile -*-
770
3
771
4
export DPKG_GENSYMBOLS_CHECK_LEVEL=4
772
5
773
6
include /usr/share/dpkg/default.mk
774
7
775
8
BUILDHOME=$(CURDIR)/debian/build
776
9
777
10
%:
778
11
	dh $@ --fail-missing
779
12
780
13
override_dh_clean:
781
14
	dh_clean
782
15
	rm -rf $(BUILDHOME)
783
16
784
17
override_dh_auto_test:
785
18
	mkdir -p $(BUILDHOME)
786
19
	HOME=$(BUILDHOME) dh_auto_test
787
0
20
788
=== added directory 'examples/mfw-plugin-dummy/debian/source'
789
=== added file 'examples/mfw-plugin-dummy/debian/source/format'
790
--- examples/mfw-plugin-dummy/debian/source/format	1970-01-01 00:00:00 +0000
791
+++ examples/mfw-plugin-dummy/debian/source/format	2017-03-22 21:22:50 +0000
792
@@ -0,0 +1,1 @@
793
1
3.0 (native)
794
0
2
795
=== added directory 'examples/mfw-plugin-dummy/doc'
796
=== added file 'examples/mfw-plugin-dummy/doc/CMakeLists.txt'
797
--- examples/mfw-plugin-dummy/doc/CMakeLists.txt	1970-01-01 00:00:00 +0000
798
+++ examples/mfw-plugin-dummy/doc/CMakeLists.txt	2017-03-22 21:22:50 +0000
799
@@ -0,0 +1,21 @@
800
1
option(
801
2
  ENABLE_DOC_GENERATION
802
3
  "Generate package documentation with doxygen"
803
4
  OFF
804
5
)
805
6
806
7
if (ENABLE_DOC_GENERATION)
807
8
808
9
find_package(Doxygen)
809
10
810
11
if (DOXYGEN_FOUND)
811
12
  configure_file(
812
13
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in 
813
14
    ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
814
15
  add_custom_target(doc ALL
815
16
    ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
816
17
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
817
18
    COMMENT "Generating API documentation with Doxygen" VERBATIM)
818
19
819
20
endif (DOXYGEN_FOUND)
820
21
endif (ENABLE_DOC_GENERATION)
821
0
22
822
=== added file 'examples/mfw-plugin-dummy/doc/Doxyfile.in'
823
--- examples/mfw-plugin-dummy/doc/Doxyfile.in	1970-01-01 00:00:00 +0000
824
+++ examples/mfw-plugin-dummy/doc/Doxyfile.in	2017-03-22 21:22:50 +0000
825
@@ -0,0 +1,1869 @@
826
1
# Doxyfile 1.8.3.1
827
2
828
3
# This file describes the settings to be used by the documentation system
829
4
# doxygen (www.doxygen.org) for a project.
830
5
#
831
6
# All text after a hash (#) is considered a comment and will be ignored.
832
7
# The format is:
833
8
#       TAG = value [value, ...]
834
9
# For lists items can also be appended using:
835
10
#       TAG += value [value, ...]
836
11
# Values that contain spaces should be placed between quotes (" ").
837
12
838
13
#---------------------------------------------------------------------------
839
14
# Project related configuration options
840
15
#---------------------------------------------------------------------------
841
16
842
17
# This tag specifies the encoding used for all characters in the config file
843
18
# that follow. The default is UTF-8 which is also the encoding used for all
844
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
845
20
# iconv built into libc) for the transcoding. See
846
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
847
22
848
23
DOXYFILE_ENCODING      = UTF-8
849
24
850
25
# The PROJECT_NAME tag is a single word (or sequence of words) that should
851
26
# identify the project. Note that if you do not use Doxywizard you need
852
27
# to put quotes around the project name if it contains spaces.
853
28
854
29
PROJECT_NAME           = @CMAKE_PROJECT_NAME@
855
30
856
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
857
32
# This could be handy for archiving the generated documentation or
858
33
# if some version control system is used.
859
34
860
35
PROJECT_NUMBER         = @SO_VERSION_MAJOR@.@SO_VERSION_MINOR@.@SO_VERSION_PATCH@
861
36
862
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
863
38
# for a project that appears at the top of each page and should give viewer
864
39
# a quick idea about the purpose of the project. Keep the description short.
865
40
866
41
PROJECT_BRIEF          = "Messaging framework backend enabling Dummy Protocol on Ubuntu phones"
867
42
868
43
# With the PROJECT_LOGO tag one can specify an logo or icon that is
869
44
# included in the documentation. The maximum height of the logo should not
870
45
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
871
46
# Doxygen will copy the logo to the output directory.
872
47
873
48
PROJECT_LOGO           =
874
49
875
50
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
876
51
# base path where the generated documentation will be put.
877
52
# If a relative path is entered, it will be relative to the location
878
53
# where doxygen was started. If left blank the current directory will be used.
879
54
880
55
OUTPUT_DIRECTORY       =
881
56
882
57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
883
58
# 4096 sub-directories (in 2 levels) under the output directory of each output
884
59
# format and will distribute the generated files over these directories.
885
60
# Enabling this option can be useful when feeding doxygen a huge amount of
886
61
# source files, where putting all generated files in the same directory would
887
62
# otherwise cause performance problems for the file system.
888
63
889
64
CREATE_SUBDIRS         = NO
890
65
891
66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
892
67
# documentation generated by doxygen is written. Doxygen will use this
893
68
# information to generate all constant output in the proper language.
894
69
# The default language is English, other supported languages are:
895
70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
896
71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
897
72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
898
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
899
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
900
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
901
76
902
77
OUTPUT_LANGUAGE        = English
903
78
904
79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
905
80
# include brief member descriptions after the members that are listed in
906
81
# the file and class documentation (similar to JavaDoc).
907
82
# Set to NO to disable this.
908
83
909
84
BRIEF_MEMBER_DESC      = YES
910
85
911
86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
912
87
# the brief description of a member or function before the detailed description.
913
88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
914
89
# brief descriptions will be completely suppressed.
915
90
916
91
REPEAT_BRIEF           = YES
917
92
918
93
# This tag implements a quasi-intelligent brief description abbreviator
919
94
# that is used to form the text in various listings. Each string
920
95
# in this list, if found as the leading text of the brief description, will be
921
96
# stripped from the text and the result after processing the whole list, is
922
97
# used as the annotated text. Otherwise, the brief description is used as-is.
923
98
# If left blank, the following values are used ("$name" is automatically
924
99
# replaced with the name of the entity): "The $name class" "The $name widget"
925
100
# "The $name file" "is" "provides" "specifies" "contains"
926
101
# "represents" "a" "an" "the"
927
102
928
103
ABBREVIATE_BRIEF       =
929
104
930
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
931
106
# Doxygen will generate a detailed section even if there is only a brief
932
107
# description.
933
108
934
109
ALWAYS_DETAILED_SEC    = NO
935
110
936
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
937
112
# inherited members of a class in the documentation of that class as if those
938
113
# members were ordinary class members. Constructors, destructors and assignment
939
114
# operators of the base classes will not be shown.
940
115
941
116
INLINE_INHERITED_MEMB  = NO
942
117
943
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
944
119
# path before files name in the file list and in the header files. If set
945
120
# to NO the shortest path that makes the file name unique will be used.
946
121
947
122
FULL_PATH_NAMES        = YES
948
123
949
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
950
125
# can be used to strip a user-defined part of the path. Stripping is
951
126
# only done if one of the specified strings matches the left-hand part of
952
127
# the path. The tag can be used to show relative paths in the file list.
953
128
# If left blank the directory from which doxygen is run is used as the
954
129
# path to strip. Note that you specify absolute paths here, but also
955
130
# relative paths, which will be relative from the directory where doxygen is
956
131
# started.
957
132
958
133
STRIP_FROM_PATH        =
959
134
960
135
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
961
136
# the path mentioned in the documentation of a class, which tells
962
137
# the reader which header file to include in order to use a class.
963
138
# If left blank only the name of the header file containing the class
964
139
# definition is used. Otherwise one should specify the include paths that
965
140
# are normally passed to the compiler using the -I flag.
966
141
967
142
STRIP_FROM_INC_PATH    =
968
143
969
144
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
970
145
# (but less readable) file names. This can be useful if your file system
971
146
# doesn't support long names like on DOS, Mac, or CD-ROM.
972
147
973
148
SHORT_NAMES            = NO
974
149
975
150
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
976
151
# will interpret the first line (until the first dot) of a JavaDoc-style
977
152
# comment as the brief description. If set to NO, the JavaDoc
978
153
# comments will behave just like regular Qt-style comments
979
154
# (thus requiring an explicit @brief command for a brief description.)
980
155
981
156
JAVADOC_AUTOBRIEF      = NO
982
157
983
158
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
984
159
# interpret the first line (until the first dot) of a Qt-style
985
160
# comment as the brief description. If set to NO, the comments
986
161
# will behave just like regular Qt-style comments (thus requiring
987
162
# an explicit \brief command for a brief description.)
988
163
989
164
QT_AUTOBRIEF           = NO
990
165
991
166
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
992
167
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
993
168
# comments) as a brief description. This used to be the default behaviour.
994
169
# The new default is to treat a multi-line C++ comment block as a detailed
995
170
# description. Set this tag to YES if you prefer the old behaviour instead.
996
171
997
172
MULTILINE_CPP_IS_BRIEF = NO
998
173
999
174
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1000
175
# member inherits the documentation from any documented member that it
1001
176
# re-implements.
1002
177
1003
178
INHERIT_DOCS           = YES
1004
179
1005
180
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
1006
181
# a new page for each member. If set to NO, the documentation of a member will
1007
182
# be part of the file/class/namespace that contains it.
1008
183
1009
184
SEPARATE_MEMBER_PAGES  = NO
1010
185
1011
186
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1012
187
# Doxygen uses this value to replace tabs by spaces in code fragments.
1013
188
1014
189
TAB_SIZE               = 4
1015
190
1016
191
# This tag can be used to specify a number of aliases that acts
1017
192
# as commands in the documentation. An alias has the form "name=value".
1018
193
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1019
194
# put the command \sideeffect (or @sideeffect) in the documentation, which
1020
195
# will result in a user-defined paragraph with heading "Side Effects:".
1021
196
# You can put \n's in the value part of an alias to insert newlines.
1022
197
1023
198
ALIASES                =
1024
199
1025
200
# This tag can be used to specify a number of word-keyword mappings (TCL only).
1026
201
# A mapping has the form "name=value". For example adding
1027
202
# "class=itcl::class" will allow you to use the command class in the
1028
203
# itcl::class meaning.
1029
204
1030
205
TCL_SUBST              =
1031
206
1032
207
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
1033
208
# sources only. Doxygen will then generate output that is more tailored for C.
1034
209
# For instance, some of the names that are used will be different. The list
1035
210
# of all members will be omitted, etc.
1036
211
1037
212
OPTIMIZE_OUTPUT_FOR_C  = NO
1038
213
1039
214
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
1040
215
# sources only. Doxygen will then generate output that is more tailored for
1041
216
# Java. For instance, namespaces will be presented as packages, qualified
1042
217
# scopes will look different, etc.
1043
218
1044
219
OPTIMIZE_OUTPUT_JAVA   = NO
1045
220
1046
221
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1047
222
# sources only. Doxygen will then generate output that is more tailored for
1048
223
# Fortran.
1049
224
1050
225
OPTIMIZE_FOR_FORTRAN   = NO
1051
226
1052
227
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
1053
228
# sources. Doxygen will then generate output that is tailored for
1054
229
# VHDL.
1055
230
1056
231
OPTIMIZE_OUTPUT_VHDL   = NO
1057
232
1058
233
# Doxygen selects the parser to use depending on the extension of the files it
1059
234
# parses. With this tag you can assign which parser to use for a given
1060
235
# extension. Doxygen has a built-in mapping, but you can override or extend it
1061
236
# using this tag. The format is ext=language, where ext is a file extension,
1062
237
# and language is one of the parsers supported by doxygen: IDL, Java,
1063
238
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
1064
239
# C++. For instance to make doxygen treat .inc files as Fortran files (default
1065
240
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
1066
241
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
1067
242
# files are not read by doxygen.
1068
243
1069
244
EXTENSION_MAPPING      =
1070
245
1071
246
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
1072
247
# comments according to the Markdown format, which allows for more readable
1073
248
# documentation. See http://daringfireball.net/projects/markdown/ for details.
1074
249
# The output of markdown processing is further processed by doxygen, so you
1075
250
# can mix doxygen, HTML, and XML commands with Markdown formatting.
1076
251
# Disable only in case of backward compatibilities issues.
1077
252
1078
253
MARKDOWN_SUPPORT       = YES
1079
254
1080
255
# When enabled doxygen tries to link words that correspond to documented classes,
1081
256
# or namespaces to their corresponding documentation. Such a link can be
1082
257
# prevented in individual cases by by putting a % sign in front of the word or
1083
258
# globally by setting AUTOLINK_SUPPORT to NO.
1084
259
1085
260
AUTOLINK_SUPPORT       = YES
1086
261
1087
262
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
1088
263
# to include (a tag file for) the STL sources as input, then you should
1089
264
# set this tag to YES in order to let doxygen match functions declarations and
1090
265
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
1091
266
# func(std::string) {}). This also makes the inheritance and collaboration
1092
267
# diagrams that involve STL classes more complete and accurate.
1093
268
1094
269
BUILTIN_STL_SUPPORT    = YES
1095
270
1096
271
# If you use Microsoft's C++/CLI language, you should set this option to YES to
1097
272
# enable parsing support.
1098
273
1099
274
CPP_CLI_SUPPORT        = NO
1100
275
1101
276
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
1102
277
# Doxygen will parse them like normal C++ but will assume all classes use public
1103
278
# instead of private inheritance when no explicit protection keyword is present.
1104
279
1105
280
SIP_SUPPORT            = NO
1106
281
1107
282
# For Microsoft's IDL there are propget and propput attributes to indicate
1108
283
# getter and setter methods for a property. Setting this option to YES (the
1109
284
# default) will make doxygen replace the get and set methods by a property in
1110
285
# the documentation. This will only work if the methods are indeed getting or
1111
286
# setting a simple type. If this is not the case, or you want to show the
1112
287
# methods anyway, you should set this option to NO.
1113
288
1114
289
IDL_PROPERTY_SUPPORT   = YES
1115
290
1116
291
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1117
292
# tag is set to YES, then doxygen will reuse the documentation of the first
1118
293
# member in the group (if any) for the other members of the group. By default
1119
294
# all members of a group must be documented explicitly.
1120
295
1121
296
DISTRIBUTE_GROUP_DOC   = NO
1122
297
1123
298
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
1124
299
# the same type (for instance a group of public functions) to be put as a
1125
300
# subgroup of that type (e.g. under the Public Functions section). Set it to
1126
301
# NO to prevent subgrouping. Alternatively, this can be done per class using
1127
302
# the \nosubgrouping command.
1128
303
1129
304
SUBGROUPING            = YES
1130
305
1131
306
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
1132
307
# unions are shown inside the group in which they are included (e.g. using
1133
308
# @ingroup) instead of on a separate page (for HTML and Man pages) or
1134
309
# section (for LaTeX and RTF).
1135
310
1136
311
INLINE_GROUPED_CLASSES = NO
1137
312
1138
313
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
1139
314
# unions with only public data fields will be shown inline in the documentation
1140
315
# of the scope in which they are defined (i.e. file, namespace, or group
1141
316
# documentation), provided this scope is documented. If set to NO (the default),
1142
317
# structs, classes, and unions are shown on a separate page (for HTML and Man
1143
318
# pages) or section (for LaTeX and RTF).
1144
319
1145
320
INLINE_SIMPLE_STRUCTS  = NO
1146
321
1147
322
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
1148
323
# is documented as struct, union, or enum with the name of the typedef. So
1149
324
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
1150
325
# with name TypeT. When disabled the typedef will appear as a member of a file,
1151
326
# namespace, or class. And the struct will be named TypeS. This can typically
1152
327
# be useful for C code in case the coding convention dictates that all compound
1153
328
# types are typedef'ed and only the typedef is referenced, never the tag name.
1154
329
1155
330
TYPEDEF_HIDES_STRUCT   = NO
1156
331
1157
332
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
1158
333
# determine which symbols to keep in memory and which to flush to disk.
1159
334
# When the cache is full, less often used symbols will be written to disk.
1160
335
# For small to medium size projects (<1000 input files) the default value is
1161
336
# probably good enough. For larger projects a too small cache size can cause
1162
337
# doxygen to be busy swapping symbols to and from disk most of the time
1163
338
# causing a significant performance penalty.
1164
339
# If the system has enough physical memory increasing the cache will improve the
1165
340
# performance by keeping more symbols in memory. Note that the value works on
1166
341
# a logarithmic scale so increasing the size by one will roughly double the
1167
342
# memory usage. The cache size is given by this formula:
1168
343
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
1169
344
# corresponding to a cache size of 2^16 = 65536 symbols.
1170
345
1171
346
SYMBOL_CACHE_SIZE      = 0
1172
347
1173
348
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
1174
349
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
1175
350
# their name and scope. Since this can be an expensive process and often the
1176
351
# same symbol appear multiple times in the code, doxygen keeps a cache of
1177
352
# pre-resolved symbols. If the cache is too small doxygen will become slower.
1178
353
# If the cache is too large, memory is wasted. The cache size is given by this
1179
354
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
1180
355
# corresponding to a cache size of 2^16 = 65536 symbols.
1181
356
1182
357
LOOKUP_CACHE_SIZE      = 0
1183
358
1184
359
#---------------------------------------------------------------------------
1185
360
# Build related configuration options
1186
361
#---------------------------------------------------------------------------
1187
362
1188
363
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1189
364
# documentation are documented, even if no documentation was available.
1190
365
# Private class members and static file members will be hidden unless
1191
366
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1192
367
1193
368
EXTRACT_ALL            = YES
1194
369
1195
370
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1196
371
# will be included in the documentation.
1197
372
1198
373
EXTRACT_PRIVATE        = NO
1199
374
1200
375
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
1201
376
# scope will be included in the documentation.
1202
377
1203
378
EXTRACT_PACKAGE        = NO
1204
379
1205
380
# If the EXTRACT_STATIC tag is set to YES all static members of a file
1206
381
# will be included in the documentation.
1207
382
1208
383
EXTRACT_STATIC         = NO
1209
384
1210
385
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
1211
386
# defined locally in source files will be included in the documentation.
1212
387
# If set to NO only classes defined in header files are included.
1213
388
1214
389
EXTRACT_LOCAL_CLASSES  = YES
1215
390
1216
391
# This flag is only useful for Objective-C code. When set to YES local
1217
392
# methods, which are defined in the implementation section but not in
1218
393
# the interface are included in the documentation.
1219
394
# If set to NO (the default) only methods in the interface are included.
1220
395
1221
396
EXTRACT_LOCAL_METHODS  = NO
1222
397
1223
398
# If this flag is set to YES, the members of anonymous namespaces will be
1224
399
# extracted and appear in the documentation as a namespace called
1225
400
# 'anonymous_namespace{file}', where file will be replaced with the base
1226
401
# name of the file that contains the anonymous namespace. By default
1227
402
# anonymous namespaces are hidden.
1228
403
1229
404
EXTRACT_ANON_NSPACES   = NO
1230
405
1231
406
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1232
407
# undocumented members of documented classes, files or namespaces.
1233
408
# If set to NO (the default) these members will be included in the
1234
409
# various overviews, but no documentation section is generated.
1235
410
# This option has no effect if EXTRACT_ALL is enabled.
1236
411
1237
412
HIDE_UNDOC_MEMBERS     = NO
1238
413
1239
414
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1240
415
# undocumented classes that are normally visible in the class hierarchy.
1241
416
# If set to NO (the default) these classes will be included in the various
1242
417
# overviews. This option has no effect if EXTRACT_ALL is enabled.
1243
418
1244
419
HIDE_UNDOC_CLASSES     = NO
1245
420
1246
421
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
1247
422
# friend (class|struct|union) declarations.
1248
423
# If set to NO (the default) these declarations will be included in the
1249
424
# documentation.
1250
425
1251
426
HIDE_FRIEND_COMPOUNDS  = NO
1252
427
1253
428
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1254
429
# documentation blocks found inside the body of a function.
1255
430
# If set to NO (the default) these blocks will be appended to the
1256
431
# function's detailed documentation block.
1257
432
1258
433
HIDE_IN_BODY_DOCS      = NO
1259
434
1260
435
# The INTERNAL_DOCS tag determines if documentation
1261
436
# that is typed after a \internal command is included. If the tag is set
1262
437
# to NO (the default) then the documentation will be excluded.
1263
438
# Set it to YES to include the internal documentation.
1264
439
1265
440
INTERNAL_DOCS          = NO
1266
441
1267
442
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1268
443
# file names in lower-case letters. If set to YES upper-case letters are also
1269
444
# allowed. This is useful if you have classes or files whose names only differ
1270
445
# in case and if your file system supports case sensitive file names. Windows
1271
446
# and Mac users are advised to set this option to NO.
1272
447
1273
448
CASE_SENSE_NAMES       = YES
1274
449
1275
450
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1276
451
# will show members with their full class and namespace scopes in the
1277
452
# documentation. If set to YES the scope will be hidden.
1278
453
1279
454
HIDE_SCOPE_NAMES       = NO
1280
455
1281
456
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1282
457
# will put a list of the files that are included by a file in the documentation
1283
458
# of that file.
1284
459
1285
460
SHOW_INCLUDE_FILES     = YES
1286
461
1287
462
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
1288
463
# will list include files with double quotes in the documentation
1289
464
# rather than with sharp brackets.
1290
465
1291
466
FORCE_LOCAL_INCLUDES   = NO
1292
467
1293
468
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1294
469
# is inserted in the documentation for inline members.
1295
470
1296
471
INLINE_INFO            = YES
1297
472
1298
473
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1299
474
# will sort the (detailed) documentation of file and class members
1300
475
# alphabetically by member name. If set to NO the members will appear in
1301
476
# declaration order.
1302
477
1303
478
SORT_MEMBER_DOCS       = YES
1304
479
1305
480
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
1306
481
# brief documentation of file, namespace and class members alphabetically
1307
482
# by member name. If set to NO (the default) the members will appear in
1308
483
# declaration order.
1309
484
1310
485
SORT_BRIEF_DOCS        = NO
1311
486
1312
487
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
1313
488
# will sort the (brief and detailed) documentation of class members so that
1314
489
# constructors and destructors are listed first. If set to NO (the default)
1315
490
# the constructors will appear in the respective orders defined by
1316
491
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
1317
492
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
1318
493
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
1319
494
1320
495
SORT_MEMBERS_CTORS_1ST = NO
1321
496
1322
497
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
1323
498
# hierarchy of group names into alphabetical order. If set to NO (the default)
1324
499
# the group names will appear in their defined order.
1325
500
1326
501
SORT_GROUP_NAMES       = NO
1327
502
1328
503
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1329
504
# sorted by fully-qualified names, including namespaces. If set to
1330
505
# NO (the default), the class list will be sorted only by class name,
1331
506
# not including the namespace part.
1332
507
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1333
508
# Note: This option applies only to the class list, not to the
1334
509
# alphabetical list.
1335
510
1336
511
SORT_BY_SCOPE_NAME     = NO
1337
512
1338
513
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
1339
514
# do proper type resolution of all parameters of a function it will reject a
1340
515
# match between the prototype and the implementation of a member function even
1341
516
# if there is only one candidate or it is obvious which candidate to choose
1342
517
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
1343
518
# will still accept a match between prototype and implementation in such cases.
1344
519
1345
520
STRICT_PROTO_MATCHING  = NO
1346
521
1347
522
# The GENERATE_TODOLIST tag can be used to enable (YES) or
1348
523
# disable (NO) the todo list. This list is created by putting \todo
1349
524
# commands in the documentation.
1350
525
1351
526
GENERATE_TODOLIST      = YES
1352
527
1353
528
# The GENERATE_TESTLIST tag can be used to enable (YES) or
1354
529
# disable (NO) the test list. This list is created by putting \test
1355
530
# commands in the documentation.
1356
531
1357
532
GENERATE_TESTLIST      = YES
1358
533
1359
534
# The GENERATE_BUGLIST tag can be used to enable (YES) or
1360
535
# disable (NO) the bug list. This list is created by putting \bug
1361
536
# commands in the documentation.
1362
537
1363
538
GENERATE_BUGLIST       = YES
1364
539
1365
540
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
1366
541
# disable (NO) the deprecated list. This list is created by putting
1367
542
# \deprecated commands in the documentation.
1368
543
1369
544
GENERATE_DEPRECATEDLIST= YES
1370
545
1371
546
# The ENABLED_SECTIONS tag can be used to enable conditional
1372
547
# documentation sections, marked by \if section-label ... \endif
1373
548
# and \cond section-label ... \endcond blocks.
1374
549
1375
550
ENABLED_SECTIONS       =
1376
551
1377
552
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1378
553
# the initial value of a variable or macro consists of for it to appear in
1379
554
# the documentation. If the initializer consists of more lines than specified
1380
555
# here it will be hidden. Use a value of 0 to hide initializers completely.
1381
556
# The appearance of the initializer of individual variables and macros in the
1382
557
# documentation can be controlled using \showinitializer or \hideinitializer
1383
558
# command in the documentation regardless of this setting.
1384
559
1385
560
MAX_INITIALIZER_LINES  = 30
1386
561
1387
562
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1388
563
# at the bottom of the documentation of classes and structs. If set to YES the
1389
564
# list will mention the files that were used to generate the documentation.
1390
565
1391
566
SHOW_USED_FILES        = YES
1392
567
1393
568
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
1394
569
# This will remove the Files entry from the Quick Index and from the
1395
570
# Folder Tree View (if specified). The default is YES.
1396
571
1397
572
SHOW_FILES             = YES
1398
573
1399
574
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
1400
575
# Namespaces page.
1401
576
# This will remove the Namespaces entry from the Quick Index
1402
577
# and from the Folder Tree View (if specified). The default is YES.
1403
578
1404
579
SHOW_NAMESPACES        = YES
1405
580
1406
581
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1407
582
# doxygen should invoke to get the current version for each file (typically from
1408
583
# the version control system). Doxygen will invoke the program by executing (via
1409
584
# popen()) the command <command> <input-file>, where <command> is the value of
1410
585
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
1411
586
# provided by doxygen. Whatever the program writes to standard output
1412
587
# is used as the file version. See the manual for examples.
1413
588
1414
589
FILE_VERSION_FILTER    =
1415
590
1416
591
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
1417
592
# by doxygen. The layout file controls the global structure of the generated
1418
593
# output files in an output format independent way. To create the layout file
1419
594
# that represents doxygen's defaults, run doxygen with the -l option.
1420
595
# You can optionally specify a file name after the option, if omitted
1421
596
# DoxygenLayout.xml will be used as the name of the layout file.
1422
597
1423
598
LAYOUT_FILE            =
1424
599
1425
600
# The CITE_BIB_FILES tag can be used to specify one or more bib files
1426
601
# containing the references data. This must be a list of .bib files. The
1427
602
# .bib extension is automatically appended if omitted. Using this command
1428
603
# requires the bibtex tool to be installed. See also
1429
604
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
1430
605
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
1431
606
# feature you need bibtex and perl available in the search path. Do not use
1432
607
# file names with spaces, bibtex cannot handle them.
1433
608
1434
609
CITE_BIB_FILES         =
1435
610
1436
611
#---------------------------------------------------------------------------
1437
612
# configuration options related to warning and progress messages
1438
613
#---------------------------------------------------------------------------
1439
614
1440
615
# The QUIET tag can be used to turn on/off the messages that are generated
1441
616
# by doxygen. Possible values are YES and NO. If left blank NO is used.
1442
617
1443
618
QUIET                  = NO
1444
619
1445
620
# The WARNINGS tag can be used to turn on/off the warning messages that are
1446
621
# generated by doxygen. Possible values are YES and NO. If left blank
1447
622
# NO is used.
1448
623
1449
624
WARNINGS               = YES
1450
625
1451
626
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1452
627
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1453
628
# automatically be disabled.
1454
629
1455
630
WARN_IF_UNDOCUMENTED   = YES
1456
631
1457
632
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
1458
633
# potential errors in the documentation, such as not documenting some
1459
634
# parameters in a documented function, or documenting parameters that
1460
635
# don't exist or using markup commands wrongly.
1461
636
1462
637
WARN_IF_DOC_ERROR      = YES
1463
638
1464
639
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
1465
640
# functions that are documented, but have no documentation for their parameters
1466
641
# or return value. If set to NO (the default) doxygen will only warn about
1467
642
# wrong or incomplete parameter documentation, but not about the absence of
1468
643
# documentation.
1469
644
1470
645
WARN_NO_PARAMDOC       = NO
1471
646
1472
647
# The WARN_FORMAT tag determines the format of the warning messages that
1473
648
# doxygen can produce. The string should contain the $file, $line, and $text
1474
649
# tags, which will be replaced by the file and line number from which the
1475
650
# warning originated and the warning text. Optionally the format may contain
1476
651
# $version, which will be replaced by the version of the file (if it could
1477
652
# be obtained via FILE_VERSION_FILTER)
1478
653
1479
654
WARN_FORMAT            = "$file:$line: $text"
1480
655
1481
656
# The WARN_LOGFILE tag can be used to specify a file to which warning
1482
657
# and error messages should be written. If left blank the output is written
1483
658
# to stderr.
1484
659
1485
660
WARN_LOGFILE           =
1486
661
1487
662
#---------------------------------------------------------------------------
1488
663
# configuration options related to the input files
1489
664
#---------------------------------------------------------------------------
1490
665
1491
666
# The INPUT tag can be used to specify the files and/or directories that contain
1492
667
# documented source files. You may enter file names like "myfile.cpp" or
1493
668
# directories like "/usr/src/myproject". Separate the files or directories
1494
669
# with spaces.
1495
670
1496
671
INPUT                  = @CMAKE_SOURCE_DIR@/include @CMAKE_SOURCE_DIR@/doc
1497
672
1498
673
# This tag can be used to specify the character encoding of the source files
1499
674
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
1500
675
# also the default input encoding. Doxygen uses libiconv (or the iconv built
1501
676
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
1502
677
# the list of possible encodings.
1503
678
1504
679
INPUT_ENCODING         = UTF-8
1505
680
1506
681
# If the value of the INPUT tag contains directories, you can use the
1507
682
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1508
683
# and *.h) to filter out the source-files in the directories. If left
1509
684
# blank the following patterns are tested:
1510
685
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
1511
686
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
1512
687
# *.f90 *.f *.for *.vhd *.vhdl
1513
688
1514
689
FILE_PATTERNS          =
1515
690
1516
691
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1517
692
# should be searched for input files as well. Possible values are YES and NO.
1518
693
# If left blank NO is used.
1519
694
1520
695
RECURSIVE              = YES
1521
696
1522
697
# The EXCLUDE tag can be used to specify files and/or directories that should be
1523
698
# excluded from the INPUT source files. This way you can easily exclude a
1524
699
# subdirectory from a directory tree whose root is specified with the INPUT tag.
1525
700
# Note that relative paths are relative to the directory from which doxygen is
1526
701
# run.
1527
702
1528
703
EXCLUDE                =
1529
704
1530
705
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1531
706
# directories that are symbolic links (a Unix file system feature) are excluded
1532
707
# from the input.
1533
708
1534
709
EXCLUDE_SYMLINKS       = NO
1535
710
1536
711
# If the value of the INPUT tag contains directories, you can use the
1537
712
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1538
713
# certain files from those directories. Note that the wildcards are matched
1539
714
# against the file with absolute path, so to exclude all test directories
1540
715
# for example use the pattern */test/*
1541
716
1542
717
EXCLUDE_PATTERNS       =
1543
718
1544
719
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1545
720
# (namespaces, classes, functions, etc.) that should be excluded from the
1546
721
# output. The symbol name can be a fully qualified name, a word, or if the
1547
722
# wildcard * is used, a substring. Examples: ANamespace, AClass,
1548
723
# AClass::ANamespace, ANamespace::*Test
1549
724
1550
725
EXCLUDE_SYMBOLS        =
1551
726
1552
727
# The EXAMPLE_PATH tag can be used to specify one or more files or
1553
728
# directories that contain example code fragments that are included (see
1554
729
# the \include command).
1555
730
1556
731
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../tests
1557
732
1558
733
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1559
734
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1560
735
# and *.h) to filter out the source-files in the directories. If left
1561
736
# blank all files are included.
1562
737
1563
738
EXAMPLE_PATTERNS       =
1564
739
1565
740
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1566
741
# searched for input files to be used with the \include or \dontinclude
1567
742
# commands irrespective of the value of the RECURSIVE tag.
1568
743
# Possible values are YES and NO. If left blank NO is used.
1569
744
1570
745
EXAMPLE_RECURSIVE      = YES
1571
746
1572
747
# The IMAGE_PATH tag can be used to specify one or more files or
1573
748
# directories that contain image that are included in the documentation (see
1574
749
# the \image command).
1575
750
1576
751
IMAGE_PATH             =
1577
752
1578
753
# The INPUT_FILTER tag can be used to specify a program that doxygen should
1579
754
# invoke to filter for each input file. Doxygen will invoke the filter program
1580
755
# by executing (via popen()) the command <filter> <input-file>, where <filter>
1581
756
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1582
757
# input file. Doxygen will then use the output that the filter program writes
1583
758
# to standard output.
1584
759
# If FILTER_PATTERNS is specified, this tag will be
1585
760
# ignored.
1586
761
1587
762
INPUT_FILTER           =
1588
763
1589
764
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1590
765
# basis.
1591
766
# Doxygen will compare the file name with each pattern and apply the
1592
767
# filter if there is a match.
1593
768
# The filters are a list of the form:
1594
769
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
1595
770
# info on how filters are used. If FILTER_PATTERNS is empty or if
1596
771
# non of the patterns match the file name, INPUT_FILTER is applied.
1597
772
1598
773
FILTER_PATTERNS        =
1599
774
1600
775
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1601
776
# INPUT_FILTER) will be used to filter the input files when producing source
1602
777
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
1603
778
1604
779
FILTER_SOURCE_FILES    = NO
1605
780
1606
781
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1607
782
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
1608
783
# and it is also possible to disable source filtering for a specific pattern
1609
784
# using *.ext= (so without naming a filter). This option only has effect when
1610
785
# FILTER_SOURCE_FILES is enabled.
1611
786
1612
787
FILTER_SOURCE_PATTERNS =
1613
788
1614
789
# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
1615
790
# is part of the input, its contents will be placed on the main page (index.html).
1616
791
# This can be useful if you have a project on for instance GitHub and want reuse
1617
792
# the introduction page also for the doxygen output.
1618
793
1619
794
USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/README.md
1620
795
1621
796
#---------------------------------------------------------------------------
1622
797
# configuration options related to source browsing
1623
798
#---------------------------------------------------------------------------
1624
799
1625
800
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1626
801
# be generated. Documented entities will be cross-referenced with these sources.
1627
802
# Note: To get rid of all source code in the generated output, make sure also
1628
803
# VERBATIM_HEADERS is set to NO.
1629
804
1630
805
SOURCE_BROWSER         = YES
1631
806
1632
807
# Setting the INLINE_SOURCES tag to YES will include the body
1633
808
# of functions and classes directly in the documentation.
1634
809
1635
810
INLINE_SOURCES         = NO
1636
811
1637
812
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1638
813
# doxygen to hide any special comment blocks from generated source code
1639
814
# fragments. Normal C, C++ and Fortran comments will always remain visible.
1640
815
1641
816
STRIP_CODE_COMMENTS    = YES
1642
817
1643
818
# If the REFERENCED_BY_RELATION tag is set to YES
1644
819
# then for each documented function all documented
1645
820
# functions referencing it will be listed.
1646
821
1647
822
REFERENCED_BY_RELATION = YES
1648
823
1649
824
# If the REFERENCES_RELATION tag is set to YES
1650
825
# then for each documented function all documented entities
1651
826
# called/used by that function will be listed.
1652
827
1653
828
REFERENCES_RELATION    = YES
1654
829
1655
830
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
1656
831
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
1657
832
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
1658
833
# link to the source code.
1659
834
# Otherwise they will link to the documentation.
1660
835
1661
836
REFERENCES_LINK_SOURCE = YES
1662
837
1663
838
# If the USE_HTAGS tag is set to YES then the references to source code
1664
839
# will point to the HTML generated by the htags(1) tool instead of doxygen
1665
840
# built-in source browser. The htags tool is part of GNU's global source
1666
841
# tagging system (see http://www.gnu.org/software/global/global.html). You
1667
842
# will need version 4.8.6 or higher.
1668
843
1669
844
USE_HTAGS              = NO
1670
845
1671
846
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1672
847
# will generate a verbatim copy of the header file for each class for
1673
848
# which an include is specified. Set to NO to disable this.
1674
849
1675
850
VERBATIM_HEADERS       = YES
1676
851
1677
852
#---------------------------------------------------------------------------
1678
853
# configuration options related to the alphabetical class index
1679
854
#---------------------------------------------------------------------------
1680
855
1681
856
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1682
857
# of all compounds will be generated. Enable this if the project
1683
858
# contains a lot of classes, structs, unions or interfaces.
1684
859
1685
860
ALPHABETICAL_INDEX     = YES
1686
861
1687
862
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1688
863
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1689
864
# in which this list will be split (can be a number in the range [1..20])
1690
865
1691
866
COLS_IN_ALPHA_INDEX    = 5
1692
867
1693
868
# In case all classes in a project start with a common prefix, all
1694
869
# classes will be put under the same header in the alphabetical index.
1695
870
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1696
871
# should be ignored while generating the index headers.
1697
872
1698
873
IGNORE_PREFIX          =
1699
874
1700
875
#---------------------------------------------------------------------------
1701
876
# configuration options related to the HTML output
1702
877
#---------------------------------------------------------------------------
1703
878
1704
879
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1705
880
# generate HTML output.
1706
881
1707
882
GENERATE_HTML          = YES
1708
883
1709
884
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1710
885
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1711
886
# put in front of it. If left blank `html' will be used as the default path.
1712
887
1713
888
HTML_OUTPUT            = html
1714
889
1715
890
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1716
891
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1717
892
# doxygen will generate files with .html extension.
1718
893
1719
894
HTML_FILE_EXTENSION    = .html
1720
895
1721
896
# The HTML_HEADER tag can be used to specify a personal HTML header for
1722
897
# each generated HTML page. If it is left blank doxygen will generate a
1723
898
# standard header. Note that when using a custom header you are responsible
1724
899
#  for the proper inclusion of any scripts and style sheets that doxygen
1725
900
# needs, which is dependent on the configuration options used.
1726
901
# It is advised to generate a default header using "doxygen -w html
1727
902
# header.html footer.html stylesheet.css YourConfigFile" and then modify
1728
903
# that header. Note that the header is subject to change so you typically
1729
904
# have to redo this when upgrading to a newer version of doxygen or when
1730
905
# changing the value of configuration settings such as GENERATE_TREEVIEW!
1731
906
1732
907
HTML_HEADER            =
1733
908
1734
909
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1735
910
# each generated HTML page. If it is left blank doxygen will generate a
1736
911
# standard footer.
1737
912
1738
913
HTML_FOOTER            =
1739
914
1740
915
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1741
916
# style sheet that is used by each HTML page. It can be used to
1742
917
# fine-tune the look of the HTML output. If left blank doxygen will
1743
918
# generate a default style sheet. Note that it is recommended to use
1744
919
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
1745
920
# tag will in the future become obsolete.
1746
921
1747
922
HTML_STYLESHEET        =
1748
923
1749
924
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
1750
925
# user-defined cascading style sheet that is included after the standard
1751
926
# style sheets created by doxygen. Using this option one can overrule
1752
927
# certain style aspects. This is preferred over using HTML_STYLESHEET
1753
928
# since it does not replace the standard style sheet and is therefor more
1754
929
# robust against future updates. Doxygen will copy the style sheet file to
1755
930
# the output directory.
1756
931
1757
932
HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/extra.css
1758
933
1759
934
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1760
935
# other source files which should be copied to the HTML output directory. Note
1761
936
# that these files will be copied to the base HTML output directory. Use the
1762
937
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1763
938
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
1764
939
# the files will be copied as-is; there are no commands or markers available.
1765
940
1766
941
HTML_EXTRA_FILES       =
1767
942
1768
943
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1769
944
# Doxygen will adjust the colors in the style sheet and background images
1770
945
# according to this color. Hue is specified as an angle on a colorwheel,
1771
946
# see http://en.wikipedia.org/wiki/Hue for more information.
1772
947
# For instance the value 0 represents red, 60 is yellow, 120 is green,
1773
948
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1774
949
# The allowed range is 0 to 359.
1775
950
1776
951
HTML_COLORSTYLE_HUE    = 220
1777
952
1778
953
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1779
954
# the colors in the HTML output. For a value of 0 the output will use
1780
955
# grayscales only. A value of 255 will produce the most vivid colors.
1781
956
1782
957
HTML_COLORSTYLE_SAT    = 100
1783
958
1784
959
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1785
960
# the luminance component of the colors in the HTML output. Values below
1786
961
# 100 gradually make the output lighter, whereas values above 100 make
1787
962
# the output darker. The value divided by 100 is the actual gamma applied,
1788
963
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1789
964
# and 100 does not change the gamma.
1790
965
1791
966
HTML_COLORSTYLE_GAMMA  = 80
1792
967
1793
968
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1794
969
# page will contain the date and time when the page was generated. Setting
1795
970
# this to NO can help when comparing the output of multiple runs.
1796
971
1797
972
HTML_TIMESTAMP         = YES
1798
973
1799
974
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1800
975
# documentation will contain sections that can be hidden and shown after the
1801
976
# page has loaded.
1802
977
1803
978
HTML_DYNAMIC_SECTIONS  = YES
1804
979
1805
980
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1806
981
# entries shown in the various tree structured indices initially; the user
1807
982
# can expand and collapse entries dynamically later on. Doxygen will expand
1808
983
# the tree to such a level that at most the specified number of entries are
1809
984
# visible (unless a fully collapsed tree already exceeds this amount).
1810
985
# So setting the number of entries 1 will produce a full collapsed tree by
1811
986
# default. 0 is a special value representing an infinite number of entries
1812
987
# and will result in a full expanded tree by default.
1813
988
1814
989
HTML_INDEX_NUM_ENTRIES = 100
1815
990
1816
991
# If the GENERATE_DOCSET tag is set to YES, additional index files
1817
992
# will be generated that can be used as input for Apple's Xcode 3
1818
993
# integrated development environment, introduced with OSX 10.5 (Leopard).
1819
994
# To create a documentation set, doxygen will generate a Makefile in the
1820
995
# HTML output directory. Running make will produce the docset in that
1821
996
# directory and running "make install" will install the docset in
1822
997
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1823
998
# it at startup.
1824
999
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1825
1000
# for more information.
1826
1001
1827
1002
GENERATE_DOCSET        = NO
1828
1003
1829
1004
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1830
1005
# feed. A documentation feed provides an umbrella under which multiple
1831
1006
# documentation sets from a single provider (such as a company or product suite)
1832
1007
# can be grouped.
1833
1008
1834
1009
DOCSET_FEEDNAME        = "Doxygen generated docs"
1835
1010
1836
1011
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1837
1012
# should uniquely identify the documentation set bundle. This should be a
1838
1013
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1839
1014
# will append .docset to the name.
1840
1015
1841
1016
DOCSET_BUNDLE_ID       = org.doxygen.Project
1842
1017
1843
1018
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1844
1019
# identify the documentation publisher. This should be a reverse domain-name
1845
1020
# style string, e.g. com.mycompany.MyDocSet.documentation.
1846
1021
1847
1022
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1848
1023
1849
1024
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1850
1025
1851
1026
DOCSET_PUBLISHER_NAME  = Publisher
1852
1027
1853
1028
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1854
1029
# will be generated that can be used as input for tools like the
1855
1030
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1856
1031
# of the generated HTML documentation.
1857
1032
1858
1033
GENERATE_HTMLHELP      = NO
1859
1034
1860
1035
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1861
1036
# be used to specify the file name of the resulting .chm file. You
1862
1037
# can add a path in front of the file if the result should not be
1863
1038
# written to the html output directory.
1864
1039
1865
1040
CHM_FILE               =
1866
1041
1867
1042
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1868
1043
# be used to specify the location (absolute path including file name) of
1869
1044
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1870
1045
# the HTML help compiler on the generated index.hhp.
1871
1046
1872
1047
HHC_LOCATION           =
1873
1048
1874
1049
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1875
1050
# controls if a separate .chi index file is generated (YES) or that
1876
1051
# it should be included in the master .chm file (NO).
1877
1052
1878
1053
GENERATE_CHI           = NO
1879
1054
1880
1055
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1881
1056
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1882
1057
# content.
1883
1058
1884
1059
CHM_INDEX_ENCODING     =
1885
1060
1886
1061
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1887
1062
# controls whether a binary table of contents is generated (YES) or a
1888
1063
# normal table of contents (NO) in the .chm file.
1889
1064
1890
1065
BINARY_TOC             = NO
1891
1066
1892
1067
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1893
1068
# to the contents of the HTML help documentation and to the tree view.
1894
1069
1895
1070
TOC_EXPAND             = NO
1896
1071
1897
1072
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1898
1073
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1899
1074
# that can be used as input for Qt's qhelpgenerator to generate a
1900
1075
# Qt Compressed Help (.qch) of the generated HTML documentation.
1901
1076
1902
1077
GENERATE_QHP           = NO
1903
1078
1904
1079
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1905
1080
# be used to specify the file name of the resulting .qch file.
1906
1081
# The path specified is relative to the HTML output folder.
1907
1082
1908
1083
QCH_FILE               =
1909
1084
1910
1085
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1911
1086
# Qt Help Project output. For more information please see
1912
1087
# http://doc.trolltech.com/qthelpproject.html#namespace
1913
1088
1914
1089
QHP_NAMESPACE          = org.doxygen.Project
1915
1090
1916
1091
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1917
1092
# Qt Help Project output. For more information please see
1918
1093
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1919
1094
1920
1095
QHP_VIRTUAL_FOLDER     = doc
1921
1096
1922
1097
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1923
1098
# add. For more information please see
1924
1099
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1925
1100
1926
1101
QHP_CUST_FILTER_NAME   =
1927
1102
1928
1103
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1929
1104
# custom filter to add. For more information please see
1930
1105
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1931
1106
# Qt Help Project / Custom Filters</a>.
1932
1107
1933
1108
QHP_CUST_FILTER_ATTRS  =
1934
1109
1935
1110
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1936
1111
# project's
1937
1112
# filter section matches.
1938
1113
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1939
1114
# Qt Help Project / Filter Attributes</a>.
1940
1115
1941
1116
QHP_SECT_FILTER_ATTRS  =
1942
1117
1943
1118
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1944
1119
# be used to specify the location of Qt's qhelpgenerator.
1945
1120
# If non-empty doxygen will try to run qhelpgenerator on the generated
1946
1121
# .qhp file.
1947
1122
1948
1123
QHG_LOCATION           =
1949
1124
1950
1125
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1951
1126
#  will be generated, which together with the HTML files, form an Eclipse help
1952
1127
# plugin. To install this plugin and make it available under the help contents
1953
1128
# menu in Eclipse, the contents of the directory containing the HTML and XML
1954
1129
# files needs to be copied into the plugins directory of eclipse. The name of
1955
1130
# the directory within the plugins directory should be the same as
1956
1131
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1957
1132
# the help appears.
1958
1133
1959
1134
GENERATE_ECLIPSEHELP   = NO
1960
1135
1961
1136
# A unique identifier for the eclipse help plugin. When installing the plugin
1962
1137
# the directory name containing the HTML and XML files should also have
1963
1138
# this name.
1964
1139
1965
1140
ECLIPSE_DOC_ID         = org.doxygen.Project
1966
1141
1967
1142
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1968
1143
# at top of each HTML page. The value NO (the default) enables the index and
1969
1144
# the value YES disables it. Since the tabs have the same information as the
1970
1145
# navigation tree you can set this option to NO if you already set
1971
1146
# GENERATE_TREEVIEW to YES.
1972
1147
1973
1148
DISABLE_INDEX          = YES
1974
1149
1975
1150
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1976
1151
# structure should be generated to display hierarchical information.
1977
1152
# If the tag value is set to YES, a side panel will be generated
1978
1153
# containing a tree-like index structure (just like the one that
1979
1154
# is generated for HTML Help). For this to work a browser that supports
1980
1155
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1981
1156
# Windows users are probably better off using the HTML help feature.
1982
1157
# Since the tree basically has the same information as the tab index you
1983
1158
# could consider to set DISABLE_INDEX to NO when enabling this option.
1984
1159
1985
1160
GENERATE_TREEVIEW      = YES
1986
1161
1987
1162
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1988
1163
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1989
1164
# documentation. Note that a value of 0 will completely suppress the enum
1990
1165
# values from appearing in the overview section.
1991
1166
1992
1167
ENUM_VALUES_PER_LINE   = 1
1993
1168
1994
1169
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1995
1170
# used to set the initial width (in pixels) of the frame in which the tree
1996
1171
# is shown.
1997
1172
1998
1173
TREEVIEW_WIDTH         = 250
1999
1174
2000
1175
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
2001
1176
# links to external symbols imported via tag files in a separate window.
2002
1177
2003
1178
EXT_LINKS_IN_WINDOW    = NO
2004
1179
2005
1180
# Use this tag to change the font size of Latex formulas included
2006
1181
# as images in the HTML documentation. The default is 10. Note that
2007
1182
# when you change the font size after a successful doxygen run you need
2008
1183
# to manually remove any form_*.png images from the HTML output directory
2009
1184
# to force them to be regenerated.
2010
1185
2011
1186
FORMULA_FONTSIZE       = 10
2012
1187
2013
1188
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
2014
1189
# generated for formulas are transparent PNGs. Transparent PNGs are
2015
1190
# not supported properly for IE 6.0, but are supported on all modern browsers.
2016
1191
# Note that when changing this option you need to delete any form_*.png files
2017
1192
# in the HTML output before the changes have effect.
2018
1193
2019
1194
FORMULA_TRANSPARENT    = YES
2020
1195
2021
1196
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
2022
1197
# (see http://www.mathjax.org) which uses client side Javascript for the
2023
1198
# rendering instead of using prerendered bitmaps. Use this if you do not
2024
1199
# have LaTeX installed or if you want to formulas look prettier in the HTML
2025
1200
# output. When enabled you may also need to install MathJax separately and
2026
1201
# configure the path to it using the MATHJAX_RELPATH option.
2027
1202
2028
1203
USE_MATHJAX            = NO
2029
1204
2030
1205
# When MathJax is enabled you can set the default output format to be used for
2031
1206
# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
2032
1207
# SVG. The default value is HTML-CSS, which is slower, but has the best
2033
1208
# compatibility.
2034
1209
2035
1210
MATHJAX_FORMAT         = HTML-CSS
2036
1211
2037
1212
# When MathJax is enabled you need to specify the location relative to the
2038
1213
# HTML output directory using the MATHJAX_RELPATH option. The destination
2039
1214
# directory should contain the MathJax.js script. For instance, if the mathjax
2040
1215
# directory is located at the same level as the HTML output directory, then
2041
1216
# MATHJAX_RELPATH should be ../mathjax. The default value points to
2042
1217
# the MathJax Content Delivery Network so you can quickly see the result without
2043
1218
# installing MathJax.
2044
1219
# However, it is strongly recommended to install a local
2045
1220
# copy of MathJax from http://www.mathjax.org before deployment.
2046
1221
2047
1222
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
2048
1223
2049
1224
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
2050
1225
# names that should be enabled during MathJax rendering.
2051
1226
2052
1227
MATHJAX_EXTENSIONS     =
2053
1228
2054
1229
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
2055
1230
# for the HTML output. The underlying search engine uses javascript
2056
1231
# and DHTML and should work on any modern browser. Note that when using
2057
1232
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
2058
1233
# (GENERATE_DOCSET) there is already a search function so this one should
2059
1234
# typically be disabled. For large projects the javascript based search engine
2060
1235
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
2061
1236
2062
1237
SEARCHENGINE           = NO
2063
1238
2064
1239
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
2065
1240
# implemented using a web server instead of a web client using Javascript.
2066
1241
# There are two flavours of web server based search depending on the
2067
1242
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
2068
1243
# searching and an index file used by the script. When EXTERNAL_SEARCH is
2069
1244
# enabled the indexing and searching needs to be provided by external tools.
2070
1245
# See the manual for details.
2071
1246
2072
1247
SERVER_BASED_SEARCH    = NO
2073
1248
2074
1249
# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
2075
1250
# script for searching. Instead the search results are written to an XML file
2076
1251
# which needs to be processed by an external indexer. Doxygen will invoke an
2077
1252
# external search engine pointed to by the SEARCHENGINE_URL option to obtain
2078
1253
# the search results. Doxygen ships with an example indexer (doxyindexer) and
2079
1254
# search engine (doxysearch.cgi) which are based on the open source search engine
2080
1255
# library Xapian. See the manual for configuration details.
2081
1256
2082
1257
EXTERNAL_SEARCH        = NO
2083
1258
2084
1259
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
2085
1260
# which will returned the search results when EXTERNAL_SEARCH is enabled.
2086
1261
# Doxygen ships with an example search engine (doxysearch) which is based on
2087
1262
# the open source search engine library Xapian. See the manual for configuration
2088
1263
# details.
2089
1264
2090
1265
SEARCHENGINE_URL       =
2091
1266
2092
1267
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
2093
1268
# search data is written to a file for indexing by an external tool. With the
2094
1269
# SEARCHDATA_FILE tag the name of this file can be specified.
2095
1270
2096
1271
SEARCHDATA_FILE        = searchdata.xml
2097
1272
2098
1273
# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
2099
1274
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
2100
1275
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
2101
1276
# projects and redirect the results back to the right project.
2102
1277
2103
1278
EXTERNAL_SEARCH_ID     =
2104
1279
2105
1280
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
2106
1281
# projects other than the one defined by this configuration file, but that are
2107
1282
# all added to the same external search index. Each project needs to have a
2108
1283
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
2109
1284
# of to a relative location where the documentation can be found.
2110
1285
# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
2111
1286
2112
1287
EXTRA_SEARCH_MAPPINGS  =
2113
1288
2114
1289
#---------------------------------------------------------------------------
2115
1290
# configuration options related to the LaTeX output
2116
1291
#---------------------------------------------------------------------------
2117
1292
2118
1293
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
2119
1294
# generate Latex output.
2120
1295
2121
1296
GENERATE_LATEX         = YES
2122
1297
2123
1298
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
2124
1299
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2125
1300
# put in front of it. If left blank `latex' will be used as the default path.
2126
1301
2127
1302
LATEX_OUTPUT           = latex
2128
1303
2129
1304
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2130
1305
# invoked. If left blank `latex' will be used as the default command name.
2131
1306
# Note that when enabling USE_PDFLATEX this option is only used for
2132
1307
# generating bitmaps for formulas in the HTML output, but not in the
2133
1308
# Makefile that is written to the output directory.
2134
1309
2135
1310
LATEX_CMD_NAME         = latex
2136
1311
2137
1312
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
2138
1313
# generate index for LaTeX. If left blank `makeindex' will be used as the
2139
1314
# default command name.
2140
1315
2141
1316
MAKEINDEX_CMD_NAME     = makeindex
2142
1317
2143
1318
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
2144
1319
# LaTeX documents. This may be useful for small projects and may help to
2145
1320
# save some trees in general.
2146
1321
2147
1322
COMPACT_LATEX          = YES 
2148
1323
2149
1324
# The PAPER_TYPE tag can be used to set the paper type that is used
2150
1325
# by the printer. Possible values are: a4, letter, legal and
2151
1326
# executive. If left blank a4wide will be used.
2152
1327
2153
1328
PAPER_TYPE             = a4
2154
1329
2155
1330
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
2156
1331
# packages that should be included in the LaTeX output.
2157
1332
2158
1333
EXTRA_PACKAGES         =
2159
1334
2160
1335
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
2161
1336
# the generated latex document. The header should contain everything until
2162
1337
# the first chapter. If it is left blank doxygen will generate a
2163
1338
# standard header. Notice: only use this tag if you know what you are doing!
2164
1339
2165
1340
LATEX_HEADER           =
2166
1341
2167
1342
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
2168
1343
# the generated latex document. The footer should contain everything after
2169
1344
# the last chapter. If it is left blank doxygen will generate a
2170
1345
# standard footer. Notice: only use this tag if you know what you are doing!
2171
1346
2172
1347
LATEX_FOOTER           =
2173
1348
2174
1349
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
2175
1350
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
2176
1351
# contain links (just like the HTML output) instead of page references
2177
1352
# This makes the output suitable for online browsing using a pdf viewer.
2178
1353
2179
1354
PDF_HYPERLINKS         = YES
2180
1355
2181
1356
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
2182
1357
# plain latex in the generated Makefile. Set this option to YES to get a
2183
1358
# higher quality PDF documentation.
2184
1359
2185
1360
USE_PDFLATEX           = YES
2186
1361
2187
1362
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
2188
1363
# command to the generated LaTeX files. This will instruct LaTeX to keep
2189
1364
# running if errors occur, instead of asking the user for help.
2190
1365
# This option is also used when generating formulas in HTML.
2191
1366
2192
1367
LATEX_BATCHMODE        = NO
2193
1368
2194
1369
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
2195
1370
# include the index chapters (such as File Index, Compound Index, etc.)
2196
1371
# in the output.
2197
1372
2198
1373
LATEX_HIDE_INDICES     = NO
2199
1374
2200
1375
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
2201
1376
# source code with syntax highlighting in the LaTeX output.
2202
1377
# Note that which sources are shown also depends on other settings
2203
1378
# such as SOURCE_BROWSER.
2204
1379
2205
1380
LATEX_SOURCE_CODE      = NO 
2206
1381
2207
1382
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2208
1383
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
2209
1384
# http://en.wikipedia.org/wiki/BibTeX for more info.
2210
1385
2211
1386
LATEX_BIB_STYLE        = plain
2212
1387
2213
1388
#---------------------------------------------------------------------------
2214
1389
# configuration options related to the RTF output
2215
1390
#---------------------------------------------------------------------------
2216
1391
2217
1392
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
2218
1393
# The RTF output is optimized for Word 97 and may not look very pretty with
2219
1394
# other RTF readers or editors.
2220
1395
2221
1396
GENERATE_RTF           = NO
2222
1397
2223
1398
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
2224
1399
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2225
1400
# put in front of it. If left blank `rtf' will be used as the default path.
2226
1401
2227
1402
RTF_OUTPUT             = rtf
2228
1403
2229
1404
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
2230
1405
# RTF documents. This may be useful for small projects and may help to
2231
1406
# save some trees in general.
2232
1407
2233
1408
COMPACT_RTF            = NO
2234
1409
2235
1410
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
2236
1411
# will contain hyperlink fields. The RTF file will
2237
1412
# contain links (just like the HTML output) instead of page references.
2238
1413
# This makes the output suitable for online browsing using WORD or other
2239
1414
# programs which support those fields.
2240
1415
# Note: wordpad (write) and others do not support links.
2241
1416
2242
1417
RTF_HYPERLINKS         = NO
2243
1418
2244
1419
# Load style sheet definitions from file. Syntax is similar to doxygen's
2245
1420
# config file, i.e. a series of assignments. You only have to provide
2246
1421
# replacements, missing definitions are set to their default value.
2247
1422
2248
1423
RTF_STYLESHEET_FILE    =
2249
1424
2250
1425
# Set optional variables used in the generation of an rtf document.
2251
1426
# Syntax is similar to doxygen's config file.
2252
1427
2253
1428
RTF_EXTENSIONS_FILE    =
2254
1429
2255
1430
#---------------------------------------------------------------------------
2256
1431
# configuration options related to the man page output
2257
1432
#---------------------------------------------------------------------------
2258
1433
2259
1434
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
2260
1435
# generate man pages
2261
1436
2262
1437
GENERATE_MAN           = YES
2263
1438
2264
1439
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
2265
1440
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2266
1441
# put in front of it. If left blank `man' will be used as the default path.
2267
1442
2268
1443
MAN_OUTPUT             = man
2269
1444
2270
1445
# The MAN_EXTENSION tag determines the extension that is added to
2271
1446
# the generated man pages (default is the subroutine's section .3)
2272
1447
2273
1448
MAN_EXTENSION          = .3
2274
1449
2275
1450
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
2276
1451
# then it will generate one additional man file for each entity
2277
1452
# documented in the real man page(s). These additional files
2278
1453
# only source the real man page, but without them the man command
2279
1454
# would be unable to find the correct page. The default is NO.
2280
1455
2281
1456
MAN_LINKS              = NO
2282
1457
2283
1458
#---------------------------------------------------------------------------
2284
1459
# configuration options related to the XML output
2285
1460
#---------------------------------------------------------------------------
2286
1461
2287
1462
# If the GENERATE_XML tag is set to YES Doxygen will
2288
1463
# generate an XML file that captures the structure of
2289
1464
# the code including all documentation.
2290
1465
2291
1466
GENERATE_XML           = NO
2292
1467
2293
1468
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
2294
1469
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2295
1470
# put in front of it. If left blank `xml' will be used as the default path.
2296
1471
2297
1472
XML_OUTPUT             = xml
2298
1473
2299
1474
# The XML_SCHEMA tag can be used to specify an XML schema,
2300
1475
# which can be used by a validating XML parser to check the
2301
1476
# syntax of the XML files.
2302
1477
2303
1478
XML_SCHEMA             =
2304
1479
2305
1480
# The XML_DTD tag can be used to specify an XML DTD,
2306
1481
# which can be used by a validating XML parser to check the
2307
1482
# syntax of the XML files.
2308
1483
2309
1484
XML_DTD                =
2310
1485
2311
1486
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
2312
1487
# dump the program listings (including syntax highlighting
2313
1488
# and cross-referencing information) to the XML output. Note that
2314
1489
# enabling this will significantly increase the size of the XML output.
2315
1490
2316
1491
XML_PROGRAMLISTING     = YES
2317
1492
2318
1493
#---------------------------------------------------------------------------
2319
1494
# configuration options for the AutoGen Definitions output
2320
1495
#---------------------------------------------------------------------------
2321
1496
2322
1497
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
2323
1498
# generate an AutoGen Definitions (see autogen.sf.net) file
2324
1499
# that captures the structure of the code including all
2325
1500
# documentation. Note that this feature is still experimental
2326
1501
# and incomplete at the moment.
2327
1502
2328
1503
GENERATE_AUTOGEN_DEF   = NO
2329
1504
2330
1505
#---------------------------------------------------------------------------
2331
1506
# configuration options related to the Perl module output
2332
1507
#---------------------------------------------------------------------------
2333
1508
2334
1509
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
2335
1510
# generate a Perl module file that captures the structure of
2336
1511
# the code including all documentation. Note that this
2337
1512
# feature is still experimental and incomplete at the
2338
1513
# moment.
2339
1514
2340
1515
GENERATE_PERLMOD       = NO
2341
1516
2342
1517
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
2343
1518
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
2344
1519
# to generate PDF and DVI output from the Perl module output.
2345
1520
2346
1521
PERLMOD_LATEX          = NO
2347
1522
2348
1523
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
2349
1524
# nicely formatted so it can be parsed by a human reader.
2350
1525
# This is useful
2351
1526
# if you want to understand what is going on.
2352
1527
# On the other hand, if this
2353
1528
# tag is set to NO the size of the Perl module output will be much smaller
2354
1529
# and Perl will parse it just the same.
2355
1530
2356
1531
PERLMOD_PRETTY         = YES
2357
1532
2358
1533
# The names of the make variables in the generated doxyrules.make file
2359
1534
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
2360
1535
# This is useful so different doxyrules.make files included by the same
2361
1536
# Makefile don't overwrite each other's variables.
2362
1537
2363
1538
PERLMOD_MAKEVAR_PREFIX =
2364
1539
2365
1540
#---------------------------------------------------------------------------
2366
1541
# Configuration options related to the preprocessor
2367
1542
#---------------------------------------------------------------------------
2368
1543
2369
1544
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
2370
1545
# evaluate all C-preprocessor directives found in the sources and include
2371
1546
# files.
2372
1547
2373
1548
ENABLE_PREPROCESSING   = YES
2374
1549
2375
1550
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
2376
1551
# names in the source code. If set to NO (the default) only conditional
2377
1552
# compilation will be performed. Macro expansion can be done in a controlled
2378
1553
# way by setting EXPAND_ONLY_PREDEF to YES.
2379
1554
2380
1555
MACRO_EXPANSION        = NO
2381
1556
2382
1557
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
2383
1558
# then the macro expansion is limited to the macros specified with the
2384
1559
# PREDEFINED and EXPAND_AS_DEFINED tags.
2385
1560
2386
1561
EXPAND_ONLY_PREDEF     = NO
2387
1562
2388
1563
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
2389
1564
# pointed to by INCLUDE_PATH will be searched when a #include is found.
2390
1565
2391
1566
SEARCH_INCLUDES        = YES
2392
1567
2393
1568
# The INCLUDE_PATH tag can be used to specify one or more directories that
2394
1569
# contain include files that are not input files but should be processed by
2395
1570
# the preprocessor.
2396
1571
2397
1572
INCLUDE_PATH           =
2398
1573
2399
1574
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2400
1575
# patterns (like *.h and *.hpp) to filter out the header-files in the
2401
1576
# directories. If left blank, the patterns specified with FILE_PATTERNS will
2402
1577
# be used.
2403
1578
2404
1579
INCLUDE_FILE_PATTERNS  =
2405
1580
2406
1581
# The PREDEFINED tag can be used to specify one or more macro names that
2407
1582
# are defined before the preprocessor is started (similar to the -D option of
2408
1583
# gcc). The argument of the tag is a list of macros of the form: name
2409
1584
# or name=definition (no spaces). If the definition and the = are
2410
1585
# omitted =1 is assumed. To prevent a macro definition from being
2411
1586
# undefined via #undef or recursively expanded use the := operator
2412
1587
# instead of the = operator.
2413
1588
2414
1589
PREDEFINED             =
2415
1590
2416
1591
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
2417
1592
# this tag can be used to specify a list of macro names that should be expanded.
2418
1593
# The macro definition that is found in the sources will be used.
2419
1594
# Use the PREDEFINED tag if you want to use a different macro definition that
2420
1595
# overrules the definition found in the source code.
2421
1596
2422
1597
EXPAND_AS_DEFINED      =
2423
1598
2424
1599
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
2425
1600
# doxygen's preprocessor will remove all references to function-like macros
2426
1601
# that are alone on a line, have an all uppercase name, and do not end with a
2427
1602
# semicolon, because these will confuse the parser if not removed.
2428
1603
2429
1604
SKIP_FUNCTION_MACROS   = YES
2430
1605
2431
1606
#---------------------------------------------------------------------------
2432
1607
# Configuration::additions related to external references
2433
1608
#---------------------------------------------------------------------------
2434
1609
2435
1610
# The TAGFILES option can be used to specify one or more tagfiles. For each
2436
1611
# tag file the location of the external documentation should be added. The
2437
1612
# format of a tag file without this location is as follows:
2438
1613
#
2439
1614
# TAGFILES = file1 file2 ...
2440
1615
# Adding location for the tag files is done as follows:
2441
1616
#
2442
1617
# TAGFILES = file1=loc1 "file2 = loc2" ...
2443
1618
# where "loc1" and "loc2" can be relative or absolute paths
2444
1619
# or URLs. Note that each tag file must have a unique name (where the name does
2445
1620
# NOT include the path). If a tag file is not located in the directory in which
2446
1621
# doxygen is run, you must also specify the path to the tagfile here.
2447
1622
2448
1623
TAGFILES               =
2449
1624
2450
1625
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2451
1626
# a tag file that is based on the input files it reads.
2452
1627
2453
1628
GENERATE_TAGFILE       =
2454
1629
2455
1630
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2456
1631
# in the class index. If set to NO only the inherited external classes
2457
1632
# will be listed.
2458
1633
2459
1634
ALLEXTERNALS           = NO
2460
1635
2461
1636
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2462
1637
# in the modules index. If set to NO, only the current project's groups will
2463
1638
# be listed.
2464
1639
2465
1640
EXTERNAL_GROUPS        = YES
2466
1641
2467
1642
# The PERL_PATH should be the absolute path and name of the perl script
2468
1643
# interpreter (i.e. the result of `which perl').
2469
1644
2470
1645
PERL_PATH              = /usr/bin/perl
2471
1646
2472
1647
#---------------------------------------------------------------------------
2473
1648
# Configuration options related to the dot tool
2474
1649
#---------------------------------------------------------------------------
2475
1650
2476
1651
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2477
1652
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
2478
1653
# or super classes. Setting the tag to NO turns the diagrams off. Note that
2479
1654
# this option also works with HAVE_DOT disabled, but it is recommended to
2480
1655
# install and use dot, since it yields more powerful graphs.
2481
1656
2482
1657
CLASS_DIAGRAMS         = YES
2483
1658
2484
1659
# You can define message sequence charts within doxygen comments using the \msc
2485
1660
# command. Doxygen will then run the mscgen tool (see
2486
1661
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
2487
1662
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2488
1663
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2489
1664
# default search path.
2490
1665
2491
1666
MSCGEN_PATH            =
2492
1667
2493
1668
# If set to YES, the inheritance and collaboration graphs will hide
2494
1669
# inheritance and usage relations if the target is undocumented
2495
1670
# or is not a class.
2496
1671
2497
1672
HIDE_UNDOC_RELATIONS   = NO
2498
1673
2499
1674
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2500
1675
# available from the path. This tool is part of Graphviz, a graph visualization
2501
1676
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2502
1677
# have no effect if this option is set to NO (the default)
2503
1678
2504
1679
HAVE_DOT               = YES
2505
1680
2506
1681
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
2507
1682
# allowed to run in parallel. When set to 0 (the default) doxygen will
2508
1683
# base this on the number of processors available in the system. You can set it
2509
1684
# explicitly to a value larger than 0 to get control over the balance
2510
1685
# between CPU load and processing speed.
2511
1686
2512
1687
DOT_NUM_THREADS        = 1 
2513
1688
2514
1689
# By default doxygen will use the Helvetica font for all dot files that
2515
1690
# doxygen generates. When you want a differently looking font you can specify
2516
1691
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
2517
1692
# the font, which can be done by putting it in a standard location or by setting
2518
1693
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2519
1694
# directory containing the font.
2520
1695
2521
1696
DOT_FONTNAME           = Helvetica
2522
1697
2523
1698
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
2524
1699
# The default size is 10pt.
2525
1700
2526
1701
DOT_FONTSIZE           = 10
2527
1702
2528
1703
# By default doxygen will tell dot to use the Helvetica font.
2529
1704
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
2530
1705
# set the path where dot can find it.
2531
1706
2532
1707
DOT_FONTPATH           =
2533
1708
2534
1709
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2535
1710
# will generate a graph for each documented class showing the direct and
2536
1711
# indirect inheritance relations. Setting this tag to YES will force the
2537
1712
# CLASS_DIAGRAMS tag to NO.
2538
1713
2539
1714
CLASS_GRAPH            = YES
2540
1715
2541
1716
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2542
1717
# will generate a graph for each documented class showing the direct and
2543
1718
# indirect implementation dependencies (inheritance, containment, and
2544
1719
# class references variables) of the class with other documented classes.
2545
1720
2546
1721
COLLABORATION_GRAPH    = YES
2547
1722
2548
1723
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
2549
1724
# will generate a graph for groups, showing the direct groups dependencies
2550
1725
2551
1726
GROUP_GRAPHS           = YES
2552
1727
2553
1728
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2554
1729
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2555
1730
# Language.
2556
1731
2557
1732
UML_LOOK               = YES
2558
1733
2559
1734
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
2560
1735
# the class node. If there are many fields or methods and many nodes the
2561
1736
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
2562
1737
# threshold limits the number of items for each type to make the size more
2563
1738
# managable. Set this to 0 for no limit. Note that the threshold may be
2564
1739
# exceeded by 50% before the limit is enforced.
2565
1740
2566
1741
UML_LIMIT_NUM_FIELDS   = 10
2567
1742
2568
1743
# If set to YES, the inheritance and collaboration graphs will show the
2569
1744
# relations between templates and their instances.
2570
1745
2571
1746
TEMPLATE_RELATIONS     = NO
2572
1747
2573
1748
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2574
1749
# tags are set to YES then doxygen will generate a graph for each documented
2575
1750
# file showing the direct and indirect include dependencies of the file with
2576
1751
# other documented files.
2577
1752
2578
1753
INCLUDE_GRAPH          = YES
2579
1754
2580
1755
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2581
1756
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2582
1757
# documented header file showing the documented files that directly or
2583
1758
# indirectly include this file.
2584
1759
2585
1760
INCLUDED_BY_GRAPH      = YES
2586
1761
2587
1762
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
2588
1763
# doxygen will generate a call dependency graph for every global function
2589
1764
# or class method. Note that enabling this option will significantly increase
2590
1765
# the time of a run. So in most cases it will be better to enable call graphs
2591
1766
# for selected functions only using the \callgraph command.
2592
1767
2593
1768
CALL_GRAPH             = YES
2594
1769
2595
1770
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
2596
1771
# doxygen will generate a caller dependency graph for every global function
2597
1772
# or class method. Note that enabling this option will significantly increase
2598
1773
# the time of a run. So in most cases it will be better to enable caller
2599
1774
# graphs for selected functions only using the \callergraph command.
2600
1775
2601
1776
CALLER_GRAPH           = NO
2602
1777
2603
1778
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2604
1779
# will generate a graphical hierarchy of all classes instead of a textual one.
2605
1780
2606
1781
GRAPHICAL_HIERARCHY    = YES
2607
1782
2608
1783
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
2609
1784
# then doxygen will show the dependencies a directory has on other directories
2610
1785
# in a graphical way. The dependency relations are determined by the #include
2611
1786
# relations between the files in the directories.
2612
1787
2613
1788
DIRECTORY_GRAPH        = YES
2614
1789
2615
1790
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2616
1791
# generated by dot. Possible values are svg, png, jpg, or gif.
2617
1792
# If left blank png will be used. If you choose svg you need to set
2618
1793
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2619
1794
# visible in IE 9+ (other browsers do not have this requirement).
2620
1795
2621
1796
DOT_IMAGE_FORMAT       = png
2622
1797
2623
1798
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2624
1799
# enable generation of interactive SVG images that allow zooming and panning.
2625
1800
# Note that this requires a modern browser other than Internet Explorer.
2626
1801
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
2627
1802
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2628
1803
# visible. Older versions of IE do not have SVG support.
2629
1804
2630
1805
INTERACTIVE_SVG        = YES
2631
1806
2632
1807
# The tag DOT_PATH can be used to specify the path where the dot tool can be
2633
1808
# found. If left blank, it is assumed the dot tool can be found in the path.
2634
1809
2635
1810
DOT_PATH               =
2636
1811
2637
1812
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2638
1813
# contain dot files that are included in the documentation (see the
2639
1814
# \dotfile command).
2640
1815
2641
1816
DOTFILE_DIRS           =
2642
1817
2643
1818
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2644
1819
# contain msc files that are included in the documentation (see the
2645
1820
# \mscfile command).
2646
1821
2647
1822
MSCFILE_DIRS           =
2648
1823
2649
1824
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
2650
1825
# nodes that will be shown in the graph. If the number of nodes in a graph
2651
1826
# becomes larger than this value, doxygen will truncate the graph, which is
2652
1827
# visualized by representing a node as a red box. Note that doxygen if the
2653
1828
# number of direct children of the root node in a graph is already larger than
2654
1829
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
2655
1830
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2656
1831
2657
1832
DOT_GRAPH_MAX_NODES    = 50
2658
1833
2659
1834
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
2660
1835
# graphs generated by dot. A depth value of 3 means that only nodes reachable
2661
1836
# from the root by following a path via at most 3 edges will be shown. Nodes
2662
1837
# that lay further from the root node will be omitted. Note that setting this
2663
1838
# option to 1 or 2 may greatly reduce the computation time needed for large
2664
1839
# code bases. Also note that the size of a graph can be further restricted by
2665
1840
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2666
1841
2667
1842
MAX_DOT_GRAPH_DEPTH    = 0
2668
1843
2669
1844
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2670
1845
# background. This is disabled by default, because dot on Windows does not
2671
1846
# seem to support this out of the box. Warning: Depending on the platform used,
2672
1847
# enabling this option may lead to badly anti-aliased labels on the edges of
2673
1848
# a graph (i.e. they become hard to read).
2674
1849
2675
1850
DOT_TRANSPARENT        = YES
2676
1851
2677
1852
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2678
1853
# files in one run (i.e. multiple -o and -T options on the command line). This
2679
1854
# makes dot run faster, but since only newer versions of dot (>1.8.10)
2680
1855
# support this, this feature is disabled by default.
2681
1856
2682
1857
DOT_MULTI_TARGETS      = YES
2683
1858
2684
1859
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2685
1860
# generate a legend page explaining the meaning of the various boxes and
2686
1861
# arrows in the dot generated graphs.
2687
1862
2688
1863
GENERATE_LEGEND        = YES
2689
1864
2690
1865
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2691
1866
# remove the intermediate dot files that are used to generate
2692
1867
# the various graphs.
2693
1868
2694
1869
DOT_CLEANUP            = YES
2695
0
1870
2696
=== added directory 'examples/mfw-plugin-dummy/include'
2697
=== added file 'examples/mfw-plugin-dummy/include/CMakeLists.txt'
2698
--- examples/mfw-plugin-dummy/include/CMakeLists.txt	1970-01-01 00:00:00 +0000
2699
+++ examples/mfw-plugin-dummy/include/CMakeLists.txt	2017-03-22 21:22:50 +0000
2700
@@ -0,0 +1,3 @@
2701
1
# make the .h files visible on qtcreator
2702
2
file(GLOB_RECURSE H_FILES_PLUGIN *.h)
2703
3
add_custom_target(dot_h_files_plugin ALL SOURCES ${H_FILES_PLUGIN})
2704
0
4
2705
=== added directory 'examples/mfw-plugin-dummy/include/dummy'
2706
=== added file 'examples/mfw-plugin-dummy/include/dummy/chat.h'
2707
--- examples/mfw-plugin-dummy/include/dummy/chat.h	1970-01-01 00:00:00 +0000
2708
+++ examples/mfw-plugin-dummy/include/dummy/chat.h	2017-03-22 21:22:50 +0000
2709
@@ -0,0 +1,31 @@
2710
1
#ifndef DUMMY_CLI_CHAT
2711
2
#define DUMMY_CLI_CHAT
2712
3
2713
4
#include <messaging/chat.h>
2714
5
2715
6
#include <map>
2716
7
2717
8
namespace dummy
2718
9
{
2719
10
2720
11
/// @brief base class not instantiable for ContactChat, GroupChat, ...
2721
12
class Chat
2722
13
        : public messaging::Chat
2723
14
{
2724
15
public:
2725
16
    virtual ~Chat();
2726
17
    std::string download_file(std::string) override;
2727
18
    void handle_incoming_message(const messaging::Message& message);
2728
19
2729
20
protected:
2730
21
    Chat(const std::shared_ptr<messaging::Chat::Observer>& observer);
2731
22
2732
23
    void mark_message_as_delivered(const std::string &alias, uint session_id = 0);
2733
24
    void mark_message_as_read(const std::string &alias, uint session_id = 0);
2734
25
2735
26
};
2736
27
2737
28
}
2738
29
2739
30
#endif // DUMMY_CLI_CHAT
2740
31
2741
0
32
2742
=== added file 'examples/mfw-plugin-dummy/include/dummy/connection.h'
2743
--- examples/mfw-plugin-dummy/include/dummy/connection.h	1970-01-01 00:00:00 +0000
2744
+++ examples/mfw-plugin-dummy/include/dummy/connection.h	2017-03-22 21:22:50 +0000
2745
@@ -0,0 +1,98 @@
2746
1
#ifndef DUMMY_CLI_CONNECTION_H_
2747
2
#define DUMMY_CLI_CONNECTION_H_
2748
3
2749
4
#include <dummy/visibility.h>
2750
5
2751
6
#include <dummy/messenger.h>
2752
7
#include <dummy/presence_manager.h>
2753
8
#include <dummy/group_starter.h>
2754
9
2755
10
#include <messaging/associative_dictionary.h>
2756
11
#include <messaging/connection.h>
2757
12
2758
13
2759
14
namespace messaging
2760
15
{
2761
16
// Handy fw declarations
2762
17
class Variant;
2763
18
class BoostVariant;
2764
19
}
2765
20
2766
21
class Connection;
2767
22
2768
23
namespace dummy
2769
24
{
2770
25
2771
26
class Connector;
2772
27
2773
28
/// @brief Connection models an active, logged in session with DUMMY server.
2774
29
class DUMMY_PUBLIC Connection : public messaging::Connection, public std::enable_shared_from_this<Connection>
2775
30
{
2776
31
public:
2777
32
2778
33
    /// @brief Constructs a new connection instance with the given connector as parent.
2779
34
    ///
2780
35
    /// Attempts a login on construction.
2781
36
    ///
2782
37
    /// @throws dummy::Error if there are any issues logging in to the DUMMY server.
2783
38
    Connection(const std::shared_ptr<messaging::Connection::Observer>& connection_observer,
2784
39
               const std::shared_ptr<messaging::Messenger::Observer>& messenger_observer,
2785
40
               const std::shared_ptr<messaging::PresenceManager::Observer>& presence_observer,
2786
41
               const messaging::Dictionary<std::string, messaging::Variant>& dict,
2787
42
               Connector *connector);
2788
43
2789
44
    /// @brief ~Connection frees up all resources and logs out from the DUMMY server.
2790
45
    ~Connection();
2791
46
2792
47
    /// @brief presence_manager returns a mutable reference to an instance of Presence
2793
48
    std::shared_ptr<messaging::PresenceManager> presence_manager() override;
2794
49
2795
50
    /// @brief messenger returns a mutable reference to an instance of Messenger.
2796
51
    std::shared_ptr<messaging::Messenger> messenger() override;
2797
52
2798
53
    /// @brief group_starter returns a mutable referece to an instance of GroupStarter
2799
54
    std::shared_ptr<messaging::GroupStarter> group_starter() override;
2800
55
2801
56
    /// @brief returns identifier of current plugin user
2802
57
    std::string self_identifier() override;
2803
58
2804
59
    /// @brief login log in to server
2805
60
    void connect() override;
2806
61
2807
62
    /// @brief logout logs out from server
2808
63
    void disconnect(messaging::Connection::StatusChangedReason reason) override;
2809
64
2810
65
    /// @brief change_status changes the current status of connection to the server
2811
66
    void set_status(Status new_status, StatusChangedReason reason = StatusChangedReason::not_specified);
2812
67
2813
68
    /// @brief request_presence request the current state for a peer
2814
69
    void request_presence(const std::string& sip_uri);
2815
70
2816
71
    /// @brief normalize_identifier unifies the format of an identifier
2817
72
    std::string normalize_identifier(const std::string& id) override;
2818
73
2819
74
    /// @brief checks if an identifier is valid
2820
75
    bool is_valid_identifier(const std::string &id) override;
2821
76
2822
77
private:
2823
78
2824
79
    /// @brief parent reference
2825
80
    Connector* connector_;
2826
81
2827
82
    /// @brief The messenger instance for managing IM messages
2828
83
    std::shared_ptr<Messenger> messenger_;
2829
84
    /// @brief the instance to manage the presence
2830
85
    std::shared_ptr<PresenceManager> presence_manager_;
2831
86
    /// @brief the instance to manage the group creation/acceptance/rejoin
2832
87
    std::shared_ptr<GroupStarter> group_starter_;
2833
88
2834
89
    std::shared_ptr<messaging::Messenger::Observer> messenger_observer_;
2835
90
2836
91
    std::string account;
2837
92
    std::string password;
2838
93
};
2839
94
}
2840
95
2841
96
2842
97
2843
98
#endif  // DUMMY_CLI_CONNECTION_H_
2844
0
99
2845
=== added file 'examples/mfw-plugin-dummy/include/dummy/connector.h'
2846
--- examples/mfw-plugin-dummy/include/dummy/connector.h	1970-01-01 00:00:00 +0000
2847
+++ examples/mfw-plugin-dummy/include/dummy/connector.h	2017-03-22 21:22:50 +0000
2848
@@ -0,0 +1,58 @@
2849
1
#ifndef DUMMY_CLI_CONNECTOR_H_
2850
2
#define DUMMY_CLI_CONNECTOR_H_
2851
3
2852
4
#include <dummy/visibility.h>
2853
5
2854
6
#include <messaging/connector.h>
2855
7
#include <messaging/messenger.h>
2856
8
#include <messaging/enumerator.h>
2857
9
#include <messaging/associative_dictionary.h>
2858
10
2859
11
2860
12
namespace messaging
2861
13
{
2862
14
// Handy fw declarations
2863
15
class Variant;
2864
16
class BoostVariant;
2865
17
}
2866
18
2867
19
namespace dummy
2868
20
{
2869
21
2870
22
// Handy fw declarations
2871
23
class Connection;
2872
24
2873
25
class DUMMY_PUBLIC Connector : public messaging::Connector
2874
26
{
2875
27
public:
2876
28
2877
29
    // create returns a new shared instance of Connector.
2878
30
    static std::shared_ptr<Connector> create();
2879
31
    virtual ~Connector();
2880
32
2881
33
    void run() override;
2882
34
    void stop() override;
2883
35
    bool network_monitor_enabled() override;
2884
36
    const messaging::Enumerator<messaging::Parameter>& parameters() const override;
2885
37
    std::shared_ptr<messaging::Connection> request_connection(
2886
38
        const std::shared_ptr<messaging::Connection::Observer>& connection_observer,
2887
39
        const std::shared_ptr<messaging::Messenger::Observer>& messenger_observer,
2888
40
        const std::shared_ptr<messaging::PresenceManager::Observer>& presence_observer,
2889
41
        const messaging::Dictionary<std::string, messaging::Variant>& dict =
2890
42
            messaging::AssociativeDictionary<std::string, messaging::BoostVariant, messaging::Variant>()) override;
2891
43
2892
44
    void release_connection(const std::weak_ptr<Connection>& connection);
2893
45
2894
46
private:
2895
47
    Connector();
2896
48
2897
49
    static Connector*& mutable_instance();
2898
50
    static Connector* instance();
2899
51
2900
52
    messaging::StdVectorEnumerator<messaging::Parameter> params_enum_;
2901
53
    std::set<std::weak_ptr<Connection>, std::owner_less<std::weak_ptr<Connection>>> connections_;
2902
54
};
2903
55
}
2904
56
2905
57
2906
58
#endif  // DUMMY_CLI_CONNECTOR_H_
2907
0
59
2908
=== added file 'examples/mfw-plugin-dummy/include/dummy/contact_chat.h'
2909
--- examples/mfw-plugin-dummy/include/dummy/contact_chat.h	1970-01-01 00:00:00 +0000
2910
+++ examples/mfw-plugin-dummy/include/dummy/contact_chat.h	2017-03-22 21:22:50 +0000
2911
@@ -0,0 +1,54 @@
2912
1
#ifndef DUMMY_CLI_CONTACT_CHAT_H
2913
2
#define DUMMY_CLI_CONTACT_CHAT_H
2914
3
2915
4
#include <messaging/user.h>
2916
5
2917
6
#include <dummy/visibility.h>
2918
7
2919
8
#include <dummy/chat.h>
2920
9
#include <dummy/user.h>
2921
10
2922
11
namespace dummy
2923
12
{
2924
13
// Handy fw declarations
2925
14
class Connector;
2926
15
class Message;
2927
16
2928
17
2929
18
2930
19
class DUMMY_PUBLIC ContactChat
2931
20
        : public Chat
2932
21
{
2933
22
  public:
2934
23
2935
24
    /// @brief Creates a new instance configuring the given user as recipient.
2936
25
    static std::shared_ptr<ContactChat> create(const User& user,
2937
26
                                               const std::shared_ptr<messaging::Chat::Observer>& observer);
2938
27
2939
28
    /// @brief Creates a new instance translating the given recipient to a user.
2940
29
    static std::shared_ptr<ContactChat> create(const messaging::User::shared_ptr& user,
2941
30
                                               const std::shared_ptr<messaging::Chat::Observer>& observer);
2942
31
2943
32
2944
33
    /// @brief send_message enqueues the given message for delivery.
2945
34
    /// @returns a numeric identifier referencing back to the delivery request.
2946
35
    /// @throws std::runtime_error in case of issues.
2947
36
    std::string send_message(const messaging::Message& message) override;
2948
37
    void mark_message_as_read(const std::string& message_id) override;
2949
38
    void start_typing() override;
2950
39
    void end_typing() override;
2951
40
2952
41
private:
2953
42
    /// @brief Creates a new instance configuring the given user as recipient.
2954
43
    ContactChat(const User& user,
2955
44
                const std::shared_ptr<messaging::Chat::Observer>& observer);
2956
45
    /// @brief Creates a new instance translating the given recipient to a user.
2957
46
    ContactChat(const messaging::User::shared_ptr& user,
2958
47
                const std::shared_ptr<messaging::Chat::Observer>& observer);
2959
48
2960
49
    User recipient;
2961
50
};
2962
51
}
2963
52
2964
53
2965
54
#endif // DUMMY_CLI_CONTACT_CHAT_H_
2966
0
55
2967
=== added file 'examples/mfw-plugin-dummy/include/dummy/group_chat.h'
2968
--- examples/mfw-plugin-dummy/include/dummy/group_chat.h	1970-01-01 00:00:00 +0000
2969
+++ examples/mfw-plugin-dummy/include/dummy/group_chat.h	2017-03-22 21:22:50 +0000
2970
@@ -0,0 +1,50 @@
2971
1
#ifndef DUMMY_CLI_GROUP_CHAT_H
2972
2
#define DUMMY_CLI_GROUP_CHAT_H
2973
3
2974
4
#include <dummy/visibility.h>
2975
5
2976
6
#include <dummy/chat.h>
2977
7
2978
8
namespace messaging
2979
9
{
2980
10
class Group;
2981
11
class Interface;
2982
12
}
2983
13
2984
14
namespace dummy
2985
15
{
2986
16
2987
17
// Handy fw declarations
2988
18
class GroupManager;
2989
19
2990
20
class DUMMY_PUBLIC GroupChat
2991
21
        : public Chat
2992
22
{
2993
23
public:
2994
24
2995
25
    /// @brief Creates a new instance translating the given recipient to a user.
2996
26
    static std::shared_ptr<GroupChat> create(const std::shared_ptr<messaging::Group> &group,
2997
27
                                             const std::shared_ptr<messaging::Chat::Observer>& observer);
2998
28
2999
29
    /// @brief send_message enqueues the given message for delivery.
3000
30
    /// @returns a numeric identifier referencing back to the delivery request.
3001
31
    /// @throws std::runtime_error in case of issues.
3002
32
    std::string send_message(const messaging::Message& message) override;
3003
33
    void mark_message_as_read(const std::string& message_token) override;
3004
34
    void start_typing() override;
3005
35
    void end_typing() override;
3006
36
3007
37
    void mark_message_as_delivered(const std::string& message_token);
3008
38
    std::string id();
3009
39
3010
40
private:
3011
41
    /// @brief Creates a new instance translating the given recipient to a user.
3012
42
    GroupChat(const std::shared_ptr<messaging::Group> &group,
3013
43
              const std::shared_ptr<messaging::Chat::Observer>& observer);
3014
44
3015
45
    std::string channel_id;
3016
46
};
3017
47
3018
48
}
3019
49
3020
50
#endif // DUMMY_CLI_GROUP_CHAT_H
3021
0
51
3022
=== added file 'examples/mfw-plugin-dummy/include/dummy/group_manager.h'
3023
--- examples/mfw-plugin-dummy/include/dummy/group_manager.h	1970-01-01 00:00:00 +0000
3024
+++ examples/mfw-plugin-dummy/include/dummy/group_manager.h	2017-03-22 21:22:50 +0000
3025
@@ -0,0 +1,72 @@
3026
1
#ifndef DUMMY_CLI_CHAT_GROUP_MANAGER_H
3027
2
#define DUMMY_CLI_CHAT_GROUP_MANAGER_H
3028
3
3029
4
#include <dummy/visibility.h>
3030
5
3031
6
#include <messaging/group_manager.h>
3032
7
#include <messaging/members.h>
3033
8
3034
9
namespace messaging
3035
10
{
3036
11
// Handy fw declarations
3037
12
class Group;
3038
13
class HasInterfaces;
3039
14
}
3040
15
3041
16
namespace dummy
3042
17
{
3043
18
3044
19
// Handy fw declaration
3045
20
class Messenger;
3046
21
class GroupChat;
3047
22
3048
23
3049
24
class DUMMY_PUBLIC GroupManager
3050
25
        : public messaging::GroupManager
3051
26
        , public std::enable_shared_from_this<GroupManager>
3052
27
{
3053
28
public:
3054
29
3055
30
    /// @brief Creates a new chat group manager configuring the given user as recipient.
3056
31
    static std::shared_ptr<GroupManager> create(const std::shared_ptr<messaging::Group>& group,
3057
32
                                                const std::shared_ptr<Messenger>& messenger);
3058
33
3059
34
    virtual ~GroupManager();
3060
35
3061
36
    std::string group_id() override;
3062
37
    std::string group_title() override;
3063
38
    std::string group_subject() override;
3064
39
    bool persistent() override;
3065
40
    std::shared_ptr<messaging::Member> group_creator() override;
3066
41
    std::set<std::string> group_admins() override;
3067
42
    messaging::Members members() override;
3068
43
3069
44
    void leave_group() override;
3070
45
    void dissolve_group() override;
3071
46
    void change_group_title(const std::string& new_title) override;
3072
47
    void change_group_subject(const std::string& new_subject) override;
3073
48
    void add_members(const messaging::Members& users) override;
3074
49
    void remove_members(const messaging::Members& users) override;
3075
50
3076
51
    void set_group_permissions(bool is_chairman);
3077
52
3078
53
    void set_observer(const std::shared_ptr<Observer> &observer);
3079
54
3080
55
private:
3081
56
    /// @brief Creates a new instance of chat group manager
3082
57
    GroupManager(const std::shared_ptr<messaging::Group>& group,
3083
58
                 const std::shared_ptr<Messenger>& messenger);
3084
59
3085
60
    void on_plugged(const std::weak_ptr<messaging::HasInterfaces> &where) override;
3086
61
3087
62
3088
63
    std::weak_ptr<Messenger> messenger_;
3089
64
    std::weak_ptr<GroupChat> chat_;
3090
65
    std::string id;
3091
66
    messaging::Members participants;
3092
67
    std::string creator;
3093
68
3094
69
};
3095
70
3096
71
}
3097
72
#endif // DUMMY_CLI_CHAT_GROUP_MANAGER_H
3098
0
73
3099
=== added file 'examples/mfw-plugin-dummy/include/dummy/group_starter.h'
3100
--- examples/mfw-plugin-dummy/include/dummy/group_starter.h	1970-01-01 00:00:00 +0000
3101
+++ examples/mfw-plugin-dummy/include/dummy/group_starter.h	2017-03-22 21:22:50 +0000
3102
@@ -0,0 +1,52 @@
3103
1
#ifndef DUMMY_CLI_GROUP_STARTER
3104
2
#define DUMMY_CLI_GROUP_STARTER
3105
3
3106
4
#include <dummy/visibility.h>
3107
5
3108
6
#include <messaging/group_starter.h>
3109
7
#include <messaging/members.h>
3110
8
3111
9
#include <map>
3112
10
3113
11
namespace messaging
3114
12
{
3115
13
// Handy fw declarations
3116
14
class GroupManager;
3117
15
class Group;
3118
16
class Broadcast;
3119
17
}
3120
18
3121
19
namespace dummy
3122
20
{
3123
21
3124
22
class Messenger;
3125
23
class GroupManager;
3126
24
3127
25
3128
26
class DUMMY_PUBLIC GroupStarter
3129
27
        : public messaging::GroupStarter
3130
28
        , public std::enable_shared_from_this<GroupStarter>
3131
29
{
3132
30
public:
3133
31
3134
32
    static std::shared_ptr<GroupStarter> create(const std::shared_ptr<Messenger>& messenger);
3135
33
3136
34
    std::shared_ptr<messaging::GroupManager> create_group(const std::shared_ptr<messaging::Group> &group) override;
3137
35
    std::shared_ptr<messaging::GroupManager> accept_group(const std::shared_ptr<messaging::Group> &group) override;
3138
36
    std::shared_ptr<messaging::GroupManager> rejoin_group(const std::shared_ptr<messaging::Group> &group) override;
3139
37
    void reject_group(const std::shared_ptr<messaging::Group> &group) override;
3140
38
    std::shared_ptr<messaging::Broadcast> create_broadcast(const messaging::Members& recipients);
3141
39
    std::map<std::string, std::shared_ptr<dummy::GroupManager>> group_managers();
3142
40
3143
41
private:
3144
42
    GroupStarter(const std::shared_ptr<Messenger>& messenger);
3145
43
3146
44
    std::weak_ptr<Messenger> messenger_;
3147
45
    std::map<std::string, std::shared_ptr<dummy::GroupManager>> group_managers_;
3148
46
3149
47
};
3150
48
3151
49
}
3152
50
3153
51
#endif // DUMMY_CLI_GROUP_STARTER
3154
52
3155
0
53
3156
=== added file 'examples/mfw-plugin-dummy/include/dummy/messenger.h'
3157
--- examples/mfw-plugin-dummy/include/dummy/messenger.h	1970-01-01 00:00:00 +0000
3158
+++ examples/mfw-plugin-dummy/include/dummy/messenger.h	2017-03-22 21:22:50 +0000
3159
@@ -0,0 +1,50 @@
3160
1
#ifndef DUMMY_CLI_MESSENGER_H_
3161
2
#define DUMMY_CLI_MESSENGER_H_
3162
3
3163
4
#include <dummy/visibility.h>
3164
5
3165
6
#include <messaging/messenger.h>
3166
7
3167
8
namespace dummy
3168
9
{
3169
10
3170
11
// Handy fw declaration
3171
12
class Message;
3172
13
class File;
3173
14
class Connector;
3174
15
class Connection;
3175
16
class GroupManager;
3176
17
3177
18
class DUMMY_PUBLIC Messenger
3178
19
        : public messaging::Messenger
3179
20
        , public std::enable_shared_from_this<Messenger>
3180
21
{
3181
22
public:
3182
23
    /// @cond
3183
24
    DEFINE_PTRS(Messenger);
3184
25
    /// @endcond
3185
26
3186
27
    static std::shared_ptr<Messenger> create(const std::shared_ptr<Messenger::Observer>& messenger_observer, const std::shared_ptr<dummy::Connection> &connection);
3187
28
3188
29
    std::shared_ptr<messaging::Chat> create_chat_with(const messaging::Recipient::shared_ptr& recipient, const std::shared_ptr<messaging::Chat::Observer>& observer) override;
3189
30
3190
31
    void handle_incoming_message(const std::string &sender, const std::string &message);
3191
32
    void handle_incoming_channel_message(const std::string &channel, const std::string &sender, const std::string &message);
3192
33
    std::shared_ptr<GroupManager> get_group_manager(const std::string &group_chat_id);
3193
34
    void handle_join_new_channel(const std::string &channel);
3194
35
    void handle_join_new_channel(const std::string &channel, const std::string &the_creator);
3195
36
    void remove_chat(const std::string &chat_id);
3196
37
3197
38
    std::shared_ptr<dummy::Connection> connection;
3198
39
private:
3199
40
    Messenger(const std::shared_ptr<messaging::Messenger::Observer>& observer, const std::shared_ptr<dummy::Connection> &connection);
3200
41
3201
42
    /// @brief identity provider to correlate msg_id with imdn unique identifier. First will be
3202
43
    /// used internally for chat messages and the other used as message external unique id
3203
44
    /// @brief maintains the history of managed messages correlated to their unique_id
3204
45
    void send_delivery_notification(const std::shared_ptr<Message>& message);
3205
46
};
3206
47
}
3207
48
3208
49
3209
50
#endif  // DUMMY_CLI_MESSENGER_H_
3210
0
51
3211
=== added file 'examples/mfw-plugin-dummy/include/dummy/presence_manager.h'
3212
--- examples/mfw-plugin-dummy/include/dummy/presence_manager.h	1970-01-01 00:00:00 +0000
3213
+++ examples/mfw-plugin-dummy/include/dummy/presence_manager.h	2017-03-22 21:22:50 +0000
3214
@@ -0,0 +1,40 @@
3215
1
#ifndef DUMMY_CLI_PRESENCE_MANAGER_H
3216
2
#define DUMMY_CLI_PRESENCE_MANAGER_H
3217
3
3218
4
#include <dummy/visibility.h>
3219
5
3220
6
#include <messaging/presence_manager.h>
3221
7
3222
8
#include <memory>
3223
9
3224
10
namespace dummy
3225
11
{
3226
12
3227
13
class Connector;
3228
14
3229
15
class DUMMY_PUBLIC PresenceManager : public messaging::PresenceManager, public std::enable_shared_from_this<PresenceManager>
3230
16
{
3231
17
public:
3232
18
3233
19
    static std::shared_ptr<PresenceManager> create(const std::shared_ptr<messaging::PresenceManager::Observer>& observer,
3234
20
                                                   Connector *connector);
3235
21
3236
22
    StatusMap get_valid_statuses() override;
3237
23
    void set_self_presence(const std::string& status, const std::string& status_message = "") override;
3238
24
    void request_presence(const std::shared_ptr<messaging::Recipient>& recipient) override;
3239
25
3240
26
private:
3241
27
    /// @brief Messenger constructs a new instance, installing the given observer instance.
3242
28
    PresenceManager(const std::shared_ptr<Observer>& observer,
3243
29
                    Connector* connector);
3244
30
3245
31
    messaging::Presence create_presence(const std::string& status, const std::string& status_message = "");
3246
32
3247
33
    Connector *connector_;
3248
34
    StatusMap statuses_;
3249
35
};
3250
36
3251
37
}
3252
38
3253
39
3254
40
#endif // DUMMY_CLI_PRESENCE_MANAGER_H
3255
0
41
3256
=== added file 'examples/mfw-plugin-dummy/include/dummy/recipient.h'
3257
--- examples/mfw-plugin-dummy/include/dummy/recipient.h	1970-01-01 00:00:00 +0000
3258
+++ examples/mfw-plugin-dummy/include/dummy/recipient.h	2017-03-22 21:22:50 +0000
3259
@@ -0,0 +1,19 @@
3260
1
#ifndef DUMMY_CLI_RECIPIENT_H
3261
2
#define DUMMY_CLI_RECIPIENT_H
3262
3
3263
4
#include <messaging/recipient.h>
3264
5
3265
6
namespace dummy
3266
7
{
3267
8
3268
9
3269
10
class Recipient : public messaging::Recipient
3270
11
{
3271
12
public:
3272
13
    Recipient() : messaging::Recipient{}
3273
14
};
3274
15
3275
16
3276
17
}
3277
18
3278
19
#endif // DUMMY_CLI_RECIPIENT_H
3279
0
20
3280
=== added file 'examples/mfw-plugin-dummy/include/dummy/user.h'
3281
--- examples/mfw-plugin-dummy/include/dummy/user.h	1970-01-01 00:00:00 +0000
3282
+++ examples/mfw-plugin-dummy/include/dummy/user.h	2017-03-22 21:22:50 +0000
3283
@@ -0,0 +1,31 @@
3284
1
#ifndef DUMMY_CLI_USER_H_
3285
2
#define DUMMY_CLI_USER_H_
3286
3
3287
4
#include <dummy/visibility.h>
3288
5
3289
6
#include <memory>
3290
7
3291
8
#include <map>
3292
9
3293
10
namespace messaging
3294
11
{
3295
12
// A handy fw declaration
3296
13
class Recipient;
3297
14
}
3298
15
3299
16
namespace dummy
3300
17
{
3301
18
3302
19
3303
20
/// @brief User models a subscriber to DUMMY services.
3304
21
struct DUMMY_PUBLIC User
3305
22
{
3306
23
    std::string username;      ///< dummy username
3307
24
3308
25
    static User from_recipient(const std::shared_ptr<messaging::Recipient>& recipient);
3309
26
    std::shared_ptr<messaging::Recipient> to_recipient() const;
3310
27
};
3311
28
}
3312
29
3313
30
3314
31
#endif  // DUMMY_CLI_USER_H_
3315
0
32
3316
=== added file 'examples/mfw-plugin-dummy/include/dummy/visibility.h'
3317
--- examples/mfw-plugin-dummy/include/dummy/visibility.h	1970-01-01 00:00:00 +0000
3318
+++ examples/mfw-plugin-dummy/include/dummy/visibility.h	2017-03-22 21:22:50 +0000
3319
@@ -0,0 +1,7 @@
3320
1
#ifndef DUMMY_VISIBILITY_H_
3321
2
#define DUMMY_VISIBILITY_H_
3322
3
3323
4
#define DUMMY_PUBLIC __attribute__((visibility("default")))
3324
5
#define DUMMY_LOCAL __attribute__((visibility("hidden")))
3325
6
3326
7
#endif  // DUMMY_VISIBILITY_H_
3327
0
8
3328
=== added directory 'examples/mfw-plugin-dummy/src'
3329
=== added file 'examples/mfw-plugin-dummy/src/CMakeLists.txt'
3330
--- examples/mfw-plugin-dummy/src/CMakeLists.txt	1970-01-01 00:00:00 +0000
3331
+++ examples/mfw-plugin-dummy/src/CMakeLists.txt	2017-03-22 21:22:50 +0000
3332
@@ -0,0 +1,43 @@
3333
1
set(PLUGIN_NAME mfw-plugin-dummy)
3334
2
3335
3
add_library(${PLUGIN_NAME} SHARED
3336
4
3337
5
    ${PLUGIN_MOCS}
3338
6
3339
7
    dummy/group_manager.cpp
3340
8
    dummy/chat.cpp
3341
9
    dummy/connection.cpp
3342
10
    dummy/connector.cpp
3343
11
    dummy/contact_chat.cpp
3344
12
    dummy/group_starter.cpp
3345
13
    dummy/messenger.cpp
3346
14
    dummy/group_chat.cpp
3347
15
    dummy/presence_manager.cpp
3348
16
    dummy/user.cpp
3349
17
)
3350
18
3351
19
set_target_properties(${PLUGIN_NAME} PROPERTIES VERSION ${SO_VERSION} SOVERSION ${SO_VERSION_MAJOR})
3352
20
set (PLUGIN_LINK_LIBRARIES
3353
21
    ${MESSAGING_FW_LIBRARIES}
3354
22
    Qt5::Core
3355
23
    Qt5::DBus
3356
24
    ${ACCOUNTS_LDFLAGS}
3357
25
    ${ZLIB_LIBRARIES}
3358
26
    ${GLog_LIBRARY}
3359
27
    ${Boost_LIBRARIES}
3360
28
    ${PROCESS_CPP_LDFLAGS}
3361
29
    ${CPPNETLIB_LIBRARIES}
3362
30
    -lpthread
3363
31
)
3364
32
3365
33
if(IS_MF_BUILD)
3366
34
    set (PLUGIN_LINK_LIBRARIES ${PLUGIN_LINK_LIBRARIES} messaging-framework)
3367
35
endif()
3368
36
3369
37
target_link_libraries(${PLUGIN_NAME}
3370
38
    ${PLUGIN_LINK_LIBRARIES}
3371
39
)
3372
40
3373
41
install(
3374
42
    TARGETS ${PLUGIN_NAME}
3375
43
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/messaging-framework)
3376
0
44
3377
=== added directory 'examples/mfw-plugin-dummy/src/dummy'
3378
=== added file 'examples/mfw-plugin-dummy/src/dummy/chat.cpp'
3379
--- examples/mfw-plugin-dummy/src/dummy/chat.cpp	1970-01-01 00:00:00 +0000
3380
+++ examples/mfw-plugin-dummy/src/dummy/chat.cpp	2017-03-22 21:22:50 +0000
3381
@@ -0,0 +1,30 @@
3382
1
#include <dummy/chat.h>
3383
2
3384
3
#include <glog/logging.h>
3385
4
3386
5
dummy::Chat::Chat(const std::shared_ptr<messaging::Chat::Observer>& observer)
3387
6
    : messaging::Chat{observer}
3388
7
{
3389
8
}
3390
9
3391
10
dummy::Chat::~Chat()
3392
11
{
3393
12
}
3394
13
3395
14
3396
15
std::string dummy::Chat::download_file(std::string alias)
3397
16
{
3398
17
}
3399
18
3400
19
void dummy::Chat::mark_message_as_delivered(const std::string &alias, uint session_id)
3401
20
{
3402
21
}
3403
22
3404
23
void dummy::Chat::mark_message_as_read(const std::string &alias, uint session_id)
3405
24
{
3406
25
}
3407
26
3408
27
void dummy::Chat::handle_incoming_message(const messaging::Message& message)
3409
28
{
3410
29
    announce_message_received(message);
3411
30
}
3412
0
31
3413
=== added file 'examples/mfw-plugin-dummy/src/dummy/connection.cpp'
3414
--- examples/mfw-plugin-dummy/src/dummy/connection.cpp	1970-01-01 00:00:00 +0000
3415
+++ examples/mfw-plugin-dummy/src/dummy/connection.cpp	2017-03-22 21:22:50 +0000
3416
@@ -0,0 +1,132 @@
3417
1
#include <dummy/connection.h>
3418
2
#include <dummy/connector.h>
3419
3
#include <dummy/group_manager.h>
3420
4
#include <dummy/group_chat.h>
3421
5
3422
6
#include <glog/logging.h>
3423
7
3424
8
#include <messaging/parameter.h>
3425
9
#include <messaging/group.h>
3426
10
3427
11
using namespace std;
3428
12
3429
13
dummy::Connection::Connection(const std::shared_ptr<messaging::Connection::Observer>& connection_observer,
3430
14
                           const std::shared_ptr<messaging::Messenger::Observer>& messenger_observer,
3431
15
                           const std::shared_ptr<messaging::PresenceManager::Observer>& presence_observer,
3432
16
                           const messaging::Dictionary<std::string, messaging::Variant>& dict,
3433
17
                           Connector *connector)
3434
18
    : messaging::Connection{connection_observer}
3435
19
    , connector_{connector}
3436
20
    , presence_manager_(PresenceManager::create(presence_observer, connector))
3437
21
    , messenger_observer_(messenger_observer)
3438
22
{
3439
23
    messaging::Parameter account_param{"account", "s", messaging::Parameter::Flags::required|messaging::Parameter::Flags::required_for_registration};
3440
24
    messaging::Parameter password_param{"password", "s", messaging::Parameter::Flags::secret};
3441
25
3442
26
    if (account_param.can_extract_from(dict))
3443
27
    {
3444
28
        account = account_param.extract_from(dict).as_string();
3445
29
        if (account.empty())
3446
30
        {
3447
31
            throw std::runtime_error{"account could not be found"};
3448
32
        }
3449
33
    }
3450
34
    else
3451
35
    {
3452
36
        throw std::runtime_error{"account could not be found"};
3453
37
    }
3454
38
3455
39
    if (password_param.can_extract_from(dict))
3456
40
    {
3457
41
        password = password_param.extract_from(dict).as_string();
3458
42
    }
3459
43
}
3460
44
3461
45
dummy::Connection::~Connection()
3462
46
{
3463
47
3464
48
}
3465
49
3466
50
std::string dummy::Connection::self_identifier()
3467
51
{
3468
52
    return account;
3469
53
}
3470
54
3471
55
shared_ptr<messaging::PresenceManager> dummy::Connection::presence_manager()
3472
56
{
3473
57
    return presence_manager_;
3474
58
}
3475
59
3476
60
shared_ptr<messaging::Messenger> dummy::Connection::messenger()
3477
61
{
3478
62
    return messenger_;
3479
63
}
3480
64
3481
65
std::shared_ptr<messaging::GroupStarter> dummy::Connection::group_starter()
3482
66
{
3483
67
    return group_starter_;
3484
68
}
3485
69
3486
70
void dummy::Connection::connect()
3487
71
{
3488
72
    LOG(INFO) << this << __PRETTY_FUNCTION__;
3489
73
3490
74
    // initiate other components
3491
75
    messenger_ = Messenger::create(messenger_observer_, shared_from_this());
3492
76
    group_starter_ = dummy::GroupStarter::create(messenger_);
3493
77
3494
78
    // Do something here to actually connect the account
3495
79
3496
80
    set_status(Status::connecting, StatusChangedReason::requested);
3497
81
}
3498
82
3499
83
void dummy::Connection::disconnect(messaging::Connection::StatusChangedReason reason)
3500
84
{
3501
85
    LOG(INFO) << this << __PRETTY_FUNCTION__;
3502
86
    try
3503
87
    {
3504
88
        set_status(Status::disconnected, reason);
3505
89
    }
3506
90
    catch (const std::runtime_error &e)
3507
91
    {
3508
92
        LOG(ERROR) << "disconnect failed: " << e.what();
3509
93
    }
3510
94
}
3511
95
3512
96
void dummy::Connection::set_status(Status new_status, StatusChangedReason reason)
3513
97
{
3514
98
    try
3515
99
    {
3516
100
        announce_status_changed(new_status, reason);
3517
101
3518
102
        switch (new_status)
3519
103
        {
3520
104
        case Status::connected:
3521
105
            break;
3522
106
        case Status::connecting:
3523
107
            break;
3524
108
        case Status::disconnected:
3525
109
            if (connector_) {
3526
110
                connector_->release_connection(shared_from_this());
3527
111
            }
3528
112
            break;
3529
113
        default:
3530
114
            break;
3531
115
        }
3532
116
    }
3533
117
    catch (const std::runtime_error &e)
3534
118
    {
3535
119
        LOG(ERROR) << "set_status failed: " << e.what();
3536
120
    }
3537
121
}
3538
122
3539
123
std::string dummy::Connection::normalize_identifier(const std::string &id)
3540
124
{
3541
125
    // dummy plugin does not require normalization
3542
126
    return id;
3543
127
}
3544
128
3545
129
bool dummy::Connection::is_valid_identifier(const std::string &id)
3546
130
{
3547
131
    return !id.empty();
3548
132
}
3549
0
133
3550
=== added file 'examples/mfw-plugin-dummy/src/dummy/connector.cpp'
3551
--- examples/mfw-plugin-dummy/src/dummy/connector.cpp	1970-01-01 00:00:00 +0000
3552
+++ examples/mfw-plugin-dummy/src/dummy/connector.cpp	2017-03-22 21:22:50 +0000
3553
@@ -0,0 +1,95 @@
3554
1
#include <dummy/connector.h>
3555
2
#include <dummy/connection.h>
3556
3
3557
4
#include <messaging/enumerator.h>
3558
5
#include <messaging/parameter.h>
3559
6
#include <messaging/plugin.h>
3560
7
3561
8
#include <messaging/boost/variant.h>
3562
9
3563
10
#include <glog/logging.h>
3564
11
3565
12
std::shared_ptr<dummy::Connector> dummy::Connector::create()
3566
13
{
3567
14
    return std::shared_ptr<Connector>(new Connector());
3568
15
}
3569
16
3570
17
dummy::Connector::Connector() :
3571
18
    params_enum_{
3572
19
          std::vector<messaging::Parameter>{messaging::Parameter{"account", "s", messaging::Parameter::Flags::required|messaging::Parameter::Flags::required_for_registration},
3573
20
                                            messaging::Parameter{"password", "s", messaging::Parameter::Flags::secret}}}
3574
21
{
3575
22
    mutable_instance() = this;
3576
23
}
3577
24
3578
25
dummy::Connector::~Connector()
3579
26
{
3580
27
    mutable_instance() = nullptr;
3581
28
}
3582
29
3583
30
void dummy::Connector::run()
3584
31
{
3585
32
   LOG(INFO) << "dummy::Connector::run";
3586
33
}
3587
34
3588
35
void dummy::Connector::stop()
3589
36
{
3590
37
   LOG(INFO) << "dummy::Connector::stop";
3591
38
}
3592
39
3593
40
std::shared_ptr<messaging::Connection> dummy::Connector::request_connection(const std::shared_ptr<messaging::Connection::Observer>& connection_observer,
3594
41
                                                                    const std::shared_ptr<messaging::Messenger::Observer>& messenger_observer,
3595
42
                                                                    const std::shared_ptr<messaging::PresenceManager::Observer>& presence_observer,
3596
43
                                                                    const messaging::Dictionary<std::string, messaging::Variant>& dict)
3597
44
{    
3598
45
    auto connection = std::make_shared<dummy::Connection>(connection_observer,
3599
46
                                       messenger_observer,
3600
47
                                       presence_observer,
3601
48
                                       dict,
3602
49
                                       this);
3603
50
    connections_.insert(connection);
3604
51
    return connection;
3605
52
}
3606
53
3607
54
void dummy::Connector::release_connection(const std::weak_ptr<Connection>& connection)
3608
55
{
3609
56
    auto it = connections_.find(connection);
3610
57
    if (it != connections_.end())
3611
58
    {
3612
59
        connections_.erase(it);
3613
60
    }
3614
61
}
3615
62
3616
63
const messaging::Enumerator<messaging::Parameter>& dummy::Connector::parameters() const
3617
64
{
3618
65
    return params_enum_;
3619
66
}
3620
67
3621
68
bool dummy::Connector::network_monitor_enabled()
3622
69
{
3623
70
    return false;
3624
71
}
3625
72
3626
73
dummy::Connector*& dummy::Connector::mutable_instance()
3627
74
{
3628
75
    static Connector* instance{nullptr};
3629
76
    return instance;
3630
77
}
3631
78
3632
79
dummy::Connector* dummy::Connector::instance()
3633
80
{
3634
81
    return mutable_instance();
3635
82
}
3636
83
3637
84
// Integrate with the messaging fw plugin runtime.
3638
85
messaging::Connector* MESSAGING_FW_CREATE_FUNCTION()
3639
86
{
3640
87
    static auto instance = dummy::Connector::create();
3641
88
    return instance.get();
3642
89
}
3643
90
3644
91
void MESSAGING_FW_DESTROY_FUNCTION(messaging::Connector*)
3645
92
{
3646
93
    // Empty on purpose.
3647
94
}
3648
95
3649
0
96
3650
=== added file 'examples/mfw-plugin-dummy/src/dummy/contact_chat.cpp'
3651
--- examples/mfw-plugin-dummy/src/dummy/contact_chat.cpp	1970-01-01 00:00:00 +0000
3652
+++ examples/mfw-plugin-dummy/src/dummy/contact_chat.cpp	2017-03-22 21:22:50 +0000
3653
@@ -0,0 +1,58 @@
3654
1
#include <dummy/contact_chat.h>
3655
2
3656
3
#include <messaging/message.h>
3657
4
#include <messaging/recipient.h>
3658
5
3659
6
#include <glog/logging.h>
3660
7
3661
8
using namespace std;
3662
9
3663
10
shared_ptr<dummy::ContactChat> dummy::ContactChat::create(const User& user,
3664
11
                                                    const shared_ptr<messaging::Chat::Observer>& observer)
3665
12
{
3666
13
    shared_ptr<dummy::ContactChat> chat(new dummy::ContactChat{user, observer});
3667
14
    return chat;
3668
15
}
3669
16
3670
17
shared_ptr<dummy::ContactChat> dummy::ContactChat::create(const messaging::User::shared_ptr& user,
3671
18
                                                    const shared_ptr<messaging::Chat::Observer>& observer)
3672
19
{
3673
20
    shared_ptr<dummy::ContactChat> chat(new dummy::ContactChat{user, observer});
3674
21
    return chat;
3675
22
}
3676
23
3677
24
dummy::ContactChat::ContactChat(const User& user,
3678
25
                             const shared_ptr<messaging::Chat::Observer>& observer)
3679
26
    : Chat{observer}
3680
27
    , recipient(user)
3681
28
{
3682
29
}
3683
30
3684
31
dummy::ContactChat::ContactChat(const messaging::User::shared_ptr& user,
3685
32
                             const shared_ptr<messaging::Chat::Observer>& observer)
3686
33
        : ContactChat{User::from_recipient(user), observer}
3687
34
{
3688
35
}
3689
36
3690
37
void dummy::ContactChat::mark_message_as_read(const string &alias)
3691
38
{
3692
39
    // Not supported on DUMMY
3693
40
}
3694
41
3695
42
void dummy::ContactChat::start_typing()
3696
43
{
3697
44
    // Typing signal not supported on DUMMY
3698
45
}
3699
46
3700
47
void dummy::ContactChat::end_typing()
3701
48
{
3702
49
    // Typing signal not supported on DUMMY
3703
50
}
3704
51
3705
52
string dummy::ContactChat::send_message(const messaging::Message& message)
3706
53
{
3707
54
    // this method is called when the ui sends a message to any user or group
3708
55
    return string();
3709
56
}
3710
57
3711
58
3712
0
59
3713
=== added file 'examples/mfw-plugin-dummy/src/dummy/group_chat.cpp'
3714
--- examples/mfw-plugin-dummy/src/dummy/group_chat.cpp	1970-01-01 00:00:00 +0000
3715
+++ examples/mfw-plugin-dummy/src/dummy/group_chat.cpp	2017-03-22 21:22:50 +0000
3716
@@ -0,0 +1,50 @@
3717
1
#include <dummy/group_chat.h>
3718
2
#include <dummy/group_manager.h>
3719
3
3720
4
#include <messaging/message.h>
3721
5
#include <messaging/group.h>
3722
6
#include <messaging/recipient.h>
3723
7
3724
8
#include <glog/logging.h>
3725
9
3726
10
std::shared_ptr<dummy::GroupChat> dummy::GroupChat::create(const std::shared_ptr<messaging::Group> &group,
3727
11
                                                     const std::shared_ptr<messaging::Chat::Observer>& observer)
3728
12
{
3729
13
    return std::shared_ptr<dummy::GroupChat>(new dummy::GroupChat{group, observer});
3730
14
}
3731
15
3732
16
dummy::GroupChat::GroupChat(const std::shared_ptr<messaging::Group> &group,
3733
17
                         const std::shared_ptr<messaging::Chat::Observer>& observer)
3734
18
        : Chat{observer}
3735
19
        , channel_id(group->id())
3736
20
{
3737
21
}
3738
22
3739
23
std::string dummy::GroupChat::send_message(const messaging::Message& message)
3740
24
{
3741
25
    // a message is being sent to this group
3742
26
    return std::string();
3743
27
}
3744
28
3745
29
void dummy::GroupChat::mark_message_as_delivered(const std::string &message_token)
3746
30
{
3747
31
    LOG(INFO) << __PRETTY_FUNCTION__ << " token:" << message_token;
3748
32
}
3749
33
3750
34
void dummy::GroupChat::mark_message_as_read(const std::string &alias)
3751
35
{
3752
36
}
3753
37
3754
38
void dummy::GroupChat::start_typing()
3755
39
{
3756
40
}
3757
41
3758
42
void dummy::GroupChat::end_typing()
3759
43
{
3760
44
}
3761
45
3762
46
std::string dummy::GroupChat::id()
3763
47
{
3764
48
    return channel_id;
3765
49
}
3766
50
3767
0
51
3768
=== added file 'examples/mfw-plugin-dummy/src/dummy/group_manager.cpp'
3769
--- examples/mfw-plugin-dummy/src/dummy/group_manager.cpp	1970-01-01 00:00:00 +0000
3770
+++ examples/mfw-plugin-dummy/src/dummy/group_manager.cpp	2017-03-22 21:22:50 +0000
3771
@@ -0,0 +1,114 @@
3772
1
#include <dummy/group_manager.h>
3773
2
3774
3
#include <dummy/messenger.h>
3775
4
#include <dummy/group_chat.h>
3776
5
#include <dummy/connection.h>
3777
6
3778
7
3779
8
#include <messaging/group.h>
3780
9
#include <messaging/user.h>
3781
10
3782
11
#include <glog/logging.h>
3783
12
3784
13
3785
14
std::shared_ptr<dummy::GroupManager> dummy::GroupManager::create(const std::shared_ptr<messaging::Group>& group,
3786
15
                                                           const std::shared_ptr<Messenger>& messenger)
3787
16
{
3788
17
    return std::shared_ptr<dummy::GroupManager>(new dummy::GroupManager{group, messenger});
3789
18
}
3790
19
3791
20
dummy::GroupManager::GroupManager(const std::shared_ptr<messaging::Group>& group,
3792
21
                               const std::shared_ptr<Messenger>& messenger)
3793
22
        : messaging::GroupManager{}
3794
23
        , messenger_{messenger}
3795
24
        , id(group->id())
3796
25
        , creator(group->creator()->id())
3797
26
{
3798
27
}
3799
28
3800
29
dummy::GroupManager::~GroupManager()
3801
30
{
3802
31
}
3803
32
3804
33
void dummy::GroupManager::on_plugged(const std::weak_ptr<messaging::HasInterfaces> &where)
3805
34
{
3806
35
    auto sp = where.lock();
3807
36
    if (sp) {
3808
37
        chat_ = std::dynamic_pointer_cast<dummy::GroupChat>(sp);
3809
38
    }
3810
39
}
3811
40
3812
41
std::string dummy::GroupManager::group_id()
3813
42
{
3814
43
    return id;
3815
44
}
3816
45
3817
46
std::string dummy::GroupManager::group_title()
3818
47
{
3819
48
    return id;
3820
49
}
3821
50
3822
51
std::string dummy::GroupManager::group_subject()
3823
52
{
3824
53
    return std::string{};
3825
54
}
3826
55
3827
56
std::shared_ptr<messaging::Member> dummy::GroupManager::group_creator()
3828
57
{
3829
58
    return std::make_shared<messaging::Member>(creator);
3830
59
}
3831
60
3832
61
std::set<std::string> dummy::GroupManager::group_admins()
3833
62
{
3834
63
    std::set<std::string> admins;
3835
64
3836
65
    return admins;
3837
66
}
3838
67
3839
68
messaging::Members dummy::GroupManager::members()
3840
69
{
3841
70
    return participants;
3842
71
}
3843
72
3844
73
void dummy::GroupManager::set_observer(const std::shared_ptr<Observer> &observer)
3845
74
{
3846
75
    messaging::GroupManager::set_observer(observer);
3847
76
    announce_group_permissions_changed(messaging::GroupManager::permissions());
3848
77
}
3849
78
3850
79
void dummy::GroupManager::change_group_title(const std::string &new_title)
3851
80
{
3852
81
}
3853
82
3854
83
void dummy::GroupManager::change_group_subject(const std::string &new_subject)
3855
84
{
3856
85
3857
86
}
3858
87
3859
88
void dummy::GroupManager::add_members(const messaging::Members &members)
3860
89
{
3861
90
}
3862
91
3863
92
void dummy::GroupManager::remove_members(const messaging::Members &members)
3864
93
{
3865
94
    for (auto member : members) {
3866
95
        if (member->id() == messenger_.lock()->connection->self_identifier()) {
3867
96
            leave_group();
3868
97
        }
3869
98
    }
3870
99
}
3871
100
3872
101
void dummy::GroupManager::leave_group()
3873
102
{
3874
103
}
3875
104
3876
105
void dummy::GroupManager::dissolve_group()
3877
106
{
3878
107
    // not supported on dummy
3879
108
}
3880
109
3881
110
bool dummy::GroupManager::persistent()
3882
111
{
3883
112
    return false;
3884
113
}
3885
114
3886
0
115
3887
=== added file 'examples/mfw-plugin-dummy/src/dummy/group_starter.cpp'
3888
--- examples/mfw-plugin-dummy/src/dummy/group_starter.cpp	1970-01-01 00:00:00 +0000
3889
+++ examples/mfw-plugin-dummy/src/dummy/group_starter.cpp	2017-03-22 21:22:50 +0000
3890
@@ -0,0 +1,85 @@
3891
1
#include <messaging/group.h>
3892
2
3893
3
#include <dummy/group_starter.h>
3894
4
#include <dummy/group_manager.h>
3895
5
#include <dummy/messenger.h>
3896
6
3897
7
#include <glog/logging.h>
3898
8
3899
9
dummy::GroupStarter::GroupStarter(const std::shared_ptr<dummy::Messenger>& messenger)
3900
10
    : messaging::GroupStarter()
3901
11
    , messenger_{messenger}
3902
12
{
3903
13
}
3904
14
3905
15
std::shared_ptr<dummy::GroupStarter> dummy::GroupStarter::create(const std::shared_ptr<dummy::Messenger>& messenger)
3906
16
{
3907
17
    std::shared_ptr<GroupStarter> group_starter(new GroupStarter{messenger});
3908
18
    return group_starter;
3909
19
}
3910
20
3911
21
std::shared_ptr<messaging::GroupManager> dummy::GroupStarter::create_group(const std::shared_ptr<messaging::Group> &group)
3912
22
{
3913
23
    auto group_manager = dummy::GroupManager::create(group, messenger_.lock());
3914
24
    group_managers_[group->id()] = group_manager;
3915
25
3916
26
    return group_manager;
3917
27
}
3918
28
3919
29
std::shared_ptr<messaging::GroupManager> dummy::GroupStarter::accept_group(const std::shared_ptr<messaging::Group> &group)
3920
30
{
3921
31
    LOG(INFO) << __PRETTY_FUNCTION__ << " ,group_chat_id:" << group->id();
3922
32
3923
33
    std::string group_chat_id = group->id();
3924
34
3925
35
    if (group_chat_id.empty())
3926
36
    {
3927
37
        throw std::runtime_error{"Cannot accept an invitation with empty chat id"};
3928
38
    }
3929
39
3930
40
    auto it = group_managers_.find(group_chat_id);
3931
41
    if (it != group_managers_.end())
3932
42
    {
3933
43
        return it->second;
3934
44
    }
3935
45
3936
46
    auto group_manager = dummy::GroupManager::create(group, messenger_.lock());
3937
47
    group_managers_[group->id()] = group_manager;
3938
48
    return group_manager;
3939
49
}
3940
50
3941
51
std::shared_ptr<messaging::GroupManager> dummy::GroupStarter::rejoin_group(const std::shared_ptr<messaging::Group> &group)
3942
52
{
3943
53
    LOG(INFO) << __PRETTY_FUNCTION__ << " group_chat_id:" << group->id();
3944
54
    std::string group_chat_id = group->id();
3945
55
    if (group_chat_id.empty())
3946
56
    {
3947
57
        throw std::runtime_error{"Cannot rejoin with empty chat id"};
3948
58
    }
3949
59
3950
60
    auto it = group_managers_.find(group_chat_id);
3951
61
    if (it != group_managers_.end())
3952
62
    {
3953
63
        return it->second;
3954
64
    }
3955
65
3956
66
    auto group_manager = dummy::GroupManager::create(group, messenger_.lock());
3957
67
    group_managers_[group->id()] = group_manager;
3958
68
3959
69
    return group_manager;
3960
70
}
3961
71
3962
72
void dummy::GroupStarter::reject_group(const std::shared_ptr<messaging::Group> &group)
3963
73
{
3964
74
    LOG(INFO) << __PRETTY_FUNCTION__ << " ,group_chat_id:" << group->id();
3965
75
}
3966
76
3967
77
std::shared_ptr<messaging::Broadcast> dummy::GroupStarter::create_broadcast(const messaging::Members& recipients)
3968
78
{
3969
79
3970
80
}
3971
81
3972
82
std::map<std::string, std::shared_ptr<dummy::GroupManager>> dummy::GroupStarter::group_managers()
3973
83
{
3974
84
    return group_managers_;
3975
85
}
3976
0
86
3977
=== added file 'examples/mfw-plugin-dummy/src/dummy/messenger.cpp'
3978
--- examples/mfw-plugin-dummy/src/dummy/messenger.cpp	1970-01-01 00:00:00 +0000
3979
+++ examples/mfw-plugin-dummy/src/dummy/messenger.cpp	2017-03-22 21:22:50 +0000
3980
@@ -0,0 +1,71 @@
3981
1
#include <dummy/messenger.h>
3982
2
#include <dummy/group_chat.h>
3983
3
#include <dummy/contact_chat.h>
3984
4
#include <dummy/group_manager.h>
3985
5
#include <dummy/connection.h>
3986
6
3987
7
#include <messaging/group.h>
3988
8
#include <messaging/user.h>
3989
9
#include <messaging/variant.h>
3990
10
3991
11
#include <glog/logging.h>
3992
12
3993
13
using namespace std;
3994
14
3995
15
dummy::Messenger::Messenger(const std::shared_ptr<messaging::Messenger::Observer>& observer, const std::shared_ptr<dummy::Connection> &_connection)
3996
16
    : messaging::Messenger{observer}
3997
17
    , connection(_connection)
3998
18
{
3999
19
}
4000
20
4001
21
std::shared_ptr<dummy::Messenger> dummy::Messenger::create(const std::shared_ptr<messaging::Messenger::Observer>& observer, const std::shared_ptr<dummy::Connection> &connection)
4002
22
{
4003
23
    std::shared_ptr<Messenger> messenger(new Messenger{observer, connection});
4004
24
    return messenger;
4005
25
}
4006
26
4007
27
std::shared_ptr<messaging::Chat> dummy::Messenger::create_chat_with(const messaging::Recipient::shared_ptr& recipient,
4008
28
                                                                 const std::shared_ptr<messaging::Chat::Observer>& observer)
4009
29
{
4010
30
    switch (recipient->type())
4011
31
    {
4012
32
    case messaging::RecipientType::user:
4013
33
        LOG(INFO) << "Creating user chat" << recipient->id();
4014
34
        return dummy::ContactChat::create(std::dynamic_pointer_cast<messaging::User>(recipient), observer);
4015
35
    case messaging::RecipientType::group:
4016
36
        LOG(INFO) << "Creating group chat" << recipient->id();
4017
37
        return dummy::GroupChat::create(std::dynamic_pointer_cast<messaging::Group>(recipient), observer);
4018
38
    case messaging::RecipientType::broadcast:
4019
39
        LOG(ERROR) << "Broadcast chat not supported on DUMMY";
4020
40
        break;
4021
41
    }
4022
42
    return std::shared_ptr<messaging::Chat>();
4023
43
}
4024
44
4025
45
void dummy::Messenger::send_delivery_notification(const std::shared_ptr<dummy::Message>& message)
4026
46
{
4027
47
4028
48
}
4029
49
4030
50
std::shared_ptr<dummy::GroupManager> dummy::Messenger::get_group_manager(const std::string &group_chat_id)
4031
51
{
4032
52
    auto chat = get_chat(group_chat_id);
4033
53
    if (not chat) {
4034
54
        return nullptr;
4035
55
    }
4036
56
4037
57
    auto group_chat = dynamic_pointer_cast<dummy::GroupChat>(chat);
4038
58
    auto group_manager = group_chat->interface<messaging::GroupManager>();
4039
59
4040
60
    if (not group_manager) {
4041
61
        LOG(ERROR) << "Could not find a valid group manager plugged to chat " << group_chat_id;
4042
62
        return nullptr;
4043
63
    }
4044
64
4045
65
    return std::dynamic_pointer_cast<dummy::GroupManager>(group_manager);
4046
66
}
4047
67
    
4048
68
void dummy::Messenger::remove_chat(const std::string &chat_id)
4049
69
{
4050
70
    chats().erase(chat_id); 
4051
71
}
4052
0
72
4053
=== added file 'examples/mfw-plugin-dummy/src/dummy/presence_manager.cpp'
4054
--- examples/mfw-plugin-dummy/src/dummy/presence_manager.cpp	1970-01-01 00:00:00 +0000
4055
+++ examples/mfw-plugin-dummy/src/dummy/presence_manager.cpp	2017-03-22 21:22:50 +0000
4056
@@ -0,0 +1,59 @@
4057
1
#include <dummy/presence_manager.h>
4058
2
#include <dummy/user.h>
4059
3
#include <dummy/connector.h>
4060
4
4061
5
#include <glog/logging.h>
4062
6
4063
7
using namespace std;
4064
8
4065
9
dummy::PresenceManager::PresenceManager(
4066
10
        const std::shared_ptr<messaging::PresenceManager::Observer>& observer,
4067
11
        Connector *connector)
4068
12
    : messaging::PresenceManager{observer}
4069
13
    , connector_{connector}
4070
14
    , statuses_{{"offline", messaging::StatusSpec{
4071
15
                                messaging::PresenceType::offline,
4072
16
                                messaging::StatusSpec::Flags::may_set_on_self &
4073
17
                                messaging::StatusSpec::Flags::can_have_message}},
4074
18
                {"available", messaging::StatusSpec{
4075
19
                                messaging::PresenceType::available,
4076
20
                                messaging::StatusSpec::Flags::may_set_on_self &
4077
21
                                messaging::StatusSpec::Flags::can_have_message}},
4078
22
                {"unknown", messaging::StatusSpec{
4079
23
                                messaging::PresenceType::unknown,
4080
24
                                messaging::StatusSpec::Flags::none}}}
4081
25
{
4082
26
}
4083
27
4084
28
std::shared_ptr<dummy::PresenceManager> dummy::PresenceManager::create(const std::shared_ptr<messaging::PresenceManager::Observer>& observer,
4085
29
                                                                 Connector* connector)
4086
30
{
4087
31
    std::shared_ptr<PresenceManager> presence(new PresenceManager{observer, connector});
4088
32
    return presence;
4089
33
}
4090
34
4091
35
messaging::PresenceManager::StatusMap dummy::PresenceManager::get_valid_statuses()
4092
36
{
4093
37
    return statuses_;
4094
38
}
4095
39
4096
40
void dummy::PresenceManager::set_self_presence(const std::string&, const std::string&)
4097
41
{
4098
42
    throw std::logic_error{"Not implemented"};
4099
43
}
4100
44
4101
45
void dummy::PresenceManager::request_presence(const std::shared_ptr<messaging::Recipient> &recipient)
4102
46
{
4103
47
4104
48
}
4105
49
4106
50
messaging::Presence dummy::PresenceManager::create_presence(const std::string& status, const std::string& status_message)
4107
51
{
4108
52
    auto it = statuses_.find(status);
4109
53
    if (it != statuses_.end())
4110
54
    {
4111
55
        return messaging::Presence{it->second.type, status, status_message};
4112
56
    }
4113
57
4114
58
    throw std::logic_error{"Trying to create a presence from a not specified presence status"};
4115
59
}
4116
0
60
4117
=== added file 'examples/mfw-plugin-dummy/src/dummy/user.cpp'
4118
--- examples/mfw-plugin-dummy/src/dummy/user.cpp	1970-01-01 00:00:00 +0000
4119
+++ examples/mfw-plugin-dummy/src/dummy/user.cpp	2017-03-22 21:22:50 +0000
4120
@@ -0,0 +1,14 @@
4121
1
#include <dummy/user.h>
4122
2
4123
3
#include <messaging/user.h>
4124
4
4125
5
dummy::User dummy::User::from_recipient(const std::shared_ptr<messaging::Recipient> &recipient)
4126
6
{
4127
7
    dummy::User user;
4128
8
    user.username = recipient->id();
4129
9
    return user;
4130
10
}
4131
11
4132
12
messaging::Recipient::shared_ptr dummy::User::to_recipient() const
4133
13
{
4134
14
}
Status:	Approved
Approved by:	Gustavo Pichorim Boiko on 2017-03-22
Approved revision:	81
Proposed branch:	lp:~phablet-team/messaging-framework/add-dummy-protocol
Merge into:	lp:messaging-framework
Prerequisite:	lp:~phablet-team/messaging-framework/multiple_api_fixes
Diff against target:	4134 lines (+3866/-0) 48 files modified CMakeLists.txt (+2/-0) debian/control.in (+6/-0) debian/mfw-plugin-dummy.install (+6/-0) examples/CMakeLists.txt (+1/-0) examples/mfw-plugin-dummy/CMakeLists.txt (+61/-0) examples/mfw-plugin-dummy/cmake/EnableCoverageReport.cmake (+153/-0) examples/mfw-plugin-dummy/cmake/FindGLog.cmake (+14/-0) examples/mfw-plugin-dummy/cmake/FindLcov.cmake (+29/-0) examples/mfw-plugin-dummy/cmake/Findgcovr.cmake (+31/-0) examples/mfw-plugin-dummy/cmake/LibFindMacros.cmake (+112/-0) examples/mfw-plugin-dummy/cmake/ParseArguments.cmake (+52/-0) examples/mfw-plugin-dummy/data/CMakeLists.txt (+63/-0) examples/mfw-plugin-dummy/data/cmake_uninstall.cmake.in (+22/-0) examples/mfw-plugin-dummy/data/dummy.manager.in (+10/-0) examples/mfw-plugin-dummy/data/dummy.protocol.in (+16/-0) examples/mfw-plugin-dummy/data/dummy.service.in (+3/-0) examples/mfw-plugin-dummy/debian/changelog (+5/-0) examples/mfw-plugin-dummy/debian/compat (+1/-0) examples/mfw-plugin-dummy/debian/control (+31/-0) examples/mfw-plugin-dummy/debian/copyright (+22/-0) examples/mfw-plugin-dummy/debian/rules (+19/-0) examples/mfw-plugin-dummy/debian/source/format (+1/-0) examples/mfw-plugin-dummy/doc/CMakeLists.txt (+21/-0) examples/mfw-plugin-dummy/doc/Doxyfile.in (+1869/-0) examples/mfw-plugin-dummy/include/CMakeLists.txt (+3/-0) examples/mfw-plugin-dummy/include/dummy/chat.h (+31/-0) examples/mfw-plugin-dummy/include/dummy/connection.h (+98/-0) examples/mfw-plugin-dummy/include/dummy/connector.h (+58/-0) examples/mfw-plugin-dummy/include/dummy/contact_chat.h (+54/-0) examples/mfw-plugin-dummy/include/dummy/group_chat.h (+50/-0) examples/mfw-plugin-dummy/include/dummy/group_manager.h (+72/-0) examples/mfw-plugin-dummy/include/dummy/group_starter.h (+52/-0) examples/mfw-plugin-dummy/include/dummy/messenger.h (+50/-0) examples/mfw-plugin-dummy/include/dummy/presence_manager.h (+40/-0) examples/mfw-plugin-dummy/include/dummy/recipient.h (+19/-0) examples/mfw-plugin-dummy/include/dummy/user.h (+31/-0) examples/mfw-plugin-dummy/include/dummy/visibility.h (+7/-0) examples/mfw-plugin-dummy/src/CMakeLists.txt (+43/-0) examples/mfw-plugin-dummy/src/dummy/chat.cpp (+30/-0) examples/mfw-plugin-dummy/src/dummy/connection.cpp (+132/-0) examples/mfw-plugin-dummy/src/dummy/connector.cpp (+95/-0) examples/mfw-plugin-dummy/src/dummy/contact_chat.cpp (+58/-0) examples/mfw-plugin-dummy/src/dummy/group_chat.cpp (+50/-0) examples/mfw-plugin-dummy/src/dummy/group_manager.cpp (+114/-0) examples/mfw-plugin-dummy/src/dummy/group_starter.cpp (+85/-0) examples/mfw-plugin-dummy/src/dummy/messenger.cpp (+71/-0) examples/mfw-plugin-dummy/src/dummy/presence_manager.cpp (+59/-0) examples/mfw-plugin-dummy/src/dummy/user.cpp (+14/-0)
To merge this branch:	bzr merge lp:~phablet-team/messaging-framework/add-dummy-protocol
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
system-apps-ci-bot	continuous-integration		Needs Fixing on 2017-03-22
Gustavo Pichorim Boiko (community)		2017-03-21	Approve on 2017-03-22
Review via email: mp+320528@code.launchpad.net