aboutsummaryrefslogtreecommitdiffstats
path: root/longbow/src/LongBow/Reporting/ANSITerm/longBowReport_Runtime.h
blob: 2e03f322bb3ec6d5e4980c19450fa461a082690a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file ANSITerm/longBowReport_Runtime.h
 * @ingroup reporting
 * @brief ANSI Terminal Reporting
 *
 */
#ifndef LongBow_longBowReport_ANSITerm_Runtime_h
#define LongBow_longBowReport_ANSITerm_Runtime_h

#include <stdio.h>
#include <stdarg.h>

#include <LongBow/Reporting/longBowReport_Runtime.h>

/**
 * Begin printing in red.
 *
 */
void longBowReportRuntime_PrintRed(void);

/**
 * Print the formatted string in red.
 *
 */
void longBowReportRuntime_RedPrintf(const char *format, ...);

/**
 * Print the formatted string in green.
 *
 */
void longBowReportRuntime_GreenPrintf(const char *format, ...);

/**
 * Print the formatted string in yellow.
 *
 */
void longBowReportRuntime_YellowPrintf(const char *format, ...);

/**
 * Print the formatted string in magenta.
 *
 */
void longBowReportRuntime_MagentaPrintf(const char *format, ...);

/**
 * Parse the given key and set the corresponding LongBowReportConfig to suppress reports.
 *
 * @param [in] config A valid LongBowReportConfig instance.
 * @param [in] key A nul-terminated C string consisting of one or more of the characters, X.SWstwFTU
 */
void longBowReportRuntime_ParseSuppress(LongBowReportConfig *config, const char *key);
#endif // LongBow_longBowReport_ANSITerm_Runtime_h