src/events/SDL_mouse.c
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Sun, 08 Feb 2015 21:25:37 +0100
changeset 9334 5eb5ab33286e
parent 9257 6f41196c2d6b
child 9448 3d3ed3a5ba8d
permissions -rw-r--r--
Fixed three memory leaks on failed allocation.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 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
*/
icculus@8093
    21
#include "../SDL_internal.h"
slouken@0
    22
slouken@0
    23
/* General mouse handling code for SDL */
slouken@0
    24
slouken@6666
    25
#include "SDL_assert.h"
slouken@8071
    26
#include "SDL_hints.h"
slouken@8066
    27
#include "SDL_timer.h"
slouken@0
    28
#include "SDL_events.h"
slouken@0
    29
#include "SDL_events_c.h"
slouken@1895
    30
#include "default_cursor.h"
slouken@3685
    31
#include "../video/SDL_sysvideo.h"
slouken@0
    32
gabomdq@7678
    33
/* #define DEBUG_MOUSE */
slouken@0
    34
slouken@5371
    35
/* The mouse state */
slouken@4465
    36
static SDL_Mouse SDL_mouse;
slouken@8066
    37
static Uint32 SDL_double_click_time = 500;
slouken@8066
    38
static int SDL_double_click_radius = 1;
slouken@0
    39
jorgen@7089
    40
static int
jorgen@7089
    41
SDL_PrivateSendMouseMotion(SDL_Window * window, SDL_MouseID mouseID, int relative, int x, int y);
slouken@0
    42
slouken@0
    43
/* Public functions */
slouken@1895
    44
int
slouken@1895
    45
SDL_MouseInit(void)
slouken@0
    46
{
slouken@5376
    47
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@5376
    48
slouken@5376
    49
    mouse->cursor_shown = SDL_TRUE;
slouken@5376
    50
slouken@1895
    51
    return (0);
slouken@1123
    52
}
slouken@0
    53
slouken@5405
    54
void
slouken@5405
    55
SDL_SetDefaultCursor(SDL_Cursor * cursor)
slouken@5405
    56
{
slouken@5405
    57
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@5405
    58
slouken@5405
    59
    mouse->def_cursor = cursor;
slouken@5405
    60
    if (!mouse->cur_cursor) {
slouken@5405
    61
        SDL_SetCursor(cursor);
slouken@5405
    62
    }
slouken@5405
    63
}
slouken@5405
    64
slouken@5371
    65
SDL_Mouse *
slouken@5371
    66
SDL_GetMouse(void)
slouken@5371
    67
{
slouken@5371
    68
    return &SDL_mouse;
slouken@5371
    69
}
slouken@5371
    70
slouken@8066
    71
void
slouken@8066
    72
SDL_SetDoubleClickTime(Uint32 interval)
slouken@8066
    73
{
slouken@8066
    74
    SDL_double_click_time = interval;
slouken@8066
    75
}
slouken@8066
    76
slouken@4465
    77
SDL_Window *
slouken@4465
    78
SDL_GetMouseFocus(void)
slouken@2710
    79
{
slouken@5371
    80
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@2940
    81
slouken@4465
    82
    return mouse->focus;
slouken@0
    83
}
slouken@0
    84
slouken@1895
    85
void
slouken@6666
    86
SDL_ResetMouse(void)
slouken@6666
    87
{
slouken@6666
    88
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@6666
    89
    Uint8 i;
slouken@6666
    90
slouken@6666
    91
#ifdef DEBUG_MOUSE
slouken@6666
    92
    printf("Resetting mouse\n");
slouken@6666
    93
#endif
slouken@6666
    94
    for (i = 1; i <= sizeof(mouse->buttonstate)*8; ++i) {
slouken@6666
    95
        if (mouse->buttonstate & SDL_BUTTON(i)) {
slouken@6950
    96
            SDL_SendMouseButton(mouse->focus, mouse->mouseID, SDL_RELEASED, i);
slouken@6666
    97
        }
slouken@6666
    98
    }
slouken@6666
    99
    SDL_assert(mouse->buttonstate == 0);
slouken@6666
   100
}
slouken@6666
   101
slouken@6666
   102
void
slouken@4465
   103
SDL_SetMouseFocus(SDL_Window * window)
slouken@0
   104
{
slouken@5371
   105
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   106
slouken@4465
   107
    if (mouse->focus == window) {
slouken@1895
   108
        return;
slouken@1895
   109
    }
slouken@1895
   110
slouken@6829
   111
    /* Actually, this ends up being a bad idea, because most operating
slouken@6829
   112
       systems have an implicit grab when you press the mouse button down
slouken@6829
   113
       so you can drag things out of the window and then get the mouse up
slouken@6829
   114
       when it happens.  So, #if 0...
slouken@6829
   115
    */
slouken@6829
   116
#if 0
slouken@6666
   117
    if (mouse->focus && !window) {
slouken@6666
   118
        /* We won't get anymore mouse messages, so reset mouse state */
slouken@6666
   119
        SDL_ResetMouse();
slouken@6666
   120
    }
slouken@6829
   121
#endif
slouken@6666
   122
slouken@1895
   123
    /* See if the current window has lost focus */
slouken@1895
   124
    if (mouse->focus) {
slouken@4465
   125
        SDL_SendWindowEvent(mouse->focus, SDL_WINDOWEVENT_LEAVE, 0, 0);
slouken@1895
   126
    }
slouken@1895
   127
slouken@3685
   128
    mouse->focus = window;
slouken@1895
   129
slouken@1895
   130
    if (mouse->focus) {
slouken@4465
   131
        SDL_SendWindowEvent(mouse->focus, SDL_WINDOWEVENT_ENTER, 0, 0);
slouken@1895
   132
    }
slouken@6666
   133
slouken@6666
   134
    /* Update cursor visibility */
slouken@6666
   135
    SDL_SetCursor(NULL);
slouken@6666
   136
}
slouken@6666
   137
slouken@6666
   138
/* Check to see if we need to synthesize focus events */
slouken@6666
   139
static SDL_bool
slouken@6673
   140
SDL_UpdateMouseFocus(SDL_Window * window, int x, int y, Uint32 buttonstate)
slouken@6666
   141
{
slouken@6666
   142
    SDL_Mouse *mouse = SDL_GetMouse();
icculus@8927
   143
    SDL_bool inWindow = SDL_TRUE;
slouken@6666
   144
slouken@8983
   145
    if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
icculus@8927
   146
        int w, h;
icculus@8927
   147
        SDL_GetWindowSize(window, &w, &h);
icculus@8927
   148
        if (x < 0 || y < 0 || x >= w || y >= h) {
icculus@8927
   149
            inWindow = SDL_FALSE;
icculus@8927
   150
        }
slouken@6666
   151
    }
slouken@6667
   152
icculus@8783
   153
/* Linux doesn't give you mouse events outside your window unless you grab
icculus@8783
   154
   the pointer.
icculus@8783
   155
icculus@8783
   156
   Windows doesn't give you mouse events outside your window unless you call
icculus@8783
   157
   SetCapture().
icculus@8783
   158
icculus@8783
   159
   Both of these are slightly scary changes, so for now we'll punt and if the
icculus@8783
   160
   mouse leaves the window you'll lose mouse focus and reset button state.
icculus@8783
   161
*/
icculus@8783
   162
#ifdef SUPPORT_DRAG_OUTSIDE_WINDOW
icculus@8783
   163
    if (!inWindow && !buttonstate) {
icculus@8783
   164
#else
slouken@6667
   165
    if (!inWindow) {
icculus@8783
   166
#endif
slouken@6666
   167
        if (window == mouse->focus) {
slouken@6666
   168
#ifdef DEBUG_MOUSE
jorgen@7089
   169
            printf("Mouse left window, synthesizing move & focus lost event\n");
slouken@6666
   170
#endif
jorgen@7089
   171
            SDL_PrivateSendMouseMotion(window, mouse->mouseID, 0, x, y);
slouken@6666
   172
            SDL_SetMouseFocus(NULL);
slouken@6666
   173
        }
slouken@6666
   174
        return SDL_FALSE;
slouken@6666
   175
    }
slouken@6666
   176
slouken@6666
   177
    if (window != mouse->focus) {
slouken@6666
   178
#ifdef DEBUG_MOUSE
jorgen@7097
   179
         printf("Mouse entered window, synthesizing focus gain & move event\n");
slouken@6666
   180
#endif
jorgen@7097
   181
         SDL_SetMouseFocus(window);
jorgen@7097
   182
         SDL_PrivateSendMouseMotion(window, mouse->mouseID, 0, x, y);
slouken@6666
   183
    }
slouken@6666
   184
    return SDL_TRUE;
slouken@1895
   185
}
slouken@1895
   186
slouken@1895
   187
int
slouken@6950
   188
SDL_SendMouseMotion(SDL_Window * window, SDL_MouseID mouseID, int relative, int x, int y)
slouken@1895
   189
{
jorgen@7089
   190
    if (window && !relative) {
jorgen@7089
   191
        SDL_Mouse *mouse = SDL_GetMouse();
jorgen@7089
   192
        if (!SDL_UpdateMouseFocus(window, x, y, mouse->buttonstate)) {
jorgen@7089
   193
            return 0;
jorgen@7089
   194
        }
jorgen@7089
   195
    }
jorgen@7089
   196
jorgen@7089
   197
    return SDL_PrivateSendMouseMotion(window, mouseID, relative, x, y);
jorgen@7089
   198
}
jorgen@7089
   199
jorgen@7089
   200
static int
jorgen@7089
   201
SDL_PrivateSendMouseMotion(SDL_Window * window, SDL_MouseID mouseID, int relative, int x, int y)
jorgen@7089
   202
{
slouken@5371
   203
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   204
    int posted;
slouken@1895
   205
    int xrel;
slouken@1895
   206
    int yrel;
slouken@1895
   207
slouken@8071
   208
    if (mouse->relative_mode_warp) {
slouken@8071
   209
        int center_x = 0, center_y = 0;
slouken@8071
   210
        SDL_GetWindowSize(window, &center_x, &center_y);
slouken@8071
   211
        center_x /= 2;
slouken@8071
   212
        center_y /= 2;
slouken@8071
   213
        if (x == center_x && y == center_y) {
slouken@8071
   214
            mouse->last_x = center_x;
slouken@8071
   215
            mouse->last_y = center_y;
slouken@8071
   216
            return 0;
slouken@8071
   217
        }
slouken@8071
   218
        SDL_WarpMouseInWindow(window, center_x, center_y);
slouken@8071
   219
    }
slouken@8071
   220
slouken@2842
   221
    if (relative) {
slouken@2842
   222
        xrel = x;
slouken@2842
   223
        yrel = y;
slouken@8071
   224
        x = (mouse->last_x + xrel);
slouken@8071
   225
        y = (mouse->last_y + yrel);
slouken@2842
   226
    } else {
slouken@2860
   227
        xrel = x - mouse->last_x;
slouken@2860
   228
        yrel = y - mouse->last_y;
slouken@2842
   229
    }
slouken@2710
   230
slouken@1895
   231
    /* Drop events that don't change state */
slouken@1895
   232
    if (!xrel && !yrel) {
slouken@6666
   233
#ifdef DEBUG_MOUSE
slouken@1895
   234
        printf("Mouse event didn't change state - dropped!\n");
slouken@1895
   235
#endif
slouken@1895
   236
        return 0;
slouken@1895
   237
    }
slouken@1895
   238
slouken@2710
   239
    /* Update internal mouse coordinates */
slouken@8071
   240
    if (!mouse->relative_mode) {
slouken@1895
   241
        mouse->x = x;
slouken@1895
   242
        mouse->y = y;
slouken@2710
   243
    } else {
slouken@2860
   244
        mouse->x += xrel;
slouken@2860
   245
        mouse->y += yrel;
slouken@2860
   246
    }
slouken@2849
   247
icculus@8927
   248
    /* make sure that the pointers find themselves inside the windows,
icculus@8927
   249
       unless we have the mouse captured. */
slouken@8983
   250
    if (window && ((window->flags & SDL_WINDOW_MOUSE_CAPTURE) == 0)) {
icculus@8927
   251
        int x_max = 0, y_max = 0;
slouken@2849
   252
icculus@8927
   253
        // !!! FIXME: shouldn't this be (window) instead of (mouse->focus)?
icculus@8927
   254
        SDL_GetWindowSize(mouse->focus, &x_max, &y_max);
icculus@8927
   255
        --x_max;
icculus@8927
   256
        --y_max;
slouken@2860
   257
icculus@8927
   258
        if (mouse->x > x_max) {
icculus@8927
   259
            mouse->x = x_max;
icculus@8927
   260
        }
icculus@8927
   261
        if (mouse->x < 0) {
icculus@8927
   262
            mouse->x = 0;
icculus@8927
   263
        }
icculus@8927
   264
icculus@8927
   265
        if (mouse->y > y_max) {
icculus@8927
   266
            mouse->y = y_max;
icculus@8927
   267
        }
icculus@8927
   268
        if (mouse->y < 0) {
icculus@8927
   269
            mouse->y = 0;
icculus@8927
   270
        }
slouken@2860
   271
    }
slouken@2860
   272
slouken@1895
   273
    mouse->xdelta += xrel;
slouken@1895
   274
    mouse->ydelta += yrel;
slouken@1895
   275
slouken@1895
   276
    /* Move the mouse cursor, if needed */
slouken@1895
   277
    if (mouse->cursor_shown && !mouse->relative_mode &&
slouken@1895
   278
        mouse->MoveCursor && mouse->cur_cursor) {
slouken@1895
   279
        mouse->MoveCursor(mouse->cur_cursor);
slouken@1895
   280
    }
slouken@1895
   281
slouken@1895
   282
    /* Post the event, if desired */
slouken@1895
   283
    posted = 0;
slouken@4465
   284
    if (SDL_GetEventState(SDL_MOUSEMOTION) == SDL_ENABLE) {
slouken@1895
   285
        SDL_Event event;
slouken@1895
   286
        event.motion.type = SDL_MOUSEMOTION;
slouken@4465
   287
        event.motion.windowID = mouse->focus ? mouse->focus->id : 0;
slouken@6950
   288
        event.motion.which = mouseID;
slouken@1895
   289
        event.motion.state = mouse->buttonstate;
slouken@1895
   290
        event.motion.x = mouse->x;
slouken@1895
   291
        event.motion.y = mouse->y;
slouken@1895
   292
        event.motion.xrel = xrel;
slouken@1895
   293
        event.motion.yrel = yrel;
slouken@1895
   294
        posted = (SDL_PushEvent(&event) > 0);
slouken@1895
   295
    }
slouken@6666
   296
    /* Use unclamped values if we're getting events outside the window */
slouken@6666
   297
    mouse->last_x = x;
slouken@6666
   298
    mouse->last_y = y;
slouken@1895
   299
    return posted;
slouken@1895
   300
}
slouken@1895
   301
slouken@8066
   302
static SDL_MouseClickState *GetMouseClickState(SDL_Mouse *mouse, Uint8 button)
slouken@8066
   303
{
slouken@8066
   304
    if (button >= mouse->num_clickstates) {
slouken@8066
   305
        int i, count = button + 1;
philipp@9334
   306
        SDL_MouseClickState *clickstate = (SDL_MouseClickState *)SDL_realloc(mouse->clickstate, count * sizeof(*mouse->clickstate));
philipp@9334
   307
        if (!clickstate) {
slouken@8066
   308
            return NULL;
slouken@8066
   309
        }
philipp@9334
   310
        mouse->clickstate = clickstate;
slouken@8066
   311
slouken@8066
   312
        for (i = mouse->num_clickstates; i < count; ++i) {
slouken@8066
   313
            SDL_zero(mouse->clickstate[i]);
slouken@8066
   314
        }
slouken@8066
   315
        mouse->num_clickstates = count;
slouken@8066
   316
    }
slouken@8066
   317
    return &mouse->clickstate[button];
slouken@8066
   318
}
slouken@8066
   319
slouken@1895
   320
int
slouken@6950
   321
SDL_SendMouseButton(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button)
slouken@1895
   322
{
slouken@5371
   323
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   324
    int posted;
slouken@4429
   325
    Uint32 type;
slouken@6673
   326
    Uint32 buttonstate = mouse->buttonstate;
slouken@8066
   327
    SDL_MouseClickState *clickstate = GetMouseClickState(mouse, button);
slouken@8066
   328
    Uint8 click_count;
slouken@4484
   329
slouken@1895
   330
    /* Figure out which event to perform */
slouken@1895
   331
    switch (state) {
slouken@1895
   332
    case SDL_PRESSED:
slouken@1895
   333
        type = SDL_MOUSEBUTTONDOWN;
slouken@6666
   334
        buttonstate |= SDL_BUTTON(button);
slouken@1895
   335
        break;
slouken@1895
   336
    case SDL_RELEASED:
slouken@1895
   337
        type = SDL_MOUSEBUTTONUP;
slouken@6666
   338
        buttonstate &= ~SDL_BUTTON(button);
slouken@1895
   339
        break;
slouken@1895
   340
    default:
slouken@1895
   341
        /* Invalid state -- bail */
slouken@1895
   342
        return 0;
slouken@1895
   343
    }
slouken@1895
   344
slouken@6666
   345
    /* We do this after calculating buttonstate so button presses gain focus */
slouken@6666
   346
    if (window && state == SDL_PRESSED) {
slouken@6666
   347
        SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
slouken@6666
   348
    }
slouken@6666
   349
slouken@6666
   350
    if (buttonstate == mouse->buttonstate) {
slouken@6666
   351
        /* Ignore this event, no state change */
slouken@6666
   352
        return 0;
slouken@6666
   353
    }
slouken@6666
   354
    mouse->buttonstate = buttonstate;
slouken@6666
   355
slouken@8066
   356
    if (clickstate) {
slouken@8066
   357
        if (state == SDL_PRESSED) {
slouken@8066
   358
            Uint32 now = SDL_GetTicks();
slouken@8066
   359
slouken@8066
   360
            if (SDL_TICKS_PASSED(now, clickstate->last_timestamp + SDL_double_click_time) ||
slouken@8066
   361
                SDL_abs(mouse->x - clickstate->last_x) > SDL_double_click_radius ||
slouken@8066
   362
                SDL_abs(mouse->y - clickstate->last_y) > SDL_double_click_radius) {
slouken@8066
   363
                clickstate->click_count = 0;
slouken@8066
   364
            }
slouken@8066
   365
            clickstate->last_timestamp = now;
slouken@8066
   366
            clickstate->last_x = mouse->x;
slouken@8066
   367
            clickstate->last_y = mouse->y;
slouken@8066
   368
            if (clickstate->click_count < 255) {
slouken@8066
   369
                ++clickstate->click_count;
slouken@8066
   370
            }
slouken@8066
   371
        }
slouken@8066
   372
        click_count = clickstate->click_count;
slouken@8066
   373
    } else {
slouken@8066
   374
        click_count = 1;
slouken@8066
   375
    }
slouken@8066
   376
slouken@1895
   377
    /* Post the event, if desired */
slouken@1895
   378
    posted = 0;
slouken@4429
   379
    if (SDL_GetEventState(type) == SDL_ENABLE) {
slouken@1895
   380
        SDL_Event event;
slouken@1895
   381
        event.type = type;
slouken@6950
   382
        event.button.windowID = mouse->focus ? mouse->focus->id : 0;
slouken@6950
   383
        event.button.which = mouseID;
slouken@1895
   384
        event.button.state = state;
slouken@1895
   385
        event.button.button = button;
slouken@8066
   386
        event.button.clicks = click_count;
slouken@1895
   387
        event.button.x = mouse->x;
slouken@1895
   388
        event.button.y = mouse->y;
slouken@1895
   389
        posted = (SDL_PushEvent(&event) > 0);
slouken@1895
   390
    }
slouken@6666
   391
slouken@6666
   392
    /* We do this after dispatching event so button releases can lose focus */
slouken@6666
   393
    if (window && state == SDL_RELEASED) {
slouken@6666
   394
        SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
slouken@6666
   395
    }
slouken@6666
   396
slouken@1895
   397
    return posted;
slouken@1895
   398
}
slouken@1895
   399
slouken@1895
   400
int
urkle@9257
   401
SDL_SendMouseWheel(SDL_Window * window, SDL_MouseID mouseID, int x, int y, SDL_MouseWheelDirection direction)
slouken@1895
   402
{
slouken@5371
   403
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   404
    int posted;
slouken@1895
   405
slouken@4484
   406
    if (window) {
slouken@4484
   407
        SDL_SetMouseFocus(window);
slouken@4484
   408
    }
slouken@4484
   409
slouken@4465
   410
    if (!x && !y) {
slouken@1895
   411
        return 0;
slouken@1895
   412
    }
slouken@1895
   413
slouken@1895
   414
    /* Post the event, if desired */
slouken@1895
   415
    posted = 0;
slouken@4429
   416
    if (SDL_GetEventState(SDL_MOUSEWHEEL) == SDL_ENABLE) {
slouken@1895
   417
        SDL_Event event;
slouken@1895
   418
        event.type = SDL_MOUSEWHEEL;
slouken@4465
   419
        event.wheel.windowID = mouse->focus ? mouse->focus->id : 0;
slouken@6950
   420
        event.wheel.which = mouseID;
slouken@2152
   421
        event.wheel.x = x;
slouken@2152
   422
        event.wheel.y = y;
urkle@9257
   423
        event.wheel.direction = (Uint32)direction;
slouken@1895
   424
        posted = (SDL_PushEvent(&event) > 0);
slouken@1895
   425
    }
slouken@1895
   426
    return posted;
slouken@1895
   427
}
slouken@1895
   428
slouken@1895
   429
void
slouken@4465
   430
SDL_MouseQuit(void)
slouken@4465
   431
{
slouken@7493
   432
    SDL_Cursor *cursor, *next;
slouken@7493
   433
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@7493
   434
slouken@9161
   435
    if (mouse->CaptureMouse) {
slouken@9161
   436
        SDL_CaptureMouse(SDL_FALSE);
slouken@9161
   437
    }
slouken@8049
   438
    SDL_SetRelativeMouseMode(SDL_FALSE);
slouken@7493
   439
    SDL_ShowCursor(1);
slouken@7493
   440
slouken@7493
   441
    cursor = mouse->cursors;
slouken@7493
   442
    while (cursor) {
slouken@7493
   443
        next = cursor->next;
slouken@7493
   444
        SDL_FreeCursor(cursor);
slouken@7493
   445
        cursor = next;
slouken@7493
   446
    }
slouken@7493
   447
slouken@7493
   448
    if (mouse->def_cursor && mouse->FreeCursor) {
slouken@7493
   449
        mouse->FreeCursor(mouse->def_cursor);
slouken@7493
   450
    }
slouken@7493
   451
slouken@8066
   452
    if (mouse->clickstate) {
slouken@8066
   453
        SDL_free(mouse->clickstate);
slouken@8066
   454
    }
slouken@8066
   455
slouken@7493
   456
    SDL_zerop(mouse);
slouken@4465
   457
}
slouken@4465
   458
slouken@6673
   459
Uint32
slouken@4465
   460
SDL_GetMouseState(int *x, int *y)
slouken@4465
   461
{
slouken@5371
   462
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   463
slouken@4465
   464
    if (x) {
slouken@4465
   465
        *x = mouse->x;
slouken@4465
   466
    }
slouken@4465
   467
    if (y) {
slouken@4465
   468
        *y = mouse->y;
slouken@4465
   469
    }
slouken@4465
   470
    return mouse->buttonstate;
slouken@4465
   471
}
slouken@4465
   472
slouken@6673
   473
Uint32
slouken@4465
   474
SDL_GetRelativeMouseState(int *x, int *y)
slouken@4465
   475
{
slouken@5371
   476
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   477
slouken@4465
   478
    if (x) {
slouken@4465
   479
        *x = mouse->xdelta;
slouken@4465
   480
    }
slouken@4465
   481
    if (y) {
slouken@4465
   482
        *y = mouse->ydelta;
slouken@4465
   483
    }
slouken@4465
   484
    mouse->xdelta = 0;
slouken@4465
   485
    mouse->ydelta = 0;
slouken@4465
   486
    return mouse->buttonstate;
slouken@4465
   487
}
slouken@4465
   488
icculus@8945
   489
Uint32
icculus@8952
   490
SDL_GetGlobalMouseState(int *x, int *y)
icculus@8945
   491
{
icculus@8945
   492
    SDL_Mouse *mouse = SDL_GetMouse();
icculus@8945
   493
    int tmpx, tmpy;
icculus@8945
   494
icculus@8945
   495
    /* make sure these are never NULL for the backend implementations... */
icculus@8945
   496
    if (!x) {
icculus@8945
   497
        x = &tmpx;
icculus@8945
   498
    }
icculus@8945
   499
    if (!y) {
icculus@8945
   500
        y = &tmpy;
icculus@8945
   501
    }
icculus@8945
   502
icculus@8945
   503
    *x = *y = 0;
icculus@8945
   504
icculus@8952
   505
    if (!mouse->GetGlobalMouseState) {
icculus@8945
   506
        SDL_assert(0 && "This should really be implemented for every target.");
icculus@8945
   507
        return 0;
icculus@8945
   508
    }
icculus@8945
   509
icculus@8952
   510
    return mouse->GetGlobalMouseState(x, y);
icculus@8945
   511
}
icculus@8945
   512
slouken@4465
   513
void
slouken@3685
   514
SDL_WarpMouseInWindow(SDL_Window * window, int x, int y)
slouken@1895
   515
{
slouken@5371
   516
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@7191
   517
icculus@8953
   518
    if (window == NULL) {
slouken@7191
   519
        window = mouse->focus;
icculus@8944
   520
    }
slouken@7191
   521
icculus@8953
   522
    if (window == NULL) {
slouken@7191
   523
        return;
icculus@8944
   524
    }
slouken@1895
   525
slouken@1895
   526
    if (mouse->WarpMouse) {
slouken@5371
   527
        mouse->WarpMouse(window, x, y);
slouken@1895
   528
    } else {
slouken@6950
   529
        SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
slouken@1895
   530
    }
slouken@1895
   531
}
slouken@1895
   532
slouken@8815
   533
void
slouken@8815
   534
SDL_WarpMouseGlobal(int x, int y)
slouken@8815
   535
{
slouken@8815
   536
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@8815
   537
slouken@8815
   538
    if (mouse->WarpMouseGlobal) {
slouken@8815
   539
        mouse->WarpMouseGlobal(x, y);
slouken@8815
   540
    }
slouken@8815
   541
}
slouken@8815
   542
slouken@8071
   543
static SDL_bool
slouken@8071
   544
ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
slouken@8071
   545
{
slouken@8071
   546
    const char *hint;
slouken@8071
   547
slouken@8071
   548
    if (!mouse->SetRelativeMouseMode) {
slouken@8071
   549
        return SDL_TRUE;
slouken@8071
   550
    }
slouken@8071
   551
slouken@8071
   552
    hint = SDL_GetHint(SDL_HINT_MOUSE_RELATIVE_MODE_WARP);
slouken@8071
   553
    if (hint) {
slouken@8071
   554
        if (*hint == '0') {
slouken@8071
   555
            return SDL_FALSE;
slouken@8071
   556
        } else {
slouken@8071
   557
            return SDL_TRUE;
slouken@8071
   558
        }
slouken@8071
   559
    }
slouken@8071
   560
    return SDL_FALSE;
slouken@8071
   561
}
slouken@8071
   562
slouken@4465
   563
int
slouken@4465
   564
SDL_SetRelativeMouseMode(SDL_bool enabled)
slouken@4465
   565
{
slouken@5371
   566
    SDL_Mouse *mouse = SDL_GetMouse();
jorgen@7107
   567
    SDL_Window *focusWindow = SDL_GetKeyboardFocus();
slouken@4465
   568
slouken@5406
   569
    if (enabled == mouse->relative_mode) {
slouken@5406
   570
        return 0;
slouken@5406
   571
    }
slouken@5406
   572
jorgen@7107
   573
    if (enabled && focusWindow) {
jorgen@7107
   574
        /* Center it in the focused window to prevent clicks from going through
jorgen@7107
   575
         * to background windows.
jorgen@7107
   576
         */
jorgen@7107
   577
        SDL_SetMouseFocus(focusWindow);
jorgen@7107
   578
        SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
jorgen@7107
   579
    }
jorgen@7107
   580
slouken@8071
   581
    /* Set the relative mode */
slouken@8071
   582
    if (!enabled && mouse->relative_mode_warp) {
slouken@8071
   583
        mouse->relative_mode_warp = SDL_FALSE;
slouken@8071
   584
    } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
slouken@8071
   585
        mouse->relative_mode_warp = SDL_TRUE;
slouken@8071
   586
    } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
slouken@8269
   587
        if (enabled) {
philipp@8776
   588
            /* Fall back to warp mode if native relative mode failed */
slouken@8269
   589
            mouse->relative_mode_warp = SDL_TRUE;
slouken@8269
   590
        }
slouken@5406
   591
    }
slouken@4465
   592
    mouse->relative_mode = enabled;
slouken@4465
   593
slouken@8071
   594
    if (mouse->focus) {
slouken@8071
   595
        SDL_UpdateWindowGrab(mouse->focus);
slouken@8071
   596
slouken@8071
   597
        /* Put the cursor back to where the application expects it */
slouken@8071
   598
        if (!enabled) {
slouken@8071
   599
            SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
slouken@8071
   600
        }
slouken@4465
   601
    }
slouken@4465
   602
slouken@8071
   603
    /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
slouken@5406
   604
    SDL_FlushEvent(SDL_MOUSEMOTION);
slouken@5406
   605
slouken@4465
   606
    /* Update cursor visibility */
slouken@4465
   607
    SDL_SetCursor(NULL);
slouken@4465
   608
slouken@4465
   609
    return 0;
slouken@4465
   610
}
slouken@4465
   611
slouken@4465
   612
SDL_bool
slouken@4465
   613
SDL_GetRelativeMouseMode()
slouken@4465
   614
{
slouken@5371
   615
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   616
slouken@4465
   617
    return mouse->relative_mode;
slouken@4465
   618
}
slouken@4465
   619
icculus@8955
   620
int
icculus@8955
   621
SDL_CaptureMouse(SDL_bool enabled)
icculus@8955
   622
{
icculus@8955
   623
    SDL_Mouse *mouse = SDL_GetMouse();
icculus@8955
   624
    SDL_Window *focusWindow;
icculus@8955
   625
    SDL_bool isCaptured;
icculus@8955
   626
icculus@8955
   627
    if (!mouse->CaptureMouse) {
icculus@8955
   628
        return SDL_Unsupported();
icculus@8955
   629
    }
icculus@8955
   630
icculus@8955
   631
    focusWindow = SDL_GetKeyboardFocus();
icculus@8955
   632
icculus@8955
   633
    isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
icculus@8955
   634
    if (isCaptured == enabled) {
icculus@8955
   635
        return 0;  /* already done! */
icculus@8955
   636
    }
icculus@8955
   637
icculus@8955
   638
    if (enabled) {
icculus@8955
   639
        if (!focusWindow) {
icculus@8955
   640
            return SDL_SetError("No window has focus");
icculus@8955
   641
        } else if (mouse->CaptureMouse(focusWindow) == -1) {
icculus@8955
   642
            return -1;  /* CaptureMouse() should call SetError */
icculus@8955
   643
        }
icculus@8955
   644
        focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
icculus@8955
   645
    } else {
icculus@8955
   646
        if (mouse->CaptureMouse(NULL) == -1) {
icculus@8955
   647
            return -1;  /* CaptureMouse() should call SetError */
icculus@8955
   648
        }
icculus@8955
   649
        focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
icculus@8955
   650
    }
icculus@8955
   651
icculus@8955
   652
    return 0;
icculus@8955
   653
}
icculus@8955
   654
slouken@1895
   655
SDL_Cursor *
slouken@1895
   656
SDL_CreateCursor(const Uint8 * data, const Uint8 * mask,
slouken@1895
   657
                 int w, int h, int hot_x, int hot_y)
slouken@1895
   658
{
slouken@1895
   659
    SDL_Surface *surface;
slouken@1895
   660
    SDL_Cursor *cursor;
slouken@1895
   661
    int x, y;
slouken@1895
   662
    Uint32 *pixel;
slouken@4465
   663
    Uint8 datab = 0, maskb = 0;
slouken@1895
   664
    const Uint32 black = 0xFF000000;
slouken@1895
   665
    const Uint32 white = 0xFFFFFFFF;
slouken@1895
   666
    const Uint32 transparent = 0x00000000;
slouken@1895
   667
slouken@1895
   668
    /* Make sure the width is a multiple of 8 */
slouken@1895
   669
    w = ((w + 7) & ~7);
slouken@1895
   670
slouken@1895
   671
    /* Create the surface from a bitmap */
slouken@5473
   672
    surface = SDL_CreateRGBSurface(0, w, h, 32,
slouken@5473
   673
                                   0x00FF0000,
slouken@5473
   674
                                   0x0000FF00,
slouken@5473
   675
                                   0x000000FF,
slouken@5473
   676
                                   0xFF000000);
slouken@1895
   677
    if (!surface) {
slouken@1895
   678
        return NULL;
slouken@1895
   679
    }
slouken@1895
   680
    for (y = 0; y < h; ++y) {
slouken@1895
   681
        pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
slouken@1895
   682
        for (x = 0; x < w; ++x) {
slouken@1895
   683
            if ((x % 8) == 0) {
slouken@1895
   684
                datab = *data++;
slouken@1895
   685
                maskb = *mask++;
slouken@1895
   686
            }
slouken@1895
   687
            if (maskb & 0x80) {
slouken@1895
   688
                *pixel++ = (datab & 0x80) ? black : white;
slouken@1895
   689
            } else {
slouken@1895
   690
                *pixel++ = (datab & 0x80) ? black : transparent;
slouken@1895
   691
            }
slouken@1895
   692
            datab <<= 1;
slouken@1895
   693
            maskb <<= 1;
slouken@1895
   694
        }
slouken@1895
   695
    }
slouken@1895
   696
slouken@5473
   697
    cursor = SDL_CreateColorCursor(surface, hot_x, hot_y);
slouken@5473
   698
slouken@5473
   699
    SDL_FreeSurface(surface);
slouken@5473
   700
slouken@5473
   701
    return cursor;
slouken@5473
   702
}
slouken@5473
   703
slouken@5473
   704
SDL_Cursor *
slouken@5473
   705
SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
slouken@5473
   706
{
slouken@5473
   707
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@5473
   708
    SDL_Surface *temp = NULL;
slouken@5473
   709
    SDL_Cursor *cursor;
slouken@5473
   710
slouken@5473
   711
    if (!surface) {
slouken@5473
   712
        SDL_SetError("Passed NULL cursor surface");
slouken@5473
   713
        return NULL;
slouken@5473
   714
    }
slouken@5473
   715
slouken@5473
   716
    if (!mouse->CreateCursor) {
slouken@5473
   717
        SDL_SetError("Cursors are not currently supported");
slouken@5473
   718
        return NULL;
slouken@5473
   719
    }
slouken@5473
   720
slouken@5473
   721
    /* Sanity check the hot spot */
slouken@5473
   722
    if ((hot_x < 0) || (hot_y < 0) ||
slouken@5473
   723
        (hot_x >= surface->w) || (hot_y >= surface->h)) {
slouken@5473
   724
        SDL_SetError("Cursor hot spot doesn't lie within cursor");
slouken@5473
   725
        return NULL;
slouken@5473
   726
    }
slouken@5473
   727
slouken@5473
   728
    if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
slouken@5473
   729
        temp = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_ARGB8888, 0);
slouken@5473
   730
        if (!temp) {
slouken@5473
   731
            return NULL;
slouken@5473
   732
        }
slouken@5473
   733
        surface = temp;
slouken@5473
   734
    }
slouken@5473
   735
slouken@1895
   736
    cursor = mouse->CreateCursor(surface, hot_x, hot_y);
slouken@1895
   737
    if (cursor) {
slouken@1895
   738
        cursor->next = mouse->cursors;
slouken@1895
   739
        mouse->cursors = cursor;
slouken@1895
   740
    }
slouken@1895
   741
slouken@7720
   742
    SDL_FreeSurface(temp);
slouken@1895
   743
slouken@1895
   744
    return cursor;
slouken@1895
   745
}
slouken@1895
   746
mikesart@6675
   747
SDL_Cursor *
mikesart@6675
   748
SDL_CreateSystemCursor(SDL_SystemCursor id)
mikesart@6675
   749
{
mikesart@6675
   750
    SDL_Mouse *mouse = SDL_GetMouse();
mikesart@6675
   751
    SDL_Cursor *cursor;
mikesart@6675
   752
mikesart@6675
   753
    if (!mouse->CreateSystemCursor) {
mikesart@6675
   754
        SDL_SetError("CreateSystemCursor is not currently supported");
mikesart@6675
   755
        return NULL;
mikesart@6675
   756
    }
mikesart@6675
   757
slouken@7191
   758
    cursor = mouse->CreateSystemCursor(id);
mikesart@6675
   759
    if (cursor) {
mikesart@6675
   760
        cursor->next = mouse->cursors;
mikesart@6675
   761
        mouse->cursors = cursor;
mikesart@6675
   762
    }
mikesart@6675
   763
slouken@7191
   764
    return cursor;
mikesart@6675
   765
}
mikesart@6675
   766
slouken@1895
   767
/* SDL_SetCursor(NULL) can be used to force the cursor redraw,
slouken@1895
   768
   if this is desired for any reason.  This is used when setting
slouken@1895
   769
   the video mode and when the SDL window gains the mouse focus.
slouken@1895
   770
 */
slouken@1895
   771
void
slouken@1895
   772
SDL_SetCursor(SDL_Cursor * cursor)
slouken@1895
   773
{
slouken@5371
   774
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   775
slouken@1895
   776
    /* Set the new cursor */
slouken@1895
   777
    if (cursor) {
slouken@1895
   778
        /* Make sure the cursor is still valid for this mouse */
slouken@5405
   779
        if (cursor != mouse->def_cursor) {
slouken@5405
   780
            SDL_Cursor *found;
slouken@5405
   781
            for (found = mouse->cursors; found; found = found->next) {
slouken@5405
   782
                if (found == cursor) {
slouken@5405
   783
                    break;
slouken@5405
   784
                }
slouken@1895
   785
            }
slouken@5405
   786
            if (!found) {
slouken@5405
   787
                SDL_SetError("Cursor not associated with the current mouse");
slouken@5405
   788
                return;
slouken@5405
   789
            }
slouken@1895
   790
        }
slouken@1895
   791
        mouse->cur_cursor = cursor;
slouken@1895
   792
    } else {
ghostunderscore@6301
   793
        if (mouse->focus) {
ghostunderscore@6301
   794
            cursor = mouse->cur_cursor;
ghostunderscore@6301
   795
        } else {
ghostunderscore@6301
   796
            cursor = mouse->def_cursor;
ghostunderscore@6301
   797
        }
slouken@1895
   798
    }
slouken@1895
   799
slouken@1895
   800
    if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
slouken@1895
   801
        if (mouse->ShowCursor) {
slouken@1895
   802
            mouse->ShowCursor(cursor);
slouken@1895
   803
        }
slouken@1895
   804
    } else {
slouken@1895
   805
        if (mouse->ShowCursor) {
slouken@1895
   806
            mouse->ShowCursor(NULL);
slouken@1895
   807
        }
slouken@1895
   808
    }
slouken@1895
   809
}
slouken@1895
   810
slouken@1895
   811
SDL_Cursor *
slouken@1895
   812
SDL_GetCursor(void)
slouken@1895
   813
{
slouken@5371
   814
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   815
slouken@1895
   816
    if (!mouse) {
slouken@1895
   817
        return NULL;
slouken@1895
   818
    }
slouken@1895
   819
    return mouse->cur_cursor;
slouken@1895
   820
}
slouken@1895
   821
jorgen@7104
   822
SDL_Cursor *
jorgen@7104
   823
SDL_GetDefaultCursor(void)
jorgen@7104
   824
{
jorgen@7104
   825
    SDL_Mouse *mouse = SDL_GetMouse();
jorgen@7104
   826
jorgen@7104
   827
    if (!mouse) {
jorgen@7104
   828
        return NULL;
jorgen@7104
   829
    }
jorgen@7104
   830
    return mouse->def_cursor;
jorgen@7104
   831
}
jorgen@7104
   832
slouken@1895
   833
void
slouken@1895
   834
SDL_FreeCursor(SDL_Cursor * cursor)
slouken@1895
   835
{
slouken@5371
   836
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   837
    SDL_Cursor *curr, *prev;
slouken@1895
   838
slouken@1895
   839
    if (!cursor) {
slouken@1895
   840
        return;
slouken@1895
   841
    }
slouken@1895
   842
slouken@1895
   843
    if (cursor == mouse->def_cursor) {
slouken@1895
   844
        return;
slouken@1895
   845
    }
slouken@1895
   846
    if (cursor == mouse->cur_cursor) {
slouken@1895
   847
        SDL_SetCursor(mouse->def_cursor);
slouken@1895
   848
    }
slouken@1895
   849
slouken@1895
   850
    for (prev = NULL, curr = mouse->cursors; curr;
slouken@1895
   851
         prev = curr, curr = curr->next) {
slouken@1895
   852
        if (curr == cursor) {
slouken@1895
   853
            if (prev) {
slouken@1895
   854
                prev->next = curr->next;
slouken@1895
   855
            } else {
slouken@1895
   856
                mouse->cursors = curr->next;
slouken@1895
   857
            }
slouken@1895
   858
slouken@1895
   859
            if (mouse->FreeCursor) {
slouken@1895
   860
                mouse->FreeCursor(curr);
slouken@1895
   861
            }
slouken@1895
   862
            return;
slouken@1895
   863
        }
slouken@1895
   864
    }
slouken@1895
   865
}
slouken@1895
   866
slouken@1895
   867
int
slouken@1895
   868
SDL_ShowCursor(int toggle)
slouken@1895
   869
{
slouken@5371
   870
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   871
    SDL_bool shown;
slouken@1895
   872
slouken@1895
   873
    if (!mouse) {
slouken@1895
   874
        return 0;
slouken@1895
   875
    }
slouken@1895
   876
slouken@1895
   877
    shown = mouse->cursor_shown;
slouken@1895
   878
    if (toggle >= 0) {
slouken@1895
   879
        if (toggle) {
slouken@1895
   880
            mouse->cursor_shown = SDL_TRUE;
slouken@1895
   881
        } else {
slouken@1895
   882
            mouse->cursor_shown = SDL_FALSE;
slouken@1895
   883
        }
slouken@1895
   884
        if (mouse->cursor_shown != shown) {
slouken@1895
   885
            SDL_SetCursor(NULL);
slouken@1895
   886
        }
slouken@1895
   887
    }
slouken@1895
   888
    return shown;
slouken@1895
   889
}
slouken@1895
   890
jorgen@7097
   891
/* vi: set ts=4 sw=4 expandtab: */