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