include/rtems/test-printer.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSTest
0007  *
0008  * @brief This header file provides interfaces of the RTEMS Test Support.
0009  */
0010
0011 /*
0012  * Copyright (C) 2014, 2023 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef _RTEMS_TEST_PRINTER_H
0037 #define _RTEMS_TEST_PRINTER_H
0038
0039 #include <rtems/printer.h>
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 /**
0046  * @addtogroup RTEMSTest
0047  *
0048  * @{
0049  */
0050
0051 /**
0052  * @brief Provides an RTEMS printer for tests.
0053  */
0054 extern rtems_printer rtems_test_printer;
0055
0056 /**
0057  * @brief Prints via the RTEMS test printer.
0058  *
0059  * @return Returns the count of output characters as specified by printf().
0060  */
0061 int rtems_test_printf( const char *format, ... ) RTEMS_PRINTFLIKE( 1, 2 );
0062
0063 /** @} */
0064
0065 #ifdef __cplusplus
0066 }
0067 #endif /* __cplusplus */
0068
0069 #endif /* _RTEMS_TEST_PRINTER_H */