https://github.com/zulu-inuoe/win32

CFFI Bindings to a variety of Win32 API
https://github.com/zulu-inuoe/win32

Last synced: 4 days ago
JSON representation

CFFI Bindings to a variety of Win32 API

• Host: GitHub
• URL: https://github.com/zulu-inuoe/win32
• Owner: Zulu-Inuoe
• License: cc0-1.0
• Created: 2014-01-03T01:44:13.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-06-01T16:27:25.000Z (over 2 years ago)
• Last Synced: 2024-10-31T13:06:22.887Z (about 2 months ago)
• Language: Common Lisp
• Size: 490 KB
• Stars: 15
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# win32

## Overview

`win32` is a library containing a set of CFFI bindings and constant definitions for interacting with the Win32 API.

This means it's a practically non-existant layer on top of the API, and has little to no utility other than exposing the raw interface.

Since relatively often type names might be changed around, and because it 

includes just a random assortment of things as one giant file, I don't 

recommend using it as a library dependency.

I primarily use this to experiment with some API before using it. That said, 

hopefully this can be cleaned up to be properly reusable.

Check out [winutil](https://github.com/Zulu-Inuoe/winutil) to see about calling 

into `win32`.

## Notes:

### BOOL BOOLEAN

The `BOOL` and `BOOLEAN` types will be coerced to generalized booleans as per [:boolean](https://common-lisp.net/project/cffi/manual/html_node/Other-Types.html).

### Unicode

When encountering "ANSI" functions with "Unicode" counterparts, the latter will always be used. Bindings that accept strings all use the :utf-16 encoding (little-endian typically, but with guards in the case of big-endian).

When encoding to/from a Win32 string, make use of the `win32:+win32-string-encoding+':

``` common-lisp

(defun lisp-to-wstring (string wchar-buf wchar-count)

  (cffi:lisp-string-to-foreign

   string

   wchar-buf

   (* wchar-count (cffi:foreign-type-size 'win32:wchar))

   :encoding win32:+win32-string-encoding+))

(defun wstring-to-lisp (wchar-buf wchar-count)

  (values

   (cffi:foreign-string-to-lisp

    wchar-buf

    :count (* wchar-count (cffi:foreign-type-size 'win32:wchar))

    :encoding win32:+win32-string-encoding+)))

```

### C Types

Most of WinAPI is defined in terms of Windows' own types, with well-defined size across ABI's, such as `win32:long`, `win32:char`, etc.

Occasionally, a type will be a bare C type instead. In this case, the corresponding CFFI type will be used, such as `:int` or `:char`

## Probable Goals:

1. Separate into multiple source files and separate packages/systems to have a 

1:1 with the library DLLS (user32, gdi32 etc.).

2. Normalize and stabilize type names to avoid breakage if people use `win32` 

directly.