Add script for formatting cmake files

The prefered call order is

  tools/cmake-format --trailing-spaces
  # create git commit
  tools/cmake-format --tabs
  # create git commit
  tools/cmake-format --keyword-case
  # create git commit
  tools/cmake-format --keyword-spaces
  # create git commit
  tools/cmake-format --end-args
  # create git commit
  tools/cmake-format --indents
  # create git commit

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Merge branch 'move-cmake-toplevel' into 'master'

Move cmake related build system to top level

See merge request dbus/dbus!84

Reviewed-by: @smcv

cmake: Set working directory to be a native path

If we're cross-compiling for Windows on Unix, CTest needs to chdir() to
the native Unix path.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Add cmake macros add_executable_version_info and add_library_version_info

This helps to reduce duplicated code.

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Remove duplicated cmake variable definition

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Install devhelp2 and api doc with cmake

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Generate documentation html index file from doc/index.html.in for autotools and cmake

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Move cmake related build system to top level

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Merge branch 'cmake-dist' into 'master'

CI: Do the CMake native debug build from an Autotools `make dist`

Closes #255

See merge request dbus/dbus!87

Merge branch 'ax-missing' into 'master'

configure.ac: Forbid AX_-prefixed patterns more selectively

Closes #249

See merge request dbus/dbus!86

Reviewed-by: @pwithnall

Merge branch 'test-bundling' into 'master'

Move some test code from dbus/ and bus/ into test/

Closes #223

See merge request dbus/dbus!1

Reviewed-by: @rhabacker
[smcv: Use ${TEST_DIR} as requested during review]

test: Move _dbus_list_test() here

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move _dbus_transport_unix_test() here

This requires exposing _dbus_connection_get_address() as an internal
symbol, but that seems worth it.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move _dbus_server_test() here

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move _dbus_misc_test() here

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move _dbus_signature_test() here

This is all public API, so there's no need to embed it in the library.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-signature: Move static assertion outside test code

This always needs to be true, even if we're not embedding test goo
in the library. These static assertions have no runtime overhead, only
compile-time, so it's OK to make it unconditional.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move sysdeps tests here

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move string tests (most of dbus-string-util.c) here

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move marshalling tests into test/

dbus-marshal-recursive-util.c contains utility functions used by the
other two, as well as tests. The others are purely test code.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-marshal-*-util: Remove all trailing whitespace

This is in preparation for moving the files: our commit hook would
object to the delete + add otherwise.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move dbus-message-factory and most of dbus-message-util into test/

As with previous moves, I've tried to extract the possible copyright
holders from the git history.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-message-factory: Remove all trailing whitespace

This is in preparation for moving the files: our commit hook would
object to the delete + add otherwise.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move auth, credentials tests from libdbus-internal into test/

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-credentials-util: Remove all trailing whitespace

This is in preparation for moving the file: our commit hook would
object to the delete + add otherwise.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-auth-util: Remove all trailing whitespace

This is in preparation for moving the file: our commit hook would
object to the delete + add otherwise.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-auth-script: Remove all trailing whitespace

This is in preparation for moving the file: our commit hook would
object to the delete + add otherwise.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Unembed hash test from libdbus and move it into test/

This required exposing one additional internal symbol:
_dbus_hash_table_ref(). I think that's a reasonable trade-off for not
compiling this test into the library.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-hash: Attempt to update copyright holders from git history

This is in preparation for splitting the file, tests vs. non-tests.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Split slow parts of the former test-dbus into their own executables

This makes it easier for a developer to run just the fast parts while
debugging some issue reproduced by the faster tests.

Signed-off-by: Simon McVittie <smcv@collabora.com>

_dbus_test_main: Move to test-utils

Now that there is no code outside test/ that calls into this, we can
move it into test/, reducing the size of libdbus.

dbus-test-tap.[ch] still need to stay in dbus/ as long as there is
code in dbus/ or bus/ relying on them, and also need to be linked into
libdbus as long as there is other code in libdbus relying on them,
so they stay where they are for now. Similarly, dbus-tests.h lists
the tests that are still embedded in libdbus, and must stay where
it is for the moment.

With this move, various tests now need to be linked to the dbus-testutils
convenience library.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move dbus-daemon-launch-helper-test here, and rename

The -test suffix does not indicate that this is a test, but rather that
it is for tests (similar to the -unix and -win suffixes on modules like
dbus-sysdeps). This seems unnecessarily confusing, so rename it to end
with -for-tests.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move libdbus embedded tests from dbus/ to test/

This groups them with the rest of the tests, and enables parts of
the test code to be unembedded from libdbus and moved to test/ too.

Rename the executable to test-misc-internals, not test-dbus. The name
test-dbus made some sense as "the executable that contains the code in
dbus/", but makes a lot less sense in test/: dbus is the name of the
entire project, so this test has no particular special claim to that
name. test-libdbus doesn't seem right either, because all the tests
exercise libdbus one way or another.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Break out the slow parts of test-bus into their own executables

This makes it more convenient to re-run the rest of test-bus as
required when debugging.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test: Move dbus-daemon and d-d-launch-helper tests from bus/

This groups them with the other tests, and avoids having them influence
the test coverage stats in bus/.

Signed-off-by: Simon McVittie <smcv@collabora.com>

bus tests: Collect possible copyright holders from git history

This is in preparation to move some of this code into the test/
directory. I've ignored changes that appear to be trivial.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Convert spawn test into a standalone test executable

This test is sufficiently well-separated that there's no real need
to embed it in libdbus. Move it into the test directory instead.

Signed-off-by: Simon McVittie <smcv@collabora.com>

build: Compile most bus/ files into static libraries

This means we can share them between tests without having to compile
the same file repeatedly, and makes them easier to share between
directories when we move test executables into test/.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test-utils: Add copyright and licensing

As far as I can tell, the only significant contributions have been
from Red Hat and Collabora, both of which have given permission to
relicense their parts of the dbus codebase to MIT/X11; so let's go
with that.

I'm assuming here that tree-wide changes from
_DBUS_GNUC_WARN_UNUSED_RESULT to _DBUS_WARN_UNUSED_RESULT, and tree-wide
changes to how we include config.h, are not significant for copyright
purposes.

Signed-off-by: Simon McVittie <smcv@collabora.com>

CI: Do the CMake native debug build from an Autotools `make dist`

We officially release dbus in the form of Autotools `make dist` tarballs,
but people who have downloaded those tarballs should be able to choose
the CMake build system. Our CI should assert that they can.

(The Autotools debug build already does a `make distcheck`, which
asserts that tarball releases can be used for an Autotools build.)

Signed-off-by: Simon McVittie <smcv@collabora.com>
Resolves: dbus#255

configure.ac: Forbid AX_-prefixed patterns more selectively

We want to make autoconf fail early and with a user-comprehensible
message if autoconf-archive isn't installed, rather than generating
a configure script with syntax errors, or a configure script that runs
successfully but doesn't do what we intended.

However, autoconf-archive doesn't actually guarantee not to use
AX_-prefixed shell variable names without m4_pattern_allow'ing them
(unlike Autoconf, Automake, Libtool and pkg-config, which explicitly use
m4_pattern_allow for variables with AC_, AM_, LT_ and PKG_ prefixes), so
it isn't safe to assume that they won't be used. In particular, recent
versions of AX_CHECK_GNU_MAKE appear to be using
$AX_CHECK_GNU_MAKE_HEADLINE as a shell variable.

Instead, specifically forbid the names of the finite list of macros
that we actually use.

Signed-off-by: Simon McVittie <smcv@collabora.com>
Resolves: dbus#249

Merge branch 'fix-ctest-runtime-path-issue' into 'master'

Make sure ctest on Windows uses the currently built dbus library

See merge request dbus/dbus!83

Make sure ctest on Windows uses the currently built dbus library

The ctest application is usually not installed in the dbus build
directory. If an older dbus library is contained in this path, it will
be used instead of the currently built one, which can lead to runtime
errors (e.g.: c0000139) if the internal dbus API differs.

Merge branch 'rename-dbus-socket-set' into 'master'

Rename structure DBusSocketSet to DBusPollableSet and adjust the corresponding functions/files

See merge request dbus/dbus!81

Reviewed-by: Simon McVittie

Rename structure DBusSocketSet to DBusPollableSet and adjust the corresponding functions/files

Because the implementation of DBusSocketSet already supports non-socket
pollables like pipes and inotify fd on Unix, DBusPollableSet is a better
name.

Merge branch 'windows-spawn-cleanup' into 'master'

Windows spawn cleanup

See merge request dbus/dbus!80

Merge branch 'glib-2.38-support' into 'master'

Add glib 2.38 support

See merge request dbus/dbus!79

Reviewed-by: Philip Withnall
Reviewed-by: Simon McVittie

Add glib 2.38 support

dbus-spawn-win.c: Simplify logic of return value from call to _dbus_spawn_program()

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

dbus-spawn-win.c: Return valid error if child could not be spawned

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

dbus-spawn-win.c: Don't wait for babysitter thread to start

Now that we start the spawned program from the main thread, there
is no need to wait for it before dereferencing `sitter->child_handle`.

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

dbus-spawn-win.c: Move out argv copy from DBusSitter struct

Since the child program is started in the main thread, there is no
need to pass a copy of argv to the thread waiting for the child's
termination.

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

dbus-spawn: Don't take ownership of envp

It's unexpected for a function to take ownership of its arguments
without indicating that in its name, or at least documenting it.

The only caller with envp != NULL is in
bus_activation_activate_service(), which has been updated.

Based on part of a larger commit by Ralf Habacker.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-spawn-win: Move _dbus_spawn_program() to main thread

We would like to stop taking ownership of envp, but we can't do that
without a deep copy if a different thread might still be using it
(asynchronously) after the main thread has returned from
_dbus_spawn_async_with_babysitter().

Originally part of a larger commit by Ralf Habacker.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'cmake-custom-install-dirs' into 'master'

In cmake use variables provided from GNUInstallDirs consequently

See merge request dbus/dbus!77

In cmake use variables provided from GNUInstallDirs consequently

This is required to support a custom installation layout, e.g. the
KDE binary factory.

Merge branch 'test-defend-getenv' into 'master'

test-wrappers: Copy strings that might come from getenv()

Closes #240

See merge request dbus/dbus!74

Reviewed-by: Philip Withnall

Merge branch 'test-main-boilerplate' into 'master'

Consolidate boilerplate from embedded tests' main()

See merge request dbus/dbus!73

Reviewed-by: Ralf Habacker

Merge branch 'deprecate-packaged-xml-in-sysconfdir' into 'master'

Deprecate packaged XML policies in ${sysconfdir}

See merge request dbus/dbus!76

Reviewed-by: Tom Gundersen

dbus-daemon(1): Give more comprehensive examples of how to add services

While writing the wording to deprecate XML policy installed by packages
into ${sysconfdir}, I realised we didn't give a typical example of
what packages *should* do.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Officially deprecate package-supplied dbus-daemon policy in ${sysconfdir}

Now that dbus 1.10 has become widely available, we should start to
treat ${sysconfdir} as reserved for the sysadmin, and encourage
third-party software packages to install their integration files into
${datadir}.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch '135-session-test-support-windows' into 'master'

name-test: Run most tests in CMake, via dbus-run-session

See merge request dbus/dbus!23

Fix multi-configuration generator support

Multi-configuration generators (VS, Xcode) append a per-configuration
subdirectory to the specified CMAKE_xxx_OUTPUT_DIRECTORY} directory.

To use the real output paths in test applications, this subdirectory
must be added to the corresponding cmake variables.

Add cmake support for session based test executables

This patch introduces a new cmake macro add_session_test_executable,
which uses dbus-run-session to start a dbus-daemon process with a
temporary session bus in the background and the desired client file.

add_session_test_executable requires additional environment variables
defined in the top level CMakeLists.txt.

Bug: https://gitlab.freedesktop.org/dbus/dbus/issues/135
Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Add cmake support for session based test executables

This patch introduces a new cmake macro add_session_test_executable,
which uses dbus-run-session to start a dbus-daemon process with a
temporary session bus in the background and the desired client file.

add_session_test_executable requires additional environment variables
defined in the top level CMakeLists.txt.

Bug: https://gitlab.freedesktop.org/dbus/dbus/issues/135
Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

Use prefined variables to setup environment in cmake macro add_test_executable

Bug: https://gitlab.freedesktop.org/dbus/dbus/issues/135

Add missing extension to TEST_LAUNCH_HELPER_BINARY in cmake

Fix setup of build time output paths in cmake

Instead of the variables EXECUTABLE_OUTPUT_PATH and
LIBRARY_OUTPUT_PATH, which have become obsolete since
cmake 3.x, CMAKE_xxx_OUTPUT_PATH is now used to define
output paths in the build directory.

test-wrappers: Copy strings that might come from getenv()

It is not safe to assume that the result of getenv() is not invalidated
by a subsequent call to setenv(), and dbus#240 demonstrates that this
can be a problem in practice when running Windows code under Wine.

Closes: https://gitlab.freedesktop.org/dbus/dbus/issues/240
Signed-off-by: Simon McVittie <smcv@collabora.com>

tests: Collect common code from embedded-test main executables

This all seems to have been written by Red Hat or by Collabora, so we
have permission to relicense it under the MIT/X11 license, and we
might as well do so.

Signed-off-by: Simon McVittie <smcv@collabora.com>

bus tests: Skip unsupported fd-passing test internally, not from main()

This results in one less special case in test-main, which will be
significant when we want to make the tests more data-driven.

Signed-off-by: Simon McVittie <smcv@collabora.com>

embedded tests: Time how long each test takes

This will help to split them up into modules that each take a
reasonable time.

Signed-off-by: Simon McVittie <smcv@collabora.com>

embedded tests: Conform to the same API for all tests

This will make it possible to unify the wrapper code that runs them.

I'm using a plain C string rather than a DBusString to make it
more straightforward to carve out tests into their own executables.

Signed-off-by: Simon McVittie <smcv@collabora.com>

dbus-marshal-validate.h: Make self-contained

This header mentions DBusString, so it had better include dbus-string.h.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'copyright-whitespace' into 'master'

trivial: Remove trailing whitespace from copyright notices

See merge request dbus/dbus!75

Reviewed-by: pwithnall

trivial: Remove trailing whitespace from copyright notices

We don't usually mass-remove trailing whitespace from the actual source
code because it would complicate cherry-picking bug fixes to older
branches, but that reasoning doesn't really apply to the comments
containing copyright and licensing notices.

Removing trailing whitespace makes it much easier to move code around:
we have a commit hook that rejects commits containing trailing
whitespace, but that commit hook counts moving a file as a delete + add
pair, so it objects to moving code that contains trailing whitespace.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'remove-threads-init-debug' into 'master'

_dbus_threads_init_debug: Remove

See merge request dbus/dbus!72

_dbus_threads_init_debug: Remove

libdbus has been thread-safe by default since 1.7.6 (2013):
dbus_threads_init_default() is called on a just-in-time basis
whenever needed, and _dbus_thread_init_debug() is equivalent to that.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'gitignore' into 'master'

trivial: Clean up .gitignore files

See merge request dbus/dbus!70

Reviewed-by: pwithnall

.gitignore: Ignore many more generated files

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'reduce-test-refs-run-time' into 'master'

Decrease the runtime of test-refs under Windows

Closes #244

See merge request dbus/dbus!65

.gitignore: Normalize into LC_ALL=C sort order

If lists are in a completely arbitrary order, sorting them consistently
means that there is only one correct place to insert a new entry, avoiding
the merge conflicts that would occur if we always append new entries.

Signed-off-by: Simon McVittie <smcv@collabora.com>

.gitignore: Make match patterns more specific

In subdirectories we mostly only want to match at the current level,
not in nested subdirectories.

Signed-off-by: Simon McVittie <smcv@collabora.com>

valid-config-files-system .gitignore: Don't ignore many-rules.conf

Signed-off-by: Simon McVittie <smcv@collabora.com>

.gitignore: Remove obsolete patterns

Signed-off-by: Simon McVittie <smcv@collabora.com>

.gitignore: Consolidate generic patterns at top level

Patterns in the top-level .gitignore match in all subdirectories, so
there's no need to repeat ourselves quite so much for generic
C, Autotools and gcov patterns.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Top level .gitignore: Sort anchored patterns in LC_ALL=C sort order

If lists are in a completely arbitrary order, sorting them consistently
means that there is only one correct place to insert a new entry, avoiding
the merge conflicts that would occur if we always append new entries.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Top level .gitignore: Group anchored and unanchored patterns

The anchored patterns match only in the top directory; the unanchored
patterns match in any subdirectory. While I'm moving the unanchored
patterns around anyway, sort them in lexicographical (LC_ALL=C sort)
order.

Signed-off-by: Simon McVittie <smcv@collabora.com>

.gitignore: Anchor patterns for files that are only at top level

There shouldn't be an aclocal.m4 in any subdirectory, for instance,
so there's no need to ignore it.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Top level .gitignore: Remove files that now live in build-aux/

We put these in build-aux/ since 15e6b4f5, and we ignore all of
build-aux/, so we don't need to ignore them separately.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'all-helpers-in-test' into 'master'

test-privserver: Move helper executable out of name-test/

See merge request dbus/dbus!67

Increase the number of references/threads to be tested under Windows by default to detect errors

Decrease the runtime of test refs under Windows by default

If the environment variable DBUS_TEST_SLOW is not set or is 0
fewer iterations are performed in test-refs enough to demonstrate
that it works, rather than seriously trying to reproduce race
conditions.

This solves the long runtime that Wine 3.x (4 times longer than
native Windows 7) or Windows 7 as a VirtualBox 5.22 guest (10
times longer) is to be seen.

Fixes #244

test-privserver: Move helper executable out of name-test/

This means we don't need to distinguish between DBUS_NAME_TEST_EXEC and
DBUS_TEST_EXEC any more, because all test helper executables are in the
same place, both during build and when installed (we don't install
test-privserver since no installed test requires it yet, but in
principle we could).

Signed-off-by: Simon McVittie <smcv@collabora.com>

test-privserver: Add copyright and licensing information

I've assumed that trivial changes from Scott James Remnant (correcting
some bus names) and Marcus Brinkmann (adding a <config.h> include
tree-wide) are not significant here. All the other potential copyright
holders from the git log are listed, and all have given permission to
relicense their dbus contributions under the MIT/X11 license.

Signed-off-by: Simon McVittie <smcv@collabora.com>

test-privserver: Remove all trailing whitespace

Otherwise the commit hook would forbid commits that move it to a new
location.

Signed-off-by: Simon McVittie <smcv@collabora.com>

Merge branch 'wip/asan' into 'master'

Add AddressSanitizer and UBSan support

See merge request dbus/dbus!57

Reviewed-by: pwithnall

Merge branch 'basic-value-align' into 'master'

Don't cast user-supplied pointers to DBusBasicValue *

See merge request dbus/dbus!69

Reviewed-by: thiago

ci: Apply AddressSanitizer to Linux "debug" builds

Signed-off-by: Simon McVittie <smcv@collabora.com>

build: Add a way to set CFLAGS for AddressSanitizer etc.

We don't want to set these globally via the normal CFLAGS, because if
we did, AddressSanitizer would catch test-segfault deliberately
segfaulting, and "helpfully" turn it into exit status 1, which in turn
makes our test fail because it asserts that the segfault is reported
as a segfault.

A typical use with gcc as compiler, on a reasonably recent Debian,
would be:

    ./configure SANITIZE_CFLAGS="-fsanitize=address -fsanitize=undefined -fPIE -pie"

Signed-off-by: Simon McVittie <smcv@collabora.com>