/*
 * JDrupes Builder
 * Copyright (C) 2025 Michael N. Lipp
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package org.jdrupes.builder.api;

import com.google.common.flogger.FluentLogger;
import static com.google.common.flogger.StackSize.*;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.lang.reflect.WildcardType;
import java.util.Arrays;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Stream;

/// A special kind of type token for representing a resource type.
/// The method [rawType()] returns the type as [Class]. If this class
/// is derived from [Resources], [containedType()] returns the
/// [ResourceType] of the contained elements.
///
/// Beware of automatic inference of type arguments. The inferred
/// type arguments will usually be superclasses of what you expect.
///
/// An alternative to using an anonymous class to create a type token
/// is to statically import the `resourceType` methods. Using these
/// typically also results in clear code that is sometimes easier to read.   
///
/// @param <T> the resource type
///
public class ResourceType<T extends Resource> {

    private static final FluentLogger logger = FluentLogger.forEnclosingClass();

    /// The resource type for [ExecResult].
    @SuppressWarnings({ "PMD.FieldNamingConventions",
        "PMD.AvoidDuplicateLiterals" })
    public static final ResourceType<Resource> BaseResourceType
        = new ResourceType<>() {};

    /// Used to request cleanup.
    @SuppressWarnings({ "PMD.FieldNamingConventions" })
    public static final ResourceType<
            Cleanliness> CleanlinessType = new ResourceType<>() {};

    /// The resource type for [ResourceFile].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<ResourceFile> ResourceFileType
        = new ResourceType<>() {};

    /// The resource type for [FileResource].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<FileResource> FileResourceType
        = new ResourceType<>() {};

    /// The resource type for [FileTree]&lt;[FileResource]&gt;.
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<FileTree<FileResource>> BaseFileTreeType
        = new ResourceType<>() {};

    /// The resource type for [InputTree]&lt;[InputResource]&gt;.
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<InputTree<InputResource>> BaseInputTreeType
        = new ResourceType<>() {};

    /// The resource type for [IOResource].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<
            IOResource> IOResourceType = new ResourceType<>() {};

    /// The resource type for `Resources[IOResource]`.
    @SuppressWarnings({ "PMD.FieldNamingConventions" })
    public static final ResourceType<Resources<IOResource>> IOResourcesType
        = new ResourceType<>(Resources.class, IOResourceType) {};

    /// The resource type for [TestResult].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<TestResult> TestResultType
        = new ResourceType<>() {};

    /// The resource type for [ExecResult].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<ExecResult<?>> ExecResultType
        = new ResourceType<>() {};

    /// The resource type for [ZipFile].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<ZipFile> ZipFileType
        = new ResourceType<>() {};

    /// The resource type for [TarFile].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<TarFile> TarFileType
        = new ResourceType<>() {};

    /// The resource type for [ZipFile].
    @SuppressWarnings("PMD.FieldNamingConventions")
    public static final ResourceType<TarGzFile> TarGzFileType
        = new ResourceType<>() {};

    private final Class<T> type;
    private final ResourceType<?> containedType;

    /// Creates a new resource type from the given type. The common
    /// usage pattern is to import this method statically.
    ///
    /// @param <T> the generic type
    /// @param type the type
    /// @return the resource type
    ///
    public static <T extends Resource> ResourceType<T>
            resourceType(Class<T> type) {
        if (Resources.class.isAssignableFrom(type)) {
            throw new IllegalArgumentException("Method resourceType may"
                + " not be called with container type " + type);
        }
        return new ResourceType<>(type);
    }

    /// Creates a new [Resources] type from the given values. The common
    /// usage pattern is to import this method statically.
    ///
    /// @param <T> the generic type
    /// @param type the type
    /// @param containedType the contained type
    /// @return the resource type
    ///
    public static <T extends Resource> ResourceType<T> resourceType(
            @SuppressWarnings("rawtypes") Class<? extends Resources> type,
            ResourceType<?> containedType) {
        return new ResourceType<>(type, containedType);
    }

    @SuppressWarnings({ "unchecked", "PMD.AvoidDuplicateLiterals" })
    private ResourceType(Class<? extends Resource> type,
            ResourceType<?> containedType) {
        if (Resources.class.isAssignableFrom(type) && containedType == null) {
            logger.atWarning().withStackTrace(MEDIUM).log("Creating resource"
                + " type for %s without information about contained type",
                type);
        }
        this.type = (Class<T>) type;
        this.containedType = containedType;
    }

    /// Creates a new resource type from the given container type
    /// and contained type. The common usage pattern is to import
    /// this method statically.
    ///
    /// @param <C> the container type
    /// @param <E> the element type
    /// @param type the type
    /// @param elementType the element type
    /// @return the resource type
    ///
    public static <C extends Resources<E>, E extends Resource> ResourceType<C>
            create(Class<C> type, Class<E> elementType) {
        return new ResourceType<>(type, resourceType(elementType));
    }

    @SuppressWarnings("unchecked")
    private ResourceType(Type type) {
        if (type instanceof WildcardType wType) {
            type = wType.getUpperBounds()[0];
            if (Object.class.equals(type)) {
                type = Resource.class;
            }
        }
        if (type instanceof ParameterizedType pType && Resources.class
            .isAssignableFrom((Class<?>) pType.getRawType())) {
            this.type = (Class<T>) pType.getRawType();
            var argType = pType.getActualTypeArguments()[0];
            if (argType instanceof ParameterizedType pArgType) {
                containedType = new ResourceType<>(pArgType);
            } else {
                var subType = pType.getActualTypeArguments()[0];
                if (subType instanceof TypeVariable) {
                    logger.atWarning().withStackTrace(MEDIUM).log(
                        "Type contained in %s is unknown", type);
                    containedType = BaseResourceType;
                    return;
                }
                containedType = new ResourceType<>(subType);
            }
            return;
        }

        // If this is a parameterized type, but not resources,
        // ignore the parameter(s).
        if (type instanceof ParameterizedType pType) {
            type = pType.getRawType();
        }

        this.type = (Class<T>) type;
        if (!Resources.class.isAssignableFrom(this.type)) {
            this.containedType = null;
            return;
        }

        // If type is not a parameterized type, its super or one of its
        // interfaces may be.
        @SuppressWarnings("rawtypes")
        final var rawBaseResourceType = (ResourceType) BaseResourceType;
        this.containedType = Stream.concat(
            Optional.ofNullable(((Class<?>) type).getGenericSuperclass())
                .stream(),
            getAllInterfaces((Class<?>) type).map(Class::getGenericInterfaces)
                .map(Arrays::stream).flatMap(s -> s))
            .filter(t -> t instanceof ParameterizedType pType && Resources.class
                .isAssignableFrom((Class<?>) pType.getRawType()))
            .map(t -> (ParameterizedType) t).findFirst()
            .map(t -> new ResourceType<>(t).containedType())
            .orElse(rawBaseResourceType);
    }

    /// Gets all interfaces that the given class implements,
    /// including the class itself.
    ///
    /// @param clazz the clazz
    /// @return all interfaces
    ///
    public static Stream<Class<?>> getAllInterfaces(Class<?> clazz) {
        return Stream.concat(Stream.of(clazz),
            Arrays.stream(clazz.getInterfaces())
                .map(ResourceType::getAllInterfaces).flatMap(s -> s));
    }

    /// Instantiates a new resource type, using the information from a
    /// derived class.
    ///
    @SuppressWarnings({ "unchecked", "PMD.AvoidCatchingGenericException",
        "rawtypes" })
    protected ResourceType() {
        Type resourceType = getClass().getGenericSuperclass();
        try {
            Type theResource = ((ParameterizedType) resourceType)
                .getActualTypeArguments()[0];
            var tempType = new ResourceType(theResource);
            type = tempType.rawType();
            containedType = tempType.containedType();
        } catch (Exception e) {
            throw new UnsupportedOperationException(
                "Could not derive resource type for " + resourceType, e);
        }
    }

    /// Return the type.
    ///
    /// @return the class
    ///
    public Class<T> rawType() {
        return type;
    }

    /// Return the contained type or `null`, if the resource is not
    /// a container.
    ///
    /// @return the type
    ///
    public ResourceType<?> containedType() {
        return containedType;
    }

    /// Checks if this is assignable from the other resource type.
    ///
    /// @param other the other
    /// @return true, if is assignable from
    ///
    @SuppressWarnings("PMD.SimplifyBooleanReturns")
    public boolean isAssignableFrom(ResourceType<?> other) {
        if (!type.isAssignableFrom(other.type)) {
            return false;
        }
        if (Objects.isNull(containedType)) {
            // If this is not a container but assignable, we're okay.
            return true;
        }
        if (Objects.isNull(other.containedType)) {
            // If this is a container but other is not, this should
            // have failed before.
            return false;
        }
        return containedType.isAssignableFrom(other.containedType);
    }

    /// Returns a new [ResourceType] with the type (`this.type()`)
    /// widened to the given type. While this method may be invoked
    /// for any [ResourceType], it is intended to be used for
    /// containers (`ResourceType<Resources<?>>`) only.
    ///
    /// @param <R> the new raw type
    /// @param type the desired super type. This should actually be
    /// declared as `Class <R>`, but there is no way to specify a 
    /// parameterized type as actual parameter.
    /// @return the new resource type
    ///
    public <R extends Resource> ResourceType<R> widened(
            Class<? extends Resource> type) {
        if (!type.isAssignableFrom(this.type)) {
            throw new IllegalArgumentException("Cannot replace "
                + this.type + " with " + type + " because it is not a "
                + "super class");
        }
        if (Resources.class.isAssignableFrom(this.type)
            && !Resources.class.isAssignableFrom(type)) {
            throw new IllegalArgumentException("Cannot replace container"
                + " type " + this.type + " with non-container type " + type);
        }
        @SuppressWarnings("unchecked")
        var result = new ResourceType<R>((Class<R>) type, containedType);
        return result;
    }

    @Override
    public int hashCode() {
        return Objects.hash(containedType, type);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!ResourceType.class.isAssignableFrom(obj.getClass())) {
            return false;
        }
        ResourceType<?> other = (ResourceType<?>) obj;
        return Objects.equals(containedType, other.containedType)
            && Objects.equals(type, other.type);
    }

    @Override
    public String toString() {
        return type.getSimpleName() + (containedType == null ? ""
            : "<" + containedType + ">");
    }

}