taskolib/internals_8h_source.html

 // SPDX-License-Identifier: LGPL-2.1-or-later


 #ifndef TASKOLIB_INTERNALS_H_

 #define TASKOLIB_INTERNALS_H_


 #include <string>

 #include <utility>


 #include <gul14/string_view.h>


 namespace task {


 enum class ErrorCause { terminated_by_script, aborted, uncaught_error };


 const char sequence_lua_filename[] = "sequence.lua";


 extern const gul14::string_view abort_marker;


 void check_for_control_characters(gul14::string_view str);


 std::pair<std::string, ErrorCause> remove_abort_markers(gul14::string_view error_message);


 } // namespace task


 #endif

task
Namespace task contains all Taskolib functions and classes.
Definition: CommChannel.h:33

task::abort_marker
const gul14::string_view abort_marker
A marker string (the word "ABORT" surrounded by Unicode stop signs) whose presence anywhere in an err...
Definition: internals.cc:36

task::sequence_lua_filename
const char sequence_lua_filename[]
Define the Lua sequence filename for storing and loading Lua script.
Definition: internals.h:39

task::ErrorCause
ErrorCause
An enum detailing the possible causes of the termination of a sequence.
Definition: internals.h:36

task::ErrorCause::uncaught_error
@ uncaught_error

task::ErrorCause::aborted
@ aborted

task::ErrorCause::terminated_by_script
@ terminated_by_script

task::check_for_control_characters
void check_for_control_characters(gul14::string_view str)
Throw an exception if the string contains control characters.
Definition: internals.cc:47

task::remove_abort_markers
std::pair< std::string, ErrorCause > remove_abort_markers(gul14::string_view error_message)
Remove abort markers from the given error message, beautify it, and determine the cause of the error.
Definition: internals.cc:56