Add "NAC_" prefix to access specifier macros to avoid conflicts
Also, sync boost.py with ndn-cxx and fix doxygen configuration
Refs: #4908
Change-Id: I388005810aac18aaea749a57666438bcc5de7811
diff --git a/.waf-tools/boost.py b/.waf-tools/boost.py
index d7e0107..4b2ede5 100644
--- a/.waf-tools/boost.py
+++ b/.waf-tools/boost.py
@@ -56,6 +56,7 @@
BOOST_LIBS = ['/usr/lib', '/usr/local/lib', '/opt/local/lib', '/sw/lib', '/lib']
BOOST_INCLUDES = ['/usr/include', '/usr/local/include', '/opt/local/include', '/sw/include']
+
BOOST_VERSION_FILE = 'boost/version.hpp'
BOOST_VERSION_CODE = '''
#include <iostream>
@@ -90,13 +91,18 @@
BOOST_LOG_CODE = '''
#include <boost/log/trivial.hpp>
+int main() { BOOST_LOG_TRIVIAL(info) << "boost_log is working"; }
+'''
+
+BOOST_LOG_SETUP_CODE = '''
+#include <boost/log/trivial.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
int main() {
using namespace boost::log;
add_common_attributes();
add_console_log(std::clog, keywords::format = "%Message%");
- BOOST_LOG_TRIVIAL(debug) << "log is working" << std::endl;
+ BOOST_LOG_TRIVIAL(info) << "boost_log_setup is working";
}
'''
@@ -145,7 +151,7 @@
opt.add_option('--boost-abi', type='string', default='', dest='boost_abi',
help='''select libraries with tags (gd for debug, static is automatically added),
see doc Boost, Getting Started, chapter 6.1''')
- opt.add_option('--boost-linkage_autodetect', action="store_true", dest='boost_linkage_autodetect',
+ opt.add_option('--boost-linkage_autodetect', action='store_true', dest='boost_linkage_autodetect',
help="auto-detect boost linkage options (don't get used to it / might break other stuff)")
opt.add_option('--boost-toolset', type='string',
default='', dest='boost_toolset',
@@ -175,7 +181,7 @@
try:
txt = node.read()
except EnvironmentError:
- Logs.error("Could not read the file %r" % node.abspath())
+ Logs.error('Could not read the file %r' % node.abspath())
else:
re_but1 = re.compile('^#define\\s+BOOST_LIB_VERSION\\s+"(.+)"', re.M)
m1 = re_but1.search(txt)
@@ -183,7 +189,7 @@
m2 = re_but2.search(txt)
if m1 and m2:
return (m1.group(1), m2.group(1))
- return self.check_cxx(fragment=BOOST_VERSION_CODE, includes=[d], execute=True, define_ret=True).split(":")
+ return self.check_cxx(fragment=BOOST_VERSION_CODE, includes=[d], execute=True, define_ret=True).split(':')
@conf
def boost_get_includes(self, *k, **kw):
@@ -194,10 +200,10 @@
if self.__boost_get_version_file(d):
return d
if includes:
- self.end_msg('headers not found in %s' % includes)
+ self.end_msg('headers not found in %s' % includes, 'YELLOW')
self.fatal('The configuration failed')
else:
- self.end_msg('headers not found, please provide a --boost-includes argument (see help)')
+ self.end_msg('headers not found, please provide a --boost-includes argument (see help)', 'YELLOW')
self.fatal('The configuration failed')
@@ -240,10 +246,10 @@
break
if not path:
if libs:
- self.end_msg('libs not found in %s' % libs)
+ self.end_msg('libs not found in %s' % libs, 'YELLOW')
self.fatal('The configuration failed')
else:
- self.end_msg('libs not found, please provide a --boost-libs argument (see help)')
+ self.end_msg('libs not found, please provide a --boost-libs argument (see help)', 'YELLOW')
self.fatal('The configuration failed')
self.to_log('Found the boost path in %r with the libraries:' % path)
@@ -313,7 +319,7 @@
libs.append(format_lib_name(file.name))
break
else:
- self.end_msg('lib %s not found in %s' % (lib, path.abspath()))
+ self.end_msg('lib %s not found in %s' % (lib, path.abspath()), 'YELLOW')
self.fatal('The configuration failed')
return libs
@@ -354,7 +360,7 @@
# ... -mt is also the pthreads flag for HP/aCC
# -lpthread: GNU Linux, etc.
# --thread-safe: KAI C++
- if Utils.unversioned_sys_platform() == "sunos":
+ if Utils.unversioned_sys_platform() == 'sunos':
# On Solaris (at least, for some versions), libc contains stubbed
# (non-functional) versions of the pthreads routines, so link-based
# tests will erroneously succeed. (We need to link with -pthreads/-mt/
@@ -362,23 +368,22 @@
# a function called by this macro, so we could check for that, but
# who knows whether they'll stub that too in a future libc.) So,
# we'll just look for -pthreads and -lpthread first:
- boost_pthread_flags = ["-pthreads", "-lpthread", "-mt", "-pthread"]
+ boost_pthread_flags = ['-pthreads', '-lpthread', '-mt', '-pthread']
else:
- boost_pthread_flags = ["", "-lpthreads", "-Kthread", "-kthread", "-llthread", "-pthread",
- "-pthreads", "-mthreads", "-lpthread", "--thread-safe", "-mt"]
+ boost_pthread_flags = ['', '-lpthreads', '-Kthread', '-kthread', '-llthread', '-pthread',
+ '-pthreads', '-mthreads', '-lpthread', '--thread-safe', '-mt']
for boost_pthread_flag in boost_pthread_flags:
try:
self.env.stash()
self.env['CXXFLAGS_%s' % var] += [boost_pthread_flag]
self.env['LINKFLAGS_%s' % var] += [boost_pthread_flag]
- self.check_cxx(code=PTHREAD_CODE, msg=None, use=var, execute=False)
-
+ self.check_cxx(code=PTHREAD_CODE, msg=None, use=var, execute=False, quiet=True)
self.end_msg(boost_pthread_flag)
return
except self.errors.ConfigurationError:
self.env.revert()
- self.end_msg('None')
+ self.end_msg('none')
@conf
def check_boost(self, *k, **kw):
@@ -403,21 +408,24 @@
var = kw.get('uselib_store', 'BOOST')
- self.find_program('dpkg-architecture', var='DPKG_ARCHITECTURE', mandatory=False)
- if self.env.DPKG_ARCHITECTURE:
- deb_host_multiarch = self.cmd_and_log([self.env.DPKG_ARCHITECTURE[0], '-qDEB_HOST_MULTIARCH'])
- BOOST_LIBS.insert(0, '/usr/lib/%s' % deb_host_multiarch.strip())
+ if not self.env.DONE_FIND_BOOST_COMMON:
+ self.find_program('dpkg-architecture', var='DPKG_ARCHITECTURE', mandatory=False)
+ if self.env.DPKG_ARCHITECTURE:
+ deb_host_multiarch = self.cmd_and_log([self.env.DPKG_ARCHITECTURE[0], '-qDEB_HOST_MULTIARCH'])
+ BOOST_LIBS.insert(0, '/usr/lib/%s' % deb_host_multiarch.strip())
- self.start_msg('Checking boost includes')
- self.env['INCLUDES_%s' % var] = inc = self.boost_get_includes(**params)
- versions = self.boost_get_version(inc)
- self.env.BOOST_VERSION = versions[0]
- self.env.BOOST_VERSION_NUMBER = int(versions[1])
- self.end_msg("%d.%d.%d" % (int(versions[1]) / 100000,
- int(versions[1]) / 100 % 1000,
- int(versions[1]) % 100))
- if Logs.verbose:
- Logs.pprint('CYAN', ' path : %s' % self.env['INCLUDES_%s' % var])
+ self.start_msg('Checking boost includes')
+ self.env['INCLUDES_%s' % var] = inc = self.boost_get_includes(**params)
+ versions = self.boost_get_version(inc)
+ self.env.BOOST_VERSION = versions[0]
+ self.env.BOOST_VERSION_NUMBER = int(versions[1])
+ self.end_msg('%d.%d.%d' % (int(versions[1]) / 100000,
+ int(versions[1]) / 100 % 1000,
+ int(versions[1]) % 100))
+ if Logs.verbose:
+ Logs.pprint('CYAN', ' path : %s' % self.env['INCLUDES_%s' % var])
+
+ self.env.DONE_FIND_BOOST_COMMON = True
if not params['lib'] and not params['stlib']:
return
@@ -429,7 +437,7 @@
self.env['STLIBPATH_%s' % var] = [path]
self.env['LIB_%s' % var] = libs
self.env['STLIB_%s' % var] = stlibs
- self.end_msg('ok')
+ self.end_msg(' '.join(libs + stlibs))
if Logs.verbose:
Logs.pprint('CYAN', ' path : %s' % path)
Logs.pprint('CYAN', ' shared libs : %s' % libs)
@@ -450,15 +458,18 @@
self.check_cxx(fragment=BOOST_ERROR_CODE, use=var, execute=False)
if has_lib('thread'):
self.check_cxx(fragment=BOOST_THREAD_CODE, use=var, execute=False)
- if has_lib('log'):
+ if has_lib('log') or has_lib('log_setup'):
if not has_lib('thread'):
self.env['DEFINES_%s' % var] += ['BOOST_LOG_NO_THREADS']
- if has_shlib('log'):
+ if has_shlib('log') or has_shlib('log_setup'):
self.env['DEFINES_%s' % var] += ['BOOST_LOG_DYN_LINK']
- self.check_cxx(fragment=BOOST_LOG_CODE, use=var, execute=False)
+ if has_lib('log_setup'):
+ self.check_cxx(fragment=BOOST_LOG_SETUP_CODE, use=var, execute=False)
+ else:
+ self.check_cxx(fragment=BOOST_LOG_CODE, use=var, execute=False)
if params.get('linkage_autodetect', False):
- self.start_msg("Attempting to detect boost linkage flags")
+ self.start_msg('Attempting to detect boost linkage flags')
toolset = self.boost_get_toolset(kw.get('toolset', ''))
if toolset in ('vc',):
# disable auto-linking feature, causing error LNK1181
@@ -480,10 +491,10 @@
# we attempt to play with some known-to-work CXXFLAGS combinations
for cxxflags in (['/MD', '/EHsc'], []):
self.env.stash()
- self.env["CXXFLAGS_%s" % var] += cxxflags
+ self.env['CXXFLAGS_%s' % var] += cxxflags
try:
try_link()
- self.end_msg("ok: winning cxxflags combination: %s" % (self.env["CXXFLAGS_%s" % var]))
+ self.end_msg('ok: winning cxxflags combination: %s' % (self.env['CXXFLAGS_%s' % var]))
exc = None
break
except Errors.ConfigurationError as e:
@@ -491,17 +502,17 @@
exc = e
if exc is not None:
- self.end_msg("Could not auto-detect boost linking flags combination, you may report it to boost.py author", ex=exc)
+ self.end_msg('Could not auto-detect boost linking flags combination, you may report it to boost.py author', ex=exc)
self.fatal('The configuration failed')
else:
- self.end_msg("Boost linkage flags auto-detection not implemented (needed ?) for this toolchain")
+ self.end_msg('Boost linkage flags auto-detection not implemented (needed ?) for this toolchain')
self.fatal('The configuration failed')
else:
self.start_msg('Checking for boost linkage')
try:
try_link()
except Errors.ConfigurationError as e:
- self.end_msg("Could not link against boost libraries using supplied options")
+ self.end_msg('Could not link against boost libraries using supplied options', 'YELLOW')
self.fatal('The configuration failed')
self.end_msg('ok')
diff --git a/docs/doxygen.conf.in b/docs/doxygen.conf.in
index a655c3b..33b1fba 100644
--- a/docs/doxygen.conf.in
+++ b/docs/doxygen.conf.in
@@ -232,7 +232,7 @@
# members will be omitted, etc.
# The default value is: NO.
-OPTIMIZE_OUTPUT_FOR_C = YES
+OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
@@ -422,7 +422,7 @@
# for Java sources.
# The default value is: YES.
-EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
@@ -524,7 +524,7 @@
# name. If set to NO the members will appear in declaration order.
# The default value is: NO.
-SORT_BRIEF_DOCS = NO
+SORT_BRIEF_DOCS = YES
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
@@ -536,7 +536,7 @@
# detailed member documentation.
# The default value is: NO.
-SORT_MEMBERS_CTORS_1ST = NO
+SORT_MEMBERS_CTORS_1ST = YES
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
@@ -733,7 +733,7 @@
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = src/
+INPUT = src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1117,7 +1117,7 @@
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_DYNAMIC_SECTIONS = NO
+HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
@@ -1355,7 +1355,7 @@
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
-ENUM_VALUES_PER_LINE = 4
+ENUM_VALUES_PER_LINE = 1
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
@@ -1917,14 +1917,12 @@
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = DOXYGEN \
- NFD_LOG_INIT \
- BOOST_CONCEPT_ASSERT \
- PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
- PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
- PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
- VIRTUAL_WITH_TESTS \
- NDN_CXX_KEYCHAIN_REGISTER_PIB \
- NDN_CXX_KEYCHAIN_REGISTER_TPM
+ BOOST_CONCEPT_ASSERT(x)= \
+ BOOST_CONCEPT_REQUIRES(x)= \
+ NAC_PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
+ NAC_PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
+ NAC_PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
+ NAC_VIRTUAL_WITH_TESTS
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
@@ -2261,7 +2259,7 @@
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_MULTI_TARGETS = NO
+DOT_MULTI_TARGETS = YES
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
diff --git a/src/common.hpp b/src/common.hpp
index a84c66c..7b9f977 100644
--- a/src/common.hpp
+++ b/src/common.hpp
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2014-2018, Regents of the University of California
+ * Copyright (c) 2014-2019, Regents of the University of California
*
* NAC library is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
@@ -22,16 +22,16 @@
#include "config.hpp"
-#ifdef NDN_NAC_HAVE_TESTS
-#define VIRTUAL_WITH_TESTS virtual
-#define PUBLIC_WITH_TESTS_ELSE_PROTECTED public
-#define PUBLIC_WITH_TESTS_ELSE_PRIVATE public
-#define PROTECTED_WITH_TESTS_ELSE_PRIVATE protected
+#ifdef NAC_WITH_TESTS
+#define NAC_VIRTUAL_WITH_TESTS virtual
+#define NAC_PUBLIC_WITH_TESTS_ELSE_PROTECTED public
+#define NAC_PUBLIC_WITH_TESTS_ELSE_PRIVATE public
+#define NAC_PROTECTED_WITH_TESTS_ELSE_PRIVATE protected
#else
-#define VIRTUAL_WITH_TESTS
-#define PUBLIC_WITH_TESTS_ELSE_PROTECTED protected
-#define PUBLIC_WITH_TESTS_ELSE_PRIVATE private
-#define PROTECTED_WITH_TESTS_ELSE_PRIVATE private
+#define NAC_VIRTUAL_WITH_TESTS
+#define NAC_PUBLIC_WITH_TESTS_ELSE_PROTECTED protected
+#define NAC_PUBLIC_WITH_TESTS_ELSE_PRIVATE private
+#define NAC_PROTECTED_WITH_TESTS_ELSE_PRIVATE private
#endif
#include <cstddef>
diff --git a/src/encryptor.hpp b/src/encryptor.hpp
index 2b82d31..21a9297 100644
--- a/src/encryptor.hpp
+++ b/src/encryptor.hpp
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2014-2018, Regents of the University of California
+/*
+ * Copyright (c) 2014-2019, Regents of the University of California
*
* NAC library is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
@@ -127,7 +127,7 @@
bool
makeAndPublishCkData(const ErrorCallback& onFailure);
-PUBLIC_WITH_TESTS_ELSE_PRIVATE:
+NAC_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
Name m_accessPrefix;
Name m_ckPrefix;
Name m_ckName;
diff --git a/wscript b/wscript
index 708d7d9..5687dd3 100644
--- a/wscript
+++ b/wscript
@@ -10,51 +10,49 @@
def options(opt):
opt.load(['compiler_cxx', 'gnu_dirs'])
- opt.load(['default-compiler-flags', 'boost',
- 'coverage', 'sanitizers',
- 'doxygen', 'sphinx_build'],
+ opt.load(['default-compiler-flags', 'coverage', 'sanitizers',
+ 'boost', 'doxygen', 'sphinx_build'],
tooldir=['.waf-tools'])
- opt = opt.add_option_group('NDN-NAC Options')
-
- opt.add_option('--with-tests', action='store_true', default=False,
- help='Build unit tests')
+ optgrp = opt.add_option_group('NDN-NAC Options')
+ optgrp.add_option('--with-tests', action='store_true', default=False,
+ help='Build unit tests')
def configure(conf):
conf.load(['compiler_cxx', 'gnu_dirs',
'default-compiler-flags', 'boost',
'doxygen', 'sphinx_build'])
- conf.env['WITH_TESTS'] = conf.options.with_tests
+ conf.env.WITH_EXAMPLES = True
+ conf.env.WITH_TESTS = conf.options.with_tests
if 'PKG_CONFIG_PATH' not in os.environ:
os.environ['PKG_CONFIG_PATH'] = Utils.subst_vars('${LIBDIR}/pkgconfig', conf.env)
- conf.check_cfg(package='libndn-cxx', args=['--cflags', '--libs'],
- uselib_store='NDN_CXX', mandatory=True)
+ conf.check_cfg(package='libndn-cxx', args=['--cflags', '--libs'], uselib_store='NDN_CXX')
- USED_BOOST_LIBS = ['system', 'thread', 'log', 'log_setup']
+ boost_libs = ['system', 'program_options']
+ if conf.env.WITH_TESTS:
+ boost_libs.append('unit_test_framework')
- if conf.env['WITH_TESTS']:
- USED_BOOST_LIBS += ['unit_test_framework']
- conf.define('NDN_NAC_HAVE_TESTS', 1)
-
- conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
+ conf.check_boost(lib=boost_libs, mt=True)
conf.check_compiler_flags()
# Loading "late" to prevent tests from being compiled with profiling flags
conf.load('coverage')
-
conf.load('sanitizers')
- conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
-
# If there happens to be a static library, waf will put the corresponding -L flags
# before dynamic library flags. This can result in compilation failure when the
- # system has a different version of the ChronoSync library installed.
- conf.env['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
+ # system has a different version of the ndn-nac library installed.
+ conf.env.prepend_value('STLIBPATH', ['.'])
- conf.write_config_header('config.hpp')
+ conf.define_cond('WITH_TESTS', conf.env.WITH_TESTS)
+ # The config header will contain all defines that were added using conf.define()
+ # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES
+ # will not appear in the config header, but will instead be passed directly to the
+ # compiler on the command line.
+ conf.write_config_header('config.hpp', define_prefix='NAC_')
def build(bld):
version(bld)
@@ -83,12 +81,13 @@
includes=['src', '.'],
export_includes=['src', '.'])
- # Unit tests
- if bld.env['WITH_TESTS']:
+ bld.recurse('tools')
+
+ if bld.env.WITH_TESTS:
bld.recurse('tests')
- bld.recurse('tools')
- bld.recurse('examples')
+ if bld.env.WITH_EXAMPLES:
+ bld.recurse('examples')
bld.install_files(
dest = '%s/ndn-nac' % bld.env['INCLUDEDIR'],