com.google.devtools.build.lib.rules.cpp.CppModuleMap.java Source code

Introduction

Here is the source code for com.google.devtools.build.lib.rules.cpp.CppModuleMap.java

Source

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.google.devtools.build.lib.rules.cpp;

import com.google.common.base.Optional;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;

/**
 * Structure for C++ module maps. Stores the name of the module and a .cppmap artifact.
 */
@Immutable
public final class CppModuleMap {
    // NOTE: If you add a field here, you'll likely need to update CppModuleMapAction.computeKey().
    private final Artifact artifact;
    private final String name;
    private final Optional<Artifact> umbrellaHeader;

    public CppModuleMap(Artifact artifact, String name) {
        this(artifact, null, name);
    }

    public CppModuleMap(Artifact artifact, Artifact umbrellaHeader, String name) {
        this.artifact = artifact;
        this.umbrellaHeader = Optional.fromNullable(umbrellaHeader);
        this.name = name;
    }

    public Artifact getArtifact() {
        return artifact;
    }

    public String getName() {
        return name;
    }

    /**
     * Returns an optional umbrella header artifact. The headers declared in module maps are compiled
     * using the #import directives which are incompatible with J2ObjC segmented headers. The headers
     * generated by J2ObjC need to be compiled using the #include directives. We can #include all the
     * headers in an umbrella header and then delcare the umbrella header in the module map.
     */
    public Optional<Artifact> getUmbrellaHeader() {
        return umbrellaHeader;
    }

    @Override
    public String toString() {
        return name + "@" + artifact;
    }

    /**
     * Specifies whether to generate an umbrella header.
     */
    public enum UmbrellaHeaderStrategy {
        /** Generate an umbrella header. */
        GENERATE,
        /** Do not generate an umbrella header. */
        DO_NOT_GENERATE
    }
}