Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
run_tests.h
Go to the documentation of this file.
1 /*==============================================================================
2  run_tests.h -- test aggregator and results reporting
3 
4  Copyright (c) 2018-2019, Laurence Lundblade. All rights reserved.
5 
6  SPDX-License-Identifier: BSD-3-Clause
7 
8  See BSD-3-Clause license in README.md
9 
10  Created 9/30/18
11  ==============================================================================*/
12 
13 /**
14  @file run_tests.h
15 */
16 
17 /**
18  @brief Type for function to output a text string
19 
20  @param[in] szString The string to output
21  @param[in] pOutCtx A context pointer; NULL if not needed
22  @param[in] bNewline If non-zero, output a newline after the string
23 
24  This is a prototype of a function to be passed to RunTests() to
25  output text strings.
26 
27  This can be implemented with stdio (if available) using a straight
28  call to fputs() where the FILE * is passed as the pOutCtx as shown in
29  the example code below. This code is for Linux where the newline is
30  a \\n. Windows usually prefers \\r\\n.
31 
32  @code
33  static void fputs_wrapper(const char *szString, void *pOutCtx, int bNewLine)
34  {
35  fputs(szString, (FILE *)pOutCtx);
36  if(bNewLine) {
37  fputs("\n", pOutCtx);
38  }
39  }
40  @endcode
41 */
42 typedef void (*OutputStringCB)(const char *szString, void *pOutCtx, int bNewline);
43 
44 
45 /**
46  @brief Runs the QCBOR tests.
47 
48  @param[in] szTestNames An argv-style list of test names to run. If
49  empty, all are run.
50  @param[in] pfOutput Function that is called to output text strings.
51  @param[in] pOutCtx Context pointer passed to output function.
52  @param[out] pNumTestsRun Returns the number of tests run. May be NULL.
53 
54  @return The number of tests that failed. Zero means overall success.
55  */
56 int RunTests(const char *szTestNames[], OutputStringCB pfOutput, void *pOutCtx, int *pNumTestsRun);
57 
58 
59 /**
60  @brief Print sizes of encoder / decoder contexts.
61 
62  @param[in] pfOutput Function that is called to output text strings.
63  @param[in] pOutCtx Context pointer passed to output function.
64  */
65 void PrintSizes(OutputStringCB pfOutput, void *pOutCtx);
RunTests
int RunTests(const char *szTestNames[], OutputStringCB pfOutput, void *pOutCtx, int *pNumTestsRun)
Runs the QCBOR tests.
OutputStringCB
void(* OutputStringCB)(const char *szString, void *pOutCtx, int bNewline)
Type for function to output a text string.
Definition: run_tests.h:42
PrintSizes
void PrintSizes(OutputStringCB pfOutput, void *pOutCtx)
Print sizes of encoder / decoder contexts.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.