gexceptions.h

/*
 * File: gexceptions.h
 * -------------------
 * This file contains a top-level exception handler to print exceptions thrown
 * by student code on the console.
 * It also contains some wizardry to try to retrieve a stack trace when the
 * exception is thrown, though it is hard to consistently do this on all platforms.
 *
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl::exceptions namespace
 * @version 2021/04/03
 * - removed dependencies
 * - renamed to gexceptions
 * @version 2018/09/25
 * - add 'force' parameter to setTopLevelExceptionHandlerEnabled
 *   (helps it to work better with threads)
 * - added doc comments for new documentation generation
 * @version 2016/11/07
 * - added cleanupFunctionNameForStackTrace
 * @version 2016/10/30
 * - moved recursion functions to recursion.h/cpp
 * @version 2014/11/12
 * - made printStackTrace function publicly available
 * - added top-level signal handler (for null-pointer derefs etc.)
 * @since 2014/11/05
 */


#ifndef _exceptions_h
#define _exceptions_h

#include <string>

namespace sgl {
namespace exceptions {

string& getProgramName();

bool getTopLevelExceptionHandlerEnabled();

void setProgramName(char* programName);

void setTopLevelExceptionHandlerEnabled(bool enabled);

void interruptIfDebug();


} // namespace exceptions
} // namespace sgl

#endif // _gexceptions_h