OFApplication.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#include <signal.h>

#import "OFObject.h"
#import "OFNotification.h"

#ifdef OF_WINDOWS
# include <windows.h>
#endif

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;

#ifdef __cplusplus
extern "C" {
#endif

extern const OFNotificationName OFApplicationDidFinishLaunchingNotification;

extern const OFNotificationName OFApplicationWillTerminateNotification;
#ifdef __cplusplus
}
#endif

#ifndef OF_WINDOWS
# define OF_APPLICATION_DELEGATE(class_)        \
    int                     \
    main(int argc, char *argv[])            \
    {                       \
        return OFApplicationMain(&argc, &argv,  \
            (class_ *)[[class_ alloc] init]);   \
    }
#else
# define OF_APPLICATION_DELEGATE(class_)                \
    int                             \
    main(int argc, char *argv[])                    \
    {                               \
        return OFApplicationMain(&argc, &argv,          \
            (class_ *)[[class_ alloc] init]);           \
    }                               \
                                    \
    WINAPI int                          \
    WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,       \
        LPSTR lpCmdLine, int nShowCmd)              \
    {                               \
        int argc = 0, si = 0;                   \
        char **argv = NULL, **envp = NULL;          \
                                    \
        __getmainargs(&argc, &argv, &envp, _CRT_glob, &si); \
                                    \
        return OFApplicationMain(&argc, &argv,          \
            (class_ *)[[class_ alloc] init]);           \
    }
# ifdef __cplusplus
extern "C" {
# endif
extern void __getmainargs(int *_Nonnull, char *_Nonnull *_Nullable *_Nullable,
    char *_Nonnull *_Nullable *_Nullable, int, int *_Nonnull);
extern int _CRT_glob;
# ifdef __cplusplus
}
# endif
#endif

#ifdef OF_HAVE_PLEDGE
# define OF_HAVE_SANDBOX
#endif

@protocol OFApplicationDelegate <OFObject>
- (void)applicationDidFinishLaunching: (OFNotification *)notification;

@optional
- (void)applicationWillTerminate: (OFNotification *)notification;

#ifndef OF_AMIGAOS

- (void)applicationDidReceiveSIGINT;

# ifdef SIGHUP

- (void)applicationDidReceiveSIGHUP;
# endif

# ifdef SIGUSR1

- (void)applicationDidReceiveSIGUSR1;
# endif

# ifdef SIGUSR2

- (void)applicationDidReceiveSIGUSR2;
# endif
#endif
@end

OF_SUBCLASSING_RESTRICTED
@interface OFApplication: OFObject
{
    OFString *_programName;
    OFArray OF_GENERIC(OFString *) *_arguments;
    OFMutableDictionary OF_GENERIC(OFString *, OFString *) *_environment;
    int *_argc;
    char ***_argv;
    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
#ifdef OF_HAVE_SANDBOX
    OFSandbox *_Nullable _activeSandbox;
    OFSandbox *_Nullable _activeSandboxForChildProcesses;
#endif
}

#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nullable, nonatomic)
    OFApplication *sharedApplication;
@property (class, readonly, nullable, nonatomic) OFString *programName;
@property (class, readonly, nullable, nonatomic)
    OFArray OF_GENERIC(OFString *) *arguments;
@property (class, readonly, nullable, nonatomic)
    OFDictionary OF_GENERIC(OFString *, OFString *) *environment;
#endif

@property (readonly, nonatomic) OFString *programName;

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

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

@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFApplicationDelegate> delegate;

#ifdef OF_HAVE_SANDBOX
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFSandbox *activeSandbox;
@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
    OFSandbox *activeSandboxForChildProcesses;
#endif

+ (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)of_activateSandbox: (OFSandbox *)sandbox;
+ (void)of_activateSandboxForChildProcesses: (OFSandbox *)sandbox;
#endif

- (instancetype)init OF_UNAVAILABLE;

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

- (void)terminate OF_NO_RETURN;

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

#ifdef OF_HAVE_SANDBOX
- (void)of_activateSandbox: (OFSandbox *)sandbox;
- (void)of_activateSandboxForChildProcesses: (OFSandbox *)sandbox;
#endif
@end

#ifdef __cplusplus
extern "C" {
#endif
extern int OFApplicationMain(int *_Nonnull, char *_Nullable *_Nonnull[_Nonnull],
    id <OFApplicationDelegate>);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END