File: Error.h

package info (click to toggle)
pcsx2 2.6.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 89,232 kB
  • sloc: cpp: 386,254; ansic: 79,847; python: 1,216; perl: 391; javascript: 92; sh: 85; asm: 58; makefile: 20; xml: 13
file content (105 lines) | stat: -rw-r--r-- 3,046 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// SPDX-FileCopyrightText: 2002-2025 PCSX2 Dev Team
// SPDX-License-Identifier: GPL-3.0+

#pragma once

#include "Pcsx2Defs.h"

#include "fmt/format.h"

#include <string>

class Error
{
public:
	Error();
	Error(const Error& e);
	Error(Error&& e);
	~Error();

	enum class Type
	{
		None = 0,
		Errno = 1,
		Socket = 2,
		User = 3,
		Win32 = 4,
		HResult = 5,
	};

	__fi Type GetType() const { return m_type; }
	__fi bool IsValid() const { return (m_type != Type::None); }
	__fi const std::string& GetDescription() const { return m_description; }

	void Clear();

	/// Error that is set by system functions, such as open().
	void SetErrno(int err);
	void SetErrno(std::string_view prefix, int err);

	/// Error that is set by socket functions, such as socket(). On Unix this is the same as errno.
	void SetSocket(int err);
	void SetSocket(std::string_view prefix, int err);

	/// Set both description and message.
	void SetString(std::string description);
	void SetStringView(std::string_view description);

#ifdef _WIN32
	/// Error that is returned by some Win32 functions, such as RegOpenKeyEx. Also used by other APIs through
	/// GetLastError().
	void SetWin32(unsigned long err);
	void SetWin32(std::string_view prefix, unsigned long err);

	/// Error that is returned by Win32 COM methods, e.g. S_OK.
	void SetHResult(long err);
	void SetHResult(std::string_view prefix, long err);
#endif

	static Error CreateNone();
	static Error CreateErrno(int err);
	static Error CreateSocket(int err);
	static Error CreateString(std::string description);
#ifdef _WIN32
	static Error CreateWin32(unsigned long err);
	static Error CreateHResult(long err);
#endif

	// helpers for setting
	static void Clear(Error* errptr);
	static void SetErrno(Error* errptr, int err);
	static void SetErrno(Error* errptr, std::string_view prefix, int err);
	static void SetSocket(Error* errptr, int err);
	static void SetSocket(Error* errptr, std::string_view prefix, int err);
	static void SetString(Error* errptr, std::string description);
	static void SetStringView(Error* errptr, std::string_view description);

#ifdef _WIN32
	static void SetWin32(Error* errptr, unsigned long err);
	static void SetWin32(Error* errptr, std::string_view prefix, unsigned long err);
	static void SetHResult(Error* errptr, long err);
	static void SetHResult(Error* errptr, std::string_view prefix, long err);
#endif

	/// Sets a formatted message.
	template <typename... T>
	static void SetStringFmt(Error* errptr, fmt::format_string<T...> fmt, T&&... args)
	{
		if (errptr)
			Error::SetString(errptr, fmt::vformat(fmt, fmt::make_format_args(args...)));
	}

	void AddPrefix(std::string_view prefix);
	void AddSuffix(std::string_view suffix);
	static void AddPrefix(Error* errptr, std::string_view prefix);
	static void AddSuffix(Error* errptr, std::string_view prefix);

	Error& operator=(const Error& e);
	Error& operator=(Error&& e);
	bool operator==(const Error& e) const;
	bool operator!=(const Error& e) const;

private:
	Type m_type = Type::None;
	std::string m_description;
};