_static/doxyhtml/ablastr_2utils_2_text_msg_8_h_source.html

 /* Copyright 2022 Luca Fedeli

  *

  * This file is part of WarpX.

  *

  * License: BSD-3-Clause-LBNL

  */


 #ifndef ABLASTR_TEXT_MSG_H_

 #define ABLASTR_TEXT_MSG_H_


 #include <string>

 #include <vector>


 namespace ablastr::utils::TextMsg

 {

     std::string

     Err (const std::string &msg, const bool do_text_wrapping = true);


     std::string

     Info (const std::string &msg, const bool do_text_wrapping = true);


     std::string

     Warn (const std::string &msg, const bool do_text_wrapping = true);


     void

     Assert (const char *ex, const char *file, const int line, const std::string &msg);


     void

     Abort (const char *file, const int line, const std::string &msg);


 } // namespace ablastr::utils::TextMsg


 #define ABLASTR_ALWAYS_ASSERT_WITH_MESSAGE(EX,MSG) (EX)?((void)0) : ablastr::utils::TextMsg::Assert( # EX , __FILE__, __LINE__ , MSG)


 #define ABLASTR_ABORT_WITH_MESSAGE(MSG) ablastr::utils::TextMsg::Abort( __FILE__, __LINE__ , MSG)


 #endif // ABLASTR_TEXT_MSG_H_

ablastr::utils::TextMsg
Definition: TextMsg.H:16

ablastr::utils::TextMsg::Assert
void Assert(const char *ex, const char *file, const int line, const std::string &msg)
This function is a wrapper around amrex::Assert, designed to ensure the uniform formatting of the err...
Definition: TextMsg.cpp:77

ablastr::utils::TextMsg::Warn
std::string Warn(const std::string &msg, const bool do_text_wrapping=true)
This function formats a text message as a warning message, adding the '### WARN: ' prefix and (by def...
Definition: TextMsg.cpp:70

ablastr::utils::TextMsg::Err
std::string Err(const std::string &msg, const bool do_text_wrapping=true)
This function formats a text message as an error message, adding the '### ERROR: ' prefix and (by def...
Definition: TextMsg.cpp:56

ablastr::utils::TextMsg::Info
std::string Info(const std::string &msg, const bool do_text_wrapping=true)
This function formats a text message as an info message, adding the '### INFO: ' prefix and (by defau...
Definition: TextMsg.cpp:63

ablastr::utils::TextMsg::Abort
void Abort(const char *file, const int line, const std::string &msg)
This function is a wrapper around amrex::Abort, designed to ensure the uniform formatting of the erro...
Definition: TextMsg.cpp:84