 |
Qore Programming Language - C/C++ Library
0.9.4.1
|
32 #ifndef _QORE_EXCEPTIONSINK_H
34 #define _QORE_EXCEPTIONSINK_H
42 struct QoreProgramLocation;
47 friend struct qore_es_private;
51 struct qore_es_private *priv;
88 DLLEXPORT
operator bool ()
const;
210 DLLEXPORT
void raiseException(
const QoreProgramLocation& loc,
const char* err,
QoreValue arg,
const char* fmt, ...);
225 DLLEXPORT
void clear();
245 DLLLOCAL QoreException* catchException();
246 DLLLOCAL QoreException* getException();
247 DLLLOCAL
void overrideLocation(
const QoreProgramLocation& loc);
248 DLLLOCAL
void rethrow(QoreException* old);
250 DLLLOCAL
static void defaultExceptionHandler(QoreException* e);
251 DLLLOCAL
static void defaultWarningHandler(QoreException* e);
253 DLLLOCAL
static void outputExceptionLocation(
const char* fns,
int start_line,
int end_line,
const char* srcs,
254 int offset,
const char* langs,
const char* types);
258 enum qore_call_t :
signed char {
283 const char*
code,
const char*
lang =
"Qore") :
295 const char*
lang =
"Qore") :
305 typedef std::vector<QoreCallStackElement> callstack_vec_t;
311 DLLLOCAL
void add(qore_call_t type,
const char* label,
int start,
int end,
const char* code,
312 const char* lang =
"Qore") {
316 DLLLOCAL
void add(qore_call_t type,
const char* label,
int start,
int end,
const char* source,
317 unsigned offset,
const char* code,
const char* lang =
"Qore") {
322 static inline void alreadyDeleted(
ExceptionSink *xsink,
const char *cmeth) {
323 xsink->
raiseException(
"OBJECT-ALREADY-DELETED",
"the method %s() cannot be executed because the object has already been deleted", cmeth);
326 static inline void makeAccessDeletedObjectException(
ExceptionSink *xsink,
const char *mem,
const char *cname) {
327 xsink->
raiseException(
"OBJECT-ALREADY-DELETED",
"attempt to access member '%s' of an already-deleted object of class '%s'", mem, cname);
330 static inline void makeAccessDeletedObjectException(
ExceptionSink *xsink,
const char *cname) {
331 xsink->
raiseException(
"OBJECT-ALREADY-DELETED",
"attempt to access an already-deleted object of class '%s'", cname);
348 const char* source =
nullptr,
int offset = 0,
const char* lang =
nullptr);
354 DLLEXPORT
void set(
const char* file,
int start_line,
int end_line,
355 const char* source =
nullptr,
int offset = 0,
const char* lang =
nullptr);
358 DLLLOCAL
const QoreProgramLocation&
get()
const {
385 std::string file_str;
386 std::string source_str;
387 std::string lang_str;
390 QoreProgramLocation* loc;
437 DLLLOCAL
virtual const AbstractStatement*
getStatement()
const = 0;
440 DLLLOCAL
virtual const std::string&
getCallName()
const = 0;
443 DLLLOCAL
virtual qore_call_t
getCallType()
const = 0;
446 DLLLOCAL
virtual const QoreProgramLocation&
getLocation()
const = 0;
456 friend class qore_external_runtime_stack_location_helper_priv;
480 DLLEXPORT
virtual const AbstractStatement*
getStatement()
const;
483 class qore_external_stack_location_priv* priv;
510 class qore_external_runtime_stack_location_helper_priv* priv;
DLLEXPORT void clear()
deletes the exception list immediately
DLLLOCAL void setNext(const QoreStackLocation *next)
called when pushed on the stack to set the next location
Definition: ExceptionSink.h:424
virtual DLLLOCAL QoreProgram * getProgram() const =0
returns the QoreProgram container
supports parsing and executing Qore-language code, reference counted, dynamically-allocated only
Definition: QoreProgram.h:126
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:262
std::string code
the function or method call name; method calls in format class::name
Definition: ExceptionSink.h:275
const DLLLOCAL QoreProgramLocation & get() const
returns the source location
Definition: ExceptionSink.h:358
DLLEXPORT bool isEvent() const
returns true if at least one exception is present or thread_exit has been triggered
DLLEXPORT int getStartLine() const
returns the start line
virtual const DLLEXPORT AbstractStatement * getStatement() const
returns the statement for the call for internal Qore code
DLLEXPORT ~QoreExternalProgramLocationWrapper()
destructor; frees memory
DLLEXPORT AbstractQoreNode * raiseErrnoException(const char *err, int en, const char *fmt,...)
appends a Qore-language exception to the list and appends the result of strerror(errno) to the descri...
DLLLOCAL QoreExternalStackLocation & operator=(const QoreExternalStackLocation &)=delete
no assignment operator
DLLLOCAL QoreStackLocation & operator=(const QoreStackLocation &)=default
default assignment operator
DLLEXPORT void handleExceptions()
calls ExceptionSink::defaultExceptionHandler() on all exceptions still present in the object and then...
const DLLLOCAL std::string & getFile() const
returns the file name
Definition: ExceptionSink.h:363
std::string source
optional additional source file
Definition: ExceptionSink.h:273
DLLEXPORT ExceptionSink()
creates an empty ExceptionSink object
virtual const DLLLOCAL QoreProgramLocation & getLocation() const =0
returns the source location of the element
const DLLEXPORT QoreValue getExceptionDesc()
returns the description of the top exception
const DLLEXPORT QoreValue getExceptionArg()
returns the argument of the top exception
virtual const DLLLOCAL QoreStackLocation * getNext() const
returns the next location in the stack or nullptr if there is none
Definition: ExceptionSink.h:429
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
returns a custom Qore program location for external modules to generate runtime exceptions with the s...
Definition: ExceptionSink.h:335
unsigned offset
offset in source file (only used if source is not empty)
Definition: ExceptionSink.h:274
DLLEXPORT int appendLastDescription(const char *fmt,...)
appends a formatted string to the top exception description if the desc value is a string
DLLEXPORT void raiseThreadExit()
sets the "thread_exit" flag; will cause the current thread to terminate
const DLLLOCAL std::string & getLanguage() const
returns the language
Definition: ExceptionSink.h:373
DLLEXPORT void outOfMemory()
intended to be used to handle out of memory errors FIXME: not yet fully implemented
virtual const DLLLOCAL AbstractStatement * getStatement() const =0
returns the statement for the call for internal Qore code
DLLEXPORT ~ExceptionSink()
calls ExceptionSink::defaultExceptionHandler() on all exceptions still present in the object and then...
DLLEXPORT AbstractQoreNode * raiseException(const char *err, const char *fmt,...)
appends a Qore-language exception to the list
Stack location element abstract class for external binary modules.
Definition: ExceptionSink.h:455
DLLEXPORT QoreExternalStackLocation()
create the object
DLLEXPORT int getEndLine() const
returns the start line
DLLEXPORT void assimilate(ExceptionSink *xs)
assimilates all entries of the "xs" argument by appending them to the internal list and deletes the "...
DLLLOCAL QoreExternalRuntimeStackLocationHelper & operator=(const QoreExternalRuntimeStackLocationHelper &)=delete
no assignment operator
virtual DLLLOCAL qore_call_t getCallType() const =0
returns the call type
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:46
DLLEXPORT void handleWarnings()
calls ExceptionSink::defaultWarningHandler() on all exceptions still present in the object and then d...
virtual DLLLOCAL ~QoreStackLocation()=default
virtual destructor
Qore source location; strings must be in the default encoding for the Qore process.
Definition: ExceptionSink.h:269
virtual DLLEXPORT QoreProgram * getProgram() const
returns the QoreProgram container
Qore call stack.
Definition: ExceptionSink.h:310
virtual DLLEXPORT ~QoreExternalStackLocation()
destroys the object
call stack element; strings must be in the default encoding for the Qore process
Definition: ExceptionSink.h:291
DLLEXPORT AbstractQoreNode * raiseExceptionArg(const char *err, QoreValue arg, const char *fmt,...)
appends a Qore-language exception to the list, and sets the 'arg' member (this object takes over the ...
DLLEXPORT bool isException() const
returns true if at least one exception is present
const DLLLOCAL std::string & getSource() const
returns the source
Definition: ExceptionSink.h:368
std::string lang
the source language
Definition: ExceptionSink.h:276
DLLLOCAL QoreStackLocation()
constructor
const DLLEXPORT QoreValue getExceptionErr()
returns the error of the top exception
DLLEXPORT ~QoreExternalRuntimeStackLocationHelper()
Restores the old runtime location.
int start_line
the start line
Definition: ExceptionSink.h:271
DLLEXPORT bool isThreadExit() const
returns true if thread_exit has been triggered
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
Sets the stack location for external modules providing language support.
Definition: ExceptionSink.h:489
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
DLLEXPORT void set(const char *file, int start_line, int end_line, const char *source=nullptr, int offset=0, const char *lang=nullptr)
sets the program source location
DLLEXPORT QoreExternalProgramLocationWrapper()
empty constructor; use set() to set the location
qore_call_t type
the call stack element type
Definition: ExceptionSink.h:292
DLLEXPORT QoreExternalRuntimeStackLocationHelper()
Sets the current runtime location.
virtual const DLLLOCAL std::string & getCallName() const =0
returns the name of the function or method call
std::string label
the code label name (source file if source not present)
Definition: ExceptionSink.h:270
int end_line
the end line
Definition: ExceptionSink.h:272
Stack location element abstract class.
Definition: ExceptionSink.h:396