xref: /trunk/main/desktop/source/inc/exithelper.hxx (revision 3f2293a34d640799d3a646809239d04f5e6f46e0)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 #ifndef _DESKTOP_EXITHELPER_HXX_
23 #define _DESKTOP_EXITHELPER_HXX_
24 
25 namespace desktop
26 {
27 
28 //=============================================================================
29 /** @short  provide helper functions to handle a abnormal exit
30             and contain a list of all "well known" exit codes.
31  */
32 class ExitHelper
33 {
34     //-------------------------------------------------------------------------
35     // const
36     public:
37 
38         //---------------------------------------------------------------------
39         /** @short  list of all well known exit codes.
40 
41             @descr  Its not allowed to use exit codes hard coded
42                     inside office. All places must use these list to
43                     be synchron.
44          */
45         enum EExitCodes
46         {
47             /// e.g. used to force showing of the command line help
48             E_NO_ERROR = 0,
49             /// pipe was detected - second office must terminate itself
50             E_SECOND_OFFICE = 1,
51             /// an uno exception was caught during startup
52             E_FATAL_ERROR = 333,    // Only the low 8 bits are significant 333 % 256 = 77
53             /// user force automatic restart after crash
54             E_CRASH_WITH_RESTART = 79,
55             /// the office restarts itself
56             E_NORMAL_RESTART = 81
57         };
58 };
59 
60 } // namespace desktop
61 
62 #endif // #ifndef _DESKTOP_EXITHELPER_HXX_
63