Backport the code to be able to display the region name of the file that holds the selected material.

Move sg_location member up to the base clase, since it’s potentially
useful in more types.

Allow suppression of the report callback when the exception is thrown

.gitignore

@@ -15,3 +15,5 @@ install_manifest.txt
 build*
 Build
 CMakeLists.txt.user
+3rdparty/expat_2.2.6/
+nbproject

3rdparty/expat/CMakeLists.txt

@@ -1,7 +1,7 @@
 
 configure_file (
     "${PROJECT_SOURCE_DIR}/3rdparty/expat/expat_config_cmake.in"
-    "${PROJECT_BINARY_DIR}/3rdparty/expat/expat_config.h"
+    "${PROJECT_BINARY_DIR}/3rdparty/expat/simgear_expat_config.h"
 )
 
 set(expat_sources 

3rdparty/expat/xmlparse.c

@@ -18,6 +18,8 @@
 #include "amigaconfig.h"
 #elif defined(__WATCOMC__)
 #include "watcomconfig.h"
+#elif defined(HAVE_SIMGEAR_EXPAT_CONFIG_H)
+#include "simgear_expat_config.h"
 #elif defined(HAVE_EXPAT_CONFIG_H)
 #include "expat_config.h"
 #endif /* ndef COMPILED_FROM_DSP */

3rdparty/expat/xmlrole.c

@@ -12,6 +12,8 @@
 #include "amigaconfig.h"
 #elif defined(__WATCOMC__)
 #include "watcomconfig.h"
+#elif defined(HAVE_SIMGEAR_EXPAT_CONFIG_H)
+#include "simgear_expat_config.h"
 #else
 #ifdef HAVE_EXPAT_CONFIG_H
 #include "expat_config.h"

3rdparty/expat/xmltok.c

@@ -12,6 +12,8 @@
 #include "amigaconfig.h"
 #elif defined(__WATCOMC__)
 #include "watcomconfig.h"
+#elif defined(HAVE_SIMGEAR_EXPAT_CONFIG_H)
+#include "simgear_expat_config.h"
 #else
 #ifdef HAVE_EXPAT_CONFIG_H
 #include "expat_config.h"

3rdparty/udns/udns_init.c

@@ -24,7 +24,7 @@
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
 # include <winsock2.h>          /* includes <windows.h> */
 # include <iphlpapi.h>		/* for dns server addresses etc */
 #else
@@ -53,7 +53,7 @@ static void dns_set_srch_internal(struct dns_ctx *ctx, char *srch) {
     dns_add_srch(ctx, srch);
 }
 
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
 
 #ifndef NO_IPHLPAPI
 /* Apparently, some systems does not have proper headers for IPHLPAIP to work.
@@ -217,7 +217,7 @@ int dns_init(struct dns_ctx *ctx, int do_open) {
     ctx = &dns_defctx;
   dns_reset(ctx);
 
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
   if (dns_initns_iphlpapi(ctx) != 0)
     dns_initns_registry(ctx);
   /*XXX WINDOWS: probably good to get default domain and search list too...

3rdparty/udns/udns_resolver.c

@@ -24,7 +24,7 @@
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
 # include <winsock2.h>          /* includes <windows.h> */
 # include <ws2tcpip.h>          /* needed for struct in6_addr */
 #else
@@ -392,7 +392,7 @@ dns_set_tmcbck(struct dns_ctx *ctx, dns_utm_fn *fn, void *data) {
 }
 
 static unsigned dns_nonrandom_32(void) {
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
   FILETIME ft;
   GetSystemTimeAsFileTime(&ft);
   return ft.dwLowDateTime;
@@ -551,7 +551,7 @@ int dns_open(struct dns_ctx *ctx) {
     ctx->dnsc_qstatus = DNS_E_TEMPFAIL;
     return -1;
   }
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
   { unsigned long on = 1;
     if (ioctlsocket(sock, FIONBIO, &on) == SOCKET_ERROR) {
       closesocket(sock);
@@ -991,7 +991,7 @@ again: /* receive the reply */
      * or remote.  On local errors, we should stop, while
      * remote errors should be ignored (for now anyway).
      */
-#ifdef WINDOWS
+#if defined(_WINDOWS) || defined(WINDOWS)
     if (WSAGetLastError() == WSAEWOULDBLOCK)
 #else
     if (errno == EAGAIN)

3rdparty/udns/udns_rr_a.c

@@ -27,7 +27,7 @@
 #include <string.h>
 #include <stdlib.h>
 #include <assert.h>
-#ifndef WINDOWS
+#if !defined(_WINDOWS) && !defined(WINDOWS)
 # include <sys/types.h>
 # include <netinet/in.h>
 #endif

CMakeLists.txt

@@ -10,6 +10,15 @@ if(COMMAND cmake_policy)
    if(POLICY CMP0067)
        cmake_policy(SET CMP0067 NEW)
    endif()
+    
+  # OpenGL VND policy : use the old definition for now, until we can audit this
+  if(POLICY CMP0072)
+        cmake_policy(SET CMP0072 OLD)
+  endif()
+
+   if(POLICY CMP0093)
+       cmake_policy(SET CMP0093 NEW)
+   endif()
 endif()
 
 
@@ -32,6 +41,7 @@ include (GenerateExportHeader)
 
 # only relevant for building shared libs but let's set it regardless
 set(CMAKE_OSX_RPATH 1)
+set(CMAKE_OSX_DEPLOYMENT_TARGET "10.9" CACHE STRING "Minimum OS X deployment version")
 
 # let's use & require C++11 - note these are only functional with CMake 3.1
 # we do manual fallbacks for CMake 3.0 in the compilers section
@@ -39,17 +49,12 @@ set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
 
 # read 'version' file into a variable (stripping any newlines or spaces)
-file(READ version versionFile)
+file(READ simgear-version versionFile)
 string(STRIP ${versionFile} SIMGEAR_VERSION)
 
 project(SimGear VERSION ${SIMGEAR_VERSION} LANGUAGES C CXX)
 
-# using 10.7 because boost requires libc++ and 10.6 doesn't include it
+# add a dependency on the version file
-# Cmake documentation says we must set this before calling project(), but
-# it only seems to be picked up setting it /after/ the call to project()
-set(CMAKE_OSX_DEPLOYMENT_TARGET "10.7")
-
-# add a dependency on the versino file
 set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS version)
 
 set_property(GLOBAL PROPERTY FIND_LIBRARY_USE_LIB64_PATHS TRUE)
@@ -126,13 +131,19 @@ option(ENABLE_RTI       "Set to ON to build SimGear with RTI support" OFF)
 option(ENABLE_GDAL      "Set to ON to build SimGear with GDAL support" OFF)
 option(ENABLE_TESTS     "Set to OFF to disable building SimGear's test applications" ON)
 option(ENABLE_SOUND     "Set to OFF to disable building SimGear's sound support" ON)
-option(USE_AEONWAVE     "Set to ON to use AeonWave instead of OpenAL" OFF)
+option(USE_AEONWAVE     "Set to ON to use AeonWave instead of OpenAL" ON)
 option(ENABLE_PKGUTIL   "Set to ON to build the sg_pkgutil application (default)" ON)
 option(ENABLE_DNS       "Set to ON to use udns library and DNS service resolver" ON)
-option(ENABLE_SIMD      "Enable SSE/SSE2 support for x86 compilers" ON)
+option(ENABLE_SIMD      "Enable SSE/SSE2 support for compilers" ON)
+option(ENABLE_SIMD_CODE	"Enable SSE/SSE2 support code for compilers" OFF)
 option(ENABLE_OPENMP    "Enable OpenMP compiler support" OFF)
 
+if (NOT ENABLE_SIMD AND ENABLE_SIMD_CODE)
+  set(ENABLE_SIMD_CODE OFF)
+endif()
+
 include (DetectArch)
+include (ExportDebugSymbols)
 
 # until the fstream fix is applied and generally available in OSG,
 # keep the compatability link option as the default
@@ -149,7 +160,7 @@ endif()
 
 
 if (MSVC)
-  GET_FILENAME_COMPONENT(PARENT_DIR ${PROJECT_BINARY_DIR} PATH)
+  GET_FILENAME_COMPONENT(PARENT_DIR ${PROJECT_BINARY_DIR} DIRECTORY)
   if (CMAKE_CL_64)
     SET(TEST_3RDPARTY_DIR "${PARENT_DIR}/3rdparty.x64")
   else (CMAKE_CL_64)
@@ -160,6 +171,11 @@ if (MSVC)
   else (EXISTS ${TEST_3RDPARTY_DIR})
     set(MSVC_3RDPARTY_ROOT NOT_FOUND CACHE PATH "Location where the third-party dependencies are extracted")
   endif (EXISTS ${TEST_3RDPARTY_DIR})
+
+  # override CMake default RelWithDebInfo flags. This is important to ensure
+  # good performance
+  set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "/Zi /O2 /Ob2 /D NDEBUG")
+  set(CMAKE_C_FLAGS_RELWITHDEBINFO "/Zi /O2 /Ob2 /D NDEBUG")
 else (MSVC)
   set(MSVC_3RDPARTY_ROOT NOT_FOUND CACHE PATH "Location where the third-party dependencies are extracted")
 endif (MSVC)
@@ -167,14 +183,24 @@ endif (MSVC)
 if (MSVC AND MSVC_3RDPARTY_ROOT)
   message(STATUS "3rdparty files located in ${MSVC_3RDPARTY_ROOT}")
 
+  string(SUBSTRING ${MSVC_VERSION} 0 2 MSVC_VERSION_MAJOR)
+  string(SUBSTRING ${MSVC_VERSION} 2 2 MSVC_VERSION_MINOR)
+
   set( OSG_MSVC "msvc" )
-  if (${MSVC_VERSION} EQUAL 1900)
+  if (${MSVC_VERSION_MAJOR} EQUAL "19")
+    if (${MSVC_VERSION_MINOR} GREATER_EQUAL "20")
+      set( OSG_MSVC ${OSG_MSVC}142 )
+    elseif (${MSVC_VERSION_MINOR} GREATER_EQUAL "10")
+      set( OSG_MSVC ${OSG_MSVC}141 )
+    else ()
       set( OSG_MSVC ${OSG_MSVC}140 )
-  elseif (${MSVC_VERSION} EQUAL 1800)
+    endif ()
+  elseif (${MSVC_VERSION_MAJOR} EQUAL "18")
     set( OSG_MSVC ${OSG_MSVC}120 )
   else ()
-      message(FATAL_ERROR "Visual Studio 2013/2015 is required now")
+    message(FATAL_ERROR "Visual Studio 2013 or higher is required")
   endif ()
+
   if (CMAKE_CL_64)
       set( OSG_MSVC ${OSG_MSVC}-64 )
       set( MSVC_3RDPARTY_DIR 3rdParty.x64 )
@@ -189,16 +215,13 @@ if (MSVC AND MSVC_3RDPARTY_ROOT)
     # if this variable was not set by the user, set it to 3rdparty root's
     # parent dir, which is the normal location for people using our
     # windows-3rd-party repo
-    GET_FILENAME_COMPONENT(MSVC_ROOT_PARENT_DIR ${MSVC_3RDPARTY_ROOT} PATH)
+    get_filename_component(MSVC_ROOT_PARENT_DIR ${MSVC_3RDPARTY_ROOT} DIRECTORY)
     set(BOOST_INCLUDEDIR ${MSVC_ROOT_PARENT_DIR})
     message(STATUS "BOOST_INCLUDEDIR is ${BOOST_INCLUDEDIR}")
   endif()
 
-  if (NOT USE_AEONWAVE)
   set (OPENAL_INCLUDE_DIR ${MSVC_3RDPARTY_ROOT}/${MSVC_3RDPARTY_DIR}/include)
   set (OPENAL_LIBRARY_DIR ${MSVC_3RDPARTY_ROOT}/${MSVC_3RDPARTY_DIR}/lib)
-    message(STATUS "OPENAL_INCLUDE_DIR is ${OPENAL_INCLUDE_DIR}")
-  endif()
 endif (MSVC AND MSVC_3RDPARTY_ROOT)
 
 if(APPLE)
@@ -210,7 +233,7 @@ if(${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD
 endif()
 
 find_package(Boost REQUIRED)
-set (BOOST_CXX_FLAGS "-DBOOST_BIMAP_DISABLE_SERIALIZATION")
+set (BOOST_CXX_FLAGS "-DBOOST_BIMAP_DISABLE_SERIALIZATION -DBOOST_NO_STDLIB_CONFIG")
 include(BoostTestTargets)
 
 if(SIMGEAR_HEADLESS)
@@ -222,12 +245,19 @@ else()
 
     if (ENABLE_SOUND)
         if (USE_AEONWAVE)
-            find_package(AAX COMPONENTS aax REQUIRED)
+            find_package(AAX)
-        else()
+        endif()
+
+        if(NOT AAX_FOUND)
+            set(USE_AEONWAVE FALSE)
             find_package(OpenAL REQUIRED)
         endif()
 
-        message(STATUS "Sound support: ENABLED")
+        if(AAX_FOUND)
+            message(STATUS "Sound support: AeonWave")
+        else()
+            message(STATUS "Sound support: OpenAL")
+        endif()
     endif(ENABLE_SOUND)
 
     find_package(OpenSceneGraph 3.2.0 REQUIRED osgText osgSim osgDB osgParticle osgGA osgViewer osgUtil)
@@ -248,7 +278,15 @@ else()
     endif()
 endif(SIMGEAR_HEADLESS)
 
+if(${CMAKE_SYSTEM_NAME} MATCHES "OpenBSD")
+    # As of 2020-08-01, OpenBSD's system zlib is slightly old, but it's usable
+    # with a workaround in simgear/io/iostreams/gzfstream.cxx.
+    find_package(ZLIB 1.2.3 REQUIRED)
+else()
     find_package(ZLIB 1.2.4 REQUIRED)
+endif()
+
+find_package(LibLZMA REQUIRED)
 find_package(CURL REQUIRED)
 
 if (SYSTEM_EXPAT)
@@ -258,9 +296,6 @@ if (SYSTEM_EXPAT)
 
 else()
     message(STATUS "Using built-in expat code")
-    # XML_STATIC is important to avoid sg_expat_external.h
-    # declaring symbols as declspec(import)
-    add_definitions(-DHAVE_EXPAT_CONFIG_H -DXML_STATIC)
     set(EXPAT_INCLUDE_DIRS
             ${PROJECT_SOURCE_DIR}/3rdparty/expat
             ${PROJECT_BINARY_DIR}/3rdparty/expat)
@@ -279,11 +314,10 @@ endif()
 if(ENABLE_RTI)
     find_package(PkgConfig)
     if(PKG_CONFIG_FOUND)
-      SET(ENV{PKG_CONFIG_PATH} "${CMAKE_INSTALL_PREFIX}/lib/pkgconfig:$ENV{PKG_CONFIG_PATH}")
+      SET(ENV{PKG_CONFIG_PATH} "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/pkgconfig:$ENV{PKG_CONFIG_PATH}")
       pkg_check_modules(RTI hla-rti13)
     endif(PKG_CONFIG_FOUND)
     if(RTI_FOUND)
-      SET(RTI_INCLUDE_DIR "${RTI_INCLUDE_DIRS}")
       message(STATUS "RTI: ENABLED")
     else()
       message(STATUS "RTI: DISABLED")
@@ -397,11 +431,8 @@ if(CMAKE_COMPILER_IS_GNUCXX)
       message(WARNING "GCC 4.4 will be required soon, please upgrade")
     endif()
 
-    if(ENABLE_SIMD)
     if (X86 OR X86_64)
-        set(CMAKE_C_FLAGS_RELEASE "-O3 -msse2 -mfpmath=sse")
+        set(SIMD_COMPILER_FLAGS "-msse2 -mfpmath=sse -ftree-vectorize -ftree-slp-vectorize")
-        set(CMAKE_CXX_FLAGS_RELEASE "-O3 -msse2 -mfpmath=sse")
-      endif()
     endif()
 
     # certain GCC versions don't provide the atomic builds, and hence
@@ -410,6 +441,10 @@ if(CMAKE_COMPILER_IS_GNUCXX)
     check_cxx_source_compiles(
        "int main() { unsigned mValue; return __sync_add_and_fetch(&mValue, 1); }"
         GCC_ATOMIC_BUILTINS_FOUND)
+
+      # override CMake default RelWithDebInfo flags.
+    set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -g -DNDEBUG")
+    set(CMAKE_C_FLAGS_RELWITHDEBINFO  "-O3 -g -DNDEBUG")
 endif(CMAKE_COMPILER_IS_GNUCXX)
 
 if (CLANG)
@@ -420,12 +455,11 @@ if (CLANG)
     # fix Boost compilation :(
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++")
 
-    if(ENABLE_SIMD)
+    # override CMake default RelWithDebInfo flags.
-      if (X86 OR X86_64)
+    set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -g -DNDEBUG")
-        set(CMAKE_C_FLAGS_RELEASE "-O3 -msse2 -mfpmath=sse")
+    set(CMAKE_C_FLAGS_RELWITHDEBINFO  "-O3 -g -DNDEBUG")
-        set(CMAKE_CXX_FLAGS_RELEASE "-O3 -msse2 -mfpmath=sse")
+
-      endif()
+    set(SIMD_COMPILER_FLAGS "-msse2 -mfpmath=sse -ftree-vectorize -ftree-slp-vectorize")
-    endif()
 endif()
 
 if (ENABLE_OPENMP)
@@ -457,14 +491,8 @@ if(WIN32)
 
     if(MSVC)
         set(MSVC_FLAGS "-DWIN32 -DNOMINMAX -D_USE_MATH_DEFINES -D_CRT_SECURE_NO_WARNINGS -D__CRT_NONSTDC_NO_WARNINGS /MP")
-        if(ENABLE_SIMD)
         if (X86)
-            SET(CMAKE_C_FLAGS_RELEASE "/O2 /arch:SSE /arch:SSE2")
+          set(SIMD_COMPILER_FLAGS "/arch:SSE /arch:SSE2")
-            SET(CMAKE_CXX_FLAGS_RELEASE "/O2 /arch:SSE /arch:SSE2")
-          else()
-            SET(CMAKE_C_FLAGS_RELEASE "/O2")
-            SET(CMAKE_CXX_FLAGS_RELEASE "/O2")
-          endif()
         endif()
 
         if (NOT OSG_FSTREAM_EXPORT_FIXED)
@@ -488,6 +516,20 @@ if(WIN32)
     set( RT_LIBRARY "winmm" )
 endif(WIN32)
 
+# append the SIMD flags if requested
+if (ENABLE_SIMD)
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${SIMD_COMPILER_FLAGS}")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${SIMD_COMPILER_FLAGS}")
+
+  # set for multi-configuration generators
+  set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} ${SIMD_COMPILER_FLAGS}")
+  set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${SIMD_COMPILER_FLAGS}")
+
+  set(CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS_RELWITHDEBINFO} ${SIMD_COMPILER_FLAGS}")
+  set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} ${SIMD_COMPILER_FLAGS}")
+endif()
+
+
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS_C} ${MSVC_FLAGS}")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS_CXX} ${MSVC_FLAGS} ${BOOST_CXX_FLAGS}")
 set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${MSVC_LD_FLAGS}")
@@ -498,6 +540,10 @@ include(CheckCXXFeatures)
 # ahead of system-installed libs
 include_directories(BEFORE ${PROJECT_BINARY_DIR}/simgear)
 
+if(${CMAKE_SYSTEM_NAME} MATCHES "OpenBSD")
+    include_directories("/usr/X11R6/include")
+endif()
+
 add_definitions(-DHAVE_CONFIG_H)
 
 # configure a header file to pass some of the CMake settings

CMakeModules/BoostTestTargets.cmake

@@ -46,11 +46,17 @@ set(BOOST_TEST_TARGET_PREFIX "test")
 if(NOT Boost_FOUND)
 	find_package(Boost 1.34.0 QUIET)
 endif()
-if("${Boost_VERSION}0" LESS "1034000")
+
+if (NOT Boost_VERSION_MACRO)
+	# Compatibility with pre CMP0093 (CMake 3.15)
+	set(Boost_VERSION_MACRO ${Boost_VERSION})
+endif()
+
+if("${Boost_VERSION_MACRO}0" LESS "1034000")
 	set(_shared_msg
 		"NOTE: boost::test-based targets and tests cannot "
 		"be added: boost >= 1.34.0 required but not found. "
-		"(found: '${Boost_VERSION}'; want >=103400) ")
+		"(found: '${Boost_VERSION_MACRO}'; want >=103400) ")
 	if(ENABLE_TESTS)
 		message(FATAL_ERROR
 			${_shared_msg}
@@ -66,7 +72,7 @@ endif()
 include(GetForceIncludeDefinitions)
 include(CopyResourcesToBuildTree)
 
-if(Boost_FOUND AND NOT "${Boost_VERSION}0" LESS "1034000")
+if(Boost_FOUND AND NOT "${Boost_VERSION_MACRO}0" LESS "1034000")
 	set(_boosttesttargets_libs)
 	set(_boostConfig "BoostTestTargetsIncluded.h")
 	if(NOT Boost_UNIT_TEST_FRAMEWORK_LIBRARY)
@@ -80,7 +86,7 @@ if(Boost_FOUND AND NOT "${Boost_VERSION}0" LESS "1034000")
 			set(_boostConfig "BoostTestTargetsDynamic.h")
 		endif()
 	endif()
-	get_filename_component(_moddir ${CMAKE_CURRENT_LIST_FILE} PATH)
+	get_filename_component(_moddir ${CMAKE_CURRENT_LIST_FILE} DIRECTORY)
 	configure_file("${_moddir}/${_boostConfig}"
 		"${CMAKE_CURRENT_BINARY_DIR}/BoostTestTargetConfig.h"
 		COPYONLY)
@@ -129,7 +135,7 @@ function(add_boost_test _name)
 			"Syntax error in use of add_boost_test: at least one source file required!")
 	endif()
 
-	if(Boost_FOUND AND NOT "${Boost_VERSION}0" LESS "1034000")
+	if(Boost_FOUND AND NOT "${Boost_VERSION_MACRO}0" LESS "1034000")
 
 		include_directories(${Boost_INCLUDE_DIRS})
 
@@ -221,7 +227,7 @@ function(add_boost_test _name)
 			set(_test_command ${_target_name})
 		endif()
 
-		if(TESTS AND ( "${Boost_VERSION}" VERSION_GREATER "103799" ))
+		if(TESTS AND ( "${Boost_VERSION_MACRO}" VERSION_GREATER "103799" ))
 			foreach(_test ${TESTS})
 				add_test(
 					${_name}-${_test}

CMakeModules/CopyResourcesToBuildTree.cmake

@@ -30,12 +30,12 @@ function(copy_resources_to_build_tree _target)
 	endif()
 
 	get_target_property(_path ${_target} LOCATION)
-	get_filename_component(_path "${_path}" PATH)
+	get_filename_component(_path "${_path}" DIRECTORY)
 
 	if(NOT MSVC AND NOT "${CMAKE_GENERATOR}" MATCHES "Makefiles")
 		foreach(_config ${CMAKE_CONFIGURATION_TYPES})
 			get_target_property(_path${_config} ${_target} LOCATION_${_config})
-			get_filename_component(_path${_config} "${_path${_config}}" PATH)
+			get_filename_component(_path${_config} "${_path${_config}}" DIRECTORY)
 			add_custom_command(TARGET ${_target}
 						POST_BUILD
 						COMMAND

CMakeModules/ExportDebugSymbols.cmake

@@ -0,0 +1,26 @@
+
+
+# placehodler target for other ones to depend upon
+add_custom_target(
+    debug_symbols
+)
+
+function(export_debug_symbols target)
+
+    if (NOT SIMGEAR_SHARED)
+        return()
+    endif()
+
+    if (APPLE)
+        add_custom_target(${target}.dSYM
+            COMMENT "Generating dSYM files for ${target}"
+            COMMAND dsymutil --out=${target}.dSYM $<TARGET_FILE:${target}>
+            DEPENDS $<TARGET_FILE:${target}>
+        ) 
+
+        install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${target}.dSYM DESTINATION symbols OPTIONAL)
+
+        add_dependencies(debug_symbols ${target}.dSYM)
+    endif()
+
+endfunction()

CMakeModules/FindAAX.cmake

@@ -1,16 +1,25 @@
-# Locate AAX
+# Try to find AAX (AeonWave)
 # This module defines
-# AAX_LIBRARIES
+#
-# AAX_FOUND, if false, do not try to link to AAX 
+# AAX_FOUND - if false, do not try to link to AAX
-# AAX_INCLUDE_DIR, where to find the headers
+# AAX_INCLUDE_DIR - where to find the headers
+# AAX_LIBRARIES - Link these to use AAX
+#
+# Copyright (C) 2016-2018 by Erik Hofman.
+# Copyright (C) 2016-2018 by Adalin B.V.
 #
 # $AAXDIR is an environment variable that would
 # correspond to the ./configure --prefix=$AAXDIR
 # used in building AAX.
 #
-# Created by Erik Hofman.
+# This file is Public Domain (www.unlicense.org)
+# This is free and unencumbered software released into the public domain.
 
-FIND_PATH(AAX_INCLUDE_DIR aax/aax.h
+if (AAX_LIBRARY AND AAX_INCLUDE_DIR)
+  # in cache already
+  set(AAX_FOUND TRUE)
+else()
+  find_path(AAX_INCLUDE_DIR aax/aax.h
     HINTS
     $ENV{AAXDIR}
     $ENV{ProgramFiles}/aax
@@ -26,15 +35,15 @@ FIND_PATH(AAX_INCLUDE_DIR aax/aax.h
     /opt
   )
 
-FIND_LIBRARY(AAX_LIBRARY 
+  find_library(AAX_LIBRARY 
-  NAMES AAX aax AAX32
+    NAMES AAX aax libAAX
     HINTS
     $ENV{AAXDIR}
     $ENV{ProgramFiles}/AAX
     $ENV{ProgramFiles}/AeonWave
     $ENV{ProgramFiles}/Adalin/AeonWave
     ${CMAKE_BUILD_DIR}/aax
-  PATH_SUFFIXES bin lib lib/${CMAKE_LIBRARY_ARCHITECTURE} lib64 libs64 libs libs/Win32 libs/Win64
+    PATH_SUFFIXES lib64 lib lib/${CMAKE_LIBRARY_ARCHITECTURE} libs64 libs libs/Win32 libs/Win64 bin
     PATHS
     ~/Library/Frameworks
     /Library/Frameworks
@@ -43,19 +52,23 @@ FIND_LIBRARY(AAX_LIBRARY
     /opt
   )
 
-IF(AAX_LIBRARY AND AAX_INCLUDE_DIR)
+  set(AAX_DEFINITIONS "")
-  SET(AAX_FOUND "YES")
+  if (AAX_LIBRARY AND AAX_INCLUDE_DIR)
-ELSE(AAX_LIBRARY AND AAX_INCLUDE_DIR)
+    set(AAX_FOUND TRUE)
-  IF(NOT AAX_INCLUDE_DIR)
+  endif()
-    MESSAGE(FATAL_ERROR "Unable to find the AAX library development files.")
+
-    SET(AAX_FOUND "NO")
+  if (AAX_FOUND)
-  ENDIF(NOT AAX_INCLUDE_DIR)
+    if (NOT Udns_FIND_QUIETLY)
-  IF(NOT AAX_LIBRARY)
+      message(STATUS "Found AeonWave: ${AAX_LIBRARIES}")
-    IF(SINGLE_PACKAGE)
+    endif ()
-      SET(AAX_LIBRARY "${aax_BUILD_DIR}/aax/AAX32.dll")
+  else ()
-      SET(AAX_FOUND "YES")
+    if (Udns_FIND_REQUIRED)
-    ELSE(SINGLE_PACKAGE)
+      message(FATAL_ERROR "Could not find AeonWave")
-    ENDIF(SINGLE_PACKAGE)
+    endif ()
-  ENDIF(NOT AAX_LIBRARY)
+  endif ()
-ENDIF(AAX_LIBRARY AND AAX_INCLUDE_DIR)
+
+  # show the AAX_INCLUDE_DIRS and AAX_LIBRARIES variables only in the advanced view
+  mark_as_advanced(AAX_INCLUDE_DIRS AAX_LIBRARIES)
+
+endif()
 

CMakeModules/FindLibLZMA.cmake

@@ -0,0 +1,124 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+FindLibLZMA
+-----------
+
+Find LZMA compression algorithm headers and library.
+
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module defines :prop_tgt:`IMPORTED` target ``LibLZMA::LibLZMA``, if
+liblzma has been found.
+
+Result variables
+^^^^^^^^^^^^^^^^
+
+This module will set the following variables in your project:
+
+``LIBLZMA_FOUND``
+  True if liblzma headers and library were found.
+``LIBLZMA_INCLUDE_DIRS``
+  Directory where liblzma headers are located.
+``LIBLZMA_LIBRARIES``
+  Lzma libraries to link against.
+``LIBLZMA_HAS_AUTO_DECODER``
+  True if lzma_auto_decoder() is found (required).
+``LIBLZMA_HAS_EASY_ENCODER``
+  True if lzma_easy_encoder() is found (required).
+``LIBLZMA_HAS_LZMA_PRESET``
+  True if lzma_lzma_preset() is found (required).
+``LIBLZMA_VERSION_MAJOR``
+  The major version of lzma
+``LIBLZMA_VERSION_MINOR``
+  The minor version of lzma
+``LIBLZMA_VERSION_PATCH``
+  The patch version of lzma
+``LIBLZMA_VERSION_STRING``
+  version number as a string (ex: "5.0.3")
+#]=======================================================================]
+
+find_path(LIBLZMA_INCLUDE_DIR lzma.h )
+if(NOT LIBLZMA_LIBRARY)
+  find_library(LIBLZMA_LIBRARY_RELEASE NAMES lzma liblzma NAMES_PER_DIR PATH_SUFFIXES lib)
+  find_library(LIBLZMA_LIBRARY_DEBUG NAMES lzmad liblzmad NAMES_PER_DIR PATH_SUFFIXES lib)
+  include(SelectLibraryConfigurations)
+  select_library_configurations(LIBLZMA)
+else()
+  file(TO_CMAKE_PATH "${LIBLZMA_LIBRARY}" LIBLZMA_LIBRARY)
+endif()
+
+if(LIBLZMA_INCLUDE_DIR AND EXISTS "${LIBLZMA_INCLUDE_DIR}/lzma/version.h")
+    file(STRINGS "${LIBLZMA_INCLUDE_DIR}/lzma/version.h" LIBLZMA_HEADER_CONTENTS REGEX "#define LZMA_VERSION_[A-Z]+ [0-9]+")
+
+    string(REGEX REPLACE ".*#define LZMA_VERSION_MAJOR ([0-9]+).*" "\\1" LIBLZMA_VERSION_MAJOR "${LIBLZMA_HEADER_CONTENTS}")
+    string(REGEX REPLACE ".*#define LZMA_VERSION_MINOR ([0-9]+).*" "\\1" LIBLZMA_VERSION_MINOR "${LIBLZMA_HEADER_CONTENTS}")
+    string(REGEX REPLACE ".*#define LZMA_VERSION_PATCH ([0-9]+).*" "\\1" LIBLZMA_VERSION_PATCH "${LIBLZMA_HEADER_CONTENTS}")
+
+    set(LIBLZMA_VERSION_STRING "${LIBLZMA_VERSION_MAJOR}.${LIBLZMA_VERSION_MINOR}.${LIBLZMA_VERSION_PATCH}")
+    unset(LIBLZMA_HEADER_CONTENTS)
+endif()
+
+# We're using new code known now as XZ, even library still been called LZMA
+# it can be found in http://tukaani.org/xz/
+# Avoid using old codebase
+if (LIBLZMA_LIBRARY)
+  include(CheckLibraryExists)
+  set(CMAKE_REQUIRED_QUIET_SAVE ${CMAKE_REQUIRED_QUIET})
+  set(CMAKE_REQUIRED_QUIET ${LibLZMA_FIND_QUIETLY})
+  if(NOT LIBLZMA_LIBRARY_RELEASE AND NOT LIBLZMA_LIBRARY_DEBUG)
+    set(LIBLZMA_LIBRARY_check ${LIBLZMA_LIBRARY})
+  elseif(LIBLZMA_LIBRARY_RELEASE)
+    set(LIBLZMA_LIBRARY_check ${LIBLZMA_LIBRARY_RELEASE})
+  elseif(LIBLZMA_LIBRARY_DEBUG)
+    set(LIBLZMA_LIBRARY_check ${LIBLZMA_LIBRARY_DEBUG})
+  endif()
+  CHECK_LIBRARY_EXISTS(${LIBLZMA_LIBRARY_check} lzma_auto_decoder "" LIBLZMA_HAS_AUTO_DECODER)
+  CHECK_LIBRARY_EXISTS(${LIBLZMA_LIBRARY_check} lzma_easy_encoder "" LIBLZMA_HAS_EASY_ENCODER)
+  CHECK_LIBRARY_EXISTS(${LIBLZMA_LIBRARY_check} lzma_lzma_preset "" LIBLZMA_HAS_LZMA_PRESET)
+  unset(LIBLZMA_LIBRARY_check)
+  set(CMAKE_REQUIRED_QUIET ${CMAKE_REQUIRED_QUIET_SAVE})
+endif ()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(LibLZMA  REQUIRED_VARS  LIBLZMA_LIBRARY
+                                                          LIBLZMA_INCLUDE_DIR
+                                                          LIBLZMA_HAS_AUTO_DECODER
+                                                          LIBLZMA_HAS_EASY_ENCODER
+                                                          LIBLZMA_HAS_LZMA_PRESET
+                                           VERSION_VAR    LIBLZMA_VERSION_STRING
+                                 )
+mark_as_advanced( LIBLZMA_INCLUDE_DIR LIBLZMA_LIBRARY )
+
+if (LIBLZMA_FOUND)
+    set(LIBLZMA_LIBRARIES ${LIBLZMA_LIBRARY})
+    set(LIBLZMA_INCLUDE_DIRS ${LIBLZMA_INCLUDE_DIR})
+    if(NOT TARGET LibLZMA::LibLZMA)
+        add_library(LibLZMA::LibLZMA UNKNOWN IMPORTED)
+        set_target_properties(LibLZMA::LibLZMA PROPERTIES
+                              INTERFACE_INCLUDE_DIRECTORIES ${LIBLZMA_INCLUDE_DIR}
+                              IMPORTED_LINK_INTERFACE_LANGUAGES C)
+
+        if(LIBLZMA_LIBRARY_RELEASE)
+            set_property(TARGET LibLZMA::LibLZMA APPEND PROPERTY
+                IMPORTED_CONFIGURATIONS RELEASE)
+            set_target_properties(LibLZMA::LibLZMA PROPERTIES
+                IMPORTED_LOCATION_RELEASE "${LIBLZMA_LIBRARY_RELEASE}")
+        endif()
+
+        if(LIBLZMA_LIBRARY_DEBUG)
+            set_property(TARGET LibLZMA::LibLZMA APPEND PROPERTY
+                IMPORTED_CONFIGURATIONS DEBUG)
+            set_target_properties(LibLZMA::LibLZMA PROPERTIES
+                IMPORTED_LOCATION_DEBUG "${LIBLZMA_LIBRARY_DEBUG}")
+        endif()
+
+        if(NOT LIBLZMA_LIBRARY_RELEASE AND NOT LIBLZMA_LIBRARY_DEBUG)
+            set_target_properties(LibLZMA::LibLZMA PROPERTIES
+                IMPORTED_LOCATION "${LIBLZMA_LIBRARY}")
+        endif()
+    endif()
+endif ()

CMakeModules/SimGearComponent.cmake

@@ -12,6 +12,11 @@ macro(simgear_component_common name includePath sourcesList sources headers)
 		set_property(GLOBAL
 			APPEND PROPERTY PUBLIC_HEADERS "${CMAKE_CURRENT_SOURCE_DIR}/${h}")
         set(fh${sourcesList} "${fh${sourcesList}}#${CMAKE_CURRENT_SOURCE_DIR}/${h}")
+
+        # also append headers to the sources list, so that IDEs find the files
+        # correctly (otherwise they are not in the project)
+        set_property(GLOBAL
+            APPEND PROPERTY ${sourcesList} "${CMAKE_CURRENT_SOURCE_DIR}/${h}")
 	endforeach()
 
     set_property(GLOBAL APPEND PROPERTY FG_GROUPS_${sourcesList}_C "${fc${sourcesList}}@")

Doxyfile

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.6
+# Doxyfile 1.8.13
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -38,7 +38,7 @@ PROJECT_NAME           = SimGear
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 3.3.0
+PROJECT_NUMBER         = 2019.2.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -46,10 +46,10 @@ PROJECT_NUMBER         = 3.3.0
 
 PROJECT_BRIEF          = 
 
-# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
-# the documentation. The maximum height of the logo should not exceed 55 pixels
+# in the documentation. The maximum height of the logo should not exceed 55
-# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
-# to the output directory.
+# the logo to the output directory.
 
 PROJECT_LOGO           = 
 
@@ -58,9 +58,9 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ../doxy
+OUTPUT_DIRECTORY       = ../docs/SimGear
 
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
 # will distribute the generated files over these directories. Enabling this
 # option can be useful when feeding doxygen a huge amount of source files, where
@@ -70,6 +70,14 @@ OUTPUT_DIRECTORY       = ../doxy
 
 CREATE_SUBDIRS         = NO
 
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES    = NO
+
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
 # documentation generated by doxygen is written. Doxygen will use this
 # information to generate all constant output in the proper language.
@@ -85,14 +93,14 @@ CREATE_SUBDIRS         = NO
 
 OUTPUT_LANGUAGE        = English
 
-# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
 # descriptions after the members that are listed in the file and class
 # documentation (similar to Javadoc). Set to NO to disable this.
 # The default value is: YES.
 
 BRIEF_MEMBER_DESC      = YES
 
-# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
 # description of a member or function before the detailed description
 #
 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
@@ -127,7 +135,7 @@ ALWAYS_DETAILED_SEC    = NO
 
 INLINE_INHERITED_MEMB  = NO
 
-# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
 # before files name in the file list and in the header files. If set to NO the
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
@@ -197,9 +205,9 @@ MULTILINE_CPP_IS_BRIEF = NO
 
 INHERIT_DOCS           = YES
 
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
-# new page for each member. If set to NO, the documentation of a member will be
+# page for each member. If set to NO, the documentation of a member will be part
-# part of the file/class/namespace that contains it.
+# of the file/class/namespace that contains it.
 # The default value is: NO.
 
 SEPARATE_MEMBER_PAGES  = NO
@@ -261,11 +269,14 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # extension. Doxygen has a built-in mapping, but you can override or extend it
 # using this tag. The format is ext=language, where ext is a file extension, and
 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
-# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
-# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# (default is Fortran), use: inc=Fortran f=C.
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
 #
-# Note For files without extension you can use no_extension as a placeholder.
+# Note: For files without extension you can use no_extension as a placeholder.
 #
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
@@ -282,10 +293,19 @@ EXTENSION_MAPPING      =
 
 MARKDOWN_SUPPORT       = YES
 
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS   = 0
+
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
-# be prevented in individual cases by by putting a % sign in front of the word
+# be prevented in individual cases by putting a % sign in front of the word or
-# or globally by setting AUTOLINK_SUPPORT to NO.
+# globally by setting AUTOLINK_SUPPORT to NO.
 # The default value is: YES.
 
 AUTOLINK_SUPPORT       = YES
@@ -325,13 +345,20 @@ SIP_SUPPORT            = NO
 IDL_PROPERTY_SUPPORT   = YES
 
 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
+# tag is set to YES then doxygen will reuse the documentation of the first
 # member in the group (if any) for the other members of the group. By default
 # all members of a group must be documented explicitly.
 # The default value is: NO.
 
 DISTRIBUTE_GROUP_DOC   = NO
 
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
 # (for instance a group of public functions) to be put as a subgroup of that
 # type (e.g. under the Public Functions section). Set it to NO to prevent
@@ -390,7 +417,7 @@ LOOKUP_CACHE_SIZE      = 0
 # Build related configuration options
 #---------------------------------------------------------------------------
 
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
 # documentation are documented, even if no documentation was available. Private
 # class members and static file members will be hidden unless the
 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
@@ -398,37 +425,37 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 
 EXTRACT_PRIVATE        = NO
 
-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
 # The default value is: NO.
 
 EXTRACT_PACKAGE        = NO
 
-# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
 # included in the documentation.
 # The default value is: NO.
 
 EXTRACT_STATIC         = YES
 
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
-# locally in source files will be included in the documentation. If set to NO
+# locally in source files will be included in the documentation. If set to NO,
 # only classes defined in header files are included. Does not have any effect
 # for Java sources.
 # The default value is: YES.
 
 EXTRACT_LOCAL_CLASSES  = YES
 
-# This flag is only useful for Objective-C code. When set to YES local methods,
+# This flag is only useful for Objective-C code. If set to YES, local methods,
 # which are defined in the implementation section but not in the interface are
-# included in the documentation. If set to NO only methods in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
 # included.
 # The default value is: NO.
 
@@ -453,21 +480,21 @@ HIDE_UNDOC_MEMBERS     = YES
 
 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
 # undocumented classes that are normally visible in the class hierarchy. If set
-# to NO these classes will be included in the various overviews. This option has
+# to NO, these classes will be included in the various overviews. This option
-# no effect if EXTRACT_ALL is enabled.
+# has no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
 HIDE_UNDOC_CLASSES     = YES
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
-# (class|struct|union) declarations. If set to NO these declarations will be
+# (class|struct|union) declarations. If set to NO, these declarations will be
 # included in the documentation.
 # The default value is: NO.
 
 HIDE_FRIEND_COMPOUNDS  = NO
 
 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
-# documentation blocks found inside the body of a function. If set to NO these
+# documentation blocks found inside the body of a function. If set to NO, these
 # blocks will be appended to the function's detailed documentation block.
 # The default value is: NO.
 
@@ -481,7 +508,7 @@ HIDE_IN_BODY_DOCS      = NO
 INTERNAL_DOCS          = NO
 
 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
-# names in lower-case letters. If set to YES upper-case letters are also
+# names in lower-case letters. If set to YES, upper-case letters are also
 # allowed. This is useful if you have classes or files whose names only differ
 # in case and if your file system supports case sensitive file names. Windows
 # and Mac users are advised to set this option to NO.
@@ -490,12 +517,19 @@ INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 
 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
-# their full class and namespace scopes in the documentation. If set to YES the
+# their full class and namespace scopes in the documentation. If set to YES, the
 # scope will be hidden.
 # The default value is: NO.
 
 HIDE_SCOPE_NAMES       = NO
 
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
@@ -523,14 +557,14 @@ INLINE_INFO            = YES
 
 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
 # (detailed) documentation of file and class members alphabetically by member
-# name. If set to NO the members will appear in declaration order.
+# name. If set to NO, the members will appear in declaration order.
 # The default value is: YES.
 
 SORT_MEMBER_DOCS       = YES
 
 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
 # descriptions of file, namespace and class members alphabetically by member
-# name. If set to NO the members will appear in declaration order. Note that
+# name. If set to NO, the members will appear in declaration order. Note that
 # this will also influence the order of the classes in the class list.
 # The default value is: NO.
 
@@ -575,16 +609,14 @@ SORT_BY_SCOPE_NAME     = NO
 
 STRICT_PROTO_MATCHING  = NO
 
-# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
-# todo list. This list is created by putting \todo commands in the
+# list. This list is created by putting \todo commands in the documentation.
-# documentation.
 # The default value is: YES.
 
 GENERATE_TODOLIST      = YES
 
-# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
-# test list. This list is created by putting \test commands in the
+# list. This list is created by putting \test commands in the documentation.
-# documentation.
 # The default value is: YES.
 
 GENERATE_TESTLIST      = YES
@@ -620,8 +652,8 @@ ENABLED_SECTIONS       =
 MAX_INITIALIZER_LINES  = 30
 
 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
-# the bottom of the documentation of classes and structs. If set to YES the list
+# the bottom of the documentation of classes and structs. If set to YES, the
-# will mention the files that were used to generate the documentation.
+# list will mention the files that were used to generate the documentation.
 # The default value is: YES.
 
 SHOW_USED_FILES        = YES
@@ -669,8 +701,7 @@ LAYOUT_FILE            =
 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
 # For LaTeX the style of the bibliography can be controlled using
 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
-# search path. Do not use file names with spaces, bibtex cannot handle them. See
+# search path. See also \cite for info how to create references.
-# also \cite for info how to create references.
 
 CITE_BIB_FILES         = 
 
@@ -694,7 +725,7 @@ QUIET                  = NO
 
 WARNINGS               = YES
 
-# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
 # will automatically be disabled.
 # The default value is: YES.
@@ -711,12 +742,18 @@ WARN_IF_DOC_ERROR      = YES
 
 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
 # are documented, but have no documentation for their parameters or return
-# value. If set to NO doxygen will only warn about wrong or incomplete parameter
+# value. If set to NO, doxygen will only warn about wrong or incomplete
-# documentation, but not about the absence of documentation.
+# parameter documentation, but not about the absence of documentation.
 # The default value is: NO.
 
 WARN_NO_PARAMDOC       = NO
 
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR          = NO
+
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
 # will be replaced by the file and line number from which the warning originated
@@ -740,7 +777,7 @@ WARN_LOGFILE           =
 # The INPUT tag is used to specify the files and/or directories that contain
 # documented source files. You may enter file names like myfile.cpp or
 # directories like /usr/src/myproject. Separate the files or directories with
-# spaces.
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = DoxygenMain.cxx \
@@ -757,12 +794,17 @@ INPUT_ENCODING         = UTF-8
 
 # If the value of the INPUT tag contains directories, you can use the
 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
-# *.h) to filter out the source-files in the directories. If left blank the
+# *.h) to filter out the source-files in the directories.
-# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+#
-# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# Note that for custom extensions or not directly supported extensions you also
-# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# read by doxygen.
-# *.qsf, *.as and *.js.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
 
 FILE_PATTERNS          = *.h \
                          *.hxx \
@@ -852,6 +894,10 @@ IMAGE_PATH             =
 # Note that the filter must not add or remove lines; it is applied before the
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 INPUT_FILTER           = 
 
@@ -861,6 +907,10 @@ INPUT_FILTER           =
 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 FILTER_PATTERNS        = 
 
@@ -925,7 +975,7 @@ REFERENCED_BY_RELATION = NO
 REFERENCES_RELATION    = NO
 
 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
-# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
 # link to the documentation.
 # The default value is: YES.
@@ -972,6 +1022,25 @@ USE_HTAGS              = NO
 
 VERBATIM_HEADERS       = YES
 
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse-libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS          = 
+
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
@@ -1002,7 +1071,7 @@ IGNORE_PREFIX          =
 # Configuration options related to the HTML output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
 GENERATE_HTML          = YES
@@ -1064,13 +1133,15 @@ HTML_FOOTER            =
 
 HTML_STYLESHEET        = 
 
-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
-# defined cascading style sheet that is included after the standard style sheets
+# cascading style sheets that are included after the standard style sheets
 # created by doxygen. Using this option one can overrule certain style aspects.
 # This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefor more robust against future updates.
+# standard style sheet and is therefore more robust against future updates.
-# Doxygen will copy the style sheet file to the output directory. For an example
+# Doxygen will copy the style sheet files to the output directory.
-# see the documentation.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_EXTRA_STYLESHEET  = 
@@ -1117,8 +1188,9 @@ HTML_COLORSTYLE_GAMMA  = 80
 
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
 # page will contain the date and time when the page was generated. Setting this
-# to NO can help when comparing the output of multiple runs.
+# to YES can help to show when doxygen was last run and thus if the
-# The default value is: YES.
+# documentation is up to date.
+# The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_TIMESTAMP         = YES
@@ -1214,15 +1286,15 @@ GENERATE_HTMLHELP      = NO
 CHM_FILE               = 
 
 # The HHC_LOCATION tag can be used to specify the location (absolute path
-# including file name) of the HTML help compiler ( hhc.exe). If non-empty
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
 # doxygen will try to run the HTML help compiler on the generated index.hhp.
 # The file has to be specified with full path.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 HHC_LOCATION           = 
 
-# The GENERATE_CHI flag controls if a separate .chi index file is generated (
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
-# YES) or that it should be included in the master .chm file ( NO).
+# (YES) or that it should be included in the master .chm file (NO).
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
@@ -1234,8 +1306,9 @@ GENERATE_CHI           = NO
 
 CHM_INDEX_ENCODING     = 
 
-# The BINARY_TOC flag controls whether a binary table of contents is generated (
+# The BINARY_TOC flag controls whether a binary table of contents is generated
-# YES) or a normal table of contents ( NO) in the .chm file.
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
@@ -1376,7 +1449,7 @@ ENUM_VALUES_PER_LINE   = 4
 
 TREEVIEW_WIDTH         = 250
 
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
 # external symbols imported via tag files in a separate window.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1405,7 +1478,7 @@ FORMULA_TRANSPARENT    = YES
 
 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
 # http://www.mathjax.org) which uses client side Javascript for the rendering
-# instead of using prerendered bitmaps. Use this if you do not have LaTeX
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
 # installed or if you want to formulas look prettier in the HTML output. When
 # enabled you may also need to install MathJax separately and configure the path
 # to it using the MATHJAX_RELPATH option.
@@ -1475,11 +1548,11 @@ SEARCHENGINE           = NO
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 # implemented using a web server instead of a web client using Javascript. There
-# are two flavours of web server based searching depending on the
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
-# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
+# setting. When disabled, doxygen will generate a PHP script for searching and
-# searching and an index file used by the script. When EXTERNAL_SEARCH is
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
-# enabled the indexing and searching needs to be provided by external tools. See
+# and searching needs to be provided by external tools. See the section
-# the section "External Indexing and Searching" for details.
+# "External Indexing and Searching" for details.
 # The default value is: NO.
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
@@ -1542,7 +1615,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
 GENERATE_LATEX         = NO
@@ -1573,7 +1646,7 @@ LATEX_CMD_NAME         = latex
 
 MAKEINDEX_CMD_NAME     = makeindex
 
-# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
 # documents. This may be useful for small projects and may help to save some
 # trees in general.
 # The default value is: NO.
@@ -1591,9 +1664,12 @@ COMPACT_LATEX          = NO
 PAPER_TYPE             = letter
 
 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
-# that should be included in the LaTeX output. To get the times font for
+# that should be included in the LaTeX output. The package can be specified just
-# instance you can specify
+# by its name or with the correct syntax as to be used with the LaTeX
-# EXTRA_PACKAGES=times
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
@@ -1607,23 +1683,36 @@ EXTRA_PACKAGES         =
 #
 # Note: Only use a user-defined header if you know what you are doing! The
 # following commands have a special meaning inside the header: $title,
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
-# replace them by respectively the title of the page, the current date and time,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# only the current date, the version number of doxygen, the project name (see
+# string, for the replacement values of the other commands the user is referred
-# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
+# to HTML_HEADER.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_HEADER           = 
 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 # generated LaTeX document. The footer should contain everything after the last
-# chapter. If it is left blank doxygen will generate a standard footer.
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
 #
 # Note: Only use a user-defined footer if you know what you are doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_FOOTER           = 
 
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET = 
+
 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the LATEX_OUTPUT output
 # directory. Note that the files will be copied as-is; there are no commands or
@@ -1641,8 +1730,8 @@ LATEX_EXTRA_FILES      =
 
 PDF_HYPERLINKS         = NO
 
-# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
-# the PDF file directly from the LaTeX files. Set this option to YES to get a
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
 # higher quality PDF documentation.
 # The default value is: YES.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1683,11 +1772,19 @@ LATEX_SOURCE_CODE      = NO
 
 LATEX_BIB_STYLE        = plain
 
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP        = NO
+
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
 # readers/editors.
 # The default value is: NO.
@@ -1702,7 +1799,7 @@ GENERATE_RTF           = YES
 
 RTF_OUTPUT             = rtf
 
-# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
 # documents. This may be useful for small projects and may help to save some
 # trees in general.
 # The default value is: NO.
@@ -1739,11 +1836,21 @@ RTF_STYLESHEET_FILE    =
 
 RTF_EXTENSIONS_FILE    = 
 
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE        = NO
+
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
 # classes and files.
 # The default value is: NO.
 
@@ -1767,6 +1874,13 @@ MAN_OUTPUT             = man
 
 MAN_EXTENSION          = .3
 
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR             = 
+
 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
 # will generate one additional man file for each entity documented in the real
 # man page(s). These additional files only source the real man page, but without
@@ -1780,7 +1894,7 @@ MAN_LINKS              = NO
 # Configuration options related to the XML output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
@@ -1794,19 +1908,7 @@ GENERATE_XML           = NO
 
 XML_OUTPUT             = xml
 
-# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_SCHEMA             =
-
-# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_DTD                =
-
-# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to
 # the XML output. Note that enabling this will significantly increase the size
 # of the XML output.
@@ -1819,7 +1921,7 @@ XML_PROGRAMLISTING     = YES
 # Configuration options related to the DOCBOOK output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
 # that can be used to generate PDF.
 # The default value is: NO.
 
@@ -1833,14 +1935,23 @@ GENERATE_DOCBOOK       = NO
 
 DOCBOOK_OUTPUT         = docbook
 
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
-# Definitions (see http://autogen.sf.net) file that captures the structure of
+# AutoGen Definitions (see http://autogen.sf.net) file that captures the
-# the code including all documentation. Note that this feature is still
+# structure of the code including all documentation. Note that this feature is
-# experimental and incomplete at the moment.
+# still experimental and incomplete at the moment.
 # The default value is: NO.
 
 GENERATE_AUTOGEN_DEF   = NO
@@ -1849,7 +1960,7 @@ GENERATE_AUTOGEN_DEF   = NO
 # Configuration options related to the Perl module output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
 # file that captures the structure of the code including all documentation.
 #
 # Note that this feature is still experimental and incomplete at the moment.
@@ -1857,7 +1968,7 @@ GENERATE_AUTOGEN_DEF   = NO
 
 GENERATE_PERLMOD       = NO
 
-# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
 # output from the Perl module output.
 # The default value is: NO.
@@ -1865,9 +1976,9 @@ GENERATE_PERLMOD       = NO
 
 PERLMOD_LATEX          = NO
 
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
 # formatted so it can be parsed by a human reader. This is useful if you want to
-# understand what is going on. On the other hand, if this tag is set to NO the
+# understand what is going on. On the other hand, if this tag is set to NO, the
 # size of the Perl module output will be much smaller and Perl will parse it
 # just the same.
 # The default value is: YES.
@@ -1887,14 +1998,14 @@ PERLMOD_MAKEVAR_PREFIX =
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 
-# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 
 ENABLE_PREPROCESSING   = YES
 
-# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
-# in the source code. If set to NO only conditional compilation will be
+# in the source code. If set to NO, only conditional compilation will be
 # performed. Macro expansion can be done in a controlled way by setting
 # EXPAND_ONLY_PREDEF to YES.
 # The default value is: NO.
@@ -1910,7 +2021,7 @@ MACRO_EXPANSION        = YES
 
 EXPAND_ONLY_PREDEF     = NO
 
-# If the SEARCH_INCLUDES tag is set to YES the includes files in the
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
 # INCLUDE_PATH will be searched if a #include is found.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
@@ -1952,9 +2063,9 @@ PREDEFINED             =
 EXPAND_AS_DEFINED      = 
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
-# remove all refrences to function-like macros that are alone on a line, have an
+# remove all references to function-like macros that are alone on a line, have
-# all uppercase name, and do not end with a semicolon. Such function macros are
+# an all uppercase name, and do not end with a semicolon. Such function macros
-# typically used for boiler-plate code, and will confuse the parser if not
+# are typically used for boiler-plate code, and will confuse the parser if not
 # removed.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
@@ -1974,7 +2085,7 @@ SKIP_FUNCTION_MACROS   = YES
 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
 # section "Linking to external documentation" for more information about the use
 # of tag files.
-# Note: Each tag file must have an unique name (where the name does NOT include
+# Note: Each tag file must have a unique name (where the name does NOT include
 # the path). If a tag file is not located in the directory in which doxygen is
 # run, you must also specify the path to the tagfile here.
 
@@ -1986,20 +2097,21 @@ TAGFILES               =
 
 GENERATE_TAGFILE       = 
 
-# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
-# class index. If set to NO only the inherited external classes will be listed.
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
 # The default value is: NO.
 
 ALLEXTERNALS           = NO
 
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
-# the modules index. If set to NO, only the current project's groups will be
+# in the modules index. If set to NO, only the current project's groups will be
 # listed.
 # The default value is: YES.
 
 EXTERNAL_GROUPS        = YES
 
-# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
 # the related pages index. If set to NO, only the current project's pages will
 # be listed.
 # The default value is: YES.
@@ -2016,14 +2128,14 @@ PERL_PATH              = /usr/bin/perl
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 
-# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
 # disabled, but it is recommended to install and use dot, since it yields more
 # powerful graphs.
 # The default value is: YES.
 
-CLASS_DIAGRAMS         = YES
+CLASS_DIAGRAMS         = NO
 
 # You can define message sequence charts within doxygen comments using the \msc
 # command. Doxygen will then run the mscgen tool (see:
@@ -2041,7 +2153,7 @@ MSCGEN_PATH            =
 
 DIA_PATH               = 
 
-# If set to YES, the inheritance and collaboration graphs will hide inheritance
+# If set to YES the inheritance and collaboration graphs will hide inheritance
 # and usage relations if the target is undocumented or is not a class.
 # The default value is: YES.
 
@@ -2052,9 +2164,9 @@ HIDE_UNDOC_RELATIONS   = YES
 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
 # Bell Labs. The other options in this section have no effect if this option is
 # set to NO
-# The default value is: NO.
+# The default value is: YES.
 
-HAVE_DOT               = NO
+HAVE_DOT               = YES
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 # to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2066,7 +2178,7 @@ HAVE_DOT               = NO
 
 DOT_NUM_THREADS        = 0
 
-# When you want a differently looking font n the dot files that doxygen
+# When you want a differently looking font in the dot files that doxygen
 # generates you can specify the font name using DOT_FONTNAME. You need to make
 # sure dot is able to find the font, which can be done by putting it in a
 # standard location or by setting the DOTFONTPATH environment variable or by
@@ -2114,7 +2226,7 @@ COLLABORATION_GRAPH    = YES
 
 GROUP_GRAPHS           = YES
 
-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 # Language.
 # The default value is: NO.
@@ -2166,22 +2278,24 @@ INCLUDED_BY_GRAPH      = YES
 #
 # Note that enabling this option will significantly increase the time of a run.
 # So in most cases it will be better to enable call graphs for selected
-# functions only using the \callgraph command.
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CALL_GRAPH             = NO
+CALL_GRAPH             = YES
 
 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
 # dependency graph for every global function or class method.
 #
 # Note that enabling this option will significantly increase the time of a run.
 # So in most cases it will be better to enable caller graphs for selected
-# functions only using the \callergraph command.
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CALLER_GRAPH           = NO
+CALLER_GRAPH           = YES
 
 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
 # hierarchy of all classes instead of a textual one.
@@ -2200,11 +2314,17 @@ GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = YES
 
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot.
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
 # to make the SVG files visible in IE 9+ (other browsers do not have this
 # requirement).
-# Possible values are: png, jpg, gif and svg.
+# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
 # The default value is: png.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
@@ -2247,6 +2367,24 @@ MSCFILE_DIRS           =
 
 DIAFILE_DIRS           = 
 
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH      = 
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE      = 
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH  = 
+
 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
 # that will be shown in the graph. If the number of nodes in a graph becomes
 # larger than this value, doxygen will truncate the graph, which is visualized
@@ -2283,7 +2421,7 @@ MAX_DOT_GRAPH_DEPTH    = 0
 
 DOT_TRANSPARENT        = NO
 
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
 # files in one run (i.e. multiple -o and -T options on the command line). This
 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
 # this, this feature is disabled by default.
@@ -2300,7 +2438,7 @@ DOT_MULTI_TARGETS      = YES
 
 GENERATE_LEGEND        = YES
 
-# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
 # files that are used to generate the various graphs.
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.

README.OpenAL

@@ -1,20 +0,0 @@
-[This file is mirrored in both the FlightGear and SimGear packages.]
-
-You *must* have the development components of OpenAL installed on your system
-to build FlightGear!"  You can get a copy here:
-
-      http://connect.creativelabs.com/openal/default.aspx
-
-Build notes:
-
-You can download a versioned release of the openal library from 
-http://www.openal.org/downloads.html. Download the openal source,
-release 0.0.8 (dated February 11, 2006) and run:  
-tar xjvf openal-soft-1.5.304.tar.bz2
-cd openal-soft-1.5.304/
-ccmake .
-
-[ While running ccmake: press 'c' to configure, press 'c' once more, and
-  then press 'g' to generate and exit ]
-
-

README.sound

@@ -0,0 +1,39 @@
+[This file is mirrored in both the FlightGear and SimGear packages.]
+
+For Sound support FlightGear requires one of the two following packages:
+- OpenAL
+- AeonWave
+
+== OpenAL ===
+
+You *must* have the development components of OpenAL installed on your system
+to build FlightGear!"  You can get a copy here:
+
+      http://connect.creativelabs.com/openal/default.aspx
+
+Build notes:
+
+You can download a versioned release of the openal library from
+http://www.openal.org/downloads.html. Download the openal source,
+release 0.0.8 (dated February 11, 2006) and run:
+tar xjvf openal-soft-1.5.304.tar.bz2
+cd openal-soft-1.5.304/
+ccmake .
+
+[ While running ccmake: press 'c' to configure, press 'c' once more, and
+  then press 'g' to generate and exit ]
+
+
+== AeonWave ===
+
+For FlightGear AeonWave has a number of advantages over OpenAL:
+* Correct Doppler effect behavior
+* Default distance attenuation frequency filtering
+* Native support for 29 types of audio formats.
+* Native support for wav, mp3, vorbis and raw file formats.
+
+The source code of AeonWave can be found on GitHub:
+https://github.com/adalinbv
+
+Optimized binary packages are available at:
+http://www.adalin.com/

SimGearConfig.cmake.in

@@ -1,6 +1,7 @@
 include(CMakeFindDependencyMacro)
 
 find_dependency(ZLIB)
+find_dependency(LibLZMA)
 find_dependency(Threads)
 
 # OSG
@@ -18,6 +19,16 @@ set(USE_AEONWAVE @USE_AEONWAVE@)
 
 set(ENABLE_SIMD @ENABLE_SIMD@)
 
+# OpenRTI support
+set(ENABLE_RTI @ENABLE_RTI@)
+if(ENABLE_RTI)
+  set(RTI_FOUND @RTI_FOUND@)
+  if(RTI_FOUND)
+    set(RTI_INCLUDE_DIRS @RTI_INCLUDE_DIRS@)
+    set(RTI_LDFLAGS @RTI_LDFLAGS@)
+  endif(RTI_FOUND)
+endif(ENABLE_RTI)
+
 # Alternative terrain engine based on pagedLOD
 
 set(ENABLE_GDAL @ENABLE_GDAL@)

simgear-version

@@ -0,0 +1 @@
+2020.3.9

simgear/CMakeLists.txt

@@ -6,6 +6,7 @@ foreach( mylibfolder
         bvh
         debug
         embedded_resources
+        emesary
         ephemeris
         io
         magvar
@@ -64,6 +65,9 @@ if(SIMGEAR_SHARED)
         set_property(TARGET SimGearScene PROPERTY VERSION   ${SIMGEAR_VERSION})
         set_property(TARGET SimGearScene PROPERTY SOVERSION ${SIMGEAR_SOVERSION})
     endif()
+
+    export_debug_symbols(SimGearCore)
+    export_debug_symbols(SimGearScene)
 else()
     message(STATUS "Library building mode: STATIC LIBRARIES")
 
@@ -114,11 +118,22 @@ target_include_directories(SimGearCore BEFORE PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
     $<INSTALL_INTERFACE:include>)
 
+# so simgear/simgear_config.h is found
+target_include_directories(SimGearCore BEFORE PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
+    $<INSTALL_INTERFACE:include>)
+
 target_include_directories(SimGearCore PUBLIC
   ${Boost_INCLUDE_DIRS} ${ZLIB_INCLUDE_DIR})
 target_include_directories(SimGearCore PRIVATE
   ${EXPAT_INCLUDE_DIRS} ${CURL_INCLUDE_DIRS})
 
+if (NOT SYSTEM_EXPAT)
+    # XML_STATIC is important to avoid sg_expat_external.h
+    # declaring symbols as declspec(import)
+    target_compile_definitions(SimGearCore PRIVATE HAVE_SIMGEAR_EXPAT_CONFIG_H XML_STATIC)
+endif()
+
     install(TARGETS SimGearCore
             EXPORT SimGearTargets
             LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
@@ -143,40 +158,44 @@ if (NOT SIMGEAR_HEADLESS)
     endif()
 endif()
 
+# we expose ZLib in some of our headers
+target_link_libraries(SimGearCore PUBLIC ${ZLIB_LIBRARY})
 
-target_link_libraries(SimGearCore
+target_link_libraries(SimGearCore PRIVATE
-    ${ZLIB_LIBRARY}
     ${RT_LIBRARY}
     ${DL_LIBRARY}
     ${CMAKE_THREAD_LIBS_INIT}
     ${COCOA_LIBRARY}
     ${CURL_LIBRARIES}
-    ${WINSOCK_LIBRARY})
+    ${WINSOCK_LIBRARY}
+    ${SHLWAPI_LIBRARY}
+    LibLZMA::LibLZMA
+)
 
 if(SYSTEM_EXPAT)
-    target_link_libraries(SimGearCore
+    target_link_libraries(SimGearCore PRIVATE ${EXPAT_LIBRARIES})
-        ${EXPAT_LIBRARIES})
 endif()
 
 if(ENABLE_DNS AND SYSTEM_UDNS)
-    target_link_libraries(SimGearCore
+    target_link_libraries(SimGearCore PRIVATE ${UDNS_LIBRARIES})
-        ${UDNS_LIBRARIES})
 endif()
 
 if(NOT SIMGEAR_HEADLESS)
     target_include_directories(SimGearScene PRIVATE ${PROJECT_SOURCE_DIR}/simgear/canvas/ShivaVG/include)
 
-    target_link_libraries(SimGearScene
+    target_link_libraries(SimGearScene PUBLIC         
         SimGearCore
-        ${ZLIB_LIBRARY}
         ${OPENSCENEGRAPH_LIBRARIES}
+    )
+
+    target_link_libraries(SimGearScene PRIVATE
+        ${ZLIB_LIBRARY}
         ${OPENAL_LIBRARY}
         ${OPENGL_LIBRARY}
         ${JPEG_LIBRARY})
 
     if(ENABLE_GDAL)
-        target_link_libraries(SimGearScene
+        target_link_libraries(SimGearScene PRIVATE ${GDAL_LIBRARIES})
-            ${GDAL_LIBRARIES})
     endif()
 
     # only actually needed by canvas/KeyboardEvent.cxx
@@ -188,5 +207,5 @@ if(ENABLE_RTI)
     set_property(SOURCE hla/RTI13InteractionClass.cxx hla/RTI13ObjectClass.cxx
         hla/RTI13ObjectInstance.cxx hla/RTI13Federate.cxx
         hla/RTI13FederateFactory.cxx
-        APPEND PROPERTY COMPILE_FLAGS "-I${RTI_INCLUDE_DIR}")
+        APPEND PROPERTY COMPILE_FLAGS "-I${RTI_INCLUDE_DIRS}")
 endif(ENABLE_RTI)

simgear/bvh/BVHPager.cxx

@@ -20,9 +20,9 @@
 #include "BVHPager.hxx"
 
 #include <list>
+#include <mutex>
 
 #include <simgear/threads/SGThread.hxx>
-#include <simgear/threads/SGGuard.hxx>
 
 #include "BVHPageNode.hxx"
 #include "BVHPageRequest.hxx"
@@ -37,12 +37,12 @@ struct BVHPager::_PrivateData : protected SGThread {
     struct _LockedQueue {
         void _push(const _Request& request)
         {
-            SGGuard<SGMutex> scopeLock(_mutex);
+            std::lock_guard<std::mutex> scopeLock(_mutex);
             _requestList.push_back(request);
         }
         _Request _pop()
         {
-            SGGuard<SGMutex> scopeLock(_mutex);
+            std::lock_guard<std::mutex> scopeLock(_mutex);
             if (_requestList.empty())
                 return _Request();
             _Request request;
@@ -51,7 +51,7 @@ struct BVHPager::_PrivateData : protected SGThread {
             return request;
         }
     private:
-        SGMutex _mutex;
+        std::mutex _mutex;
         _RequestList _requestList;
     };
     
@@ -62,7 +62,7 @@ struct BVHPager::_PrivateData : protected SGThread {
         }
         void _push(const _Request& request)
         {
-            SGGuard<SGMutex> scopeLock(_mutex);
+            std::lock_guard<std::mutex> scopeLock(_mutex);
             bool needSignal = _requestList.empty();
             _requestList.push_back(request);
             if (needSignal)
@@ -70,7 +70,7 @@ struct BVHPager::_PrivateData : protected SGThread {
         }
         _Request _pop()
         {
-            SGGuard<SGMutex> scopeLock(_mutex);
+            std::lock_guard<std::mutex> scopeLock(_mutex);
             while (_requestList.empty())
                 _waitCondition.wait(_mutex);
             _Request request;
@@ -79,7 +79,7 @@ struct BVHPager::_PrivateData : protected SGThread {
             return request;
         }
     private:
-        SGMutex _mutex;
+        std::mutex _mutex;
         SGWaitCondition _waitCondition;
         _RequestList _requestList;
     };

simgear/canvas/Canvas.cxx

@@ -1,4 +1,5 @@
-// The canvas for rendering with the 2d API
+///@file
+/// The canvas for rendering with the 2d API
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -38,6 +39,75 @@ namespace simgear
 {
 namespace canvas
 {
+  static int globalinstanceid = 1;
+  /**
+   * Camera Callback for moving completed canvas images to subscribed listener.
+   */
+  class CanvasImageCallback : public osg::Camera::DrawCallback {
+    public:
+    osg::Image *_rawImage;
+
+    CanvasImageCallback(osg::Image *rawImage)
+    : _min_delta_tick(1.0 / 8.0) {
+      _previousFrameTick = osg::Timer::instance()->tick();
+      _rawImage = rawImage;
+      SG_LOG(SG_GENERAL,SG_INFO,"CanvasImageCallback created. instance is " << instanceid);
+    }
+
+    virtual void operator()(osg::RenderInfo& renderInfo) const {
+      osg::Timer_t n = osg::Timer::instance()->tick();
+      double dt = osg::Timer::instance()->delta_s(_previousFrameTick, n);
+      if (dt < _min_delta_tick)
+        return;
+      _previousFrameTick = n;
+      SG_LOG(SG_GENERAL,SG_DEBUG,"CanvasImageCallback " << instanceid << ": image available for " << _subscribers.size() << " subscribers. camera is " << renderInfo.getCurrentCamera());
+
+      bool hasSubscribers = false;
+      {
+        OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_lock);
+        hasSubscribers = !_subscribers.empty();
+      }
+      if (hasSubscribers) {
+        //Make sure image can be overwritten by next frame while it is still returned to the client
+        osg::Image* image = new osg::Image(*_rawImage, osg::CopyOp::DEEP_COPY_ALL);
+        {
+          OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_lock);
+          while (!_subscribers.empty()) {
+            try {
+              CanvasImageReadyListener *subs = _subscribers.back();
+              if (subs){
+                subs->imageReady(image);
+              }else{
+                SG_LOG(SG_GENERAL,SG_WARN,"CanvasImageCallback subscriber null");
+              }
+            } catch (...) { }
+            _subscribers.pop_back();
+          }
+        }
+      }
+    }
+
+    void subscribe(CanvasImageReadyListener * subscriber) {
+      OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_lock);
+      _subscribers.push_back(subscriber);
+    }
+
+    void unsubscribe(CanvasImageReadyListener * subscriber) {
+      OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_lock);
+      _subscribers.remove(subscriber);
+    }
+
+    int getSubscriberCount() {
+      return _subscribers.size();
+    }
+
+    private:
+      mutable list<CanvasImageReadyListener*> _subscribers;
+      mutable OpenThreads::Mutex _lock;
+      mutable double _previousFrameTick;
+      double _min_delta_tick;
+      int instanceid = globalinstanceid++;
+  };
 
   //----------------------------------------------------------------------------
   Canvas::CullCallback::CullCallback(const CanvasWeakPtr& canvas):
@@ -247,6 +317,21 @@ namespace canvas
 
       osg::Camera* camera = _texture.getCamera();
 
+      string canvasname = _node->getStringValue("name");
+      int renderToImage = _node->getBoolValue("render-to-image");
+
+      if (renderToImage){
+        CanvasImageCallback *_screenshotCallback = dynamic_cast<CanvasImageCallback*> (camera->getFinalDrawCallback());
+        if (!_screenshotCallback) {
+          // no draw callback yet
+          osg::Image* shot = new osg::Image();
+          shot->allocateImage(getSizeX(), getSizeY(), 24, GL_RGB, GL_UNSIGNED_BYTE);
+          camera->attach(osg::Camera::COLOR_BUFFER, shot);
+          camera->setFinalDrawCallback(new CanvasImageCallback(shot));
+          SG_LOG(SG_GENERAL,SG_INFO,"CanvasImage: attached image and draw callback to camera " << camera << " for canvas " << canvasname << ". Ready for subscriber now.");
+        }
+      }
+
       // TODO Allow custom render order? For now just keep in order with
       //      property tree.
       camera->setRenderOrder(osg::Camera::PRE_RENDER, _node->getIndex());
@@ -346,6 +431,41 @@ namespace canvas
     }
   }
 
+  int Canvas::subscribe(CanvasImageReadyListener * subscriber) {
+    osg::Camera* camera = _texture.getCamera();
+    const string canvasname = _node->getStringValue("name");
+
+    SG_LOG(SG_GENERAL,SG_DEBUG,"CanvasImage: subscribe to canvas " << canvasname.c_str() << ", camera ="<< camera);
+
+    if (!_node->getBoolValue("render-to-image")) {
+      SG_LOG(SG_GENERAL,SG_INFO,"CanvasImage: Setting render-to-image");
+      _node->addChild("render-to-image", 0)->setBoolValue(1);
+      setStatusFlags(STATUS_DIRTY, true);
+    }
+
+    CanvasImageCallback *_screenshotCallback = dynamic_cast<CanvasImageCallback*> (camera->getFinalDrawCallback());
+    if (_screenshotCallback) {
+      // Camera ready for subscriber. Otherwise, draw callback is created by canvas thread later.
+      SG_LOG(SG_GENERAL,SG_DEBUG,"CanvasImage: adding subscriber to camera draw callback");
+      _screenshotCallback->subscribe(subscriber);
+      // TODO: check: Is this the correct way to ensure the canvas will be available?
+      enableRendering(true);
+      return 1;
+    }
+    return 0;
+  }
+
+  int Canvas::unsubscribe(CanvasImageReadyListener * subscriber) {
+    osg::Camera* camera = _texture.getCamera();
+    SG_LOG(SG_GENERAL,SG_DEBUG,"CanvasImage: unsubscribe");
+    CanvasImageCallback *cb = dynamic_cast<CanvasImageCallback*> (camera->getFinalDrawCallback());
+    if (cb) {
+      SG_LOG(SG_GENERAL,SG_DEBUG,"CanvasImage: unsubscribe from camera " << camera);
+      cb->unsubscribe(subscriber);
+    }
+    return 0;
+  }
+
   //----------------------------------------------------------------------------
   bool Canvas::addEventListener( const std::string& type,
                                  const EventListener& cb )
@@ -571,6 +691,10 @@ namespace canvas
       {
         _sampling_dirty = true;
       }
+      else if( name == "anisotropy" )
+      {
+        _texture.setMaxAnisotropy( node->getFloatValue() );
+      }
       else if( name == "additive-blend" )
       {
         _texture.useAdditiveBlend( node->getBoolValue() );

simgear/canvas/Canvas.hxx

@@ -44,6 +44,17 @@ namespace canvas
   class CanvasMgr;
   class MouseEvent;
 
+  /**
+   * A listener interested in completed canvas drawing.
+   */
+  class CanvasImageReadyListener {
+  public:
+    virtual void imageReady(osg::ref_ptr<osg::Image>) = 0;
+    virtual ~CanvasImageReadyListener()
+    {
+    }
+  };
+
   /**
    * Canvas to draw onto (to an off-screen render target).
    */
@@ -71,18 +82,18 @@ namespace canvas
         public osg::NodeCallback
       {
         public:
-          CullCallback(const CanvasWeakPtr& canvas);
+          explicit CullCallback(const CanvasWeakPtr& canvas);
 
         private:
           CanvasWeakPtr _canvas;
 
-          virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
+          void operator()(osg::Node* node, osg::NodeVisitor* nv) override;
       };
       typedef osg::ref_ptr<CullCallback> CullCallbackPtr;
 
-      Canvas(SGPropertyNode* node);
+      explicit Canvas(SGPropertyNode* node);
       virtual ~Canvas();
-      virtual void onDestroy();
+      void onDestroy() override;
 
       void setCanvasMgr(CanvasMgr* canvas_mgr);
       CanvasMgr* getCanvasMgr() const;
@@ -160,7 +171,12 @@ namespace canvas
        */
       void enableRendering(bool force = false);
 
-      void update(double delta_time_sec);
+      void update(double delta_time_sec) override;
+
+      osg::Camera* getCamera();
+      int subscribe(CanvasImageReadyListener * subscriber);
+      int unsubscribe(CanvasImageReadyListener * subscriber);
+      int getSubscriberCount();
 
       bool addEventListener(const std::string& type, const EventListener& cb);
       bool dispatchEvent(const EventPtr& event);
@@ -184,11 +200,9 @@ namespace canvas
       bool propagateEvent( EventPtr const& event,
                            EventPropagationPath const& path );
 
-      virtual void childAdded( SGPropertyNode * parent,
+      void childAdded(SGPropertyNode* parent, SGPropertyNode* child) override;
-                               SGPropertyNode * child );
+      void childRemoved(SGPropertyNode* parent, SGPropertyNode* child) override;
-      virtual void childRemoved( SGPropertyNode * parent,
+      void valueChanged(SGPropertyNode * node) override;
-                                 SGPropertyNode * child );
-      virtual void valueChanged (SGPropertyNode * node);
 
       osg::Texture2D* getTexture() const;
 
@@ -254,8 +268,8 @@ namespace canvas
 
       static SystemAdapterPtr _system_adapter;
 
-      Canvas(const Canvas&); // = delete;
+      Canvas(const Canvas&) = delete;
-      Canvas& operator=(const Canvas&); // = delete;
+      Canvas& operator=(const Canvas&) = delete;
   };
 
 } // namespace canvas

simgear/canvas/CanvasEvent.cxx

@@ -1,4 +1,5 @@
-// Canvas Event for event model similar to DOM Level 3 Event Model
+///@file
+/// Canvas Event for event model similar to DOM Level 3 Event Model
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -125,10 +126,10 @@ namespace canvas
   //----------------------------------------------------------------------------
   std::string Event::typeToStr(int type)
   {
-    TypeMap const& type_map = getTypeMap();
+    auto const& map_by_id = getTypeMap().by<id>();
 
-    TypeMap::map_by<id>::const_iterator it = type_map.by<id>().find(type);
+    auto it = map_by_id.find(type);
-    if( it == type_map.by<id>().end() )
+    if( it == map_by_id.end() )
       return "unknown";
     return it->second;
   }

simgear/canvas/CanvasEvent.hxx

@@ -65,6 +65,11 @@ namespace canvas
       // of the actual event instances.
       virtual ~Event();
 
+      /**
+       * Clone event and set to the given type (Same type if not specified)
+       */
+      virtual Event* clone(int type = 0) const = 0;
+
       /**
        * Get whether this events support bubbling
        */
@@ -110,7 +115,14 @@ namespace canvas
        */
       bool defaultPrevented() const;
 
+      /**
+       * Register a new type string or get the id of an existing type string
+       *
+       * @param type    Type string
+       * @return Id of the given @a type
+       */
       static int getOrRegisterType(const std::string& type);
+
       static int strToType(const std::string& type);
       static std::string typeToStr(int type);
 

simgear/canvas/CanvasEventManager.cxx

@@ -1,4 +1,5 @@
-// Manage event handling inside a Canvas similar to the DOM Level 3 Event Model
+///@file
+/// Manage event handling inside a Canvas similar to the DOM Level 3 Event Model
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -17,9 +18,11 @@
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
 
 #include <simgear_config.h>
+
 #include "CanvasEventManager.hxx"
-#include <simgear/canvas/events/MouseEvent.hxx>
+#include "elements/CanvasElement.hxx"
-#include <simgear/canvas/elements/CanvasElement.hxx>
+#include "events/MouseEvent.hxx"
+
 #include <cmath>
 
 namespace simgear
@@ -114,6 +117,8 @@ namespace canvas
         return handled;
       }
       case Event::DRAG:
+      case Event::DRAG_START:
+      case Event::DRAG_END:
         if( !_last_mouse_down.valid() )
           return false;
         else

simgear/canvas/CanvasEventManager.hxx

@@ -1,4 +1,5 @@
-// Manage event handling inside a Canvas similar to the DOM Level 3 Event Model
+///@file
+/// Manage event handling inside a Canvas similar to the DOM Level 3 Event Model
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/CanvasEventTypes.hxx

@@ -1,4 +1,5 @@
-// Mapping between canvas gui Event types and their names
+///@file
+/// Mapping between canvas gui Event types and their names
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -25,6 +26,8 @@ ENUM_MAPPING(MOUSE_UP,    "mouseup",    MouseEvent)
 ENUM_MAPPING(CLICK,       "click",      MouseEvent)
 ENUM_MAPPING(DBL_CLICK,   "dblclick",   MouseEvent)
 ENUM_MAPPING(DRAG,        "drag",       MouseEvent)
+ENUM_MAPPING(DRAG_START,  "dragstart",  MouseEvent)
+ENUM_MAPPING(DRAG_END,    "dragend",    MouseEvent)
 ENUM_MAPPING(WHEEL,       "wheel",      MouseEvent)
 ENUM_MAPPING(MOUSE_MOVE,  "mousemove",  MouseEvent)
 ENUM_MAPPING(MOUSE_OVER,  "mouseover",  MouseEvent)

simgear/canvas/CanvasEventVisitor.cxx

@@ -1,5 +1,6 @@
-// Visitor for traversing a canvas element hierarchy similar to the traversal
+///@file
-// of the DOM Level 3 Event Model
+/// Visitor for traversing a canvas element hierarchy similar to the traversal
+/// of the DOM Level 3 Event Model
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -18,9 +19,10 @@
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
 
 #include <simgear_config.h>
+
 #include "CanvasEvent.hxx"
 #include "CanvasEventVisitor.hxx"
-#include <simgear/canvas/elements/CanvasElement.hxx>
+#include "elements/CanvasElement.hxx"
 
 namespace simgear
 {

simgear/canvas/CanvasEventVisitor.hxx

@@ -1,5 +1,6 @@
-// Visitor for traversing a canvas element hierarchy similar to the traversal
+///@file
-// of the DOM Level 3 Event Model
+/// Visitor for traversing a canvas element hierarchy similar to the traversal
+/// of the DOM Level 3 Event Model
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/CanvasMgr.cxx

@@ -1,4 +1,5 @@
-// Canvas with 2D rendering API
+///@file
+/// Canvas with 2D rendering API
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -17,12 +18,11 @@
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
 
 #include <simgear_config.h>
+
 #include "CanvasMgr.hxx"
 #include "Canvas.hxx"
 #include "CanvasEventManager.hxx"
 
-#include <boost/bind.hpp>
-
 namespace simgear
 {
 namespace canvas

simgear/canvas/CanvasMgr.hxx

@@ -1,4 +1,5 @@
-// Canvas with 2D rendering API
+///@file
+/// Canvas with 2D rendering API
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -27,11 +28,9 @@ namespace simgear
 namespace canvas
 {
 
-  class CanvasMgr:
+class CanvasMgr : public PropertyBasedMgr
-    public PropertyBasedMgr
 {
 public:
-
     /**
      * @param node    Root node of branch used to control canvasses
      */
@@ -60,8 +59,7 @@ namespace canvas
     CanvasPtr getCanvas(const std::string& name) const;
 
 protected:
-
+    void elementCreated(PropertyBasedElementPtr element) override;
-      virtual void elementCreated(PropertyBasedElementPtr element);
 };
 
 } // namespace canvas

simgear/canvas/CanvasObjectPlacement.cxx

@@ -1,4 +1,5 @@
-// Canvas placement for placing a canvas texture onto osg objects.
+///@file
+/// Canvas placement for placing a canvas texture onto osg objects
 //
 // It also provides a SGPickCallback for passing mouse events to the canvas and
 // manages emissive lighting of the placed canvas.

simgear/canvas/CanvasObjectPlacement.hxx

@@ -1,5 +1,5 @@
 ///@file
-/// Placement for putting a canvas texture onto OpenSceneGraph objects.
+/// Placement for putting a canvas texture onto OpenSceneGraph objects
 ///
 /// It also provides a SGPickCallback for passing mouse events to the canvas and
 /// manages emissive lighting of the placed canvas.
@@ -60,7 +60,7 @@ namespace canvas
        */
       void setCaptureEvents(bool enable);
 
-      virtual bool childChanged(SGPropertyNode* child);
+      bool childChanged(SGPropertyNode* child) override;
 
     protected:
       typedef SGSharedPtr<SGPickCallback> PickCallbackPtr;

simgear/canvas/CanvasPlacement.cxx

@@ -1,4 +1,5 @@
-// Base class for canvas placements
+///@file
+/// Base class for canvas placements
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/CanvasPlacement.hxx

@@ -1,4 +1,5 @@
-// Base class for canvas placements
+///@file
+/// Base class for canvas placements
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -40,9 +41,8 @@ namespace canvas
     protected:
       SGPropertyNode_ptr _node;
 
-    private:
+      Placement(const Placement&) = delete;
-      Placement(const Placement&) /* = delete */;
+      Placement& operator=(const Placement&) = delete;
-      Placement& operator=(const Placement&) /* = delete */;
   };
 
 } // namespace canvas

simgear/canvas/CanvasSystemAdapter.hxx

@@ -1,4 +1,5 @@
-// Adapter for using the canvas with different applications
+///@file
+/// Adapter for using the canvas with different applications
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -29,6 +30,10 @@ namespace HTTP { class Client; }
 namespace canvas
 {
 
+  /**
+   * Provides access to different required systems of the application to the
+   * Canvas
+   */
   class SystemAdapter
   {
     public:

simgear/canvas/CanvasWindow.cxx

@@ -1,4 +1,5 @@
-// Window for placing a Canvas onto it (for dialogs, menus, etc.)
+///@file
+/// Window for placing a Canvas onto it (for dialogs, menus, etc.)
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -212,6 +213,19 @@ namespace canvas
       _resize_left = getRegion().l() + offset.x();
   }
 
+  //----------------------------------------------------------------------------
+  bool Window::handleEvent(const EventPtr& event)
+  {
+    if( auto mouse_event = dynamic_cast<MouseEvent*>(event.get()) )
+    {
+      mouse_event->local_pos =
+      mouse_event->client_pos =
+        mouse_event->screen_pos - toOsg(getPosition());
+    }
+
+    return Image::handleEvent(event);
+  }
+
   //----------------------------------------------------------------------------
   void Window::parseDecorationBorder(const std::string& str)
   {

simgear/canvas/CanvasWindow.hxx

@@ -1,4 +1,5 @@
-// Window for placing a Canvas onto it (for dialogs, menus, etc.)
+///@file
+/// Window for placing a Canvas onto it (for dialogs, menus, etc.)
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -67,8 +68,8 @@ namespace canvas
               Element* parent = 0 );
       virtual ~Window();
 
-      virtual void update(double delta_time_sec);
+      void update(double delta_time_sec) override;
-      virtual void valueChanged(SGPropertyNode* node);
+      void valueChanged(SGPropertyNode* node) override;
 
       const SGVec2<float> getPosition() const;
       const SGRect<float>  getScreenRegion() const;
@@ -83,8 +84,8 @@ namespace canvas
       bool isResizable() const;
       bool isCapturingEvents() const;
 
-      virtual void setVisible(bool visible);
+      void setVisible(bool visible) override;
-      virtual bool isVisible() const;
+      bool isVisible() const override;
 
       /**
        * Moves window on top of all other windows with the same z-index.
@@ -96,6 +97,8 @@ namespace canvas
       void handleResize( uint8_t mode,
                          const osg::Vec2f& offset = osg::Vec2f() );
 
+      bool handleEvent(const EventPtr& event) override;
+
     protected:
 
       enum Attributes

simgear/canvas/ODGauge.cxx

@@ -1,4 +1,5 @@
-// Owner Drawn Gauge helper class
+///@file
+/// Owner Drawn Gauge helper class
 //
 // Written by Harald JOHNSEN, started May 2005.
 //
@@ -6,9 +7,9 @@
 //
 // Ported to OSG by Tim Moore - Jun 2007
 //
-// Heavily modified to be usable for the 2d Canvas by Thomas Geymayer - April 2012
+// Heavily modified to be usable for the 2d Canvas by Thomas Geymayer - April
-// Supports now multisampling/mipmapping, usage of the stencil buffer and placing
+// 2012 Supports now multisampling/mipmapping, usage of the stencil buffer and
-// the texture in the scene by certain filter criteria
+// placing the texture in the scene by certain filter criteria.
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -201,6 +202,12 @@ namespace canvas
     updateSampling();
   }
 
+  //----------------------------------------------------------------------------
+  void ODGauge::setMaxAnisotropy(float anis)
+  {
+    texture->setMaxAnisotropy(anis);
+  }
+
   //----------------------------------------------------------------------------
   void ODGauge::setRender(bool render)
   {
@@ -249,10 +256,16 @@ namespace canvas
 
     if( !texture )
     {
+      // It shouldn't be necessary to allocate an image for the
+      // texture that is the target of dynamic rendering, but
+      // otherwise OSG won't construct all the mipmaps for the texture
+      // and dynamic mipmap generation doesn't work.
+      osg::Image* image = new osg::Image;
+      image->allocateImage(_size_x, _size_y, 1, GL_RGBA, GL_UNSIGNED_BYTE);
       texture = new osg::Texture2D;
       texture->setResizeNonPowerOfTwoHint(false);
-      texture->setTextureSize(_size_x, _size_y);
+      texture->setImage(image);
-      texture->setInternalFormat(GL_RGBA);
+      texture->setUnRefImageDataAfterApply(true);
     }
 
     updateSampling();

simgear/canvas/ODGauge.hxx

@@ -1,4 +1,5 @@
-// Owner Drawn Gauge helper class
+///@file
+/// Owner Drawn Gauge helper class
 //
 // Written by Harald JOHNSEN, started May 2005.
 //
@@ -6,9 +7,9 @@
 //
 // Ported to OSG by Tim Moore - Jun 2007
 //
-// Heavily modified to be usable for the 2d Canvas by Thomas Geymayer - April 2012
+// Heavily modified to be usable for the 2d Canvas by Thomas Geymayer - April
-// Supports now multisampling/mipmapping, usage of the stencil buffer and placing
+// 2012 Supports now multisampling/mipmapping, usage of the stencil buffer and
-// the texture in the scene by certain filter criteria
+// placing the texture in the scene by certain filter criteria.
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -108,6 +109,8 @@ namespace canvas
                         int coverage_samples = 0,
                         int color_samples = 0 );
 
+      void setMaxAnisotropy(float anis);
+
       /**
        * Enable/Disable updating the texture (If disabled the contents of the
        * texture remains with the outcome of the last rendering pass)

simgear/canvas/ShivaVG/src/shConfig.h

@@ -31,6 +31,11 @@
     // FreeBSD
     #define VG_API_FREEBSD
 
+#elif defined(__OpenBSD__)
+
+    // FreeBSD
+    #define VG_API_OPENBSD
+
 #else
 
     // Unsupported system

simgear/canvas/ShivaVG/src/shDefs.h

@@ -34,7 +34,7 @@
 #include <math.h>
 #include <float.h>
 
-#if !defined(VG_API_MACOSX) && !defined(__FreeBSD__)
+#if !defined(VG_API_MACOSX) && !defined(__FreeBSD__) && !defined(__OpenBSD__)
 #  include <malloc.h>
 #endif
 
@@ -161,7 +161,7 @@ SHfloat getMaxFloat();
 
 /* OpenGL headers */
 
-#if defined(VG_API_LINUX) || defined(VG_API_FREEBSD)
+#if defined(VG_API_LINUX) || defined(VG_API_FREEBSD) || defined(VG_API_OPENBSD)
     #include <GL/gl.h>
     #include <GL/glx.h>
 #elif defined(VG_API_MACOSX)

simgear/canvas/ShivaVG/src/shPath.c

@@ -1193,7 +1193,7 @@ VG_API_CALL VGboolean vgInterpolatePath(VGPath dstPath, VGPath startPath,
   SHfloat *procData1, *procData2;
   SHint procSegCount1=0, procSegCount2=0;
   SHint procDataCount1=0, procDataCount2=0;
-  SHuint8 *newSegs, *newData;
+  SHuint8 *newSegs, *newData=0;
   void *userData[4];
   SHint segment1, segment2;
   SHint segindex, s,d,i;

simgear/canvas/VGInitOperation.cxx

@@ -1,4 +1,5 @@
-// osg::Operation to initialize the OpenVG context used for path rendering
+///@file
+/// osg::Operation to initialize the OpenVG context used for path rendering
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/VGInitOperation.hxx

@@ -1,4 +1,5 @@
-// osg::Operation to initialize the OpenVG context used for path rendering
+///@file
+/// osg::Operation to initialize the OpenVG context used for path rendering
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/canvas_fwd.hxx

@@ -1,4 +1,5 @@
-// Canvas forward declarations
+///@file
+/// Canvas forward declarations
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -25,11 +26,9 @@
 #include <osg/ref_ptr>
 #include <osgText/Font>
 
-#include <boost/function.hpp>
+#include <functional>
-#include <boost/shared_ptr.hpp>
-#include <boost/weak_ptr.hpp>
-
 #include <map>
+#include <memory>
 #include <vector>
 
 namespace simgear
@@ -61,8 +60,8 @@ namespace canvas
 
 #define SG_FWD_DECL(name)\
   class name;\
-  typedef boost::shared_ptr<name> name##Ptr;\
+  typedef std::shared_ptr<name> name##Ptr;\
-  typedef boost::weak_ptr<name> name##WeakPtr;
+  typedef std::weak_ptr<name> name##WeakPtr;
 
   SG_FWD_DECL(Placement)
   SG_FWD_DECL(SystemAdapter)
@@ -84,10 +83,10 @@ namespace canvas
   typedef osg::ref_ptr<osgText::Font> FontPtr;
 
   typedef std::vector<PlacementPtr> Placements;
-  typedef boost::function<Placements( SGPropertyNode*,
+  typedef std::function<Placements( SGPropertyNode*,
                                     CanvasPtr )> PlacementFactory;
 
-  typedef boost::function<void(const EventPtr&)> EventListener;
+  typedef std::function<void(const EventPtr&)> EventListener;
 
 } // namespace canvas
 } // namespace simgear

simgear/canvas/elements/CanvasElement.cxx

@@ -1,4 +1,5 @@
-// Interface for 2D Canvas element
+///@file
+/// Interface for 2D Canvas element
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -271,8 +272,7 @@ namespace canvas
   //----------------------------------------------------------------------------
   void Element::setFocus()
   {
-    CanvasPtr canvas = _canvas.lock();
+    if( auto canvas = _canvas.lock() )
-    if( canvas )
       canvas->setFocusElement(this);
   }
 

simgear/canvas/elements/CanvasElement.hxx

@@ -29,9 +29,6 @@
 #include <osg/BoundingBox>
 #include <osg/MatrixTransform>
 
-#include <boost/bind.hpp>
-#include <boost/function.hpp>
-
 namespace osg
 {
   class Drawable;
@@ -62,9 +59,9 @@ namespace canvas
           OSGUserData(ElementPtr element);
       };
 
-      typedef boost::function<bool(Element&, const SGPropertyNode*)>
+      typedef std::function<bool(Element&, const SGPropertyNode*)>
               StyleSetterFunc;
-      typedef boost::function<void(Element&, const SGPropertyNode*)>
+      typedef std::function<void(Element&, const SGPropertyNode*)>
               StyleSetterFuncUnchecked;
       struct StyleSetter:
         public SGReferenced
@@ -95,7 +92,7 @@ namespace canvas
        *
        */
       virtual ~Element() = 0;
-      virtual void onDestroy();
+      void onDestroy() override;
 
       ElementPtr getParent() const;
       CanvasWeakPtr getCanvas() const;
@@ -105,7 +102,7 @@ namespace canvas
        *
        * @param dt  Frame time in seconds
        */
-      virtual void update(double dt);
+      void update(double dt) override;
 
       bool addEventListener(const std::string& type, const EventListener& cb);
       virtual void clearEventListener();
@@ -154,11 +151,9 @@ namespace canvas
        */
       osg::Vec2f posToLocal(const osg::Vec2f& pos) const;
 
-      virtual void childAdded( SGPropertyNode * parent,
+      void childAdded(SGPropertyNode* parent, SGPropertyNode* child) override;
-                               SGPropertyNode * child );
+      void childRemoved(SGPropertyNode* parent, SGPropertyNode* child) override;
-      virtual void childRemoved( SGPropertyNode * parent,
+      void valueChanged(SGPropertyNode* child) override;
-                                 SGPropertyNode * child );
-      virtual void valueChanged(SGPropertyNode * child);
 
       virtual bool setStyle( const SGPropertyNode* child,
                              const StyleInfo* style_info = 0 );
@@ -321,7 +316,7 @@ namespace canvas
       StyleSetter
       addStyle( const std::string& name,
                 const std::string& type,
-                const boost::function<void (Derived&, T2)>& setter,
+                const std::function<void (Derived&, T2)>& setter,
                 bool inheritable = true )
       {
         StyleInfo& style_info = _style_setters[ name ];
@@ -347,13 +342,10 @@ namespace canvas
         if( style->func )
           style = style->next = new StyleSetter;
 
-        style->func = boost::bind
+        style->func = std::bind(&type_match<Derived>::call,
-        (
+                                std::placeholders::_1,
-          &type_match<Derived>::call,
+                                std::placeholders::_2,
-          _1,
+                                bindStyleSetter<T1>(name, setter));
-          _2,
-          bindStyleSetter<T1>(name, setter)
-        );
         return *style;
       }
 
@@ -365,7 +357,7 @@ namespace canvas
       StyleSetter
       addStyle( const std::string& name,
                 const std::string& type,
-                const boost::function<void (Derived&, T)>& setter,
+                const std::function<void (Derived&, T)>& setter,
                 bool inheritable = true )
       {
         return addStyle<T, T>(name, type, setter, inheritable);
@@ -386,7 +378,7 @@ namespace canvas
         (
           name,
           type,
-          boost::function<void (Derived&, T)>(setter),
+          std::function<void (Derived&, T)>(setter),
           inheritable
         );
       }
@@ -407,7 +399,7 @@ namespace canvas
         (
           name,
           type,
-          boost::function<void (Derived&, T2)>(setter),
+          std::function<void (Derived&, T2)>(setter),
           inheritable
         );
       }
@@ -426,7 +418,7 @@ namespace canvas
         (
           name,
           type,
-          boost::function<void (Derived&, const std::string&)>(setter),
+          std::function<void (Derived&, const std::string&)>(setter),
           inheritable
         );
       }
@@ -489,7 +481,7 @@ namespace canvas
       StyleSetter
       addStyle( const std::string& name,
                 const std::string& type,
-                const boost::function<void (Other&, T2)>& setter,
+                const std::function<void (Other&, T2)>& setter,
                 OtherRef Derived::*instance_ref,
                 bool inheritable = true )
       {
@@ -519,7 +511,7 @@ namespace canvas
         (
           name,
           type,
-          boost::function<void (Other&, const std::string&)>(setter),
+          std::function<void (Other&, const std::string&)>(setter),
           instance_ref,
           inheritable
         );
@@ -527,44 +519,37 @@ namespace canvas
 
       template<typename T, class Derived, class Other, class OtherRef>
       static
-      boost::function<void (Derived&, T)>
+      std::function<void (Derived&, T)>
       bindOther( void (Other::*setter)(T), OtherRef Derived::*instance_ref )
       {
-        return boost::bind(setter, boost::bind(instance_ref, _1), _2);
+        return std::bind(setter,
+                         std::bind(instance_ref, std::placeholders::_1),
+                         std::placeholders::_2);
       }
 
       template<typename T, class Derived, class Other, class OtherRef>
       static
-      boost::function<void (Derived&, T)>
+      std::function<void (Derived&, T)>
-      bindOther( const boost::function<void (Other&, T)>& setter,
+      bindOther( const std::function<void (Other&, T)>& setter,
                  OtherRef Derived::*instance_ref )
       {
-        return boost::bind
+        return std::bind(setter,
-        (
+                         std::bind(&reference_from_pointer<Other, OtherRef>,
-          setter,
+                                   std::bind(instance_ref, std::placeholders::_1)),
-          boost::bind
+                         std::placeholders::_2);
-          (
-            &reference_from_pointer<Other, OtherRef>,
-            boost::bind(instance_ref, _1)
-          ),
-          _2
-        );
       }
 
       template<typename T1, typename T2, class Derived>
       static
       StyleSetterFuncUnchecked
       bindStyleSetter( const std::string& name,
-                       const boost::function<void (Derived&, T2)>& setter )
+                       const std::function<void (Derived&, T2)>& setter )
       {
-        return boost::bind
+        return std::bind(setter,
-        (
-          setter,
                          // We will only call setters with Derived instances, so we can safely
                          // cast here.
-          boost::bind(&derived_cast<Derived>, _1),
+                         std::bind(&derived_cast<Derived>, std::placeholders::_1),
-          boost::bind(&getValue<T1>, _2)
+                         std::bind(&getValue<T1>, std::placeholders::_2));
-        );
       }
 
       bool isStyleEmpty(const SGPropertyNode* child) const;
@@ -597,7 +582,7 @@ namespace canvas
 
       osg::ref_ptr<osg::Drawable> _drawable;
 
-      Element(const Element&);// = delete
+      Element(const Element&) = delete;
 
       template<class Derived>
       static Derived& derived_cast(Element& el)

simgear/canvas/elements/CanvasGroup.cxx

@@ -1,4 +1,5 @@
-// A group of 2D Canvas elements
+///@file
+/// A group of 2D Canvas elements
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -168,6 +169,7 @@ namespace canvas
     if( !_scene_group.valid() )
       return warnSceneGroupExpired("clearEventListener");
 
+    // TODO should this be recursive?
     for(size_t i = 0; i < _scene_group->getNumChildren(); ++i)
       getChildByIndex(i)->clearEventListener();
   }

simgear/canvas/elements/CanvasGroup.hxx

@@ -1,4 +1,5 @@
-// A group of 2D Canvas elements
+///@file
+/// A group of 2D Canvas elements
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -86,14 +87,15 @@ namespace canvas
        */
       ElementPtr getElementById(const std::string& id);
 
-      virtual void clearEventListener();
+      void clearEventListener() override;
 
-      virtual bool traverse(EventVisitor& visitor);
+      bool traverse(EventVisitor& visitor) override;
 
-      virtual bool setStyle( const SGPropertyNode* child,
+      bool setStyle( const SGPropertyNode* child,
-                             const StyleInfo* style_info = 0 );
+                     const StyleInfo* style_info = 0 ) override;
 
-      virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
+      osg::BoundingBox
+      getTransformedBounds(const osg::Matrix& m) const override;
 
     protected:
 
@@ -105,11 +107,11 @@ namespace canvas
        */
       virtual ElementFactory getChildFactory(const std::string& type) const;
 
-      virtual void updateImpl(double dt);
+      void updateImpl(double dt) override;
 
-      virtual void childAdded(SGPropertyNode * child);
+      void childAdded(SGPropertyNode * child) override;
-      virtual void childRemoved(SGPropertyNode * child);
+      void childRemoved(SGPropertyNode * child) override;
-      virtual void childChanged(SGPropertyNode * child);
+      void childChanged(SGPropertyNode * child) override;
 
       void handleZIndexChanged(ElementPtr child, int z_index = 0);
 

simgear/canvas/elements/CanvasImage.cxx

@@ -1,4 +1,5 @@
-// An image on the Canvas
+///@file
+/// An image on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -837,5 +838,143 @@ namespace canvas
     return false;
   }
 
+  void Image::fillRect(const SGRect<int>& rect, const std::string& c)
+  {
+    osg::Vec4 color(1,1,1,1);
+    if(!c.empty() && !parseColor(c, color))
+      return;
+    
+    fillRect(rect, color);
+  }
+
+void fillRow(GLubyte* row, GLuint pixel, GLuint width, GLuint pixelBytes)
+{
+  GLubyte* dst = row;
+  for (GLuint x = 0; x < width; ++x) {
+    memcpy(dst, &pixel, pixelBytes);
+    dst += pixelBytes;
+  }
+}
+
+SGRect<int> intersectRect(const SGRect<int>& a, const SGRect<int>& b)
+{
+  SGVec2<int> m1 = max(a.getMin(), b.getMin());
+  SGVec2<int> m2 = min(a.getMax(), b.getMax());
+  return SGRect<int>(m1, m2);
+}
+
+  void Image::fillRect(const SGRect<int>& rect, const osg::Vec4& color)
+  {
+    osg::ref_ptr<osg::Image> image = _texture->getImage();
+    if (!image) {
+      allocateImage();
+      image = _texture->getImage();
+    }
+      
+      if (image->getDataVariance() != osg::Object::DYNAMIC) {
+          image->setDataVariance(osg::Object::DYNAMIC);
+      }
+      
+    const auto format = image->getInternalTextureFormat();
+    
+    auto clippedRect = intersectRect(rect, SGRect<int>(0, 0, image->s(), image->t()));
+    if ((clippedRect.width() == 0) || (clippedRect.height() == 0)) {
+      return;
+    }
+    
+    GLubyte* rowData = nullptr;
+    size_t rowByteSize = 0;
+    GLuint pixelWidth = clippedRect.width();
+    GLuint pixel = 0;
+    GLuint pixelBytes = 0;
+    
+    switch (format) {
+    case GL_RGBA8:
+    case GL_RGBA:
+        rowByteSize = pixelWidth * 4;
+        rowData = static_cast<GLubyte*>(alloca(rowByteSize));
+        
+        // assume litte-endian, so read out backwards, hence when we memcpy
+        // the data, it ends up in RGBA order
+        pixel = color.asABGR();
+        pixelBytes = 4;
+        fillRow(rowData, pixel, pixelWidth, pixelBytes);
+        break;
+    
+    case GL_RGB8:
+    case GL_RGB:
+        rowByteSize = pixelWidth * 3;
+        rowData = static_cast<GLubyte*>(alloca(rowByteSize));
+        pixel = color.asABGR();
+        pixelBytes = 3;
+        fillRow(rowData, pixel, pixelWidth, pixelBytes);
+        break;
+        
+    default:
+      SG_LOG(SG_IO, SG_WARN, "Image::fillRect: unsupported internal image format:" << format);
+      return;
+    }
+    
+    for (int row=clippedRect.t(); row < clippedRect.b(); ++row) {
+      GLubyte* imageData = image->data(clippedRect.l(), row);
+      memcpy(imageData, rowData, rowByteSize);
+    }
+      
+    image->dirty();
+    auto c = getCanvas().lock();
+    c->enableRendering(true); // force a repaint
+  }
+
+  void Image::setPixel(int x, int y, const std::string& c)
+  {
+    osg::Vec4 color(1,1,1,1);
+    if(!c.empty() && !parseColor(c, color))
+      return;
+    
+    setPixel(x, y, color);
+  }
+
+  void Image::setPixel(int x, int y, const osg::Vec4& color)
+  {
+    osg::ref_ptr<osg::Image> image = _texture->getImage();
+    if (!image) {
+        allocateImage();
+        image = _texture->getImage();
+    }
+     
+    if (image->getDataVariance() != osg::Object::DYNAMIC) {
+      image->setDataVariance(osg::Object::DYNAMIC);
+    }
+      
+    image->setColor(color, x, y);
+  }
+
+    void Image::dirtyPixels()
+    {
+        osg::ref_ptr<osg::Image> image = _texture->getImage();
+        if (!image)
+            return;
+        image->dirty();
+        auto c = getCanvas().lock();
+        c->enableRendering(true); // force a repaint
+    }
+
+  void Image::allocateImage()
+  {
+    osg::Image* image = new osg::Image;
+    // default to RGBA
+    image->allocateImage(_node->getIntValue("size[0]"), _node->getIntValue("size[1]"), 1, GL_RGBA, GL_UNSIGNED_BYTE);
+    image->setInternalTextureFormat(GL_RGBA);
+    _texture->setImage(image);
+  }
+
+
+osg::ref_ptr<osg::Image> Image::getImage() const
+{
+    if (!_texture)
+        return {};
+    return _texture->getImage();
+}
+
 } // namespace canvas
 } // namespace simgear

simgear/canvas/elements/CanvasImage.hxx

@@ -1,4 +1,5 @@
-// An image on the Canvas
+///@file
+/// An image on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -53,7 +54,7 @@ namespace canvas
              ElementWeakPtr parent = 0 );
       virtual ~Image();
 
-      virtual void valueChanged(SGPropertyNode* child);
+      void valueChanged(SGPropertyNode* child) override;
 
       void setSrcCanvas(CanvasPtr canvas);
       CanvasWeakPtr getSrcCanvas() const;
@@ -93,13 +94,35 @@ namespace canvas
 
       const SGRect<float>& getRegion() const;
 
-      bool handleEvent(const EventPtr& event);
+      bool handleEvent(const EventPtr& event) override;
 
       /**
        *
        */
       void setSourceRect(const SGRect<float>& sourceRect);
 
+      /**
+       * fill the specified rectangle of the image, with an RGB value
+       */
+      void fillRect(const SGRect<int>& rect, const std::string& color);
+      
+      /**
+       * fill the specified rectangle of the image, with an RGB value
+       */
+      void fillRect(const SGRect<int>& rect, const osg::Vec4& color);
+      
+      void setPixel(int x, int y, const std::string& color);
+      
+      void setPixel(int x, int y, const osg::Vec4& color);
+
+      /**
+        * mark the image pixels as modified, so the canvas is re-painted
+       */
+      void dirtyPixels();
+      
+      osg::ref_ptr<osg::Image> getImage() const;
+      
+    //  void setRow(int row, int offset, )
     protected:
       enum ImageAttributes
       {
@@ -108,9 +131,9 @@ namespace canvas
         SRC_CANVAS     = DEST_SIZE << 1
       };
 
-      virtual void updateImpl(double dt);
+      void updateImpl(double dt) override;
 
-      virtual void childChanged(SGPropertyNode * child);
+      void childChanged(SGPropertyNode * child) override;
 
       void setupDefaultDimensions();
       SGRect<int> getTextureDimensions() const;
@@ -124,6 +147,8 @@ namespace canvas
                       HTTP::Request& request,
                       const std::string& type );
 
+      void allocateImage();
+      
       osg::ref_ptr<osg::Texture2D> _texture;
       // TODO optionally forward events to canvas
       CanvasWeakPtr _src_canvas;

simgear/canvas/elements/CanvasMap.cxx

@@ -1,5 +1,6 @@
-// A group of 2D Canvas elements which get automatically transformed according
+///@file
-// to the map parameters.
+/// A group of 2D Canvas elements which get automatically transformed according
+/// to the map parameters.
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -96,6 +97,8 @@ namespace canvas
           || (!geo_node->isDirty() && !_projection_dirty) )
         continue;
 
+      double latD = -9999.0, lonD = -9999.0;
+      if (geo_node->isDirty()) {
         GeoCoord lat = parseGeoCoord(geo_node->getLat());
         if( lat.type != GeoCoord::LATITUDE )
           continue;
@@ -104,9 +107,16 @@ namespace canvas
         if( lon.type != GeoCoord::LONGITUDE )
           continue;
         
-      Projection::ScreenPosition pos =
+        // save the parsed values so we can re-use them if only projection
-        _projection->worldToScreen(lat.value, lon.value);
+        // is changed (very common case for moving vehicle)
+        latD = lat.value;
+        lonD = lon.value;
+        geo_node->setCachedLatLon(std::make_pair(latD, lonD));
+      } else {
+        std::tie(latD, lonD) = geo_node->getCachedLatLon();
+      }
       
+      Projection::ScreenPosition pos = _projection->worldToScreen(latD, lonD);
       geo_node->setScreenPos(pos.x, pos.y);
 
 //      geo_node->print();
@@ -200,9 +210,17 @@ namespace canvas
 
     _projection->setWorldPosition(_node->getDoubleValue(REF_LAT),
                                   _node->getDoubleValue(REF_LON));
-    _projection->setOrientation(_node->getFloatValue(HDG));
+
-    _projection->setScreenRange(_node->getDoubleValue(SCREEN_RANGE));
+    // Only set existing properties to prevent using 0 instead of default values
-    _projection->setRange(_node->getDoubleValue(RANGE));
+
+    if( auto heading = _node->getChild(HDG) )
+      _projection->setOrientation(heading->getFloatValue());
+
+    if( auto screen_range = _node->getChild(SCREEN_RANGE) )
+      _projection->setScreenRange(screen_range->getDoubleValue());
+
+    if( auto range = _node->getChild(RANGE) )
+      _projection->setRange(range->getDoubleValue());
 
     _projection_dirty = true;
   }

simgear/canvas/elements/CanvasMap.hxx

@@ -1,5 +1,6 @@
-// A group of 2D Canvas elements which get automatically transformed according
+///@file
-// to the map parameters.
+/// A group of 2D Canvas elements which get automatically transformed according
+/// to the map parameters.
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -46,16 +47,14 @@ namespace canvas
       virtual ~Map();
 
     protected:
-      virtual void updateImpl(double dt);
+      void updateImpl(double dt) override;
 
       void updateProjection(SGPropertyNode* type_node);
 
-      virtual void childAdded( SGPropertyNode* parent,
+      void childAdded(SGPropertyNode* parent, SGPropertyNode* child) override;
-                               SGPropertyNode* child );
+      void childRemoved(SGPropertyNode* parent, SGPropertyNode* child) override;
-      virtual void childRemoved( SGPropertyNode* parent,
+      void valueChanged(SGPropertyNode* child) override;
-                                 SGPropertyNode* child );
+      void childChanged(SGPropertyNode* child) override;
-      virtual void valueChanged(SGPropertyNode* child);
-      virtual void childChanged(SGPropertyNode* child);
 
       using GeoNodes =
         std::unordered_map<SGPropertyNode*, std::shared_ptr<GeoNodePair>>;

simgear/canvas/elements/CanvasPath.cxx

@@ -1,4 +1,5 @@
-// An OpenVG path on the Canvas
+///@file
+/// An OpenVG path on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -230,9 +231,12 @@ namespace canvas
           vgDestroyPaint(_paint_fill);
       }
 
-      virtual const char* className() const { return "PathDrawable"; }
+      const char* className() const override
-      virtual osg::Object* cloneType() const { return new PathDrawable(_path_element); }
+      { return "PathDrawable"; }
-      virtual osg::Object* clone(const osg::CopyOp&) const { return new PathDrawable(_path_element); }
+      osg::Object* cloneType() const override
+      { return new PathDrawable(_path_element); }
+      osg::Object* clone(const osg::CopyOp&) const override
+      { return new PathDrawable(_path_element); }
 
       /**
        * Replace the current path segments with the new ones
@@ -383,7 +387,7 @@ namespace canvas
       /**
        * Draw callback
        */
-      virtual void drawImplementation(osg::RenderInfo& renderInfo) const
+      void drawImplementation(osg::RenderInfo& renderInfo) const override
       {
         if( _attributes_dirty & PATH )
           return;
@@ -555,13 +559,13 @@ namespace canvas
       /**
        * Compute the bounding box
        */
-      virtual osg::BoundingBox
+      osg::BoundingBox
 #if OSG_VERSION_LESS_THAN(3,3,2)
       computeBound()
 #else
       computeBoundingBox()
 #endif
-      const
+      const override
       {
         if( _path == VG_INVALID_HANDLE || (_attributes_dirty & PATH) )
           return osg::BoundingBox();
@@ -667,7 +671,7 @@ namespace canvas
       struct PathUpdateCallback:
         public osg::Drawable::UpdateCallback
       {
-        virtual void update(osg::NodeVisitor*, osg::Drawable* drawable)
+        void update(osg::NodeVisitor*, osg::Drawable* drawable) override
         {
           static_cast<PathDrawable*>(drawable)->update();
         }
@@ -859,6 +863,9 @@ namespace canvas
   //----------------------------------------------------------------------------
   void Path::childChanged(SGPropertyNode* child)
   {
+    if( child->getParent() != _node )
+      return;
+      
     const std::string& name = child->getNameString();
     const std::string &prName = child->getParent()->getNameString();
 
@@ -888,17 +895,16 @@ namespace canvas
       return;
     }
 
-    if( child->getParent() != _node )
-      return;
-
     if( name == "cmd" )
       _attributes_dirty |= CMDS;
     else if( name == "coord" )
       _attributes_dirty |= COORDS;
     else if ( name == "svg")
+    {
       _hasSVG = true;
       _attributes_dirty |= SVG;
     }
+  }
 
   //----------------------------------------------------------------------------
   std::vector<float> splitAndConvert(const char del[], const std::string& str)

simgear/canvas/elements/CanvasPath.hxx

@@ -1,4 +1,5 @@
-// An OpenVG path on the Canvas
+///@file
+/// An OpenVG path on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -40,7 +41,8 @@ namespace canvas
             ElementWeakPtr parent = 0 );
       virtual ~Path();
 
-      virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
+      osg::BoundingBox
+      getTransformedBounds(const osg::Matrix& m) const override;
 
       /** Add a segment with the given command and coordinates */
       Path& addSegment(uint8_t cmd, std::initializer_list<float> coords = {});
@@ -86,10 +88,10 @@ namespace canvas
       bool _hasRect : 1;
       SGRectf _rect;
 
-      virtual void updateImpl(double dt);
+      void updateImpl(double dt) override;
 
-      virtual void childRemoved(SGPropertyNode * child);
+      void childRemoved(SGPropertyNode * child) override;
-      virtual void childChanged(SGPropertyNode * child);
+      void childChanged(SGPropertyNode * child) override;
 
       void parseRectToVGPath();
   };

simgear/canvas/elements/CanvasText.cxx

@@ -1,4 +1,5 @@
-// A text on the Canvas
+///@file
+/// A text on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -17,6 +18,7 @@
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
 
 #include <simgear_config.h>
+
 #include "CanvasText.hxx"
 #include <simgear/canvas/Canvas.hxx>
 #include <simgear/canvas/CanvasSystemAdapter.hxx>
@@ -51,26 +53,30 @@ namespace canvas
       TextLine lineAt(size_t i) const;
 
       /// Get nearest line to given y-coordinate
+#if OSG_VERSION_LESS_THAN(3,6,5)
       TextLine nearestLine(float pos_y) const;
-
-
       SGVec2i sizeForWidth(int w) const;
-
-      virtual osg::BoundingBox
-#if OSG_VERSION_LESS_THAN(3,3,2)
-      computeBound()
 #else
-      computeBoundingBox()
+      TextLine nearestLine(float pos_y);
+      SGVec2i sizeForWidth(int w);
+#endif
+
+#if OSG_VERSION_LESS_THAN(3,3,2)
+      osg::BoundingBox computeBound() const override;
+#else
+      osg::BoundingBox computeBoundingBox() const override;
 #endif
-      const;
 
     protected:
-
       friend class TextLine;
 
       canvas::Text *_text_element;
 
-      virtual void computePositions(unsigned int contextID) const;
+#if OSG_VERSION_LESS_THAN(3,5,6)
+     void computePositions(unsigned int contextID) const override;
+#else
+     void computePositionsImplementation() override;
+#endif
 };
 
   class TextLine
@@ -121,6 +127,7 @@ namespace canvas
 
     _quads = &text->_textureGlyphQuadMap.begin()->second;
 
+#if OSG_VERSION_LESS_THAN(3,5,6)
     GlyphQuads::LineNumbers const& line_numbers = _quads->_lineNumbers;
     GlyphQuads::LineNumbers::const_iterator begin_it =
       std::lower_bound(line_numbers.begin(), line_numbers.end(), _line);
@@ -132,6 +139,9 @@ namespace canvas
     _begin = begin_it - line_numbers.begin();
     _end = std::upper_bound(begin_it, line_numbers.end(), _line)
          - line_numbers.begin();
+#else
+  // TODO: Need 3.5.6 version of this
+#endif
   }
 
   //----------------------------------------------------------------------------
@@ -160,12 +170,17 @@ namespace canvas
 
     if( empty() )
       return pos;
+
+#if OSG_VERSION_GREATER_OR_EQUAL(3,5,6)
+    // TODO: need 3.5.6 version of this.
+#else
 #if OSG_VERSION_LESS_THAN(3,3,5)
       GlyphQuads::Coords2 const& coords = _quads->_coords;
 #else
       GlyphQuads::Coords2 refCoords = _quads->_coords;
       GlyphQuads::Coords2::element_type &coords = *refCoords.get();
 #endif
+
       size_t global_i = _begin + i;
 
       if (global_i == _begin)
@@ -188,6 +203,7 @@ namespace canvas
               // position at center between characters
               pos.x() = 0.5 * (prev_r + cur_l);
       }
+#endif
 
     return pos;
   }
@@ -198,7 +214,10 @@ namespace canvas
     if (empty())
       return cursorPos(0);
 
-    GlyphQuads::Glyphs const& glyphs = _quads->_glyphs;
+#if OSG_VERSION_GREATER_OR_EQUAL(3,5,6)
+  // TODO: need 3.5.7 version of this.
+	return cursorPos(0);
+#else
 #if OSG_VERSION_LESS_THAN(3,3,5)
     GlyphQuads::Coords2 const& coords = _quads->_coords;
 #else
@@ -206,6 +225,8 @@ namespace canvas
     GlyphQuads::Coords2::element_type &coords = *refCoords.get();
 #endif
 
+    GlyphQuads::Glyphs const& glyphs = _quads->_glyphs;
+
     float const HIT_FRACTION = 0.6;
     float const character_width = _text->getCharacterHeight()
                                 * _text->getCharacterAspectRatio();
@@ -224,6 +245,7 @@ namespace canvas
     }
 
     return cursorPos(i - _begin);
+#endif
   }
 
   //----------------------------------------------------------------------------
@@ -302,9 +324,16 @@ namespace canvas
   }
 
   //----------------------------------------------------------------------------
+#if OSG_VERSION_LESS_THAN(3,6,5)
   TextLine Text::TextOSG::nearestLine(float pos_y) const
   {
     osgText::Font const* font = getActiveFont();
+#else
+  TextLine Text::TextOSG::nearestLine(float pos_y)
+  {
+    auto font = getActiveFont();
+#endif
+
     if( !font || lineCount() <= 0 )
       return TextLine(0, this);
 
@@ -326,12 +355,21 @@ namespace canvas
   // simplified version of osgText::Text::computeGlyphRepresentation() to
   // just calculate the size for a given weight. Glpyh calculations/creating
   // is not necessary for this...
+#if OSG_VERSION_LESS_THAN(3,6,5)
   SGVec2i Text::TextOSG::sizeForWidth(int w) const
+#else
+  SGVec2i Text::TextOSG::sizeForWidth(int w)
+#endif
   {
     if( _text.empty() )
       return SGVec2i(0, 0);
 
+#if OSG_VERSION_LESS_THAN(3,6,5)
     osgText::Font* activefont = const_cast<osgText::Font*>(getActiveFont());
+#else
+    auto activefont = getActiveFont();
+#endif
+
     if( !activefont )
       return SGVec2i(-1, -1);
 
@@ -611,19 +649,16 @@ namespace canvas
   }
 
   //----------------------------------------------------------------------------
-  osg::BoundingBox
 #if OSG_VERSION_LESS_THAN(3,3,2)
-  Text::TextOSG::computeBound()
+  osg::BoundingBox Text::TextOSG::computeBound() const
 #else
-  Text::TextOSG::computeBoundingBox()
+  osg::BoundingBox Text::TextOSG::computeBoundingBox() const
 #endif
-  const
   {
-    osg::BoundingBox bb =
 #if OSG_VERSION_LESS_THAN(3,3,2)
-      osgText::Text::computeBound();
+      osg::BoundingBox bb = osgText::Text::computeBound();
 #else
-      osgText::Text::computeBoundingBox();
+      osg::BoundingBox bb = osgText::Text::computeBoundingBox();
 #endif
 
 #if OSG_VERSION_LESS_THAN(3,1,0)
@@ -639,7 +674,7 @@ namespace canvas
     return bb;
   }
 
-  //----------------------------------------------------------------------------
+#if OSG_VERSION_LESS_THAN(3,5,6)
   void Text::TextOSG::computePositions(unsigned int contextID) const
   {
     if( _textureGlyphQuadMap.empty() || _layout == VERTICAL )
@@ -709,6 +744,14 @@ namespace canvas
     return osgText::Text::computePositions(contextID);
   }
 
+#else
+  void Text::TextOSG::computePositionsImplementation()
+  {
+    TextBase::computePositionsImplementation();
+  }
+#endif
+ //----------------------------------------------------------------------------
+
   //----------------------------------------------------------------------------
   const std::string Text::TYPE_NAME = "text";
 

simgear/canvas/elements/CanvasText.hxx

@@ -1,4 +1,5 @@
-// A text on the Canvas
+///@file
+/// A text on the Canvas
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/elements/map/geo_node_pair.hxx

@@ -67,6 +67,7 @@ namespace canvas
       {
         _node_lat = node;
         _status &= ~LAT_MISSING;
+        _xNode.reset();
           
         if( node == _node_lon )
         {
@@ -79,6 +80,7 @@ namespace canvas
       {
         _node_lon = node;
         _status &= ~LON_MISSING;
+        _yNode.reset();
           
         if( node == _node_lat )
         {
@@ -97,19 +99,34 @@ namespace canvas
         return _node_lon ? _node_lon->getStringValue() : "";
       }
 
+      void setCachedLatLon(const std::pair<double, double>& latLon)
+      { _cachedLatLon = latLon; }
+      
+      std::pair<double, double> getCachedLatLon()
+      { return _cachedLatLon; }
+      
       void setTargetName(const std::string& name)
       {
         _target_name = name;
+        _xNode.reset();
+        _yNode.reset();
       }
 
       void setScreenPos(float x, float y)
       {
         assert( isComplete() );
+        if (!_xNode) {
           SGPropertyNode *parent = _node_lat->getParent();
-        parent->getChild(_target_name, _node_lat->getIndex(), true)
+          _xNode = parent->getChild(_target_name, _node_lat->getIndex(), true);
-              ->setDoubleValue(x);
+        }
-        parent->getChild(_target_name, _node_lon->getIndex(), true)
+          
-              ->setDoubleValue(y);
+        if (!_yNode) {
+          SGPropertyNode *parent = _node_lat->getParent();
+          _yNode = parent->getChild(_target_name, _node_lon->getIndex(), true);
+        }
+          
+        _xNode->setDoubleValue(x);
+        _yNode->setDoubleValue(y);
       }
 
       void print()
@@ -125,6 +142,9 @@ namespace canvas
       SGPropertyNode *_node_lat,
                      *_node_lon;
       std::string   _target_name;
+      SGPropertyNode_ptr _xNode,
+          _yNode;
+      std::pair<double, double> _cachedLatLon;
 
   };
 

simgear/canvas/elements/map/projection.hxx

@@ -1,4 +1,5 @@
-// Geographic projections for Canvas map element
+///@file
+/// Geographic projections for Canvas map element
 //
 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/events/CustomEvent.cxx

@@ -1,4 +1,5 @@
-// Canvas user defined event
+///@file
+/// Canvas user defined event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -46,6 +47,14 @@ namespace canvas
 //    assert( type_map.find(type_id) != type_map.end() );
   }
 
+  //----------------------------------------------------------------------------
+  CustomEvent* CustomEvent::clone(int type) const
+  {
+    auto event = new CustomEvent(*this);
+    event->type = type;
+    return event;
+  }
+
   //----------------------------------------------------------------------------
   void CustomEvent::setDetail(StringMap const& data)
   {

simgear/canvas/events/CustomEvent.hxx

@@ -38,6 +38,7 @@ namespace canvas
     public:
 
       /**
+       * @brief Construct a user defined event from a type string
        *
        * @param type_str    Event type name (if name does not exist yet it will
        *                    be registered as new event type)
@@ -49,6 +50,10 @@ namespace canvas
                    StringMap const& data = StringMap() );
 
       /**
+       * @brief Construct a user defined event from a (previously registered)
+       *        type id
+       *
+       * @see getOrRegisterType()
        *
        * @param type_id     Event type id
        * @param bubbles     If this event should take part in the bubbling phase
@@ -58,6 +63,8 @@ namespace canvas
                    bool bubbles = false,
                    StringMap const& data = StringMap() );
 
+      CustomEvent* clone(int type = 0) const override;
+
       /**
        * Set user data
        */
@@ -74,7 +81,7 @@ namespace canvas
        * @see #bubbles
        * @see CustomEvent()
        */
-      virtual bool canBubble() const { return bubbles; }
+      bool canBubble() const override { return bubbles; }
 
       StringMap detail; //!< User data map
       bool bubbles;     //!< Whether the event supports bubbling

simgear/canvas/events/DeviceEvent.cxx

@@ -1,4 +1,5 @@
-// Input device event
+///@file
+/// Input device event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/events/KeyboardEvent.cxx

@@ -1,4 +1,5 @@
-// Keyboard event
+///@file
+/// Keyboard event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -69,6 +70,14 @@ namespace canvas
 //      // TODO what to do with wrong event type?
   }
 
+  //----------------------------------------------------------------------------
+  KeyboardEvent* KeyboardEvent::clone(int type) const
+  {
+    auto event = new KeyboardEvent(*this);
+    event->type = type;
+    return event;
+  }
+
   //----------------------------------------------------------------------------
   void KeyboardEvent::setKey(uint32_t key)
   {

simgear/canvas/events/KeyboardEvent.hxx

@@ -45,6 +45,7 @@ namespace canvas
 
       KeyboardEvent();
       KeyboardEvent(const osgGA::GUIEventAdapter& ea);
+      KeyboardEvent* clone(int type = 0) const override;
 
       void setKey(uint32_t key);
       void setUnmodifiedKey(uint32_t key);

simgear/canvas/events/MouseEvent.cxx

@@ -1,4 +1,5 @@
-// Mouse event
+///@file
+/// Mouse event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -48,6 +49,14 @@ namespace canvas
       button += 1;
   }
 
+  //----------------------------------------------------------------------------
+  MouseEvent* MouseEvent::clone(int type) const
+  {
+    auto event = new MouseEvent(*this);
+    event->type = type;
+    return event;
+  }
+
   //----------------------------------------------------------------------------
   bool MouseEvent::canBubble() const
   {

simgear/canvas/events/MouseEvent.hxx

@@ -36,8 +36,9 @@ namespace canvas
     public:
       MouseEvent();
       MouseEvent(const osgGA::GUIEventAdapter& ea);
+      MouseEvent* clone(int type = 0) const override;
 
-      virtual bool canBubble() const;
+      bool canBubble() const override;
 
       osg::Vec2f getScreenPos() const { return screen_pos; }
       osg::Vec2f getClientPos() const { return client_pos; }

simgear/canvas/events/input_event_demo.cxx

@@ -1,4 +1,5 @@
-// Keyboard event demo. Press some keys and get some info...
+///@file
+/// Keyboard event demo. Press some keys and get some info...
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //

simgear/canvas/layout/BoxLayout.cxx

@@ -73,7 +73,7 @@ namespace canvas
                               int stretch,
                               uint8_t alignment )
   {
-    ItemData item_data = {0};
+    ItemData item_data = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
     item_data.layout_item = item;
     item_data.stretch = std::max(0, stretch);
 

simgear/canvas/layout/Layout.cxx

@@ -18,6 +18,9 @@
 
 #include <simgear_config.h>
 #include "Layout.hxx"
+
+#include <algorithm>
+
 #include <simgear/debug/logstream.hxx>
 
 namespace simgear

simgear/canvas/layout/NasalWidget.cxx

@@ -150,7 +150,7 @@ namespace canvas
   //----------------------------------------------------------------------------
   bool NasalWidget::hasHeightForWidth() const
   {
-    return !_height_for_width.empty() || !_min_height_for_width.empty();
+    return _height_for_width || _min_height_for_width;
   }
 
   //----------------------------------------------------------------------------
@@ -186,7 +186,7 @@ namespace canvas
   int NasalWidget::callHeightForWidthFunc( const HeightForWidthFunc& hfw,
                                            int w ) const
   {
-    if( hfw.empty() )
+    if( !hfw )
       return -1;
 
     try
@@ -239,17 +239,17 @@ namespace canvas
   //----------------------------------------------------------------------------
   int NasalWidget::heightForWidthImpl(int w) const
   {
-    return callHeightForWidthFunc( _height_for_width.empty()
+    return callHeightForWidthFunc( _height_for_width
-                                 ? _min_height_for_width
+                                 ? _height_for_width
-                                 : _height_for_width, w );
+                                 : _min_height_for_width, w );
   }
 
   //----------------------------------------------------------------------------
   int NasalWidget::minimumHeightForWidthImpl(int w) const
   {
-    return callHeightForWidthFunc( _min_height_for_width.empty()
+    return callHeightForWidthFunc( _min_height_for_width
-                                 ? _height_for_width
+                                 ? _min_height_for_width
-                                 : _min_height_for_width, w );
+                                 : _height_for_width, w );
   }
 
 

simgear/canvas/layout/NasalWidget.hxx

@@ -40,8 +40,8 @@ namespace canvas
   {
     public:
 
-      typedef boost::function<void (nasal::Me, const SGRecti&)> SetGeometryFunc;
+      typedef std::function<void (nasal::Me, const SGRecti&)> SetGeometryFunc;
-      typedef boost::function<int (nasal::Me, int)> HeightForWidthFunc;
+      typedef std::function<int (nasal::Me, int)> HeightForWidthFunc;
 
       /**
        *

simgear/constants.h

@@ -218,6 +218,9 @@ const float SG_RADIANS_TO_DEGREES = 180.0f / SG_PI;
 #define SG_OBJECT_RANGE_ROUGH     9000.0
 #define SG_OBJECT_RANGE_DETAILED  1500.0
 
+/** Minimum expiry time of PagedLOD within the Tile.  Overridden by /sim/rendering/plod-minimum-expiry-time-secs **/
+#define SG_TILE_MIN_EXPIRY 180.0
+
 /** Radius of scenery tiles in m **/
 #define SG_TILE_RADIUS      14000.0
 

simgear/debug/BufferedLogCallback.cxx

@@ -22,13 +22,12 @@
 #include <simgear_config.h>
 #include <simgear/debug/BufferedLogCallback.hxx>
 
-#include <boost/foreach.hpp>
-     
 #include <simgear/sg_inlines.h>
 #include <simgear/threads/SGThread.hxx>
-#include <simgear/threads/SGGuard.hxx>
 
 #include <cstdlib> // for malloc
+#include <cstring>
+#include <mutex>
 
 namespace simgear
 {
@@ -36,7 +35,7 @@ namespace simgear
 class BufferedLogCallback::BufferedLogCallbackPrivate
 {
 public:
-    SGMutex m_mutex;
+    std::mutex m_mutex;
     vector_cstring m_buffer;
     unsigned int m_stamp;
     unsigned int m_maxLength;
@@ -52,7 +51,7 @@ BufferedLogCallback::BufferedLogCallback(sgDebugClass c, sgDebugPriority p) :
 
 BufferedLogCallback::~BufferedLogCallback()
 {
-    BOOST_FOREACH(unsigned char* msg, d->m_buffer) {
+    for (auto msg : d->m_buffer) {
         free(msg);
     }
 }
@@ -74,7 +73,7 @@ void BufferedLogCallback::operator()(sgDebugClass c, sgDebugPriority p,
         msg = (vector_cstring::value_type) strdup(aMessage.c_str());
     }
 
-    SGGuard<SGMutex> g(d->m_mutex);
+    std::lock_guard<std::mutex> g(d->m_mutex);
     d->m_buffer.push_back(msg);
     d->m_stamp++;
 }
@@ -86,7 +85,7 @@ unsigned int BufferedLogCallback::stamp() const
 
 unsigned int BufferedLogCallback::threadsafeCopy(vector_cstring& aOutput)
 {
-    SGGuard<SGMutex> g(d->m_mutex);
+    std::lock_guard<std::mutex> g(d->m_mutex);
     size_t sz = d->m_buffer.size();
     aOutput.resize(sz);
     memcpy(aOutput.data(), d->m_buffer.data(), sz * sizeof(vector_cstring::value_type));

simgear/debug/BufferedLogCallback.hxx

@@ -26,7 +26,7 @@
 #include <vector>
 #include <memory> // for std::unique_ptr
 
-#include <simgear/debug/logstream.hxx>
+#include <simgear/debug/LogCallback.hxx>
 
 namespace simgear
 {

simgear/debug/CMakeLists.txt

@@ -1,7 +1,14 @@
 
 include (SimGearComponent)
 
-set(HEADERS debug_types.h logstream.hxx BufferedLogCallback.hxx)
+set(HEADERS debug_types.h 
-set(SOURCES logstream.cxx BufferedLogCallback.cxx)
+    logstream.hxx BufferedLogCallback.hxx OsgIoCapture.hxx
+    LogCallback.hxx LogEntry.hxx
+    ErrorReportingCallback.hxx)
+
+set(SOURCES logstream.cxx BufferedLogCallback.cxx
+    LogCallback.cxx LogEntry.cxx
+    ErrorReportingCallback.cxx
+    )
 
 simgear_component(debug debug "${SOURCES}" "${HEADERS}")

simgear/debug/ErrorReportingCallback.cxx

@@ -0,0 +1,47 @@
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#include <simgear_config.h>
+
+#include "ErrorReportingCallback.hxx"
+
+using std::string;
+
+namespace simgear {
+
+static ErrorReportCallback static_callback;
+
+void setErrorReportCallback(ErrorReportCallback cb)
+{
+    static_callback = cb;
+}
+
+
+void reportError(const std::string& msg, const std::string& more)
+{
+    if (!static_callback)
+        return;
+
+    static_callback(msg, more, false);
+}
+
+void reportFatalError(const std::string& msg, const std::string& more)
+{
+    if (!static_callback)
+        return;
+    static_callback(msg, more, true);
+}
+
+} // namespace simgear

simgear/debug/ErrorReportingCallback.hxx

@@ -0,0 +1,31 @@
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#pragma once
+
+#include <functional>
+#include <string>
+
+namespace simgear {
+
+void reportError(const std::string& msg, const std::string& more = {});
+
+void reportFatalError(const std::string& msg, const std::string& more = {});
+
+using ErrorReportCallback = std::function<void(const std::string& msg, const std::string& more, bool isFatal)>;
+
+void setErrorReportCallback(ErrorReportCallback cb);
+
+} // namespace simgear

simgear/debug/LogCallback.cxx

@@ -0,0 +1,116 @@
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#include <simgear_config.h>
+
+#include "LogCallback.hxx"
+
+using namespace simgear;
+
+LogCallback::LogCallback(sgDebugClass c, sgDebugPriority p) : m_class(c),
+                                                              m_priority(p)
+{
+}
+
+void LogCallback::operator()(sgDebugClass c, sgDebugPriority p,
+                             const char* file, int line, const std::string& aMessage)
+{
+    // override me
+}
+
+bool LogCallback::doProcessEntry(const LogEntry& e)
+{
+    return false;
+}
+
+void LogCallback::processEntry(const LogEntry& e)
+{
+    if (doProcessEntry(e))
+        return; // derived class used the new API
+
+    // call the old API
+    (*this)(e.debugClass, e.debugPriority, e.file, e.line, e.message);
+}
+
+
+bool LogCallback::shouldLog(sgDebugClass c, sgDebugPriority p) const
+{
+    if ((c & m_class) != 0 && p >= m_priority)
+        return true;
+    if (c == SG_OSG) // always have OSG logging as it OSG logging is configured separately.
+        return true;
+    return false;
+}
+
+void LogCallback::setLogLevels(sgDebugClass c, sgDebugPriority p)
+{
+    m_priority = p;
+    m_class = c;
+}
+const char* LogCallback::debugPriorityToString(sgDebugPriority p)
+{
+    switch (p) {
+    case SG_DEV_ALERT:
+    case SG_ALERT:
+        return "ALRT";
+    case SG_BULK: return "BULK";
+    case SG_DEBUG: return "DBUG";
+    case SG_MANDATORY_INFO:
+    case SG_INFO:
+        return "INFO";
+    case SG_POPUP: return "POPU";
+    case SG_DEV_WARN:
+    case SG_WARN:
+        return "WARN";
+
+    default: return "UNKN";
+    }
+}
+
+const char* LogCallback::debugClassToString(sgDebugClass c)
+{
+    switch (c) {
+    case SG_NONE: return "none";
+    case SG_TERRAIN: return "terrain";
+    case SG_ASTRO: return "astro";
+    case SG_FLIGHT: return "flight";
+    case SG_INPUT: return "input";
+    case SG_GL: return "opengl";
+    case SG_VIEW: return "view";
+    case SG_COCKPIT: return "cockpit";
+    case SG_GENERAL: return "general";
+    case SG_MATH: return "math";
+    case SG_EVENT: return "event";
+    case SG_AIRCRAFT: return "aircraft";
+    case SG_AUTOPILOT: return "autopilot";
+    case SG_IO: return "io";
+    case SG_CLIPPER: return "clipper";
+    case SG_NETWORK: return "network";
+    case SG_ATC: return "atc";
+    case SG_NASAL: return "nasal";
+    case SG_INSTR: return "instruments";
+    case SG_SYSTEMS: return "systems";
+    case SG_AI: return "ai";
+    case SG_ENVIRONMENT: return "environment";
+    case SG_SOUND: return "sound";
+    case SG_NAVAID: return "navaid";
+    case SG_GUI: return "gui";
+    case SG_TERRASYNC: return "terrasync";
+    case SG_PARTICLES: return "particles";
+    case SG_HEADLESS: return "headless";
+    case SG_OSG: return "OSG";
+    default: return "unknown";
+    }
+}

simgear/debug/LogCallback.hxx

@@ -0,0 +1,56 @@
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#pragma once
+
+#include <string>
+
+#include "LogEntry.hxx"
+#include "debug_types.h"
+
+namespace simgear {
+
+class LogCallback
+{
+public:
+    virtual ~LogCallback() = default;
+
+    // newer API: return true if you handled the message, otherwise
+    // the old API will be called
+    virtual bool doProcessEntry(const LogEntry& e);
+
+    // old API, kept for compatability
+    virtual void operator()(sgDebugClass c, sgDebugPriority p,
+                            const char* file, int line, const std::string& aMessage);
+
+    void setLogLevels(sgDebugClass c, sgDebugPriority p);
+
+    void processEntry(const LogEntry& e);
+
+protected:
+    LogCallback(sgDebugClass c, sgDebugPriority p);
+
+    bool shouldLog(sgDebugClass c, sgDebugPriority p) const;
+
+    static const char* debugClassToString(sgDebugClass c);
+    static const char* debugPriorityToString(sgDebugPriority p);
+
+private:
+    sgDebugClass m_class;
+    sgDebugPriority m_priority;
+};
+
+
+} // namespace simgear

simgear/debug/LogEntry.cxx

@@ -0,0 +1,45 @@
+
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#include <simgear_config.h>
+
+#include "LogEntry.hxx"
+
+#include <cstring> // for strdup
+
+namespace simgear {
+
+LogEntry::~LogEntry()
+{
+    if (freeFilename) {
+        free(const_cast<char*>(file));
+    }
+}
+
+LogEntry::LogEntry(const LogEntry& c) : debugClass(c.debugClass),
+                                        debugPriority(c.debugPriority),
+                                        originalPriority(c.originalPriority),
+                                        file(c.file),
+                                        line(c.line),
+                                        message(c.message),
+                                        freeFilename(c.freeFilename)
+{
+    if (c.freeFilename) {
+        file = strdup(c.file);
+    }
+}
+
+} // namespace simgear

simgear/debug/LogEntry.hxx

@@ -0,0 +1,54 @@
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
+#pragma once
+
+#include <string>
+
+#include "debug_types.h"
+
+namespace simgear {
+/**
+ * storage of a single log entry. This is used to pass log entries from
+ * the various threads to the logging thread, and also to store the startup
+ * entries
+ */
+class LogEntry
+{
+public:
+    LogEntry(sgDebugClass c, sgDebugPriority p,
+             sgDebugPriority op,
+             const char* f, int l, const std::string& msg) : debugClass(c), debugPriority(p), originalPriority(op),
+                                                             file(f), line(l),
+                                                             message(msg)
+    {
+    }
+
+    LogEntry(const LogEntry& c);
+    LogEntry& operator=(const LogEntry& c) = delete;
+
+    ~LogEntry();
+
+    const sgDebugClass debugClass;
+    const sgDebugPriority debugPriority;
+    const sgDebugPriority originalPriority;
+    const char* file;
+    const int line;
+    const std::string message;
+
+    bool freeFilename = false; ///< if true, we own, and therefore need to free, the memory pointed to by 'file'
+};
+
+} // namespace simgear

simgear/debug/OsgIoCapture.hxx

@@ -0,0 +1,53 @@
+#include <cstring>
+
+#include <osg/Notify>
+
+#include <simgear/debug/logstream.hxx>
+
+/**
+* merge OSG output into our logging system, so it gets recorded to file,
+* and so we can display a GUI console with renderer issues, especially
+* shader compilation warnings and errors.
+*/
+class NotifyLogger : public osg::NotifyHandler
+{
+public:
+    // note this callback will be invoked by OSG from multiple threads.
+    // fortunately our Simgear logging implementation already handles
+    // that internally, so we simply pass the message on.
+    virtual void notify(osg::NotifySeverity severity, const char* message) {
+        // Detect whether a osg::Reference derived object is deleted with a non-zero
+        // reference count. In this case trigger a segfault to get a stack trace.
+        if (strstr(message, "the final reference count was")) {
+            // as this is going to segfault ignore the translation of severity and always output the message.
+            SG_LOG(SG_GL, SG_ALERT, message);
+#ifndef DEBUG
+            throw new std::string(message);
+            //int* trigger_segfault = 0;
+            //*trigger_segfault     = 0;
+#endif
+            return;
+        }
+        char*tmessage = strdup(message);
+        char*lf = strrchr(tmessage, '\n');
+        if (lf)
+            *lf = 0;
+
+        SG_LOG(SG_OSG, translateSeverity(severity), tmessage);
+        free(tmessage);
+    }
+
+private:
+    sgDebugPriority translateSeverity(osg::NotifySeverity severity) {
+        switch (severity) {
+        case osg::ALWAYS:
+        case osg::FATAL:      return SG_ALERT;
+        case osg::WARN:       return SG_WARN;
+        case osg::NOTICE:
+        case osg::INFO:       return SG_INFO;
+        case osg::DEBUG_FP:
+        case osg::DEBUG_INFO: return SG_DEBUG;
+        default:              return SG_ALERT;
+        }
+    }
+};

simgear/debug/debug_types.h

@@ -1,3 +1,5 @@
+#pragma once
+
 /** \file debug_types.h
  *  Define the various logging classes and priorities
  */
@@ -34,7 +36,11 @@ typedef enum {
     SG_GUI         = 0x00800000,
     SG_TERRASYNC   = 0x01000000,
     SG_PARTICLES   = 0x02000000,
-    SG_UNDEFD      = 0x04000000, // For range checking
+    SG_HEADLESS    = 0x04000000,
+    // SG_OSG (OSG notify) - will always be displayed regardless of FG log settings as OSG log level is configured 
+    // separately and thus it makes more sense to allow these message through.
+    SG_OSG         = 0x08000000,
+    SG_UNDEFD      = 0x10000000, // For range checking
 
     SG_ALL         = 0xFFFFFFFF
 } sgDebugClass;
@@ -58,6 +64,7 @@ typedef enum {
     // SG_ABORT        // Abandon ship (core)
 
     SG_DEV_WARN,  // Warning for developers, translated to other priority
-    SG_DEV_ALERT       // Alert for developers, translated
+    SG_DEV_ALERT, // Alert for developers, translated
-} sgDebugPriority;
 
+    SG_MANDATORY_INFO // information, but should always be shown
+} sgDebugPriority;

simgear/debug/logstream.cxx

@@ -24,20 +24,22 @@
 
 #include "logstream.hxx"
 
+#include <cstring>
 #include <iostream>
 #include <fstream>
 #include <sstream>
 #include <algorithm>
-
+#include <mutex>
-#include <boost/foreach.hpp>
 
 #include <simgear/sg_inlines.h>
 #include <simgear/threads/SGThread.hxx>
 #include <simgear/threads/SGQueue.hxx>
-#include <simgear/threads/SGGuard.hxx>
 
+#include "LogCallback.hxx"
 #include <simgear/io/iostreams/sgstream.hxx>
 #include <simgear/misc/sg_path.hxx>
+#include <simgear/misc/strutils.hxx>
+#include <simgear/timing/timestamp.hxx>
 
 #if defined (SG_WINDOWS)
 // for AllocConsole, OutputDebugString
@@ -46,83 +48,55 @@
     #include <io.h>
 #endif
 
-
-
 //////////////////////////////////////////////////////////////////////////////
 
-namespace simgear
-{
 
-LogCallback::LogCallback(sgDebugClass c, sgDebugPriority p) :
-	m_class(c),
-	m_priority(p)
-{
-}
-
-bool LogCallback::shouldLog(sgDebugClass c, sgDebugPriority p) const
-{
-	 return ((c & m_class) != 0 && p >= m_priority);
-}
-
-void LogCallback::setLogLevels( sgDebugClass c, sgDebugPriority p )
-{
-	m_priority = p;
-	m_class = c;
-}
-
-const char* LogCallback::debugClassToString(sgDebugClass c)
-{
-    switch (c) {
-        case SG_NONE:       return "none";
-        case SG_TERRAIN:    return "terrain";
-        case SG_ASTRO:      return "astro";
-        case SG_FLIGHT:     return "flight";
-        case SG_INPUT:      return "input";
-        case SG_GL:         return "opengl";
-        case SG_VIEW:       return "view";
-        case SG_COCKPIT:    return "cockpit";
-        case SG_GENERAL:    return "general";
-        case SG_MATH:       return "math";
-        case SG_EVENT:      return "event";
-        case SG_AIRCRAFT:   return "aircraft";
-        case SG_AUTOPILOT:  return "autopilot";
-        case SG_IO:         return "io";
-        case SG_CLIPPER:    return "clipper";
-        case SG_NETWORK:    return "network";
-        case SG_ATC:        return "atc";
-        case SG_NASAL:      return "nasal";
-        case SG_INSTR:      return "instruments";
-        case SG_SYSTEMS:    return "systems";
-        case SG_AI:         return "ai";
-        case SG_ENVIRONMENT:return "environment";
-        case SG_SOUND:      return "sound";
-        case SG_NAVAID:     return "navaid";
-        case SG_GUI:        return "gui";
-        case SG_TERRASYNC:  return "terrasync";
-        case SG_PARTICLES:  return "particles";
-        default:            return "unknown";
-    }
-}
-
-} // of namespace simgear
-
-//////////////////////////////////////////////////////////////////////////////
 
 class FileLogCallback : public simgear::LogCallback
 {
 public:
+    SGTimeStamp logTimer;
     FileLogCallback(const SGPath& aPath, sgDebugClass c, sgDebugPriority p) :
 	    simgear::LogCallback(c, p)
     {
         m_file.open(aPath, std::ios_base::out | std::ios_base::trunc);
+        logTimer.stamp();
     }
 
-    virtual void operator()(sgDebugClass c, sgDebugPriority p,
+    void operator()(sgDebugClass c, sgDebugPriority p,
-        const char* file, int line, const std::string& message)
+                    const char* file, int line, const std::string& message) override
     {
         if (!shouldLog(c, p)) return;
-        m_file << debugClassToString(c) << ":" << (int) p
+
-            << ":" << file << ":" << line << ":" << message << std::endl;
+
+//        fprintf(stderr, "%7.2f [%.8s]:%-10s %s\n", logTimer.elapsedMSec() / 1000.0, debugPriorityToString(p), debugClassToString(c), aMessage.c_str());
+        m_file
+            << std::fixed
+            << std::setprecision(2)
+            << std::setw(8)
+            << std::right
+            << (logTimer.elapsedMSec() / 1000.0)
+            << std::setw(8)
+            << std::left
+            << " ["+std::string(debugPriorityToString(p))+"]:"
+            << std::setw(10)
+            << std::left
+            << debugClassToString(c)
+            ;
+        if (file) {
+            /* <line> can be -ve to indicate that m_fileLine was false, but we
+            want to show file:line information regardless of m_fileLine. */
+            m_file
+                << file
+                << ":"
+                << abs(line)
+                << ": "
+                ;
+            }
+        m_file
+            << message << std::endl;
+        //m_file << debugClassToString(c) << ":" << (int)p
+        //    << ":" << file << ":" << line << ":" << message << std::endl;
     }
 private:
     sg_ofstream m_file;
@@ -131,9 +105,12 @@ private:
 class StderrLogCallback : public simgear::LogCallback
 {
 public:
+    SGTimeStamp logTimer;
+
     StderrLogCallback(sgDebugClass c, sgDebugPriority p) :
 		simgear::LogCallback(c, p)
     {
+        logTimer.stamp();
     }
 
 #if defined (SG_WINDOWS)
@@ -143,12 +120,19 @@ public:
     }
 #endif
 
-    virtual void operator()(sgDebugClass c, sgDebugPriority p,
+    void operator()(sgDebugClass c, sgDebugPriority p,
-        const char* file, int line, const std::string& aMessage)
+                    const char* file, int line, const std::string& aMessage) override
     {
         if (!shouldLog(c, p)) return;
+        //fprintf(stderr, "%s\n", aMessage.c_str());
 
-        fprintf(stderr, "%s\n", aMessage.c_str());
+        if (file && line > 0) {
+            fprintf(stderr, "%8.2f %s:%i: [%.8s]:%-10s %s\n", logTimer.elapsedMSec()/1000.0, file, line, debugPriorityToString(p), debugClassToString(c), aMessage.c_str());
+        }
+        else {
+            fprintf(stderr, "%8.2f [%.8s]:%-10s %s\n", logTimer.elapsedMSec()/1000.0, debugPriorityToString(p), debugClassToString(c), aMessage.c_str());
+        }
+        //    file, line, aMessage.c_str());
         //fprintf(stderr, "%s:%d:%s:%d:%s\n", debugClassToString(c), p,
         //    file, line, aMessage.c_str());
         fflush(stderr);
@@ -166,8 +150,8 @@ public:
     {
     }
 
-    virtual void operator()(sgDebugClass c, sgDebugPriority p,
+    void operator()(sgDebugClass c, sgDebugPriority p,
-        const char* file, int line, const std::string& aMessage)
+                    const char* file, int line, const std::string& aMessage) override
     {
         if (!shouldLog(c, p)) return;
 
@@ -182,28 +166,6 @@ public:
 class logstream::LogStreamPrivate : public SGThread
 {
 private:
-    /**
-     * storage of a single log entry. This is used to pass log entries from
-     * the various threads to the logging thread, and also to store the startup
-     * entries
-     */
-    class LogEntry
-    {
-    public:
-        LogEntry(sgDebugClass c, sgDebugPriority p,
-            const char* f, int l, const std::string& msg) :
-            debugClass(c), debugPriority(p), file(f), line(l),
-                message(msg)
-        {
-        }
-
-        const sgDebugClass debugClass;
-        const sgDebugPriority debugPriority;
-        const char* file;
-        const int line;
-        const std::string message;
-    };
-
     /**
      * RAII object to pause the logging thread if it's running, and restart it.
      * used to safely make configuration changes.
@@ -327,24 +289,34 @@ public:
 
         m_callbacks.push_back(new StderrLogCallback(m_logClass, m_logPriority));
         m_consoleCallbacks.push_back(m_callbacks.back());
-#if defined (SG_WINDOWS) && !defined(NDEBUG)
+        
+#if defined (SG_WINDOWS)
+        const char* winDebugEnv = ::getenv("SG_WINDEBUG");
+        const bool b = winDebugEnv ? simgear::strutils::to_bool(std::string{winDebugEnv}) : false;
+        if (b) {
             m_callbacks.push_back(new WinDebugLogCallback(m_logClass, m_logPriority));
             m_consoleCallbacks.push_back(m_callbacks.back());
+        }
 #endif
     }
 
     ~LogStreamPrivate()
     {
-        for (simgear::LogCallback* cb : m_callbacks) {
+        removeCallbacks();
-            delete cb;
+
+        // house-keeping, avoid leak warnings if we exit before disabling
+        // startup logging
+        {
+            std::lock_guard<std::mutex> g(m_lock);
+            clearStartupEntriesLocked();
         }
     }
 
-    SGMutex m_lock;
+    std::mutex m_lock;
-    SGBlockingQueue<LogEntry> m_entries;
+    SGBlockingQueue<simgear::LogEntry> m_entries;
 
     // log entries posted during startup
-    std::vector<LogEntry> m_startupEntries;
+    std::vector<simgear::LogEntry> m_startupEntries;
     bool m_startupLogging = false;
 
     typedef std::vector<simgear::LogCallback*> CallbackVec;
@@ -362,10 +334,16 @@ public:
     bool m_stdout_isRedirectedAlready = false;
 #endif
     bool m_developerMode = false;
+    bool m_fileLine = false;
+
+    // test suite mode.
+    bool m_testMode = false;
+
+    std::vector<std::string> _popupMessages;
 
     void startLog()
     {
-        SGGuard<SGMutex> g(m_lock);
+        std::lock_guard<std::mutex> g(m_lock);
         if (m_isRunning) return;
         m_isRunning = true;
         start();
@@ -377,44 +355,54 @@ public:
             return;
         }
 
+        {
+            std::lock_guard<std::mutex> g(m_lock);
             m_startupLogging = on;
+            clearStartupEntriesLocked();
+        }
+    }
+
+    void clearStartupEntriesLocked()
+    {
         m_startupEntries.clear();
     }
 
-    virtual void run()
+    void run() override
     {
         while (1) {
-            LogEntry entry(m_entries.pop());
+            simgear::LogEntry entry(m_entries.pop());
             // special marker entry detected, terminate the thread since we are
             // making a configuration change or quitting the app
-            if ((entry.debugClass == SG_NONE) && !strcmp(entry.file, "done")) {
+            if ((entry.debugClass == SG_NONE) && entry.file && !strcmp(entry.file, "done")) {
                 return;
             }
-
+            {
+                std::lock_guard<std::mutex> g(m_lock);
                 if (m_startupLogging) {
                     // save to the startup list for not-yet-added callbacks to
                     // pull down on startup
                     m_startupEntries.push_back(entry);
                 }
-
+            }
             // submit to each installed callback in turn
             for (simgear::LogCallback* cb : m_callbacks) {
-                (*cb)(entry.debugClass, entry.debugPriority,
+                cb->processEntry(entry);
-                    entry.file, entry.line, entry.message);
             }
         } // of main thread loop
     }
 
     bool stop()
     {
-        SGGuard<SGMutex> g(m_lock);
+        {
+            std::lock_guard<std::mutex> g(m_lock);
             if (!m_isRunning) {
                 return false;
             }
 
             // log a special marker value, which will cause the thread to wakeup,
             // and then exit
-        log(SG_NONE, SG_ALERT, "done", -1, "");
+            log(SG_NONE, SG_ALERT, "done", -1, "", false);
+        }
         join();
 
         m_isRunning = false;
@@ -428,9 +416,8 @@ public:
 
         // we clear startup entries not using this, so always safe to run
         // this code, container will simply be empty
-        for (auto entry : m_startupEntries) {
+        for (const auto& entry : m_startupEntries) {
-            (*cb)(entry.debugClass, entry.debugPriority,
+            cb->processEntry(entry);
-               entry.file, entry.line, entry.message);
         }
     }
 
@@ -443,28 +430,52 @@ public:
         }
     }
 
+    void removeCallbacks()
+    {
+        PauseThread pause(this);
+        for (simgear::LogCallback* cb : m_callbacks) {
+            delete cb;
+        }
+        m_callbacks.clear();
+        m_consoleCallbacks.clear();
+    }
+
     void setLogLevels( sgDebugClass c, sgDebugPriority p )
     {
         PauseThread pause(this);
         m_logPriority = p;
         m_logClass = c;
-		BOOST_FOREACH(simgear::LogCallback* cb, m_consoleCallbacks) {
+        for (auto cb : m_consoleCallbacks) {
             cb->setLogLevels(c, p);
         }
     }
 
     bool would_log( sgDebugClass c, sgDebugPriority p ) const
     {
+        // Testing mode, so always log.
+        if (m_testMode) return true;
+
+        // SG_OSG (OSG notify) - will always be displayed regardless of FG log settings as OSG log level is configured
+        // separately and thus it makes more sense to allow these message through.
+        if (static_cast<unsigned>(p) == static_cast<unsigned>(SG_OSG)) return true;
+
         p = translatePriority(p);
         if (p >= SG_INFO) return true;
         return ((c & m_logClass) != 0 && p >= m_logPriority);
     }
 
     void log( sgDebugClass c, sgDebugPriority p,
-            const char* fileName, int line, const std::string& msg)
+            const char* fileName, int line, const std::string& msg,
+             bool freeFilename)
     {
-        p = translatePriority(p);
+        auto tp = translatePriority(p);
-        LogEntry entry(c, p, fileName, line, msg);
+        if (!m_fileLine) {
+            /* This prevents output of file:line in StderrLogCallback. */
+            line = -line;
+        }
+
+        simgear::LogEntry entry(c, tp, p, fileName, line, msg);
+        entry.freeFilename = freeFilename;
         m_entries.push(entry);
     }
 
@@ -475,7 +486,7 @@ public:
         }
 
         if (in == SG_DEV_ALERT) {
-            return m_developerMode ? SG_POPUP : SG_WARN;
+            return m_developerMode ? SG_ALERT : SG_WARN;
         }
 
         return in;
@@ -485,7 +496,7 @@ public:
 /////////////////////////////////////////////////////////////////////////////
 
 static std::unique_ptr<logstream> global_logstream;
-static SGMutex global_logStreamLock;
+static std::mutex global_logStreamLock;
 
 logstream::logstream()
 {
@@ -495,8 +506,8 @@ logstream::logstream()
 
 logstream::~logstream()
 {
-    popup_msgs.clear();
     d->stop();
+    d.reset();
 }
 
 void
@@ -510,6 +521,10 @@ void logstream::setDeveloperMode(bool devMode)
     d->m_developerMode = devMode;
 }
 
+void logstream::setFileLine(bool fileLine)
+{
+    d->m_fileLine = fileLine;
+}
 
 void
 logstream::addCallback(simgear::LogCallback* cb)
@@ -527,7 +542,14 @@ void
 logstream::log( sgDebugClass c, sgDebugPriority p,
         const char* fileName, int line, const std::string& msg)
 {
-    d->log(c, p, fileName, line, msg);
+    d->log(c, p, fileName, line, msg, false);
+}
+
+void
+logstream::logCopyingFilename( sgDebugClass c, sgDebugPriority p,
+         const char* fileName, int line, const std::string& msg)
+{
+    d->log(c, p, strdup(fileName), line, msg, true);
 }
 
 
@@ -588,17 +610,18 @@ void logstream::hexdump(sgDebugClass c, sgDebugPriority p, const char* fileName,
 void
 logstream::popup( const std::string& msg)
 {
-    popup_msgs.push_back(msg);
+    std::lock_guard<std::mutex> g(d->m_lock);
+    d->_popupMessages.push_back(msg);
 }
 
 std::string
 logstream::get_popup()
 {
-    std::string rv = "";
+    std::string rv;
-    if (!popup_msgs.empty())
+    std::lock_guard<std::mutex> g(d->m_lock);
-    {
+    if (!d->_popupMessages.empty()) {
-        rv = popup_msgs.front();
+        rv = d->_popupMessages.front();
-        popup_msgs.erase(popup_msgs.begin());
+        d->_popupMessages.erase(d->_popupMessages.begin());
     }
     return rv;
 }
@@ -606,7 +629,8 @@ logstream::get_popup()
 bool
 logstream::has_popup()
 {
-    return (popup_msgs.size() > 0) ? true : false;
+    std::lock_guard<std::mutex> g(d->m_lock);
+    return !d->_popupMessages.empty();
 }
 
 bool
@@ -639,6 +663,16 @@ logstream::set_log_classes( sgDebugClass c)
     d->setLogLevels(c, d->m_logPriority);
 }
 
+sgDebugPriority logstream::priorityFromString(const std::string& s)
+{
+    if (s == "bulk") return SG_BULK;
+    if (s == "debug") return SG_DEBUG;
+    if (s == "info") return SG_INFO;
+    if (s == "warn") return SG_WARN;
+    if (s == "alert") return SG_ALERT;
+
+    throw std::invalid_argument("Couldn't parse log prioirty:" + s);
+}
 
 logstream&
 sglog()
@@ -649,7 +683,7 @@ sglog()
     // http://www.aristeia.com/Papers/DDJ_Jul_Aug_2004_revised.pdf
     // in the absence of portable memory barrier ops in Simgear,
     // let's keep this correct & safe
-    SGGuard<SGMutex> g(global_logStreamLock);
+    std::lock_guard<std::mutex> g(global_logStreamLock);
 
     if( !global_logstream )
         global_logstream.reset(new logstream);
@@ -711,6 +745,13 @@ void logstream::requestConsole()
 #endif
 }
 
+void
+logstream::setTestingMode( bool testMode )
+{
+    d->m_testMode = testMode;
+    if (testMode) d->removeCallbacks();
+}
+
 
 namespace simgear
 {
@@ -723,7 +764,7 @@ void requestConsole()
 
 void shutdownLogging()
 {
-    SGGuard<SGMutex> g(global_logStreamLock);
+    std::lock_guard<std::mutex> g(global_logStreamLock);
     global_logstream.reset();
 }
 

simgear/debug/logstream.hxx

@@ -38,25 +38,7 @@ class SGPath;
 namespace simgear
 {
 
-class LogCallback
+class LogCallback;
-{
-public:
-    virtual ~LogCallback() {}
-    virtual void operator()(sgDebugClass c, sgDebugPriority p, 
-        const char* file, int line, const std::string& aMessage) = 0;
-
-	void setLogLevels(sgDebugClass c, sgDebugPriority p);
-protected:
-	LogCallback(sgDebugClass c, sgDebugPriority p);
-
-	bool shouldLog(sgDebugClass c, sgDebugPriority p) const;
-
-    static const char* debugClassToString(sgDebugClass c);
-private:
-	sgDebugClass m_class;
-	sgDebugPriority m_priority;
-};
-
 /**
  * Helper force a console on platforms where it might optional, when
  * we need to show a console. This basically means Windows at the
@@ -104,6 +86,11 @@ public:
     
     sgDebugPriority get_log_priority() const;
 
+    /**
+        @brief convert a string value to a log prioirty.
+        throws std::invalid_argument if the string is not valid
+     */
+    static sgDebugPriority priorityFromString(const std::string& s);
     /**
      * set developer mode on/off. In developer mode, SG_DEV_WARN messags
      * are treated as warnings. In normal (non-developer) mode they are
@@ -111,12 +98,26 @@ public:
      */
     void setDeveloperMode(bool devMode);
 
+    /**
+     * set output of file:line mode on/off. If on, all log messages are
+     * prefixed by the file:line of the caller of SG_LOG().
+     */
+    void setFileLine(bool fileLine);
+
     /**
      * the core logging method
      */
     void log( sgDebugClass c, sgDebugPriority p,
             const char* fileName, int line, const std::string& msg);
 
+    // overload of above, which can transfer ownership of the file-name.
+    // this is unecesary overhead when logging from C++, since __FILE__ points
+    // to constant data, but it's needed when the filename is Nasal data (for
+    // example) since during shutdown the filename is freed by Nasal GC
+    // asynchronously with the logging thread.
+    void logCopyingFilename( sgDebugClass c, sgDebugPriority p,
+             const char* fileName, int line, const std::string& msg);
+    
     /**
     * output formatted hex dump of memory block
     */
@@ -158,18 +159,26 @@ public:
      
     void removeCallback(simgear::LogCallback* cb);
 
+    void removeCallbacks();
+
     /**
      * optionally record all entries and submit them to new log callbacks that
      * are added. This allows simplified logging configuration, but still including
      * early startup information in all logs.
      */
     void setStartupLoggingEnabled(bool enabled);
+
+    /**
+     * Set up the logstream for running in test mode.  For example the callbacks
+     * will be unregistered and the behaviour of the would_log() function
+     * sanitized.
+     */
+    void setTestingMode(bool testMode);
+
 private:
     // constructor
     logstream();
 
-    std::vector<std::string> popup_msgs;
-
     class LogStreamPrivate;
 
     std::unique_ptr<LogStreamPrivate> d;
@@ -193,9 +202,11 @@ logstream& sglog();
     } } while(0)
 #ifdef FG_NDEBUG
 # define SG_LOG(C,P,M)	do { if((P) == SG_POPUP) SG_LOGX(C,P,M) } while(0)
+# define SG_LOG_NAN(C,P,M) SG_LOG(C,P,M)
 # define SG_HEXDUMP(C,P,MEM,LEN)
 #else
 # define SG_LOG(C,P,M)	SG_LOGX(C,P,M)
+# define SG_LOG_NAN(C,P,M) do { SG_LOGX(C,P,M); throw std::overflow_error(M); } while(0)
 # define SG_LOG_HEXDUMP(C,P,MEM,LEN) if(sglog().would_log(C,P)) sglog().hexdump(C, P, __FILE__, __LINE__, MEM, LEN)
 #endif
 

simgear/emesary/CMakeLists.txt

@@ -0,0 +1,33 @@
+
+
+include (SimGearComponent)
+
+set(HEADERS 
+    Emesary.hxx
+    INotification.hxx
+    IReceiver.hxx
+    ITransmitter.hxx
+    ReceiptStatus.hxx
+    Transmitter.hxx
+    notifications.hxx
+    )
+    
+set(SOURCES 
+    Emesary.cxx
+    )
+
+simgear_component(emesary emesary "${SOURCES}" "${HEADERS}")
+
+
+if(ENABLE_TESTS)
+
+add_executable(test_emesary test_emesary.cxx)
+
+set_target_properties(test_emesary PROPERTIES
+  COMPILE_DEFINITIONS "SRC_DIR=\"${CMAKE_CURRENT_SOURCE_DIR}\"" )
+
+target_link_libraries(test_emesary ${TEST_LIBS})
+add_test(emesary ${EXECUTABLE_OUTPUT_PATH}/test_emesary)
+
+
+endif(ENABLE_TESTS)

simgear/emesary/Emesary.cxx

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------
+*
+*	Title                : Emesary - class based inter-object communication
+*
+*	File Type            : Implementation File
+*
+*	Description          : Emesary main.
+*	                     : This only needs to instance the GlobalTransmitter as all of the 
+*	                     : logic is in the header files (by design)
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*	Author               : Richard Harrison (richard@zaretto.com)
+*
+*	Creation Date        : 18 March 2002
+*
+*	Version              : $Header: $
+*
+*  Copyright © 2002 Richard Harrison           All Rights Reserved.
+*
+*---------------------------------------------------------------------------*/
+
+#include "simgear/emesary/Emesary.hxx"
+
+namespace simgear
+{
+    namespace Emesary
+    {
+      
+    }
+}

simgear/emesary/Emesary.hxx

@@ -0,0 +1,48 @@
+#ifndef EMESARY_hxx
+#define EMESARY_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - class based inter-object communication
+*
+*  File Type            : Implementation File
+*
+*  Description          : Provides generic inter-object communication. For an object to receive a message it
+*                       : must first register with a Transmitter, such as GlobalTransmitter, and implement the
+*                       : IReceiver interface. That's it.
+*                       : To send a message use a Transmitter with an object. That's all there is to it.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+#include <typeinfo>
+
+#include "ReceiptStatus.hxx"
+#include "INotification.hxx"
+#include "IReceiver.hxx"
+#include "ITransmitter.hxx"
+#include "Transmitter.hxx"
+#include <simgear/structure/Singleton.hxx>
+
+namespace simgear
+{
+    namespace Emesary
+    {
+        class GlobalTransmitter : public simgear::Singleton<Transmitter>
+        {
+        public:
+            GlobalTransmitter()
+            {
+            }
+            virtual ~GlobalTransmitter() {}
+        };
+    }
+}
+#endif

simgear/emesary/INotification.hxx

@@ -0,0 +1,54 @@
+#ifndef INOTIFICATION_hxx
+#define INOTIFICATION_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - Notification base class
+*
+*  File Type            : Implementation File
+*
+*  Description          : Base class (interface) for all Notifications.
+*                       : This is also compatible with the usual implementation of how we
+*                       : implement queued notifications.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+namespace simgear
+{
+    namespace Emesary
+    {
+        /// Interface (base class) for all notifications. 
+        class INotification
+        {
+        public:
+            // text representation of notification type. must be unique across all notifications
+            virtual const char *GetType() = 0;
+
+            /// Used to control the sending of notifications. If this returns false then the Transmitter 
+            /// should not send this notification.
+            virtual bool IsReadyToSend() { return true; }
+
+            /// Used to control the timeout. If this notification has timed out - then the processor is entitled 
+            /// to true.
+            virtual bool IsTimedOut() { return false; }
+
+            /// when this notification has completed the processing recipient must set this to true.
+            /// the processing recipient is responsible for follow on notifications.
+            /// a notification can remain as complete until the transmit queue decides to remove it from the queue.
+            /// there is no requirement that elements are removed immediately upon completion merely that once complete
+            /// the transmitter should not notify any more elements.
+            /// The current notification loop may be completed - following the usual convention unless Completed or Abort
+            /// is returned as the status.
+            virtual bool IsComplete() { return true; }
+        };
+    }
+}
+#endif

simgear/emesary/IReceiver.hxx

@@ -0,0 +1,47 @@
+#ifndef IRECEIVER_hxx
+#define IRECEIVER_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - Receiver base class
+*
+*  File Type            : Implementation File
+*
+*  Description          : Base class for all recipients.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+namespace simgear
+{
+    namespace Emesary
+    {
+
+        /// Interface (base class) for a recipeint.
+        class IReceiver
+        {
+        public:
+            /// Receive notification - must be implemented
+            virtual ReceiptStatus Receive(INotification& message) = 0;
+
+            /// Called when registered at a transmitter
+            virtual void OnRegisteredAtTransmitter(class Transmitter *p)
+            {
+            }
+
+            /// Called when de-registered at a transmitter
+            virtual void OnDeRegisteredAtTransmitter(class Transmitter *p)
+            {
+            }
+        };
+
+    }
+}
+#endif

simgear/emesary/ITransmitter.hxx

@@ -0,0 +1,52 @@
+#ifndef ITRANSMITTER_hxx
+#define ITRANSMITTER_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - Transmitter base class
+*
+*  File Type            : Implementation File
+*
+*  Description          : Base class for all transmitters.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+
+namespace simgear
+{
+    namespace Emesary
+    {
+        /// Interface (base clasee) for a transmitter.
+        ///  Transmits Message derived objects. Each instance of this class provides a
+        ///  event/databus to which any number of receivers can attach to.
+        class ITransmitter
+        {
+        public:
+            // Registers a recipient to receive message from this transmitter
+            virtual void Register(IReceiver& R) = 0;
+            // Removes a recipient from from this transmitter
+            virtual void DeRegister(IReceiver& R) = 0;
+
+
+            //Notify all registered recipients. Stop when receipt status of abort or finished are received.
+            //The receipt status from this method will be
+            // - OK > message handled
+            // - Fail > message not handled. A status of Abort from a recipient will result in our status
+            //          being fail as Abort means that the message was not and cannot be handled, and
+            //          allows for usages such as access controls.
+            virtual ReceiptStatus NotifyAll(INotification& M) = 0;
+
+            /// number of recipients
+            virtual int Count() = 0;
+        };
+    }
+}
+#endif

simgear/emesary/ReceiptStatus.hxx

@@ -0,0 +1,54 @@
+#ifndef RECEIPTSTATUS_hxx
+#define RECEIPTSTATUS_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - Transmitter base class
+*
+*  File Type            : Implementation File
+*
+*  Description          : Defines the receipt status that can be returned from 
+*                       : a receive method.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+namespace simgear
+{
+    namespace Emesary
+    {
+        enum ReceiptStatus
+        {
+            /// Processing completed successfully
+            ReceiptStatusOK = 0,
+
+            /// Individual item failure
+            ReceiptStatusFail = 1,
+
+            /// Fatal error; stop processing any further recipieints of this message. Implicitly fail
+            ReceiptStatusAbort = 2,
+
+            /// Definitive completion - do not send message to any further recipieints
+            ReceiptStatusFinished = 3,
+
+            /// Return value when method doesn't process a message.
+            ReceiptStatusNotProcessed = 4,
+
+            /// Message has been sent but the return status cannot be determined as it has not been processed by the recipient. 
+            /// e.g. a queue or outgoing bridge
+            ReceiptStatusPending = 5,
+
+            /// Message has been definitively handled but the return value cannot be determined. The message will not be sent any further
+            /// e.g. a point to point forwarding bridge
+            ReceiptStatusPendingFinished = 6,
+        };
+    }
+}
+#endif

simgear/emesary/Transmitter.hxx

@@ -0,0 +1,189 @@
+#ifndef TRANSMITTER_hxx
+#define TRANSMITTER_hxx
+/*---------------------------------------------------------------------------
+*
+*  Title                : Emesary - Transmitter base class
+*
+*  File Type            : Implementation File
+*
+*  Description          : Defines the receipt status that can be returned from
+*                       : a receive method.
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*  Author               : Richard Harrison (richard@zaretto.com)
+*
+*  Creation Date        : 18 March 2002, rewrite 2017, simgear version 2019
+*
+*  Version              : $Header: $
+*
+*  Copyright (C)2019 Richard Harrison            Licenced under GPL2 or later.
+*
+*---------------------------------------------------------------------------*/
+
+#include <algorithm>
+#include <string>
+#include <list>
+#include <set>
+#include <vector>
+#include <atomic>
+#include <mutex>
+
+namespace simgear
+{
+    namespace Emesary
+    {
+        // Implementation of a ITransmitter
+        class Transmitter : public ITransmitter
+        {
+        protected:
+            typedef std::list<IReceiver *> RecipientList;
+            RecipientList recipient_list;
+            RecipientList deleted_recipients;
+            int CurrentRecipientIndex = 0;
+            std::mutex _lock;
+            std::atomic<int> receiveDepth;
+            std::atomic<int> sentMessageCount;
+
+        public:
+            Transmitter() : receiveDepth(0), sentMessageCount(0)
+            {
+            }
+
+            virtual ~Transmitter()
+            {
+            }
+
+            // Registers an object to receive messsages from this transmitter.
+            // This object is added to the top of the list of objects to be notified. This is deliberate as
+            // the sequence of registration and message receipt can influence the way messages are processing
+            // when ReceiptStatus of Abort or Finished are encountered. So it was a deliberate decision that the
+            // most recently registered recipients should process the messages/events first.
+            virtual void Register(IReceiver& r)
+            {
+                std::lock_guard<std::mutex> scopeLock(_lock);
+                recipient_list.push_back(&r);
+                r.OnRegisteredAtTransmitter(this);
+                if (std::find(deleted_recipients.begin(), deleted_recipients.end(), &r) != deleted_recipients.end())
+                    deleted_recipients.remove(&r);
+            }
+
+            //  Removes an object from receving message from this transmitter
+            virtual void DeRegister(IReceiver& R)
+            {
+                std::lock_guard<std::mutex> scopeLock(_lock);
+                if (recipient_list.size())
+                {
+                    if (std::find(recipient_list.begin(), recipient_list.end(), &R) != recipient_list.end())
+                    {
+                        recipient_list.remove(&R);
+                        R.OnDeRegisteredAtTransmitter(this);
+                        if (std::find(deleted_recipients.begin(), deleted_recipients.end(), &R) == deleted_recipients.end())
+                            deleted_recipients.push_back(&R);
+                    }
+                }
+            }
+
+            // Notify all registered recipients. Stop when receipt status of abort or finished are received.
+            // The receipt status from this method will be
+            //  - OK > message handled
+            //  - Fail > message not handled. A status of Abort from a recipient will result in our status
+            //           being fail as Abort means that the message was not and cannot be handled, and
+            //           allows for usages such as access controls.
+            virtual ReceiptStatus NotifyAll(INotification& M)
+            {
+                ReceiptStatus return_status = ReceiptStatusNotProcessed;
+
+                sentMessageCount++;
+
+                std::vector<IReceiver*> temp;
+                {
+                    std::lock_guard<std::mutex> scopeLock(_lock);
+                    if (receiveDepth == 0)
+                        deleted_recipients.clear();
+                    receiveDepth++;
+
+                    int idx = 0;
+                    for (RecipientList::iterator i = recipient_list.begin(); i != recipient_list.end(); i++)
+                    {
+                        temp.push_back(*i);
+                    }
+                }
+                int tempSize = temp.size();
+                for (int index = 0; index < tempSize; index++)
+                {
+                    IReceiver* R = temp[index];
+                    {
+                        std::lock_guard<std::mutex> scopeLock(_lock);
+                        if (deleted_recipients.size())
+                        {
+                            if (std::find(deleted_recipients.begin(), deleted_recipients.end(), R) != deleted_recipients.end())
+                            {
+                                continue;
+                            }
+                        }
+                    }
+                    if (R)
+                    {
+                        ReceiptStatus rstat = R->Receive(M);
+                        switch (rstat)
+                        {
+                        case ReceiptStatusFail:
+                            return_status = ReceiptStatusFail;
+                            break;
+
+                        case ReceiptStatusPending:
+                            return_status = ReceiptStatusPending;
+                            break;
+
+                        case ReceiptStatusPendingFinished:
+                            return rstat;
+
+                        case ReceiptStatusNotProcessed:
+                            break;
+
+                        case ReceiptStatusOK:
+                            if (return_status == ReceiptStatusNotProcessed)
+                                return_status = rstat;
+                            break;
+
+                        case ReceiptStatusAbort:
+                            return ReceiptStatusAbort;
+
+                        case ReceiptStatusFinished:
+                            return ReceiptStatusOK;
+                        }
+                    }
+
+                }
+
+                receiveDepth--;
+                return return_status;
+            }
+
+            // number of currently registered recipients
+            virtual int Count()
+            {
+                std::lock_guard<std::mutex> scopeLock(_lock);
+                return recipient_list.size();
+            }
+
+            // number of sent messages.
+            int SentMessageCount()
+            {
+                return sentMessageCount;
+            }
+
+            // ascertain if a receipt status can be interpreted as failure.
+            static bool Failed(ReceiptStatus receiptStatus)
+            {
+                //
+                // failed is either Fail or Abort.
+                // NotProcessed isn't a failure because it hasn't been processed.
+                return receiptStatus == ReceiptStatusFail
+                    || receiptStatus == ReceiptStatusAbort;
+            }
+        };
+    }
+}
+#endif

simgear/emesary/notifications.hxx

@@ -0,0 +1,68 @@
+#ifndef NOTIFICATIONS_hxx
+#define NOTIFICATIONS_hxx
+/*---------------------------------------------------------------------------
+*
+*	Title                : Emesary - class based inter-object communication
+*
+*	File Type            : Implementation File
+*
+*	Description          : simgear notifications
+*
+*  References           : http://www.chateau-logic.com/content/class-based-inter-object-communication
+*
+*	Author               : Richard Harrison (richard@zaretto.com)
+*
+*	Creation Date        : 18 March 2002, rewrite 2017
+*
+*	Version              : $Header: $
+*
+*  Copyright � 2002 - 2017 Richard Harrison           All Rights Reserved.
+*
+*---------------------------------------------------------------------------*/
+
+#include "INotification.hxx"
+
+namespace simgear
+{
+    namespace Notifications
+    {
+        class MainLoopNotification : public simgear::Emesary::INotification
+        {
+        public:
+            enum Type { Started, Stopped, Begin, End };
+            MainLoopNotification(Type v) : _type(v) {}
+
+            virtual Type GetValue() { return _type; }
+            virtual const char *GetType() { return "MainLoop"; }
+
+        protected:
+            Type _type;
+        };
+
+        class NasalGarbageCollectionConfigurationNotification : public simgear::Emesary::INotification
+        {
+        public:
+            NasalGarbageCollectionConfigurationNotification(bool canWait, bool active) : CanWait(canWait), Active(active) {}
+
+            virtual bool GetCanWait() { return CanWait; }
+            virtual bool GetActive() { return Active; }
+            virtual const char *GetType() { return "NasalGarbageCollectionConfiguration"; }
+            virtual bool SetWait(bool wait) {
+                if (wait == CanWait)
+                    return false;
+                CanWait = wait;
+                return true;
+            }
+            virtual bool SetActive(bool active) {
+                if (active == Active)
+                    return false;
+                Active = active;
+                return true;
+            }
+        public:
+            bool CanWait;
+            bool Active;
+        };
+    }
+}
+#endif

simgear/emesary/test_emesary.cxx

@@ -0,0 +1,130 @@
+////////////////////////////////////////////////////////////////////////
+// Test harness for Emesary.
+////////////////////////////////////////////////////////////////////////
+
+#include <simgear_config.h>
+#include <simgear/compiler.h>
+
+#include <iostream>
+
+#include <simgear/threads/SGThread.hxx>
+#include <simgear/emesary/Emesary.hxx>
+
+using std::cout;
+using std::cerr;
+using std::endl;
+
+std::atomic<int> nthread {0};
+std::atomic<int> noperations {0};
+const int MaxIterations = 9999;
+
+class TestThreadNotification : public simgear::Emesary::INotification
+{
+protected:
+    const char *baseValue;
+public:
+    TestThreadNotification(const char *v) : baseValue(v) {}
+
+    virtual const char* GetType () { return baseValue; }
+};
+
+class TestThreadRecipient : public simgear::Emesary::IReceiver
+{
+public:
+    TestThreadRecipient() : receiveCount(0)
+    {
+    }
+
+    std::atomic<int> receiveCount;
+
+    virtual simgear::Emesary::ReceiptStatus Receive(simgear::Emesary::INotification &n)
+    {
+        if (n.GetType() == (const char*)this)
+        {
+            // Unused: TestThreadNotification *tn = dynamic_cast<TestThreadNotification *>(&n);
+            receiveCount++;
+
+            TestThreadNotification onwardNotification("AL");
+            simgear::Emesary::GlobalTransmitter::instance()->NotifyAll(onwardNotification);
+            
+            return simgear::Emesary::ReceiptStatusOK;
+        }
+
+        return simgear::Emesary::ReceiptStatusOK;
+    }
+};
+
+class EmesaryTestThread : public SGThread
+{
+protected:
+    virtual void run() {
+        int threadId = nthread.fetch_add(1);
+
+        //System.Threading.Interlocked.Increment(ref nthread);
+        //var rng = new Random();
+        TestThreadRecipient r;
+        char temp[100];
+        sprintf(temp, "Notif %d", threadId);
+        printf("starting thread %s\n", temp);
+        TestThreadNotification tn((const char*)&r);
+        for (int i = 0; i < MaxIterations; i++)
+        {
+            simgear::Emesary::GlobalTransmitter::instance()->Register(r);
+            simgear::Emesary::GlobalTransmitter::instance()->NotifyAll(tn);
+            simgear::Emesary::GlobalTransmitter::instance()->DeRegister(r);
+            //System.Threading.Thread.Sleep(rng.Next(MaxSleep));
+            noperations++;
+        }
+        printf("%s invocations %d\n", temp, (int)r.receiveCount);
+        printf("finish thread %s\n", temp);
+    }
+};
+
+class EmesaryTest
+{
+public:
+
+    void Emesary_MultiThreadTransmitterTest()
+    {
+        int num_threads = 12;
+        std::list<EmesaryTestThread*> threads;
+
+        for (int i = 0; i < num_threads; i++)
+        {
+            EmesaryTestThread *thread = new EmesaryTestThread();
+            threads.push_back(thread);
+            thread->start();
+        }
+        for (std::list<EmesaryTestThread*>::iterator i = threads.begin(); i != threads.end(); i++)
+        {
+            (*i)->join();
+        }
+    }
+};
+
+void testEmesaryThreaded()
+{
+    TestThreadRecipient r;
+    TestThreadNotification tn((const char*)&r);
+    simgear::Emesary::GlobalTransmitter::instance()->Register(r);
+    for (int i = 0; i < MaxIterations*MaxIterations; i++)
+    {
+        simgear::Emesary::GlobalTransmitter::instance()->NotifyAll(tn);
+        //System.Threading.Thread.Sleep(rng.Next(MaxSleep));
+        noperations++;
+    }
+    simgear::Emesary::GlobalTransmitter::instance()->DeRegister(r);
+    printf("invocations %d\n", simgear::Emesary::GlobalTransmitter::instance()->SentMessageCount());
+
+    EmesaryTest t;
+    t.Emesary_MultiThreadTransmitterTest();
+}
+
+
+int main(int ac, char ** av)
+{
+    testEmesaryThreaded();
+
+    std::cout << "all tests passed" << std::endl;
+    return 0;
+}

simgear/environment/metar.cxx

@@ -38,11 +38,15 @@
 #  include <simgear_config.h>
 #endif
 
+#include <iomanip>
 #include <string>
 #include <time.h>
 #include <cstring>
+#include <ostream>
+#include <sstream>
 
 #include <simgear/debug/logstream.hxx>
+#include <simgear/math/sg_random.h>
 #include <simgear/structure/exception.hxx>
 
 #include "metar.hxx"
@@ -155,6 +159,320 @@ SGMetar::~SGMetar()
 }
 
 
+static const char *azimuthName(double d)
+{
+	const char *dir[] = {
+		"N", "NNE", "NE", "ENE",
+		"E", "ESE", "SE", "SSE",
+		"S", "SSW", "SW", "WSW",
+		"W", "WNW", "NW", "NNW"
+	};
+	d += 11.25;
+	while (d < 0)
+		d += 360;
+	while (d >= 360)
+		d -= 360;
+	return dir[int(d / 22.5)];
+}
+
+
+// round double to 10^g
+static double rnd(double r, int g = 0)
+{
+	double f = pow(10.0, g);
+	return f * floor(r / f + 0.5);
+}
+
+
+/* A manipulator that can use spaces to emulate tab characters. */
+struct Tab
+{
+    /* If <stops> is 0, we simply insert tab characters. Otherwise we insert
+    spaces to align with the next column at multiple of <stops>. */
+    explicit Tab(int stops)
+    :
+    _stops(stops)
+    {}
+    int _stops;
+};
+
+std::ostream& operator << (std::ostream& out, const Tab& t)
+{
+    if (t._stops == 0) {
+        return out << '\t';
+    }
+    
+    std::ostringstream& out2 = *(std::ostringstream*) &out;
+    std::string s = out2.str();
+    
+    if (t._stops < 0) {
+        if (!s.size() || s[s.size()-1] != ' ') {
+            out << ' ';
+        }
+        return out;
+    }
+    
+    auto nl = s.rfind('\n');
+    if (nl < 0) nl = 0;
+    int column = 0;
+    for (auto i = nl+1; i != s.size(); ++i) {
+        if (s[i] == '\t')
+            column = (column + t._stops) / t._stops * t._stops;
+        else
+            column += 1;
+    }
+    int column2 = (column + t._stops) / t._stops * t._stops;
+    for (int i=column; i<column2; ++i) {
+        out << ' ';
+    }
+    return out;
+}
+
+/* Manipulator for SGMetarVisibility using a Tab. */
+struct SGMetarVisibilityManip
+{
+    explicit SGMetarVisibilityManip(const SGMetarVisibility& v, const Tab& tab)
+    :
+    _v(v),
+    _tab(tab)
+    {}
+    const SGMetarVisibility&    _v;
+    const Tab&                  _tab;
+};
+
+std::ostream& operator << (std::ostream& out, const SGMetarVisibilityManip& v)
+{
+	int m = v._v.getModifier();
+	const char *mod;
+	if (m == SGMetarVisibility::GREATER_THAN)
+		mod = ">=";
+	else if (m == SGMetarVisibility::LESS_THAN)
+		mod = "<";
+	else
+		mod = "";
+	out << mod;
+
+	double dist = rnd(v._v.getVisibility_m(), 1);
+	if (dist < 1000.0)
+		out << rnd(dist, 1) << " m";
+	else
+		out << rnd(dist / 1000.0, -1) << " km";
+
+	const char *dir = "";
+	int i;
+	if ((i = v._v.getDirection()) != -1) {
+		dir = azimuthName(i);
+		out << " " << dir;
+	}
+        out << v._tab << v._tab << v._tab << v._tab << v._tab;
+        out << mod << rnd(v._v.getVisibility_sm(), -1) << " US-miles " << dir;
+        return out;
+}
+
+
+std::string SGMetar::getDescription(int tabstops) const
+{
+        std::ostringstream  out;
+	const char *s;
+	char buf[256];
+	double d;
+	int i, lineno;
+        Tab tab(tabstops);
+        
+	if ((i = getReportType()) == SGMetar::AUTO)
+		out << "(METAR automatically generated)\n";
+	else if (i == SGMetar::COR)
+		out << "(METAR manually corrected)\n";
+	else if (i == SGMetar::RTD)
+		out << "(METAR routine delayed)\n";
+        
+	out << "Airport-Id:" << tab << tab << getId() << "\n";
+
+	// date/time
+	int year = getYear();
+	int month = getMonth();
+	out << "Report time:" << tab << tab << year << '/' << month << '/' << getDay();
+	out << ' ' << getHour() << ':';
+	out << std::setw(2) << std::setfill('0') << getMinute() << " UTC\n";
+
+
+	// visibility
+	SGMetarVisibility minvis = getMinVisibility();
+	SGMetarVisibility maxvis = getMaxVisibility();
+	double min = minvis.getVisibility_m();
+	double max = maxvis.getVisibility_m();
+	if (min != NaN) {
+		if (max != NaN) {
+			out << "min. Visibility:" << tab << SGMetarVisibilityManip(minvis, tab) << "\n";
+			out << "max. Visibility:" << tab << SGMetarVisibilityManip(maxvis, tab) << "\n";
+		} else {
+			out << "Visibility:" << tab << tab << SGMetarVisibilityManip(minvis, tab) << "\n";
+                }
+	}
+
+
+	// directed visibility
+	const SGMetarVisibility *dirvis = getDirVisibility();
+	for (i = 0; i < 8; i++, dirvis++)
+		if (dirvis->getVisibility_m() != NaN)
+			out << tab << tab << tab << SGMetarVisibilityManip(*dirvis, tab) << "\n";
+
+
+	// vertical visibility
+	SGMetarVisibility vertvis = getVertVisibility();
+	if ((d = vertvis.getVisibility_ft()) != NaN)
+		out << "Vert. visibility:" << tab << SGMetarVisibilityManip(vertvis, tab) << "\n";
+	else if (vertvis.getModifier() == SGMetarVisibility::NOGO)
+		out << "Vert. visibility:" << tab << "impossible to determine" << "\n";
+
+
+	// wind
+	d = getWindSpeed_kmh();
+	out << "Wind:" << tab << tab << tab;
+	if (d < .1)
+		out << "none" << "\n";
+	else {
+		if ((i = getWindDir()) == -1)
+			out << "from variable directions";
+		else
+			out << "from the " << azimuthName(i) << " (" << i << " deg)";
+		out << " at " << rnd(d, -1) << " km/h";
+
+		out << tab << tab << rnd(getWindSpeed_kt(), -1) << " kt";
+		out << " = " << rnd(getWindSpeed_mph(), -1) << " mph";
+		out << " = " << rnd(getWindSpeed_mps(), -1) << " m/s";
+		out << "\n";
+
+		d = getGustSpeed_kmh();
+                if (d != NaN && d != 0) {
+			out << tab << tab << tab << "with gusts at " << rnd(d, -1) << " km/h";
+			out << tab << tab << tab << rnd(getGustSpeed_kt(), -1) << " kt";
+			out << " = " << rnd(getGustSpeed_mph(), -1) << " mph";
+			out << " = " << rnd(getGustSpeed_mps(), -1) << " m/s";
+			out << "\n";
+		}
+
+		int from = getWindRangeFrom();
+		int to = getWindRangeTo();
+		if (from != to) {
+			out << tab << tab << tab << "variable from " << azimuthName(from);
+			out << " to " << azimuthName(to);
+			out << " (" << from << "deg --" << to << " deg)" << "\n";
+		}
+	}
+
+
+	// temperature/humidity/air pressure
+	if ((d = getTemperature_C()) != NaN) {
+		out << "Temperature:" << tab << tab << d << " C" << tab << tab << tab << tab << tab;
+		out << rnd(getTemperature_F(), -1) << " F" << "\n";
+
+		if ((d = getDewpoint_C()) != NaN) {
+			out << "Dewpoint:" << tab << tab << d << " C" << tab << tab << tab << tab << tab;
+			out << rnd(getDewpoint_F(), -1) << " F"  << "\n";
+			out << "Rel. Humidity: " << tab << tab << rnd(getRelHumidity()) << " %" << "\n";
+		}
+	}
+	if ((d = getPressure_hPa()) != NaN) {
+		out << "Pressure:" << tab << tab << rnd(d) << " hPa" << tab << tab << tab << tab;
+		out << rnd(getPressure_inHg(), -2) << " in. Hg" << "\n";
+	}
+
+
+	// weather phenomena
+	vector<string> wv = getWeather();
+	vector<string>::iterator weather;
+	for (i = 0, weather = wv.begin(); weather != wv.end(); weather++, i++) {
+		out << (i ? ", " : "Weather:") << tab << tab << weather->c_str();
+	}
+	if (i)
+		out << "\n";
+
+
+	// cloud layers
+	const char *coverage_string[5] = {
+		"clear skies", "few clouds", "scattered clouds", "broken clouds", "sky overcast"
+	};
+	vector<SGMetarCloud> cv = getClouds();
+	vector<SGMetarCloud>::iterator cloud;
+	for (lineno = 0, cloud = cv.begin(); cloud != cv.end(); cloud++, lineno++) {
+                if (lineno) out << tab << tab << tab;
+                else    out << "Sky condition:" << tab << tab;
+
+		if ((i = cloud->getCoverage()) != -1)
+			out << coverage_string[i];
+		if ((d = cloud->getAltitude_ft()) != NaN)
+			out << " at " << rnd(d, 1) << " ft";
+		if ((s = cloud->getTypeLongString()))
+			out << " (" << s << ')';
+		if (d != NaN)
+			out << tab << tab << tab << rnd(cloud->getAltitude_m(), 1) << " m";
+		out << "\n";
+	}
+
+
+	// runways
+	map<string, SGMetarRunway> rm = getRunways();
+	map<string, SGMetarRunway>::iterator runway;
+	for (runway = rm.begin(); runway != rm.end(); runway++) {
+		lineno = 0;
+		if (!strcmp(runway->first.c_str(), "ALL"))
+			out << "All runways:" << tab << tab;
+		else
+			out << "Runway " << runway->first << ":" << tab << tab;
+		SGMetarRunway rwy = runway->second;
+
+		// assemble surface string
+		vector<string> surface;
+		if ((s = rwy.getDepositString()) && strlen(s))
+			surface.push_back(s);
+		if ((s = rwy.getExtentString()) && strlen(s))
+			surface.push_back(s);
+		if ((d = rwy.getDepth()) != NaN) {
+			sprintf(buf, "%.1lf mm", d * 1000.0);
+			surface.push_back(buf);
+		}
+		if ((s = rwy.getFrictionString()) && strlen(s))
+			surface.push_back(s);
+		if ((d = rwy.getFriction()) != NaN) {
+			sprintf(buf, "friction: %.2lf", d);
+			surface.push_back(buf);
+		}
+
+		if (! surface.empty()) {
+			vector<string>::iterator rwysurf = surface.begin();
+			for (i = 0; rwysurf != surface.end(); rwysurf++, i++) {
+				if (i)
+					out << ", ";
+				out << *rwysurf;
+			}
+			lineno++;
+		}
+
+		// assemble visibility string
+		SGMetarVisibility minvis = rwy.getMinVisibility();
+		SGMetarVisibility maxvis = rwy.getMaxVisibility();
+		if ((d = minvis.getVisibility_m()) != NaN) {
+			if (lineno++)
+				out << "\n" << tab << tab << tab;
+			out << SGMetarVisibilityManip(minvis, tab);
+		}
+		if (maxvis.getVisibility_m() != d) {
+			out << "\n" << tab << tab << tab << SGMetarVisibilityManip(maxvis, tab) << "\n";
+			lineno++;
+		}
+
+		if (rwy.getWindShear()) {
+			if (lineno++)
+				out << "\n" << tab << tab << tab;
+			out << "critical wind shear" << "\n";
+		}
+		out << "\n";
+	}
+	out << "\n";
+        return out.str();
+}
+
 void SGMetar::useCurrentDate()
 {
 	struct tm now;
@@ -314,30 +632,41 @@ bool SGMetar::scanWind()
 	int dir;
 	if (!strncmp(m, "VRB", 3))
 		m += 3, dir = -1;
+	else if (!strncmp(m, "///", 3))	// direction not measurable
+		m += 3, dir = -1;
 	else if (!scanNumber(&m, &dir, 3))
 		return false;
 
 	int i;
-	if (!scanNumber(&m, &i, 2, 3))
+	if (!strncmp(m, "//", 2))	// speed not measurable
+		m += 2, i = -1;
+	else if (!scanNumber(&m, &i, 2, 3))
 		return false;
 	double speed = i;
 
 	double gust = NaN;
 	if (*m == 'G') {
 		m++;
-		if (!scanNumber(&m, &i, 2, 3))
+		if (!strncmp(m, "//", 2))	// speed not measurable
+			m += 2, i = -1;
+		else if (!scanNumber(&m, &i, 2, 3))
 			return false;
+
+		if (i != -1)
 			gust = i;
 	}
+
 	double factor;
 	if (!strncmp(m, "KT", 2))
 		m += 2, factor = SG_KT_TO_MPS;
-	else if (!strncmp(m, "KMH", 3))
+	else if (!strncmp(m, "KMH", 3))		// invalid Km/h
 		m += 3, factor = SG_KMH_TO_MPS;
-	else if (!strncmp(m, "KPH", 3))		// ??
+	else if (!strncmp(m, "KPH", 3))		// invalid Km/h
 		m += 3, factor = SG_KMH_TO_MPS;
 	else if (!strncmp(m, "MPS", 3))
 		m += 3, factor = 1.0;
+	else if (!strncmp(m, " ", 1))		// default to Knots
+		factor = SG_KT_TO_MPS;
 	else
 		return false;
 	if (!scanBoundary(&m))
@@ -357,18 +686,28 @@ bool SGMetar::scanVariability()
 {
 	char *m = _m;
 	int from, to;
-	if (!scanNumber(&m, &from, 3))
+
+	if (!strncmp(m, "///", 3))	// direction not measurable
+		m += 3, from = -1;
+	else if (!scanNumber(&m, &from, 3))
 		return false;
+
 	if (*m++ != 'V')
 		return false;
-	if (!scanNumber(&m, &to, 3))
+
+	if (!strncmp(m, "///", 3))	// direction not measurable
+		m += 3, to = -1;
+	else if (!scanNumber(&m, &to, 3))
 		return false;
+
 	if (!scanBoundary(&m))
 		return false;
+
 	_m = m;
 	_wind_range_from = from;
 	_wind_range_to = to;
 	_grpcount++;
+
 	return true;
 }
 
@@ -635,6 +974,8 @@ bool SGMetar::scanWeather()
 		weather += string(a->text) + " ";
 		if (!strcmp(a->id, "RA"))
 			_rain = w.intensity;
+		else if (!strcmp(a->id, "DZ"))
+			_rain = LIGHT;
 		else if (!strcmp(a->id, "HA"))
 			_hail = w.intensity;
 		else if (!strcmp(a->id, "SN"))
@@ -728,9 +1069,12 @@ bool SGMetar::scanSkyCondition()
 		return false;
 	m += i;
 
-	if (!strncmp(m, "///", 3))	// vis not measurable (e.g. because of heavy snowing)
+	if (!strncmp(m, "///", 3))	{ // vis not measurable (e.g. because of heavy snowing)
 		m += 3, i = -1;
-	else if (scanBoundary(&m)) {
+		sg_srandom_time();
+		// randomize the base height to avoid the black sky issue
+		i = 50 + static_cast<int>(sg_random() * 250.0);		// range [5,000, 30,000]
+	} else if (scanBoundary(&m)) {
 		_m = m;
 		return true;				// ignore single OVC/BKN/...
 	} else if (!scanNumber(&m, &i, 3))

simgear/environment/metar.hxx

@@ -235,6 +235,11 @@ public:
 	inline const std::vector<std::string>& getWeather()		const	{ return _weather; }
 	inline const std::vector<struct Weather> getWeather2()	const   { return _weather2; }
 
+        /* Returns human-readable description. If tabtops is 0, we use tab
+        characters. If +ve we use spaces to pad to multiple of <tabstops>. If
+        -1 all sequences of tabs are represented by a single space. */
+        std::string     getDescription(int tabstops)   const;
+
 protected:
 	std::string	_url;
 	int	_grpcount;