1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_OSL_SIGNAL_H
21#define INCLUDED_OSL_SIGNAL_H
22
23#include <sal/config.h>
24
25#include <sal/saldllapi.h>
26#include <sal/types.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#define OSL_SIGNAL_USER_RESERVED 0
33
34#define OSL_SIGNAL_USER_RESOURCEFAILURE (OSL_SIGNAL_USER_RESERVED - 1)
35#define OSL_SIGNAL_USER_X11SUBSYSTEMERROR (OSL_SIGNAL_USER_RESERVED - 2)
36#define OSL_SIGNAL_USER_RVPCONNECTIONERROR (OSL_SIGNAL_USER_RESERVED - 3)
37
38typedef void* oslSignalHandler;
39
40typedef enum
41{
42 osl_Signal_System,
43 osl_Signal_Terminate,
44 osl_Signal_AccessViolation,
45 osl_Signal_IntegerDivideByZero,
46 osl_Signal_FloatDivideByZero,
47 osl_Signal_DebugBreak,
48 osl_Signal_User,
49 osl_Signal_Alarm,
50 osl_Signal_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
51} oslSignal;
52
53typedef enum
54{
55 osl_Signal_ActCallNextHdl,
56 osl_Signal_ActIgnore,
57 osl_Signal_ActAbortApp,
58 osl_Signal_ActKillApp,
59 osl_Signal_Act_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
60} oslSignalAction;
61
62#ifdef SAL_W32
63# pragma pack(push, 8)
64#endif
65
66typedef struct
67{
68 oslSignal Signal;
69 sal_Int32 UserSignal;
70 void* UserData;
71} oslSignalInfo;
72
73#if defined( SAL_W32)
74# pragma pack(pop)
75#endif
76
77/** the function-ptr. representing the signal handler-function.
78*/
79typedef oslSignalAction (SAL_CALL *oslSignalHandlerFunction)(void* pData, oslSignalInfo* pInfo);
80
81SAL_DLLPUBLIC oslSignalHandler SAL_CALL osl_addSignalHandler(
82 oslSignalHandlerFunction Handler, void* pData);
83
84SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeSignalHandler(
85 oslSignalHandler hHandler);
86
87SAL_DLLPUBLIC oslSignalAction SAL_CALL osl_raiseSignal(
88 sal_Int32 UserSignal, void* UserData);
89
90/** Enables or disables error reporting
91
92 On default error reporting is enabled after process startup.
93
94 @param bEnable [in]
95 Enables or disables error reporting.
96
97 @return
98 sal_True if previous state of error reporting was enabled<br>
99 sal_False if previous state of error reporting was disbaled<br>
100*/
101
102SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setErrorReporting(
103 sal_Bool bEnable );
104
105#ifdef __cplusplus
106}
107#endif
108
109#endif // INCLUDED_OSL_SIGNAL_H
110
111
112/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
113