xref: /trunk/main/desktop/source/inc/exithelper.hxx (revision 0a1e2f0e)
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 
23 
24 #ifndef _DESKTOP_EXITHELPER_HXX_
25 #define _DESKTOP_EXITHELPER_HXX_
26 
27 namespace desktop
28 {
29 
30 //=============================================================================
31 /** @short  provide helper functions to handle a abnormal exit
32             and contain a list of all "well known" exit codes.
33  */
34 class ExitHelper
35 {
36     //-------------------------------------------------------------------------
37     // const
38     public:
39 
40         //---------------------------------------------------------------------
41         /** @short  list of all well known exit codes.
42 
43             @descr  Its not allowed to use exit codes hard coded
44                     inside office. All places must use these list to
45                     be synchron.
46          */
47         enum EExitCodes
48         {
49             /// e.g. used to force showing of the command line help
50             E_NO_ERROR = 0,
51             /// pipe was detected - second office must terminate itself
52             E_SECOND_OFFICE = 1,
53             /// an uno exception was catched during startup
54             E_FATAL_ERROR = 333,    // Only the low 8 bits are significant 333 % 256 = 77
55             /// user force automatic restart after crash
56             E_CRASH_WITH_RESTART = 79,
57             /// the office restarts itself
58             E_NORMAL_RESTART = 81
59         };
60 };
61 
62 } // namespace desktop
63 
64 #endif // #ifndef _DESKTOP_EXITHELPER_HXX_
65