aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc_tools/plmerge/java/com/google/devtools/build/xcode/plmerge/MergingArguments.java
blob: 61d23de74925780a9b6620016b4116cffebf84b2 (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// Copyright 2015 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.xcode.plmerge;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.xcode.plmerge.PlMerge.PlMergeOptions;
import com.google.devtools.build.xcode.plmerge.proto.PlMergeProtos.Control;

import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;

/**
 * Container for data consumed by plmerge
 */
class MergingArguments {

  private final FileSystem fileSystem = FileSystems.getDefault();
  private final List<Path> sourceFilePaths;
  private final List<Path> immutableSourceFilePaths;
  private final String outFile;
  private final Map<String, String> variableSubstitutions;
  private final String primaryBundleId;
  private final String fallbackBundleId;
  private final String executableName;

  /**
   * Build MergingArguments from a plmerge protobuf.
   */
  public MergingArguments(Control control) {
    ImmutableList.Builder<Path> sourceFilePathsBuilder = new Builder<>();
    for (String pathString : control.getSourceFileList()) {
      sourceFilePathsBuilder.add(fileSystem.getPath(pathString));
    }
    sourceFilePaths = sourceFilePathsBuilder.build();
    
    ImmutableList.Builder<Path> immutableSourceFilePathsBuilder = new Builder<>();
    for (String pathString : control.getImmutableSourceFileList()) {
      immutableSourceFilePathsBuilder.add(fileSystem.getPath(pathString));
    }
    immutableSourceFilePaths = immutableSourceFilePathsBuilder.build();
    
    outFile = control.getOutFile();
    variableSubstitutions = control.getVariableSubstitutionMap();
    primaryBundleId = control.getPrimaryBundleId();
    fallbackBundleId = control.getFallbackBundleId();
    if (control.hasExecutableName()) {
      executableName = control.getExecutableName();
    } else {
      executableName = null;
    }
  }

  /**
   * Build MergingArguments from command line arguments passed to the plmerge executable.
   */
  public MergingArguments(PlMergeOptions options) {
    ImmutableList.Builder<Path> sourceFilePathsBuilder = new Builder<Path>();
    for (String sourceFile : options.sourceFiles) {
      sourceFilePathsBuilder.add(fileSystem.getPath(sourceFile));
    }

    sourceFilePaths = sourceFilePathsBuilder.build();
    immutableSourceFilePaths = ImmutableList.<Path>of();
    outFile = options.outFile;
    variableSubstitutions = ImmutableMap.<String, String>of();
    primaryBundleId = options.primaryBundleId;
    fallbackBundleId = options.fallbackBundleId;
    executableName = null;
  }

  /**
   * Returns paths to the plist files to merge relative to plmerge. These can be
   * binary, XML, or ASCII format.
   */
  public List<Path> getSourceFilePaths() {
    return sourceFilePaths;
  }

  /*
   * Returns paths to plist files with keys which may not be overwritten.
   */
  public List<Path> getImmutableSourceFilePaths() {
    return immutableSourceFilePaths;
  }
  
  /**
   * Returns path to the output file to merge relative to plmerge.
   */
  public String getOutFile() {
    return outFile;
  }

  /**
   * Returns a reverse-DNS string identifier for this bundle associated with output
   * binary plist.  Overrides the bundle id specified in the CFBundleIdentifier
   * plist field.
   */
  public String getPrimaryBundleId() {
    return primaryBundleId;
  }

  /**
   * Returns a fallback reverse-DNS string identifier for this bundle when bundle
   * identifier is not specified in primary_bundle_id or an associated plist
   * file.
   */
  public String getFallbackBundleId() {
    return fallbackBundleId;
  }

  /**
   * Returns key-value substitutions to support templating for plists.  A substitution
   * is made if the substitution key appears as a value for any key-value pair
   * in any source_file.
   * For example, a plist with the entry:
   *    <pre><key>CFBundleExectuable</key>
   *    <string>EXECUTABLE_NAME</string></pre>
   * could be templated by passing a variable substitution like
   *    {"EXECUTABLE_NAME", "PrenotCalculator"}
   */
  public Map<String, String> getVariableSubstitutions() {
    return variableSubstitutions;
  }
  
  /**
   * Returns the name of the executable for the bundle the merged plist is intended for, or null
   * if no such executable exists.
   */
  public String getExecutableName() {
    return executableName;
  }
}