net.fabricmc.mapping.reader.v2

Interface TinyVisitor

public interface TinyVisitor

A visitor that explores Tiny V2 mappings.

State information should be stored in the visitor. This visitor preferably should use a stack structure to keep track of its visit state so that it collects context correctly.

The caller of the visitor needs to guarantee the state of the mapping is correct.

All descriptors in the visits are in the format of the namespace at TinyMetadata.index(String) index} 0. Do not remap these descriptors as you don't have access to all class mappings when you received the descriptors! It's recommended to put the collected mappings in a Map and then use a remapper to remap descriptors when the mapping visit is finished.

Method Summary

Modifier and Type	Method and Description
default void	pop(int count) Remove a few elements from the context stack.
default void	pushClass(MappingGetter name) Visit a class.
default void	pushComment(String comment) Visits a comment (JavaDoc).
default void	pushField(MappingGetter name, String descriptor) Visit a field.
default void	pushLocalVariable(MappingGetter name, int localVariableIndex, int localVariableStartOffset, int localVariableTableIndex) Visits a method's local variable.
default void	pushMethod(MappingGetter name, String descriptor) Visit a method.
default void	pushParameter(MappingGetter name, int localVariableIndex) Visits a method parameter.
default void	start(TinyMetadata metadata) Start visiting a new mapping and collect basic mapping information.

Method Detail

start

default void start(TinyMetadata metadata)

Start visiting a new mapping and collect basic mapping information.

It's recommended to collect the index of namespaces you want to track from the metadata.

Parameters:

metadata - the metadata of the Tiny V2 mapping

pushClass

default void pushClass(MappingGetter name)

Visit a class.

start(TinyMetadata) is called before this call and the visit stack is empty.

Parameters:

name - the mappings

pushField

default void pushField(MappingGetter name,
                       String descriptor)

Visit a field.

pushClass(MappingGetter) is called before this call and the last element in the visit stack is a class.

Parameters:

name - the mappings

descriptor - the descriptor in the index 0 namespace's mapping

pushMethod

default void pushMethod(MappingGetter name,
                        String descriptor)

Visit a method.

pushClass(MappingGetter) is called before this call and the last element in the visit stack is a class.

Parameters:

name - the mappings

descriptor - the descriptor in the index 0 namespace's mapping

pushParameter

default void pushParameter(MappingGetter name,
                           int localVariableIndex)

Visits a method parameter.

pushMethod(MappingGetter, String) (MappingGetter)} is called before this call and the last element in the visit stack is a method.

Parameters:

name - the mappings

localVariableIndex - the local variable index

pushLocalVariable

default void pushLocalVariable(MappingGetter name,
                               int localVariableIndex,
                               int localVariableStartOffset,
                               int localVariableTableIndex)

Visits a method's local variable.

pushMethod(MappingGetter, String) (MappingGetter)} is called before this call and the last element in the visit stack is a method.

Parameters:

name - the mappings

localVariableIndex - the local variable index

localVariableStartOffset - the local variable start offset

localVariableTableIndex - the local variable table index

pushComment

default void pushComment(String comment)

Visits a comment (JavaDoc).

One of the other push methods is called before this call; the visit stack is not empty, and the last element in the visit stack can be commented (i.e. everything other than a comment).

Parameters:

comment - the comment

pop

default void pop(int count)

Remove a few elements from the context stack.

The sum of count of all pop calls should equal to the number of push calls when each class visit is finished.

Parameters:

count - the number of elements removed