com.facebook.buck.cxx.toolchain.HeaderSymlinkTree.java Source code

Introduction

Here is the source code for com.facebook.buck.cxx.toolchain.HeaderSymlinkTree.java

Source

/*
 * Copyright 2015-present Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.facebook.buck.cxx.toolchain;

import com.facebook.buck.core.model.BuildTarget;
import com.facebook.buck.core.rules.SourcePathRuleFinder;
import com.facebook.buck.core.rules.impl.SymlinkTree;
import com.facebook.buck.core.sourcepath.PathSourcePath;
import com.facebook.buck.core.sourcepath.SourcePath;
import com.facebook.buck.io.filesystem.ProjectFilesystem;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMultimap;
import java.nio.file.Path;
import java.util.Optional;

public class HeaderSymlinkTree extends SymlinkTree {

    public HeaderSymlinkTree(BuildTarget target, ProjectFilesystem filesystem, Path root,
            ImmutableMap<Path, SourcePath> links, SourcePathRuleFinder ruleFinder) {
        super("cxx_header", target, filesystem, root, links, ImmutableMultimap.of(), ruleFinder);
    }

    /**
     * Get path to use as an include path to get access to the files in the tree.
     *
     * <p>If {@link #getHeaderMapSourcePath()} is present, then the path it returns needs to be passed
     * as an include path as well and it has to be passed before the path returned from this method.
     *
     * <p>This path should not be added to rulekeys as a SourcePath (in some cases it points to the
     * entire buck-out).
     */
    public PathSourcePath getIncludeSourcePath() {
        return PathSourcePath.of(getProjectFilesystem(), getProjectFilesystem().relativize(getRoot()));
    }

    public Optional<SourcePath> getHeaderMapSourcePath() {
        return Optional.empty();
    }
}