include/SDL_main.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
   4
   5   This software is provided 'as-is', without any express or implied
   6   warranty.  In no event will the authors be held liable for any damages
   7   arising from the use of this software.
   8
   9   Permission is granted to anyone to use this software for any purpose,
  10   including commercial applications, and to alter it and redistribute it
  11   freely, subject to the following restrictions:
  12
  13   1. The origin of this software must not be misrepresented; you must not
  14      claim that you wrote the original software. If you use this software
  15      in a product, an acknowledgment in the product documentation would be
  16      appreciated but is not required.
  17   2. Altered source versions must be plainly marked as such, and must not be
  18      misrepresented as being the original software.
  19   3. This notice may not be removed or altered from any source distribution.
  20 */
  21
  22 #ifndef _SDL_main_h
  23 #define _SDL_main_h
  24
  25 #include "SDL_stdinc.h"
  26
  27 /**
  28  *  \file SDL_main.h
  29  *
  30  *  Redefine main() on some platforms so that it is called by SDL.
  31  */
  32
  33 #ifndef SDL_MAIN_HANDLED
  34 #if defined(__WIN32__)
  35 /* On Windows SDL provides WinMain(), which parses the command line and passes
  36    the arguments to your main function.
  37
  38    If you provide your own WinMain(), you may define SDL_MAIN_HANDLED
  39  */
  40 #define SDL_MAIN_AVAILABLE
  41
  42 #elif defined(__WINRT__)
  43 /* On WinRT, SDL provides a main function that initializes CoreApplication,
  44    creating an instance of IFrameworkView in the process.
  45
  46    Please note that #include'ing SDL_main.h is not enough to get a main()
  47    function working.  In non-XAML apps, the file,
  48    src/main/winrt/SDL_WinRT_main_NonXAML.cpp, or a copy of it, must be compiled
  49    into the app itself.  In XAML apps, the function, SDL_WinRTRunApp must be
  50    called, with a pointer to the Direct3D-hosted XAML control passed in.
  51 */
  52 #define SDL_MAIN_NEEDED
  53
  54 #elif defined(__IPHONEOS__)
  55 /* On iOS SDL provides a main function that creates an application delegate
  56    and starts the iOS application run loop.
  57
  58    See src/video/uikit/SDL_uikitappdelegate.m for more details.
  59  */
  60 #define SDL_MAIN_NEEDED
  61
  62 #elif defined(__ANDROID__)
  63 /* On Android SDL provides a Java class in SDLActivity.java that is the
  64    main activity entry point.
  65
  66    See README-android.txt for more details on extending that class.
  67  */
  68 #define SDL_MAIN_NEEDED
  69
  70 #elif defined(__NACL__)
  71 /* On NACL we use ppapi_simple to set up the application helper code,
  72    then wait for the first PSE_INSTANCE_DIDCHANGEVIEW event before
  73    starting the user main function.
  74    All user code is run in a separate thread by ppapi_simple, thus
  75    allowing for blocking io to take place via nacl_io
  76 */
  77 #define SDL_MAIN_NEEDED
  78
  79 #elif defined(__TIZEN__)
  80 /* On Tizen SDL provides tizen backend and port for tizen device.
  81
  82  */
  83 #define SDL_MAIN_NEEDED
  84
  85 #endif
  86 #endif /* SDL_MAIN_HANDLED */
  87
  88 #ifdef __cplusplus
  89 #define C_LINKAGE   "C"
  90 #else
  91 #define C_LINKAGE
  92 #endif /* __cplusplus */
  93
  94 /**
  95  *  \file SDL_main.h
  96  *
  97  *  The application's main() function must be called with C linkage,
  98  *  and should be declared like this:
  99  *  \code
 100  *  #ifdef __cplusplus
 101  *  extern "C"
 102  *  #endif
 103  *  int main(int argc, char *argv[])
 104  *  {
 105  *  }
 106  *  \endcode
 107  */
 108
 109 #if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)
 110 #define main    SDL_main
 111 #endif
 112
 113 /**
 114  *  The prototype for the application's main() function
 115  */
 116 extern C_LINKAGE int SDL_main(int argc, char *argv[]);
 117
 118
 119 #include "begin_code.h"
 120 #ifdef __cplusplus
 121 extern "C" {
 122 #endif
 123
 124 /**
 125  *  This is called by the real SDL main function to let the rest of the
 126  *  library know that initialization was done properly.
 127  *
 128  *  Calling this yourself without knowing what you're doing can cause
 129  *  crashes and hard to diagnose problems with your application.
 130  */
 131 extern DECLSPEC void SDLCALL SDL_SetMainReady(void);
 132
 133 #ifdef __WIN32__
 134
 135 /**
 136  *  This can be called to set the application class at startup
 137  */
 138 extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style,
 139                                             void *hInst);
 140 extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);
 141
 142 #endif /* __WIN32__ */
 143
 144
 145 #ifdef __WINRT__
 146
 147 /**
 148  *  \brief Initializes and launches an SDL/WinRT application.
 149  *
 150  *  \param mainFunction The SDL app's C-style main().
 151  *  \param reserved Reserved for future use; should be NULL
 152  *  \return 0 on success, -1 on failure.  On failure, use SDL_GetError to retrieve more
 153  *      information on the failure.
 154  */
 155 extern DECLSPEC int SDLCALL SDL_WinRTRunApp(int (*mainFunction)(int, char **), void * reserved);
 156
 157 #endif /* __WINRT__ */
 158
 159 #ifdef __TIZEN__
 160
 161 extern DECLSPEC int SDLCALL SDL_tizen_app_init(int argc, char *argv[]);
 162
 163 #endif /* __TIZEN__ */
 164
 165
 166 #ifdef __cplusplus
 167 }
 168 #endif
 169 #include "close_code.h"
 170
 171 #endif /* _SDL_main_h */
 172
 173 /* vi: set ts=4 sw=4 expandtab: */