LayoutBinder.java revision dea555cf42dc3583604699c8c018d22681f56166
1/* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.databinding.tool; 18 19import com.google.common.base.Preconditions; 20 21import android.databinding.tool.expr.Dependency; 22import android.databinding.tool.expr.Expr; 23import android.databinding.tool.expr.ExprModel; 24import android.databinding.tool.expr.IdentifierExpr; 25import android.databinding.tool.store.ResourceBundle; 26import android.databinding.tool.store.ResourceBundle.BindingTargetBundle; 27import android.databinding.tool.util.ParserHelper; 28import android.databinding.tool.writer.LayoutBinderWriter; 29import android.databinding.tool.writer.WriterPackage; 30 31import java.util.ArrayList; 32import java.util.Collections; 33import java.util.Comparator; 34import java.util.HashMap; 35import java.util.List; 36import java.util.Map; 37 38/** 39 * Keeps all information about the bindings per layout file 40 */ 41public class LayoutBinder { 42 private static final Comparator<BindingTarget> COMPARE_FIELD_NAME = new Comparator<BindingTarget>() { 43 @Override 44 public int compare(BindingTarget first, BindingTarget second) { 45 final String fieldName1 = WriterPackage.getFieldName(first); 46 final String fieldName2 = WriterPackage.getFieldName(second); 47 return fieldName1.compareTo(fieldName2); 48 } 49 }; 50 51 /* 52 * val pkg: String, val projectPackage: String, val baseClassName: String, 53 val layoutName:String, val lb: LayoutExprBinding*/ 54 private final ExprModel mExprModel; 55 private final ExpressionParser mExpressionParser; 56 private final List<BindingTarget> mBindingTargets; 57 private String mPackage; 58 private String mModulePackage; 59 private String mProjectPackage; 60 private String mBaseClassName; 61 private final HashMap<String, String> mUserDefinedVariables = new HashMap<String, String>(); 62 63 private LayoutBinderWriter mWriter; 64 private ResourceBundle.LayoutFileBundle mBundle; 65 66 public LayoutBinder(ResourceBundle resourceBundle, 67 ResourceBundle.LayoutFileBundle layoutBundle) { 68 mExprModel = new ExprModel(); 69 mExpressionParser = new ExpressionParser(mExprModel); 70 mBindingTargets = new ArrayList<BindingTarget>(); 71 mBundle = layoutBundle; 72 mProjectPackage = resourceBundle.getAppPackage(); 73 mModulePackage = layoutBundle.getModulePackage(); 74 mPackage = layoutBundle.getModulePackage() + ".generated"; 75 mBaseClassName = ParserHelper.INSTANCE$.toClassName(layoutBundle.getFileName()) + "Binding"; 76 // copy over data. 77 for (Map.Entry<String, String> variable : mBundle.getVariables().entrySet()) { 78 addVariable(variable.getKey(), variable.getValue()); 79 } 80 81 for (Map.Entry<String, String> userImport : mBundle.getImports().entrySet()) { 82 mExprModel.addImport(userImport.getKey(), userImport.getValue()); 83 } 84 for (BindingTargetBundle targetBundle : mBundle.getBindingTargetBundles()) { 85 final BindingTarget bindingTarget = createBindingTarget(targetBundle); 86 for (ResourceBundle.BindingTargetBundle.BindingBundle bindingBundle : targetBundle 87 .getBindingBundleList()) { 88 bindingTarget.addBinding(bindingBundle.getName(), parse(bindingBundle.getExpr())); 89 } 90 } 91 Collections.sort(mBindingTargets, COMPARE_FIELD_NAME); 92 } 93 94 public void resolveWhichExpressionsAreUsed() { 95 List<Expr> used = new ArrayList<Expr>(); 96 for (BindingTarget target : mBindingTargets) { 97 for (Binding binding : target.getBindings()) { 98 binding.getExpr().setIsUsed(true); 99 used.add(binding.getExpr()); 100 } 101 } 102 while (!used.isEmpty()) { 103 Expr e = used.remove(used.size() - 1); 104 for (Dependency dep : e.getDependencies()) { 105 if (!dep.getOther().isUsed()) { 106 used.add(dep.getOther()); 107 dep.getOther().setIsUsed(true); 108 } 109 } 110 } 111 } 112 113 public IdentifierExpr addVariable(String name, String type) { 114 Preconditions.checkState(!mUserDefinedVariables.containsKey(name), 115 "%s has already been defined as %s", name, type); 116 final IdentifierExpr id = mExprModel.identifier(name); 117 id.setUserDefinedType(type); 118 id.enableDirectInvalidation(); 119 mUserDefinedVariables.put(name, type); 120 return id; 121 } 122 123 public HashMap<String, String> getUserDefinedVariables() { 124 return mUserDefinedVariables; 125 } 126 127 public BindingTarget createBindingTarget(ResourceBundle.BindingTargetBundle targetBundle) { 128 final BindingTarget target = new BindingTarget(targetBundle); 129 mBindingTargets.add(target); 130 target.setModel(mExprModel); 131 return target; 132 } 133 134 public Expr parse(String input) { 135 final Expr parsed = mExpressionParser.parse(input); 136 parsed.setBindingExpression(true); 137 return parsed; 138 } 139 140 public List<BindingTarget> getBindingTargets() { 141 return mBindingTargets; 142 } 143 144 public boolean isEmpty() { 145 return mExprModel.size() == 0; 146 } 147 148 public ExprModel getModel() { 149 return mExprModel; 150 } 151 152 private void ensureWriter() { 153 if (mWriter == null) { 154 mWriter = new LayoutBinderWriter(this); 155 } 156 } 157 158 public String writeViewBinderBaseClass() { 159 ensureWriter(); 160 return mWriter.writeBaseClass(); 161 } 162 163 164 public String writeViewBinder() { 165 mExprModel.seal(); 166 ensureWriter(); 167 Preconditions.checkNotNull(mPackage, "package cannot be null"); 168 Preconditions.checkNotNull(mProjectPackage, "project package cannot be null"); 169 Preconditions.checkNotNull(mBaseClassName, "base class name cannot be null"); 170 return mWriter.write(); 171 } 172 173 public String getPackage() { 174 return mPackage; 175 } 176 177 public String getModulePackage() { 178 return mModulePackage; 179 } 180 181 public void setPackage(String aPackage) { 182 mPackage = aPackage; 183 } 184 185 public String getProjectPackage() { 186 return mProjectPackage; 187 } 188 189 public String getLayoutname() { 190 return mBundle.getFileName(); 191 } 192 193 public String getImplementationName() { 194 if (hasVariations()) { 195 final String suffix; 196 if (hasVariations()) { 197 suffix = mBundle.getConfigName(); 198 } else { 199 suffix = ""; 200 } 201 return mBaseClassName + suffix + "Impl"; 202 } else { 203 return mBaseClassName; 204 } 205 } 206 207 public String getClassName() { 208 return mBaseClassName; 209 } 210 211 public int getId() { 212 return mBundle.getLayoutId(); 213 } 214 215 public boolean hasVariations() { 216 return mBundle.hasVariations(); 217 } 218 219} 220