2.5: Change blenloader module to use the Report system for reporting errors.
[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 typedef enum ReportType {
40         RPT_DEBUG                                       = 0,
41         RPT_INFO                                        = 1000,
42         RPT_WARNING                                     = 2000,
43         RPT_ERROR                                       = 3000,
44         RPT_ERROR_INVALID_INPUT         = 3001,
45         RPT_ERROR_INVALID_CONTEXT       = 3002,
46         RPT_ERROR_OUT_OF_MEMORY         = 3003
47 } ReportType;
48
49 enum ReportListFlags {
50         RPT_PRINT = 1,
51         RPT_STORE = 2,
52         RPT_HAS_ERROR = 4
53 };
54
55 typedef struct Report {
56         struct Report *next, *prev;
57         ReportType type;
58         char *typestr;
59         char *message;
60 } Report;
61
62 typedef struct ReportList {
63         ListBase list;
64         ReportType printlevel;
65         ReportType storelevel;
66         int flag;
67 } ReportList;
68
69 void BKE_reports_init(ReportList *reports, int flag);
70 void BKE_reports_clear(ReportList *reports);
71
72 void BKE_report(ReportList *reports, ReportType type, const char *message);
73 void BKE_reportf(ReportList *reports, ReportType type, const char *format, ...);
74
75 ReportType BKE_report_print_level(ReportList *reports);
76 void BKE_report_print_level_set(ReportList *reports, ReportType level);
77
78 ReportType BKE_report_store_level(ReportList *reports);
79 void BKE_report_store_level_set(ReportList *reports, ReportType level);
80
81 void BKE_reports_print(ReportList *reports, ReportType level);
82
83 #ifdef __cplusplus
84 }
85 #endif
86         
87 #endif
88