xref: /aoo41x/main/sal/inc/osl/signal.h (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _OSL_SIGNAL_H_
29*cdf0e10cSrcweir #define _OSL_SIGNAL_H_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "sal/types.h"
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #ifdef __cplusplus
34*cdf0e10cSrcweir extern "C" {
35*cdf0e10cSrcweir #endif
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir #define OSL_SIGNAL_USER_RESERVED	0
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir #define OSL_SIGNAL_USER_RESOURCEFAILURE		(OSL_SIGNAL_USER_RESERVED - 1)
40*cdf0e10cSrcweir #define OSL_SIGNAL_USER_X11SUBSYSTEMERROR 	(OSL_SIGNAL_USER_RESERVED - 2)
41*cdf0e10cSrcweir #define OSL_SIGNAL_USER_RVPCONNECTIONERROR 	(OSL_SIGNAL_USER_RESERVED - 3)
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir typedef void* oslSignalHandler;
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir typedef enum
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir 	osl_Signal_System,
48*cdf0e10cSrcweir 	osl_Signal_Terminate,
49*cdf0e10cSrcweir 	osl_Signal_AccessViolation,
50*cdf0e10cSrcweir 	osl_Signal_IntegerDivideByZero,
51*cdf0e10cSrcweir 	osl_Signal_FloatDivideByZero,
52*cdf0e10cSrcweir 	osl_Signal_DebugBreak,
53*cdf0e10cSrcweir 	osl_Signal_User,
54*cdf0e10cSrcweir 	osl_Signal_Alarm,
55*cdf0e10cSrcweir 	osl_Signal_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
56*cdf0e10cSrcweir } oslSignal;
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir typedef enum
59*cdf0e10cSrcweir {
60*cdf0e10cSrcweir 	osl_Signal_ActCallNextHdl,
61*cdf0e10cSrcweir 	osl_Signal_ActIgnore,
62*cdf0e10cSrcweir 	osl_Signal_ActAbortApp,
63*cdf0e10cSrcweir 	osl_Signal_ActKillApp,
64*cdf0e10cSrcweir 	osl_Signal_Act_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
65*cdf0e10cSrcweir } oslSignalAction;
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir #ifdef SAL_W32
68*cdf0e10cSrcweir #	pragma pack(push, 8)
69*cdf0e10cSrcweir #elif defined(SAL_OS2)
70*cdf0e10cSrcweir #	pragma pack(push, 4)
71*cdf0e10cSrcweir #endif
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir typedef struct
74*cdf0e10cSrcweir {
75*cdf0e10cSrcweir 	oslSignal	Signal;
76*cdf0e10cSrcweir 	sal_Int32	UserSignal;
77*cdf0e10cSrcweir 	void* 		UserData;
78*cdf0e10cSrcweir } oslSignalInfo;
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir #if defined( SAL_W32) ||  defined(SAL_OS2)
81*cdf0e10cSrcweir #	pragma pack(pop)
82*cdf0e10cSrcweir #endif
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir /** the function-ptr. representing the signal handler-function.
85*cdf0e10cSrcweir */
86*cdf0e10cSrcweir typedef oslSignalAction (SAL_CALL *oslSignalHandlerFunction)(void* pData, oslSignalInfo* pInfo);
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir oslSignalHandler SAL_CALL osl_addSignalHandler(oslSignalHandlerFunction Handler, void* pData);
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir sal_Bool SAL_CALL osl_removeSignalHandler(oslSignalHandler hHandler);
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir oslSignalAction SAL_CALL osl_raiseSignal(sal_Int32 UserSignal, void* UserData);
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir /** Enables or disables error reporting
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir 	On default error reporting is enabled after process startup.
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir 	@param	bEnable [in]
99*cdf0e10cSrcweir 	Enables or disables error reporting.
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir 	@return
102*cdf0e10cSrcweir 	sal_True if previous state of error reporting was enabled<br>
103*cdf0e10cSrcweir 	sal_False if previous state of error reporting was disbaled<br>
104*cdf0e10cSrcweir */
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir sal_Bool SAL_CALL osl_setErrorReporting( sal_Bool bEnable );
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir #ifdef __cplusplus
109*cdf0e10cSrcweir }
110*cdf0e10cSrcweir #endif
111*cdf0e10cSrcweir 
112*cdf0e10cSrcweir #endif	/* _OSL_SIGNAL_H_ */
113*cdf0e10cSrcweir 
114*cdf0e10cSrcweir 
115