Eclipse Community Forums: TMF (Xtext) » Javadoc-style context/hover information for rules/keywords

Home » Modeling » TMF (Xtext) » Javadoc-style context/hover information for rules/keywords(Display context sensitive when hovering over keywords)

Show: Today's Messages :: Show Polls :: Message Navigator

Javadoc-style context/hover information for rules/keywords [message #1008201]

Mon, 11 February 2013 06:52

Sebbes Neumann
Messages: 6
Registered: December 2010

Junior Member

Hi,

I am looking for a way to display the javadoc comment in the rule definition when hovering over the keyword. An example:

/**
 * My doc , this is how you use it
 */
TestClass: 'test' name=ID

When I use hover/click on 'test' in my editor I would like to see the javadoc as a popup? Hope someone can point me in the right direction.

Best regards,
Sebastian

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1008256 is a reply to message #1008201]

Mon, 11 February 2013 13:38

Christian Dietrich
Messages: 4444
Registered: July 2009

Senior Member

Hi,

you may have a look at org.eclipse.xtext.ui.editor.hover.AbstractEObjectHover.getXtextElementAt(XtextResource, int)
you will see that the hover is by default only shown for the significant region, which is the name

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1008524 is a reply to message #1008201]

Tue, 12 February 2013 15:30

Alexander Nittka
Messages: 1085
Registered: July 2009

Senior Member

Hi,

http://blogs.itemis.de/stundzig/archives/868 may serve as a starter to get hovers for keywords to work at all.

As far as I know, there is no way to access the grammar file at runtime (in order to get at the rules' comments), so you'll have to write an IGeneratorFragment that extracts that information from the grammar file. For a first prototype it will be easier to provide the information per keyword by hand.

Alex

Need training, onsite consulting or any other kind of help for Xtext?
Go visit http://xtext.itemis.com or send a mail to xtext@itemis.de

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1009125 is a reply to message #1008524]

Thu, 14 February 2013 08:47

Sebbes Neumann
Messages: 6
Registered: December 2010

Junior Member

Thanks, both Christian and Alexander. Will give it try.

Regards

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1059056 is a reply to message #1009125]

Thu, 16 May 2013 08:49

Sebbes Neumann
Messages: 6
Registered: December 2010

Junior Member

Hi,

if anyone is interested I resolved the 'hover' javadoc-like feature as follows; as my whole project is built with Maven I hooked in a Test file that reads my xtext file, parses it and writes the comments to a custom xml file. That file is then evaluated by binding my custom DocumentationProvider to the module. I evaluate the object name (class name) and read it from my XML file.

Might not be the most elegant solution, but it works and I only have to maintain my xtext file (that's where I have already put my comments).

Regards,
Sebastian

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1060564 is a reply to message #1008524]

Sun, 26 May 2013 23:06

rafael lima
Messages: 2
Registered: July 2012

Junior Member

Hi Alex,

I did as you sad (created a MydslEObjectHover class) and added the following lines in my MyDslUiModule class. It worked fine, but I had only one problem.

@Override
	public Class<? extends IEObjectHover> bindIEObjectHover() {
		return 	MydslEObjectHover.class;
	}

The EObject first is never an instance of Keyword, so the getHoverInfo method from super is always being called. Can you give some sugestion to handle it?

@Override
	public Object getHoverInfo(EObject first, ITextViewer textViewer,
			IRegion hoverRegion) {
		if (first instanceof Keyword) {
			return getHoverInfoForKeyword((Keyword) first);
		} else {
			return super.getHoverInfo(first, textViewer, hoverRegion);
		}
	}

Best Regards,
Rafael

Report message to a moderator

Re: Javadoc-style context/hover information for rules/keywords [message #1060569 is a reply to message #1060564]

Mon, 27 May 2013 02:22

Alexander Nittka
Messages: 1085
Registered: July 2009

Senior Member

Hi,

did you override the getXtextElementAt-method as described in the blog entry, as well? It is essential. Otherwise, keywords are not processed at all, as you notice.

Alex

Need training, onsite consulting or any other kind of help for Xtext?
Go visit http://xtext.itemis.com or send a mail to xtext@itemis.de

Report message to a moderator

Previous Topic:	Infer from external source
Next Topic:	Using a File located in workspace during Validation process

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Tue May 28 17:07:23 EDT 2013