Enable build of libconf/nutconf features by default

NEWS.adoc

@@ -191,7 +191,15 @@ https://github.com/networkupstools/nut/milestone/10
  - Eaton contributed recipes and scripts used to create the IPP for Unix bundle
    (UPS software companion), delivering NUT packages with an interactive
    installer and some system integration scripts (events, notifications,
-   status, shutdown daemon...) [#2288]
+   status, shutdown daemon...) -- provided "as is" at the moment, and may
+   later serve as foundation or inspiration for new NUT features. [#2288]
+
+ - nutconf (C++ library and tool to read and manage NUT configuration files)
+   was started in the open by Eaton employees and used in the IPP installer,
+   but the code lingered in a side branch. It was now brushed up to our common
+   best practices and added to the main codebase. As of this import, there are
+   known deficiencies in Windows platform support, as well as some un-awareness
+   about configuration key words which appeared in NUT since 2013. [#2290]
 
 
 Release notes for NUT 2.8.1 - what's new since 2.8.0

appveyor.yml

@@ -91,7 +91,7 @@ test_script:
         REM Start a 64 bit Mingw environment:
         set MSYSTEM=MINGW64
         REM Start Mingw-based integration and unit checks:
-        C:\msys64\usr\bin\bash -lc 'date -u; PATH="/mingw64/bin:$PATH" make -s check'
+        C:\msys64\usr\bin\bash -lc 'date -u; NUT_STATEPATH="C:\\Users\\appveyor\\AppData\\Local\\Temp\\nut-test"; mkdir -p "${NUT_STATEPATH}"; export NUT_STATEPATH; PATH="/mingw64/bin:$PATH" make -s check || bash -lc "for F in tests/*.log tests/*.trs ; do echo \"===---=== $F :\"; cat \"$F\"; done; exit 1;" '
         REM Start a Mingw-based documentation spellcheck:
         C:\msys64\usr\bin\bash -lc 'date -u; PATH="/mingw64/bin:$PATH" make -s -j 4 spellcheck'
 

ci_build.sh

@@ -296,6 +296,18 @@ for L in $NODE_LABELS ; do
         "NUT_BUILD_CAPS=cppunit"|"NUT_BUILD_CAPS=cppunit=yes")
             [ -n "$CANBUILD_CPPUNIT_TESTS" ] || CANBUILD_CPPUNIT_TESTS=yes ;;
 
+        # This should cover both the --with-nutconf tool setting
+        # and the cppunit tests for it (if active per above).
+        # By default we would nowadays guess (requires C++11).
+        "NUT_BUILD_CAPS=nutconf=no")
+            [ -n "$CANBUILD_NUTCONF" ] || CANBUILD_NUTCONF=no ;;
+        "NUT_BUILD_CAPS=nutconf=no-gcc")
+            [ -n "$CANBUILD_NUTCONF" ] || CANBUILD_NUTCONF=no-gcc ;;
+        "NUT_BUILD_CAPS=nutconf=no-clang")
+            [ -n "$CANBUILD_NUTCONF" ] || CANBUILD_NUTCONF=no-clang ;;
+        "NUT_BUILD_CAPS=nutconf"|"NUT_BUILD_CAPS=nutconf=yes")
+            [ -n "$CANBUILD_NUTCONF" ] || CANBUILD_NUTCONF=yes ;;
+
         # Some (QEMU) builders have issues running valgrind as a tool
         "NUT_BUILD_CAPS=valgrind=no")
             [ -n "$CANBUILD_VALGRIND_TESTS" ] || CANBUILD_VALGRIND_TESTS=no ;;
@@ -1063,6 +1075,40 @@ default|default-alldrv|default-alldrv:no-distcheck|default-all-errors|default-sp
         CONFIG_OPTS+=("--enable-cppunit=no")
     fi
 
+    if ( [ "${CANBUILD_NUTCONF-}" = "no-gcc" ] && [ "$COMPILER_FAMILY" = "GCC" ] ) \
+    || ( [ "${CANBUILD_NUTCONF-}" = "no-clang" ] && [ "$COMPILER_FAMILY" = "CLANG" ] ) \
+    ; then
+        CANBUILD_NUTCONF=no
+    fi
+
+    case "${CANBUILD_NUTCONF-}" in
+        yes)
+            # Depends on C++11 or newer, so let configure script try this tediously
+            # unless we know we would not build for the too-old language revision
+            case "${CXXFLAGS-}" in
+                *-std=c++98*|*-std=gnu++98*|*-std=c++03*|*-std=gnu++03*)
+                    echo "WARNING: Build agent says it can build nutconf, but requires a test with C++ revision too old - so not requiring the experimental feature (auto-try)" >&2
+                    CONFIG_OPTS+=("--with-nutconf=auto")
+                    ;;
+                *-std=c++0x*|*-std=gnu++0x*|*-std=c++1*|*-std=gnu++1*|*-std=c++2*|*-std=gnu++2*)
+                    echo "WARNING: Build agent says it can build nutconf, and requires a test with a sufficiently new C++ revision - so requiring the experimental feature" >&2
+                    CONFIG_OPTS+=("--with-nutconf=yes")
+                    ;;
+                *)
+                    echo "WARNING: Build agent says it can build nutconf, and does not specify a test with prticular C++ revision - so not requiring the experimental feature (auto-try)" >&2
+                    CONFIG_OPTS+=("--with-nutconf=auto")
+                    ;;
+            esac
+            ;;
+        no)
+            echo "WARNING: Build agent says it can not build nutconf, disabling the feature (do not even try)" >&2
+            CONFIG_OPTS+=("--with-nutconf=no")
+            ;;
+        "")
+            CONFIG_OPTS+=("--with-nutconf=auto")
+            ;;
+    esac
+
     if [ "${CANBUILD_VALGRIND_TESTS-}" = no ] ; then
         echo "WARNING: Build agent says it has a broken valgrind, adding configure option to skip tests with it" >&2
         CONFIG_OPTS+=("--with-valgrind=no")

common/Makefile.am

@@ -9,13 +9,22 @@
 @NUT_AM_MAKE_CAN_EXPORT@export CCACHE_PATH=@CCACHE_PATH@
 @NUT_AM_MAKE_CAN_EXPORT@export PATH=@PATH_DURING_CONFIGURE@
 
-AM_CFLAGS = -I$(top_srcdir)/include
+AM_CFLAGS = -I$(top_builddir)/include -I$(top_srcdir)/include
+AM_CXXFLAGS = -I$(top_builddir)/include -I$(top_srcdir)/include
 AM_LDFLAGS = -no-undefined
 EXTRA_DIST =
 
 noinst_LTLIBRARIES = libparseconf.la libcommon.la libcommonclient.la
+if WITH_NUTCONF
+# We define the recipe below in any case, but only activate it by default
+# if the build configuration tells us to:
+noinst_LTLIBRARIES += libnutconf.la
+endif
+
 libparseconf_la_SOURCES = parseconf.c
 
+libnutconf_la_SOURCES = nutconf.cpp nutstream.cpp nutwriter.cpp nutipc.cpp
+
 # do not hard depend on '../include/nut_version.h', since it blocks
 # 'dist', and is only required for actual build, in which case
 # BUILT_SOURCES (in ../include) will ensure nut_version.h will
@@ -75,7 +84,7 @@ endif
 if HAVE_WINDOWS
 libcommon_la_SOURCES += wincompat.c $(top_srcdir)/include/wincompat.h
 libcommonclient_la_SOURCES += wincompat.c $(top_srcdir)/include/wincompat.h
-endif
+endif HAVE_WINDOWS
 
 # ensure inclusion of local implementation of missing systems functions
 # using LTLIBOBJS. Refer to configure.in/.ac -> AC_REPLACE_FUNCS
@@ -85,6 +94,11 @@ libcommonclient_la_LIBADD = libparseconf.la @LTLIBOBJS@ @NETLIBS@
 libcommon_la_CFLAGS = $(AM_CFLAGS)
 libcommonclient_la_CFLAGS = $(AM_CFLAGS)
 
+if WITH_NUTCONF
+libnutconf_la_CXXFLAGS = $(AM_CXXFLAGS)
+libnutconf_la_LIBADD = @LTLIBOBJS@ @NETLIBS@ libcommonclient.la
+endif WITH_NUTCONF
+
 if HAVE_LIBREGEX
   libcommon_la_CFLAGS += $(LIBREGEX_CFLAGS)
   libcommon_la_LIBADD += $(LIBREGEX_LIBS)