sal/inc/osl/signal.h

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