Skip to content

Commit

Permalink
Conditionally link with Boost.Regex library, if it's in C++03 mode.
Browse files Browse the repository at this point in the history
Boost.Log supports compilers that do not qualify as C++11 compilers
for Boost.Regex, even if they are compiling in C++11 mode. In that
case, we still need to link with Boost.Regex v4 prebuilt library.

For more recent compilers, Boost.Regex v5 is used, and that is
a header-only library. This commit removes linking with Boost.Regex
when this is detected at configure time.

Note that only Boost.Build is updated. CMake doesn't need to be
updated since even header-only libraries need to be listed as
dependencies.

Closes #219.
  • Loading branch information
Lastique committed Sep 25, 2023
1 parent adbdc63 commit 79e6e75
Show file tree
Hide file tree
Showing 5 changed files with 170 additions and 134 deletions.
147 changes: 14 additions & 133 deletions build/Jamfile.v2
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ import feature ;
import configure ;
import log-arch-config ;
import log-platform-config ;
import log-build-config ;

using mc ;

local here = [ modules.binding $(__name__) ] ;

project.push-current [ project.current ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/message-compiler ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/x86-ext ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/pthread-mutex-robust ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/native-syslog ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/atomic-int32 ] ;
project.pop-current ;

# Windows libs
Expand All @@ -41,132 +39,15 @@ lib nsl ;
lib ipv6 ;
explicit rt socket nsl ipv6 ;

rule has-config-flag ( flag : properties * )
{
if ( "<define>$(flag)" in $(properties) || "<define>$(flag)=1" in $(properties) )
{
return 1 ;
}
else
{
return ;
}
}

rule check-instruction-set ( properties * )
{
local result ;
local instruction_set = [ log-arch-config.deduce-instruction-set $(properties) ] ;

if $(instruction_set) = i386 || $(instruction_set) = i486
{
if ! $(.annouced-failure)
{
ECHO Boost.Log is not supported on the specified target CPU and will not be built. At least i586 class CPU is required. ;
.annouced-failure = 1 ;
}
result = <build>no ;
}

return $(result) ;
}

rule select-regex-backend ( properties * )
{
local result ;

# Use Boost.Regex backend by default. It produces smaller executables and also has the best performance for small string matching.
if ! (
[ has-config-flag BOOST_LOG_WITHOUT_SETTINGS_PARSERS : $(properties) ] ||
[ has-config-flag BOOST_LOG_WITHOUT_DEFAULT_FACTORIES : $(properties) ] ||
[ has-config-flag BOOST_LOG_USE_STD_REGEX : $(properties) ] ||
[ has-config-flag BOOST_LOG_USE_BOOST_XPRESSIVE : $(properties) ] )
{
result = <library>/boost/regex//boost_regex ;
}

return $(result) ;
}

rule check-pthread-mutex-robust ( properties * )
{
local result ;

local has_pthread_mutex_robust = [ configure.builds /boost/log/pthread-mutex-robust//pthread_mutex_robust : $(properties) : "pthread supports robust mutexes" ] ;
if $(has_pthread_mutex_robust)
{
result = <define>BOOST_LOG_HAS_PTHREAD_MUTEX_ROBUST ;
}

return $(result) ;
}

rule check-atomic-int32 ( properties * )
{
local result ;

local has_atomic_int32 = [ configure.builds /boost/log/atomic-int32//atomic_int32 : $(properties) : "native atomic int32 supported" ] ;
if ! $(has_atomic_int32)
{
result = <define>BOOST_LOG_WITHOUT_IPC ;
}

return $(result) ;
}

rule check-native-syslog ( properties * )
{
local result ;

if ! [ has-config-flag BOOST_LOG_WITHOUT_SYSLOG : $(properties) ]
{
local has_native_syslog = [ configure.builds /boost/log/native-syslog//native_syslog : $(properties) : "native syslog supported" ] ;
if $(has_native_syslog)
{
result = <define>BOOST_LOG_USE_NATIVE_SYSLOG ;
}
}

return $(result) ;
}

rule check-message-compiler ( properties * )
{
local result ;

if <target-os>windows in $(properties)
{
if ! [ has-config-flag BOOST_LOG_WITHOUT_EVENT_LOG : $(properties) ]
{
local has_mc = [ configure.builds /boost/log/message-compiler//test-availability : $(properties) : "has message compiler" ] ;
if ! $(has_mc)
{
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}
}
else
{
# This branch is needed to fix building with MinGW
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}
}
else
{
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}

return $(result) ;
}

project boost/log
: source-location ../src
: requirements
<conditional>@check-instruction-set
<conditional>@check-atomic-int32
<conditional>@select-regex-backend
<conditional>@check-pthread-mutex-robust
<conditional>@check-native-syslog
<conditional>@check-message-compiler
<conditional>@log-arch-config.check-instruction-set
<conditional>@log-build-config.check-atomic-int32
<conditional>@log-build-config.select-regex-backend
<conditional>@log-build-config.check-pthread-mutex-robust
<conditional>@log-build-config.check-native-syslog
<conditional>@log-build-config.check-message-compiler
<conditional>@log-platform-config.set-platform-defines

<include>../src
Expand Down Expand Up @@ -346,7 +227,7 @@ rule select-platform-specific-sources ( properties * )
result += <source>windows/light_rw_mutex.cpp ;
result += <source>windows/is_debugger_present.cpp ;

if ! [ has-config-flag BOOST_LOG_WITHOUT_IPC : $(properties) ]
if ! [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_IPC : $(properties) ]
{
result += <source>windows/object_name.cpp ;
result += <source>windows/mapped_shared_memory.cpp ;
Expand All @@ -355,12 +236,12 @@ rule select-platform-specific-sources ( properties * )
result += <library>secur32 ;
}

if ! [ has-config-flag BOOST_LOG_WITHOUT_DEBUG_OUTPUT : $(properties) ]
if ! [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_DEBUG_OUTPUT : $(properties) ]
{
result += <source>windows/debug_output_backend.cpp ;
}

if ! [ has-config-flag BOOST_LOG_WITHOUT_EVENT_LOG : $(properties) ]
if ! [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_EVENT_LOG : $(properties) ]
{
result += <source>windows/simple_event_log.mc ;
result += <source>windows/event_log_backend.cpp ;
Expand All @@ -374,14 +255,14 @@ rule select-platform-specific-sources ( properties * )
result += <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
result += <define>BOOST_LOG_WITHOUT_DEBUG_OUTPUT ;

if ! [ has-config-flag BOOST_LOG_WITHOUT_IPC : $(properties) ]
if ! [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_IPC : $(properties) ]
{
result += <source>posix/object_name.cpp ;
result += <source>posix/ipc_reliable_message_queue.cpp ;
}
}

if ! [ has-config-flag BOOST_LOG_WITHOUT_SYSLOG : $(properties) ]
if ! [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_SYSLOG : $(properties) ]
{
result += <source>syslog_backend.cpp ;
}
Expand Down Expand Up @@ -422,7 +303,7 @@ rule check-boost_log_setup-enabled ( properties * )
{
local result ;

if [ has-config-flag BOOST_LOG_WITHOUT_SETTINGS_PARSERS : $(properties) ]
if [ log-build-config.has-config-flag BOOST_LOG_WITHOUT_SETTINGS_PARSERS : $(properties) ]
{
result = <build>no ;
}
Expand Down
18 changes: 18 additions & 0 deletions build/log-arch-config.jam
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,21 @@ rule avx2-flags ( properties * )

return $(result) ;
}

rule check-instruction-set ( properties * )
{
local result ;
local instruction_set = [ log-arch-config.deduce-instruction-set $(properties) ] ;

if $(instruction_set) = i386 || $(instruction_set) = i486
{
if ! $(.annouced-failure)
{
ECHO Boost.Log is not supported on the specified target CPU and will not be built. At least i586 class CPU is required. ;
.annouced-failure = 1 ;
}
result = <build>no ;
}

return $(result) ;
}
135 changes: 135 additions & 0 deletions build/log-build-config.jam
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# log-build-config.jam
#
# Copyright 2023 Andrey Semashev
#
# Distributed under the Boost Software License Version 1.0. (See
# accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)

import configure ;
import project ;
import path ;
import property ;
import feature ;

local here = [ modules.binding $(__name__) ] ;

project.push-current [ project.current ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/message-compiler ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/pthread-mutex-robust ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/native-syslog ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/atomic-int32 ] ;
project.load [ path.join [ path.make $(here:D) ] ../config/regex-header-only ] ;
project.pop-current ;

rule has-config-flag ( flag : properties * )
{
if ( "<define>$(flag)" in $(properties) || "<define>$(flag)=1" in $(properties) )
{
return 1 ;
}
else
{
return ;
}
}

rule check-regex-header-only ( properties * )
{
local result ;

local has_regex_header_only = [ configure.builds /boost/log/regex-header-only//regex_header_only : $(properties) : "Boost.Regex is header-only" ] ;
if ! $(has_regex_header_only)
{
result = <library>/boost/regex//boost_regex ;
}

return $(result) ;
}

rule check-atomic-int32 ( properties * )
{
local result ;

local has_atomic_int32 = [ configure.builds /boost/log/atomic-int32//atomic_int32 : $(properties) : "native atomic int32 supported" ] ;
if ! $(has_atomic_int32)
{
result = <define>BOOST_LOG_WITHOUT_IPC ;
}

return $(result) ;
}

rule check-pthread-mutex-robust ( properties * )
{
local result ;

local has_pthread_mutex_robust = [ configure.builds /boost/log/pthread-mutex-robust//pthread_mutex_robust : $(properties) : "pthread supports robust mutexes" ] ;
if $(has_pthread_mutex_robust)
{
result = <define>BOOST_LOG_HAS_PTHREAD_MUTEX_ROBUST ;
}

return $(result) ;
}

rule check-native-syslog ( properties * )
{
local result ;

if ! [ has-config-flag BOOST_LOG_WITHOUT_SYSLOG : $(properties) ]
{
local has_native_syslog = [ configure.builds /boost/log/native-syslog//native_syslog : $(properties) : "native syslog supported" ] ;
if $(has_native_syslog)
{
result = <define>BOOST_LOG_USE_NATIVE_SYSLOG ;
}
}

return $(result) ;
}

rule check-message-compiler ( properties * )
{
local result ;

if <target-os>windows in $(properties)
{
if ! [ has-config-flag BOOST_LOG_WITHOUT_EVENT_LOG : $(properties) ]
{
local has_mc = [ configure.builds /boost/log/message-compiler//test-availability : $(properties) : "has message compiler" ] ;
if ! $(has_mc)
{
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}
}
else
{
# This branch is needed to fix building with MinGW
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}
}
else
{
result = <define>BOOST_LOG_WITHOUT_EVENT_LOG ;
}

return $(result) ;
}

rule select-regex-backend ( properties * )
{
local result ;

# Use Boost.Regex backend by default. It produces smaller executables and also has the best performance for small string matching.
if ! (
[ log-build-config.has-config-flag BOOST_LOG_WITHOUT_SETTINGS_PARSERS : $(properties) ] ||
[ log-build-config.has-config-flag BOOST_LOG_WITHOUT_DEFAULT_FACTORIES : $(properties) ] ||
[ log-build-config.has-config-flag BOOST_LOG_USE_STD_REGEX : $(properties) ] ||
[ log-build-config.has-config-flag BOOST_LOG_USE_BOOST_XPRESSIVE : $(properties) ] )
{
result = <conditional>@log-build-config.check-regex-header-only ;
}

return $(result) ;
}
1 change: 1 addition & 0 deletions doc/changelog.qbk
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
[heading 2.28, Boost 1.84]

* C++03 is no longer supported. A C++11 or later compiler is required.
* When built with C++11 compilers that are conforming enough for Boost.Regex v5 to be used, Boost.Log no longer links with Boost.Regex prebuilt library, since Boost.Regex v5 is header-only.

[heading 2.27, Boost 1.83]

Expand Down
3 changes: 2 additions & 1 deletion test/Jamfile.v2
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ import path ;
import regex ;
import os ;
import ../build/log-platform-config ;
import ../build/log-build-config ;

project
: requirements
<conditional>@log-platform-config.set-platform-defines
<conditional>@log-build-config.check-regex-header-only

<include>common

Expand Down Expand Up @@ -50,7 +52,6 @@ project

<library>/boost/log//boost_log
<library>/boost/log//boost_log_setup
<library>/boost/regex//boost_regex
<library>/boost/filesystem//boost_filesystem
<library>/boost/test//boost_unit_test_framework
<threading>single:<define>BOOST_LOG_NO_THREADS
Expand Down

0 comments on commit 79e6e75

Please sign in to comment.