org.eclipse.xtext.formatting2.regionaccess.IComment Java Examples

protected String toString(ITextSegment region) {
	String result;
	if (region instanceof IEObjectRegion)
		result = toString((IEObjectRegion) region);
	else if (region instanceof ISemanticRegion)
		result = toString((ISemanticRegion) region);
	else if (region instanceof IHiddenRegion)
		result = toString((IHiddenRegion) region);
	else if (region instanceof IWhitespace)
		result = toString((IWhitespace) region);
	else if (region instanceof IComment)
		result = toString((IComment) region);
	else if (region != null)
		result = region.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(region));
	else
		result = "null";
	if (hightlightOrigin && region == origin)
		return ">>>" + result + "<<<";
	return result;
}
 

@Override
public ITextReplacer createCommentReplacer(IComment comment) {
	final EObject grammarElement = comment.getGrammarElement();
	if (grammarElement instanceof AbstractRule) {
		final String ruleName = ((AbstractRule) grammarElement).getName();
		CommentReplacer replacer = null;
		if (ruleName.startsWith("ML")) { //$NON-NLS-1$
			replacer = new SARLMultilineCommentReplacer(comment);
		} else if (ruleName.startsWith("SL")) { //$NON-NLS-1$
			replacer = new SARLSinglelineCommentReplacer(comment);
		}
		if (replacer != null) {
			this.injector.injectMembers(replacer);
			return replacer;
		}
	}
	final String elementName = new GrammarElementTitleSwitch().showQualified().showRule().doSwitch(grammarElement);
	throw new IllegalStateException(
			MessageFormat.format(Messages.SARLFormatter_0,
					ITextReplacer.class.getSimpleName(), elementName));
}
 

public ITextReplacer createCommentReplacer(IComment comment) {
	EObject grammarElement = comment.getGrammarElement();
	if (grammarElement instanceof AbstractRule) {
		String ruleName = ((AbstractRule) grammarElement).getName();
		if (ruleName.startsWith("ML"))
			return new MultilineCommentReplacer(comment, '*');
		if (ruleName.startsWith("SL")) {
			if (comment.getLineRegions().get(0).getIndentation().getLength() > 0)
				return new SinglelineDocCommentReplacer(comment, "//");
			else
				return new SinglelineCodeCommentReplacer(comment, "//");
		}
	}
	String elementName = new GrammarElementTitleSwitch().showQualified().showRule().doSwitch(grammarElement);
	throw new IllegalStateException("No " + ITextReplacer.class.getSimpleName() + " configured for " + elementName);
}
 

/** Fixing the bug.
 *
 * @param context the replacement context.
 * @param comment the comment for which the fix must be applied.
 * @return the new context.
 */
@SuppressWarnings("static-method")
public ITextReplacerContext fix(final ITextReplacerContext context, IComment comment) {
	final IHiddenRegion hiddenRegion = comment.getHiddenRegion();
	if (detectBugSituation(hiddenRegion) && fixBug(hiddenRegion)) {
		// Indentation of the first comment line
		final ITextRegionAccess access = comment.getTextRegionAccess();
		final ITextSegment target = access.regionForOffset(comment.getOffset(), 0);
		context.addReplacement(target.replaceWith(context.getIndentationString(1)));
		// Indentation of the comment's lines
		return new FixedReplacementContext(context);
	}
	return context;
}
 

/** @see MultilineCommentReplacer#MultilineCommentReplacer(IComment, char) */
public N4MultilineCommentReplacer(IComment comment, char prefix) {
	super(comment, prefix);
	this.prefix = prefix;
	multiline = comment.isMultiline();

}
 

/** Fixing the bug.
 *
 * @param context the replacement context.
 * @param comment the comment for which the fix must be applied.
 * @return the new context.
 */
@SuppressWarnings("static-method")
public ITextReplacerContext fix(final ITextReplacerContext context, IComment comment) {
	final IHiddenRegion hiddenRegion = comment.getHiddenRegion();
	if (detectBugSituation(hiddenRegion)
			&& fixBug(hiddenRegion)) {
		// Indentation of the first comment line
		final ITextRegionAccess access = comment.getTextRegionAccess();
		final ITextSegment target = access.regionForOffset(comment.getOffset(), 0);
		context.addReplacement(target.replaceWith(context.getIndentationString(1)));
	}
	return context;
}
 

@Override
public ITextReplacerContext createReplacements(ITextReplacerContext context) {
	final IComment comment = getComment();
	if (context != null && comment != null) {
		this.formatter.formatSinglelineComment(this.bugfix.fix(context, comment), comment);
	}
	return context;
}
 

protected List<ITextSegment> collectAlternatingSpaceAndComments(boolean includeComments) {
	List<IHiddenRegionPart> parts = getParts();
	if (parts.isEmpty()) {
		return Collections.<ITextSegment>singletonList(this);
	} else {
		ITextSegment lastWhitespace = null;
		List<ITextSegment> result = Lists.newArrayList();
		for (IHiddenRegionPart part : parts) {
			if (part instanceof IWhitespace) {
				if (lastWhitespace == null) {
					result.add(part);
					lastWhitespace = part;
				} else {
					int mergedLength = lastWhitespace.getLength() + part.getLength();
					lastWhitespace = new TextSegment(access, lastWhitespace.getOffset(), mergedLength);
					result.set(result.size() - 1, lastWhitespace);
				}
			} else if (part instanceof IComment) {
				if (lastWhitespace == null) {
					result.add(new TextSegment(access, part.getOffset(), 0));
				} else {
					lastWhitespace = null;
				}
				if (includeComments) {
					result.add(part);
				}
			}
		}
		if (lastWhitespace == null) {
			result.add(new TextSegment(access, getEndOffset(), 0));
		}
		return ImmutableList.copyOf(result);
	}
}
 

@Override
public boolean containsComment() {
	for (IHiddenRegionPart hidden : hiddens)
		if (hidden instanceof IComment)
			return true;
	return false;
}
 

@Override
public ITextReplacerContext createReplacements(ITextReplacerContext context) {
	final IComment comment = getComment();
	if (context != null && comment != null) {
		this.formatter.formatMultilineComment(this.bugfix.fix(context, comment), comment);
	}
	return context;
}
 

protected ITextSegment getFirstSpace() {
	IComment comment = getComment();
	String text = comment.getText();
	if (!text.startsWith(prefix))
		return null;
	int start = prefix.length();
	for (int i = start; i < text.length(); i++) {
		char charAt = text.charAt(i);
		if (!Character.isWhitespace(charAt) || charAt == '\r' || charAt == '\n')
			return new TextSegment(comment.getTextRegionAccess(), comment.getOffset() + start, i - start);
	}
	return new TextSegment(comment.getTextRegionAccess(), comment.getOffset() + start, text.length() - start);
}
 

protected boolean hasEmptyBody() {
	IComment comment = getComment();
	String text = comment.getText();
	if (!text.startsWith(prefix))
		return false;
	int start = prefix.length();
	for (int i = start; i < text.length(); i++) {
		char charAt = text.charAt(i);
		if (!Character.isWhitespace(charAt))
			return false;
	}
	return true;
}
 

public IComment getComment() {
	return comment;
}
 

public RegionAccessor(ITextReplacerContext context, IComment comment) {
	super(comment.getText(), null);
	this.context = context;
	this.comment = comment;
	this.access = comment.getTextRegionAccess();
}
 

public void formatSinglelineComment(ITextReplacerContext context, IComment comment) {
	formatSinglelineComment(context.getIndentationString(), new RegionAccessor(context, comment));
}
 

@Pure
public void formatMultilineComment(ITextReplacerContext context, IComment comment) {
	formatMultlineComment(context.getIndentationString(), context.getNewLinesString(1), new RegionAccessor(context, comment));
}
 

public SinglelineCodeCommentReplacer(IComment comment, String prefix) {
	super(comment, prefix);
}
 

public CommentReplacer(IComment comment) {
	this.comment = comment;
}
 

public SinglelineCommentReplacer(IComment comment, String prefix) {
	super(comment);
	this.prefix = prefix;
}
 

public SinglelineDocCommentReplacer(IComment comment, String prefix) {
	super(comment, prefix);
}
 

public MultilineCommentReplacer(IComment comment, char prefix) {
	super(comment);
	this.prefix = prefix;
	this.multiline = comment.isMultiline();
}
 

protected String toString(IComment comment) {
	String text = quote(comment.getText());
	String gammar = toString(comment.getGrammarElement());
	String association = comment.getAssociation() + "";
	return String.format("%s Comment:%s Association:%s", text, gammar, association);
}
 

/** */
public FixedMultilineCommentReplacer(IComment comment) {
	super(comment);
	this.multiline = comment.isMultiline();
}
 

/**
 * Ctor for comment with indentation.
 *
 * @param comment
 *            to be processed
 */
public OffMultilineCommentReplacer(IComment comment) {
	this(comment, false);
}
 

/** Format the given multiline documentation.
 *
 * @param context the formatting context.
 * @param comment the comment to format out.
 */
@Pure
public void formatMultilineComment(ITextReplacerContext context, IComment comment);
 

/** Format the given singleline documentation.
 *
 * @param context the formatting context.
 * @param comment the comment to format out.
 */
@Pure
void formatSinglelineComment(ITextReplacerContext context, IComment comment);
 

/** Construct the replacer.
 *
 * @param comment the comment to format.
 */
public SARLMultilineCommentReplacer(IComment comment) {
	super(comment);
}
 

/** Construct the replacer.
 *
 * @param comment the comment to format.
 */
public SARLSinglelineCommentReplacer(IComment comment) {
	super(comment);
}
 

/**
 *
 * @param comment
 *            comment not to alter.
 * @param noIndent
 *            if true Comment will not be indented.
 */
public OffMultilineCommentReplacer(IComment comment, boolean noIndent) {
	super(comment);
	this.noIndent = noIndent;
}