Read Papyrus script docstring comment from .pex

! Read Papyrus Pex Docstring Comment.md

Read Papyrus .pex Docstring Comment

Example Script

scriptName MyScript
{This is the text that we are looking for, right here.

Oh, and it can have newlines.}

C++ code (using Champollion)

#include <Pex/FileReader.hpp>
#include <filesystem>
#include <format>
#include <iostream>

int main() {
    auto path = std::filesystem::current_path() / "../../MyScript.pex";
    auto pex = Pex::Binary();
    auto reader = Pex::FileReader(path.string());
    reader.read(pex);
    std::cout << pex.getObjects().front().getDocString().asString();
    // Prints out "This is the text that we are looking for, right here.\n\nOh..."
}

.gitignore

build

CMakeLists.txt

cmake_minimum_required(VERSION 3.21)
project(PexDocStringReader)
find_package(Champollion CONFIG REQUIRED)
add_executable(${PROJECT_NAME} main.cpp)
target_link_libraries(${PROJECT_NAME} PRIVATE Champollion::Champollion)

CMakePresets.json

{
    "version": 3,
    "configurePresets": [
        {
            "name": "Debug",
            "displayName": "Debug",
            "generator": "Ninja",
            "binaryDir": "${sourceDir}/build/${presetName}",
            "installDir": "${sourceDir}/install/${presetName}",
            "architecture": { "value": "x64", "strategy": "external" },
            "cacheVariables": {
                "CMAKE_CXX_COMPILER": "cl.exe",
                "CMAKE_CXX_FLAGS": "/std:c++20 /permissive- /Zc:preprocessor /EHsc /MP /W4 -DWIN32_LEAN_AND_MEAN -DNOMINMAX -DUNICODE -D_UNICODE",
                "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
                "VCPKG_TARGET_TRIPLET": "x64-windows-static-md",
                "VCPKG_OVERLAY_TRIPLETS": "${sourceDir}/cmake",
                "CMAKE_MSVC_RUNTIME_LIBRARY": "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL",
                "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
                "CMAKE_BUILD_TYPE": "Debug"
            }
        }
    ]
}

main.cpp

#include <Pex/FileReader.hpp>
#include <filesystem>
#include <format>
#include <iostream>

int main() {
    auto path = std::filesystem::current_path() / "../../MyScript.pex";
    auto pex = Pex::Binary();
    auto reader = Pex::FileReader(path.string());
    reader.read(pex);
    std::cout << pex.getObjects().front().getDocString().asString();
    // Prints out "This is the text that we are looking for, right here.\n..."
}

MyScript.pex

MyScript.psc

scriptName MyScript
{This is the text that we are looking for, right here.

Oh, and it can have newlines.}

Papyrus.ppj

<PapyrusProject Flags="TESV_Papyrus_Flags.flg" Game="sse" Output=".">
    <Imports>
        <Import>C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Data\Scripts\Source</Import>
    </Imports>
    <Folders>
        <Folder>.</Folder>
    </Folders>
</PapyrusProject>

vcpkg-configuration.json

{
  "default-registry": {
    "kind": "git",
    "repository": "https://github.com/microsoft/vcpkg.git",
    "baseline": "cc288af760054fa489574bd8e22d05aa8fa01e5c"
  },
  "registries": [
    {
      "kind": "git",
      "repository": "https://github.com/SkyrimScripting/vcpkg-dev.git",
      "baseline": "6bef2935934077c80b5a1278946c3c31c9e5a975",
      "packages": ["champollion"]
    }
  ]
}

vcpkg.json

{
    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
    "name": "example",
    "version-string": "0.0.1",
    "dependencies": ["champollion"]
}