yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/rfc6020/repo/YangStatementStreamSource.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc6020.repo;
   9
  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;
  36
  37 /**
  38  * This class represents implementation of StatementStreamSource in order to emit YANG statements using supplied
  39  * StatementWriter.
  40  *
  41  * @author Robert Varga
  42  */
  43 @Beta
  44 public final class YangStatementStreamSource implements Identifiable<SourceIdentifier>, StatementStreamSource {
  45     private static final ParseTreeListener MAKE_IMMUTABLE_LISTENER = new ParseTreeListener() {
  46         @Override
  47         public void enterEveryRule(final ParserRuleContext ctx) {
  48             // No-op
  49         }
  50
  51         @Override
  52         public void exitEveryRule(final ParserRuleContext ctx) {
  53             ctx.children = ctx.children == null ? ImmutableList.of() : ImmutableList.copyOf(ctx.children);
  54         }
  55
  56         @Override
  57         public void visitTerminal(final TerminalNode node) {
  58             // No-op
  59         }
  60
  61         @Override
  62         public void visitErrorNode(final ErrorNode node) {
  63             // No-op
  64         }
  65     };
  66
  67     private final YangStatementParserListenerImpl yangStatementModelParser;
  68     private final SourceIdentifier identifier;
  69     private final StatementContext context;
  70
  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);
  76     }
  77
  78     public static YangStatementStreamSource create(final YangTextSchemaSource source) throws IOException,
  79             YangSyntaxErrorException {
  80         final StatementContext context;
  81         try (final InputStream stream = source.openStream()) {
  82             context = parseYangSource(stream);
  83         }
  84
  85         final String sourceName = source.getSymbolicName().orElse(null);
  86         final YangStatementParserListenerImpl parser = new YangStatementParserListenerImpl(sourceName);
  87         return new YangStatementStreamSource(source.getIdentifier(), parser, context);
  88     }
  89
  90     @Override
  91     public void writePreLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef) {
  92         yangStatementModelParser.setAttributes(writer, stmtDef);
  93         ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
  94     }
  95
  96     @Override
  97     public void writeLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
  98             final PrefixToModule preLinkagePrefixes) {
  99         writeLinkage(writer, stmtDef, preLinkagePrefixes, YangVersion.VERSION_1);
 100     }
 101
 102     @Override
 103     public void writeLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
 104             final PrefixToModule preLinkagePrefixes, final YangVersion yangVersion) {
 105         yangStatementModelParser.setAttributes(writer, stmtDef, preLinkagePrefixes, yangVersion);
 106         ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
 107     }
 108
 109     @Override
 110     public void writeLinkageAndStatementDefinitions(final StatementWriter writer,
 111             final QNameToStatementDefinition stmtDef, final PrefixToModule prefixes) {
 112         writeLinkageAndStatementDefinitions(writer, stmtDef, prefixes, YangVersion.VERSION_1);
 113     }
 114
 115     @Override
 116     public void writeLinkageAndStatementDefinitions(final StatementWriter writer,
 117             final QNameToStatementDefinition stmtDef, final PrefixToModule prefixes, final YangVersion yangVersion) {
 118         yangStatementModelParser.setAttributes(writer, stmtDef, prefixes, yangVersion);
 119         ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
 120     }
 121
 122     @Override
 123     public void writeFull(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
 124             final PrefixToModule prefixes) {
 125         writeFull(writer, stmtDef, prefixes, YangVersion.VERSION_1);
 126     }
 127
 128     @Override
 129     public void writeFull(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
 130             final PrefixToModule prefixes, final YangVersion yangVersion) {
 131         yangStatementModelParser.setAttributes(writer, stmtDef, prefixes, yangVersion);
 132         ParseTreeWalker.DEFAULT.walk(yangStatementModelParser, context);
 133     }
 134
 135     @Override
 136     public SourceIdentifier getIdentifier() {
 137         return identifier;
 138     }
 139
 140     public ParserRuleContext getYangAST() {
 141         return context;
 142     }
 143
 144     /**
 145      * @deprecated Provided for migration purposes only. Do not use.
 146      */
 147     @Deprecated
 148     public static StatementContext parseYangSource(final InputStream stream) throws IOException,
 149             YangSyntaxErrorException {
 150         final YangStatementLexer lexer = new YangStatementLexer(CharStreams.fromStream(stream));
 151         final CommonTokenStream tokens = new CommonTokenStream(lexer);
 152         final YangStatementParser parser = new YangStatementParser(tokens);
 153         //disconnect from console error output
 154         parser.removeErrorListeners();
 155
 156         final YangErrorListener errorListener = new YangErrorListener();
 157         parser.addErrorListener(errorListener);
 158
 159         final StatementContext result = parser.statement();
 160         errorListener.validate();
 161
 162         // Walk the resulting tree and replace each children with an immutable list, lowering memory requirements
 163         // and making sure the resulting tree will not get accidentally modified. An alternative would be to use
 164         // org.antlr.v4.runtime.Parser.TrimToSizeListener, but that does not make the tree immutable.
 165         ParseTreeWalker.DEFAULT.walk(MAKE_IMMUTABLE_LISTENER, result);
 166
 167         return result;
 168     }
 169
 170     @Override
 171     public String toString() {
 172         return MoreObjects.toStringHelper(this).add("identifier", getIdentifier()).toString();
 173     }
 174 }