RTMain.h

/*
 * Licensed Materials - Property of HCL and/or IBM
 * Copyright HCL Technologies Ltd. 2016, 2021. All Rights Reserved.
 * Copyright IBM Corporation 1999, 2016. All Rights Reserved.
 *
 * U.S. Government Users Restricted Rights -  Use, duplication or 
 * disclosure restricted by GSA ADP Schedule.
 */
 
#ifndef __RTMain_h__
#define __RTMain_h__ included
 
#ifdef PRAGMA
#pragma interface
#endif
 
#ifndef __RTConfig_h__
#include <RTConfig.h>
#endif
 
#if OTRTSDEBUG != DEBUG_NONE
#include <stdarg.h>
 
typedef void (*DEBUG_ERROR_FUNC_PTR)(const char*);
 
// Enables compile-time verification of printf-style format strings
#ifndef FORMAT_CHECK
  #if defined (__GNUC__) && !defined (DISABLE_FORMATCHECKING)
    #if defined(__MINGW32__) && !defined(__clang__)
    #define FORMAT_CHECK(f,s)       __attribute__((__format__(gnu_printf, f, s)))
    #else
    #define FORMAT_CHECK(f,s)       __attribute__((__format__(printf, f, s)))
    #endif
  #else
  #define FORMAT_CHECK(f,s)
  #endif
#endif//FORMAT_CHECK
#endif // OTRTSDEBUG != DEBUG_NONE
 
class  RTActor;
class  RTActorRef;
class  RTController;
class  RTSuperActor;
struct RTSystemDescriptor;
 
class RTMain
{
private:
    friend class RTSuperActor;
    friend class RTTracer;
 
    static int                          execute( void );
    static int                          mainLine( void );
 
    static void                         targetStartup( void );
    static void                         installHandlers( void );
    static void                         installOneHandler( int,
                               void (*)( int ) );
    static void                         removeHandlers( void );
    static void                         removeOneHandler( int );
    static void                         targetShutdown( void );
 
#if OTRTSDEBUG != DEBUG_NONE
 
    static void                 invokeOrDiagInternal(const char* format, va_list args);
 
    static DEBUG_ERROR_FUNC_PTR               debugErrorFunctionPtr;
#endif // OTRTSDEBUG != DEBUG_NONE
 
    static const RTSystemDescriptor   * _system;
    static int                          _exitCode;
    static int                          _argc;
    static const char * const         * _argv;
 
    static RTController               * _controller;
    static RTActor                    * _superActor;
    static RTActorRef                 * _topReference;
 
#if USE_THREADS && OTRTSDEBUG != DEBUG_NONE
    static int                          debugPriority;
    static int                          debugStackSize;
#endif
 
public:
    // entryPoint must be provided by the generated code
    static int                          entryPoint( int, const char * const * );
 
    static int                          shutdown( RTController * );
    static const char                 * debugName( void );
 
#if OTRTSDEBUG != DEBUG_NONE
    static void                         registerDebugErrorFunction(DEBUG_ERROR_FUNC_PTR pFunc);
 
    static DEBUG_ERROR_FUNC_PTR         getDebugErrorFunction();
 
    static FORMAT_CHECK(1, 2) void      invokeOrDiag(const char* format, ...);
#endif // OTRTSDEBUG != DEBUG_NONE
 
    static RTS_INLINE RTController    * controller( void );
    static RTS_INLINE RTActorRef      * topReference( void );
    static RTS_INLINE RTActor         * topActor( void );
 
    static RTS_INLINE
    const RTSystemDescriptor          * systemInfo( void );
    static RTS_INLINE int                  argCount( void );
    static RTS_INLINE const char * const * argStrings( void );
    static RTS_INLINE void             setExitCode(int code);
    static RTS_INLINE int              getExitCode(void);
 
#if USE_THREADS
    static void                         lock( void );
    static void                         unlock( void );
#else
    static RTS_INLINE void              lock( void );
    static RTS_INLINE void              unlock( void );
#endif
};
 
#if RTS_INLINES
#include <RTMain.inl>
#endif
 
#endif // __RTMain_h__