com.exadatum.xsuite.xmaven.bash.doc.DocBlockParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bash-maven-plugin Show documentation

Bash Maven Plugin is used to generate documentation as well as to run unit test for bash scripts.

There is a newer version: 1.0.7

package com.exadatum.xsuite.xmaven.bash.doc;

/*-
 * #%L
 * Exadatum Bash Function Document Generator
 * %%
 * Copyright (C) 2016 - 2017 Exadatum Software Services Pvt. Ltd.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

import org.antlr.v4.runtime.CharStream;
import org.antlr.v4.runtime.CharStreams;
import org.antlr.v4.runtime.CommonTokenStream;
import org.antlr.v4.runtime.tree.ParseTreeWalker;

import com.exadatum.xsuite.xmaven.bash.doc.antlr4.BashDocLexer;
import com.exadatum.xsuite.xmaven.bash.doc.antlr4.BashDocParser;

public class DocBlockParser {

	public DocBlock parse(InputStream inputStream) throws IOException {
		CharStream charStream = CharStreams.fromStream(inputStream);
		BashDocLexer docLexer = new BashDocLexer(charStream);
		BashDocParser docParser = new BashDocParser(new CommonTokenStream(docLexer));
		ParseTreeWalker walker = new ParseTreeWalker();
		DocBlock docBlock = new DocBlock();
		walker.walk(new BashDocListener(docBlock), docParser.documentation());
		return docBlock;
	}

	public static void main(String[] args) throws Exception {
		DocBlockParser parser = new DocBlockParser();
		DocBlock block = parser.parse(new FileInputStream(
				"/Users/Shingate/Documents/Workspaces/XArchitect/bdoc-maven-plugin/src/test/resources/Sample.java"));
		System.out.println(block);
	}

}