Initial commit of cl-win32-errors library

Author: Andrew D. France

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+# .github/workflows/ci.yml
+
+name: CI
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+jobs:
+  test:
+    runs-on: windows-latest
+    
+    env:
+      LISP: sbcl-bin
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Common Lisp
+        uses: 40ants/setup-lisp@v4
+        with:
+          asdf-system: cl-win32-errors
+
+      - name: Install Dependencies & Run Tests
+        shell: lispsh -eo pipefail {0}
+        run: |
+          ros install fiveam
+          ros --eval "(asdf:test-system :cl-win32-errors)" --quit

.gitignore

@@ -0,0 +1,19 @@
+*.fasl
+*.lib
+*.x86f
+*.x64f
+*.ax64f
+*.lx64f
+*.aarch64f
+*.ppcf
+*.dfsl
+*.lf
+*~
+#*#
+.*.swp
+.roswell/
+.idea/
+.vscode/
+*.elc
+.qlot/
+qlfile.lock

CHANGELOG.md

@@ -0,0 +1,21 @@
+# 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/ "null").
+
+## [1.0.0] - 2025-07-25
+
+### Added
+
+- Initial release of `cl-win32-errors`.
+  
+- A comprehensive mapping of over 2,300 Windows API error codes to their symbolic names and descriptions.
+  
+- Core API functions (`get-error-details`, `format-error-message`) for error code translation.
+  
+- A `win32-error` condition system with accessors for idiomatic Lisp error handling.
+  
+- ASDF system definitions for the library (`cl-win32-errors`) and its test suite (`cl-win32-errors/tests`).
+  
+- Full unit test suite using FiveAM to verify API correctness and data integrity.

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,159 @@
+# cl-win32-errors
+
+A Common Lisp library for translating cryptic Windows API error codes into human-readable information. When working with CFFI, Windows functions often return numeric error codes. This library provides a simple interface to convert these codes into their symbolic names, hexadecimal values, and descriptive strings, complete with a condition system for error handling.
+
+This project is the logical companion to [cl-win32-types](https://github.com/ItsMeForLua/cl-win32-types).
+
+## Features
+
+- **Error Mapping:** Translates over 2,300 system error codes across numerous categories, including core system, networking, RPC, security, Active Directory, DNS, and more.
+  
+- **Extensible:** The library is structured to make adding new error code definitions simple.
+  
+- **Condition System:** Provides a `win32-error` condition for idiomatic Lisp error handling.
+  
+- **User-Friendly API:** Simple functions to get error details or formatted strings.
+  
+- **ASDF System:** Ready for straightforward use via Quicklisp. The library and its tests are defined as separate systems.
+  
+
+## Installation (for Users)
+
+Once available in a Quicklisp distribution, you can load the library with:
+
+``` lisp
+(ql:quickload :cl-win32-errors)
+```
+
+## Developer Setup (for Contributors)
+
+This project uses [Qlot](https://github.com/fukamachi/qlot "null") to manage and lock dependency versions for reproducible builds.
+
+1. **Install Qlot** (one-time setup):
+  
+  ``` powershell
+  ros install qlot
+  ```
+  
+2. Install Project Dependencies:
+  
+  This command reads the qfile and installs the exact versions of all dependencies into a local .qlot/ directory.
+  
+  ``` powershell
+  # 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.
+  
+  ``` powershell
+  qlot exec ros run
+  ```
+  
+
+## Quick Start / Usage Example
+
+Here is the most common use case for the library. All functions are exported from the `cl-win32-errors` package.
+
+``` lisp
+;; Load the library
+(ql:quickload :cl-win32-errors)
+
+;; Look up an error code
+(cl-win32-errors:get-error-details 2)
+;; => (:CODE 2 :HEX "0x2" :SYMBOL :ERROR_FILE_NOT_FOUND
+;;     :DESCRIPTION "The system cannot find the file specified.")
+
+;; Get a formatted string directly
+(cl-win32-errors:format-error-message 5 :verbosity :verbose)
+;; => "Win32 Error 5 (0x5/ERROR_ACCESS_DENIED): Access is denied."
+```
+
+## API Reference
+
+### `get-error-details` (error-code)
+
+Looks up a numeric Win32 error code and returns a property list (plist) of its details.
+
+**Parameters:**
+
+- `error-code`: An integer representing the Windows error code.
+
+**Returns:** A plist with the keys `:code`, `:hex`, `:symbol`, and `:description`, or `NIL` if the code is not found.
+
+**Example:**
+
+``` lisp
+(get-error-details 5)
+;; => (:CODE 5 :HEX "0x5" :SYMBOL :ERROR_ACCESS_DENIED :DESCRIPTION "Access is denied.")
+```
+
+### `format-error-message` (error-code &key (verbosity :default))
+
+Formats a Win32 error code into a human-readable string.
+
+**Parameters:**
+
+- `error-code`: An integer representing the Windows error code.
+  
+- `:verbosity`: A keyword, either `:default` or `:verbose`. The `:verbose` option includes the hex code and symbolic name.
+  
+
+**Returns:** A formatted string.
+
+**Example:**
+
+``` lisp
+(format-error-message 87 :verbosity :verbose)
+;; => "Win32 Error 87 (0x57/ERROR_INVALID_PARAMETER): The parameter is incorrect."
+```
+
+## Condition System
+
+The library provides a `win32-error` condition for idiomatic error handling. You can signal it after a failed API call and use the provided accessors to inspect its details within a `handler-case`.
+
+**Condition Accessors:**
+
+- `win32-error-code` (condition): Returns the numeric error code.
+  
+- `win32-error-symbol` (condition): Returns the keyword symbol for the error.
+  
+- `win32-error-description` (condition): Returns the descriptive string for the error.
+  
+
+**Example of handling an error:**
+
+``` lisp
+(handler-case
+    ;; For example, signal an error after a failed API call
+    (error 'cl-win32-errors:win32-error :code 87)
+  (cl-win32-errors:win32-error (e)
+    (format t "Caught a Win32 Error!~%")
+    (format t "  Code: ~A~%" (cl-win32-errors:win32-error-code e))
+    (format t "  Symbol: ~A~%" (cl-win32-errors:win32-error-symbol e))
+    (format t "  Description: ~A~%" (cl-win32-errors:win32-error-description e))))
+```
+
+## Running Tests
+
+To run the test suite from the command line, use `qlot exec`:
+
+``` powershell
+qlot exec ros run --eval "(asdf:test-system :cl-win32-errors/tests)" --quit
+```
+
+Alternatively, from within a REPL started with `qlot exec ros run`:
+
+``` lisp
+(asdf:test-system :cl-win32-errors/tests)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. Please ensure the test suite passes before submitting a pull request.
+
+## License
+
+This project is licensed under the MIT License.

cl-win32-errors.asd

@@ -0,0 +1,36 @@
+;;;; cl-win32-errors.asd
+
+(defsystem #:cl-win32-errors
+  :description "A library for translating Windows API error codes."
+  :author "Your Name <[email protected]>"
+  :license "MIT"
+  :version "1.3.0"
+  :depends-on ()
+  :components ((:file "package")
+               (:file "cl-win32-errors" :depends-on ("package"))
+               ;; Load all the error code files from the src/ directory.
+               (:module "src"
+                :depends-on ("cl-win32-errors")
+                :components ((:file "core")
+                             (:file "network")
+                             (:file "rpc")
+                             (:file "security")
+                             (:file "extended")
+                             (:file "cluster")
+                             (:file "transactional")
+                             (:file "ds")
+                             (:file "dns")
+                             (:file "winsock")))))
+
+(defsystem #:cl-win32-errors/tests
+  :description "Test suite for cl-win32-errors."
+  :author "Your Name <[email protected]>"
+  :license "MIT"
+  :depends-on (:cl-win32-errors
+               :fiveam)
+  :components ((:module "tests"
+                :components ((:file "main"))))
+  :perform (test-op (op c)
+             (uiop:symbol-call :fiveam '#:run!
+                               (uiop:find-symbol* '#:cl-win32-errors-suite
+                                                  '#:cl-win32-errors/tests))))