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