BKE_report.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <cstdio>
 
#include "BLI_compiler_attrs.h"
#include "DNA_windowmanager_types.h"

 
/* Report structures are stored in DNA. */

void BKE_reports_init(ReportList *reports, int flag);
void BKE_reports_free(ReportList *reports);

void BKE_reports_clear(ReportList *reports);

void BKE_reports_move_to_reports(ReportList *reports_dst, ReportList *reports_src);

void BKE_reports_lock(ReportList *reports);
void BKE_reports_unlock(ReportList *reports);
 
void BKE_report(ReportList *reports, eReportType type, const char *message);
void BKE_reportf(ReportList *reports, eReportType type, const char *format, ...)
    ATTR_PRINTF_FORMAT(3, 4);
 
void BKE_reports_prepend(ReportList *reports, const char *prepend);
void BKE_reports_prependf(ReportList *reports, const char *prepend_format, ...)
    ATTR_PRINTF_FORMAT(2, 3);
 
eReportType BKE_report_print_level(ReportList *reports);
void BKE_report_print_level_set(ReportList *reports, eReportType level);
 
eReportType BKE_report_store_level(ReportList *reports);
void BKE_report_store_level_set(ReportList *reports, eReportType level);
 
char *BKE_reports_string(ReportList *reports, eReportType level);

bool BKE_reports_print_test(const ReportList *reports, eReportType type);
void BKE_reports_print(ReportList *reports, eReportType level);
 
Report *BKE_reports_last_displayable(ReportList *reports);
 
bool BKE_reports_contain(ReportList *reports, eReportType level);
 
const char *BKE_report_type_str(eReportType type);
 
bool BKE_report_write_file_fp(FILE *fp, ReportList *reports, const char *header);
bool BKE_report_write_file(const char *filepath, ReportList *reports, const char *header);