55352d60e8cf5461763d326bf6a0268ea1ba3c0b
[mdsal.git] / binding / mdsal-binding-generator / src / main / java / org / opendaylight / mdsal / binding / generator / impl / reactor / AbstractCompositeGenerator.java
1 /*
2  * Copyright (c) 2021 PANTHEON.tech, 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.mdsal.binding.generator.impl.reactor;
9
10 import static com.google.common.base.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
12 import static java.util.Objects.requireNonNull;
13
14 import java.util.ArrayList;
15 import java.util.Iterator;
16 import java.util.List;
17 import java.util.stream.Collectors;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.mdsal.binding.model.api.Enumeration;
21 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
22 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
23 import org.opendaylight.mdsal.binding.model.api.Type;
24 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
25 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
26 import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
27 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.model.api.AddedByUsesAware;
30 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
31 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
33 import org.opendaylight.yangtools.yang.model.api.stmt.AnydataEffectiveStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.AnyxmlEffectiveStatement;
35 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
36 import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
37 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
38 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerEffectiveStatement;
39 import org.opendaylight.yangtools.yang.model.api.stmt.FeatureEffectiveStatement;
40 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
41 import org.opendaylight.yangtools.yang.model.api.stmt.IdentityEffectiveStatement;
42 import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
43 import org.opendaylight.yangtools.yang.model.api.stmt.LeafEffectiveStatement;
44 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
45 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
46 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
47 import org.opendaylight.yangtools.yang.model.api.stmt.OutputEffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
49 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
50 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.ri.type.TypeBuilder;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
55
56 /**
57  * A composite generator. Composite generators may contain additional children, which end up being mapped into
58  * the naming hierarchy 'under' the composite generator. To support this use case, each composite has a Java package
59  * name assigned.
60  *
61  * <p>
62  * State tracking for resolution of children to their original declaration, i.e. back along the 'uses' and 'augment'
63  * axis. This is quite convoluted because we are traversing the generator tree recursively in the iteration order of
64  * children, but actual dependencies may require resolution in a different order, for example in the case of:
65  * <pre>
66  *   container foo {
67  *     uses bar {             // A
68  *       augment bar {        // B
69  *         container xyzzy;   // C
70  *       }
71  *     }
72  *
73  *     grouping bar {
74  *       container bar {      // D
75  *         uses baz;          // E
76  *       }
77  *     }
78  *
79  *     grouping baz {
80  *       leaf baz {           // F
81  *         type string;
82  *       }
83  *     }
84  *   }
85  *
86  *   augment /foo/bar/xyzzy { // G
87  *     leaf xyzzy {           // H
88  *       type string;
89  *     }
90  *   }
91  * </pre>
92  *
93  * <p>
94  * In this case we have three manifestations of 'leaf baz' -- marked A, E and F in the child iteration order. In order
95  * to perform a resolution, we first have to determine that F is the original definition, then establish that E is using
96  * the definition made by F and finally establish that A is using the definition made by F.
97  *
98  * <p>
99  * Dealing with augmentations is harder still, because we need to attach them to the original definition, hence for the
100  * /foo/bar container at A, we need to understand that its original definition is at D and we need to attach the augment
101  * at B to D. Futhermore we also need to establish that the augmentation at G attaches to container defined in C, so
102  * that the 'leaf xyzzy' existing as /foo/bar/xyzzy/xyzzy under C has its original definition at H.
103  *
104  * <p>
105  * Finally realize that the augment at G can actually exist in a different module and is shown in this example only
106  * the simplified form. That also means we could encounter G well before 'container foo' as well as we can have multiple
107  * such augments sprinkled across multiple modules having the same dependency rules as between C and G -- but they still
108  * have to form a directed acyclic graph and we partially deal with those complexities by having modules sorted by their
109  * dependencies.
110  *
111  * <p>
112  * For further details see {@link #linkOriginalGenerator()} and {@link #linkOriginalGeneratorRecursive()}, which deal
113  * with linking original instances in the tree iteration order. The part dealing with augment attachment lives mostly
114  * in {@link AugmentRequirement}.
115  */
116 public abstract class AbstractCompositeGenerator<S extends EffectiveStatement<?, ?>, R extends CompositeRuntimeType>
117         extends AbstractExplicitGenerator<S, R> {
118     private static final Logger LOG = LoggerFactory.getLogger(AbstractCompositeGenerator.class);
119
120     // FIXME: we want to allocate this lazily to lower memory footprint
121     private final @NonNull CollisionDomain domain = new CollisionDomain(this);
122     private final @NonNull List<Generator> childGenerators;
123
124     /**
125      * List of {@code augment} statements targeting this generator. This list is maintained only for the primary
126      * incarnation. This list is an evolving entity until after we have finished linkage of original statements. It is
127      * expected to be stable at the start of {@code step 2} in {@link GeneratorReactor#execute(TypeBuilderFactory)}.
128      */
129     private @NonNull List<AbstractAugmentGenerator> augments = List.of();
130
131     /**
132      * List of {@code grouping} statements this statement references. This field is set once by
133      * {@link #linkUsesDependencies(GeneratorContext)}.
134      */
135     private List<GroupingGenerator> groupings;
136
137     /**
138      * List of composite children which have not been recursively processed. This may become a mutable list when we
139      * have some children which have not completed linking. Once we have completed linking of all children, including
140      * {@link #unlinkedChildren}, this will be set to {@code null}.
141      */
142     private List<AbstractCompositeGenerator<?, ?>> unlinkedComposites = List.of();
143     /**
144      * List of children which have not had their original linked. This list starts of as null. When we first attempt
145      * linkage, it becomes non-null.
146      */
147     private List<Generator> unlinkedChildren;
148
149     AbstractCompositeGenerator(final S statement) {
150         super(statement);
151         childGenerators = createChildren(statement);
152     }
153
154     AbstractCompositeGenerator(final S statement, final AbstractCompositeGenerator<?, ?> parent) {
155         super(statement, parent);
156         childGenerators = createChildren(statement);
157     }
158
159     @Override
160     public final Iterator<Generator> iterator() {
161         return childGenerators.iterator();
162     }
163
164     final @NonNull List<AbstractAugmentGenerator> augments() {
165         return augments;
166     }
167
168     final @NonNull List<GroupingGenerator> groupings() {
169         return verifyNotNull(groupings, "Groupings not initialized in %s", this);
170     }
171
172     @Override
173     final R createExternalRuntimeType(final Type type) {
174         verify(type instanceof GeneratedType, "Unexpected type %s", type);
175         return createBuilder(statement()).populate(new AugmentResolver(), this).build((GeneratedType) type);
176     }
177
178     abstract @NonNull CompositeRuntimeTypeBuilder<S, R> createBuilder(S statement);
179
180     @Override
181     final R createInternalRuntimeType(final AugmentResolver resolver, final S statement, final Type type) {
182         verify(type instanceof GeneratedType, "Unexpected type %s", type);
183         return createBuilder(statement).populate(resolver, this).build((GeneratedType) type);
184     }
185
186     @Override
187     final boolean isEmpty() {
188         return childGenerators.isEmpty();
189     }
190
191     final @Nullable AbstractExplicitGenerator<?, ?> findGenerator(final List<EffectiveStatement<?, ?>> stmtPath) {
192         return findGenerator(MatchStrategy.identity(), stmtPath, 0);
193     }
194
195     final @Nullable AbstractExplicitGenerator<?, ?> findGenerator(final MatchStrategy childStrategy,
196             // TODO: Wouldn't this method be nicer with Deque<EffectiveStatement<?, ?>> ?
197             final List<EffectiveStatement<?, ?>> stmtPath, final int offset) {
198         final var stmt = stmtPath.get(offset);
199
200         // Try direct children first, which is simple
201         var ret = childStrategy.findGenerator(stmt, childGenerators);
202         if (ret != null) {
203             final int next = offset + 1;
204             if (stmtPath.size() == next) {
205                 // Final step, return child
206                 return ret;
207             }
208             if (ret instanceof AbstractCompositeGenerator<?, ?> composite) {
209                 // We know how to descend down
210                 return composite.findGenerator(childStrategy, stmtPath, next);
211             }
212             // Yeah, don't know how to continue here
213             return null;
214         }
215
216         // At this point we are about to fork for augments or groupings. In either case only schema tree statements can
217         // be found this way. The fun part is that if we find a match and need to continue, we will use the same
218         // strategy for children as well. We now know that this (and subsequent) statements need to have a QName
219         // argument.
220         if (stmt instanceof SchemaTreeEffectiveStatement) {
221             // grouping -> uses instantiation changes the namespace to the local namespace of the uses site. We are
222             // going the opposite direction, hence we are changing namespace from local to the grouping's namespace.
223             for (GroupingGenerator gen : groupings) {
224                 final MatchStrategy strat = MatchStrategy.grouping(gen);
225                 ret = gen.findGenerator(strat, stmtPath, offset);
226                 if (ret != null) {
227                     return ret;
228                 }
229             }
230
231             // All augments are dead simple: they need to match on argument (which we expect to be a QName)
232             final MatchStrategy strat = MatchStrategy.augment();
233             for (AbstractAugmentGenerator gen : augments) {
234                 ret = gen.findGenerator(strat, stmtPath, offset);
235                 if (ret != null) {
236                     return ret;
237                 }
238             }
239         }
240         return null;
241     }
242
243     final @NonNull CollisionDomain domain() {
244         return domain;
245     }
246
247     final void linkUsesDependencies(final GeneratorContext context) {
248         // We are establishing two linkages here:
249         // - we are resolving 'uses' statements to their corresponding 'grouping' definitions
250         // - we propagate those groupings as anchors to any augment statements, which takes out some amount of guesswork
251         //   from augment+uses resolution case, as groupings know about their immediate augments as soon as uses linkage
252         //   is resolved
253         final var tmp = new ArrayList<GroupingGenerator>();
254         for (var stmt : statement().effectiveSubstatements()) {
255             if (stmt instanceof UsesEffectiveStatement uses) {
256                 final var grouping = context.resolveTreeScoped(GroupingGenerator.class, uses.argument());
257                 tmp.add(grouping);
258
259                 // Trigger resolution of uses/augment statements. This looks like guesswork, but there may be multiple
260                 // 'augment' statements in a 'uses' statement and keeping a ListMultimap here seems wasteful.
261                 for (Generator gen : this) {
262                     if (gen instanceof UsesAugmentGenerator usesGen) {
263                         usesGen.resolveGrouping(uses, grouping);
264                     }
265                 }
266             }
267         }
268         groupings = List.copyOf(tmp);
269     }
270
271     final void startUsesAugmentLinkage(final List<AugmentRequirement> requirements) {
272         for (var child : childGenerators) {
273             if (child instanceof UsesAugmentGenerator uses) {
274                 requirements.add(uses.startLinkage());
275             }
276             if (child instanceof AbstractCompositeGenerator<?, ?> composite) {
277                 composite.startUsesAugmentLinkage(requirements);
278             }
279         }
280     }
281
282     final void addAugment(final AbstractAugmentGenerator augment) {
283         if (augments.isEmpty()) {
284             augments = new ArrayList<>(2);
285         }
286         augments.add(requireNonNull(augment));
287     }
288
289     /**
290      * Attempt to link the generator corresponding to the original definition for this generator's statements as well as
291      * to all child generators.
292      *
293      * @return Progress indication
294      */
295     final @NonNull LinkageProgress linkOriginalGeneratorRecursive() {
296         if (unlinkedComposites == null) {
297             // We have unset this list (see below), and there is nothing left to do
298             return LinkageProgress.DONE;
299         }
300
301         if (unlinkedChildren == null) {
302             unlinkedChildren = childGenerators.stream()
303                 .filter(AbstractExplicitGenerator.class::isInstance)
304                 .map(child -> (AbstractExplicitGenerator<?, ?>) child)
305                 .collect(Collectors.toList());
306         }
307
308         var progress = LinkageProgress.NONE;
309         if (!unlinkedChildren.isEmpty()) {
310             // Attempt to make progress on child linkage
311             final var it = unlinkedChildren.iterator();
312             while (it.hasNext()) {
313                 if (it.next() instanceof AbstractExplicitGenerator<?, ?> explicit && explicit.linkOriginalGenerator()) {
314                     progress = LinkageProgress.SOME;
315                     it.remove();
316
317                     // If this is a composite generator we need to process is further
318                     if (explicit instanceof AbstractCompositeGenerator<?, ?> composite) {
319                         if (unlinkedComposites.isEmpty()) {
320                             unlinkedComposites = new ArrayList<>();
321                         }
322                         unlinkedComposites.add(composite);
323                     }
324                 }
325             }
326
327             if (unlinkedChildren.isEmpty()) {
328                 // Nothing left to do, make sure any previously-allocated list can be scavenged
329                 unlinkedChildren = List.of();
330             }
331         }
332
333         // Process children of any composite children we have.
334         final var it = unlinkedComposites.iterator();
335         while (it.hasNext()) {
336             final var tmp = it.next().linkOriginalGeneratorRecursive();
337             if (tmp != LinkageProgress.NONE) {
338                 progress = LinkageProgress.SOME;
339             }
340             if (tmp == LinkageProgress.DONE) {
341                 it.remove();
342             }
343         }
344
345         if (unlinkedChildren.isEmpty() && unlinkedComposites.isEmpty()) {
346             // All done, set the list to null to indicate there is nothing left to do in this generator or any of our
347             // children.
348             unlinkedComposites = null;
349             return LinkageProgress.DONE;
350         }
351
352         return progress;
353     }
354
355     @Override
356     final AbstractCompositeGenerator<S, R> getOriginal() {
357         return (AbstractCompositeGenerator<S, R>) super.getOriginal();
358     }
359
360     @Override
361     final AbstractCompositeGenerator<S, R> tryOriginal() {
362         return (AbstractCompositeGenerator<S, R>) super.tryOriginal();
363     }
364
365     final <X extends EffectiveStatement<?, ?>, Y extends RuntimeType> @Nullable OriginalLink<X, Y> originalChild(
366             final QName childQName) {
367         // First try groupings/augments ...
368         var found = findInferredGenerator(childQName);
369         if (found != null) {
370             return (OriginalLink<X, Y>) OriginalLink.partial(found);
371         }
372
373         // ... no luck, we really need to start looking at our origin
374         final var prev = previous();
375         if (prev != null) {
376             final QName prevQName = childQName.bindTo(prev.getQName().getModule());
377             found = prev.findSchemaTreeGenerator(prevQName);
378             if (found != null) {
379                 return (OriginalLink<X, Y>) found.originalLink();
380             }
381         }
382
383         return null;
384     }
385
386     @Override
387     final AbstractExplicitGenerator<?, ?> findSchemaTreeGenerator(final QName qname) {
388         final var found = super.findSchemaTreeGenerator(qname);
389         return found != null ? found : findInferredGenerator(qname);
390     }
391
392     final @Nullable AbstractAugmentGenerator findAugmentForGenerator(final QName qname) {
393         for (var augment : augments) {
394             final var gen = augment.findSchemaTreeGenerator(qname);
395             if (gen != null) {
396                 return augment;
397             }
398         }
399         return null;
400     }
401
402     final @Nullable GroupingGenerator findGroupingForGenerator(final QName qname) {
403         for (var grouping : groupings) {
404             final var gen = grouping.findSchemaTreeGenerator(qname.bindTo(grouping.statement().argument().getModule()));
405             if (gen != null) {
406                 return grouping;
407             }
408         }
409         return null;
410     }
411
412     private @Nullable AbstractExplicitGenerator<?, ?> findInferredGenerator(final QName qname) {
413         // First search our local groupings ...
414         for (var grouping : groupings) {
415             final var gen = grouping.findSchemaTreeGenerator(qname.bindTo(grouping.statement().argument().getModule()));
416             if (gen != null) {
417                 return gen;
418             }
419         }
420         // ... next try local augments, which may have groupings themselves
421         for (var augment : augments) {
422             final var gen = augment.findSchemaTreeGenerator(qname);
423             if (gen != null) {
424                 return gen;
425             }
426         }
427         return null;
428     }
429
430     /**
431      * Update the specified builder to implement interfaces generated for the {@code grouping} statements this generator
432      * is using.
433      *
434      * @param builder Target builder
435      * @param builderFactory factory for creating {@link TypeBuilder}s
436      * @return The number of groupings this type uses.
437      */
438     final int addUsesInterfaces(final GeneratedTypeBuilder builder, final TypeBuilderFactory builderFactory) {
439         for (var grp : groupings) {
440             builder.addImplementsType(grp.getGeneratedType(builderFactory));
441         }
442         return groupings.size();
443     }
444
445     static final void addAugmentable(final GeneratedTypeBuilder builder) {
446         builder.addImplementsType(BindingTypes.augmentable(builder));
447     }
448
449     final void addGetterMethods(final GeneratedTypeBuilder builder, final TypeBuilderFactory builderFactory) {
450         for (var child : this) {
451             // Only process explicit generators here
452             if (child instanceof AbstractExplicitGenerator<?, ?> explicit) {
453                 explicit.addAsGetterMethod(builder, builderFactory);
454             }
455
456             final var enclosedType = child.enclosedType(builderFactory);
457             if (enclosedType instanceof GeneratedTransferObject gto) {
458                 builder.addEnclosingTransferObject(gto);
459             } else if (enclosedType instanceof Enumeration enumeration) {
460                 builder.addEnumeration(enumeration);
461             } else {
462                 verify(enclosedType == null, "Unhandled enclosed type %s in %s", enclosedType, child);
463             }
464         }
465     }
466
467     private @NonNull List<Generator> createChildren(final EffectiveStatement<?, ?> statement) {
468         final var tmp = new ArrayList<Generator>();
469         final var tmpAug = new ArrayList<AbstractAugmentGenerator>();
470
471         for (var stmt : statement.effectiveSubstatements()) {
472             if (stmt instanceof ActionEffectiveStatement action) {
473                 if (!isAugmenting(action)) {
474                     tmp.add(new ActionGenerator(action, this));
475                 }
476             } else if (stmt instanceof AnydataEffectiveStatement anydata) {
477                 if (!isAugmenting(anydata)) {
478                     tmp.add(new OpaqueObjectGenerator.Anydata(anydata, this));
479                 }
480             } else if (stmt instanceof AnyxmlEffectiveStatement anyxml) {
481                 if (!isAugmenting(anyxml)) {
482                     tmp.add(new OpaqueObjectGenerator.Anyxml(anyxml, this));
483                 }
484             } else if (stmt instanceof CaseEffectiveStatement cast) {
485                 tmp.add(new CaseGenerator(cast, this));
486             } else if (stmt instanceof ChoiceEffectiveStatement choice) {
487                 // FIXME: use isOriginalDeclaration() ?
488                 if (!isAddedByUses(choice)) {
489                     tmp.add(new ChoiceGenerator(choice, this));
490                 }
491             } else if (stmt instanceof ContainerEffectiveStatement container) {
492                 if (isOriginalDeclaration(container)) {
493                     tmp.add(new ContainerGenerator(container, this));
494                 }
495             } else if (stmt instanceof FeatureEffectiveStatement feature && this instanceof ModuleGenerator parent) {
496                 tmp.add(new FeatureGenerator(feature, parent));
497             } else if (stmt instanceof GroupingEffectiveStatement grouping) {
498                 tmp.add(new GroupingGenerator(grouping, this));
499             } else if (stmt instanceof IdentityEffectiveStatement identity) {
500                 tmp.add(new IdentityGenerator(identity, this));
501             } else if (stmt instanceof InputEffectiveStatement input) {
502                 tmp.add(new InputGenerator(input, this));
503             } else if (stmt instanceof LeafEffectiveStatement leaf) {
504                 if (!isAugmenting(leaf)) {
505                     tmp.add(new LeafGenerator(leaf, this));
506                 }
507             } else if (stmt instanceof LeafListEffectiveStatement leafList) {
508                 if (!isAugmenting(leafList)) {
509                     tmp.add(new LeafListGenerator(leafList, this));
510                 }
511             } else if (stmt instanceof ListEffectiveStatement list) {
512                 if (isOriginalDeclaration(list)) {
513                     final var listGen = new ListGenerator(list, this);
514                     tmp.add(listGen);
515
516                     final var keyGen = listGen.keyGenerator();
517                     if (keyGen != null) {
518                         tmp.add(keyGen);
519                     }
520                 }
521             } else if (stmt instanceof NotificationEffectiveStatement notification) {
522                 if (!isAugmenting(notification)) {
523                     tmp.add(new NotificationGenerator(notification, this));
524                 }
525             } else if (stmt instanceof OutputEffectiveStatement output) {
526                 tmp.add(new OutputGenerator(output, this));
527             } else if (stmt instanceof RpcEffectiveStatement rpc) {
528                 if (this instanceof ModuleGenerator module) {
529                     tmp.add(new RpcGenerator(rpc, module));
530                 }
531             } else if (stmt instanceof TypedefEffectiveStatement typedef) {
532                 tmp.add(new TypedefGenerator(typedef, this));
533             } else if (stmt instanceof AugmentEffectiveStatement augment) {
534                 // FIXME: MDSAL-695: So here we are ignoring any augment which is not in a module, while the 'uses'
535                 //                   processing takes care of the rest. There are two problems here:
536                 //
537                 //                   1) this could be an augment introduced through uses -- in this case we are picking
538                 //                      confusing it with this being its declaration site, we should probably be
539                 //                      ignoring it, but then
540                 //
541                 //                   2) we are losing track of AugmentEffectiveStatement for which we do not generate
542                 //                      interfaces -- and recover it at runtime through explicit walk along the
543                 //                      corresponding AugmentationSchemaNode.getOriginalDefinition() pointer
544                 //
545                 //                   So here is where we should decide how to handle this augment, and make sure we
546                 //                   retain information about this being an alias. That will serve as the base for keys
547                 //                   in the augment -> original map we provide to BindingRuntimeTypes.
548                 if (this instanceof ModuleGenerator module) {
549                     tmpAug.add(new ModuleAugmentGenerator(augment, module));
550                 }
551             } else if (stmt instanceof UsesEffectiveStatement uses) {
552                 for (var usesSub : uses.effectiveSubstatements()) {
553                     if (usesSub instanceof AugmentEffectiveStatement usesAug) {
554                         tmpAug.add(new UsesAugmentGenerator(usesAug, uses, this));
555                     }
556                 }
557             } else {
558                 LOG.trace("Ignoring statement {}", stmt);
559             }
560         }
561
562         // Sort augments and add them last. This ensures child iteration order always reflects potential
563         // interdependencies, hence we do not need to worry about them. This is extremely important, as there are a
564         // number of places where we would have to either move the logic to parent statement and explicitly filter/sort
565         // substatements to establish this order.
566         tmpAug.sort(AbstractAugmentGenerator.COMPARATOR);
567         tmp.addAll(tmpAug);
568
569         // Compatibility FooService and FooListener interfaces, only generated for modules.
570         if (this instanceof ModuleGenerator moduleGen) {
571             final List<NotificationGenerator> notifs = tmp.stream()
572                 .filter(NotificationGenerator.class::isInstance)
573                 .map(NotificationGenerator.class::cast)
574                 .collect(Collectors.toUnmodifiableList());
575             if (!notifs.isEmpty()) {
576                 tmp.add(new NotificationServiceGenerator(moduleGen, notifs));
577             }
578
579             final List<RpcGenerator> rpcs = tmp.stream()
580                 .filter(RpcGenerator.class::isInstance)
581                 .map(RpcGenerator.class::cast)
582                 .collect(Collectors.toUnmodifiableList());
583             if (!rpcs.isEmpty()) {
584                 tmp.add(new RpcServiceGenerator(moduleGen, rpcs));
585             }
586         }
587
588         return List.copyOf(tmp);
589     }
590
591     // Utility equivalent of (!isAddedByUses(stmt) && !isAugmenting(stmt)). Takes advantage of relationship between
592     // CopyableNode and AddedByUsesAware
593     private static boolean isOriginalDeclaration(final EffectiveStatement<?, ?> stmt) {
594         if (stmt instanceof AddedByUsesAware aware
595             && (aware.isAddedByUses() || stmt instanceof CopyableNode copyable && copyable.isAugmenting())) {
596             return false;
597         }
598         return true;
599     }
600
601     private static boolean isAddedByUses(final EffectiveStatement<?, ?> stmt) {
602         return stmt instanceof AddedByUsesAware aware && aware.isAddedByUses();
603     }
604
605     private static boolean isAugmenting(final EffectiveStatement<?, ?> stmt) {
606         return stmt instanceof CopyableNode copyable && copyable.isAugmenting();
607     }
608 }