LayoutBinder.java revision 96e1c821dd446d1ed78f8ae61131550588f60a24
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 final List<BindingTarget> mSortedBindingTargets; 58 private String mPackage; 59 private String mModulePackage; 60 private String mProjectPackage; 61 private String mBaseClassName; 62 private final HashMap<String, String> mUserDefinedVariables = new HashMap<String, String>(); 63 64 private LayoutBinderWriter mWriter; 65 private ResourceBundle.LayoutFileBundle mBundle; 66 67 public LayoutBinder(ResourceBundle resourceBundle, 68 ResourceBundle.LayoutFileBundle layoutBundle) { 69 mExprModel = new ExprModel(); 70 mExpressionParser = new ExpressionParser(mExprModel); 71 mBindingTargets = new ArrayList<BindingTarget>(); 72 mBundle = layoutBundle; 73 mProjectPackage = resourceBundle.getAppPackage(); 74 mModulePackage = layoutBundle.getModulePackage(); 75 mPackage = layoutBundle.getModulePackage() + ".databinding"; 76 mBaseClassName = ParserHelper.INSTANCE$.toClassName(layoutBundle.getFileName()) + "Binding"; 77 // copy over data. 78 for (Map.Entry<String, String> variable : mBundle.getVariables().entrySet()) { 79 addVariable(variable.getKey(), variable.getValue()); 80 } 81 82 for (Map.Entry<String, String> userImport : mBundle.getImports().entrySet()) { 83 mExprModel.addImport(userImport.getKey(), userImport.getValue()); 84 } 85 for (BindingTargetBundle targetBundle : mBundle.getBindingTargetBundles()) { 86 final BindingTarget bindingTarget = createBindingTarget(targetBundle); 87 for (ResourceBundle.BindingTargetBundle.BindingBundle bindingBundle : targetBundle 88 .getBindingBundleList()) { 89 bindingTarget.addBinding(bindingBundle.getName(), parse(bindingBundle.getExpr())); 90 } 91 } 92 mSortedBindingTargets = new ArrayList<BindingTarget>(mBindingTargets); 93 Collections.sort(mSortedBindingTargets, COMPARE_FIELD_NAME); 94 } 95 96 public void resolveWhichExpressionsAreUsed() { 97 List<Expr> used = new ArrayList<Expr>(); 98 for (BindingTarget target : mBindingTargets) { 99 for (Binding binding : target.getBindings()) { 100 binding.getExpr().setIsUsed(true); 101 used.add(binding.getExpr()); 102 } 103 } 104 while (!used.isEmpty()) { 105 Expr e = used.remove(used.size() - 1); 106 for (Dependency dep : e.getDependencies()) { 107 if (!dep.getOther().isUsed()) { 108 used.add(dep.getOther()); 109 dep.getOther().setIsUsed(true); 110 } 111 } 112 } 113 } 114 115 public IdentifierExpr addVariable(String name, String type) { 116 Preconditions.checkState(!mUserDefinedVariables.containsKey(name), 117 "%s has already been defined as %s", name, type); 118 final IdentifierExpr id = mExprModel.identifier(name); 119 id.setUserDefinedType(type); 120 id.enableDirectInvalidation(); 121 mUserDefinedVariables.put(name, type); 122 return id; 123 } 124 125 public HashMap<String, String> getUserDefinedVariables() { 126 return mUserDefinedVariables; 127 } 128 129 public BindingTarget createBindingTarget(ResourceBundle.BindingTargetBundle targetBundle) { 130 final BindingTarget target = new BindingTarget(targetBundle); 131 mBindingTargets.add(target); 132 target.setModel(mExprModel); 133 return target; 134 } 135 136 public Expr parse(String input) { 137 final Expr parsed = mExpressionParser.parse(input); 138 parsed.setBindingExpression(true); 139 return parsed; 140 } 141 142 public List<BindingTarget> getBindingTargets() { 143 return mBindingTargets; 144 } 145 146 public List<BindingTarget> getSortedTargets() { 147 return mSortedBindingTargets; 148 } 149 150 public boolean isEmpty() { 151 return mExprModel.size() == 0; 152 } 153 154 public ExprModel getModel() { 155 return mExprModel; 156 } 157 158 private void ensureWriter() { 159 if (mWriter == null) { 160 mWriter = new LayoutBinderWriter(this); 161 } 162 } 163 164 public String writeViewBinderBaseClass() { 165 ensureWriter(); 166 return mWriter.writeBaseClass(); 167 } 168 169 170 public String writeViewBinder(int minSdk) { 171 mExprModel.seal(); 172 ensureWriter(); 173 Preconditions.checkNotNull(mPackage, "package cannot be null"); 174 Preconditions.checkNotNull(mProjectPackage, "project package cannot be null"); 175 Preconditions.checkNotNull(mBaseClassName, "base class name cannot be null"); 176 return mWriter.write(minSdk); 177 } 178 179 public String getPackage() { 180 return mPackage; 181 } 182 183 public boolean isMerge() { 184 return mBundle.isMerge(); 185 } 186 187 public String getModulePackage() { 188 return mModulePackage; 189 } 190 191 public void setPackage(String aPackage) { 192 mPackage = aPackage; 193 } 194 195 public String getProjectPackage() { 196 return mProjectPackage; 197 } 198 199 public String getLayoutname() { 200 return mBundle.getFileName(); 201 } 202 203 public String getImplementationName() { 204 if (hasVariations()) { 205 return mBaseClassName + mBundle.getConfigName() + "Impl"; 206 } else { 207 return mBaseClassName; 208 } 209 } 210 211 public String getClassName() { 212 return mBaseClassName; 213 } 214 215 public String getTag() { 216 return mBundle.getDirectory() + "/" + mBundle.getFileName(); 217 } 218 219 public boolean hasVariations() { 220 return mBundle.hasVariations(); 221 } 222} 223