Release imgui modules 0.0.1

Author: Sunrisepeak

.gitattributes

@@ -0,0 +1,7 @@
+*.cppm linguist-language=cpp
+*.cppm linguist-detectable=true
+*.cppm linguist-documentation=false
+
+*.mpp linguist-language=cpp
+*.mpp linguist-detectable=true
+*.mpp linguist-documentation=false

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  mcpp:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Xlings
+        env:
+          XLINGS_NON_INTERACTIVE: 1
+        run: |
+          curl -fsSL https://raw.githubusercontent.com/openxlings/xlings/refs/heads/main/tools/other/quick_install.sh | bash
+          echo "$HOME/.xlings/subos/current/bin" >> "$GITHUB_PATH"
+
+      - name: Install project tools
+        run: |
+          xlings update
+          xlings install
+
+      - name: Show mcpp version
+        run: mcpp --version
+
+      - name: Build library
+        run: mcpp build
+
+      - name: Run tests
+        run: mcpp test
+
+      - name: Run headless example
+        run: |
+          cd examples/basic
+          mcpp run
+
+      - name: Build GLFW/OpenGL3 example
+        run: |
+          cd examples/glfw_opengl3
+          mcpp build

.gitignore

@@ -0,0 +1,45 @@
+# mcpp
+target/
+gcm.cache/
+mcpp.lock
+compile_commands.json
+imgui.ini
+
+# xlings project environment
+.xlings/
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Linker files
+*.ilk
+
+# Debugger Files
+*.pdb
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Debug information files
+*.dwo
+*.d

.xlings.json

@@ -0,0 +1,5 @@
+{
+  "workspace": {
+    "xim:mcpp": "0.0.44"
+  }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 imgui module contributors
+
+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,102 @@
+# imgui
+
+C++23 module package for Dear ImGui on mcpp.
+
+This package uses `compat.imgui` for upstream Dear ImGui sources and provides
+module interfaces for the core API plus GLFW/OpenGL3 backend entry points.
+
+## Modules
+
+- `imgui.core`
+  - Core Dear ImGui context, frame, widget, and draw-data APIs.
+- `imgui.backend.glfw`
+  - GLFW platform backend plus a small GLFW window/context helper surface.
+- `imgui.backend.opengl3`
+  - OpenGL3 renderer backend.
+- `imgui.backend.glfw_opengl3`
+  - Convenience module that re-exports core, GLFW, and OpenGL3 backend modules
+    and provides combined lifecycle helpers.
+
+## Dependencies
+
+The root package depends on:
+
+- `compat.imgui = "1.92.8"`
+- `compat.glfw = "3.4"`
+- `compat.opengl = "2026.05.31"`
+
+The repository does not vendor Dear ImGui sources. Source and header files come
+from compat packages through mcpp dependency metadata.
+
+## Quick Start
+
+```bash
+mcpp build
+mcpp test
+cd examples/basic
+mcpp run
+```
+
+Expected headless example output:
+
+```text
+Dear ImGui 1.92.8 module frame ok
+```
+
+## Backend Example
+
+The GLFW/OpenGL3 example builds on CI but should be run only in an environment
+with a working display and OpenGL context:
+
+```bash
+cd examples/glfw_opengl3
+mcpp build
+mcpp run
+```
+
+## Consumer Usage
+
+```toml
+[dependencies]
+imgui = "0.0.1"
+```
+
+Then import the modules you need:
+
+```cpp
+import imgui.core;
+import imgui.backend.glfw_opengl3;
+
+int main() {
+    ImGuiContext* context = ImGui::CreateContext();
+    ImGui::SetCurrentContext(context);
+    ImGui::DestroyContext(context);
+}
+```
+
+## Module Surface
+
+`src/core.cppm` wraps `imgui.h` through a global module fragment and exports a
+tested core API surface:
+
+- Types: `ImGuiContext`, `ImFontAtlas`, `ImGuiIO`, `ImDrawData`, `ImVec2`.
+- Functions: context lifecycle, `GetIO`, `NewFrame`, `Begin`, `Button`,
+  `TextUnformatted`, `End`, `Render`, and `GetDrawData`.
+
+Backend modules adapt the official Dear ImGui backend headers internally and
+export explicit wrapper functions. Consumer code should only need module
+imports for the surfaces exposed by this package.
+
+## Verification
+
+The `0.0.1` release state is verified with mcpp `0.0.44`:
+
+- `mcpp build`
+- `mcpp test`
+- `cd examples/basic && mcpp run`
+- `cd examples/glfw_opengl3 && mcpp build`
+
+## License
+
+The wrapper code in this repository is MIT licensed. Dear ImGui is MIT licensed
+and provided by the `compat.imgui` package.

docs/architecture.md

@@ -0,0 +1,89 @@
+# Architecture
+
+This repository adapts Dear ImGui to the mcpp module workflow while keeping
+upstream source ownership in compat packages.
+
+## Goals
+
+- Let consumers use explicit module imports:
+  - `import imgui.core;`
+  - `import imgui.backend.glfw;`
+  - `import imgui.backend.opengl3;`
+  - `import imgui.backend.glfw_opengl3;`
+- Keep the package source small: module wrappers and backend implementation
+  translation units only.
+- Use `compat.imgui`, `compat.glfw`, and `compat.opengl` as the source and
+  header providers.
+- Provide both a headless core example and a real GLFW/OpenGL3 window example.
+
+## Layout
+
+```text
+.
+|-- mcpp.toml
+|-- src/
+|   |-- core.cppm
+|   `-- backends/
+|       |-- glfw.cppm
+|       |-- opengl3.cppm
+|       |-- glfw_opengl3.cppm
+|       |-- glfw_impl.cpp
+|       `-- opengl3_impl.cpp
+|-- tests/
+|   |-- imgui_test.cpp
+|   `-- backend_test.cpp
+`-- examples/
+    |-- basic/
+    `-- glfw_opengl3/
+```
+
+## Package Configuration
+
+The root `mcpp.toml` declares package `imgui`, lists the module wrappers and
+backend implementation translation units, and depends on compat packages:
+
+```toml
+[build]
+sources = [
+  "src/core.cppm",
+  "src/backends/glfw.cppm",
+  "src/backends/opengl3.cppm",
+  "src/backends/glfw_opengl3.cppm",
+  "src/backends/glfw_impl.cpp",
+  "src/backends/opengl3_impl.cpp",
+]
+
+[dependencies]
+compat.imgui = "1.92.8"
+compat.glfw = "3.4"
+compat.opengl = "2026.05.31"
+```
+
+The wrapper package does not vendor `third_party/imgui`. Upstream headers,
+core sources, and backend files are read from `compat.imgui`.
+
+## Module Wrappers
+
+`src/core.cppm` adapts upstream `imgui.h` internally, then exports selected
+types and functions with explicit `using` declarations. This keeps consumer code
+on `import imgui.core;` instead of requiring direct header usage.
+
+Backend module interfaces similarly adapt the official backend headers
+internally and export explicit wrapper functions. The implementation `.cpp`
+files compile upstream backend sources from `compat.imgui/backends` so consumers
+do not need to copy backend sources into their own package.
+
+## Validation
+
+Primary proof points:
+
+```bash
+mcpp build
+mcpp test
+cd examples/basic && mcpp run
+cd ../glfw_opengl3 && mcpp build
+```
+
+The GLFW/OpenGL3 example is a real windowed example. It is build-checked in
+headless CI and intended to be run on a machine with a working display/OpenGL
+context.

examples/basic/mcpp.toml

@@ -0,0 +1,11 @@
+[package]
+name        = "imgui-basic"
+version     = "0.1.0"
+description = "Headless consumer for the imgui.core module"
+license     = "MIT"
+
+[toolchain]
+linux = "llvm@20.1.7"
+
+[dependencies]
+imgui = { path = "../.." }

examples/basic/src/main.cpp

@@ -0,0 +1,25 @@
+import std;
+import imgui.core;
+
+int main() {
+    ImGuiContext* context = ImGui::CreateContext();
+    ImGui::SetCurrentContext(context);
+
+    ImGuiIO& io = ImGui::GetIO();
+    io.DisplaySize = ImVec2 { 320.0f, 240.0f };
+    unsigned char* fontPixels = nullptr;
+    int fontWidth = 0;
+    int fontHeight = 0;
+    io.Fonts->GetTexDataAsRGBA32(&fontPixels, &fontWidth, &fontHeight);
+
+    ImGui::NewFrame();
+    bool open = true;
+    ImGui::Begin("mcpp imgui", &open);
+    ImGui::TextUnformatted("hello from import imgui.core");
+    ImGui::End();
+    ImGui::Render();
+
+    std::println("Dear ImGui {} module frame ok", ImGui::GetVersion());
+    ImGui::DestroyContext(context);
+    return 0;
+}

examples/glfw_opengl3/mcpp.toml

@@ -0,0 +1,11 @@
+[package]
+name        = "imgui-glfw-opengl3"
+version     = "0.1.0"
+description = "GLFW and OpenGL3 consumer for imgui backend modules"
+license     = "MIT"
+
+[toolchain]
+linux = "llvm@20.1.7"
+
+[dependencies]
+imgui = { path = "../.." }