xref: /trunk/main/sal/inc/osl/signal.h (revision 9eab2a37)
1*9eab2a37SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*9eab2a37SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*9eab2a37SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*9eab2a37SAndrew Rist  * distributed with this work for additional information
6*9eab2a37SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*9eab2a37SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*9eab2a37SAndrew Rist  * "License"); you may not use this file except in compliance
9*9eab2a37SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*9eab2a37SAndrew Rist  *
11*9eab2a37SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*9eab2a37SAndrew Rist  *
13*9eab2a37SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*9eab2a37SAndrew Rist  * software distributed under the License is distributed on an
15*9eab2a37SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*9eab2a37SAndrew Rist  * KIND, either express or implied.  See the License for the
17*9eab2a37SAndrew Rist  * specific language governing permissions and limitations
18*9eab2a37SAndrew Rist  * under the License.
19*9eab2a37SAndrew Rist  *
20*9eab2a37SAndrew Rist  *************************************************************/
21*9eab2a37SAndrew Rist 
22*9eab2a37SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef _OSL_SIGNAL_H_
25cdf0e10cSrcweir #define _OSL_SIGNAL_H_
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include "sal/types.h"
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #ifdef __cplusplus
30cdf0e10cSrcweir extern "C" {
31cdf0e10cSrcweir #endif
32cdf0e10cSrcweir 
33cdf0e10cSrcweir #define OSL_SIGNAL_USER_RESERVED	0
34cdf0e10cSrcweir 
35cdf0e10cSrcweir #define OSL_SIGNAL_USER_RESOURCEFAILURE		(OSL_SIGNAL_USER_RESERVED - 1)
36cdf0e10cSrcweir #define OSL_SIGNAL_USER_X11SUBSYSTEMERROR 	(OSL_SIGNAL_USER_RESERVED - 2)
37cdf0e10cSrcweir #define OSL_SIGNAL_USER_RVPCONNECTIONERROR 	(OSL_SIGNAL_USER_RESERVED - 3)
38cdf0e10cSrcweir 
39cdf0e10cSrcweir typedef void* oslSignalHandler;
40cdf0e10cSrcweir 
41cdf0e10cSrcweir typedef enum
42cdf0e10cSrcweir {
43cdf0e10cSrcweir 	osl_Signal_System,
44cdf0e10cSrcweir 	osl_Signal_Terminate,
45cdf0e10cSrcweir 	osl_Signal_AccessViolation,
46cdf0e10cSrcweir 	osl_Signal_IntegerDivideByZero,
47cdf0e10cSrcweir 	osl_Signal_FloatDivideByZero,
48cdf0e10cSrcweir 	osl_Signal_DebugBreak,
49cdf0e10cSrcweir 	osl_Signal_User,
50cdf0e10cSrcweir 	osl_Signal_Alarm,
51cdf0e10cSrcweir 	osl_Signal_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
52cdf0e10cSrcweir } oslSignal;
53cdf0e10cSrcweir 
54cdf0e10cSrcweir typedef enum
55cdf0e10cSrcweir {
56cdf0e10cSrcweir 	osl_Signal_ActCallNextHdl,
57cdf0e10cSrcweir 	osl_Signal_ActIgnore,
58cdf0e10cSrcweir 	osl_Signal_ActAbortApp,
59cdf0e10cSrcweir 	osl_Signal_ActKillApp,
60cdf0e10cSrcweir 	osl_Signal_Act_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
61cdf0e10cSrcweir } oslSignalAction;
62cdf0e10cSrcweir 
63cdf0e10cSrcweir #ifdef SAL_W32
64cdf0e10cSrcweir #	pragma pack(push, 8)
65cdf0e10cSrcweir #elif defined(SAL_OS2)
66cdf0e10cSrcweir #	pragma pack(push, 4)
67cdf0e10cSrcweir #endif
68cdf0e10cSrcweir 
69cdf0e10cSrcweir typedef struct
70cdf0e10cSrcweir {
71cdf0e10cSrcweir 	oslSignal	Signal;
72cdf0e10cSrcweir 	sal_Int32	UserSignal;
73cdf0e10cSrcweir 	void* 		UserData;
74cdf0e10cSrcweir } oslSignalInfo;
75cdf0e10cSrcweir 
76cdf0e10cSrcweir #if defined( SAL_W32) ||  defined(SAL_OS2)
77cdf0e10cSrcweir #	pragma pack(pop)
78cdf0e10cSrcweir #endif
79cdf0e10cSrcweir 
80cdf0e10cSrcweir /** the function-ptr. representing the signal handler-function.
81cdf0e10cSrcweir */
82cdf0e10cSrcweir typedef oslSignalAction (SAL_CALL *oslSignalHandlerFunction)(void* pData, oslSignalInfo* pInfo);
83cdf0e10cSrcweir 
84cdf0e10cSrcweir oslSignalHandler SAL_CALL osl_addSignalHandler(oslSignalHandlerFunction Handler, void* pData);
85cdf0e10cSrcweir 
86cdf0e10cSrcweir sal_Bool SAL_CALL osl_removeSignalHandler(oslSignalHandler hHandler);
87cdf0e10cSrcweir 
88cdf0e10cSrcweir oslSignalAction SAL_CALL osl_raiseSignal(sal_Int32 UserSignal, void* UserData);
89cdf0e10cSrcweir 
90cdf0e10cSrcweir /** Enables or disables error reporting
91cdf0e10cSrcweir 
92cdf0e10cSrcweir 	On default error reporting is enabled after process startup.
93cdf0e10cSrcweir 
94cdf0e10cSrcweir 	@param	bEnable [in]
95cdf0e10cSrcweir 	Enables or disables error reporting.
96cdf0e10cSrcweir 
97cdf0e10cSrcweir 	@return
98cdf0e10cSrcweir 	sal_True if previous state of error reporting was enabled<br>
99cdf0e10cSrcweir 	sal_False if previous state of error reporting was disbaled<br>
100cdf0e10cSrcweir */
101cdf0e10cSrcweir 
102cdf0e10cSrcweir sal_Bool SAL_CALL osl_setErrorReporting( sal_Bool bEnable );
103cdf0e10cSrcweir 
104cdf0e10cSrcweir #ifdef __cplusplus
105cdf0e10cSrcweir }
106cdf0e10cSrcweir #endif
107cdf0e10cSrcweir 
108cdf0e10cSrcweir #endif	/* _OSL_SIGNAL_H_ */
109cdf0e10cSrcweir 
110cdf0e10cSrcweir 
111