org.enginehub.piston.gen.GenerationSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of FastAsyncWorldEdit-Libs-Ap Show documentation

Blazingly fast Minecraft world manipulation for artists, builders and everyone else.

There is a newer version: 2.11.2

Show newest version

/*
 * Piston, a flexible command management system.
 * Copyright (C) EngineHub 
 * Copyright (C) Piston contributors
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see .
 */

package org.enginehub.piston.gen;

import com.squareup.javapoet.AnnotationSpec;
import com.squareup.javapoet.CodeBlock;
import com.squareup.javapoet.TypeName;
import org.enginehub.piston.inject.Key;

import javax.annotation.Nullable;

public interface GenerationSupport {

    /**
     * Request that a variable with the given type and name be in-scope
     * for the code block returned by the method using this support object.
     * Also requests that it be injected, i.e. the code asking for this variable
     * doesn't know how it should be initialized.
     *
     * 
     * You may also share variables, if the non-null share key matches. This allows
     * for easy injection of common dependencies, shared by multiple different code generators.
     * 
     *
     * @param type the type of the variable
     * @param name the base name of the variable
     * @param shareKey if non-null, share variables that match this key, as well as type and
     *     name
     * @return the actual name of the variable. You must use this to reference it.
     */
    String requestDependency(TypeName type, String name, @Nullable Object shareKey);

    /**
     * Request a field to store data in. The code requesting this field will initialize
     * it.
     *
     * 
     * You may also share variables, if the non-null share key matches. This allows
     * for easy injection of common dependencies, shared by multiple different code generators.
     * 
     *
     * @param type the type of the field
     * @param name the requested name of the field
     * @param shareKey if non-null, share variables that match this key, as well as type and
     *     name
     * @return the actual name of the field. You must use this to reference it.
     */
    String requestField(TypeName type, String name, @Nullable Object shareKey);

    /**
     * Request a method name, avoiding collisions.
     *
     * @param name the base name for the method
     * @return the actual name of the method
     */
    String requestMethodName(String name);

    /**
     * Request a {@link Key} that provides the type at runtime.
     *
     * @param type the type to represent with a {@code Key}
     * @param annotationSpec the annotation to include on the {@code Key}
     * @return code that represents an expression which will return the correct {@code Key}
     */
    CodeBlock requestKey(TypeName type, @Nullable AnnotationSpec annotationSpec);

}