001/*
002 * Copyright (C) 2022 - 2023, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.filemanagers.config;
017
018import io.github.ascopes.jct.compilers.JctCompiler;
019import io.github.ascopes.jct.filemanagers.JctFileManager;
020import io.github.ascopes.jct.utils.SpecialLocationUtils;
021import io.github.ascopes.jct.workspaces.impl.WrappingDirectoryImpl;
022import javax.tools.StandardLocation;
023import org.apiguardian.api.API;
024import org.apiguardian.api.API.Status;
025import org.slf4j.Logger;
026import org.slf4j.LoggerFactory;
027
028/**
029 * Configurer for a file manager that applies the running JVM's platform classpath to the file
030 * manager.
031 *
032 * <p>If platform classpath inheritance is disabled in the compiler, then this will not run.
033 *
034 * @author Ashley Scopes
035 * @since 0.0.1 (0.0.1-M7)
036 * @deprecated The platform class path has been mostly replaced by the use of system modules, so
037 * should not be used. This will be removed in v1.0.0.
038 */
039@API(since = "0.0.1", status = Status.STABLE)
040@Deprecated(forRemoval = true, since = "0.6.0")
041@SuppressWarnings("DeprecatedIsStillUsed")
042public final class JctFileManagerJvmPlatformClassPathConfigurer
043    implements JctFileManagerConfigurer {
044
045  private static final Logger LOGGER = LoggerFactory
046      .getLogger(JctFileManagerJvmPlatformClassPathConfigurer.class);
047
048  private final JctCompiler<?, ?> compiler;
049
050  /**
051   * Initialise the configurer with the desired compiler.
052   *
053   * @param compiler the compiler to wrap.
054   */
055  public JctFileManagerJvmPlatformClassPathConfigurer(JctCompiler<?, ?> compiler) {
056    this.compiler = compiler;
057  }
058
059  @Override
060  @SuppressWarnings("removal")
061  public JctFileManager configure(JctFileManager fileManager) {
062    LOGGER.debug("Configuring JVM platform class path");
063
064    SpecialLocationUtils
065        .currentPlatformClassPathLocations()
066        .stream()
067        .peek(loc -> LOGGER.trace(
068            "Adding {} to file manager platform classpath (inherited from JVM)", loc
069        ))
070        .map(WrappingDirectoryImpl::new)
071        .forEach(dir -> fileManager.addPath(StandardLocation.PLATFORM_CLASS_PATH, dir));
072
073    return fileManager;
074  }
075
076  @Override
077  @SuppressWarnings("removal")
078  public boolean isEnabled() {
079    return compiler.isInheritPlatformClassPath();
080  }
081}