gcleanup.h

Go to the documentation of this file.

//
// Copyright (C) 2017 Graeme Walker
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
// ===
///
/// \file gcleanup.h
///

#ifndef G_CLEANUP_H
#define G_CLEANUP_H

#include "gdef.h"
#include "gpath.h"
#include "gsignalsafe.h"
#include "gexception.h"

namespace G
{
    class Cleanup ;
}

/// \class G::Cleanup
/// A static interface for registering cleanup functions that are called when 
/// the process terminates abnormally. On unix this relates to signals like 
/// SIGTERM, SIGINT etc.
/// 
class G::Cleanup
{
public:
    G_EXCEPTION( Error , "cleanup error" ) ;

    static void init() ;
        ///< An optional early-initialisation function. May be called more than once.

    static void add( void (*fn)(SignalSafe,const char*) , const char * arg ) ;
        ///< Adds the given handler to the list of handlers that are to be called 
        ///< when the process terminates abnormally. The handler function must be 
        ///< fully reentrant, hence the SignalSafe dummy parameter. The 'arg' 
        ///< pointer is kept.

    static void atexit( bool active = true ) ;
        ///< Ensures that the cleanup functions are also called via atexit(), in 
        ///< addition to abnormal-termination signals. 
        ///< 
        ///< This can be useful when third-party library code (eg. Xlib) might call 
        ///< exit() (grrr). But be careful to call atexit(false) before normal 
        ///< termination, returning from main().

private:
    Cleanup() ; // not implemeneted
} ;

#endif