src/events/SDL_mouse.c
author Sam Lantinga <slouken@libsdl.org>
Fri, 07 Oct 2016 23:40:44 -0700
changeset 10499 363c1c7e7a41
parent 10390 420482621a34
child 10609 d702ecbd8ba7
permissions -rw-r--r--
Implemented SDL_GetHintBoolean() to make it easier to check boolean hints
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@9998
     3
  Copyright (C) 1997-2016 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@9448
   296
    if (relative) {
slouken@9448
   297
        mouse->last_x = mouse->x;
slouken@9448
   298
        mouse->last_y = mouse->y;
slouken@9448
   299
    } else {
slouken@9448
   300
        /* Use unclamped values if we're getting events outside the window */
slouken@9448
   301
        mouse->last_x = x;
slouken@9448
   302
        mouse->last_y = y;
slouken@9448
   303
    }
slouken@1895
   304
    return posted;
slouken@1895
   305
}
slouken@1895
   306
slouken@8066
   307
static SDL_MouseClickState *GetMouseClickState(SDL_Mouse *mouse, Uint8 button)
slouken@8066
   308
{
slouken@8066
   309
    if (button >= mouse->num_clickstates) {
slouken@8066
   310
        int i, count = button + 1;
philipp@9334
   311
        SDL_MouseClickState *clickstate = (SDL_MouseClickState *)SDL_realloc(mouse->clickstate, count * sizeof(*mouse->clickstate));
philipp@9334
   312
        if (!clickstate) {
slouken@8066
   313
            return NULL;
slouken@8066
   314
        }
philipp@9334
   315
        mouse->clickstate = clickstate;
slouken@8066
   316
slouken@8066
   317
        for (i = mouse->num_clickstates; i < count; ++i) {
slouken@8066
   318
            SDL_zero(mouse->clickstate[i]);
slouken@8066
   319
        }
slouken@8066
   320
        mouse->num_clickstates = count;
slouken@8066
   321
    }
slouken@8066
   322
    return &mouse->clickstate[button];
slouken@8066
   323
}
slouken@8066
   324
slime73@10366
   325
static int
slime73@10366
   326
SDL_PrivateSendMouseButton(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button, int clicks)
slouken@1895
   327
{
slouken@5371
   328
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   329
    int posted;
slouken@4429
   330
    Uint32 type;
slouken@6673
   331
    Uint32 buttonstate = mouse->buttonstate;
slouken@4484
   332
slouken@1895
   333
    /* Figure out which event to perform */
slouken@1895
   334
    switch (state) {
slouken@1895
   335
    case SDL_PRESSED:
slouken@1895
   336
        type = SDL_MOUSEBUTTONDOWN;
slouken@6666
   337
        buttonstate |= SDL_BUTTON(button);
slouken@1895
   338
        break;
slouken@1895
   339
    case SDL_RELEASED:
slouken@1895
   340
        type = SDL_MOUSEBUTTONUP;
slouken@6666
   341
        buttonstate &= ~SDL_BUTTON(button);
slouken@1895
   342
        break;
slouken@1895
   343
    default:
slouken@1895
   344
        /* Invalid state -- bail */
slouken@1895
   345
        return 0;
slouken@1895
   346
    }
slouken@1895
   347
slouken@6666
   348
    /* We do this after calculating buttonstate so button presses gain focus */
slouken@6666
   349
    if (window && state == SDL_PRESSED) {
slouken@6666
   350
        SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
slouken@6666
   351
    }
slouken@6666
   352
slouken@6666
   353
    if (buttonstate == mouse->buttonstate) {
slouken@6666
   354
        /* Ignore this event, no state change */
slouken@6666
   355
        return 0;
slouken@6666
   356
    }
slouken@6666
   357
    mouse->buttonstate = buttonstate;
slouken@6666
   358
slime73@10366
   359
    if (clicks < 0) {
slime73@10366
   360
        SDL_MouseClickState *clickstate = GetMouseClickState(mouse, button);
philipp@10390
   361
        if (clickstate) {
philipp@10390
   362
            if (state == SDL_PRESSED) {
philipp@10390
   363
                Uint32 now = SDL_GetTicks();
slouken@8066
   364
philipp@10390
   365
                if (SDL_TICKS_PASSED(now, clickstate->last_timestamp + SDL_double_click_time) ||
philipp@10390
   366
                    SDL_abs(mouse->x - clickstate->last_x) > SDL_double_click_radius ||
philipp@10390
   367
                    SDL_abs(mouse->y - clickstate->last_y) > SDL_double_click_radius) {
philipp@10390
   368
                    clickstate->click_count = 0;
philipp@10390
   369
                }
philipp@10390
   370
                clickstate->last_timestamp = now;
philipp@10390
   371
                clickstate->last_x = mouse->x;
philipp@10390
   372
                clickstate->last_y = mouse->y;
philipp@10390
   373
                if (clickstate->click_count < 255) {
philipp@10390
   374
                    ++clickstate->click_count;
philipp@10390
   375
                }
slouken@8066
   376
            }
philipp@10390
   377
            clicks = clickstate->click_count;
philipp@10390
   378
        } else {
philipp@10390
   379
            clicks = 1;
slouken@8066
   380
        }
slouken@8066
   381
    }
slouken@8066
   382
slouken@1895
   383
    /* Post the event, if desired */
slouken@1895
   384
    posted = 0;
slouken@4429
   385
    if (SDL_GetEventState(type) == SDL_ENABLE) {
slouken@1895
   386
        SDL_Event event;
slouken@1895
   387
        event.type = type;
slouken@6950
   388
        event.button.windowID = mouse->focus ? mouse->focus->id : 0;
slouken@6950
   389
        event.button.which = mouseID;
slouken@1895
   390
        event.button.state = state;
slouken@1895
   391
        event.button.button = button;
slime73@10366
   392
        event.button.clicks = (Uint8) SDL_min(clicks, 255);
slouken@1895
   393
        event.button.x = mouse->x;
slouken@1895
   394
        event.button.y = mouse->y;
slouken@1895
   395
        posted = (SDL_PushEvent(&event) > 0);
slouken@1895
   396
    }
slouken@6666
   397
slouken@6666
   398
    /* We do this after dispatching event so button releases can lose focus */
slouken@6666
   399
    if (window && state == SDL_RELEASED) {
slouken@6666
   400
        SDL_UpdateMouseFocus(window, mouse->x, mouse->y, buttonstate);
slouken@6666
   401
    }
slime73@10366
   402
    
slime73@10366
   403
    return posted;
slime73@10366
   404
}
slouken@6666
   405
slime73@10366
   406
int
slime73@10366
   407
SDL_SendMouseButtonClicks(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button, int clicks)
slime73@10366
   408
{
slime73@10366
   409
    clicks = SDL_max(clicks, 0);
slime73@10366
   410
    return SDL_PrivateSendMouseButton(window, mouseID, state, button, clicks);
slime73@10366
   411
}
slime73@10366
   412
slime73@10366
   413
int
slime73@10366
   414
SDL_SendMouseButton(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button)
slime73@10366
   415
{
slime73@10366
   416
    return SDL_PrivateSendMouseButton(window, mouseID, state, button, -1);
slouken@1895
   417
}
slouken@1895
   418
slouken@1895
   419
int
urkle@9257
   420
SDL_SendMouseWheel(SDL_Window * window, SDL_MouseID mouseID, int x, int y, SDL_MouseWheelDirection direction)
slouken@1895
   421
{
slouken@5371
   422
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   423
    int posted;
slouken@1895
   424
slouken@4484
   425
    if (window) {
slouken@4484
   426
        SDL_SetMouseFocus(window);
slouken@4484
   427
    }
slouken@4484
   428
slouken@4465
   429
    if (!x && !y) {
slouken@1895
   430
        return 0;
slouken@1895
   431
    }
slouken@1895
   432
slouken@1895
   433
    /* Post the event, if desired */
slouken@1895
   434
    posted = 0;
slouken@4429
   435
    if (SDL_GetEventState(SDL_MOUSEWHEEL) == SDL_ENABLE) {
slouken@1895
   436
        SDL_Event event;
slouken@1895
   437
        event.type = SDL_MOUSEWHEEL;
slouken@4465
   438
        event.wheel.windowID = mouse->focus ? mouse->focus->id : 0;
slouken@6950
   439
        event.wheel.which = mouseID;
slouken@2152
   440
        event.wheel.x = x;
slouken@2152
   441
        event.wheel.y = y;
urkle@9257
   442
        event.wheel.direction = (Uint32)direction;
slouken@1895
   443
        posted = (SDL_PushEvent(&event) > 0);
slouken@1895
   444
    }
slouken@1895
   445
    return posted;
slouken@1895
   446
}
slouken@1895
   447
slouken@1895
   448
void
slouken@4465
   449
SDL_MouseQuit(void)
slouken@4465
   450
{
slouken@7493
   451
    SDL_Cursor *cursor, *next;
slouken@7493
   452
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@7493
   453
slouken@9161
   454
    if (mouse->CaptureMouse) {
slouken@9161
   455
        SDL_CaptureMouse(SDL_FALSE);
slouken@9161
   456
    }
slouken@8049
   457
    SDL_SetRelativeMouseMode(SDL_FALSE);
slouken@7493
   458
    SDL_ShowCursor(1);
slouken@7493
   459
slouken@7493
   460
    cursor = mouse->cursors;
slouken@7493
   461
    while (cursor) {
slouken@7493
   462
        next = cursor->next;
slouken@7493
   463
        SDL_FreeCursor(cursor);
slouken@7493
   464
        cursor = next;
slouken@7493
   465
    }
slouken@7493
   466
slouken@7493
   467
    if (mouse->def_cursor && mouse->FreeCursor) {
slouken@7493
   468
        mouse->FreeCursor(mouse->def_cursor);
slouken@7493
   469
    }
slouken@7493
   470
slouken@8066
   471
    if (mouse->clickstate) {
slouken@8066
   472
        SDL_free(mouse->clickstate);
slouken@8066
   473
    }
slouken@8066
   474
slouken@7493
   475
    SDL_zerop(mouse);
slouken@4465
   476
}
slouken@4465
   477
slouken@6673
   478
Uint32
slouken@4465
   479
SDL_GetMouseState(int *x, int *y)
slouken@4465
   480
{
slouken@5371
   481
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   482
slouken@4465
   483
    if (x) {
slouken@4465
   484
        *x = mouse->x;
slouken@4465
   485
    }
slouken@4465
   486
    if (y) {
slouken@4465
   487
        *y = mouse->y;
slouken@4465
   488
    }
slouken@4465
   489
    return mouse->buttonstate;
slouken@4465
   490
}
slouken@4465
   491
slouken@6673
   492
Uint32
slouken@4465
   493
SDL_GetRelativeMouseState(int *x, int *y)
slouken@4465
   494
{
slouken@5371
   495
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   496
slouken@4465
   497
    if (x) {
slouken@4465
   498
        *x = mouse->xdelta;
slouken@4465
   499
    }
slouken@4465
   500
    if (y) {
slouken@4465
   501
        *y = mouse->ydelta;
slouken@4465
   502
    }
slouken@4465
   503
    mouse->xdelta = 0;
slouken@4465
   504
    mouse->ydelta = 0;
slouken@4465
   505
    return mouse->buttonstate;
slouken@4465
   506
}
slouken@4465
   507
icculus@8945
   508
Uint32
icculus@8952
   509
SDL_GetGlobalMouseState(int *x, int *y)
icculus@8945
   510
{
icculus@8945
   511
    SDL_Mouse *mouse = SDL_GetMouse();
icculus@8945
   512
    int tmpx, tmpy;
icculus@8945
   513
icculus@8945
   514
    /* make sure these are never NULL for the backend implementations... */
icculus@8945
   515
    if (!x) {
icculus@8945
   516
        x = &tmpx;
icculus@8945
   517
    }
icculus@8945
   518
    if (!y) {
icculus@8945
   519
        y = &tmpy;
icculus@8945
   520
    }
icculus@8945
   521
icculus@8945
   522
    *x = *y = 0;
icculus@8945
   523
icculus@8952
   524
    if (!mouse->GetGlobalMouseState) {
icculus@8945
   525
        SDL_assert(0 && "This should really be implemented for every target.");
icculus@8945
   526
        return 0;
icculus@8945
   527
    }
icculus@8945
   528
icculus@8952
   529
    return mouse->GetGlobalMouseState(x, y);
icculus@8945
   530
}
icculus@8945
   531
slouken@4465
   532
void
slouken@3685
   533
SDL_WarpMouseInWindow(SDL_Window * window, int x, int y)
slouken@1895
   534
{
slouken@5371
   535
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@7191
   536
icculus@8953
   537
    if (window == NULL) {
slouken@7191
   538
        window = mouse->focus;
icculus@8944
   539
    }
slouken@7191
   540
icculus@8953
   541
    if (window == NULL) {
slouken@7191
   542
        return;
icculus@8944
   543
    }
slouken@1895
   544
slouken@1895
   545
    if (mouse->WarpMouse) {
slouken@5371
   546
        mouse->WarpMouse(window, x, y);
slouken@1895
   547
    } else {
slouken@6950
   548
        SDL_SendMouseMotion(window, mouse->mouseID, 0, x, y);
slouken@1895
   549
    }
slouken@1895
   550
}
slouken@1895
   551
icculus@9807
   552
int
slouken@8815
   553
SDL_WarpMouseGlobal(int x, int y)
slouken@8815
   554
{
slouken@8815
   555
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@8815
   556
slouken@8815
   557
    if (mouse->WarpMouseGlobal) {
icculus@9807
   558
        return mouse->WarpMouseGlobal(x, y);
slouken@8815
   559
    }
icculus@9807
   560
icculus@9807
   561
    return SDL_Unsupported();
slouken@8815
   562
}
slouken@8815
   563
slouken@8071
   564
static SDL_bool
slouken@8071
   565
ShouldUseRelativeModeWarp(SDL_Mouse *mouse)
slouken@8071
   566
{
slouken@8071
   567
    if (!mouse->SetRelativeMouseMode) {
slouken@8071
   568
        return SDL_TRUE;
slouken@8071
   569
    }
slouken@8071
   570
slouken@10499
   571
    return SDL_GetHintBoolean(SDL_HINT_MOUSE_RELATIVE_MODE_WARP, SDL_FALSE);
slouken@8071
   572
}
slouken@8071
   573
slouken@4465
   574
int
slouken@4465
   575
SDL_SetRelativeMouseMode(SDL_bool enabled)
slouken@4465
   576
{
slouken@5371
   577
    SDL_Mouse *mouse = SDL_GetMouse();
jorgen@7107
   578
    SDL_Window *focusWindow = SDL_GetKeyboardFocus();
slouken@4465
   579
slouken@5406
   580
    if (enabled == mouse->relative_mode) {
slouken@5406
   581
        return 0;
slouken@5406
   582
    }
slouken@5406
   583
jorgen@7107
   584
    if (enabled && focusWindow) {
jorgen@7107
   585
        /* Center it in the focused window to prevent clicks from going through
jorgen@7107
   586
         * to background windows.
jorgen@7107
   587
         */
jorgen@7107
   588
        SDL_SetMouseFocus(focusWindow);
jorgen@7107
   589
        SDL_WarpMouseInWindow(focusWindow, focusWindow->w/2, focusWindow->h/2);
jorgen@7107
   590
    }
jorgen@7107
   591
slouken@8071
   592
    /* Set the relative mode */
slouken@8071
   593
    if (!enabled && mouse->relative_mode_warp) {
slouken@8071
   594
        mouse->relative_mode_warp = SDL_FALSE;
slouken@8071
   595
    } else if (enabled && ShouldUseRelativeModeWarp(mouse)) {
slouken@8071
   596
        mouse->relative_mode_warp = SDL_TRUE;
slouken@8071
   597
    } else if (mouse->SetRelativeMouseMode(enabled) < 0) {
slouken@8269
   598
        if (enabled) {
philipp@8776
   599
            /* Fall back to warp mode if native relative mode failed */
slouken@8269
   600
            mouse->relative_mode_warp = SDL_TRUE;
slouken@8269
   601
        }
slouken@5406
   602
    }
slouken@4465
   603
    mouse->relative_mode = enabled;
slouken@4465
   604
slouken@8071
   605
    if (mouse->focus) {
slouken@8071
   606
        SDL_UpdateWindowGrab(mouse->focus);
slouken@8071
   607
slouken@8071
   608
        /* Put the cursor back to where the application expects it */
slouken@8071
   609
        if (!enabled) {
slouken@8071
   610
            SDL_WarpMouseInWindow(mouse->focus, mouse->x, mouse->y);
slouken@8071
   611
        }
slouken@4465
   612
    }
slouken@4465
   613
slouken@8071
   614
    /* Flush pending mouse motion - ideally we would pump events, but that's not always safe */
slouken@5406
   615
    SDL_FlushEvent(SDL_MOUSEMOTION);
slouken@5406
   616
slouken@4465
   617
    /* Update cursor visibility */
slouken@4465
   618
    SDL_SetCursor(NULL);
slouken@4465
   619
slouken@4465
   620
    return 0;
slouken@4465
   621
}
slouken@4465
   622
slouken@4465
   623
SDL_bool
slouken@4465
   624
SDL_GetRelativeMouseMode()
slouken@4465
   625
{
slouken@5371
   626
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@4465
   627
slouken@4465
   628
    return mouse->relative_mode;
slouken@4465
   629
}
slouken@4465
   630
icculus@8955
   631
int
icculus@8955
   632
SDL_CaptureMouse(SDL_bool enabled)
icculus@8955
   633
{
icculus@8955
   634
    SDL_Mouse *mouse = SDL_GetMouse();
icculus@8955
   635
    SDL_Window *focusWindow;
icculus@8955
   636
    SDL_bool isCaptured;
icculus@8955
   637
icculus@8955
   638
    if (!mouse->CaptureMouse) {
icculus@8955
   639
        return SDL_Unsupported();
icculus@8955
   640
    }
icculus@8955
   641
icculus@8955
   642
    focusWindow = SDL_GetKeyboardFocus();
icculus@8955
   643
icculus@8955
   644
    isCaptured = focusWindow && (focusWindow->flags & SDL_WINDOW_MOUSE_CAPTURE);
icculus@8955
   645
    if (isCaptured == enabled) {
icculus@8955
   646
        return 0;  /* already done! */
icculus@8955
   647
    }
icculus@8955
   648
icculus@8955
   649
    if (enabled) {
icculus@8955
   650
        if (!focusWindow) {
icculus@8955
   651
            return SDL_SetError("No window has focus");
icculus@8955
   652
        } else if (mouse->CaptureMouse(focusWindow) == -1) {
icculus@8955
   653
            return -1;  /* CaptureMouse() should call SetError */
icculus@8955
   654
        }
icculus@8955
   655
        focusWindow->flags |= SDL_WINDOW_MOUSE_CAPTURE;
icculus@8955
   656
    } else {
icculus@8955
   657
        if (mouse->CaptureMouse(NULL) == -1) {
icculus@8955
   658
            return -1;  /* CaptureMouse() should call SetError */
icculus@8955
   659
        }
icculus@8955
   660
        focusWindow->flags &= ~SDL_WINDOW_MOUSE_CAPTURE;
icculus@8955
   661
    }
icculus@8955
   662
icculus@8955
   663
    return 0;
icculus@8955
   664
}
icculus@8955
   665
slouken@1895
   666
SDL_Cursor *
slouken@1895
   667
SDL_CreateCursor(const Uint8 * data, const Uint8 * mask,
slouken@1895
   668
                 int w, int h, int hot_x, int hot_y)
slouken@1895
   669
{
slouken@1895
   670
    SDL_Surface *surface;
slouken@1895
   671
    SDL_Cursor *cursor;
slouken@1895
   672
    int x, y;
slouken@1895
   673
    Uint32 *pixel;
slouken@4465
   674
    Uint8 datab = 0, maskb = 0;
slouken@1895
   675
    const Uint32 black = 0xFF000000;
slouken@1895
   676
    const Uint32 white = 0xFFFFFFFF;
slouken@1895
   677
    const Uint32 transparent = 0x00000000;
slouken@1895
   678
slouken@1895
   679
    /* Make sure the width is a multiple of 8 */
slouken@1895
   680
    w = ((w + 7) & ~7);
slouken@1895
   681
slouken@1895
   682
    /* Create the surface from a bitmap */
slouken@5473
   683
    surface = SDL_CreateRGBSurface(0, w, h, 32,
slouken@5473
   684
                                   0x00FF0000,
slouken@5473
   685
                                   0x0000FF00,
slouken@5473
   686
                                   0x000000FF,
slouken@5473
   687
                                   0xFF000000);
slouken@1895
   688
    if (!surface) {
slouken@1895
   689
        return NULL;
slouken@1895
   690
    }
slouken@1895
   691
    for (y = 0; y < h; ++y) {
slouken@1895
   692
        pixel = (Uint32 *) ((Uint8 *) surface->pixels + y * surface->pitch);
slouken@1895
   693
        for (x = 0; x < w; ++x) {
slouken@1895
   694
            if ((x % 8) == 0) {
slouken@1895
   695
                datab = *data++;
slouken@1895
   696
                maskb = *mask++;
slouken@1895
   697
            }
slouken@1895
   698
            if (maskb & 0x80) {
slouken@1895
   699
                *pixel++ = (datab & 0x80) ? black : white;
slouken@1895
   700
            } else {
slouken@1895
   701
                *pixel++ = (datab & 0x80) ? black : transparent;
slouken@1895
   702
            }
slouken@1895
   703
            datab <<= 1;
slouken@1895
   704
            maskb <<= 1;
slouken@1895
   705
        }
slouken@1895
   706
    }
slouken@1895
   707
slouken@5473
   708
    cursor = SDL_CreateColorCursor(surface, hot_x, hot_y);
slouken@5473
   709
slouken@5473
   710
    SDL_FreeSurface(surface);
slouken@5473
   711
slouken@5473
   712
    return cursor;
slouken@5473
   713
}
slouken@5473
   714
slouken@5473
   715
SDL_Cursor *
slouken@5473
   716
SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
slouken@5473
   717
{
slouken@5473
   718
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@5473
   719
    SDL_Surface *temp = NULL;
slouken@5473
   720
    SDL_Cursor *cursor;
slouken@5473
   721
slouken@5473
   722
    if (!surface) {
slouken@5473
   723
        SDL_SetError("Passed NULL cursor surface");
slouken@5473
   724
        return NULL;
slouken@5473
   725
    }
slouken@5473
   726
slouken@5473
   727
    if (!mouse->CreateCursor) {
slouken@5473
   728
        SDL_SetError("Cursors are not currently supported");
slouken@5473
   729
        return NULL;
slouken@5473
   730
    }
slouken@5473
   731
slouken@5473
   732
    /* Sanity check the hot spot */
slouken@5473
   733
    if ((hot_x < 0) || (hot_y < 0) ||
slouken@5473
   734
        (hot_x >= surface->w) || (hot_y >= surface->h)) {
slouken@5473
   735
        SDL_SetError("Cursor hot spot doesn't lie within cursor");
slouken@5473
   736
        return NULL;
slouken@5473
   737
    }
slouken@5473
   738
slouken@5473
   739
    if (surface->format->format != SDL_PIXELFORMAT_ARGB8888) {
slouken@5473
   740
        temp = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_ARGB8888, 0);
slouken@5473
   741
        if (!temp) {
slouken@5473
   742
            return NULL;
slouken@5473
   743
        }
slouken@5473
   744
        surface = temp;
slouken@5473
   745
    }
slouken@5473
   746
slouken@1895
   747
    cursor = mouse->CreateCursor(surface, hot_x, hot_y);
slouken@1895
   748
    if (cursor) {
slouken@1895
   749
        cursor->next = mouse->cursors;
slouken@1895
   750
        mouse->cursors = cursor;
slouken@1895
   751
    }
slouken@1895
   752
slouken@7720
   753
    SDL_FreeSurface(temp);
slouken@1895
   754
slouken@1895
   755
    return cursor;
slouken@1895
   756
}
slouken@1895
   757
mikesart@6675
   758
SDL_Cursor *
mikesart@6675
   759
SDL_CreateSystemCursor(SDL_SystemCursor id)
mikesart@6675
   760
{
mikesart@6675
   761
    SDL_Mouse *mouse = SDL_GetMouse();
mikesart@6675
   762
    SDL_Cursor *cursor;
mikesart@6675
   763
mikesart@6675
   764
    if (!mouse->CreateSystemCursor) {
mikesart@6675
   765
        SDL_SetError("CreateSystemCursor is not currently supported");
mikesart@6675
   766
        return NULL;
mikesart@6675
   767
    }
mikesart@6675
   768
slouken@7191
   769
    cursor = mouse->CreateSystemCursor(id);
mikesart@6675
   770
    if (cursor) {
mikesart@6675
   771
        cursor->next = mouse->cursors;
mikesart@6675
   772
        mouse->cursors = cursor;
mikesart@6675
   773
    }
mikesart@6675
   774
slouken@7191
   775
    return cursor;
mikesart@6675
   776
}
mikesart@6675
   777
slouken@1895
   778
/* SDL_SetCursor(NULL) can be used to force the cursor redraw,
slouken@1895
   779
   if this is desired for any reason.  This is used when setting
slouken@1895
   780
   the video mode and when the SDL window gains the mouse focus.
slouken@1895
   781
 */
slouken@1895
   782
void
slouken@1895
   783
SDL_SetCursor(SDL_Cursor * cursor)
slouken@1895
   784
{
slouken@5371
   785
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   786
slouken@1895
   787
    /* Set the new cursor */
slouken@1895
   788
    if (cursor) {
slouken@1895
   789
        /* Make sure the cursor is still valid for this mouse */
slouken@5405
   790
        if (cursor != mouse->def_cursor) {
slouken@5405
   791
            SDL_Cursor *found;
slouken@5405
   792
            for (found = mouse->cursors; found; found = found->next) {
slouken@5405
   793
                if (found == cursor) {
slouken@5405
   794
                    break;
slouken@5405
   795
                }
slouken@1895
   796
            }
slouken@5405
   797
            if (!found) {
slouken@5405
   798
                SDL_SetError("Cursor not associated with the current mouse");
slouken@5405
   799
                return;
slouken@5405
   800
            }
slouken@1895
   801
        }
slouken@1895
   802
        mouse->cur_cursor = cursor;
slouken@1895
   803
    } else {
ghostunderscore@6301
   804
        if (mouse->focus) {
ghostunderscore@6301
   805
            cursor = mouse->cur_cursor;
ghostunderscore@6301
   806
        } else {
ghostunderscore@6301
   807
            cursor = mouse->def_cursor;
ghostunderscore@6301
   808
        }
slouken@1895
   809
    }
slouken@1895
   810
slouken@1895
   811
    if (cursor && mouse->cursor_shown && !mouse->relative_mode) {
slouken@1895
   812
        if (mouse->ShowCursor) {
slouken@1895
   813
            mouse->ShowCursor(cursor);
slouken@1895
   814
        }
slouken@1895
   815
    } else {
slouken@1895
   816
        if (mouse->ShowCursor) {
slouken@1895
   817
            mouse->ShowCursor(NULL);
slouken@1895
   818
        }
slouken@1895
   819
    }
slouken@1895
   820
}
slouken@1895
   821
slouken@1895
   822
SDL_Cursor *
slouken@1895
   823
SDL_GetCursor(void)
slouken@1895
   824
{
slouken@5371
   825
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   826
slouken@1895
   827
    if (!mouse) {
slouken@1895
   828
        return NULL;
slouken@1895
   829
    }
slouken@1895
   830
    return mouse->cur_cursor;
slouken@1895
   831
}
slouken@1895
   832
jorgen@7104
   833
SDL_Cursor *
jorgen@7104
   834
SDL_GetDefaultCursor(void)
jorgen@7104
   835
{
jorgen@7104
   836
    SDL_Mouse *mouse = SDL_GetMouse();
jorgen@7104
   837
jorgen@7104
   838
    if (!mouse) {
jorgen@7104
   839
        return NULL;
jorgen@7104
   840
    }
jorgen@7104
   841
    return mouse->def_cursor;
jorgen@7104
   842
}
jorgen@7104
   843
slouken@1895
   844
void
slouken@1895
   845
SDL_FreeCursor(SDL_Cursor * cursor)
slouken@1895
   846
{
slouken@5371
   847
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   848
    SDL_Cursor *curr, *prev;
slouken@1895
   849
slouken@1895
   850
    if (!cursor) {
slouken@1895
   851
        return;
slouken@1895
   852
    }
slouken@1895
   853
slouken@1895
   854
    if (cursor == mouse->def_cursor) {
slouken@1895
   855
        return;
slouken@1895
   856
    }
slouken@1895
   857
    if (cursor == mouse->cur_cursor) {
slouken@1895
   858
        SDL_SetCursor(mouse->def_cursor);
slouken@1895
   859
    }
slouken@1895
   860
slouken@1895
   861
    for (prev = NULL, curr = mouse->cursors; curr;
slouken@1895
   862
         prev = curr, curr = curr->next) {
slouken@1895
   863
        if (curr == cursor) {
slouken@1895
   864
            if (prev) {
slouken@1895
   865
                prev->next = curr->next;
slouken@1895
   866
            } else {
slouken@1895
   867
                mouse->cursors = curr->next;
slouken@1895
   868
            }
slouken@1895
   869
slouken@1895
   870
            if (mouse->FreeCursor) {
slouken@1895
   871
                mouse->FreeCursor(curr);
slouken@1895
   872
            }
slouken@1895
   873
            return;
slouken@1895
   874
        }
slouken@1895
   875
    }
slouken@1895
   876
}
slouken@1895
   877
slouken@1895
   878
int
slouken@1895
   879
SDL_ShowCursor(int toggle)
slouken@1895
   880
{
slouken@5371
   881
    SDL_Mouse *mouse = SDL_GetMouse();
slouken@1895
   882
    SDL_bool shown;
slouken@1895
   883
slouken@1895
   884
    if (!mouse) {
slouken@1895
   885
        return 0;
slouken@1895
   886
    }
slouken@1895
   887
slouken@1895
   888
    shown = mouse->cursor_shown;
slouken@1895
   889
    if (toggle >= 0) {
slouken@1895
   890
        if (toggle) {
slouken@1895
   891
            mouse->cursor_shown = SDL_TRUE;
slouken@1895
   892
        } else {
slouken@1895
   893
            mouse->cursor_shown = SDL_FALSE;
slouken@1895
   894
        }
slouken@1895
   895
        if (mouse->cursor_shown != shown) {
slouken@1895
   896
            SDL_SetCursor(NULL);
slouken@1895
   897
        }
slouken@1895
   898
    }
slouken@1895
   899
    return shown;
slouken@1895
   900
}
slouken@1895
   901
jorgen@7097
   902
/* vi: set ts=4 sw=4 expandtab: */