Ziggle() : A handy tool to lookup Win32 Constants

[eugenesv]

Is it possible to somehow use this data directly in scripts like

Code: Select all

#include <constZiggle>
!Numpad8::{
  Cz := win32ConstantZiggle.m
  msgbox(Cz['__RPCNDR_H_VERSION__'])
}

so that you maintain readability later on instead of having raw numbers pasted in various dllcalls?

I've tried to naively load the converted attached data file in a Map('const_name','const_value',...) format, but then the AHK couldn't load, guess it's too big :)
And the load times plumetted when I cut the size to something AHK could load
But is there a simple yet performant way to achieve the same?

[SKAN]

Is it possible to somehow use this data directly in scripts like

Include 173416 Constants?
Not suitable for a interpreted language, IMO.

[eugenesv]

Is it possible to somehow use this data directly in scripts like

Include 173416 Constants? :shock:
Not suitable for a interpreted language, IMO.

but I've seen some mentions in other posts about the possibility of embedding native functions within AHK, maybe they could load some memory-mapped file (or something?) and respond to calls from within AHK scripts with numbers (except they wouldn't have to string-parse the file every single time as that could be preparsed to whatever the best format for that function is)? This way it could be millions of constants :)?

This would also allow you to add more helpful aliases

[SKAN]

GdiPlus constants were (almost) hand-compiled from header files and there were a few errors.
Attaching here a script of GdiPlus constants as well as data file that has been included in Ziggle3.zip

[eugenesv]

By the way, there are a bunch of duplicate keys in the file

Spoiler

Duplicate key/value (2nd+ )
IID_IAnnotationProvider {95ba1417-4437-451b-9461-050a49b59d06}
IID_IAudioStateMonitor {1d13d136-0199-4cdc-b84e-e72c2b581ece}
IID_IBinding {3f7a0c6b-d00f-4730-8c1d-48e16c46f9ca}
IID_ICallAnswerEventArgs {61f132aa-f92a-48fa-aa8f-4f3a17662980}
IID_ICallRejectEventArgs {3e04061a-ce7d-49c2-a2b8-7f49b6eaebc5}
IID_ICallStateChangeEventArgs {1f3e87b0-d371-4395-8b6c-1786a42e2f18}
IID_ICommand {e5af3542-ca67-4081-995b-709dd13792df}
IID_IComponent {43136eb2-d36c-11cf-adbc-00aa00a80033}
IID_ICompositionTarget {26cfbff0-713c-4bec-8803-e101f7b14ed3}
IID_IContact {ec0072f3-2118-4049-9ebc-17f0ab692b64}
IID_ICustomNavigationProvider {2bd8a6d0-2fa3-4717-b28c-4917ce54928d}
IID_IDisplayServices {1b54f32b-890d-5747-bd26-fdbdeb0c8a71}
IID_IDockProvider {48c243f8-78b1-44a0-ac5f-750757bcde3c}
IID_IDragProvider {2e7786a9-7ffc-4f57-b965-1ef1f373f546}
IID_IDropTargetProvider {7a245bdd-b458-4fe0-98c8-aac89df56d61}
IID_IEnteredBackgroundEventHandler {93a956ae-1d7f-438b-b7b8-227d96b609c0}
IID_IEventTrigger {def8f855-0b49-4087-b1a9-b8b38488f786}
IID_IExpandCollapseProvider {49ac8399-d626-4543-94b9-a6d9a9593af6}
IID_IFrameworkView {ddba664b-b603-47aa-942d-3833174f0d80}
IID_IFrameworkViewSource {e3b077da-35ad-4b09-b5b2-27420041ba9f}
IID_IGestureRecognizer {b47a37bf-3d6b-4f88-83e8-6dcb4012ffb0}
IID_IGridItemProvider {fff3683c-7407-45bb-a936-df3ed6d3837d}
IID_IGridProvider {8b62b7a0-932c-4490-9a13-02fdb39a8f5b}
IID_IImageList {46eb5926-582e-4017-9fdf-e8998daa0950}
IID_IInkDrawingAttributes {97a2176c-6774-48ad-84f0-48f5a9be74f9}
IID_IInkRecognitionResult {36461a94-5068-40ef-8a05-2c2fb60908a2}
IID_IInkRecognizer {077ccea3-904d-442a-b151-aaca3631c43b}
IID_IInvokeProvider {f7d1a187-b13c-4540-b09e-6778e2dc9ba5}
IID_IItemContainerProvider {ef5cd845-e1d4-40f4-bad5-c7fad44a703e}
IID_ILeavingBackgroundEventHandler {aaad5dad-4fc6-4aa4-b7cf-877e36ada4f6}
IID_IMediaControl {98f1fbe1-7a8d-42cb-b6fe-8fe698264f13}
IID_IMultipleViewProvider {d014e196-0e50-4843-a5d2-c22897c8845a}
IID_IMuteChangeEventArgs {f914ead4-1c94-458c-acb7-1926a233f74c}
IID_INavigatedEventHandler {7bd1cf54-23cf-4cce-b2f5-4ce78d96896e}
IID_IObjectModelProvider {c3ca36b9-0793-4ed0-bbf4-9ff4e0f98f80}
IID_IPlaybackRateChangeRequestedEventArgs {0f5661ae-2c88-4cca-8540-d586095d13a5}
IID_IRangeException {3051072d-98b5-11cf-bb82-00aa00bdce0b}
IID_IRangeValueProvider {838a34a8-7d5f-4079-af03-c3d015e93413}
IID_IResourceManager {13741d21-87eb-11ce-8081-0080c758527e}
IID_IResourceManager {f744d97b-9988-44fb-abd6-5378844cfa8b}
IID_IResourceManager2 {9d66fe6c-a4d7-4c23-9e85-675f304c252d}
IID_IScrollItemProvider {9a3ec090-5d2c-4e42-9ee6-9d58db100b55}
IID_IScrollProvider {374bf581-7716-4bbc-82eb-d997006ea999}
IID_ISelectionItemProvider {6a4977c1-830d-42d2-bf62-042ebddecc19}
IID_ISelectionProvider {1f018fca-b944-4395-8de1-88f674af51d3}
IID_ISelector {e30eb3a5-b36b-42dc-8527-cd25136c083c}
IID_ISpeechRecognizer {0bc3c9cb-c26a-40f2-aeb5-8096b2e48073}
IID_ISpreadsheetItemProvider {ebde8f92-6015-4826-b719-47521a81c67e}
IID_ISpreadsheetProvider {15359093-bd99-4cfd-9f07-3b14b315e23d}
IID_IStylesProvider {1a5b7a17-7c01-4bec-9cd4-2dfa7dc246cd}
IID_ISuspendingEventHandler {23429465-e36a-40e2-b139-a4704602a6e1}
IID_ISynchronizedInputProvider {3d60cecb-da54-4aa3-b915-e3244427d4ac}
IID_ITableItemProvider {3b2c49cd-1de2-4ee2-a3e1-fb553559d15d}
IID_ITableProvider {7a8ed399-6824-4595-bab3-464bc9a04417}
IID_ITextChildProvider {1133c336-a89b-4130-9be6-55e33334f557}
IID_ITextDocument {beee4ddb-90b2-408c-a2f6-0a0ac31e33e4}
IID_ITextDocument2 {f2311112-8c89-49c9-9118-f057cbb814ee}
IID_ITextProvider {db5bbc9f-4807-4f2a-8678-1b13f3c60e22}
IID_ITextProvider2 {df1d48bc-0487-4e7f-9d5e-f09e77e41246}
IID_ITextRange {5b9e4e57-c072-42a0-8945-af503ee54768}
IID_ITextRangeProvider {0274688d-06e9-4f66-9446-28a5be98fbd0}
IID_ITextRangeProvider2 {d3be3dfb-9f54-4642-a7a5-5c18d5ee2a3f}
IID_ITextSelection {a6d36724-f28f-430a-b2cf-c343671ec0e9}
IID_ITimeTrigger {656e5556-0b2a-4377-ba70-3b45a935547f}
IID_IToggleProvider {93b88290-656f-44f7-aeaf-78b8f944d062}
IID_ITransformProvider {79670fdd-f6a9-4a65-af17-861db799a2da}
IID_ITransformProvider2 {a8b11756-a39f-4e97-8c7d-c1ea8dd633c5}
IID_IUserNotification {adf7e52f-4e53-42d5-9c33-eb5ea515b23e}
IID_IValueProvider {2086b7a7-ac0e-47d1-ab9b-2a64292afdf8}
IID_IVirtualizedItemProvider {17d4a04b-d658-48e0-a574-5a516c58dfa7}
IID_IVoipCallCoordinator {0d5f3579-f6dd-4e10-9f25-3d8c91376ee8}
IID_IVoipCallCoordinator2 {0290a9b8-645d-4711-8e32-926bfabf6928}
IID_IVoipCallCoordinator3 {80a2ede6-0d02-40cd-8891-b4cec6472c82}
IID_IVoipCallCoordinatorStatics {10fb55bb-e07d-407e-bc39-f7cc3641d979}
IID_IVoipPhoneCall {716654be-28e8-495e-b657-8053074b4150}
IID_IVoipPhoneCall2 {1ac5b7dc-c83f-4862-8393-1ea14af7efea}
IID_IVoipPhoneCall3 {a92ab1d1-52fb-4adf-8225-4d289b866fe0}
IID_IWindowProvider {1baa8b3d-38cf-415a-85d3-20e43a0ec1b1}
IID_IWorkspace {b41da63b-a4b8-4036-89c5-83c31266ba49}
SEC_E_INTERNAL_ERROR 2148074244
SEC_E_UNSUPPORTED_FUNCTION 2148074242

[eugenesv]

And a slightly cleaned x64 version

• removed duplicates (though haven't checked which of the dupes is correct, just left the first one). Also, some constants have legit different values with names only differing by CaSe (DISPID_MaxLength and DISPID_MAXLENGTH)
• replaced all ptrsize'd conditionals like (A_PtrSize=8 ? "0xFFFFFFFFFFFFFFFF" : 4294967295) _SIZE_T_ERROR with the first "0xFFFFFFFFFFFFFFFF" value
• removed () from ("0xFFFFFFFFFFFFFFFF") DWORD64_MAX
• replaced (Chr(124)) with |

[SKAN]

removed duplicates (though haven't checked which of the dupes is correct, just left the first one

That's almost correct, the second one is being picked from winrt subfolder
except IID_IResourceManager which has 3 entries?!
https://www.magnumdb.com/search?q=IID_IResourceManager

Unable to decide about

Code: Select all

SEC_E_INTERNAL_ERROR
SEC_E_UNSUPPORTED_FUNCTION

In Ziggle.txt, they have both signed/unsigned value.. According to MagnumDB they are unsigned numbers:
https://www.magnumdb.com/search?q=SEC_E_INTERNAL_ERROR
https://www.magnumdb.com/search?q=SEC_E_UNSUPPORTED_FUNCTION
  

replaced (A_PtrSize=8 ? "0xFFFFFFFFFFFFFFFF" : 4294967295) _SIZE_T_ERROR with the first "0xFFFFFFFFFFFFFFFF" value

https://www.magnumdb.com/search?q=_SIZE_T_ERROR

replaced (Chr(124)) with |

That might mess with search delimiter |.

[eugenesv]

According to MagnumDB they are unsigned numbers:
https://www.magnumdb.com/search?q=SEC_E_INTERNAL_ERROR
https://www.magnumdb.com/search?q=SEC_E_UNSUPPORTED_FUNCTION

Out of curiousity, shouldn't the official Windows bindings be more authoritative vs the MagnumDB https://docs.rs/windows-sys/latest/windows_sys/Win32/Foundation/constant.SEC_E_INTERNAL_ERROR.html

replaced (Chr(124)) with |

That might mess with search delimiter |.

Think that should be dealt with at the app layer rather than dirtying the database

[eugenesv]

And FYI I've compiled your database to DLL so you can use a DllCall in AHK to avoid the need to do the work twice (find a constant, then find its value), see this post

[eugenesv]

FYI I've also managed to extract most of the constants from the official Windows sys Rust library (112k out of 126k, missing are all the GUIDs and wide string literlas PCWSTR as their values escape the extraction process route I've used), and you might be interested in these discrepancies vs. the Ziggle data:

• 0.5k constants with different values. Checked a few and the library seems to match the docs unlike Ziggle, but then there is also some weird integer wraparound going on
  

  Code: Select all

  Constant                  	crate     	ziggle     	Comment
  DEPENDENT_DISK_FLAG_PARENT	256       	32         0x00000100=256 per msdocs https://learn.microsoft.com/en-us/windows/win32/api/virtdisk/ne-virtdisk-dependent_disk_flag 
  PDH_INSUFFICIENT_BUFFER   	3221228482	-1073738814	 PDH_INSUFFICIENT_BUFFER   	3221228482	-1073738814	 0xC0000BC2=3221228482 per https://learn.microsoft.com/en-us/windows/win32/perfctrs/pdh-error-codes, Ziggle with wraparound i32 = crate
  

  winConst_vs_ziggle_diff_value_0.5k.txt.rar

  (7.13 KiB) Downloaded 248 times

• 1.8k constants missing from Ziggle (haven't checked them, some seem to be just dupe in values (but different in type) like PRINTER_STANDARD_RIGHTS_READ same as STANDARD_RIGHTS_READ)
  
  

  winConst_vs_ziggle_extra_1.8k.txt.rar

  (14.23 KiB) Downloaded 267 times

[SKAN]

• 0.5k constants with different values...
  

  Code: Select all

  Constant                  	crate     	ziggle     	Comment
  DEPENDENT_DISK_FLAG_PARENT	256       	32         0x00000100=256 per msdocs https://learn.microsoft.com/en-us/windows/win32/api/virtdisk/ne-virtdisk-dependent_disk_flag 
  ...
  

 
Oh! My parser had a mistake. Thanks for the valuable feedback!

1.8k constants missing from Ziggle

 
After rectifying the code, I downloaded the latest zig bindings, updated Ziggle.txt and cross checked with your list.
Have included 1105 entries from your list (1809 entries) to Ziggle4.zip
Thanks.

[eugenesv]

FYI the results of the same simple cleaning process as described above based on Ziggle4, and the dupe file (which is now slightly bigger at 2k entries)
Noticed things like

Code: Select all

`\n	IMAGE_ARCHIVE_END
\n	IMAGE_ARCHIVE_END

which might indicate some parsing issue with AHK due to the backtick?

Have included 1105 entries from your list (1809 entries)

Out of curiosity, what about the other ~700 entries?

[SKAN]

Noticed things like

Code: Select all

`\n	IMAGE_ARCHIVE_END
\n	IMAGE_ARCHIVE_END

which might indicate some parsing issue with AHK due to the backtick?

 
I will look into that.
 

Have included 1105 entries from your list (1809 entries)

Out of curiosity, what about the other ~700 entries?

 
They have been included in latest zig bindings.

[eugenesv]

And similar diff with the updated data - almost all are of the "wraparound" variety nowPDH_CANNOT_READ_NAME_STRINGS 3221228488 -1073738808

one with a type difference for
INVALID_SOCKET 18446744073709551615 4294967295
(in the lib it's max usize, so u64, guess it's u32 in whatever your database got it from, might want to hide it behind A_PtrSize check like other values?)

and a couple with a rounding difference
X3DAUDIO_2PI 6.2831855 6.283185307

winConst_vs_ziggle_diff_value_0.09k.rar

(1.44 KiB) Downloaded 249 times

(and everything is included in Ziggle, so no extras except for Success 0 UNKNOWN 0 FALSE 0 TRUE 1)

[SKAN]

one with a type difference for
INVALID_SOCKET 18446744073709551615 4294967295
(in the lib it's max usize, so u64, guess it's u32 in whatever your database got it from, might want to hide it behind A_PtrSize check like other values?)

Unsigned 32 bit value. Should be -1 instead.
Why is invalid socket defined as ~0 in WinSock2.h (c++)?

[eugenesv]

-1 is a way to set the unsigned type to MAX, so it should be u32MAX or u64MAX

[eugenesv]

I've switched to the same WinMD parsing method (based on the MS Rust library) that the Zig data you referenced, so now the coverage is almost complete (except for generic interface GUIDs, haven't parsed them to concrete types unlike your Ziggle file) and should be the same, so FYI below are a few differences in case you find them useful for your database

• the "wraparound" differences mentioned in previous posts

  winConst_vs_ziggle_diff_value 1 minus 0.3k.log.rar

  (3.8 KiB) Downloaded 232 times

• other differences, though this might be due to duplicates (in case of IIDs) so not really differences, but the limitations of my quick checks since I've only compared to the "cleaned up" Ziggle file that excluded the duplicates

  winConst_vs_ziggle_diff_value 2 misc 0.3k.log.rar

  (4.09 KiB) Downloaded 236 times

• (this might be intentional on your part, so can be ignored) some struct constants with fields like PKEY_Devices_AepContainer_CanPair {fmtid:{0bba1ede-7566-4f47-90ec-25fc567ced2a},pid:3,} are only included as a single GUID value

  winConst_vs_ziggle_diff_value 3 struct 2.4k.log.rar

  (46.32 KiB) Downloaded 238 times

[eugenesv]

and there are ~9k constants not included in your data