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 "BLI_mutex.hh"
#include "BLI_utildefines.h"
 
#include "DNA_listBase.h"
 
struct wmTimer;
 
struct CLG_LogRef;


enum eReportType : uint16_t {
  RPT_DEBUG = (1 << 0),
  RPT_INFO = (1 << 1),
  RPT_OPERATOR = (1 << 2),
  RPT_PROPERTY = (1 << 3),
  RPT_WARNING = (1 << 4),
  RPT_ERROR = (1 << 5),
  RPT_ERROR_INVALID_INPUT = (1 << 6),
  RPT_ERROR_INVALID_CONTEXT = (1 << 7),
  RPT_ERROR_OUT_OF_MEMORY = (1 << 8),
};
ENUM_OPERATORS(eReportType, RPT_ERROR_OUT_OF_MEMORY)
 
#define RPT_DEBUG_ALL (RPT_DEBUG)
#define RPT_INFO_ALL (RPT_INFO)
#define RPT_OPERATOR_ALL (RPT_OPERATOR)
#define RPT_PROPERTY_ALL (RPT_PROPERTY)
#define RPT_WARNING_ALL (RPT_WARNING)
#define RPT_ERROR_ALL \
  (RPT_ERROR | RPT_ERROR_INVALID_INPUT | RPT_ERROR_INVALID_CONTEXT | RPT_ERROR_OUT_OF_MEMORY)
 
enum ReportListFlags {
  RPT_PRINT = (1 << 0),
  RPT_STORE = (1 << 1),
  RPT_FREE = (1 << 2),
  RPT_OP_HOLD = (1 << 3), /* don't move them into the operator global list (caller will use) */
  RPT_PRINT_HANDLED_BY_OWNER = (1 << 4),
};
 
struct Report {
  Report *next, *prev;
  short type;
  short flag;
  int len;
  const char *typestr;
  const char *message;
};
 
struct ReportList {
  ListBase list;
  int printlevel;
  int storelevel;
  int flag;
  char _pad[4];
  wmTimer *reporttimer;

  std::mutex *lock;
};
 
/* 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);
 
void BKE_report_log(eReportType type, const char *message, CLG_LogRef *log);
void BKE_reports_log(ReportList *reports, eReportType level, CLG_LogRef *log);
 
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);