Do not issue duplicate warnings for lists missing keys
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / reactor / RFC7950Reactors.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.reactor;
9
10 import static org.opendaylight.yangtools.yang.common.YangVersion.VERSION_1;
11 import static org.opendaylight.yangtools.yang.common.YangVersion.VERSION_1_1;
12
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableSet;
15 import com.google.common.collect.Sets;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.YangVersion;
18 import org.opendaylight.yangtools.yang.parser.openconfig.stmt.OpenConfigVersionSupport;
19 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
20 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ModuleQNameToPrefix;
21 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.URIStringToImportPrefix;
22 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.XPathSupport;
23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.action.ActionStatementSupport;
24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.anydata.AnydataStatementSupport;
25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.anyxml.AnyxmlStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.argument.ArgumentStatementSupport;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment.AugmentImplicitHandlingNamespace;
28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment.AugmentStatementRFC6020Support;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment.AugmentStatementRFC7950Support;
30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.base.BaseStatementSupport;
31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.belongs_to.BelongsToStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.bit.BitStatementRFC6020Support;
33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.bit.BitStatementRFC7950Support;
34 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.case_.CaseStatementRFC6020Support;
35 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.case_.CaseStatementRFC7950Support;
36 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice.ChoiceStatementRFC6020Support;
37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice.ChoiceStatementRFC7950Support;
38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.config.ConfigStatementSupport;
39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.contact.ContactStatementSupport;
40 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.container.ContainerStatementRFC6020Support;
41 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.container.ContainerStatementRFC7950Support;
42 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.default_.DefaultStatementSupport;
43 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.description.DescriptionStatementSupport;
44 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.deviate.DeviateStatementRFC6020Support;
45 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.deviate.DeviateStatementRFC7950Support;
46 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.deviation.DeviationStatementSupport;
47 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.enum_.EnumStatementRFC6020Support;
48 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.enum_.EnumStatementRFC7950Support;
49 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.error_app_tag.ErrorAppTagStatementSupport;
50 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.error_message.ErrorMessageStatementSupport;
51 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.extension.ExtensionStatementSupport;
52 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.feature.FeatureStatementSupport;
53 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.fraction_digits.FractionDigitsStatementSupport;
54 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.grouping.GroupingStatementRFC6020Support;
55 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.grouping.GroupingStatementRFC7950Support;
56 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.identity.IdentityStatementRFC6020Support;
57 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.identity.IdentityStatementRFC7950Support;
58 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.if_feature.IfFeatureStatementSupport;
59 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.import_.ImportStatementRFC6020Support;
60 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.import_.ImportStatementRFC7950Support;
61 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.include.IncludeStatementRFC6020Support;
62 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.include.IncludeStatementRFC7950Support;
63 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementRFC6020Support;
64 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.input.InputStatementRFC7950Support;
65 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.key.KeyStatementSupport;
66 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.leaf.LeafStatementSupport;
67 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.leaf_list.LeafListStatementRFC6020Support;
68 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.leaf_list.LeafListStatementRFC7950Support;
69 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.length.LengthStatementSupport;
70 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.list.ConfigListWarningNamespace;
71 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.list.ListStatementRFC6020Support;
72 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.list.ListStatementRFC7950Support;
73 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.mandatory.MandatoryStatementSupport;
74 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.max_elements.MaxElementsStatementSupport;
75 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.min_elements.MinElementsStatementSupport;
76 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.modifier.ModifierStatementSupport;
77 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.module.ModuleStatementRFC6020Support;
78 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.module.ModuleStatementRFC7950Support;
79 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.must.MustStatementSupport;
80 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.namespace.NamespaceStatementSupport;
81 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.notification.NotificationStatementRFC6020Support;
82 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.notification.NotificationStatementRFC7950Support;
83 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ordered_by.OrderedByStatementSupport;
84 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.organization.OrganizationStatementSupport;
85 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementRFC6020Support;
86 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.output.OutputStatementRFC7950Support;
87 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.path.PathStatementSupport;
88 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.pattern.PatternStatementRFC6020Support;
89 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.pattern.PatternStatementRFC7950Support;
90 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.position.PositionStatementSupport;
91 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.prefix.PrefixStatementSupport;
92 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.presence.PresenceStatementSupport;
93 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.range.RangeStatementSupport;
94 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.reference.ReferenceStatementSupport;
95 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineStatementRFC6020Support;
96 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineStatementRFC7950Support;
97 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.require_instance.RequireInstanceStatementSupport;
98 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.revision.RevisionStatementSupport;
99 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.revision_date.RevisionDateStatementSupport;
100 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.rpc.RpcStatementRFC6020Support;
101 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.rpc.RpcStatementRFC7950Support;
102 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.status.StatusStatementSupport;
103 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.submodule.SubmoduleStatementRFC6020Support;
104 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.submodule.SubmoduleStatementRFC7950Support;
105 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.type.TypeStatementRFC6020Support;
106 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.type.TypeStatementRFC7950Support;
107 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.typedef.TypedefStatementSupport;
108 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.unique.UniqueStatementSupport;
109 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.units.UnitsStatementSupport;
110 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.uses.UsesStatementSupport;
111 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.value.ValueStatementSupport;
112 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.when.WhenStatementSupport;
113 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.yang_version.YangVersionStatementSupport;
114 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.yin_element.YinElementStatementSupport;
115 import org.opendaylight.yangtools.yang.parser.spi.ExtensionNamespace;
116 import org.opendaylight.yangtools.yang.parser.spi.FeatureNamespace;
117 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
118 import org.opendaylight.yangtools.yang.parser.spi.IdentityNamespace;
119 import org.opendaylight.yangtools.yang.parser.spi.ModuleNamespace;
120 import org.opendaylight.yangtools.yang.parser.spi.NamespaceToModule;
121 import org.opendaylight.yangtools.yang.parser.spi.PreLinkageModuleNamespace;
122 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
123 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
124 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
125 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionModuleNamespace;
126 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionNamespace;
127 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementDefinitionNamespace;
128 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportBundle;
129 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToModuleContext;
130 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleCtx;
131 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
132 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
133 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
134 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToSemVerSourceIdentifier;
135 import org.opendaylight.yangtools.yang.parser.spi.source.ImportedModuleContext;
136 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
137 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
138 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
139 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToSourceIdentifier;
140 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
141 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToNamespace;
142 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNamespaceForBelongsTo;
143 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleQNameToModuleName;
144 import org.opendaylight.yangtools.yang.parser.spi.source.ModulesDeviatedByModules;
145 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
146 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
147 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
148 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
149 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
150 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
151 import org.opendaylight.yangtools.yang.xpath.api.YangXPathParserFactory;
152
153 /**
154  * Utility class holding entrypoints for assembling RFC6020/RFC7950 statement {@link CrossSourceStatementReactor}s.
155  *
156  * @author Robert Varga
157  */
158 @Beta
159 public final class RFC7950Reactors {
160     private static final ImmutableSet<YangVersion> SUPPORTED_VERSIONS = Sets.immutableEnumSet(VERSION_1, VERSION_1_1);
161
162     private static final StatementSupportBundle INIT_BUNDLE = StatementSupportBundle.builder(SUPPORTED_VERSIONS)
163             .addSupport(ValidationBundlesNamespace.BEHAVIOUR)
164             .addSupport(SupportedFeaturesNamespace.BEHAVIOUR)
165             .addSupport(ModulesDeviatedByModules.BEHAVIOUR)
166             .build();
167
168     private static final StatementSupportBundle PRE_LINKAGE_BUNDLE = StatementSupportBundle.derivedFrom(INIT_BUNDLE)
169             .addVersionSpecificSupport(VERSION_1, ModuleStatementRFC6020Support.getInstance())
170             .addVersionSpecificSupport(VERSION_1_1, ModuleStatementRFC7950Support.getInstance())
171             .addVersionSpecificSupport(VERSION_1, SubmoduleStatementRFC6020Support.getInstance())
172             .addVersionSpecificSupport(VERSION_1_1, SubmoduleStatementRFC7950Support.getInstance())
173             .addSupport(NamespaceStatementSupport.getInstance())
174             .addVersionSpecificSupport(VERSION_1, ImportStatementRFC6020Support.getInstance())
175             .addVersionSpecificSupport(VERSION_1_1, ImportStatementRFC7950Support.getInstance())
176             .addVersionSpecificSupport(VERSION_1, IncludeStatementRFC6020Support.getInstance())
177             .addVersionSpecificSupport(VERSION_1_1, IncludeStatementRFC7950Support.getInstance())
178             .addSupport(BelongsToStatementSupport.getInstance())
179             .addSupport(PrefixStatementSupport.getInstance())
180             .addSupport(YangVersionStatementSupport.getInstance())
181             .addSupport(RevisionStatementSupport.getInstance())
182             .addSupport(RevisionDateStatementSupport.getInstance())
183             .addSupport(ModuleNameToNamespace.BEHAVIOUR)
184             .addSupport(PreLinkageModuleNamespace.BEHAVIOUR)
185             .addSupport(ImpPrefixToNamespace.BEHAVIOUR)
186             .addSupport(ModuleCtxToModuleQName.BEHAVIOUR)
187             .build();
188
189     private static final StatementSupportBundle LINKAGE_BUNDLE = StatementSupportBundle
190             .derivedFrom(PRE_LINKAGE_BUNDLE)
191             .addSupport(DescriptionStatementSupport.getInstance())
192             .addSupport(ReferenceStatementSupport.getInstance())
193             .addSupport(ContactStatementSupport.getInstance())
194             .addSupport(OrganizationStatementSupport.getInstance())
195             .addSupport(ModuleNamespace.BEHAVIOUR)
196             .addSupport(ModuleNamespaceForBelongsTo.BEHAVIOUR)
197             .addSupport(SubmoduleNamespace.BEHAVIOUR)
198             .addSupport(NamespaceToModule.BEHAVIOUR)
199             .addSupport(ModuleNameToModuleQName.BEHAVIOUR)
200             .addSupport(ModuleCtxToSourceIdentifier.BEHAVIOUR)
201             .addSupport(ModuleQNameToModuleName.BEHAVIOUR)
202             .addSupport(PrefixToModule.BEHAVIOUR)
203             .addSupport(ImportedModuleContext.BEHAVIOUR)
204             .addSupport(IncludedModuleContext.BEHAVIOUR)
205             .addSupport(IncludedSubmoduleNameToModuleCtx.BEHAVIOUR)
206             .addSupport(ImportPrefixToModuleCtx.BEHAVIOUR)
207             .addSupport(BelongsToPrefixToModuleCtx.BEHAVIOUR)
208             .addSupport(ModuleQNameToPrefix.BEHAVIOUR)
209             .addSupport(URIStringToImportPrefix.BEHAVIOUR)
210             .addSupport(BelongsToModuleContext.BEHAVIOUR)
211             .addSupport(QNameToStatementDefinition.BEHAVIOUR)
212             .addSupport(BelongsToPrefixToModuleName.BEHAVIOUR)
213             .build();
214
215     private static final StatementSupportBundle STMT_DEF_BUNDLE = StatementSupportBundle
216             .derivedFrom(LINKAGE_BUNDLE)
217             .addSupport(YinElementStatementSupport.getInstance())
218             .addSupport(ArgumentStatementSupport.getInstance())
219             .addSupport(ExtensionStatementSupport.getInstance())
220             .addSupport(new ChildSchemaNodeNamespace<>())
221             .addSupport(ExtensionNamespace.BEHAVIOUR)
222             .addSupport(TypedefStatementSupport.getInstance())
223             .addSupport(TypeNamespace.BEHAVIOUR)
224             .addVersionSpecificSupport(VERSION_1, IdentityStatementRFC6020Support.getInstance())
225             .addVersionSpecificSupport(VERSION_1_1, IdentityStatementRFC7950Support.getInstance())
226             .addSupport(IdentityNamespace.BEHAVIOUR)
227             .addSupport(DefaultStatementSupport.getInstance())
228             .addSupport(StatusStatementSupport.getInstance())
229             .addVersionSpecificSupport(VERSION_1, TypeStatementRFC6020Support.getInstance())
230             .addVersionSpecificSupport(VERSION_1_1, TypeStatementRFC7950Support.getInstance())
231             .addSupport(UnitsStatementSupport.getInstance())
232             .addSupport(RequireInstanceStatementSupport.getInstance())
233             .addVersionSpecificSupport(VERSION_1, BitStatementRFC6020Support.getInstance())
234             .addVersionSpecificSupport(VERSION_1_1, BitStatementRFC7950Support.getInstance())
235             .addSupport(PathStatementSupport.strictInstance())
236             .addVersionSpecificSupport(VERSION_1, EnumStatementRFC6020Support.getInstance())
237             .addVersionSpecificSupport(VERSION_1_1, EnumStatementRFC7950Support.getInstance())
238             .addSupport(LengthStatementSupport.getInstance())
239             .addVersionSpecificSupport(VERSION_1, PatternStatementRFC6020Support.getInstance())
240             .addVersionSpecificSupport(VERSION_1_1, PatternStatementRFC7950Support.getInstance())
241             .addVersionSpecificSupport(VERSION_1_1, ModifierStatementSupport.getInstance())
242             .addSupport(RangeStatementSupport.getInstance())
243             .addSupport(KeyStatementSupport.getInstance())
244             .addVersionSpecificSupport(VERSION_1, ContainerStatementRFC6020Support.getInstance())
245             .addVersionSpecificSupport(VERSION_1_1, ContainerStatementRFC7950Support.getInstance())
246             .addVersionSpecificSupport(VERSION_1, GroupingStatementRFC6020Support.getInstance())
247             .addVersionSpecificSupport(VERSION_1_1, GroupingStatementRFC7950Support.getInstance())
248             .addVersionSpecificSupport(VERSION_1, ListStatementRFC6020Support.getInstance())
249             .addVersionSpecificSupport(VERSION_1_1, ListStatementRFC7950Support.getInstance())
250             .addSupport(ConfigListWarningNamespace.BEHAVIOUR)
251             .addSupport(UniqueStatementSupport.getInstance())
252             .addVersionSpecificSupport(VERSION_1_1, ActionStatementSupport.getInstance())
253             .addVersionSpecificSupport(VERSION_1, RpcStatementRFC6020Support.getInstance())
254             .addVersionSpecificSupport(VERSION_1_1, RpcStatementRFC7950Support.getInstance())
255             .addVersionSpecificSupport(VERSION_1, InputStatementRFC6020Support.getInstance())
256             .addVersionSpecificSupport(VERSION_1_1, InputStatementRFC7950Support.getInstance())
257             .addVersionSpecificSupport(VERSION_1, OutputStatementRFC6020Support.getInstance())
258             .addVersionSpecificSupport(VERSION_1_1, OutputStatementRFC7950Support.getInstance())
259             .addVersionSpecificSupport(VERSION_1, NotificationStatementRFC6020Support.getInstance())
260             .addVersionSpecificSupport(VERSION_1_1, NotificationStatementRFC7950Support.getInstance())
261             .addSupport(FractionDigitsStatementSupport.getInstance())
262             .addSupport(BaseStatementSupport.getInstance())
263             .addSupport(StatementDefinitionNamespace.BEHAVIOUR)
264             .build();
265
266
267     private RFC7950Reactors() {
268         // Hidden on purpose
269     }
270
271     /**
272      * Returns a pre-built {@link CrossSourceStatementReactor} supporting RFC6020 and RFC7950, along with OpenConfig
273      * semantic version extension. This is useful for parsing near-vanilla YANG models while providing complete
274      * support for semantic versions.
275      *
276      * @return A shared reactor instance.
277      */
278     public static @NonNull CrossSourceStatementReactor defaultReactor() {
279         return ServiceLoaderState.DefaultReactor.INSTANCE;
280     }
281
282     /**
283      * Returns a partially-configured {@link CustomCrossSourceStatementReactorBuilder}, with RFC6020/RFC7950
284      * and OpenConfig semantic version support enabled.
285      *
286      * @return A new {@link CustomCrossSourceStatementReactorBuilder}.
287      */
288     public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
289         return addExtensions(vanillaReactorBuilder());
290     }
291
292     public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
293             final YangXPathParserFactory xpathFactory) {
294         return addExtensions(vanillaReactorBuilder(xpathFactory));
295     }
296
297     private static @NonNull CustomCrossSourceStatementReactorBuilder addExtensions(
298             final @NonNull CustomCrossSourceStatementReactorBuilder builder) {
299         return builder
300                 // Semantic version support
301                 .addStatementSupport(ModelProcessingPhase.SOURCE_LINKAGE, OpenConfigVersionSupport.getInstance())
302                 .addNamespaceSupport(ModelProcessingPhase.SOURCE_LINKAGE, SemanticVersionNamespace.BEHAVIOUR)
303                 .addNamespaceSupport(ModelProcessingPhase.SOURCE_LINKAGE, SemanticVersionModuleNamespace.BEHAVIOUR)
304                 .addNamespaceSupport(ModelProcessingPhase.SOURCE_LINKAGE,
305                     ImportPrefixToSemVerSourceIdentifier.BEHAVIOUR);
306     }
307
308     /**
309      * Returns a pre-built {@link CrossSourceStatementReactor} supporting both RFC6020 and RFC7950. This is useful
310      * for parsing vanilla YANG models without any semantic support for extensions. Notably missing is the semantic
311      * version extension, hence attempts to use semantic version mode will cause failures.
312      *
313      * @return A shared reactor instance.
314      */
315     public static @NonNull CrossSourceStatementReactor vanillaReactor() {
316         return ServiceLoaderState.VanillaReactor.INSTANCE;
317     }
318
319     /**
320      * Returns a partially-configured {@link CustomCrossSourceStatementReactorBuilder}, with vanilla RFC6020/RFC7950
321      * support enabled.
322      *
323      * @return A new {@link CustomCrossSourceStatementReactorBuilder}.
324      */
325     public static @NonNull CustomCrossSourceStatementReactorBuilder vanillaReactorBuilder() {
326         return vanillaReactorBuilder(ServiceLoaderState.XPath.INSTANCE);
327     }
328
329     public static @NonNull CustomCrossSourceStatementReactorBuilder vanillaReactorBuilder(
330             final @NonNull YangXPathParserFactory xpathFactory) {
331         return vanillaReactorBuilder(new XPathSupport(xpathFactory));
332     }
333
334     private static @NonNull CustomCrossSourceStatementReactorBuilder vanillaReactorBuilder(
335             final @NonNull XPathSupport xpathSupport) {
336         final StatementSupportBundle fullDeclarationBundle = fullDeclarationBundle(xpathSupport);
337         return new CustomCrossSourceStatementReactorBuilder(SUPPORTED_VERSIONS)
338                 .addAllSupports(ModelProcessingPhase.INIT, INIT_BUNDLE)
339                 .addAllSupports(ModelProcessingPhase.SOURCE_PRE_LINKAGE, PRE_LINKAGE_BUNDLE)
340                 .addAllSupports(ModelProcessingPhase.SOURCE_LINKAGE, LINKAGE_BUNDLE)
341                 .addAllSupports(ModelProcessingPhase.STATEMENT_DEFINITION, STMT_DEF_BUNDLE)
342                 .addAllSupports(ModelProcessingPhase.FULL_DECLARATION, fullDeclarationBundle)
343                 .addAllSupports(ModelProcessingPhase.EFFECTIVE_MODEL, fullDeclarationBundle)
344                 .addValidationBundle(ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS,
345                     YangValidationBundles.SUPPORTED_REFINE_SUBSTATEMENTS)
346                 .addValidationBundle(ValidationBundleType.SUPPORTED_AUGMENT_TARGETS,
347                     YangValidationBundles.SUPPORTED_AUGMENT_TARGETS)
348
349                 // FIXME: 5.0.0: we do not seem to need this validation bundle
350                 .addValidationBundle(ValidationBundleType.SUPPORTED_CASE_SHORTHANDS,
351                     YangValidationBundles.SUPPORTED_CASE_SHORTHANDS)
352
353                 .addValidationBundle(ValidationBundleType.SUPPORTED_DATA_NODES,
354                     YangValidationBundles.SUPPORTED_DATA_NODES);
355     }
356
357     private static @NonNull StatementSupportBundle fullDeclarationBundle(final XPathSupport xpathSupport) {
358         return StatementSupportBundle
359             .derivedFrom(STMT_DEF_BUNDLE)
360             .addSupport(LeafStatementSupport.getInstance())
361             .addSupport(ConfigStatementSupport.getInstance())
362             .addSupport(DeviationStatementSupport.getInstance())
363             .addVersionSpecificSupport(VERSION_1, DeviateStatementRFC6020Support.getInstance())
364             .addVersionSpecificSupport(VERSION_1_1, DeviateStatementRFC7950Support.getInstance())
365             .addVersionSpecificSupport(VERSION_1, ChoiceStatementRFC6020Support.getInstance())
366             .addVersionSpecificSupport(VERSION_1_1, ChoiceStatementRFC7950Support.getInstance())
367             .addVersionSpecificSupport(VERSION_1, CaseStatementRFC6020Support.getInstance())
368             .addVersionSpecificSupport(VERSION_1_1, CaseStatementRFC7950Support.getInstance())
369             .addSupport(MustStatementSupport.createInstance(xpathSupport))
370             .addSupport(MandatoryStatementSupport.getInstance())
371             .addSupport(AnyxmlStatementSupport.getInstance())
372             .addVersionSpecificSupport(VERSION_1_1, AnydataStatementSupport.getInstance())
373             .addSupport(FeatureNamespace.BEHAVIOUR)
374             .addSupport(IfFeatureStatementSupport.getInstance())
375             .addSupport(UsesStatementSupport.getInstance())
376             .addSupport(GroupingNamespace.BEHAVIOUR)
377             .addSupport(ErrorMessageStatementSupport.getInstance())
378             .addSupport(ErrorAppTagStatementSupport.getInstance())
379             .addVersionSpecificSupport(VERSION_1, LeafListStatementRFC6020Support.getInstance())
380             .addVersionSpecificSupport(VERSION_1_1, LeafListStatementRFC7950Support.getInstance())
381             .addSupport(PresenceStatementSupport.getInstance())
382             .addSupport(MaxElementsStatementSupport.getInstance())
383             .addSupport(MinElementsStatementSupport.getInstance())
384             .addSupport(OrderedByStatementSupport.getInstance())
385             .addSupport(WhenStatementSupport.createInstance(xpathSupport))
386             .addSupport(AugmentImplicitHandlingNamespace.BEHAVIOUR)
387             .addVersionSpecificSupport(VERSION_1, AugmentStatementRFC6020Support.getInstance())
388             .addVersionSpecificSupport(VERSION_1_1, AugmentStatementRFC7950Support.getInstance())
389             .addVersionSpecificSupport(VERSION_1, RefineStatementRFC6020Support.getInstance())
390             .addVersionSpecificSupport(VERSION_1_1, RefineStatementRFC7950Support.getInstance())
391             .addSupport(FeatureStatementSupport.getInstance())
392             .addSupport(PositionStatementSupport.getInstance())
393             .addSupport(ValueStatementSupport.getInstance())
394             .build();
395     }
396 }