mirror of
https://github.com/WerWolv/ImHex-Patterns.git
synced 2026-04-02 13:37:41 -05:00
includes/std: Added first set of documentation to the std library
This commit is contained in:
@@ -2,14 +2,28 @@
|
||||
|
||||
#include <std/io.pat>
|
||||
|
||||
/*!
|
||||
Basic helper functions
|
||||
*/
|
||||
|
||||
namespace std {
|
||||
|
||||
/**
|
||||
Asserts that a given value is true. If it's not, abort evaluation and print the given message to the console
|
||||
@param conditoon The condition that is required to be true
|
||||
@param message The message to print in case the assertion doesn't hold
|
||||
*/
|
||||
fn assert(bool condition, str message) {
|
||||
if (!condition) {
|
||||
std::error(std::format("assertion failed '{0}'", message));
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
Asserts that a given value is true. If it's not, print the given message to the console as a warning
|
||||
@param conditoon The condition that is required to be true
|
||||
@param message The message to print in case the assertion doesn't hold
|
||||
*/
|
||||
fn assert_warn(bool condition, str message) {
|
||||
if (!condition) {
|
||||
std::warning(std::format("assertion failed '{0}'", message));
|
||||
@@ -17,10 +31,20 @@ namespace std {
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
Queries the value of a set environment variable given it's name
|
||||
@param name The name of the env variable
|
||||
@return The value of that variable
|
||||
*/
|
||||
fn env(str name) {
|
||||
return builtin::std::env(name);
|
||||
};
|
||||
|
||||
/**
|
||||
Returns the number of parameters in a parameter pack.
|
||||
@param pack The pack to check
|
||||
@return Number of parameters in `pack`
|
||||
*/
|
||||
fn sizeof_pack(auto ... pack) {
|
||||
return builtin::std::sizeof_pack(pack);
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user