ernie-renderer 0.2.0.dev43__tar.gz → 0.2.0.dev45__tar.gz

{ernie_renderer-0.2.0.dev43 → ernie_renderer-0.2.0.dev45}/.github/workflows/ci.yml

@@ -134,7 +134,7 @@ jobs:
       - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: "3.12"
-      - run: python -m pip install pytest
+      - run: python -m pip install pytest jsonschema
       - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
         with:
           name: build-${{ matrix.os }}
@@ -213,8 +213,10 @@ jobs:
           path: coverage
           retention-days: 14
 
-  # The documentation, built strictly so broken links and warnings fail.
+  # The documentation, built strictly so broken links and warnings fail, with the schema reference
+  # pages and the scene files' JSON Schema generated by the Linux build.
   docs:
+    needs: build
     runs-on: ubuntu-24.04
     timeout-minutes: 10
     steps:
@@ -222,6 +224,14 @@ jobs:
       - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: "3.12"
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: build-ubuntu-24.04
+      - name: Generate the schema reference
+        run: |
+          tar -xf build-ci.tar
+          build/ci/bin/ernie schema --json-schema docs/schema/ernie-scene.schema.json \
+            --markdown docs/reference
       - run: python -m pip install -r docs/requirements.txt
       - run: mkdocs build --strict
       - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2

{ernie_renderer-0.2.0.dev43 → ernie_renderer-0.2.0.dev45}/.gitignore

@@ -7,6 +7,9 @@ build/
 dist/
 site/
 .deps/
+# Generated by `ernie schema` before the docs build
+/docs/reference/
+/docs/schema/
 *.egg-info/
 __pycache__/
 .venv/

{ernie_renderer-0.2.0.dev43 → ernie_renderer-0.2.0.dev45}/CMakeLists.txt

@@ -15,7 +15,7 @@ project(
 )
 
 # Pre-release suffix such as .dev12, written by CI.
-set(ERNIE_VERSION_SUFFIX ".dev43" CACHE STRING "Pre-release suffix of Ernie's version")
+set(ERNIE_VERSION_SUFFIX ".dev45" CACHE STRING "Pre-release suffix of Ernie's version")
 set(ERNIE_VERSION "${PROJECT_VERSION}${ERNIE_VERSION_SUFFIX}")
 
 option(ERNIE_BUILD_TESTS "Build Ernie's tests" OFF)

{ernie_renderer-0.2.0.dev43 → ernie_renderer-0.2.0.dev45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ernie-renderer
-Version: 0.2.0.dev43
+Version: 0.2.0.dev45
 Summary: Efficient Renderer for Natural and Interplanetary Environments: a physically based, spectral Vulkan ray tracer
 Author: Alex Maietta
 License-Expression: BSD-3-Clause

ernie_renderer-0.2.0.dev45/docs/README.md

@@ -0,0 +1,10 @@
+# Docs
+
+The schema reference pages and the scene files' JSON Schema are generated from the schema registry by a build of `ernie`, before the site is built:
+
+```sh
+ernie schema --json-schema docs/schema/ernie-scene.schema.json --markdown docs/reference
+python -m pip install -r docs/requirements.txt
+mkdocs serve # live preview at http://127.0.0.1:8000
+mkdocs build # static site in site/
+```

ernie_renderer-0.2.0.dev45/ernie/app/main.cpp

@@ -0,0 +1,110 @@
+// SPDX-License-Identifier: BSD-3-Clause
+/// @file main.cpp
+/// @brief The ernie program.
+#include "ernie/device/vulkan_devices.h"
+#include "ernie/scene/reference.h"
+#include "ernie/util/file.h"
+#include "ernie/util/version.h"
+
+#include <cstdio>
+#include <exception>
+#include <filesystem>
+#include <string_view>
+#include <vector>
+
+namespace {
+
+namespace fs = std::filesystem;
+
+void PrintUsage() {
+    std::puts("Usage: ernie [--version] [--devices] [--help]\n"
+              "       ernie schema [--json-schema FILE] [--markdown DIR] [--usda DIR]\n"
+              "       ernie validate SCENE.json...");
+}
+
+int PrintDevices() {
+    for (const ernie::VulkanDeviceInfo& device : ernie::ListVulkanDevices()) {
+        std::printf("%s (%s, Vulkan %u.%u%s)\n", device.name.c_str(), ernie::ToString(device.type),
+                    device.apiMajor, device.apiMinor, device.rayQuery ? ", ray queries" : "");
+    }
+    return 0;
+}
+
+void Write(const fs::path& path, std::string_view text) {
+    if (path.has_parent_path()) {
+        fs::create_directories(path.parent_path());
+    }
+    ernie::WriteTextFile(path, text);
+}
+
+/// Writes the views of the schema registry that `arguments` ask for.
+int Schema(const std::vector<std::string_view>& arguments) {
+    if (arguments.empty() || arguments.size() % 2 != 0) {
+        PrintUsage();
+        return 2;
+    }
+    for (std::size_t i = 0; i < arguments.size(); i += 2) {
+        const fs::path out(arguments[i + 1]);
+        if (arguments[i] == "--json-schema") {
+            Write(out, ernie::SceneJsonSchema());
+        } else if (arguments[i] == "--markdown") {
+            for (const ernie::SchemaFamily& family : ernie::SchemaFamilies()) {
+                Write(out / (std::string(family.name) + ".md"), ernie::ReferencePage(family));
+            }
+        } else if (arguments[i] == "--usda") {
+            const ernie::UsdSchemaPlugin plugin = ernie::ErnieUsdSchemaPlugin();
+            Write(out / "generatedSchema.usda", plugin.generatedSchema);
+            Write(out / "plugInfo.json", plugin.plugInfo);
+        } else {
+            PrintUsage();
+            return 2;
+        }
+    }
+    return 0;
+}
+
+/// Prints every problem of the scene files; fails if any has one.
+int Validate(const std::vector<std::string_view>& files) {
+    if (files.empty()) {
+        PrintUsage();
+        return 2;
+    }
+    int status = 0;
+    for (const std::string_view file : files) {
+        for (const ernie::SceneProblem& problem :
+             ernie::ValidateScene(ernie::ReadTextFile(fs::path(file)))) {
+            std::printf("%.*s: %s\n", static_cast<int>(file.size()), file.data(),
+                        problem.Message().c_str());
+            status = 1;
+        }
+    }
+    return status;
+}
+
+}  // namespace
+
+int main(int argc, char** argv) {
+    const std::string_view option = argc > 1 ? argv[1] : "--help";
+    const std::vector<std::string_view> rest(argv + std::min(argc, 2), argv + argc);
+    try {
+        if (option == "--version") {
+            std::printf("ernie %.*s\n", static_cast<int>(ernie::Version().size()),
+                        ernie::Version().data());
+            return 0;
+        }
+        if (option == "--devices") {
+            return PrintDevices();
+        }
+        if (option == "schema") {
+            return Schema(rest);
+        }
+        if (option == "validate") {
+            return Validate(rest);
+        }
+        PrintUsage();
+        return option == "--help" ? 0 : 2;
+    } catch (const std::exception& error) {
+        std::fprintf(stderr, "ernie: %s\n", error.what());
+        return 1;
+    }
+}

{ernie_renderer-0.2.0.dev43 → ernie_renderer-0.2.0.dev45}/ernie/scene/CMakeLists.txt

@@ -5,10 +5,14 @@ add_library(
     extent_cache.cpp
     holder_index.cpp
     inherit.cpp
+    json.cpp
     path.cpp
+    reference.cpp
     schema.cpp
     scene.cpp
     storage.cpp
+    usd_plugin.cpp
+    validate.cpp
     view.cpp
     xform.cpp
     schemas/camera.cpp
@@ -24,4 +28,8 @@ add_library(
     schemas/shade.cpp
     schemas/vol.cpp
 )
-target_link_libraries(ernie_scene PUBLIC ernie_physics ernie_io PRIVATE ernie_build_options)
+target_link_libraries(
+    ernie_scene
+    PUBLIC ernie_physics ernie_io
+    PRIVATE ernie_json ernie_build_options
+)