Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_report.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BKE_REPORT_H__
24 #define __BKE_REPORT_H__
25
26 /** \file BKE_report.h
27  *  \ingroup bke
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #include <stdio.h>
35
36 #include "DNA_windowmanager_types.h"
37 #include "BLI_compiler_attrs.h"
38 #include "BLI_utildefines.h"
39
40 /* Reporting Information and Errors
41  *
42  * These functions also accept NULL in case no error reporting
43  * is needed. */
44
45 /* report structures are stored in DNA */
46
47 void BKE_reports_init(ReportList *reports, int flag);
48 void BKE_reports_clear(ReportList *reports);
49
50 void BKE_report(ReportList *reports, ReportType type, const char *message);
51 void BKE_reportf(ReportList *reports, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
52
53 void BKE_reports_prepend(ReportList *reports, const char *prepend);
54 void BKE_reports_prependf(ReportList *reports, const char *prepend, ...) ATTR_PRINTF_FORMAT(2, 3);
55
56 ReportType BKE_report_print_level(ReportList *reports);
57 void BKE_report_print_level_set(ReportList *reports, ReportType level);
58
59 ReportType BKE_report_store_level(ReportList *reports);
60 void BKE_report_store_level_set(ReportList *reports, ReportType level);
61
62 char *BKE_reports_string(ReportList *reports, ReportType level);
63 void BKE_reports_print(ReportList *reports, ReportType level);
64
65 Report *BKE_reports_last_displayable(ReportList *reports);
66
67 bool BKE_reports_contain(ReportList *reports, ReportType level);
68
69 const char *BKE_report_type_str(ReportType type);
70
71 bool BKE_report_write_file_fp(FILE *fp, ReportList *reports, const char *header);
72 bool BKE_report_write_file(const char *filepath, ReportList *reports, const char *header);
73
74 #ifdef __cplusplus
75 }
76 #endif
77         
78 #endif
79