2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.rfc6020.repo;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.ImmutableList;
14 import java.io.IOException;
15 import java.io.InputStream;
16 import org.antlr.v4.runtime.CharStreams;
17 import org.antlr.v4.runtime.CommonTokenStream;
18 import org.antlr.v4.runtime.ParserRuleContext;
19 import org.antlr.v4.runtime.tree.ErrorNode;
20 import org.antlr.v4.runtime.tree.ParseTreeListener;
21 import org.antlr.v4.runtime.tree.ParseTreeWalker;
22 import org.antlr.v4.runtime.tree.TerminalNode;
23 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementLexer;
24 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
25 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser.StatementContext;
26 import org.opendaylight.yangtools.concepts.Identifiable;
27 import org.opendaylight.yangtools.yang.common.YangVersion;
28 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
29 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
30 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
31 import org.opendaylight.yangtools.yang.parser.impl.YangStatementParserListenerImpl;
32 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
33 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
34 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
35 import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter;
38 * This class represents implementation of StatementStreamSource in order to emit YANG statements using supplied
41 * @author Robert Varga
44 public final class YangStatementStreamSource implements Identifiable<SourceIdentifier>, StatementStreamSource {
45 private static final ParseTreeListener MAKE_IMMUTABLE_LISTENER = new ParseTreeListener() {
47 public void enterEveryRule(final ParserRuleContext ctx) {
52 public void exitEveryRule(final ParserRuleContext ctx) {
53 ctx.children = ctx.children == null ? ImmutableList.of() : ImmutableList.copyOf(ctx.children);
57 public void visitTerminal(final TerminalNode node) {
62 public void visitErrorNode(final ErrorNode node) {
67 private final YangStatementParserListenerImpl yangStatementModelParser;
68 private final SourceIdentifier identifier;
69 private final StatementContext context;
71 private YangStatementStreamSource(final SourceIdentifier identifier, final YangStatementParserListenerImpl parser,
72 final StatementContext context) {
73 this.identifier = Preconditions.checkNotNull(identifier);
74 this.yangStatementModelParser = Preconditions.checkNotNull(parser);
75 this.context = Preconditions.checkNotNull(context);
78 public static YangStatementStreamSource create(final YangTextSchemaSource source) throws IOException,
79 YangSyntaxErrorException {
80 final StatementContext context;
81 try (InputStream stream = source.openStream()) {
82 context = parseYangSource(stream);
85 final String sourceName = source.getSymbolicName().orElse(null);
86 final YangStatementParserListenerImpl parser = new YangStatementParserListenerImpl(sourceName);
87 return new YangStatementStreamSource(source.getIdentifier(), parser, context);
90 public static YangStatementStreamSource create(final SourceIdentifier identifier, final StatementContext context,
91 final String symbolicName) {
92 return new YangStatementStreamSource(identifier, new YangStatementParserListenerImpl(symbolicName), context);
96 public void writePreLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef) {
97 yangStatementModelParser.setAttributes(writer, stmtDef);
98 ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
102 public void writeLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
103 final PrefixToModule preLinkagePrefixes) {
104 writeLinkage(writer, stmtDef, preLinkagePrefixes, YangVersion.VERSION_1);
108 public void writeLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
109 final PrefixToModule preLinkagePrefixes, final YangVersion yangVersion) {
110 yangStatementModelParser.setAttributes(writer, stmtDef, preLinkagePrefixes, yangVersion);
111 ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
115 public void writeLinkageAndStatementDefinitions(final StatementWriter writer,
116 final QNameToStatementDefinition stmtDef, final PrefixToModule prefixes) {
117 writeLinkageAndStatementDefinitions(writer, stmtDef, prefixes, YangVersion.VERSION_1);
121 public void writeLinkageAndStatementDefinitions(final StatementWriter writer,
122 final QNameToStatementDefinition stmtDef, final PrefixToModule prefixes, final YangVersion yangVersion) {
123 yangStatementModelParser.setAttributes(writer, stmtDef, prefixes, yangVersion);
124 ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
128 public void writeFull(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
129 final PrefixToModule prefixes) {
130 writeFull(writer, stmtDef, prefixes, YangVersion.VERSION_1);
134 public void writeFull(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
135 final PrefixToModule prefixes, final YangVersion yangVersion) {
136 yangStatementModelParser.setAttributes(writer, stmtDef, prefixes, yangVersion);
137 ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
141 public SourceIdentifier getIdentifier() {
145 public ParserRuleContext getYangAST() {
149 private static StatementContext parseYangSource(final InputStream stream) throws IOException,
150 YangSyntaxErrorException {
151 final YangStatementLexer lexer = new YangStatementLexer(CharStreams.fromStream(stream));
152 final CommonTokenStream tokens = new CommonTokenStream(lexer);
153 final YangStatementParser parser = new YangStatementParser(tokens);
154 //disconnect from console error output
155 parser.removeErrorListeners();
157 final YangErrorListener errorListener = new YangErrorListener();
158 parser.addErrorListener(errorListener);
160 final StatementContext result = parser.statement();
161 errorListener.validate();
163 // Walk the resulting tree and replace each children with an immutable list, lowering memory requirements
164 // and making sure the resulting tree will not get accidentally modified. An alternative would be to use
165 // org.antlr.v4.runtime.Parser.TrimToSizeListener, but that does not make the tree immutable.
166 ParseTreeWalker.DEFAULT.walk(MAKE_IMMUTABLE_LISTENER, result);
172 public String toString() {
173 return MoreObjects.toStringHelper(this).add("identifier", getIdentifier()).toString();