LayoutBinder.java revision e9b33bac04bb1ce1444d7f1744fcec1ecd3a57da
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.reflection.ModelAnalyzer; 26import android.databinding.tool.store.ResourceBundle; 27import android.databinding.tool.store.ResourceBundle.BindingTargetBundle; 28import android.databinding.tool.store.SetterStore; 29import android.databinding.tool.util.ParserHelper; 30import android.databinding.tool.writer.LayoutBinderWriter; 31import android.databinding.tool.writer.WriterPackage; 32 33import java.util.ArrayList; 34import java.util.Collections; 35import java.util.Comparator; 36import java.util.HashMap; 37import java.util.List; 38import java.util.Map; 39 40/** 41 * Keeps all information about the bindings per layout file 42 */ 43public class LayoutBinder { 44 private static final Comparator<BindingTarget> COMPARE_FIELD_NAME = new Comparator<BindingTarget>() { 45 @Override 46 public int compare(BindingTarget first, BindingTarget second) { 47 final String fieldName1 = WriterPackage.getFieldName(first); 48 final String fieldName2 = WriterPackage.getFieldName(second); 49 return fieldName1.compareTo(fieldName2); 50 } 51 }; 52 53 /* 54 * val pkg: String, val projectPackage: String, val baseClassName: String, 55 val layoutName:String, val lb: LayoutExprBinding*/ 56 private final ExprModel mExprModel; 57 private final ExpressionParser mExpressionParser; 58 private final List<BindingTarget> mBindingTargets; 59 private final List<BindingTarget> mSortedBindingTargets; 60 private String mModulePackage; 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.LayoutFileBundle layoutBundle) { 67 mExprModel = new ExprModel(); 68 mExpressionParser = new ExpressionParser(mExprModel); 69 mBindingTargets = new ArrayList<BindingTarget>(); 70 mBundle = layoutBundle; 71 mModulePackage = layoutBundle.getModulePackage(); 72 // copy over data. 73 for (Map.Entry<String, String> variable : mBundle.getVariables().entrySet()) { 74 addVariable(variable.getKey(), variable.getValue()); 75 } 76 77 for (Map.Entry<String, String> userImport : mBundle.getImports().entrySet()) { 78 mExprModel.addImport(userImport.getKey(), userImport.getValue()); 79 } 80 for (BindingTargetBundle targetBundle : mBundle.getBindingTargetBundles()) { 81 final BindingTarget bindingTarget = createBindingTarget(targetBundle); 82 for (ResourceBundle.BindingTargetBundle.BindingBundle bindingBundle : targetBundle 83 .getBindingBundleList()) { 84 bindingTarget.addBinding(bindingBundle.getName(), parse(bindingBundle.getExpr())); 85 } 86 bindingTarget.resolveMultiSetters(); 87 } 88 mSortedBindingTargets = new ArrayList<BindingTarget>(mBindingTargets); 89 Collections.sort(mSortedBindingTargets, COMPARE_FIELD_NAME); 90 } 91 92 public void resolveWhichExpressionsAreUsed() { 93 List<Expr> used = new ArrayList<Expr>(); 94 for (BindingTarget target : mBindingTargets) { 95 for (Binding binding : target.getBindings()) { 96 binding.getExpr().setIsUsed(true); 97 used.add(binding.getExpr()); 98 } 99 } 100 while (!used.isEmpty()) { 101 Expr e = used.remove(used.size() - 1); 102 for (Dependency dep : e.getDependencies()) { 103 if (!dep.getOther().isUsed()) { 104 used.add(dep.getOther()); 105 dep.getOther().setIsUsed(true); 106 } 107 } 108 } 109 } 110 111 public IdentifierExpr addVariable(String name, String type) { 112 Preconditions.checkState(!mUserDefinedVariables.containsKey(name), 113 "%s has already been defined as %s", name, type); 114 final IdentifierExpr id = mExprModel.identifier(name); 115 id.setUserDefinedType(type); 116 id.enableDirectInvalidation(); 117 mUserDefinedVariables.put(name, type); 118 return id; 119 } 120 121 public HashMap<String, String> getUserDefinedVariables() { 122 return mUserDefinedVariables; 123 } 124 125 public BindingTarget createBindingTarget(ResourceBundle.BindingTargetBundle targetBundle) { 126 final BindingTarget target = new BindingTarget(targetBundle); 127 mBindingTargets.add(target); 128 target.setModel(mExprModel); 129 return target; 130 } 131 132 public Expr parse(String input) { 133 final Expr parsed = mExpressionParser.parse(input); 134 parsed.setBindingExpression(true); 135 return parsed; 136 } 137 138 public List<BindingTarget> getBindingTargets() { 139 return mBindingTargets; 140 } 141 142 public List<BindingTarget> getSortedTargets() { 143 return mSortedBindingTargets; 144 } 145 146 public boolean isEmpty() { 147 return mExprModel.size() == 0; 148 } 149 150 public ExprModel getModel() { 151 return mExprModel; 152 } 153 154 private void ensureWriter() { 155 if (mWriter == null) { 156 mWriter = new LayoutBinderWriter(this); 157 } 158 } 159 160 public String writeViewBinderBaseClass() { 161 ensureWriter(); 162 return mWriter.writeBaseClass(); 163 } 164 165 166 public String writeViewBinder(int minSdk) { 167 mExprModel.seal(); 168 ensureWriter(); 169 Preconditions.checkNotNull(getPackage(), "package cannot be null"); 170 Preconditions.checkNotNull(getClassName(), "base class name cannot be null"); 171 return mWriter.write(minSdk); 172 } 173 174 public String getPackage() { 175 return mBundle.getBindingClassPackage(); 176 } 177 178 public boolean isMerge() { 179 return mBundle.isMerge(); 180 } 181 182 public String getModulePackage() { 183 return mModulePackage; 184 } 185 186 public String getLayoutname() { 187 return mBundle.getFileName(); 188 } 189 190 public String getImplementationName() { 191 if (hasVariations()) { 192 return mBundle.getBindingClassName() + mBundle.getConfigName() + "Impl"; 193 } else { 194 return mBundle.getBindingClassName(); 195 } 196 } 197 198 public String getClassName() { 199 return mBundle.getBindingClassName(); 200 } 201 202 public String getTag() { 203 return mBundle.getDirectory() + "/" + mBundle.getFileName(); 204 } 205 206 public boolean hasVariations() { 207 return mBundle.hasVariations(); 208 } 209} 210