Initial commit of cl-win32-types v1.0.0

Author: Andrew D. France

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+jobs:
+  test:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Common Lisp
+        uses: 40ants/setup-lisp@v4
+
+      - name: Install SBCL latest
+        shell: bash
+        run: |
+          ros config set sbcl-bin.version 2.5.6
+          ros install sbcl-bin
+      
+      - name: Install Dependencies & Run Tests
+        shell: bash
+        run: |
+          ros install fiveam
+          ros --eval "(asdf:test-system :cl-win32-types)" --quit

.gitignore

@@ -0,0 +1,25 @@
+# Compiled Lisp files
+*.fasl
+*.p
+*.dll
+*.so
+*.exe
+*.image
+
+# Editor backup files
+*~
+*.bak
+#*#
+
+# OS-specific files
+.DS_Store
+Thumbs.db
+
+# Roswell
+.roswell/
+
+# ASDF cache
+/asdf-cache/
+
+# Qlot local dependencies
+/.qlot/

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "streetsidesoftware.code-spell-checker"
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [1.0.0] - 2025-07-20
+
+### Added
+- Initial release of `cl-win32-types`.
+- An exhaustive set of CFFI type aliases for the Windows API.
+- ASDF system definitions for the library, tests, and benchmarks.
+- Full unit test suite using FiveAM to verify type correctness.
+- Detailed performance benchmark suite using `trivial-benchmark`.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **[email protected]**. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interaction in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Andrew D. France
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,124 @@
+# cl-win32-types
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Quicklisp](https://img.shields.io/badge/Quicklisp-available-brightgreen.svg)](http://quicklisp.org/)
+
+A comprehensive set of CFFI type definitions for the Windows API, designed for seamless integration with modern Common Lisp development environments on Windows.
+
+## Overview
+
+This package provides an exhaustive set of 45 CFFI type definitions for the Windows C API (e.g., `DWORD`, `HANDLE`, `WCHAR`, `BOOL`). It is built for production use with Common Lisp (i.e., SBCL) on Windows. The system is designed to be modular, well-documented, and includes very thorough test and benchmark suites.
+
+## Features
+
+* **Comprehensive Type Coverage**: Defines a wide range of standard Windows C types.
+* **Lisp-Idiomatic Naming**: Type names are lowercased (e.g., `dword` instead of `DWORD`) and use a `win-` prefix for types that clash with Common Lisp symbols (e.g., `win-char`).
+* **Platform Detection**: Includes compile-time checks to ensure pointer-sized types are defined correctly for 32-bit and 64-bit platforms, with a clear error for unsupported environments.
+* **ASDF System**: Ready for straightforward use via Quicklisp. The library, tests, and benchmarks are defined as separate systems.
+* **Comprehensive Test Suite**: Includes a full suite of unit tests using FiveAM to verify type sizes, ranges, and behavior.
+* **Performance Benchmarks**: Provides a detailed benchmark suite to measure FFI call overhead, memory allocation, and type conversion performance.
+
+## Installation (for Users)
+
+Once available in Quicklisp, you can load it with:
+
+```lisp
+(ql:quickload :cl-win32-types)
+```
+## Developer Setup (for Contributors)
+
+This project uses **Qlot** to manage and lock dependency versions for reproducible builds.
+
+1.  **Install Qlot** (one-time setup):
+    ```bash
+    ros install qlot
+    ```
+
+2.  **Install Project Dependencies**: This command reads the `qlfile.lock` and installs the exact versions of all dependencies into a local `.qlot/` directory.
+    ```bash
+    # Make sure you are in the project's root directory
+    qlot install
+    ```
+
+3.  **Start a REPL**: To work on the project, start your REPL using `qlot exec`. This ensures your Lisp session uses the project's local dependencies.
+    ```bash
+    qlot exec ros run
+    ```
+---
+
+## Usage Example
+
+Reference the types in your CFFI definitions. All types are exported from the `cl-win32-types` package.
+
+```lisp
+(defpackage #:my-windows-app
+  (:use #:cl #:cffi #:cl-win32-types))
+
+(in-package #:my-windows-app)
+
+(cffi:defcfun ("MessageBoxW" message-box-w) int
+  (hwnd    hwnd)
+  (text    lpcwstr)
+  (caption lpcwstr)
+  (type    uint))
+
+(defun show-hello-dialog ()
+  (message-box-w (cffi:null-pointer) "Hello from Common Lisp!" "My App" 0))
+```
+
+## Running Tests and Benchmarks
+
+* **To run the test suite**:
+    ```lisp
+    (asdf:test-system :cl-win32-types)
+    ```
+  * **Or with qlot:**
+    ```powershell
+    qlot exec ros run --eval "(asdf:test-system :cl-win32-types)" --quit
+    ```
+
+
+* **To run the benchmarks**:
+    ```lisp
+    (ql:quickload :cl-win32-types/benchmarks)
+    (cl-win32-types/benchmarks:run-all-benchmarks)
+    ```
+  * **Or with qlot:**
+    ```powershell
+    qlot exec ros --eval "(ql:quickload :cl-win32-types/benchmarks)" --eval "(cl-win32-types/benchmarks:run-all-benchmarks)" --quit
+    ```
+<details>
+<summary>Click to see sample benchmark output</summary>
+
+```text
+=== CL-WIN32-TYPES BENCHMARK SUITE ===
+
+--- Basic Type Benchmarks ---
+GetTickCount (DWORD return):
+-          SAMPLES  TOTAL     MINIMUM   MAXIMUM   MEDIAN    AVERAGE    DEVIATION
+REAL-TIME        3  0.002202  0.000583  0.000939  0.00068   0.000734   0.00015
+...
+
+--- Call Overhead Comparison ---
+Native Lisp function call:
+-          SAMPLES  TOTAL     MINIMUM   MAXIMUM   MEDIAN    AVERAGE    DEVIATION
+REAL-TIME        3  0.001002  0.000288  0.00042   0.000294  0.000334   0.000061
+
+CFFI function call (no args):
+-          SAMPLES  TOTAL     MINIMUM   MAXIMUM   MEDIAN    AVERAGE    DEVIATION
+REAL-TIME        3  0.022551  0.006851  0.008161  0.007539  0.007517   0.000535
+
+...
+
+=== BENCHMARK SUITE COMPLETE ===
+```
+
+</details>
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. Please ensure the test suite passes by running `(asdf:test-system :cl-win32-types)` before submitting a pull request.
+
+## License
+
+This project is licensed under the **MIT License**. See the `LICENSE` file for details.