Reflection compiler option

[tareksander]

Fixes #5492

Some questions:

• Is OSFilesystem the correct API to write a file?
• Does saveFile expect a NULL-terminated string? I kind of just expected it to, since there is no length argument.

All the reflection tests still seemed to pass.

[csyonghe]

Thank you for putting these together! It all looks good to me. Only minor comments.

Would also be good if we can also get this added to our COM-based compilation API, in the form of IComponentType::getReflectionJson(IBlob** outBlob).

[csyonghe]

Can use File::writeAllText().

[csyonghe]

Can you put this file under compiler-core instead of core?

[csyonghe]

For formatting, you can post a message in this thread with the content "/format" and you will get a pull request to your branch for the formatting changes.

[csyonghe]

This line has a warning that breaks the build on CI:

warning C4456: declaration of 'parameterCount' hides previous local declaration

[expipiplus1]

It's not necessary to do, but it would be nice if this handled passing - to output the json to stdout.

[csyonghe]

The code still needs to be formated.

[tareksander]

/format

[csyonghe]

There are linking errors.

[expipiplus1]

/format

(@tareksander, I just fixed a bug where non-write users couldn't trigger the formatting bot, I've done it now but it should work for you in the future)

[slangbot]

🌈 Formatted, please merge the changes from this PR

[tareksander]

Would also be good if we can also get this added to our COM-based compilation API, in the form of IComponentType::getReflectionJson(IBlob** outBlob).

I don't have enough knowledge of that API to do that.

There are linking errors.

Weird. slang-reflection-test links with the slang library, but the linker can't find Slang::emitReflectionJSON.

[csyonghe]

This is because slang is compiled as an DLL, and functions in a dll is generally not visible to other projects, unless you explicitly export it. You need to expose it in slang-deprecated.h similar to other reflection functions.

// declare in slang-deprecated.h and implement as follows:

SLANG_API SlangResult spReflection_ToJson(SlangReflection* reflection, SlangCompileRequest* request, IBlob** outBlob)
{
       PrettyWriter writer;
       emitReflectionJSON(request, reflection, writer);
       *outBlob = StringBlob::moveCreate(writer.getBuilder());
       return SLANG_OK;
}

Then you will be able to call this from reflection-test.

[tareksander]

This is because slang is compiled as an DLL, and functions in a dll is generally not visible to other projects, unless you explicitly export it. You need to expose it in slang-deprecated.h similar to other reflection functions.

Weird, since I'm on Linux, and symbols should be visible by default. That fixed it anyways, thanks.

Now I get a segfault in spReflection_GetTypeParameterCount during the test, no idea why.

[csyonghe]

This will break binary compatibility. New enum values should be added at the end.

[csyonghe]

The failures are due to C++ object lifetime issues.

You need to do:

*outObject = StringBlob::moveCreate(...).detach();

Otherwise the object will be deleted upon return.

Also changed the callsite to use

ComPtr<ISlangBlob> b;
spReflection_ToJson(..., b.writeRef());

instead of using raw ISlangBlob* pointer for b to ensure consistent life-time management.

I pushed the changes to your branch.

[csyonghe]

/format

[slangbot]

🌈 Formatted, please merge the changes from this PR

[csyonghe]

Everything looks good after fixing the memory management issue.
Thank you very much for your contribution!