yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContextUtils.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.spi.meta;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Splitter;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.collect.ImmutableSet.Builder;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.function.Predicate;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.common.QNameModule;
  20 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  25 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
  26 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace.SupportedFeatures;
  27 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  28 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnknownStatementImpl;
  29
  30 public final class StmtContextUtils {
  31     public static final Splitter LIST_KEY_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
  32
  33     private static final Function<StmtContext<?, ?,?>, DeclaredStatement<?>> BUILD_DECLARED =
  34             new Function<StmtContext<?,?,?>, DeclaredStatement<?>>() {
  35         @Override
  36         public DeclaredStatement<?> apply(final StmtContext<?, ?, ?> input) {
  37             return input.buildDeclared();
  38         }
  39     };
  40
  41     private static final Function<StmtContext<?, ?,?>, EffectiveStatement<?,?>> BUILD_EFFECTIVE =
  42             new Function<StmtContext<?,?,?>, EffectiveStatement<?,?>>() {
  43         @Override
  44         public EffectiveStatement<?, ?> apply(final StmtContext<?, ?, ?> input) {
  45             return input.buildEffective();
  46         }
  47     };
  48
  49     private StmtContextUtils() {
  50         throw new UnsupportedOperationException("Utility class");
  51     }
  52
  53     @SuppressWarnings("unchecked")
  54     public static <D extends DeclaredStatement<?>> Function<StmtContext<?, ? extends D, ?>, D> buildDeclared() {
  55         return Function.class.cast(BUILD_DECLARED);
  56     }
  57
  58     @SuppressWarnings("unchecked")
  59     public static <E extends EffectiveStatement<?, ?>> Function<StmtContext<?, ?, ? extends E>, E> buildEffective() {
  60         return Function.class.cast(BUILD_EFFECTIVE);
  61     }
  62
  63     @SuppressWarnings("unchecked")
  64     public static <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(
  65             final Iterable<? extends StmtContext<?, ?, ?>> contexts, final Class<DT> declaredType) {
  66         for (StmtContext<?, ?, ?> ctx : contexts) {
  67             if (producesDeclared(ctx, declaredType)) {
  68                 return (AT) ctx.getStatementArgument();
  69             }
  70         }
  71         return null;
  72     }
  73
  74     @SuppressWarnings("unchecked")
  75     public static <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(final StmtContext<?, ?, ?> ctx,
  76             final Class<DT> declaredType) {
  77         return producesDeclared(ctx, declaredType) ? (AT) ctx.getStatementArgument() : null;
  78     }
  79
  80     public static <AT, DT extends DeclaredStatement<AT>> AT firstSubstatementAttributeOf(
  81             final StmtContext<?, ?, ?> ctx, final Class<DT> declaredType) {
  82         AT firstAttribute = firstAttributeOf(ctx.effectiveSubstatements(), declaredType);
  83         return firstAttribute != null ? firstAttribute : firstAttributeOf(ctx.declaredSubstatements(), declaredType);
  84     }
  85
  86     @SuppressWarnings("unchecked")
  87     public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstDeclaredSubstatement(
  88             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
  89         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
  90             if (producesDeclared(subStmtContext,declaredType)) {
  91                 return (StmtContext<AT, ?, ?>) subStmtContext;
  92             }
  93         }
  94         return null;
  95     }
  96
  97     @SuppressWarnings("unchecked")
  98     public static <AT, DT extends DeclaredStatement<AT>> Collection<StmtContext<AT, DT, ?>> findAllDeclaredSubstatements(
  99             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
 100         ImmutableList.Builder<StmtContext<AT, DT, ?>> listBuilder = ImmutableList.builder();
 101         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
 102             if (producesDeclared(subStmtContext, declaredType)) {
 103                 listBuilder.add((StmtContext<AT, DT, ?>) subStmtContext);
 104             }
 105         }
 106         return listBuilder.build();
 107     }
 108
 109     @SuppressWarnings("unchecked")
 110     public static <AT, DT extends DeclaredStatement<AT>> Collection<StmtContext<AT, DT, ?>> findAllEffectiveSubstatements(
 111             final StmtContext<?, ?, ?> stmtContext, final Class<DT> type) {
 112         ImmutableList.Builder<StmtContext<AT, DT, ?>> listBuilder = ImmutableList.builder();
 113         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.effectiveSubstatements()) {
 114             if (producesDeclared(subStmtContext, type)) {
 115                 listBuilder.add((StmtContext<AT, DT, ?>) subStmtContext);
 116             }
 117         }
 118         return listBuilder.build();
 119     }
 120
 121     public static <AT, DT extends DeclaredStatement<AT>> Collection<StmtContext<AT, DT, ?>> findAllSubstatements(
 122             final StmtContext<?, ?, ?> stmtContext, final Class<DT> type) {
 123         ImmutableList.Builder<StmtContext<AT, DT, ?>> listBuilder = ImmutableList.builder();
 124         listBuilder.addAll(findAllDeclaredSubstatements(stmtContext, type));
 125         listBuilder.addAll(findAllEffectiveSubstatements(stmtContext, type));
 126         return listBuilder.build();
 127     }
 128
 129     @SuppressWarnings("unchecked")
 130     public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstEffectiveSubstatement(
 131             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
 132         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.effectiveSubstatements()) {
 133             if (producesDeclared(subStmtContext,declaredType)) {
 134                 return (StmtContext<AT, ?, ?>) subStmtContext;
 135             }
 136         }
 137         return null;
 138     }
 139
 140     public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstSubstatement(
 141             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
 142         StmtContext<AT, ?, ?> declaredSubstatement = findFirstDeclaredSubstatement(stmtContext, declaredType);
 143         return declaredSubstatement != null ? declaredSubstatement : findFirstEffectiveSubstatement(stmtContext, declaredType);
 144     }
 145
 146     @SafeVarargs
 147     public static StmtContext<?, ?, ?> findFirstDeclaredSubstatement(final StmtContext<?, ?, ?> stmtContext,
 148             int startIndex, final Class<? extends DeclaredStatement<?>>... types) {
 149         if (startIndex >= types.length) {
 150             return null;
 151         }
 152
 153         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
 154             if (producesDeclared(subStmtContext,types[startIndex])) {
 155                 return startIndex + 1 == types.length ? subStmtContext
 156                         : findFirstDeclaredSubstatement(subStmtContext, ++startIndex, types);
 157             }
 158         }
 159         return null;
 160     }
 161
 162     public static <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findFirstDeclaredSubstatementOnSublevel(
 163             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType, int sublevel) {
 164         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
 165             if (sublevel == 1 && producesDeclared(subStmtContext, declaredType)) {
 166                 return subStmtContext;
 167             }
 168             if (sublevel > 1) {
 169                 final StmtContext<?, ?, ?> result = findFirstDeclaredSubstatementOnSublevel(
 170                     subStmtContext, declaredType, --sublevel);
 171                 if (result != null) {
 172                     return result;
 173                 }
 174             }
 175         }
 176
 177         return null;
 178     }
 179
 180     public static <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findDeepFirstDeclaredSubstatement(
 181             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
 182         for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
 183             if (producesDeclared(subStmtContext, declaredType)) {
 184                 return subStmtContext;
 185             }
 186
 187             final StmtContext<?, ?, ?> result = findDeepFirstDeclaredSubstatement(subStmtContext, declaredType);
 188             if (result != null) {
 189                 return result;
 190             }
 191         }
 192
 193         return null;
 194     }
 195
 196     public static boolean producesDeclared(final StmtContext<?, ?, ?> ctx,
 197             final Class<? extends DeclaredStatement<?>> type) {
 198         return type.isAssignableFrom(ctx.getPublicDefinition().getDeclaredRepresentationClass());
 199     }
 200
 201     public static boolean isInExtensionBody(final StmtContext<?,?,?> stmtCtx) {
 202         StmtContext<?,?,?> current = stmtCtx;
 203         while (!current.getParentContext().isRootContext()) {
 204             current = current.getParentContext();
 205             if (producesDeclared(current, UnknownStatementImpl.class)) {
 206                 return true;
 207             }
 208         }
 209
 210         return false;
 211     }
 212
 213     public static boolean isUnknownStatement(final StmtContext<?, ?, ?> stmtCtx) {
 214         return producesDeclared(stmtCtx, UnknownStatementImpl.class);
 215     }
 216
 217     public static Collection<SchemaNodeIdentifier> replaceModuleQNameForKey(
 218             final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?> keyStmtCtx,
 219             final QNameModule newQNameModule) {
 220
 221         final Builder<SchemaNodeIdentifier> builder = ImmutableSet.builder();
 222         boolean replaced = false;
 223         for (SchemaNodeIdentifier arg : keyStmtCtx.getStatementArgument()) {
 224             final QName qname = arg.getLastComponent();
 225             if (!newQNameModule.equals(qname)) {
 226                 final QName newQname = keyStmtCtx.getFromNamespace(QNameCacheNamespace.class,
 227                     QName.create(newQNameModule, qname.getLocalName()));
 228                 builder.add(SchemaNodeIdentifier.create(false, newQname));
 229                 replaced = true;
 230             } else {
 231                 builder.add(arg);
 232             }
 233         }
 234
 235         // This makes sure we reuse the collection when a grouping is instantiated in the same module
 236         return replaced ? builder.build() : keyStmtCtx.getStatementArgument();
 237     }
 238
 239     public static boolean areFeaturesSupported(final StmtContext<?, ?, ?> stmtContext) {
 240         Predicate<QName> isFeatureSupported = stmtContext.getFromNamespace(SupportedFeaturesNamespace.class,
 241                 SupportedFeatures.SUPPORTED_FEATURES);
 242         Collection<StatementContextBase<?, ?, ?>> substatements = new ArrayList<>();
 243         substatements.addAll(stmtContext.declaredSubstatements());
 244         substatements.addAll(stmtContext.effectiveSubstatements());
 245
 246         boolean isSupported = false;
 247         boolean containsIfFeature = false;
 248         for (StatementContextBase<?, ?, ?> stmt: substatements) {
 249             if (stmt.getPublicDefinition().equals(Rfc6020Mapping.IF_FEATURE)) {
 250                 containsIfFeature = true;
 251                 if (isFeatureSupported.test((QName) stmt.getStatementArgument())) {
 252                     isSupported = true;
 253                 } else {
 254                     isSupported = false;
 255                     break;
 256                 }
 257             }
 258         }
 259
 260         return !containsIfFeature || isSupported;
 261     }
 262 }