Context Navigation

EbnfFormatterVisitor.java @ 40

Last change on this file since 40 was 37, checked in by zeiss, 14 years ago

Property svn:mime-type set to `text/plain`
File size: 17.0 KB

Rev	Line
[9]	1	package de.ugoe.cs.swe.bnftools.ui.formatter;
	2
[21]	3	import java.util.ArrayList;
[28]	4	import java.util.Stack;
[21]	5
[9]	6	import org.eclipse.emf.ecore.EObject;
[21]	7	import org.eclipse.xtext.parsetree.AbstractNode;
	8	import org.eclipse.xtext.parsetree.CompositeNode;
	9	import org.eclipse.xtext.parsetree.LeafNode;
	10	import org.eclipse.xtext.parsetree.NodeUtil;
[9]	11
	12	import de.ugoe.cs.swe.bnftools.ebnf.Atom;
[13]	13	import de.ugoe.cs.swe.bnftools.ebnf.BnfEntry;
[9]	14	import de.ugoe.cs.swe.bnftools.ebnf.DefinitionList;
[13]	15	import de.ugoe.cs.swe.bnftools.ebnf.DeltaEntry;
[9]	16	import de.ugoe.cs.swe.bnftools.ebnf.EtsiBnf;
	17	import de.ugoe.cs.swe.bnftools.ebnf.ExtRule;
	18	import de.ugoe.cs.swe.bnftools.ebnf.GlobalCombinator;
	19	import de.ugoe.cs.swe.bnftools.ebnf.GroupedSequence;
	20	import de.ugoe.cs.swe.bnftools.ebnf.HookCombinator;
[12]	21	import de.ugoe.cs.swe.bnftools.ebnf.Import;
[13]	22	import de.ugoe.cs.swe.bnftools.ebnf.ImportSection;
	23	import de.ugoe.cs.swe.bnftools.ebnf.MergeEntry;
[9]	24	import de.ugoe.cs.swe.bnftools.ebnf.MergeRule;
	25	import de.ugoe.cs.swe.bnftools.ebnf.OptionalSequence;
	26	import de.ugoe.cs.swe.bnftools.ebnf.RepeatedSequence;
	27	import de.ugoe.cs.swe.bnftools.ebnf.Rule;
	28	import de.ugoe.cs.swe.bnftools.ebnf.RuleCombinator;
	29	import de.ugoe.cs.swe.bnftools.ebnf.RuleReference;
	30	import de.ugoe.cs.swe.bnftools.ebnf.SectionHeading;
	31	import de.ugoe.cs.swe.bnftools.ebnf.SingleDefinition;
	32	import de.ugoe.cs.swe.bnftools.ebnf.StringRule;
	33	import de.ugoe.cs.swe.bnftools.ebnf.Term;
	34	import de.ugoe.cs.swe.bnftools.visitor.EbnfVisitor;
	35
	36	public class EbnfFormatterVisitor extends EbnfVisitor {
[34]	37	protected StringBuffer buf;
	38	protected FormatterConfig config;
	39	protected int bufferPositionFormattedTextNoWhitespaces = 0;
	40	protected int bufferPositionOriginalText = 0;
	41	protected int allCommentsPosition = 0;
	42	protected ArrayList<LeafNode> allComments = new ArrayList<LeafNode>();
[21]	43
[34]	44	protected boolean lastWasSectionHeading=false;
	45	protected CompositeNode parserEtsiBnfNode;
	46	protected String originalText;
	47	protected int bufferPositionFormattedText;
	48	protected String formattedText;
	49	protected String formattedTextNoWhitespaces;
	50	protected String originalTextNoWhitespaces;
	51	protected int newLineOffsetCounter = 0;
	52	protected int rightHandSideRuleOffset = 0;
	53	protected Stack<Integer> ruleSpacingStack = new Stack<Integer>();
	54	protected Double averageSingleDefinitionLength;
[17]	55
[9]	56	public EbnfFormatterVisitor(EObject rootNode, FormatterConfig config) {
	57	super(rootNode);
	58	this.config = config;
	59	buf = new StringBuffer();
	60	}
	61
	62	public EbnfFormatterVisitor(FormatterConfig config) {
	63	this.config = config;
	64	buf = new StringBuffer();
	65	}
	66
	67	public StringBuffer getBuf() {
	68	return buf;
	69	}
	70
[37]	71	protected boolean isCommentNode(LeafNode node) {
[21]	72	if ((node.getText().trim().startsWith("//") \|\| node.getText().trim().startsWith("/*")) && (node.isHidden()))
	73	return true;
	74	return false;
	75	}
	76
[37]	77	protected void collectAllComments(CompositeNode node) {
[21]	78	for (int i=0; i < node.getChildren().size(); i++) {
	79	AbstractNode currentNode = node.getChildren().get(i);
	80	if (currentNode instanceof LeafNode) {
	81	LeafNode leafNode = (LeafNode) currentNode;
	82	if (isCommentNode(leafNode)) {
	83	allComments.add(leafNode);
	84	}
	85	}
	86
	87	if (currentNode instanceof CompositeNode) {
	88	collectAllComments((CompositeNode) currentNode);
	89	}
	90	}
	91	}
	92
[37]	93	protected boolean isSingleLineComment(String str) {
[21]	94	if (str.startsWith("//"))
	95	return true;
	96	return false;
	97	}
	98
[37]	99	protected boolean isMultiLineComment(String str) {
[21]	100	if (str.startsWith("/*"))
	101	return true;
	102	return false;
	103	}
	104
[37]	105	protected boolean isWhitespace(char ch) {
[21]	106	if ((ch==' ') \|\| (ch == '\t') \|\| (ch == '\n') \|\| (ch == '\r'))
	107	return true;
	108	return false;
	109	}
	110
[37]	111	protected void skipWhitespacesOriginalText() {
[25]	112	while (bufferPositionOriginalText < originalText.length() && isWhitespace(originalText.charAt(bufferPositionOriginalText))) {
[21]	113	bufferPositionOriginalText++;
	114	}
	115	}
	116
[37]	117	protected void skipWhitespacesFormattedText(StringBuffer result) {
[25]	118	while (bufferPositionFormattedText < formattedText.length() && isWhitespace(formattedText.charAt(bufferPositionFormattedText))) {
[21]	119	result.append(formattedText.substring(bufferPositionFormattedText, bufferPositionFormattedText+1));
	120	bufferPositionFormattedText++;
	121	}
	122	}
	123
[37]	124	protected boolean isSingleLineCommentNext(String str, int position) {
[21]	125	if ((str.charAt(position) == '/') && (str.charAt(position) == '/'))
	126	return true;
	127	return false;
	128	}
	129
[37]	130	protected boolean isMultiLineCommentNext(String str, int position) {
[21]	131	if ((str.charAt(position) == '/') && (str.charAt(position) == '*'))
	132	return true;
	133	return false;
	134	}
	135
[37]	136	protected boolean isCommentNext(String str, int position) {
[21]	137	if (isSingleLineCommentNext(str, position) \|\| isMultiLineCommentNext(str, position))
	138	return true;
	139	else
	140	return false;
	141	}
	142
[37]	143	protected String scanBackWhitespaces(String str, int position) {
[22]	144	StringBuffer whiteSpaces = new StringBuffer();
	145	int currentPosition = position;
	146	while (isWhitespace(str.charAt(currentPosition))) {
	147	whiteSpaces.append(str.charAt(currentPosition));
	148	currentPosition--;
	149	}
	150	return whiteSpaces.toString();
	151	}
	152
[37]	153	protected String stripEndingNewline(String str) {
[22]	154	int position = str.length() - 1;
	155	while ((str.charAt(position) == '\n') \|\| (str.charAt(position) == '\r')) {
	156	position--;
	157	}
	158	return str.substring(0, position + 1);
	159	}
	160
[37]	161	protected int scanBackNewlinesCount(String str, int position) {
[24]	162	int newLinesCount = 0;
	163	int currentPosition = position;
	164	while ((str.charAt(currentPosition) == '\n') \|\| (str.charAt(currentPosition) == '\r')) {
	165	if (str.charAt(currentPosition) == '\n') {
	166	if (str.charAt(currentPosition - 1) == '\r') {
	167	currentPosition -= 2;
	168	} else {
	169	currentPosition -= 1;
	170	}
	171	newLinesCount++;
	172	} else if (str.charAt(currentPosition) == '\r') {
	173	currentPosition -= 1;
	174	newLinesCount++;
	175	}
	176	}
	177
	178	return newLinesCount;
	179	}
	180
[37]	181	protected void weaveComments() {
[21]	182	bufferPositionOriginalText = 0;
[25]	183	bufferPositionFormattedTextNoWhitespaces = 0;
[21]	184	bufferPositionFormattedText = 0;
	185
	186	StringBuffer result = new StringBuffer();
[25]	187	formattedTextNoWhitespaces = buf.toString().replaceAll("[ \t\n\r]", "");
[21]	188	formattedText = buf.toString();
	189
[26]	190	while (bufferPositionFormattedTextNoWhitespaces <= formattedTextNoWhitespaces.length()) {
[21]	191	skipWhitespacesOriginalText();
	192	skipWhitespacesFormattedText(result);
[25]	193
	194	if (!(bufferPositionOriginalText < originalText.length()))
	195	break;
	196
[26]	197	char formattedPositionNoWhitespaces;
	198	if (bufferPositionFormattedTextNoWhitespaces == formattedTextNoWhitespaces.length()) {
	199	formattedPositionNoWhitespaces = ' ';
	200	} else {
	201	formattedPositionNoWhitespaces = formattedTextNoWhitespaces.charAt(bufferPositionFormattedTextNoWhitespaces);
	202	}
[25]	203	char originalPosition = originalText.charAt(bufferPositionOriginalText);
[21]	204
[25]	205	if (formattedPositionNoWhitespaces != originalPosition) {
	206	if (formattedPositionNoWhitespaces == ';') { // formatted text always outputs the optional semicolon, skip it if necessary
	207	bufferPositionFormattedTextNoWhitespaces++;
	208	bufferPositionFormattedText++;
	209	} else if (isCommentNext(originalText, bufferPositionOriginalText)) {
[21]	210	LeafNode currentComment = allComments.get(allCommentsPosition);
	211	if (currentComment.getTotalOffset() == bufferPositionOriginalText) {
	212	if (isMultiLineComment(currentComment.getText())) {
[24]	213	int newLinesCount = scanBackNewlinesCount(originalText, bufferPositionOriginalText-1);
	214	if (newLinesCount > 0) {
[25]	215	if (scanBackNewlinesCount(result.toString(), result.toString().length()-1) == 0) {
	216	result.append("\n\n");
	217	}
	218
[24]	219	result.append(currentComment.getText());
	220	result.append("\n");
	221	} else {
	222	String lastWhiteSpaces = scanBackWhitespaces(result.toString(), result.toString().length()-1);
	223	result.delete(result.toString().length() - lastWhiteSpaces.length(), result.toString().length());
	224	result.append(" " + stripEndingNewline(currentComment.getText()));
	225	result.append(lastWhiteSpaces);
	226	}
[23]	227	} else if (isSingleLineComment(currentComment.getText())) {
[24]	228	int newLinesCount = scanBackNewlinesCount(originalText, bufferPositionOriginalText-1);
[22]	229	String lastWhiteSpaces = scanBackWhitespaces(result.toString(), result.toString().length()-1);
	230	result.delete(result.toString().length() - lastWhiteSpaces.length(), result.toString().length());
[24]	231	if (newLinesCount > 0) {
	232	result.append("\n\n" + stripEndingNewline(currentComment.getText()));
	233	} else {
	234	result.append(" " + stripEndingNewline(currentComment.getText()));
	235	}
[22]	236	result.append(lastWhiteSpaces);
	237	}
[21]	238	bufferPositionOriginalText+=currentComment.getLength();
	239	allCommentsPosition++;
	240	}
[25]	241	} else { // disaster handling: return original unformatted text!
[31]	242	System.err.println("Disaster Recovery: returning original text!!");
[25]	243	buf = new StringBuffer();
	244	buf.append(originalText);
	245	return;
[21]	246	}
	247	} else {
	248	result.append(formattedText.substring(bufferPositionFormattedText, bufferPositionFormattedText+1));
	249	bufferPositionOriginalText++;
	250	bufferPositionFormattedText++;
[25]	251	bufferPositionFormattedTextNoWhitespaces++;
[21]	252	}
	253	}
	254	buf = result;
	255	}
[23]	256
[37]	257	protected void newLine() {
[27]	258	buf.append("\n");
[29]	259	if ((ruleSpacingStack != null) && (!ruleSpacingStack.empty())) {
	260	newLineOffsetCounter = ruleSpacingStack.peek();
	261	} else {
	262	newLineOffsetCounter = 0;
	263	}
[27]	264	}
[21]	265
[37]	266	protected void text(String str) {
[27]	267	buf.append(str);
[28]	268	newLineOffsetCounter += str.length();
[27]	269	}
	270
[37]	271	protected void space() {
[27]	272	buf.append(" ");
[28]	273	newLineOffsetCounter++;
[27]	274	}
[28]	275
[37]	276	protected void spaces(int count) {
[28]	277	for (int i=0; i < count; i++) {
	278	buf.append(" ");
	279	}
	280	}
[27]	281
[37]	282	protected boolean lastIsClosingParentheses() {
[31]	283	char ch = buf.toString().charAt(buf.toString().length()-1);
	284	if ((ch == ')') \|\| (ch == ']') \|\| (ch == '}'))
	285	return true;
	286	return false;
	287	}
	288
[37]	289	protected void wrap() {
[31]	290	if ((config.isWrapAfterThreshold()) && (newLineOffsetCounter > config.getWrapThreshold())) {
[32]	291	char last = buf.toString().charAt(buf.toString().length()-1);
	292	if (!((last == '(' \|\| last == '[' \|\| last == '{' ))) {
	293	newLine();
	294	if (ruleSpacingStack.size() > 1)
	295	spaces(ruleSpacingStack.peek() + 1);
	296	else
	297	spaces(ruleSpacingStack.peek());
	298	}
[31]	299	}
	300	}
	301
[9]	302	// -----------------------------------------------------------------------------
	303
[11]	304	protected void visitBefore(EtsiBnf node) {
[21]	305	parserEtsiBnfNode = NodeUtil.getNodeAdapter(node).getParserNode();
	306	collectAllComments(parserEtsiBnfNode);
	307	originalText = NodeUtil.getNodeAdapter(node).getParserNode().serialize();
	308	originalTextNoWhitespaces = originalText.replaceAll("[ \t\n\r]", "");
	309
[27]	310	text("grammar " + node.getName());
[9]	311	if (node.getType() != null)
[27]	312	text(node.getType());
	313	text(";");
[21]	314
[27]	315	newLine();
	316	newLine();
[9]	317	}
	318
[11]	319	protected void visitAfter(EtsiBnf node) {
[21]	320	weaveComments();
[9]	321	}
	322
[13]	323	protected void visitBefore(ImportSection node) {
	324	}
	325
	326	protected void visitAfter(ImportSection node) {
[27]	327	newLine();
[13]	328	}
	329
	330	protected void visitBefore(BnfEntry node) {
	331	}
	332
	333	protected void visitAfter(BnfEntry node) {
	334	}
	335
	336	protected void visitBefore(DeltaEntry node) {
	337	}
	338
	339	protected void visitAfter(DeltaEntry node) {
	340	}
	341
	342	protected void visitBefore(MergeEntry node) {
	343	}
	344
	345	protected void visitAfter(MergeEntry node) {
	346	}
	347
[11]	348	protected void visitBefore(Atom node) {
[9]	349	}
	350
[11]	351	protected void visitAfter(Atom node) {
[9]	352	}
	353
[11]	354	protected void visitBefore(Term node) {
[9]	355	}
	356
[11]	357	protected void visitAfter(Term node) {
[12]	358	if (!isLastElement())
[27]	359	space();
[9]	360	}
	361
[11]	362	protected void visitBefore(DefinitionList node) {
[30]	363	averageSingleDefinitionLength = null;
	364	int totalLength = 0;
	365	for (int i=0; i < node.eContents().size(); i++) {
	366	CompositeNode parseNode = NodeUtil.getNodeAdapter(node.eContents().get(i)).getParserNode();
	367	totalLength += parseNode.serialize().trim().length();
	368	}
	369	averageSingleDefinitionLength = (double) totalLength / (double) node.eContents().size();
[9]	370	}
	371
[11]	372	protected void visitAfter(DefinitionList node) {
[9]	373	}
	374
[11]	375	protected void visitBefore(ExtRule node) {
[9]	376	}
	377
[11]	378	protected void visitAfter(ExtRule node) {
[9]	379	}
	380
[11]	381	protected void visitBefore(GlobalCombinator node) {
[9]	382	}
	383
[11]	384	protected void visitAfter(GlobalCombinator node) {
[9]	385	}
	386
[11]	387	protected void visitBefore(HookCombinator node) {
[9]	388	}
	389
[11]	390	protected void visitAfter(HookCombinator node) {
[9]	391	}
	392
[11]	393	protected void visitBefore(Import node) {
[34]	394	text("import \"" + node.getImportURI() + "\"");
	395	if (node.getGrammarType() != null) {
	396	text("/" + node.getGrammarType());
	397	}
	398	if (node.getLabel() != null) {
	399	space();
	400	text("label: " + node.getLabel());
	401	}
	402	text(";");
[27]	403	newLine();
[9]	404	}
	405
[11]	406	protected void visitAfter(Import node) {
[9]	407	}
	408
[11]	409	protected void visitBefore(MergeRule node) {
	410	}
	411
	412	protected void visitAfter(MergeRule node) {
	413	}
	414
[31]	415	protected void visitBefore(GroupedSequence node) {
	416	wrap();
	417	text("(");
	418	ruleSpacingStack.push(newLineOffsetCounter-1);
	419	}
	420
	421	protected void visitAfter(GroupedSequence node) {
	422	// if ((config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) \|\| (lastIsClosingParentheses())) {
	423	if (config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) {
	424	newLine();
	425	spaces(ruleSpacingStack.peek());
	426	}
	427
	428	text(")");
	429	ruleSpacingStack.pop();
	430	}
	431
[11]	432	protected void visitBefore(OptionalSequence node) {
[31]	433	wrap();
[27]	434	text("[");
[31]	435	ruleSpacingStack.push(newLineOffsetCounter-1);
[11]	436	}
	437
	438	protected void visitAfter(OptionalSequence node) {
[31]	439	// if ((config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) \|\| (lastIsClosingParentheses())) {
	440	if (config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) {
	441	newLine();
	442	spaces(ruleSpacingStack.peek());
	443	}
	444
[27]	445	text("]");
[28]	446	ruleSpacingStack.pop();
[11]	447	}
	448
	449	protected void visitBefore(RepeatedSequence node) {
[31]	450	wrap();
[27]	451	text("{");
[31]	452	ruleSpacingStack.push(newLineOffsetCounter-1);
[11]	453	}
	454
	455	protected void visitAfter(RepeatedSequence node) {
[31]	456	// if ((config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) \|\| (lastIsClosingParentheses())) {
	457	if (config.isAlignParentheses() && (node.eContents().get(0).eContents().size() >= config.getAlignParenthesesElementCountThreshold())) {
	458	newLine();
	459	spaces(ruleSpacingStack.peek());
	460	}
	461
[27]	462	text("}");
[12]	463	if (node.isMorethanonce())
[27]	464	text("+");
[28]	465	ruleSpacingStack.pop();
[11]	466	}
	467
	468	protected void visitBefore(Rule node) {
[17]	469	if (lastWasSectionHeading)
[27]	470	newLine();
[17]	471
	472	lastWasSectionHeading=false;
	473
[28]	474	newLineOffsetCounter = 0;
	475
[11]	476	if (node.getRulenumber() > 0)
[27]	477	text(node.getRulenumber() + ". ");
[11]	478
[27]	479	text(node.getName() + " ::= ");
[28]	480
	481	rightHandSideRuleOffset = newLineOffsetCounter;
	482	ruleSpacingStack.push(newLineOffsetCounter);
[11]	483	}
	484
	485	protected void visitAfter(Rule node) {
[27]	486	text(";");
	487	newLine();
[28]	488	ruleSpacingStack.pop();
[11]	489	}
	490
	491	protected void visitBefore(RuleCombinator node) {
	492	}
	493
	494	protected void visitAfter(RuleCombinator node) {
	495	}
	496
	497	protected void visitBefore(RuleReference node) {
[31]	498	wrap();
[27]	499	text(node.getRuleref().getName());
[11]	500	}
	501
	502	protected void visitAfter(RuleReference node) {
	503	}
	504
	505	protected void visitBefore(SectionHeading node) {
[17]	506	if (!lastWasSectionHeading && !buf.substring(buf.length()-2).equals("\n\n"))
[27]	507	newLine();
[13]	508
[17]	509	lastWasSectionHeading=true;
	510
[27]	511	text(node.getSectionHeader());
[11]	512	}
	513
	514	protected void visitAfter(SectionHeading node) {
	515	}
	516
	517	protected void visitBefore(SingleDefinition node) {
	518	}
	519
	520	protected void visitAfter(SingleDefinition node) {
[30]	521	boolean preventAlternativeBreakShortAlternatives = config.isPreventNewLineAfterAlternativeOnShortAlternatives() && (averageSingleDefinitionLength <= config.getShortAlternativeThreshold());
[28]	522	if (!isLastElement()) {
[27]	523	text(" \| ");
[28]	524	if (config.isNewLineAfterAlternative()) {
	525	if (config.isPreventNewLineAfterAlternativeOnLessThanThreeElements()) {
	526	DefinitionList definitionList = (DefinitionList) node.eContainer();
[30]	527	if ((definitionList.eContents().size() > 2) && (!preventAlternativeBreakShortAlternatives)) {
[28]	528	newLine();
[31]	529	if (ruleSpacingStack.size() > 1)
	530	spaces(ruleSpacingStack.peek() + 1);
	531	else
	532	spaces(ruleSpacingStack.peek());
[28]	533	}
	534	} else {
[30]	535	if (!preventAlternativeBreakShortAlternatives) {
	536	newLine();
[31]	537	if (ruleSpacingStack.size() > 1)
	538	spaces(ruleSpacingStack.peek() + 1);
	539	else
	540	spaces(ruleSpacingStack.peek());
[30]	541	}
[28]	542	}
	543	}
	544	}
[11]	545	}
	546
	547	protected void visitBefore(StringRule node) {
[31]	548	wrap();
[11]	549	if (node.getLiteral() != null)
[27]	550	text("\"" + node.getLiteral() + "\"");
[11]	551	else if (node.getColon() != null)
[27]	552	text("\"\"\"");
[11]	553	}
	554
	555	protected void visitAfter(StringRule node) {
	556	}
	557
[9]	558	}

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format