Push out ItemOrder FIXME
[yangtools.git] / yang / yang-parser-reactor / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / StatementDefinitionContext.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 static java.util.Objects.requireNonNull;
11
12 import com.google.common.base.MoreObjects;
13 import java.util.HashMap;
14 import java.util.Map;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.common.QNameModule;
19 import org.opendaylight.yangtools.yang.model.api.meta.ArgumentDefinition;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.OverrideChildStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
31
32 final class StatementDefinitionContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
33     private final @NonNull StatementSupport<A, D, E> support;
34     private final Map<String, StatementDefinitionContext<?, ?, ?>> argumentSpecificSubDefinitions;
35
36     private Map<StatementDefinitionContext<?, ?, ?>, StatementDefinitionContext<?,?,?>> unknownStmtDefsOfYangStmts;
37
38     StatementDefinitionContext(final StatementSupport<A, D, E> support) {
39         this.support = requireNonNull(support);
40         this.argumentSpecificSubDefinitions = support.hasArgumentSpecificSupports() ? new HashMap<>() : null;
41     }
42
43     @NonNull StatementFactory<A, D, E> getFactory() {
44         return support;
45     }
46
47     A parseArgumentValue(final StmtContext<A, D, E> context, final String value) {
48         return support.parseArgumentValue(context, value);
49     }
50
51     A adaptArgumentValue(final StmtContext<A, D, E> context, final QNameModule targetModule) {
52         return support.adaptArgumentValue(context, targetModule);
53     }
54
55     // FIXME: 7.0.0: remove this method
56     void checkNamespaceAllowed(final Class<? extends ParserNamespace<?,?>> namespace) {
57         // Noop
58     }
59
60     @NonNull StatementDefinition getPublicView() {
61         return support.getPublicView();
62     }
63
64     Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
65         return support instanceof ImplicitParentAwareStatementSupport
66                 ? ((ImplicitParentAwareStatementSupport) support).getImplicitParentFor(stmtDef) : Optional.empty();
67     }
68
69     void onStatementAdded(final Mutable<A, D, E> stmt) {
70         support.onStatementAdded(stmt);
71     }
72
73     void onDeclarationFinished(final Mutable<A, D, E> statement, final ModelProcessingPhase phase) {
74         switch (phase) {
75             case SOURCE_PRE_LINKAGE:
76                 support.onPreLinkageDeclared(statement);
77                 break;
78             case SOURCE_LINKAGE:
79                 support.onLinkageDeclared(statement);
80                 break;
81             case STATEMENT_DEFINITION:
82                 support.onStatementDefinitionDeclared(statement);
83                 break;
84             case FULL_DECLARATION:
85                 support.onFullDefinitionDeclared(statement);
86                 break;
87             default:
88                 break;
89         }
90     }
91
92     @NonNull Optional<ArgumentDefinition> getArgumentDefinition() {
93         return support.getArgumentDefinition();
94     }
95
96     @NonNull QName getStatementName() {
97         return support.getStatementName();
98     }
99
100     @Override
101     public String toString() {
102         return MoreObjects.toStringHelper(this).add("statement", getStatementName()).toString();
103     }
104
105     @NonNull StatementDefinitionContext<?, ?, ?> getSubDefinitionSpecificForArgument(final String argument) {
106         if (!hasArgumentSpecificSubDefinitions()) {
107             return this;
108         }
109
110         StatementDefinitionContext<?, ?, ?> potential = argumentSpecificSubDefinitions.get(argument);
111         if (potential == null) {
112             final StatementSupport<?, ?, ?> argumentSpecificSupport = support.getSupportSpecificForArgument(argument);
113             potential = argumentSpecificSupport != null ? new StatementDefinitionContext<>(argumentSpecificSupport)
114                     : this;
115             argumentSpecificSubDefinitions.put(argument, potential);
116         }
117
118         return potential;
119     }
120
121     StatementSupport<A, D, E> support() {
122         return support;
123     }
124
125     boolean hasArgumentSpecificSubDefinitions() {
126         return support.hasArgumentSpecificSupports();
127     }
128
129     @NonNull StatementDefinitionContext<?, ?, ?> overrideDefinition(
130             final @NonNull StatementDefinitionContext<?, ?, ?> def) {
131         if (!(support instanceof OverrideChildStatementSupport)) {
132             return def;
133         }
134
135         if (unknownStmtDefsOfYangStmts != null) {
136             final StatementDefinitionContext<?, ?, ?> existing = unknownStmtDefsOfYangStmts.get(def);
137             if (existing != null) {
138                 return existing;
139             }
140         } else {
141             unknownStmtDefsOfYangStmts = new HashMap<>(4);
142         }
143
144         final StatementSupport<?, ?, ?> override =
145             ((OverrideChildStatementSupport) support).statementDefinitionOverrideOf(def.getPublicView());
146         final StatementDefinitionContext<?, ?, ?> ret;
147         if (override != null) {
148             ret = new StatementDefinitionContext<>(override);
149         } else {
150             ret = def;
151         }
152         unknownStmtDefsOfYangStmts.put(def, ret);
153         return ret;
154     }
155 }