// Copyright (c) 2020 Lv Decai, Shenzhen, China.
// Filename: MiniDumper.h
// Version: 1.0
// Release date: 2020年10月11日
// License: MIT (http://opensource.org/licenses/MIT)

#pragma once

#include <DbgHelp.h>
#include "../CommonCpp.h"

struct _EXCEPTION_POINTERS;

NAMESPACE_BEGIN;

// 程序崩溃内存信息转储类
class COMMON_API CMiniDumper
{
public:
	// 配置类
	class CConfig
	{
	public:
		// 转储类型,参见 enum _MINIDUMP_TYPE
		int DumpType = MiniDumpNormal;

		// 应用程序名,用作显示提示信息的提示窗口标题,以及崩溃信息转储文件的名称
		TCHAR AppName[MAX_PATH] = { 0 };

		// 是否把进程的模块信息写入文件
		BOOL DumpModuleInfo = FALSE;

		// 是否显示错误提示信息
		BOOL ShowError = FALSE;

		// 发生错误时回调的函数,可用于记录日志或显示提示信息
		void (*OnError)(PCTSTR sErrorMessage) = NULL;

		// 发生崩溃的回调的函数,可用于显示提示信息或重启进程
		void (*OnCrush)() = NULL;
	};

	// 启用崩溃内存信息转储
	static void Enable(
		// 转储类型,参见 enum _MINIDUMP_TYPE
		int iDumpType = MiniDumpNormal,
		// 应用程序名,用作显示提示信息的提示窗口标题,以及崩溃信息转储文件的名称,未设置应用程序名时自动使用可执行文件名
		PCTSTR sAppName = NULL,
		// 是否显示错误提示信息
		BOOL bShowError = FALSE);

	// 启用崩溃内存信息转储
	// 未设置应用程序名时自动使用可执行文件名
	static void Enable(
		// 程序崩溃内存信息转储配置
		const CConfig& Config);

	// 创建内存信息转储文件
	// 未发生异常时也可以调用该函数创建内存信息转储文件
	// 返回值:错误信息,空字符串表示操作成功
	static CString CreateDumpFile(
		// 转储类型,参见 enum _MINIDUMP_TYPE
		MINIDUMP_TYPE iDumpType,
		// 异常信息,空指针表示无异常
		_EXCEPTION_POINTERS* pExceptionInfo);

	// 改名备份已存在的内存信息转储文件
	static void BackupDumpFile();

	// 把进程的模块信息保存到文件中
	static BOOL DumpModuleInfo(PCTSTR sFilePath);

private:
	// 程序崩溃内存信息转储配置
	static CConfig m_Config;

	// 异常处理函数
	static LONG WINAPI TopLevelFilter(_EXCEPTION_POINTERS* pExceptionInfo);

	// 获取转储文件路径
	static CString GetDumpFilePath();

	// 显示错误提示信息
	static int ShowError(PCTSTR sErrorMessage, UINT iType);
};

NAMESPACE_END;