E.14 exception type examples for #1852 (#1857)

* E.14

* clean-up

* add final

* Added words to dictionary

* cleanup

* fix typo

* Update CppCoreGuidelines.md
This commit is contained in:
bgloyer 2022-01-27 13:10:34 -08:00 committed by GitHub
parent 369beb8a0c
commit 43f2e34148
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 56 deletions

View File

@ -15992,80 +15992,56 @@ Sometimes, [`finally()`](#Re-finally) can make such unsystematic cleanup a bit m
##### Reason
A user-defined type is unlikely to clash with other people's exceptions.
A user-defined type can better transmit information about an error to a handler. Information
can be encoded into the type itself and the type is unlikely to clash with other people's exceptions.
##### Example
void my_code()
throw 7; // bad
throw "something bad"; // bad
throw std::exception{}; // bad - no info
Deriving from `std::exception` gives the flexibility to catch the specific exception or handle generally through `std::exception`:
class MyException : public std::runtime_error
{
public:
MyException(const string& msg) : std::runtime_error{msg} {}
// ...
throw Moonphase_error{};
// ...
}
};
void your_code()
{
try {
// ...
my_code();
// ...
}
catch(const Bufferpool_exhausted&) {
// ...
}
}
// ...
##### Example, don't
throw MyException{"something bad"}; // good
void my_code() // Don't
{
// ...
throw 7; // 7 means "moon in the 4th quarter"
// ...
}
Exceptions do not need to be derived from `std::exception`:
void your_code() // Don't
{
try {
// ...
my_code();
// ...
}
catch(int i) { // i == 7 means "input buffer too small"
// ...
}
}
class MyCustomError final {}; // not derived from std::exception
##### Note
// ...
The standard-library classes derived from `exception` should be used only as base classes or for exceptions that require only "generic" handling. Like built-in types, their use could clash with other people's use of them.
throw MyCustomError{}; // good - handlers must catch this type (or ...)
##### Example, don't
Library types derived from `std::exception` can be used as generic exceptions if
no useful information can be added at the point of detection:
void my_code() // Don't
{
// ...
throw runtime_error{"moon in the 4th quarter"};
// ...
}
throw std::runtime_error("someting bad"); // good
void your_code() // Don't
{
try {
// ...
my_code();
// ...
}
catch(const runtime_error&) { // runtime_error means "input buffer too small"
// ...
}
}
// ...
throw std::invalid_argument("i is not even"); // good
**See also**: [Discussion](#Sd-???)
`enum` classes are also allowed:
enum class alert {RED, YELLOW, GREEN};
throw alert::RED; // good
##### Enforcement
Catch `throw` and `catch` of a built-in type. Maybe warn about `throw` and `catch` using a standard-library `exception` type. Obviously, exceptions derived from the `std::exception` hierarchy are fine.
Catch `throw` of built-in types and `std::exception`.
### <a name="Re-exception-ref"></a>E.15: Throw by value, catch exceptions from a hierarchy by reference

View File

@ -343,6 +343,8 @@ Murray93
mutex
mutexes
mx
MyCustomError
MyException
myMap
MyMap
myset