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.utils.StringUtils;
022import io.github.ascopes.jct.workspaces.impl.WrappingDirectoryImpl;
023import javax.tools.StandardLocation;
024import org.apiguardian.api.API;
025import org.apiguardian.api.API.Status;
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029/**
030 * Configurer for a file manager that applies the running JVM's platform classpath to the file
031 * manager.
032 *
033 * <p>If platform classpath inheritance is disabled in the compiler, then this will not run.
034 *
035 * @author Ashley Scopes
036 * @since 0.0.1
037 * @deprecated The platform class path has been mostly replaced by the use of system modules, so
038 * should not be used. This will be removed in v1.0.0.
039 */
040@API(since = "0.0.1", status = Status.STABLE)
041@Deprecated(forRemoval = true, since = "0.6.0")
042@SuppressWarnings("DeprecatedIsStillUsed")
043public final class JctFileManagerJvmPlatformClassPathConfigurer
044    implements JctFileManagerConfigurer {
045
046  private static final Logger LOGGER = LoggerFactory
047      .getLogger(JctFileManagerJvmPlatformClassPathConfigurer.class);
048
049  private final JctCompiler<?, ?> compiler;
050
051  /**
052   * Initialise the configurer with the desired compiler.
053   *
054   * @param compiler the compiler to wrap.
055   */
056  public JctFileManagerJvmPlatformClassPathConfigurer(JctCompiler<?, ?> compiler) {
057    this.compiler = compiler;
058  }
059
060  @Override
061  @SuppressWarnings("removal")
062  public JctFileManager configure(JctFileManager fileManager) {
063    LOGGER.debug("Configuring JVM platform class path");
064
065    SpecialLocationUtils
066        .currentPlatformClassPathLocations()
067        .stream()
068        .peek(loc -> LOGGER
069            .atTrace()
070            .setMessage("Adding {} ({}) to file manager platform class path (inherited from JVM))")
071            .addArgument(() -> StringUtils.quoted(loc.toAbsolutePath()))
072            .addArgument(() -> StringUtils.quoted(loc.toUri()))
073            .log())
074        .map(WrappingDirectoryImpl::new)
075        .forEach(dir -> fileManager.addPath(StandardLocation.PLATFORM_CLASS_PATH, dir));
076
077    return fileManager;
078  }
079
080  @Override
081  @SuppressWarnings("removal")
082  public boolean isEnabled() {
083    return compiler.isInheritPlatformClassPath();
084  }
085}