Eclipse Community Forums: TMF (Xtext) » How to autowrap comments

Help

Home

Home » Modeling » TMF (Xtext) » How to autowrap comments

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

How to autowrap comments [message #1785976]

Mon, 23 April 2018 17:43

Elie Richa

Messages: 72
Registered: February 2016

Member

Hello,

I would like to have the XText formatter of my language auto-wrap multi-line comments, and maybe even single-line comments (by joining together successive single-line comments).

So far I have been able to perform auto-wrapping for semantic elements by calling "autowrap" before or after certain keywords of the grammar. However comments are handled by MultilineCommentReplacer and SinglelineDocCommentReplacer.

I know that I can provide my own implementations of these classes by overriding AbstractFormatter2::createCommentReplacer() but I have no idea what I should do in the implementations that I provide.

Any hints? :)

Thanks!

--
Elie

Elie Richa, Ph.D
Software Engineer, AdaCore
https://www.adacore.com

Report message to a moderator

Re: How to autowrap comments [message #1785978 is a reply to message #1785976]

Mon, 23 April 2018 18:14

Christian Dietrich

Messages: 14665
Registered: July 2009

Senior Member

i have no idea how to properly implement it or elegantly but if you move to logic completely to your code you could try something like (just a starting point

if(ruleName.startsWith("ML")) return new MultilineCommentReplacer(comment, Character.valueOf('*').charValue) {
				
				override createReplacements(ITextReplacerContext context) {
					var ITextRegionAccess access = comment.getTextRegionAccess();
					val region = access.regionForOffset(comment.offset, comment.length)
					context.addReplacement(region.replaceWith("/* TODO */"))
					context
				}
				
			}

Twitter : @chrdietrich
Blog : https://www.dietrich-it.de

Report message to a moderator