19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.util; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.Method; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.lang.reflect.InvocationTargetException; 21cb64d430627b71221c588ef5f23599dd34a89ee9Elliott Hughesimport java.util.Locale; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 24a0f8bc51aff98c2e23e73069e447f63397471a0aJesse Wilson * <p>Various utilities for debugging and logging.</p> 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class DebugUtils { 27a0f8bc51aff98c2e23e73069e447f63397471a0aJesse Wilson /** @hide */ public DebugUtils() {} 28a0f8bc51aff98c2e23e73069e447f63397471a0aJesse Wilson 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Filters objects against the <code>ANDROID_OBJECT_FILTER</code> 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * environment variable. This environment variable can filter objects 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * based on their class name and attribute values.</p> 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Here is the syntax for <code>ANDROID_OBJECT_FILTER</code>:</p> 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><code>ClassName@attribute1=value1@attribute2=value2...</code></p> 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Examples:</p> 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Select TextView instances: <code>TextView</code></li> 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li>Select TextView instances of text "Loading" and bottom offset of 22: 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <code>TextView@text=Loading.*@bottom=22</code></li> 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The class name and the values are regular expressions.</p> 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>This class is useful for debugging and logging purpose:</p> 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre> 4934f1ca7b79ff678a651aea4b82e032b798506b37Dave Bort * if (DEBUG) { 5034f1ca7b79ff678a651aea4b82e032b798506b37Dave Bort * if (DebugUtils.isObjectSelected(childView) && LOGV_ENABLED) { 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Log.v(TAG, "Object " + childView + " logged!"); 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </pre> 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><strong>NOTE</strong>: This method is very expensive as it relies 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * heavily on regular expressions and reflection. Calls to this method 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * should always be stripped out of the release binaries and avoided 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as much as possible in debug mode.</p> 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param object any object to match against the ANDROID_OBJECT_FILTER 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * environement variable 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if object is selected by the ANDROID_OBJECT_FILTER 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * environment variable, false otherwise 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean isObjectSelected(Object object) { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean match = false; 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String s = System.getenv("ANDROID_OBJECT_FILTER"); 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (s != null && s.length() > 0) { 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String[] selectors = s.split("@"); 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // first selector == class name 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (object.getClass().getSimpleName().matches(selectors[0])) { 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // check potential attributes 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 1; i < selectors.length; i++) { 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String[] pair = selectors[i].split("="); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Class<?> klass = object.getClass(); 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Method declaredMethod = null; 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Class<?> parent = klass; 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project do { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project declaredMethod = parent.getDeclaredMethod("get" + 82cb64d430627b71221c588ef5f23599dd34a89ee9Elliott Hughes pair[0].substring(0, 1).toUpperCase(Locale.ROOT) + 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pair[0].substring(1), 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (Class[]) null); 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } while ((parent = klass.getSuperclass()) != null && 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project declaredMethod == null); 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (declaredMethod != null) { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Object value = declaredMethod 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project .invoke(object, (Object[])null); 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project match |= (value != null ? 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project value.toString() : "null").matches(pair[1]); 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (NoSuchMethodException e) { 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.printStackTrace(); 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalAccessException e) { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.printStackTrace(); 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (InvocationTargetException e) { 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.printStackTrace(); 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return match; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 107a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn /** @hide */ 108a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn public static void buildShortClassTag(Object cls, StringBuilder out) { 109a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn if (cls == null) { 110a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn out.append("null"); 111a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn } else { 112a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn String simpleName = cls.getClass().getSimpleName(); 113a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn if (simpleName == null || simpleName.isEmpty()) { 114a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn simpleName = cls.getClass().getName(); 115a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn int end = simpleName.lastIndexOf('.'); 116a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn if (end > 0) { 117a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn simpleName = simpleName.substring(end+1); 118a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn } 119a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn } 120a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn out.append(simpleName); 121a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn out.append('{'); 122a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn out.append(Integer.toHexString(System.identityHashCode(cls))); 123a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn } 124a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn } 125a2ea747faaf5fcd437afbaaf4085cfc29e7c16b8Dianne Hackborn 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 127