desktop/source/inc/exithelper.hxx

   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: exithelper.hxx,v $
  10  * $Revision: 1.5 $
  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 _DESKTOP_EXITHELPER_HXX_
  32 #define _DESKTOP_EXITHELPER_HXX_
  33
  34 namespace desktop
  35 {
  36
  37 //=============================================================================
  38 /** @short  provide helper functions to handle a abnormal exit
  39             and contain a list of all "well known" exit codes.
  40  */
  41 class ExitHelper
  42 {
  43     //-------------------------------------------------------------------------
  44     // const
  45     public:
  46
  47         //---------------------------------------------------------------------
  48         /** @short  list of all well known exit codes.
  49
  50             @descr  Its not allowed to use exit codes hard coded
  51                     inside office. All places must use these list to
  52                     be synchron.
  53          */
  54         enum EExitCodes
  55         {
  56             /// e.g. used to force showing of the command line help
  57             E_NO_ERROR = 0,
  58             /// pipe was detected - second office must terminate itself
  59             E_SECOND_OFFICE = 1,
  60             /// an uno exception was catched during startup
  61             E_FATAL_ERROR = 333,    // Only the low 8 bits are significant 333 % 256 = 77
  62             /// crash during runtime
  63             E_CRASH = 78,
  64             /// user force automatic restart after crash
  65             E_CRASH_WITH_RESTART = 79,
  66             /// ???
  67             E_LOCKFILE = 80
  68         };
  69 };
  70
  71 } // namespace desktop
  72
  73 #endif // #ifndef _DESKTOP_EXITHELPER_HXX_