Splitting Platform/Windows/API.cs into OpenTK.NT #765

FreezyLemon · 2018-06-05T21:56:36Z

THIS IS HEAVILY WIP!

Todo

General cleanup pass
Check for namespace errors (all should be OpenTK.NT.Native, and not e.g. OpenTK.NT.Native.User32.Structs)
Standardize type names with Win API (-> Structs)
Use windows typedef names (e.g. HWND instead of IntPtr)
check naming (especially PascalCase, unless we want to stick to the Win API with those too)
make (almost) everything public
[/] create more wrappers for function calls that could use them (postponed)

VPeruS · 2018-06-08T08:15:12Z

What is end purpose of this?

FreezyLemon · 2018-06-08T12:01:28Z

Moving all the P/Invoke code into its own library..
Check this blog post as a reference.

Remove unused leftover functions

- Renamed structs to be inline with WinApi docs - Used WinApi typedefs whereever(?) possible (might have missed some) - renamed Enums to be more consistent (uppercase if part of a struct, if only used with a function, '<FunctionName><Usage>' in PascalCase instead) - added docs from WinApi docs for a lot of enums

FreezyLemon · 2018-06-10T21:33:34Z

The files directly in the User32 folder (Cursor, Device, etc...) still need some refactoring regarding windows typedefs (when I did those, I did not replace every type with the windows type def).
Except for User32 and the two unchecked points above (wrapper are low priority), I'm pretty much done.

EDIT: I still need to clean up the remaining code in API.cs, I'd love to get rid of it completely. Everything in the class "Constants" should be moved to enums or flags. The non-WinApi structs should be moved to OpenTK.Core->Platform->Windows.
Not sure what to do about the #if ANDROID || IPHONE || MINIMAL segment though.

FreezyLemon · 2018-07-11T21:04:23Z

I went with the following:

Leave undocumented members in, but mark them as such in the XML documentation ("This member is not officially documented. Use with care.")
Delete members that are no longer present in the header files (we can assume that those are not supported anymore)

There's still the things from my last "todo" post (testing some structs) plus a very small amount of missing XML doc (<25 stylecop errors), but this is mostly done now.
edit: I'll also do a pass over the whole thing once to check if I missed some old XML documentation.

Nihlus · 2018-07-11T21:10:06Z

Absolutely fantastic. Looking forward to merging this.

to lparam and wparam

VPeruS · 2018-07-15T15:18:42Z

src/OpenTK.GLControl/WinGLControl.cs

@@ -51,53 +49,8 @@ public IGraphicsContext CreateContext(int major, int minor, GraphicsContextFlags
            return new GraphicsContext(mode, WindowInfo, major, minor, flags);
        }

-        public bool IsIdle => !PeekMessage(ref msg, IntPtr.Zero, 0, 0, 0);
+        public bool IsIdle => !User32.Message.PeekMessage(out message, IntPtr.Zero, 0, 0, 0);


Are you sure that message are allocated in managed code before call? Last time got issue by passing huge struct with out mod(it was nested and with arrays) and it genereated runtime exceptions, always with random time after call while trying to Marshal struct, changes to ref with preallocation before call fixed issue.

Since message is a field, it will always be initialized before we access it.
This means that
private Msg message; is (at least for normal usage) equivalent to
private Msg message = default(Msg);

So yes, I'm pretty sure that the message is allocated before the unmanaged function call.

What if someone make call:
Msg msg;
PeekMessage(out msg);

msg will be initialized to its default value. Even then, with an out, you don't strictly need to initialize anything since out guarantees initialization. Might want to brush up on that.

Nihlus · 2018-07-21T21:31:10Z

Looks like it's just about time to merge this. All set, @FreezyLemon?

FreezyLemon added 9 commits June 5, 2018 23:45

Initial split of windows/API.cs

7ae0d31

HIDType -> HidType

5cbc24b

Finish up Hid[...] classes

bc6acf9

Finish up User32 raw input structs etc.

5a575b0

fix some typedef mistakes

fdede67

split User32.cs into subclasses

fffb725

finish up raw input (for good pls?)

5fd1646

WNDCLASS and WNDCLASSEX

2dcaae3

various small improvements

270ba4c

FreezyLemon added 10 commits June 10, 2018 12:59

Fix User32 structs and bring them to a standard

307ec54

Move last functions out of class Functions

75c31c9

Remove unused leftover functions

bring struct naming in functions up to date

05c7a63

improve Get/SetWindowLong API

dee4c3a

move two enums to proper folder

fadf6f1

delete unused code from API.cs

7985ae5

finish up Gdi32

7c10940

finish up Kernel32

4ead4d7

finish up Shell32

4d4c3fb

FreezyLemon added 8 commits June 11, 2018 16:07

PascalCase naming in Gdi32

1ea0c7a

PascalCase for everything except enum values (soonTM)

155bf98

Change enums back to PascalCasing

02b530c

The big public-ation

3b071ec

Fix windows typedef oversight

4294c8b

Move code from API.cs into Platform/Windows for now

47e0d36

Rename WM to WindowMessage

daf0fb1

Remove last bits of API.cs

018fb96

FreezyLemon added 7 commits July 10, 2018 01:27

move WindowPosition struct to OpenTK.NT and fix some compilation errors

98db682

DeviceMode refactoring pass

a73e166

Merge branch '4.0' into 4.0-split-nt

7157ad8

first pass with the new stylecop rules, finish up DeviceMode

7747aa2

add more xml docs and refactor some enum names

a1f4cbc

more docs and refactoring

2d4acfc

a TON of XML doc and some refactoring

6146141

FreezyLemon added 10 commits July 12, 2018 00:39

change name for lParam and wParam params in functions

8cf239f

to lparam and wparam

remove redundant package reference

4e49a86

Fix DeviceMode for real

c55474b

Some Rect struct refactoring

7f5431c

Fix BroadcastDeviceInterface

fa33c8a

fix some small bugs

b889efa

refactor raw input

47b4dad

fix some left over compilation errors

86d8424

make "Library" field public

bd674a7

fix the remaining xml doc warnings

159da04

FreezyLemon force-pushed the 4.0-split-nt branch from 1557f32 to 159da04 Compare July 15, 2018 01:28

VPeruS reviewed Jul 15, 2018

View reviewed changes

FreezyLemon added 3 commits July 15, 2018 21:50

small style fixes

aa40d02

some xml doc fixes and a tiny bit of refactoring

5d0271d

line length pass

214f839

Nihlus approved these changes Jul 21, 2018

View reviewed changes

Merge branch '4.0' into 4.0-split-nt

52d183e

Nihlus merged commit 49b4125 into opentk:4.0 Jul 21, 2018

FreezyLemon deleted the 4.0-split-nt branch July 21, 2018 21:47

FreezyLemon changed the title ~~[WIP] Splitting Platform/Windows/API.cs into OpenTK.NT~~ Splitting Platform/Windows/API.cs into OpenTK.NT Jul 21, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Splitting Platform/Windows/API.cs into OpenTK.NT #765

Splitting Platform/Windows/API.cs into OpenTK.NT #765

FreezyLemon commented Jun 5, 2018 •

edited

Loading

VPeruS commented Jun 8, 2018

FreezyLemon commented Jun 8, 2018

FreezyLemon commented Jun 10, 2018

FreezyLemon commented Jul 11, 2018 •

edited

Loading

Nihlus commented Jul 11, 2018

VPeruS Jul 15, 2018

FreezyLemon Jul 15, 2018

VPeruS Jul 15, 2018

VPeruS Jul 15, 2018

Nihlus Jul 15, 2018 •

edited

Loading

Nihlus commented Jul 21, 2018

Splitting Platform/Windows/API.cs into OpenTK.NT #765

Splitting Platform/Windows/API.cs into OpenTK.NT #765

Conversation

FreezyLemon commented Jun 5, 2018 • edited Loading

Todo

VPeruS commented Jun 8, 2018

FreezyLemon commented Jun 8, 2018

FreezyLemon commented Jun 10, 2018

FreezyLemon commented Jul 11, 2018 • edited Loading

Nihlus commented Jul 11, 2018

VPeruS Jul 15, 2018

Choose a reason for hiding this comment

FreezyLemon Jul 15, 2018

Choose a reason for hiding this comment

VPeruS Jul 15, 2018

Choose a reason for hiding this comment

VPeruS Jul 15, 2018

Choose a reason for hiding this comment

Nihlus Jul 15, 2018 • edited Loading

Choose a reason for hiding this comment

Nihlus commented Jul 21, 2018

FreezyLemon commented Jun 5, 2018 •

edited

Loading

FreezyLemon commented Jul 11, 2018 •

edited

Loading

Nihlus Jul 15, 2018 •

edited

Loading