parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/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.rfc7950.repo;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  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.opendaylight.yangtools.concepts.AbstractSimpleIdentifiable;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.common.QNameModule;
  21 import org.opendaylight.yangtools.yang.common.YangVersion;
  22 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  23 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  24 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  25 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementLexer;
  26 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementParser;
  27 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementParser.FileContext;
  28 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementParser.StatementContext;
  29 import org.opendaylight.yangtools.yang.parser.api.YangSyntaxErrorException;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.antlr.CompactYangStatementLexer;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.antlr.IRSupport;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.ir.IRKeyword;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.ir.IRStatement;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixResolver;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
  36 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter;
  40
  41 /**
  42  * This class represents implementation of StatementStreamSource in order to emit YANG statements using supplied
  43  * StatementWriter.
  44  *
  45  * @author Robert Varga
  46  */
  47 @Beta
  48 public final class YangStatementStreamSource extends AbstractSimpleIdentifiable<SourceIdentifier>
  49         implements StatementStreamSource {
  50     private final IRStatement rootStatement;
  51     private final String sourceName;
  52
  53     private YangStatementStreamSource(final SourceIdentifier identifier,  final IRStatement rootStatement,
  54             final String sourceName) {
  55         super(identifier);
  56         this.rootStatement = requireNonNull(rootStatement);
  57         this.sourceName = sourceName;
  58     }
  59
  60     /**
  61      * Create a {@link YangStatementStreamSource} for a {@link YangTextSchemaSource}.
  62      *
  63      * @param source YangTextSchemaSource, must not be null
  64      * @return A new {@link YangStatementStreamSource}
  65      * @throws IOException When we fail to read the source
  66      * @throws YangSyntaxErrorException If the source fails basic parsing
  67      */
  68     public static YangStatementStreamSource create(final YangTextSchemaSource source) throws IOException,
  69             YangSyntaxErrorException {
  70         return new YangStatementStreamSource(source.getIdentifier(),
  71             IRSupport.createStatement(parseYangSource(source)), source.getSymbolicName().orElse(null));
  72     }
  73
  74     /**
  75      * Create a {@link YangStatementStreamSource} for a {@link IRSchemaSource}.
  76      *
  77      * @param source YangTextSchemaSource, must not be null
  78      * @return A new {@link YangStatementStreamSource}
  79      * @throws NullPointerException if {@code source} is null
  80      */
  81     public static YangStatementStreamSource create(final IRSchemaSource source) {
  82         return create(source.getIdentifier(), source.getRootStatement(), source.getSymbolicName().orElse(null));
  83     }
  84
  85     public static YangStatementStreamSource create(final SourceIdentifier identifier, final IRStatement rootStatement,
  86             final String symbolicName) {
  87         return new YangStatementStreamSource(identifier, rootStatement, symbolicName);
  88     }
  89
  90     @Override
  91     public void writePreLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef) {
  92         new StatementContextVisitor(sourceName, writer, stmtDef, null, YangVersion.VERSION_1).visit(rootStatement);
  93     }
  94
  95     @Override
  96     public void writeLinkage(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
  97             final PrefixResolver preLinkagePrefixes, final YangVersion yangVersion) {
  98         new StatementContextVisitor(sourceName, writer, stmtDef, preLinkagePrefixes, yangVersion) {
  99             @Override
 100             StatementDefinition resolveStatement(final QNameModule module, final String localName) {
 101                 return stmtDef.getByNamespaceAndLocalName(module.getNamespace(), localName);
 102             }
 103         }.visit(rootStatement);
 104     }
 105
 106     @Override
 107     public void writeLinkageAndStatementDefinitions(final StatementWriter writer,
 108             final QNameToStatementDefinition stmtDef, final PrefixResolver prefixes, final YangVersion yangVersion) {
 109         new StatementContextVisitor(sourceName, writer, stmtDef, prefixes, yangVersion).visit(rootStatement);
 110     }
 111
 112     @Override
 113     public void writeFull(final StatementWriter writer, final QNameToStatementDefinition stmtDef,
 114             final PrefixResolver prefixes, final YangVersion yangVersion) {
 115         new StatementContextVisitor(sourceName, writer, stmtDef, prefixes, yangVersion) {
 116             @Override
 117             QName getValidStatementDefinition(final IRKeyword keyword, final StatementSourceReference ref) {
 118                 final QName ret = super.getValidStatementDefinition(keyword, ref);
 119                 if (ret == null) {
 120                     throw new SourceException(ref, "%s is not a YANG statement or use of extension.",
 121                         keyword.asStringDeclaration());
 122                 }
 123                 return ret;
 124             }
 125         }.visit(rootStatement);
 126     }
 127
 128     IRStatement rootStatement() {
 129         return rootStatement;
 130     }
 131
 132     static StatementContext parseYangSource(final YangTextSchemaSource source)
 133             throws IOException, YangSyntaxErrorException {
 134         try (InputStream stream = source.openStream()) {
 135             return parseYangSource(source.getIdentifier(), stream);
 136         }
 137     }
 138
 139     private static StatementContext parseYangSource(final SourceIdentifier source, final InputStream stream)
 140             throws IOException, YangSyntaxErrorException {
 141         final YangStatementLexer lexer = new CompactYangStatementLexer(CharStreams.fromStream(stream));
 142         final YangStatementParser parser = new YangStatementParser(new CommonTokenStream(lexer));
 143         // disconnect from console error output
 144         lexer.removeErrorListeners();
 145         parser.removeErrorListeners();
 146
 147         final YangErrorListener errorListener = new YangErrorListener(source);
 148         lexer.addErrorListener(errorListener);
 149         parser.addErrorListener(errorListener);
 150
 151         final FileContext result = parser.file();
 152         errorListener.validate();
 153         return verifyNotNull(result.statement());
 154     }
 155 }