microsoft / microsoft/ifc-spec

TypeSort::Placeholder has surprising interior padding following "basis"

Open
#78 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
94
Forks
11
Avg merge
1d 29m
Merged PRs (30d)
2

Description

The IFC spec describes TypeSort::Placeholder as:

|-------------|-----------------------------|
| Name        | Type                        |
|-------------|-----------------------------|
| constraint  | ExprIndex                   |
| basis       | TypeBasis                   |
| elaboration | TypeIndex                   |
|-------------|-----------------------------|

The true representation is:

|-------------|-----------------------------|
| Name        | Type                        |
|-------------|-----------------------------|
| constraint  | ExprIndex                   |
| basis       | TypeBasis                   |
| __pading__  | uint8[3]                    |
| elaboration | TypeIndex                   |
|-------------|-----------------------------|

Ideally, this would be as follows to match other cases of padding in the IFC spec:

|-------------|-----------------------------|
| Name        | Type                        |
|-------------|-----------------------------|
| constraint  | ExprIndex                   |
| basis       | TypeBasis                   |
| elaboration | TypeIndex                   |
| __pading__  | uint8[3]                    |
|-------------|-----------------------------|

At a minimum, this padding should be documented in the spec.

Contributor guide

No contributing guide indexed for this repository

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

No file or test is named in the issue. Start by locating the TypeSort::Placeholder definition in the IFC specification and compare its padding order with the reported representation. Done means either matching the documented field order to the desired layout or documenting the existing uint8[3] padding.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.