Repository navigation
docs(parser): the direct C++ bridge stays in 1.x and freezes builtin layouts - #237
Merged
Merged
Conversation
…layouts Four documents and three header comments said SDK 1.0 removes the bridge through which a host casts a parser context to MessageParserPluginBase*. PlotJuggler 4 reads objects that way for every parser and never negotiates pj.parser_functional.v2, so the promise was false. The bridge is now documented as deprecated but supported through 1.x, and ARCHITECTURE.md section 0a states the rule that follows from it: the MessageParserPluginBase prefix, ObjectRecord, BuiltinObject, Expected and every builtin object struct are frozen layouts, and a member change in any of them is a MAJOR. A 1.x release lifts the freeze once the host reads objects through v2 only. No code changes: comments, docs and the changelog. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Four documents and three header comments said "SDK 1.0 removes the bridge", the path where a host casts a parser's opaque context to
MessageParserPluginBase*and callsparseObject().That is not what happens. PlotJuggler
maincontains no use ofpj.parser_functional.v2; it passesMessageParserPluginBase*through the session manager and the scene2D image, depth and video pipelines, for every parser. Shipping 1.0 with the old text would publish a promise the only host breaks.What changes
Docs, header comments and the changelog only. No code token changes.
pj_plugins/docs/ARCHITECTURE.mdsection 0a gains the rule that follows from it. While a host casts, these layouts are frozen like a C struct:MessageParserPluginBasemember prefix and virtual order,sdk::ObjectRecord,sdk::BuiltinObject,PJ::Expected,pj_base/builtin/.PJ_ABI_VERSIONnor theabidiffgate (a DataSource canary) detects it.CLAUDE.md(release rules),docs/builtin_type.md,REQUIREMENTS.md, the parser guide and the three headers.One thing 1.0 already did
1.0.0 changes two of those layouts:
sdk::Loggainscategoryandsdk::DepthImagegainsframe_id. A parser built against 0.x that returns either type must be rebuilt for a 1.0 host. I searched pj-official-pluginsmainand found no parser that returns either type. The changelog says so.Verification
Pre-commit passes. Nothing was built locally: the diff touches comments and Markdown only, and CI compiles the three headers.
🤖 Generated with Claude Code