gazebosim / gazebosim/sdformat

ign.hh: Does not expose all functions consumed by `ign sdf`?

Open
#323 2 comments 2 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
216
Forks
125
Avg merge
1d 14h
Merged PRs (30d)
14

Description

At present (f94626a889), `libsdformat` only exposes these functions in `ign.hh`:
https://github.com/osrf/sdformat/blob/f94626a8898b0a2898ae65892d76fd1031456133/src/ign.hh#L30-L37

However, `ign.cc` defines more (`cmdDescribe`, `cmdPrint`):
https://github.com/osrf/sdformat/blob/f94626a8898b0a2898ae65892d76fd1031456133/src/ign.cc

These are consumed by the intermediate Ruby script:
https://github.com/osrf/sdformat/blob/f94626a8898b0a2898ae65892d76fd1031456133/src/cmd/cmdsdformat.rb.in#L150-L158

It would be nice if these were exposed via the header file.

In https://github.com/robotlocomotion/drake/pull/13767, I want to use the `check` and `print` functionality to lint and convert models.

(I'm OK-ish with it being an unstable private API, but if it's there, would be nice to have it be consistent?)

Contributor guide

Open the contributing guide

Research direction

Compare the declarations in src/ign.hh with the implementations in src/ign.cc and the calls from src/cmd/cmdsdformat.rb.in. Determine how cmdDescribe and cmdPrint should be exposed consistently, then verify that the ign sdf check and print functionality can use the exposed API.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, ruby
Domain
api, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.