OFApplication.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#include <signal.h>

#import "OFObject.h"

OF_ASSUME_NONNULL_BEGIN

@class OFArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFSandbox;
@class OFString;

#define OF_APPLICATION_DELEGATE(cls)                    \
    int                             \
    main(int argc, char *argv[])                    \
    {                               \
        return of_application_main(&argc, &argv, [cls class]);  \
    }

#ifdef OF_HAVE_PLEDGE
# define OF_HAVE_SANDBOX
#endif

@protocol OFApplicationDelegate <OFObject>
- (void)applicationDidFinishLaunching;

@optional
- (void)applicationWillTerminate;

- (void)applicationDidReceiveSIGINT;

#ifdef SIGHUP

- (void)applicationDidReceiveSIGHUP;
#endif

#ifdef SIGUSR1

- (void)applicationDidReceiveSIGUSR1;
#endif

#ifdef SIGUSR2

- (void)applicationDidReceiveSIGUSR2;
#endif
@end

@interface OFApplication: OFObject
{
    OFString *_programName;
    OFArray OF_GENERIC(OFString *) *_arguments;
    OFMutableDictionary OF_GENERIC(OFString *, OFString *) *_environment;
    int *_argc;
    char ***_argv;
@public
    id <OFApplicationDelegate> _Nullable _delegate;
    void (*_Nullable _SIGINTHandler)(id, SEL);
#ifndef OF_WINDOWS
    void (*_Nullable _SIGHUPHandler)(id, SEL);
    void (*_Nullable _SIGUSR1Handler)(id, SEL);
    void (*_Nullable _SIGUSR2Handler)(id, SEL);
#endif
}

@property (readonly, nonatomic) OFString *programName;

@property (readonly, nonatomic) OFArray OF_GENERIC(OFString *) *arguments;

@property (readonly, nonatomic)
    OFDictionary OF_GENERIC(OFString *, OFString *) *environment;

+ (nullable OFApplication *)sharedApplication;

+ (nullable OFString *)programName;

+ (nullable OFArray OF_GENERIC(OFString *) *)arguments;

+ (nullable OFDictionary OF_GENERIC(OFString *, OFString *) *)environment;

+ (void)terminate OF_NO_RETURN;

+ (void)terminateWithStatus: (int)status OF_NO_RETURN;

#ifdef OF_HAVE_SANDBOX

+ (void)activateSandbox: (OFSandbox *)sandbox;
#endif

- init OF_UNAVAILABLE;

- (void)getArgumentCount: (int *_Nonnull *_Nonnull)argc
       andArgumentValues: (char *_Nonnull *_Nonnull *_Nonnull[_Nonnull])argv;

- (nullable id <OFApplicationDelegate>)delegate;

- (void)setDelegate: (nullable id <OFApplicationDelegate>)delegate;

- (void)terminate OF_NO_RETURN;

- (void)terminateWithStatus: (int)status OF_NO_RETURN;

#ifdef OF_HAVE_SANDBOX

- (void)activateSandbox: (OFSandbox *)sandbox;
#endif
@end

#ifdef __cplusplus
extern "C" {
#endif
extern int of_application_main(int *_Nonnull,
    char *_Nonnull *_Nonnull[_Nonnull], Class);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END