aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/java/JavaPluginInfoProvider.java
blob: 48241d4ccf805c31488272d960edf592f5bc268d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// 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.java;

import com.google.auto.value.AutoValue;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import java.util.ArrayList;
import java.util.List;

/** Provider for users of Java plugins. */
@AutoCodec
@Immutable
@AutoValue
public abstract class JavaPluginInfoProvider implements TransitiveInfoProvider {

  /** Information about a Java plugin, except for whether it generates API. */
  @AutoCodec
  @Immutable
  @AutoValue
  public abstract static class JavaPluginInfo {

    public static JavaPluginInfo create(
        NestedSet<String> processorClasses, NestedSet<Artifact> processorClasspath) {
      return new AutoValue_JavaPluginInfoProvider_JavaPluginInfo(
          processorClasses, processorClasspath);
    }

    @AutoCodec.Instantiator
    public static JavaPluginInfo empty() {
      return create(
          NestedSetBuilder.emptySet(Order.NAIVE_LINK_ORDER),
          NestedSetBuilder.emptySet(Order.NAIVE_LINK_ORDER));
    }

    public static JavaPluginInfo merge(Iterable<JavaPluginInfo> plugins) {
      NestedSetBuilder<String> processorClasses = NestedSetBuilder.naiveLinkOrder();
      NestedSetBuilder<Artifact> processorClasspath = NestedSetBuilder.naiveLinkOrder();
      for (JavaPluginInfo plugin : plugins) {
        processorClasses.addTransitive(plugin.processorClasses());
        processorClasspath.addTransitive(plugin.processorClasspath());
      }
      return create(processorClasses.build(), processorClasspath.build());
    }

    /**
     * Returns the class that should be passed to javac in order to run the annotation processor
     * this class represents.
     */
    public abstract NestedSet<String> processorClasses();

    /** Returns the artifacts to add to the runtime classpath for this plugin. */
    public abstract NestedSet<Artifact> processorClasspath();

    public boolean isEmpty() {
      return processorClasses().isEmpty() && processorClasspath().isEmpty();
    }
  }

  public static JavaPluginInfoProvider merge(Iterable<JavaPluginInfoProvider> providers) {
    List<JavaPluginInfo> plugins = new ArrayList<>();
    List<JavaPluginInfo> apiGeneratingPlugins = new ArrayList<>();
    for (JavaPluginInfoProvider provider : providers) {
      plugins.add(provider.plugins());
      apiGeneratingPlugins.add(provider.apiGeneratingPlugins());
    }
    return new AutoValue_JavaPluginInfoProvider(
        JavaPluginInfo.merge(plugins), JavaPluginInfo.merge(apiGeneratingPlugins));
  }

  public static JavaPluginInfoProvider create(JavaPluginInfo javaPluginInfo, Boolean generatesApi) {
    return new AutoValue_JavaPluginInfoProvider(
        javaPluginInfo, generatesApi ? javaPluginInfo : JavaPluginInfo.empty());
  }

  @AutoCodec.Instantiator
  public static JavaPluginInfoProvider empty() {
    return new AutoValue_JavaPluginInfoProvider(JavaPluginInfo.empty(), JavaPluginInfo.empty());
  }

  public abstract JavaPluginInfo plugins();

  public abstract JavaPluginInfo apiGeneratingPlugins();

  public boolean isEmpty() {
    // apiGeneratingPlugins is a subset of plugins, so checking if plugins is empty is sufficient
    return plugins().isEmpty();
  }
}