summaryrefslogtreecommitdiff
path: root/src/util/safe_print.h
diff options
context:
space:
mode:
authorAina Niemetz <aina.niemetz@gmail.com>2021-04-12 12:31:43 -0700
committerGitHub <noreply@github.com>2021-04-12 19:31:43 +0000
commit7ec30058750611786b1b597816c8a23e28bb5812 (patch)
treee59b1de0078dc04d3a9c212cf9e6ebfd70cbb7f4 /src/util/safe_print.h
parent7361b587e9a1b717dfa906d02f66feb6896e80dd (diff)
Refactor and update copyright headers. (#6316)
Diffstat (limited to 'src/util/safe_print.h')
-rw-r--r--src/util/safe_print.h67
1 files changed, 34 insertions, 33 deletions
diff --git a/src/util/safe_print.h b/src/util/safe_print.h
index 92eaaaeff..51e6745c7 100644
--- a/src/util/safe_print.h
+++ b/src/util/safe_print.h
@@ -1,36 +1,37 @@
-/********************* */
-/*! \file safe_print.h
- ** \verbatim
- ** Top contributors (to current version):
- ** Andres Noetzli, Mathias Preiner
- ** This file is part of the CVC4 project.
- ** Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
- ** in the top-level source directory and their institutional affiliations.
- ** All rights reserved. See the file COPYING in the top-level source
- ** directory for licensing information.\endverbatim
- **
- ** \brief Print functions that are safe to use in a signal handler.
- **
- ** Signal handlers only allow a very limited set of operations, e.g. dynamic
- ** memory allocation is not possible. This set of functions can be used to
- ** print information from a signal handler.
- **
- ** The safe_print function takes a template parameter T and prints an argument
- ** of type const T& to avoid copying, e.g. when printing std::strings. For
- ** consistency, we also pass primitive types by reference (otherwise, functions
- ** in statistics_registry.h would require specialization or we would have to
- ** use function overloading).
- **
- ** If there exists a function `toString(obj)` for a given object, it will be
- ** used automatically. This is useful for printing enum values for example.
- ** IMPORTANT: The `toString(obj)` function *must not* perform any allocations
- ** or call other functions that are not async-signal-safe.
- **
- ** This header is a "cvc4_private_library.h" header because it is private but
- ** the safe_print functions are used in the driver. See also the description
- ** of "statistics_registry.h" for more information on
- ** "cvc4_private_library.h".
- **/
+/******************************************************************************
+ * Top contributors (to current version):
+ * Andres Noetzli, Mathias Preiner
+ *
+ * This file is part of the cvc5 project.
+ *
+ * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
+ * in the top-level source directory and their institutional affiliations.
+ * All rights reserved. See the file COPYING in the top-level source
+ * directory for licensing information.
+ * ****************************************************************************
+ *
+ * Print functions that are safe to use in a signal handler.
+ *
+ * Signal handlers only allow a very limited set of operations, e.g. dynamic
+ * memory allocation is not possible. This set of functions can be used to
+ * print information from a signal handler.
+ *
+ * The safe_print function takes a template parameter T and prints an argument
+ * of type const T& to avoid copying, e.g. when printing std::strings. For
+ * consistency, we also pass primitive types by reference (otherwise, functions
+ * in statistics_registry.h would require specialization or we would have to
+ * use function overloading).
+ *
+ * If there exists a function `toString(obj)` for a given object, it will be
+ * used automatically. This is useful for printing enum values for example.
+ * IMPORTANT: The `toString(obj)` function *must not* perform any allocations
+ * or call other functions that are not async-signal-safe.
+ *
+ * This header is a "cvc4_private_library.h" header because it is private but
+ * the safe_print functions are used in the driver. See also the description
+ * of "statistics_registry.h" for more information on
+ * "cvc4_private_library.h".
+ */
#include "cvc4_private_library.h"
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback