yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/SubstatementContext.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.stmt.reactor;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Verify;
  13 import java.util.Collection;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.common.QNameModule;
  16 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  30 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  31 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  32 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  33 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.GroupingUtils;
  34 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  35
  36 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
  37         extends StatementContextBase<A, D, E> {
  38
  39     private final StatementContextBase<?, ?, ?> parent;
  40     private final A argument;
  41     private volatile SchemaPath schemaPath;
  42
  43     SubstatementContext(final StatementContextBase<?, ?, ?> parent,
  44             final ContextBuilder<A, D, E> builder) throws SourceException {
  45         super(builder);
  46         this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
  47         this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
  48     }
  49
  50     @SuppressWarnings("unchecked")
  51     SubstatementContext(final SubstatementContext<A, D, E> original,
  52             final QNameModule newQNameModule,
  53             final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
  54         super(original);
  55         this.parent = newParent;
  56
  57         if (newQNameModule != null) {
  58             if (original.argument instanceof QName) {
  59                 QName originalQName = (QName) original.argument;
  60                 this.argument = (A)
  61                         getFromNamespace(QNameCacheNamespace.class,
  62                             QName.create(newQNameModule, originalQName.getLocalName()));
  63             } else if (StmtContextUtils.producesDeclared(original, KeyStatement.class)) {
  64                 this.argument = (A) StmtContextUtils.replaceModuleQNameForKey(
  65                                 (StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?>) original,
  66                                 newQNameModule);
  67             } else {
  68                 this.argument = original.argument;
  69             }
  70         } else {
  71             this.argument = original.argument;
  72         }
  73     }
  74
  75
  76     private void copyDeclaredStmts(final SubstatementContext<A, D, E> original,
  77             final QNameModule newQNameModule, final TypeOfCopy typeOfCopy)
  78             throws SourceException {
  79         Collection<? extends StatementContextBase<?, ?, ?>> originalDeclaredSubstatements = original
  80                 .declaredSubstatements();
  81         for (StatementContextBase<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
  82             if (GroupingUtils.needToCopyByUses(stmtContext)) {
  83                 StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
  84                         newQNameModule, this, typeOfCopy);
  85                 this.addEffectiveSubstatement(copy);
  86             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
  87                 this.addEffectiveSubstatement(stmtContext);
  88             }
  89         }
  90     }
  91
  92     private void copyEffectiveStmts(final SubstatementContext<A, D, E> original,
  93             final QNameModule newQNameModule, final TypeOfCopy typeOfCopy)
  94             throws SourceException {
  95         Collection<? extends StatementContextBase<?, ?, ?>> originalEffectiveSubstatements = original
  96                 .effectiveSubstatements();
  97         for (StatementContextBase<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
  98             if (GroupingUtils.needToCopyByUses(stmtContext)) {
  99                 StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
 100                         newQNameModule, this, typeOfCopy);
 101                 this.addEffectiveSubstatement(copy);
 102             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
 103                 this.addEffectiveSubstatement(stmtContext);
 104             }
 105         }
 106     }
 107
 108     @Override
 109     public StatementContextBase<?, ?, ?> getParentContext() {
 110         return parent;
 111     }
 112
 113     @Override
 114     public NamespaceStorageNode getParentNamespaceStorage() {
 115         return parent;
 116     }
 117
 118     @Override
 119     public Registry getBehaviourRegistry() {
 120         return parent.getBehaviourRegistry();
 121     }
 122
 123     @Override
 124     public RootStatementContext<?, ?, ?> getRoot() {
 125         return parent.getRoot();
 126     }
 127
 128     @Override
 129     public A getStatementArgument() {
 130         return argument;
 131     }
 132
 133     @Override
 134     public StatementContextBase<?, ?, ?> createCopy(
 135             final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy)
 136             throws SourceException {
 137         return createCopy(null, newParent, typeOfCopy);
 138     }
 139
 140     @Override
 141     public StatementContextBase<A, D, E> createCopy(final QNameModule newQNameModule,
 142             final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy)
 143             throws SourceException {
 144         SubstatementContext<A, D, E> copy = new SubstatementContext<>(this, newQNameModule, newParent, typeOfCopy);
 145
 146         copy.addAllToCopyHistory(this.getCopyHistory());
 147         copy.addToCopyHistory(typeOfCopy);
 148
 149         if(this.getOriginalCtx() != null) {
 150             copy.setOriginalCtx(this.getOriginalCtx());
 151         } else {
 152             copy.setOriginalCtx(this);
 153         }
 154
 155         definition().onStatementAdded(copy);
 156
 157         copy.copyDeclaredStmts(this, newQNameModule, typeOfCopy);
 158         copy.copyEffectiveStmts(this, newQNameModule, typeOfCopy);
 159         return copy;
 160     }
 161
 162     private boolean isSupportedAsShorthandCase() {
 163         final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
 164                 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
 165         return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
 166     }
 167
 168     private SchemaPath createSchemaPath() {
 169         final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
 170         Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
 171         final SchemaPath parentPath = maybeParentPath.get();
 172
 173         if (argument instanceof QName) {
 174             QName qname = (QName) argument;
 175             if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
 176                 return maybeParentPath.orNull();
 177             }
 178
 179             final SchemaPath path;
 180             if (StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
 181                     && isSupportedAsShorthandCase()) {
 182                 path = parentPath.createChild(qname);
 183             } else {
 184                 path = parentPath;
 185             }
 186             return path.createChild(qname);
 187         }
 188         if (argument instanceof String) {
 189             // FIXME: This may yield illegal argument exceptions
 190             final StatementContextBase<?, ?, ?> originalCtx = getOriginalCtx();
 191             final QName qname = (originalCtx != null) ? Utils.qNameFromArgument(originalCtx, (String) argument)
 192                     : Utils.qNameFromArgument(this, (String) argument);
 193             return parentPath.createChild(qname);
 194         }
 195         if (argument instanceof SchemaNodeIdentifier &&
 196                 (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
 197                    || StmtContextUtils.producesDeclared(this, RefineStatement.class))) {
 198
 199             return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
 200         }
 201         if (Utils.isUnknownNode(this)) {
 202             return parentPath.createChild(getPublicDefinition().getStatementName());
 203         }
 204
 205         // FIXME: this does not look right
 206         return maybeParentPath.orNull();
 207     }
 208
 209     @Override
 210     public Optional<SchemaPath> getSchemaPath() {
 211         SchemaPath local = schemaPath;
 212         if (local == null) {
 213             synchronized (this) {
 214                 local = schemaPath;
 215                 if (local == null) {
 216                     local = createSchemaPath();
 217                     schemaPath = local;
 218                 }
 219             }
 220
 221         }
 222
 223         return Optional.fromNullable(local);
 224     }
 225
 226     @Override
 227     public boolean isRootContext() {
 228         return false;
 229     }
 230 }