include/SDL_main.h
author David Ludwig <dludwig@pobox.com>
Tue, 13 Aug 2013 20:28:10 -0400
changeset 8480 733f78caa9cb
parent 8477 ad08f0d710f3
child 8500 f25ef28d61e8
permissions -rw-r--r--
WinRT: made sure SDL_main gets used in the latest SDL 2.0.0 based code
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 Windows RT, 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.  The file, src/main/windowsrt/SDL_WinRT_main.cpp, or a copy
    48    of it, must be compiled into the app itself.
    49 */
    50 #define SDL_MAIN_NEEDED
    51 
    52 #elif defined(__IPHONEOS__)
    53 /* On iOS SDL provides a main function that creates an application delegate
    54    and starts the iOS application run loop.
    55 
    56    See src/video/uikit/SDL_uikitappdelegate.m for more details.
    57  */
    58 #define SDL_MAIN_NEEDED
    59 
    60 #elif defined(__ANDROID__)
    61 /* On Android SDL provides a Java class in SDLActivity.java that is the
    62    main activity entry point.
    63 
    64    See README-android.txt for more details on extending that class.
    65  */
    66 #define SDL_MAIN_NEEDED
    67 
    68 #endif
    69 #endif /* SDL_MAIN_HANDLED */
    70 
    71 #ifdef __cplusplus
    72 #define C_LINKAGE   "C"
    73 #else
    74 #define C_LINKAGE
    75 #endif /* __cplusplus */
    76 
    77 /**
    78  *  \file SDL_main.h
    79  *
    80  *  The application's main() function must be called with C linkage,
    81  *  and should be declared like this:
    82  *  \code
    83  *  #ifdef __cplusplus
    84  *  extern "C"
    85  *  #endif
    86  *  int main(int argc, char *argv[])
    87  *  {
    88  *  }
    89  *  \endcode
    90  */
    91 
    92 #if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)
    93 #define main    SDL_main
    94 #endif
    95 
    96 /**
    97  *  The prototype for the application's main() function
    98  */
    99 extern C_LINKAGE int SDL_main(int argc, char *argv[]);
   100 
   101 
   102 #include "begin_code.h"
   103 #ifdef __cplusplus
   104 extern "C" {
   105 #endif
   106 
   107 /*
   108  *  This is called by the real SDL main function to let the rest of the
   109  *  library know that initialization was done properly.
   110  *
   111  *  Calling this yourself without knowing what you're doing can cause
   112  *  crashes and hard to diagnose problems with your application.
   113  */
   114 extern DECLSPEC void SDL_SetMainReady(void);
   115 
   116 #ifdef __WIN32__
   117 
   118 /**
   119  *  This can be called to set the application class at startup
   120  */
   121 extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style,
   122                                             void *hInst);
   123 extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);
   124 
   125 #endif /* __WIN32__ */
   126 
   127 
   128 #ifdef __cplusplus
   129 }
   130 #endif
   131 #include "close_code.h"
   132 
   133 #endif /* _SDL_main_h */
   134 
   135 /* vi: set ts=4 sw=4 expandtab: */