Difference between revisions of "Object Inspector"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Calling from a Basic Macro)
(update repo link to post-graduation location)
 
(79 intermediate revisions by 8 users not shown)
Line 1: Line 1:
== '''The new Object Inspector''' ==
+
The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary UNO-Objects.  
The Object Inspector is an OpenOffice.org extension that is to help the developer to inspect arbitrary Uno-Objects. As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several „deficiencies“. The Object Inspector is still under development.
+
UNO provides a service-oriented API with abstract service descriptions exporting defined interfaces. The capabilities of a UNO Object do not open up to the developer at design time, mainly due to several "deficiencies".  
 +
Please note that the Object Inspector is still under development.
  
== '''The Problem''' ==
+
== The Problem ==
  
Generic interfaces like „XPropertySet“ or „XIndexAcess“ do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.
+
Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html XIndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.
  
It is not always clear at design time which services a Uno-object actually supports.
+
It is not always clear at design time which services a UNO object actually supports.
  
Documentation bugs. As service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a Uno object.
+
Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties, there may be a certain difference between the theoretical and the practical capabilities of a UNO object.
  
== '''The Solution''' ==
+
== The Solution ==
The conclusion is that it has be be inspected during runtime what respective capabilities a Uno-Object actually has. The new Object Inspector is an OpenOffice extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of  a „living Uno-object“ such as all supported services, exported interfaces, and their respective methods and properties in a treeview window.
+
  
 +
The conclusion is that a runtime inspection is necessary to determine what respective capabilities a UNO object actually has.
 +
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living UNO-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.
  
== '''Usage''' ==
+
== Usage ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/files/documents/22/3674/Inspector.uno.pkg] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected a Uno-object. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
+
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt Inspector.oxt] .  
  
Methods of Uno-objects  are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear.
+
Together with the new package a new toolbar is added from which the object inspector may be started.  
 +
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:
  
Properties of Uno-objects are presented as subnodes under a „Properties“ node.  
+
Methods of UNO objects are presented as subnodes below a "Method" node. All methods are listed below this node, no matter what their parental interfaces are.
  
„Interface“ nodes offer a view to all methods by arranging them under their respective interface.
+
Properties of UNO objects are presented as subnodes below a "Properties" node.  
  
„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
+
"Interface" nodes offer a view to all methods by arranging them under their respective interface.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"
+
  
Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.
+
"Service" nodes offer a view to all supported services of a UNO object and their respectively exported interfaces and properties.
  
The menubar consists of several menus:
+
Expanding any arbitrary subnode will inspect the UNO object that is represented by the node in the same way as described above.
  
„File“ menu to remove tab panes and to quit the object inspector.
+
=== Screenshots ===
  
„Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
+
[[Image:ObjectInspector.png|600px]]
empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
+
Menu entries for the so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
+
The currently selected object. This menu entry references the Uno-object of the currently selected node.  This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
+
The global service manager, that can be used to instantiate a great variety of services.
+
  
„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and  „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.
+
=== Calling from a Basic Macro ===
  
„Options“menu to be used to set all kind of options. It is not yet implemented.
+
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:
  
„Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
+
<source lang="oobas">
A context menu can be applied on selected nodes and offers some functions to
+
Sub Main
1) inspect the object behind the selected node in a new tabpane
+
oInspector = createUnoService("org.openoffice.InstanceInspector")
2) add the source code needed to retrieve the Uno-object behind the node to the textfield in the bottom of the dialog.
+
oInspector.inspect(ThisComponent, "My Document")
3) get Help to the referred API functionality like via the "Help" menu
+
End Sub
 +
</source>
  
== '''Filtering''' ==
+
=== Sourcecode generation ===
  
As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.
+
The Object Inspector is also able to generate Sourcecode snippets that show how to:
  
[[Image:Inspector.png]]
+
* query an interface (if necessary in the selected language)
 +
* invoke a method
 +
* retrieve a property value
  
Illustration 1 Object Inspector
+
Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well. See [[ObjectInspectorComparison|Object Inspector Comparison]].
  
== Calling from a Basic Macro ==
+
=== IDL help ===
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:
+
<font color="red">Currently broken</font>
  
<code>[cpp]
+
The user may retrieve help about selected nodes from the IDL files of the respective interface and service descriptions.
Sub Main
+
oInspector = createUnoService("org.openoffice.InstanceInspector")
+
oInspector.inspect(ThisComponent, "My Document")
+
End Sub
+
</code>
+
  
== Source-code generation ==
+
== Development ==
  
 +
=== Source code ===
  
The Object inspector now is also capable to generate Source Code that is needed to create the Object or primitve value returned of the current selected node.  Starting from an the root object, denoted as „<ENTRYOBJECT>“, all needed variables are declared and defined automatically as well as import statements(for C++ include statements).
+
You will find the Object Inspector source code within the OpenOffice.org Subversion Repository:
  
 +
  svn co svn://svn.apache.org/repos/asf/openoffice/trunk/main/odk/examples/java/Inspector/
  
== '''Problems and Todos''' ==
+
The checked in source contains a complete NetBeans project, so that one can immediately start hacking around. Feel free to commit bugfixes and changes or contact cli(at)openoffice.org if you like to take over the project.
  
Interfaces that are exported by an Uno-Object although not being exported by any of the suported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.
+
=== Known issues ===
  
The Object Inspector should be able to store data persistently in the registry. Such data would be a) the path to a local SDK -installation, which would then be preferrably used to get help content or b) configuration data such as the default programming language.
+
The Object inspector is still under development and the following list points to some known unresolved defects.
  
Treenodes representing methods currently can only be called once which is not sufficient for methods that may return diferent return values. Therefor it must be defined how this behaviour is implemented in the treeview control.
+
* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
Currently not all variable types are handled correctly. One big issue in this context is the correct assignment of object variables as method parameters. It has to be specified how the object values of the parameters are defined. It will result in a reference setup by the path of the respective treeview control node that the user can select. By means of the context menu the userer then has the possibility to copy the path to the dialog where the method parameters can be entered.
+
* IDL help is not working (including context sensitive help)
 +
* C++ code not properly generated (it was better with previous version). [[Programming_OOoWriter#Going_further_with_Inspector|Read more here]] particularly [[Programming_OOoWriter#Java_Inspector_2| Java Inspector 2]] section.
  
Sourcecode in C++ or OpenOffice.org Basic is not yet implemented.
+
=== Future Enhancements ===
  
The design of the icon set should be overworked and extended in a final step
+
* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
 +
** Implementation of Array parameters with primitive elements.
 +
** Implementation of structs.
 +
** Implementation of an input mask to refer to UNO-Objects as method parameters.
 +
**Consider multidimensional arrays as method parameters and for return values.
  
Part of the functionality should be provided by a context menu mainly to be used to invoke actions from treenodes, like inspecting treenodes' Uno-objext in a new tabpane or copy
+
* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.
Uno-objects from a treenode to the parameter invocation input mask.
+
  
Instead of obtaining the help files from the internet at www.openoffice.org it could optionally be retrieved from a local sdk installation. The path to this installation would have to be set only once and the object inspector would be independent of internet access.
+
* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.
  
Implementation of different views on the inspected Uno-objects as already being mentioned above in the description of the „View“ menu
+
* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO object also depicts a container that exports interfaces like XIndexAccess.
  
 
== See Also ==
 
== See Also ==
 +
* [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0  Object Inspector binary file]
 +
* [[ObjectInspectorComparison|Object Inspector Comparison]]
 
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
 
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
+
* Bernard Marcelly's [[Extensions_development_basic#Xray_tool|XRay tool description]] in this wiki.
 +
* [http://extensions.services.openoffice.org/project/MRI MRI an Object Inspector] written on Python from the Extension Website.
 
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
 
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
+
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and AOOBasic)
 
+
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with AOOWriter
[[Category:Development]]
+
[[Category:API]]
 
+
 
[[Category:Extensions]]
 
[[Category:Extensions]]
Current CWS Name: [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Id=4285&Path=SRC680%2Fsdkinspector  sdkinspector]
 

Latest revision as of 10:12, 25 March 2014

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary UNO-Objects. UNO provides a service-oriented API with abstract service descriptions exporting defined interfaces. The capabilities of a UNO Object do not open up to the developer at design time, mainly due to several "deficiencies". Please note that the Object Inspector is still under development.

The Problem

Generic interfaces like XPropertySet or XIndexAccess do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties, there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

The Solution

The conclusion is that a runtime inspection is necessary to determine what respective capabilities a UNO object actually has. The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living UNO-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

Usage

The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from Inspector.oxt .

Together with the new package a new toolbar is added from which the object inspector may be started. The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of UNO objects are presented as subnodes below a "Method" node. All methods are listed below this node, no matter what their parental interfaces are.

Properties of UNO objects are presented as subnodes below a "Properties" node.

"Interface" nodes offer a view to all methods by arranging them under their respective interface.

"Service" nodes offer a view to all supported services of a UNO object and their respectively exported interfaces and properties.

Expanding any arbitrary subnode will inspect the UNO object that is represented by the node in the same way as described above.

Screenshots

ObjectInspector.png

Calling from a Basic Macro

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

Sub Main
	oInspector = createUnoService("org.openoffice.InstanceInspector")
	oInspector.inspect(ThisComponent, "My Document")
End Sub

Sourcecode generation

The Object Inspector is also able to generate Sourcecode snippets that show how to:

  • query an interface (if necessary in the selected language)
  • invoke a method
  • retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but should compile well. See Object Inspector Comparison.

IDL help

Currently broken

The user may retrieve help about selected nodes from the IDL files of the respective interface and service descriptions.

Development

Source code

You will find the Object Inspector source code within the OpenOffice.org Subversion Repository:

 svn co svn://svn.apache.org/repos/asf/openoffice/trunk/main/odk/examples/java/Inspector/

The checked in source contains a complete NetBeans project, so that one can immediately start hacking around. Feel free to commit bugfixes and changes or contact cli(at)openoffice.org if you like to take over the project.

Known issues

The Object inspector is still under development and the following list points to some known unresolved defects.

  • Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
  • IDL help is not working (including context sensitive help)
  • C++ code not properly generated (it was better with previous version). Read more here particularly Java Inspector 2 section.

Future Enhancements

  • Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
    • Implementation of Array parameters with primitive elements.
    • Implementation of structs.
    • Implementation of an input mask to refer to UNO-Objects as method parameters.
    • Consider multidimensional arrays as method parameters and for return values.
  • An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.
  • Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.
  • Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO object also depicts a container that exports interfaces like XIndexAccess.

See Also

Personal tools