Class OuterClassNamePropagator

java.lang.Object

net.fabricmc.mappingio.adapter.ForwardingMappingVisitor

net.fabricmc.mappingio.adapter.OuterClassNamePropagator

All Implemented Interfaces:

MappingVisitor

public class OuterClassNamePropagator
extends ForwardingMappingVisitor

Searches for inner classes whose effective destination name contains outer classes referenced via their source name, waits for mappings for these enclosing classes, and applies the latters' destination names to the formers' fully qualified name.

For example, it takes a class class_1$class_2 that doesn't have a mapping, tries to find class_1, which let's say has the mapping SomeClass, and changes the former's destination name to SomeClass$class_2.

Implementation Note:

This visitor requires two pre-passes: one to collect all classes and their mappings, the other to actually apply the outer names. The third pass onwards will then emit the final mappings.

Field Summary

Fields inherited from class ForwardingMappingVisitor

next

Constructor Summary

Constructors

Constructor	Description
OuterClassNamePropagator(MappingVisitor next)	Constructs a new OuterClassNamePropagator which processes all destination namespaces, including already remapped class destination names therein.
OuterClassNamePropagator(MappingVisitor next, @Nullable Collection<String> namespaces, boolean processRemappedDstNames)	Constructs a new OuterClassNamePropagator which processes the selected destination namespaces.

Method Summary

Modifier and Type	Method	Description
Set<MappingFlag>	getFlags()
boolean	visitClass(String srcName)	Visit a class.
boolean	visitContent()	Determine whether the mapping content (classes and anything below, metadata if not part of the header) should be visited.
void	visitDstDesc(MappedElementKind targetKind, int namespace, String desc)
void	visitDstName(MappedElementKind targetKind, int namespace, String name)	Destination name for the current element.
boolean	visitElementContent(MappedElementKind targetKind)	Determine whether the element content (comment, sub-elements) should be visited.
boolean	visitEnd()	Finish the visitation pass.
boolean	visitHeader()	Determine whether the header (namespaces, metadata if part of the header) should be visited.
void	visitMetadata(String key, @Nullable String value)
void	visitNamespaces(String srcNamespace, List<String> dstNamespaces)

Methods inherited from class ForwardingMappingVisitor

reset, visitComment, visitField, visitMethod, visitMethodArg, visitMethodVar

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OuterClassNamePropagator

public OuterClassNamePropagator(MappingVisitor next)

Constructs a new OuterClassNamePropagator which processes all destination namespaces, including already remapped class destination names therein.

OuterClassNamePropagator

public OuterClassNamePropagator(MappingVisitor next,
 @Nullable
 @Nullable Collection<String> namespaces,
 boolean processRemappedDstNames)

Constructs a new OuterClassNamePropagator which processes the selected destination namespaces.

Parameters:

namespaces - The destination namespaces where outer class names shall be propagated. Pass null to process all destination namespaces.

processRemappedDstNames - Whether already remapped destination names should also get their unmapped outer classes replaced.

Method Details

getFlags

public Set<MappingFlag> getFlags()

Specified by:

getFlags in interface MappingVisitor

Overrides:

getFlags in class ForwardingMappingVisitor

visitHeader

public boolean visitHeader()
                    throws IOException

Description copied from interface: MappingVisitor

Determine whether the header (namespaces, metadata if part of the header) should be visited.

Specified by:

visitHeader in interface MappingVisitor

Overrides:

visitHeader in class ForwardingMappingVisitor

Returns:

true if the header is to be visited, false otherwise.

Throws:

IOException

visitNamespaces

public void visitNamespaces(String srcNamespace,
 List<String> dstNamespaces)
                     throws IOException

Specified by:

visitNamespaces in interface MappingVisitor

Overrides:

visitNamespaces in class ForwardingMappingVisitor

Throws:

IOException

visitMetadata

public void visitMetadata(String key,
 @Nullable
 @Nullable String value)
                   throws IOException

Specified by:

visitMetadata in interface MappingVisitor

Overrides:

visitMetadata in class ForwardingMappingVisitor

Throws:

IOException

visitContent

public boolean visitContent()
                     throws IOException

Description copied from interface: MappingVisitor

Determine whether the mapping content (classes and anything below, metadata if not part of the header) should be visited.

Specified by:

visitContent in interface MappingVisitor

Overrides:

visitContent in class ForwardingMappingVisitor

Returns:

true if content is to be visited, false otherwise.

Throws:

IOException

visitClass

public boolean visitClass(String srcName)
                   throws IOException

Description copied from interface: MappingVisitor

Visit a class.

Specified by:

visitClass in interface MappingVisitor

Overrides:

visitClass in class ForwardingMappingVisitor

Parameters:

srcName - The fully qualified source name of the class, in internal form (slashes instead of dots, dollar signs for delimiting inner classes).

Returns:

Whether the class's content should be visited too.

Throws:

IOException

visitDstName

public void visitDstName(MappedElementKind targetKind,
 int namespace,
 String name)
                  throws IOException

Description copied from interface: MappingVisitor

Destination name for the current element.

Specified by:

visitDstName in interface MappingVisitor

Overrides:

visitDstName in class ForwardingMappingVisitor

Parameters:

namespace - Namespace index (index into the dstNamespaces list in MappingVisitor.visitNamespaces(String, List)).

name - Destination name.

Throws:

IOException

visitDstDesc

public void visitDstDesc(MappedElementKind targetKind,
 int namespace,
 String desc)
                  throws IOException

Specified by:

visitDstDesc in interface MappingVisitor

Overrides:

visitDstDesc in class ForwardingMappingVisitor

Throws:

IOException

visitElementContent

public boolean visitElementContent(MappedElementKind targetKind)
                            throws IOException

Description copied from interface: MappingVisitor

Determine whether the element content (comment, sub-elements) should be visited.

Called after visiting the target itself (e.g. visitClass for targetKind=class), its dst names and descs, but before any child elements or the comment.

This is also a notification about all available dst names having been passed on.

Specified by:

visitElementContent in interface MappingVisitor

Overrides:

visitElementContent in class ForwardingMappingVisitor

Returns:

true if the contents are to be visited, false otherwise

Throws:

IOException

visitEnd

public boolean visitEnd()
                 throws IOException

Description copied from interface: MappingVisitor

Finish the visitation pass.

Implementors may throw an exception if a second pass is requested without the NEEDS_MULTIPLE_PASSES flag having been passed beforehand, but only if that behavior is documented.

Specified by:

visitEnd in interface MappingVisitor

Overrides:

visitEnd in class ForwardingMappingVisitor

Returns:

true if the visitation pass is final, false if it should be started over.

Throws:

IOException