Allow hiding the Introspectable interface #441
Closed
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.
Motivation
Many real-world applications hide the existence of the
org.freedesktop.DBus.Introspectable
interface on several nodes, yet provide introspection capabilities on these nodes. This primarily happens on intermediate nodes which do not have any other functionality.The reason for this seems to be to make DBus GUI tools nicer to use. D-Feet, or example, hides nodes that don't have any interfaces visible. That way, if you, for example, just have an object at
/com/example/test_object
, just that path will be shown, instead of three paths:/com
,/com/example
, and/com/example/test_object
.Change Description
I added a
hidden
field toIfaceDesc
,MethodDesc
,SignalDesc
, andPropDesc
. The goal of this PR would only require it to be added toIfaceDesc
, but for completeness sake, That property defaults tofalse
, and if it is set (by thehidden
function on theIfaceBuilder
,MethodDesc
,SignalBuilder
, orPropBuilder
.Why Draft?
I don't think the way I did it is the best way. Maybe instead of setting a property on the interface to hide, we should add an additional list to
Object
to represent interfaces hidden from introspection. A prior version of this PR used annotations to store thehidden
flag, but as it is not useful to render in the introspection, that was dropped.