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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
// Copyright 2015 Google Inc. 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.common.base.Joiner;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ConfigurationEnvironment;
import com.google.devtools.build.lib.analysis.config.ConfigurationFragmentFactory;
import com.google.devtools.build.lib.analysis.config.FragmentOptions;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import java.util.Collections;
import java.util.Set;
/**
* A J2ObjC transpiler configuration fragment containing J2ObjC translation flags.
* This configuration fragment is used by Java rules that can be transpiled
* (specifically, J2ObjCAspects thereof).
*/
public class J2ObjcConfiguration extends Fragment {
/**
* Always-on flags for J2ObjC translation. These flags will always be used for invoking the J2ObjC
* transpiler. See https://github.com/google/j2objc/wiki/j2objc for flag documentation.
*/
private static final Set<String> J2OBJC_ALWAYS_ON_TRANSLATION_FLAGS = ImmutableSet.of(
"-encoding",
"UTF-8",
"--doc-comments",
"--extract-unsequenced",
"--final-methods-as-functions",
"--hide-private-members",
"--segmented-headers",
"-XcombineJars");
/**
* Allowed flags for J2ObjC translation. See https://github.com/google/j2objc/wiki/j2objc for flag
* documentation.
*/
static final Set<String> J2OBJC_BLACKLISTED_TRANSLATION_FLAGS =
ImmutableSet.of("--prefixes", "--prefix", "-x");
static final String INVALID_TRANSLATION_FLAGS_MSG_TEMPLATE =
"J2Objc translation flags: %s not supported. Unsupported flags are: %s";
/**
* Configuration loader for {@link J2ObjcConfiguration}.
*/
public static class Loader implements ConfigurationFragmentFactory {
@Override
public Fragment create(ConfigurationEnvironment env, BuildOptions buildOptions) {
return new J2ObjcConfiguration(buildOptions.get(J2ObjcCommandLineOptions.class));
}
@Override
public Class<? extends Fragment> creates() {
return J2ObjcConfiguration.class;
}
@Override
public ImmutableSet<Class<? extends FragmentOptions>> requiredOptions() {
return ImmutableSet.<Class<? extends FragmentOptions>>of(J2ObjcCommandLineOptions.class);
}
}
private final Set<String> translationFlags;
private final boolean removeDeadCode;
J2ObjcConfiguration(J2ObjcCommandLineOptions j2ObjcOptions) {
this.removeDeadCode = j2ObjcOptions.removeDeadCode;
this.translationFlags = ImmutableSet.<String>builder()
.addAll(j2ObjcOptions.translationFlags)
.addAll(J2OBJC_ALWAYS_ON_TRANSLATION_FLAGS)
.build();
}
/**
* Returns the translation flags used to invoke the J2ObjC transpiler. The returned flags contain
* both the always-on flags from {@link #J2OBJC_ALWAYS_ON_TRANSLATION_FLAGS} and user-specified
* flags from {@link J2ObjcCommandLineOptions}. The set of valid flags can be found at
* {@link #J2OBJC_BLACKLISTED_TRANSLATION_FLAGS}.
*/
public Iterable<String> getTranslationFlags() {
return translationFlags;
}
/**
* Returns whether to perform J2ObjC dead code removal. If true, the list of entry classes will be
* collected transitively throuh "entry_classes" attribute on j2objc_library and used as entry
* points to perform dead code analysis. Unused classes will then be removed from the final ObjC
* app bundle.
*/
public boolean removeDeadCode() {
return removeDeadCode;
}
@Override
public void reportInvalidOptions(EventHandler reporter, BuildOptions buildOptions) {
if (!Collections.disjoint(translationFlags, J2OBJC_BLACKLISTED_TRANSLATION_FLAGS)) {
String errorMsg = String.format(INVALID_TRANSLATION_FLAGS_MSG_TEMPLATE,
Joiner.on(",").join(translationFlags),
Joiner.on(",").join(J2OBJC_BLACKLISTED_TRANSLATION_FLAGS));
reporter.handle(Event.error(errorMsg));
}
}
}
|
