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.

The newest version!

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

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

/*-
 * #%L
 * Bash Plugin
 * %%
 * Copyright (C) 2016 - 2018 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 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;

/**
 * Parser block using parser and lexer generated using the grammar specified
 * using antlr4.
 */
public class DocBlockParser {

  /**
   * Parse the block using parser and lexer.
   *
   * @param inputStream
   * @return DocBlock object
   * @throws IOException
   *           IOException
   */
  public DocBlock parse(final 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;
  }

}