Console Space Type
[blender.git] / source / blender / blenkernel / BKE_report.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation (2008).
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_REPORT_H
29 #define BKE_REPORT_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "DNA_listBase.h"
36
37 /* Reporting Information and Errors
38  *
39  * These functions also accept NULL in case no error reporting
40  * is needed. */
41
42 typedef enum ReportType {
43         RPT_DEBUG                                       = 1<<0,
44         RPT_INFO                                        = 1<<1,
45         RPT_OPERATOR                            = 1<<2,
46         RPT_WARNING                                     = 1<<3,
47         RPT_ERROR                                       = 1<<4,
48         RPT_ERROR_INVALID_INPUT         = 1<<5,
49         RPT_ERROR_INVALID_CONTEXT       = 1<<6,
50         RPT_ERROR_OUT_OF_MEMORY         = 1<<7
51 } ReportType;
52
53 #define RPT_DEBUG_ALL           (RPT_DEBUG)
54 #define RPT_INFO_ALL            (RPT_INFO)
55 #define RPT_OPERATOR_ALL        (RPT_OPERATOR)
56 #define RPT_WARNING_ALL         (RPT_WARNING)
57 #define RPT_ERROR_ALL           (RPT_ERROR|RPT_ERROR_INVALID_INPUT|RPT_ERROR_INVALID_CONTEXT|RPT_ERROR_OUT_OF_MEMORY)
58
59 enum ReportListFlags {
60         RPT_PRINT = 1,
61         RPT_STORE = 2,
62 };
63
64 typedef struct Report {
65         struct Report *next, *prev;
66         ReportType type;
67         char *typestr;
68         char *message;
69 } Report;
70
71 typedef struct ReportList {
72         ListBase list;
73         ReportType printlevel;
74         ReportType storelevel;
75         int flag;
76 } ReportList;
77
78 void BKE_reports_init(ReportList *reports, int flag);
79 void BKE_reports_clear(ReportList *reports);
80
81 void BKE_report(ReportList *reports, ReportType type, const char *message);
82 void BKE_reportf(ReportList *reports, ReportType type, const char *format, ...);
83
84 void BKE_reports_prepend(ReportList *reports, const char *prepend);
85 void BKE_reports_prependf(ReportList *reports, const char *prepend, ...);
86
87 ReportType BKE_report_print_level(ReportList *reports);
88 void BKE_report_print_level_set(ReportList *reports, ReportType level);
89
90 ReportType BKE_report_store_level(ReportList *reports);
91 void BKE_report_store_level_set(ReportList *reports, ReportType level);
92
93 char *BKE_reports_string(ReportList *reports, ReportType level);
94 void BKE_reports_print(ReportList *reports, ReportType level);
95
96 #ifdef __cplusplus
97 }
98 #endif
99         
100 #endif
101