microsoft / microsoft/CsWin32

Possible issue with `VS_FIXEDFILEINFO` generation/projection.

Open
#1,653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C#
Stars
2.5k
Forks
124
Avg merge
1d 3h
Merged PRs (30d)
9

Description

Actual behavior

Take the below snippet of partial source code emitted for VS_FIXEDFILEINFO, why are dwFileType and dwFileSubtype set up with getter/setter properties and private backing fields?

internal partial struct VS_FIXEDFILEINFO
{
    private winmdroot.Storage.FileSystem.VS_FIXEDFILEINFO_FILE_TYPE _dwFileType;

    private winmdroot.Storage.FileSystem.VS_FIXEDFILEINFO_FILE_SUBTYPE _dwFileSubtype;

    internal VS_FIXEDFILEINFO_FILE_TYPE dwFileType
    {
        get => (VS_FIXEDFILEINFO_FILE_TYPE)this._dwFileType;
        set => this._dwFileType = (winmdroot.Storage.FileSystem.VS_FIXEDFILEINFO_FILE_TYPE)value;
    }

    internal VS_FIXEDFILEINFO_FILE_SUBTYPE dwFileSubtype
    {
        get => (VS_FIXEDFILEINFO_FILE_SUBTYPE)this._dwFileSubtype;
        set => this._dwFileSubtype = (winmdroot.Storage.FileSystem.VS_FIXEDFILEINFO_FILE_SUBTYPE)value;
    }
}

Expected behavior

The backing fields are the same type, so I'd expect these to just be internal fields.

Repro steps

  1. NativeMethods.txt content:
VS_FIXEDFILEINFO
  1. NativeMethods.json content (if present): N/A

  2. Any of your own code that should be shared? N/A

Context
  • CsWin32 version: 0.3.269
  • Win32Metadata version (if explicitly set by project): N/A
  • Target Framework: net472
  • LangVersion (if explicitly set by project): N/A

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing generation from the NativeMethods.txt entry containing VS_FIXEDFILEINFO and inspect the emitted partial struct. Trace how the metadata types for dwFileType and dwFileSubtype are projected into C# properties and backing fields. Done means the generated members match the expected field shape and the regenerated output confirms the change.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.