Merge pull request #2114 from yunline/port-window

Port video.Window to C

Author: Starbuck5

buildconfig/Setup.Emscripten.SDL2.in

@@ -61,6 +61,7 @@ surflock src_c/void.c
 rect src_c/void.c
 rwobject src_c/void.c
 system src_c/void.c
+_window src_c/void.c
 
 #_sdl2.controller src_c/_sdl2/controller.c $(SDL) $(DEBUG) -Isrc_c
 _sdl2.controller_old src_c/void.c

buildconfig/Setup.SDL2.in

@@ -75,3 +75,4 @@ math src_c/math.c $(SDL) $(DEBUG)
 pixelcopy src_c/pixelcopy.c $(SDL) $(DEBUG)
 newbuffer src_c/newbuffer.c $(SDL) $(DEBUG)
 system src_c/system.c $(SDL) $(DEBUG)
+_window src_c/window.c $(SDL) $(DEBUG)

buildconfig/stubs/gen_stubs.py

@@ -67,7 +67,7 @@
     "font": ["Font"],
     "mixer": ["Channel"],
     "time": ["Clock"],
-    "joystick": ["Joystick"]
+    "joystick": ["Joystick"],
 }
 
 # pygame modules from which __init__.py does the equivalent of

buildconfig/stubs/pygame/__init__.pyi

@@ -639,6 +639,8 @@ from .constants import (
     WINDOWMAXIMIZED as WINDOWMAXIMIZED,
     WINDOWMINIMIZED as WINDOWMINIMIZED,
     WINDOWMOVED as WINDOWMOVED,
+    WINDOWPOS_CENTERED as WINDOWPOS_CENTERED,
+    WINDOWPOS_UNDEFINED as WINDOWPOS_UNDEFINED,
     WINDOWRESIZED as WINDOWRESIZED,
     WINDOWRESTORED as WINDOWRESTORED,
     WINDOWSHOWN as WINDOWSHOWN,

buildconfig/stubs/pygame/_sdl2/video.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Generator, Iterable, Optional, Tuple, Union
+from typing import Any, Generator, Iterable, Optional, Tuple, Union, final
 
 from pygame.color import Color
 from pygame.rect import Rect
@@ -38,6 +38,7 @@ def messagebox(
     escape_button: int = 0,
 ) -> int: ...
 
+@final
 class Window:
     DEFAULT_SIZE: Tuple[Literal[640], Literal[480]]
     def __init__(
@@ -73,6 +74,8 @@ class Window:
     display_index: int
     def set_modal_for(self, Window) -> None: ...
 
+_Window = Window
+
 class Texture:
     def __init__(
         self,
@@ -153,14 +156,14 @@ class Image:
 class Renderer:
     def __init__(
         self,
-        window: Window,
+        window: Union[Window,_Window],
         index: int = -1,
         accelerated: int = -1,
         vsync: bool = False,
         target_texture: bool = False,
     ) -> None: ...
     @classmethod
-    def from_window(cls, window: Window) -> Renderer: ...
+    def from_window(cls, window: Union[Window,_Window]) -> Renderer: ...
     draw_blend_mode: int
     draw_color: Color
     def clear(self) -> None: ...

buildconfig/stubs/pygame/_sdl2/window.pyi

@@ -0,0 +1 @@
+from pygame._sdl2.video import _Window as Window

buildconfig/stubs/pygame/_window.pyi

@@ -0,0 +1,38 @@
+from typing import Iterable, Optional, Tuple, Union, final
+from pygame.surface import Surface
+from ._common import RectValue
+from pygame.locals import WINDOWPOS_UNDEFINED
+
+def get_grabbed_window() -> Optional[Window]: ...
+@final
+class Window:
+    def __init__(
+        self,
+        title: str = "pygame window",
+        size: Iterable[int] = (640, 480),
+        position: Union[int, Iterable[int]] = WINDOWPOS_UNDEFINED,
+        **flags: bool
+    ) -> None: ...
+    def destroy(self) -> None: ...
+    def set_windowed(self) -> None: ...
+    def set_fullscreen(self, desktop: bool = False) -> None: ...
+    def focus(self, input_only: bool = False) -> None: ...
+    def hide(self) -> None: ...
+    def show(self) -> None: ...
+    def restore(self) -> None: ...
+    def maximize(self) -> None: ...
+    def minimize(self) -> None: ...
+    def set_modal_for(self, parent: Window) -> None: ...
+    def set_icon(self, icon: Surface) -> None: ...
+    grab: bool
+    title: str
+    resizable: bool
+    borderless: bool
+    relative_mouse: bool
+    id: int
+    size: Iterable[int]
+    position: Union[int, Iterable[int]]
+    opacity: float
+    display_index: int
+    @classmethod
+    def from_display_module(cls) -> Window: ...

buildconfig/stubs/pygame/constants.pyi

@@ -561,6 +561,8 @@ WINDOWLEAVE: int
 WINDOWMAXIMIZED: int
 WINDOWMINIMIZED: int
 WINDOWMOVED: int
+WINDOWPOS_CENTERED: int
+WINDOWPOS_UNDEFINED: int
 WINDOWRESIZED: int
 WINDOWRESTORED: int
 WINDOWSHOWN: int

buildconfig/stubs/pygame/locals.pyi

@@ -563,6 +563,8 @@ WINDOWLEAVE: int
 WINDOWMAXIMIZED: int
 WINDOWMINIMIZED: int
 WINDOWMOVED: int
+WINDOWPOS_CENTERED: int
+WINDOWPOS_UNDEFINED: int
 WINDOWRESIZED: int
 WINDOWRESTORED: int
 WINDOWSHOWN: int

docs/reST/c_api.rst

@@ -19,6 +19,7 @@ pygame C API
    c_api/surface.rst
    c_api/surflock.rst
    c_api/version.rst
+   c_api/window.rst
 
 
 src_c/include/ contains header files for applications

docs/reST/c_api/window.rst

@@ -0,0 +1,30 @@
+.. include:: ../common.txt
+
+.. highlight:: c
+
+************************************************
+  Class Window API exported by pygame.window
+************************************************
+
+src_c/window.c
+===============
+
+This extension module defines Python type :py:class:`pygame.Window`.
+
+Header file: src_c/include/pygame.h
+
+
+.. c:type:: pgWindowObject
+
+   A :py:class:`pygame.window.Window` instance.
+
+.. c:var:: PyTypeObject *pgWindow_Type
+
+   The :py:class:`pygame.window.Window` Python type.
+
+.. c:function:: int pgWindow_Check(PyObject *x)
+
+   Return true if *x* is a :py:class:`pygame.window.Window` instance
+
+   Will return false if *x* is not a subclass of `Window`.
+   This is a macro. No check is made that *x* is not *NULL*.

src_c/_pygame.h

@@ -341,5 +341,6 @@ struct pgColorObject {
 #define PYGAMEAPI_MATH_NUMSLOTS 2
 #define PYGAMEAPI_BASE_NUMSLOTS 24
 #define PYGAMEAPI_EVENT_NUMSLOTS 6
+#define PYGAMEAPI_WINDOW_NUMSLOTS 1
 
 #endif /* _PYGAME_INTERNAL_H */