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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
|
/*
* Copyright (C) 2007 The Android Open Source Project
*
* 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 android.view;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.TestApi;
import android.annotation.UnsupportedAppUsage;
import android.content.Context;
import android.content.res.Resources;
import android.graphics.Bitmap;
import android.graphics.Canvas;
import android.graphics.HardwareRenderer;
import android.graphics.Picture;
import android.graphics.RecordingCanvas;
import android.graphics.Rect;
import android.graphics.RenderNode;
import android.os.Debug;
import android.os.Handler;
import android.os.Looper;
import android.os.RemoteException;
import android.util.DisplayMetrics;
import android.util.Log;
import android.util.TypedValue;
import java.io.BufferedOutputStream;
import java.io.BufferedWriter;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.concurrent.Callable;
import java.util.concurrent.CancellationException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Function;
/**
* Various debugging/tracing tools related to {@link View} and the view hierarchy.
*/
public class ViewDebug {
/**
* @deprecated This flag is now unused
*/
@Deprecated
public static final boolean TRACE_HIERARCHY = false;
/**
* @deprecated This flag is now unused
*/
@Deprecated
public static final boolean TRACE_RECYCLER = false;
/**
* Enables detailed logging of drag/drop operations.
* @hide
*/
public static final boolean DEBUG_DRAG = false;
/**
* Enables detailed logging of task positioning operations.
* @hide
*/
public static final boolean DEBUG_POSITIONING = false;
/**
* This annotation can be used to mark fields and methods to be dumped by
* the view server. Only non-void methods with no arguments can be annotated
* by this annotation.
*/
@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExportedProperty {
/**
* When resolveId is true, and if the annotated field/method return value
* is an int, the value is converted to an Android's resource name.
*
* @return true if the property's value must be transformed into an Android
* resource name, false otherwise
*/
boolean resolveId() default false;
/**
* A mapping can be defined to map int values to specific strings. For
* instance, View.getVisibility() returns 0, 4 or 8. However, these values
* actually mean VISIBLE, INVISIBLE and GONE. A mapping can be used to see
* these human readable values:
*
* <pre>
* {@literal @}ViewDebug.ExportedProperty(mapping = {
* {@literal @}ViewDebug.IntToString(from = 0, to = "VISIBLE"),
* {@literal @}ViewDebug.IntToString(from = 4, to = "INVISIBLE"),
* {@literal @}ViewDebug.IntToString(from = 8, to = "GONE")
* })
* public int getVisibility() { ...
* <pre>
*
* @return An array of int to String mappings
*
* @see android.view.ViewDebug.IntToString
*/
IntToString[] mapping() default { };
/**
* A mapping can be defined to map array indices to specific strings.
* A mapping can be used to see human readable values for the indices
* of an array:
*
* <pre>
* {@literal @}ViewDebug.ExportedProperty(indexMapping = {
* {@literal @}ViewDebug.IntToString(from = 0, to = "INVALID"),
* {@literal @}ViewDebug.IntToString(from = 1, to = "FIRST"),
* {@literal @}ViewDebug.IntToString(from = 2, to = "SECOND")
* })
* private int[] mElements;
* <pre>
*
* @return An array of int to String mappings
*
* @see android.view.ViewDebug.IntToString
* @see #mapping()
*/
IntToString[] indexMapping() default { };
/**
* A flags mapping can be defined to map flags encoded in an integer to
* specific strings. A mapping can be used to see human readable values
* for the flags of an integer:
*
* <pre>
* {@literal @}ViewDebug.ExportedProperty(flagMapping = {
* {@literal @}ViewDebug.FlagToString(mask = ENABLED_MASK, equals = ENABLED,
* name = "ENABLED"),
* {@literal @}ViewDebug.FlagToString(mask = ENABLED_MASK, equals = DISABLED,
* name = "DISABLED"),
* })
* private int mFlags;
* <pre>
*
* A specified String is output when the following is true:
*
* @return An array of int to String mappings
*/
FlagToString[] flagMapping() default { };
/**
* When deep export is turned on, this property is not dumped. Instead, the
* properties contained in this property are dumped. Each child property
* is prefixed with the name of this property.
*
* @return true if the properties of this property should be dumped
*
* @see #prefix()
*/
boolean deepExport() default false;
/**
* The prefix to use on child properties when deep export is enabled
*
* @return a prefix as a String
*
* @see #deepExport()
*/
String prefix() default "";
/**
* Specifies the category the property falls into, such as measurement,
* layout, drawing, etc.
*
* @return the category as String
*/
String category() default "";
/**
* Indicates whether or not to format an {@code int} or {@code byte} value as a hex string.
*
* @return true if the supported values should be formatted as a hex string.
*/
boolean formatToHexString() default false;
/**
* Indicates whether or not the key to value mappings are held in adjacent indices.
*
* Note: Applies only to fields and methods that return String[].
*
* @return true if the key to value mappings are held in adjacent indices.
*/
boolean hasAdjacentMapping() default false;
}
/**
* Defines a mapping from an int value to a String. Such a mapping can be used
* in an @ExportedProperty to provide more meaningful values to the end user.
*
* @see android.view.ViewDebug.ExportedProperty
*/
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface IntToString {
/**
* The original int value to map to a String.
*
* @return An arbitrary int value.
*/
int from();
/**
* The String to use in place of the original int value.
*
* @return An arbitrary non-null String.
*/
String to();
}
/**
* Defines a mapping from a flag to a String. Such a mapping can be used
* in an @ExportedProperty to provide more meaningful values to the end user.
*
* @see android.view.ViewDebug.ExportedProperty
*/
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface FlagToString {
/**
* The mask to apply to the original value.
*
* @return An arbitrary int value.
*/
int mask();
/**
* The value to compare to the result of:
* <code>original value & {@link #mask()}</code>.
*
* @return An arbitrary value.
*/
int equals();
/**
* The String to use in place of the original int value.
*
* @return An arbitrary non-null String.
*/
String name();
/**
* Indicates whether to output the flag when the test is true,
* or false. Defaults to true.
*/
boolean outputIf() default true;
}
/**
* This annotation can be used to mark fields and methods to be dumped when
* the view is captured. Methods with this annotation must have no arguments
* and must return a valid type of data.
*/
@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface CapturedViewProperty {
/**
* When retrieveReturn is true, we need to retrieve second level methods
* e.g., we need myView.getFirstLevelMethod().getSecondLevelMethod()
* we will set retrieveReturn = true on the annotation of
* myView.getFirstLevelMethod()
* @return true if we need the second level methods
*/
boolean retrieveReturn() default false;
}
/**
* Allows a View to inject custom children into HierarchyViewer. For example,
* WebView uses this to add its internal layer tree as a child to itself
* @hide
*/
public interface HierarchyHandler {
/**
* Dumps custom children to hierarchy viewer.
* See ViewDebug.dumpViewWithProperties(Context, View, BufferedWriter, int)
* for the format
*
* An empty implementation should simply do nothing
*
* @param out The output writer
* @param level The indentation level
*/
public void dumpViewHierarchyWithProperties(BufferedWriter out, int level);
/**
* Returns a View to enable grabbing screenshots from custom children
* returned in dumpViewHierarchyWithProperties.
*
* @param className The className of the view to find
* @param hashCode The hashCode of the view to find
* @return the View to capture from, or null if not found
*/
public View findHierarchyView(String className, int hashCode);
}
private static HashMap<Class<?>, Method[]> mCapturedViewMethodsForClasses = null;
private static HashMap<Class<?>, Field[]> mCapturedViewFieldsForClasses = null;
// Maximum delay in ms after which we stop trying to capture a View's drawing
private static final int CAPTURE_TIMEOUT = 4000;
private static final String REMOTE_COMMAND_CAPTURE = "CAPTURE";
private static final String REMOTE_COMMAND_DUMP = "DUMP";
private static final String REMOTE_COMMAND_DUMP_THEME = "DUMP_THEME";
private static final String REMOTE_COMMAND_INVALIDATE = "INVALIDATE";
private static final String REMOTE_COMMAND_REQUEST_LAYOUT = "REQUEST_LAYOUT";
private static final String REMOTE_PROFILE = "PROFILE";
private static final String REMOTE_COMMAND_CAPTURE_LAYERS = "CAPTURE_LAYERS";
private static final String REMOTE_COMMAND_OUTPUT_DISPLAYLIST = "OUTPUT_DISPLAYLIST";
private static HashMap<Class<?>, Field[]> sFieldsForClasses;
private static HashMap<Class<?>, Method[]> sMethodsForClasses;
private static HashMap<AccessibleObject, ExportedProperty> sAnnotations;
/**
* @deprecated This enum is now unused
*/
@Deprecated
public enum HierarchyTraceType {
INVALIDATE,
INVALIDATE_CHILD,
INVALIDATE_CHILD_IN_PARENT,
REQUEST_LAYOUT,
ON_LAYOUT,
ON_MEASURE,
DRAW,
BUILD_CACHE
}
/**
* @deprecated This enum is now unused
*/
@Deprecated
public enum RecyclerTraceType {
NEW_VIEW,
BIND_VIEW,
RECYCLE_FROM_ACTIVE_HEAP,
RECYCLE_FROM_SCRAP_HEAP,
MOVE_TO_SCRAP_HEAP,
MOVE_FROM_ACTIVE_TO_SCRAP_HEAP
}
/**
* Returns the number of instanciated Views.
*
* @return The number of Views instanciated in the current process.
*
* @hide
*/
@UnsupportedAppUsage
public static long getViewInstanceCount() {
return Debug.countInstancesOfClass(View.class);
}
/**
* Returns the number of instanciated ViewAncestors.
*
* @return The number of ViewAncestors instanciated in the current process.
*
* @hide
*/
@UnsupportedAppUsage
public static long getViewRootImplCount() {
return Debug.countInstancesOfClass(ViewRootImpl.class);
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
@SuppressWarnings({ "UnusedParameters", "deprecation" })
public static void trace(View view, RecyclerTraceType type, int... parameters) {
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
@SuppressWarnings("UnusedParameters")
public static void startRecyclerTracing(String prefix, View view) {
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
@SuppressWarnings("UnusedParameters")
public static void stopRecyclerTracing() {
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
@SuppressWarnings({ "UnusedParameters", "deprecation" })
public static void trace(View view, HierarchyTraceType type) {
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
@SuppressWarnings("UnusedParameters")
public static void startHierarchyTracing(String prefix, View view) {
}
/**
* @deprecated This method is now unused and invoking it is a no-op
*/
@Deprecated
public static void stopHierarchyTracing() {
}
@UnsupportedAppUsage
static void dispatchCommand(View view, String command, String parameters,
OutputStream clientStream) throws IOException {
// Paranoid but safe...
view = view.getRootView();
if (REMOTE_COMMAND_DUMP.equalsIgnoreCase(command)) {
dump(view, false, true, clientStream);
} else if (REMOTE_COMMAND_DUMP_THEME.equalsIgnoreCase(command)) {
dumpTheme(view, clientStream);
} else if (REMOTE_COMMAND_CAPTURE_LAYERS.equalsIgnoreCase(command)) {
captureLayers(view, new DataOutputStream(clientStream));
} else {
final String[] params = parameters.split(" ");
if (REMOTE_COMMAND_CAPTURE.equalsIgnoreCase(command)) {
capture(view, clientStream, params[0]);
} else if (REMOTE_COMMAND_OUTPUT_DISPLAYLIST.equalsIgnoreCase(command)) {
outputDisplayList(view, params[0]);
} else if (REMOTE_COMMAND_INVALIDATE.equalsIgnoreCase(command)) {
invalidate(view, params[0]);
} else if (REMOTE_COMMAND_REQUEST_LAYOUT.equalsIgnoreCase(command)) {
requestLayout(view, params[0]);
} else if (REMOTE_PROFILE.equalsIgnoreCase(command)) {
profile(view, clientStream, params[0]);
}
}
}
/** @hide */
public static View findView(View root, String parameter) {
// Look by type/hashcode
if (parameter.indexOf('@') != -1) {
final String[] ids = parameter.split("@");
final String className = ids[0];
final int hashCode = (int) Long.parseLong(ids[1], 16);
View view = root.getRootView();
if (view instanceof ViewGroup) {
return findView((ViewGroup) view, className, hashCode);
}
} else {
// Look by id
final int id = root.getResources().getIdentifier(parameter, null, null);
return root.getRootView().findViewById(id);
}
return null;
}
private static void invalidate(View root, String parameter) {
final View view = findView(root, parameter);
if (view != null) {
view.postInvalidate();
}
}
private static void requestLayout(View root, String parameter) {
final View view = findView(root, parameter);
if (view != null) {
root.post(new Runnable() {
public void run() {
view.requestLayout();
}
});
}
}
private static void profile(View root, OutputStream clientStream, String parameter)
throws IOException {
final View view = findView(root, parameter);
BufferedWriter out = null;
try {
out = new BufferedWriter(new OutputStreamWriter(clientStream), 32 * 1024);
if (view != null) {
profileViewAndChildren(view, out);
} else {
out.write("-1 -1 -1");
out.newLine();
}
out.write("DONE.");
out.newLine();
} catch (Exception e) {
android.util.Log.w("View", "Problem profiling the view:", e);
} finally {
if (out != null) {
out.close();
}
}
}
/** @hide */
public static void profileViewAndChildren(final View view, BufferedWriter out)
throws IOException {
RenderNode node = RenderNode.create("ViewDebug", null);
profileViewAndChildren(view, node, out, true);
}
private static void profileViewAndChildren(View view, RenderNode node, BufferedWriter out,
boolean root) throws IOException {
long durationMeasure =
(root || (view.mPrivateFlags & View.PFLAG_MEASURED_DIMENSION_SET) != 0)
? profileViewMeasure(view) : 0;
long durationLayout =
(root || (view.mPrivateFlags & View.PFLAG_LAYOUT_REQUIRED) != 0)
? profileViewLayout(view) : 0;
long durationDraw =
(root || !view.willNotDraw() || (view.mPrivateFlags & View.PFLAG_DRAWN) != 0)
? profileViewDraw(view, node) : 0;
out.write(String.valueOf(durationMeasure));
out.write(' ');
out.write(String.valueOf(durationLayout));
out.write(' ');
out.write(String.valueOf(durationDraw));
out.newLine();
if (view instanceof ViewGroup) {
ViewGroup group = (ViewGroup) view;
final int count = group.getChildCount();
for (int i = 0; i < count; i++) {
profileViewAndChildren(group.getChildAt(i), node, out, false);
}
}
}
private static long profileViewMeasure(final View view) {
return profileViewOperation(view, new ViewOperation() {
@Override
public void pre() {
forceLayout(view);
}
private void forceLayout(View view) {
view.forceLayout();
if (view instanceof ViewGroup) {
ViewGroup group = (ViewGroup) view;
final int count = group.getChildCount();
for (int i = 0; i < count; i++) {
forceLayout(group.getChildAt(i));
}
}
}
@Override
public void run() {
view.measure(view.mOldWidthMeasureSpec, view.mOldHeightMeasureSpec);
}
});
}
private static long profileViewLayout(View view) {
return profileViewOperation(view,
() -> view.layout(view.mLeft, view.mTop, view.mRight, view.mBottom));
}
private static long profileViewDraw(View view, RenderNode node) {
DisplayMetrics dm = view.getResources().getDisplayMetrics();
if (dm == null) {
return 0;
}
if (view.isHardwareAccelerated()) {
RecordingCanvas canvas = node.beginRecording(dm.widthPixels, dm.heightPixels);
try {
return profileViewOperation(view, () -> view.draw(canvas));
} finally {
node.endRecording();
}
} else {
Bitmap bitmap = Bitmap.createBitmap(
dm, dm.widthPixels, dm.heightPixels, Bitmap.Config.RGB_565);
Canvas canvas = new Canvas(bitmap);
try {
return profileViewOperation(view, () -> view.draw(canvas));
} finally {
canvas.setBitmap(null);
bitmap.recycle();
}
}
}
interface ViewOperation {
default void pre() {}
void run();
}
private static long profileViewOperation(View view, final ViewOperation operation) {
final CountDownLatch latch = new CountDownLatch(1);
final long[] duration = new long[1];
view.post(() -> {
try {
operation.pre();
long start = Debug.threadCpuTimeNanos();
//noinspection unchecked
operation.run();
duration[0] = Debug.threadCpuTimeNanos() - start;
} finally {
latch.countDown();
}
});
try {
if (!latch.await(CAPTURE_TIMEOUT, TimeUnit.MILLISECONDS)) {
Log.w("View", "Could not complete the profiling of the view " + view);
return -1;
}
} catch (InterruptedException e) {
Log.w("View", "Could not complete the profiling of the view " + view);
Thread.currentThread().interrupt();
return -1;
}
return duration[0];
}
/** @hide */
public static void captureLayers(View root, final DataOutputStream clientStream)
throws IOException {
try {
Rect outRect = new Rect();
try {
root.mAttachInfo.mSession.getDisplayFrame(root.mAttachInfo.mWindow, outRect);
} catch (RemoteException e) {
// Ignore
}
clientStream.writeInt(outRect.width());
clientStream.writeInt(outRect.height());
captureViewLayer(root, clientStream, true);
clientStream.write(2);
} finally {
clientStream.close();
}
}
private static void captureViewLayer(View view, DataOutputStream clientStream, boolean visible)
throws IOException {
final boolean localVisible = view.getVisibility() == View.VISIBLE && visible;
if ((view.mPrivateFlags & View.PFLAG_SKIP_DRAW) != View.PFLAG_SKIP_DRAW) {
final int id = view.getId();
String name = view.getClass().getSimpleName();
if (id != View.NO_ID) {
name = resolveId(view.getContext(), id).toString();
}
clientStream.write(1);
clientStream.writeUTF(name);
clientStream.writeByte(localVisible ? 1 : 0);
int[] position = new int[2];
// XXX: Should happen on the UI thread
view.getLocationInWindow(position);
clientStream.writeInt(position[0]);
clientStream.writeInt(position[1]);
clientStream.flush();
Bitmap b = performViewCapture(view, true);
if (b != null) {
ByteArrayOutputStream arrayOut = new ByteArrayOutputStream(b.getWidth() *
b.getHeight() * 2);
b.compress(Bitmap.CompressFormat.PNG, 100, arrayOut);
clientStream.writeInt(arrayOut.size());
arrayOut.writeTo(clientStream);
}
clientStream.flush();
}
if (view instanceof ViewGroup) {
ViewGroup group = (ViewGroup) view;
int count = group.getChildCount();
for (int i = 0; i < count; i++) {
captureViewLayer(group.getChildAt(i), clientStream, localVisible);
}
}
if (view.mOverlay != null) {
ViewGroup overlayContainer = view.getOverlay().mOverlayViewGroup;
captureViewLayer(overlayContainer, clientStream, localVisible);
}
}
private static void outputDisplayList(View root, String parameter) throws IOException {
final View view = findView(root, parameter);
view.getViewRootImpl().outputDisplayList(view);
}
/** @hide */
public static void outputDisplayList(View root, View target) {
root.getViewRootImpl().outputDisplayList(target);
}
private static class PictureCallbackHandler implements AutoCloseable,
HardwareRenderer.PictureCapturedCallback, Runnable {
private final HardwareRenderer mRenderer;
private final Function<Picture, Boolean> mCallback;
private final Executor mExecutor;
private final ReentrantLock mLock = new ReentrantLock(false);
private final ArrayDeque<Picture> mQueue = new ArrayDeque<>(3);
private boolean mStopListening;
private Thread mRenderThread;
private PictureCallbackHandler(HardwareRenderer renderer,
Function<Picture, Boolean> callback, Executor executor) {
mRenderer = renderer;
mCallback = callback;
mExecutor = executor;
mRenderer.setPictureCaptureCallback(this);
}
@Override
public void close() {
mLock.lock();
mStopListening = true;
mLock.unlock();
mRenderer.setPictureCaptureCallback(null);
}
@Override
public void onPictureCaptured(Picture picture) {
mLock.lock();
if (mStopListening) {
mLock.unlock();
mRenderer.setPictureCaptureCallback(null);
return;
}
if (mRenderThread == null) {
mRenderThread = Thread.currentThread();
}
Picture toDestroy = null;
if (mQueue.size() == 3) {
toDestroy = mQueue.removeLast();
}
mQueue.add(picture);
mLock.unlock();
if (toDestroy == null) {
mExecutor.execute(this);
} else {
toDestroy.close();
}
}
@Override
public void run() {
mLock.lock();
final Picture picture = mQueue.poll();
final boolean isStopped = mStopListening;
mLock.unlock();
if (Thread.currentThread() == mRenderThread) {
close();
throw new IllegalStateException(
"ViewDebug#startRenderingCommandsCapture must be given an executor that "
+ "invokes asynchronously");
}
if (isStopped) {
picture.close();
return;
}
final boolean keepReceiving = mCallback.apply(picture);
if (!keepReceiving) {
close();
}
}
}
/**
* Begins capturing the entire rendering commands for the view tree referenced by the given
* view. The view passed may be any View in the tree as long as it is attached. That is,
* {@link View#isAttachedToWindow()} must be true.
*
* Every time a frame is rendered a Picture will be passed to the given callback via the given
* executor. As long as the callback returns 'true' it will continue to receive new frames.
* The system will only invoke the callback at a rate that the callback is able to keep up with.
* That is, if it takes 48ms for the callback to complete and there is a 60fps animation running
* then the callback will only receive 33% of the frames produced.
*
* This method must be called on the same thread as the View tree.
*
* @param tree The View tree to capture the rendering commands.
* @param callback The callback to invoke on every frame produced. Should return true to
* continue receiving new frames, false to stop capturing.
* @param executor The executor to invoke the callback on. Recommend using a background thread
* to avoid stalling the UI thread. Must be an asynchronous invoke or an
* exception will be thrown.
* @return a closeable that can be used to stop capturing. May be invoked on any thread. Note
* that the callback may continue to receive another frame or two depending on thread timings.
* Returns null if the capture stream cannot be started, such as if there's no
* HardwareRenderer for the given view tree.
* @hide
* @deprecated use {@link #startRenderingCommandsCapture(View, Executor, Callable)} instead.
*/
@TestApi
@Nullable
@Deprecated
public static AutoCloseable startRenderingCommandsCapture(View tree, Executor executor,
Function<Picture, Boolean> callback) {
final View.AttachInfo attachInfo = tree.mAttachInfo;
if (attachInfo == null) {
throw new IllegalArgumentException("Given view isn't attached");
}
if (attachInfo.mHandler.getLooper() != Looper.myLooper()) {
throw new IllegalStateException("Called on the wrong thread."
+ " Must be called on the thread that owns the given View");
}
final HardwareRenderer renderer = attachInfo.mThreadedRenderer;
if (renderer != null) {
return new PictureCallbackHandler(renderer, callback, executor);
}
return null;
}
private static class StreamingPictureCallbackHandler implements AutoCloseable,
HardwareRenderer.PictureCapturedCallback, Runnable {
private final HardwareRenderer mRenderer;
private final Callable<OutputStream> mCallback;
private final Executor mExecutor;
private final ReentrantLock mLock = new ReentrantLock(false);
private final ArrayDeque<byte[]> mQueue = new ArrayDeque<>(3);
private final ByteArrayOutputStream mByteStream = new ByteArrayOutputStream();
private boolean mStopListening;
private Thread mRenderThread;
private StreamingPictureCallbackHandler(HardwareRenderer renderer,
Callable<OutputStream> callback, Executor executor) {
mRenderer = renderer;
mCallback = callback;
mExecutor = executor;
mRenderer.setPictureCaptureCallback(this);
}
@Override
public void close() {
mLock.lock();
mStopListening = true;
mLock.unlock();
mRenderer.setPictureCaptureCallback(null);
}
@Override
public void onPictureCaptured(Picture picture) {
mLock.lock();
if (mStopListening) {
mLock.unlock();
mRenderer.setPictureCaptureCallback(null);
return;
}
if (mRenderThread == null) {
mRenderThread = Thread.currentThread();
}
boolean needsInvoke = true;
if (mQueue.size() == 3) {
mQueue.removeLast();
needsInvoke = false;
}
picture.writeToStream(mByteStream);
mQueue.add(mByteStream.toByteArray());
mByteStream.reset();
mLock.unlock();
if (needsInvoke) {
mExecutor.execute(this);
}
}
@Override
public void run() {
mLock.lock();
final byte[] picture = mQueue.poll();
final boolean isStopped = mStopListening;
mLock.unlock();
if (Thread.currentThread() == mRenderThread) {
close();
throw new IllegalStateException(
"ViewDebug#startRenderingCommandsCapture must be given an executor that "
+ "invokes asynchronously");
}
if (isStopped) {
return;
}
OutputStream stream = null;
try {
stream = mCallback.call();
} catch (Exception ex) {
Log.w("ViewDebug", "Aborting rendering commands capture "
+ "because callback threw exception", ex);
}
if (stream != null) {
try {
stream.write(picture);
} catch (IOException ex) {
Log.w("ViewDebug", "Aborting rendering commands capture "
+ "due to IOException writing to output stream", ex);
}
} else {
close();
}
}
}
/**
* Begins capturing the entire rendering commands for the view tree referenced by the given
* view. The view passed may be any View in the tree as long as it is attached. That is,
* {@link View#isAttachedToWindow()} must be true.
*
* Every time a frame is rendered the callback will be invoked on the given executor to
* provide an OutputStream to serialize to. As long as the callback returns a valid
* OutputStream the capturing will continue. The system will only invoke the callback at a rate
* that the callback & OutputStream is able to keep up with. That is, if it takes 48ms for the
* callback & serialization to complete and there is a 60fps animation running
* then the callback will only receive 33% of the frames produced.
*
* This method must be called on the same thread as the View tree.
*
* @param tree The View tree to capture the rendering commands.
* @param callback The callback to invoke on every frame produced. Should return an
* OutputStream to write the data to. Return null to cancel capture. The
* same stream may be returned each time as the serialized data contains
* start & end markers. The callback will not be invoked while a previous
* serialization is being performed, so if a single continuous stream is being
* used it is valid for the callback to write its own metadata to that stream
* in response to callback invocation.
* @param executor The executor to invoke the callback on. Recommend using a background thread
* to avoid stalling the UI thread. Must be an asynchronous invoke or an
* exception will be thrown.
* @return a closeable that can be used to stop capturing. May be invoked on any thread. Note
* that the callback may continue to receive another frame or two depending on thread timings.
* Returns null if the capture stream cannot be started, such as if there's no
* HardwareRenderer for the given view tree.
* @hide
*/
@TestApi
@Nullable
public static AutoCloseable startRenderingCommandsCapture(View tree, Executor executor,
Callable<OutputStream> callback) {
final View.AttachInfo attachInfo = tree.mAttachInfo;
if (attachInfo == null) {
throw new IllegalArgumentException("Given view isn't attached");
}
if (attachInfo.mHandler.getLooper() != Looper.myLooper()) {
throw new IllegalStateException("Called on the wrong thread."
+ " Must be called on the thread that owns the given View");
}
final HardwareRenderer renderer = attachInfo.mThreadedRenderer;
if (renderer != null) {
return new StreamingPictureCallbackHandler(renderer, callback, executor);
}
return null;
}
private static void capture(View root, final OutputStream clientStream, String parameter)
throws IOException {
final View captureView = findView(root, parameter);
capture(root, clientStream, captureView);
}
/** @hide */
public static void capture(View root, final OutputStream clientStream, View captureView)
throws IOException {
Bitmap b = performViewCapture(captureView, false);
if (b == null) {
Log.w("View", "Failed to create capture bitmap!");
// Send an empty one so that it doesn't get stuck waiting for
// something.
b = Bitmap.createBitmap(root.getResources().getDisplayMetrics(),
1, 1, Bitmap.Config.ARGB_8888);
}
BufferedOutputStream out = null;
try {
out = new BufferedOutputStream(clientStream, 32 * 1024);
b.compress(Bitmap.CompressFormat.PNG, 100, out);
out.flush();
} finally {
if (out != null) {
out.close();
}
b.recycle();
}
}
private static Bitmap performViewCapture(final View captureView, final boolean skipChildren) {
if (captureView != null) {
final CountDownLatch latch = new CountDownLatch(1);
final Bitmap[] cache = new Bitmap[1];
captureView.post(() -> {
try {
CanvasProvider provider = captureView.isHardwareAccelerated()
? new HardwareCanvasProvider() : new SoftwareCanvasProvider();
cache[0] = captureView.createSnapshot(provider, skipChildren);
} catch (OutOfMemoryError e) {
Log.w("View", "Out of memory for bitmap");
} finally {
latch.countDown();
}
});
try {
latch.await(CAPTURE_TIMEOUT, TimeUnit.MILLISECONDS);
return cache[0];
} catch (InterruptedException e) {
Log.w("View", "Could not complete the capture of the view " + captureView);
Thread.currentThread().interrupt();
}
}
return null;
}
/**
* Dumps the view hierarchy starting from the given view.
* @deprecated See {@link #dumpv2(View, ByteArrayOutputStream)} below.
* @hide
*/
@Deprecated
@UnsupportedAppUsage
public static void dump(View root, boolean skipChildren, boolean includeProperties,
OutputStream clientStream) throws IOException {
BufferedWriter out = null;
try {
out = new BufferedWriter(new OutputStreamWriter(clientStream, "utf-8"), 32 * 1024);
View view = root.getRootView();
if (view instanceof ViewGroup) {
ViewGroup group = (ViewGroup) view;
dumpViewHierarchy(group.getContext(), group, out, 0,
skipChildren, includeProperties);
}
out.write("DONE.");
out.newLine();
} catch (Exception e) {
android.util.Log.w("View", "Problem dumping the view:", e);
} finally {
if (out != null) {
out.close();
}
}
}
/**
* Dumps the view hierarchy starting from the given view.
* Rather than using reflection, it uses View's encode method to obtain all the properties.
* @hide
*/
public static void dumpv2(@NonNull final View view, @NonNull ByteArrayOutputStream out)
throws InterruptedException {
final ViewHierarchyEncoder encoder = new ViewHierarchyEncoder(out);
final CountDownLatch latch = new CountDownLatch(1);
view.post(new Runnable() {
@Override
public void run() {
encoder.addProperty("window:left", view.mAttachInfo.mWindowLeft);
encoder.addProperty("window:top", view.mAttachInfo.mWindowTop);
view.encode(encoder);
latch.countDown();
}
});
latch.await(2, TimeUnit.SECONDS);
encoder.endStream();
}
/**
* Dumps the theme attributes from the given View.
* @hide
*/
public static void dumpTheme(View view, OutputStream clientStream) throws IOException {
BufferedWriter out = null;
try {
out = new BufferedWriter(new OutputStreamWriter(clientStream, "utf-8"), 32 * 1024);
String[] attributes = getStyleAttributesDump(view.getContext().getResources(),
view.getContext().getTheme());
if (attributes != null) {
for (int i = 0; i < attributes.length; i += 2) {
if (attributes[i] != null) {
out.write(attributes[i] + "\n");
out.write(attributes[i + 1] + "\n");
}
}
}
out.write("DONE.");
out.newLine();
} catch (Exception e) {
android.util.Log.w("View", "Problem dumping View Theme:", e);
} finally {
if (out != null) {
out.close();
}
}
}
/**
* Gets the style attributes from the {@link Resources.Theme}. For debugging only.
*
* @param resources Resources to resolve attributes from.
* @param theme Theme to dump.
* @return a String array containing pairs of adjacent Theme attribute data: name followed by
* its value.
*
* @hide
*/
private static String[] getStyleAttributesDump(Resources resources, Resources.Theme theme) {
TypedValue outValue = new TypedValue();
String nullString = "null";
int i = 0;
int[] attributes = theme.getAllAttributes();
String[] data = new String[attributes.length * 2];
for (int attributeId : attributes) {
try {
data[i] = resources.getResourceName(attributeId);
data[i + 1] = theme.resolveAttribute(attributeId, outValue, true) ?
outValue.coerceToString().toString() : nullString;
i += 2;
// attempt to replace reference data with its name
if (outValue.type == TypedValue.TYPE_REFERENCE) {
data[i - 1] = resources.getResourceName(outValue.resourceId);
}
} catch (Resources.NotFoundException e) {
// ignore resources we can't resolve
}
}
return data;
}
private static View findView(ViewGroup group, String className, int hashCode) {
if (isRequestedView(group, className, hashCode)) {
return group;
}
final int count = group.getChildCount();
for (int i = 0; i < count; i++) {
final View view = group.getChildAt(i);
if (view instanceof ViewGroup) {
final View found = findView((ViewGroup) view, className, hashCode);
if (found != null) {
return found;
}
} else if (isRequestedView(view, className, hashCode)) {
return view;
}
if (view.mOverlay != null) {
final View found = findView((ViewGroup) view.mOverlay.mOverlayViewGroup,
className, hashCode);
if (found != null) {
return found;
}
}
if (view instanceof HierarchyHandler) {
final View found = ((HierarchyHandler)view)
.findHierarchyView(className, hashCode);
if (found != null) {
return found;
}
}
}
return null;
}
private static boolean isRequestedView(View view, String className, int hashCode) {
if (view.hashCode() == hashCode) {
String viewClassName = view.getClass().getName();
if (className.equals("ViewOverlay")) {
return viewClassName.equals("android.view.ViewOverlay$OverlayViewGroup");
} else {
return className.equals(viewClassName);
}
}
return false;
}
private static void dumpViewHierarchy(Context context, ViewGroup group,
BufferedWriter out, int level, boolean skipChildren, boolean includeProperties) {
if (!dumpView(context, group, out, level, includeProperties)) {
return;
}
if (skipChildren) {
return;
}
final int count = group.getChildCount();
for (int i = 0; i < count; i++) {
final View view = group.getChildAt(i);
if (view instanceof ViewGroup) {
dumpViewHierarchy(context, (ViewGroup) view, out, level + 1, skipChildren,
includeProperties);
} else {
dumpView(context, view, out, level + 1, includeProperties);
}
if (view.mOverlay != null) {
ViewOverlay overlay = view.getOverlay();
ViewGroup overlayContainer = overlay.mOverlayViewGroup;
dumpViewHierarchy(context, overlayContainer, out, level + 2, skipChildren,
includeProperties);
}
}
if (group instanceof HierarchyHandler) {
((HierarchyHandler)group).dumpViewHierarchyWithProperties(out, level + 1);
}
}
private static boolean dumpView(Context context, View view,
BufferedWriter out, int level, boolean includeProperties) {
try {
for (int i = 0; i < level; i++) {
out.write(' ');
}
String className = view.getClass().getName();
if (className.equals("android.view.ViewOverlay$OverlayViewGroup")) {
className = "ViewOverlay";
}
out.write(className);
out.write('@');
out.write(Integer.toHexString(view.hashCode()));
out.write(' ');
if (includeProperties) {
dumpViewProperties(context, view, out);
}
out.newLine();
} catch (IOException e) {
Log.w("View", "Error while dumping hierarchy tree");
return false;
}
return true;
}
private static Field[] getExportedPropertyFields(Class<?> klass) {
if (sFieldsForClasses == null) {
sFieldsForClasses = new HashMap<Class<?>, Field[]>();
}
if (sAnnotations == null) {
sAnnotations = new HashMap<AccessibleObject, ExportedProperty>(512);
}
final HashMap<Class<?>, Field[]> map = sFieldsForClasses;
Field[] fields = map.get(klass);
if (fields != null) {
return fields;
}
try {
final Field[] declaredFields = klass.getDeclaredFieldsUnchecked(false);
final ArrayList<Field> foundFields = new ArrayList<Field>();
for (final Field field : declaredFields) {
// Fields which can't be resolved have a null type.
if (field.getType() != null && field.isAnnotationPresent(ExportedProperty.class)) {
field.setAccessible(true);
foundFields.add(field);
sAnnotations.put(field, field.getAnnotation(ExportedProperty.class));
}
}
fields = foundFields.toArray(new Field[foundFields.size()]);
map.put(klass, fields);
} catch (NoClassDefFoundError e) {
throw new AssertionError(e);
}
return fields;
}
private static Method[] getExportedPropertyMethods(Class<?> klass) {
if (sMethodsForClasses == null) {
sMethodsForClasses = new HashMap<Class<?>, Method[]>(100);
}
if (sAnnotations == null) {
sAnnotations = new HashMap<AccessibleObject, ExportedProperty>(512);
}
final HashMap<Class<?>, Method[]> map = sMethodsForClasses;
Method[] methods = map.get(klass);
if (methods != null) {
return methods;
}
methods = klass.getDeclaredMethodsUnchecked(false);
final ArrayList<Method> foundMethods = new ArrayList<Method>();
for (final Method method : methods) {
// Ensure the method return and parameter types can be resolved.
try {
method.getReturnType();
method.getParameterTypes();
} catch (NoClassDefFoundError e) {
continue;
}
if (method.getParameterTypes().length == 0 &&
method.isAnnotationPresent(ExportedProperty.class) &&
method.getReturnType() != Void.class) {
method.setAccessible(true);
foundMethods.add(method);
sAnnotations.put(method, method.getAnnotation(ExportedProperty.class));
}
}
methods = foundMethods.toArray(new Method[foundMethods.size()]);
map.put(klass, methods);
return methods;
}
private static void dumpViewProperties(Context context, Object view,
BufferedWriter out) throws IOException {
dumpViewProperties(context, view, out, "");
}
private static void dumpViewProperties(Context context, Object view,
BufferedWriter out, String prefix) throws IOException {
if (view == null) {
out.write(prefix + "=4,null ");
return;
}
Class<?> klass = view.getClass();
do {
exportFields(context, view, out, klass, prefix);
exportMethods(context, view, out, klass, prefix);
klass = klass.getSuperclass();
} while (klass != Object.class);
}
private static Object callMethodOnAppropriateTheadBlocking(final Method method,
final Object object) throws IllegalAccessException, InvocationTargetException,
TimeoutException {
if (!(object instanceof View)) {
return method.invoke(object, (Object[]) null);
}
final View view = (View) object;
Callable<Object> callable = new Callable<Object>() {
@Override
public Object call() throws IllegalAccessException, InvocationTargetException {
return method.invoke(view, (Object[]) null);
}
};
FutureTask<Object> future = new FutureTask<Object>(callable);
// Try to use the handler provided by the view
Handler handler = view.getHandler();
// Fall back on using the main thread
if (handler == null) {
handler = new Handler(android.os.Looper.getMainLooper());
}
handler.post(future);
while (true) {
try {
return future.get(CAPTURE_TIMEOUT, java.util.concurrent.TimeUnit.MILLISECONDS);
} catch (ExecutionException e) {
Throwable t = e.getCause();
if (t instanceof IllegalAccessException) {
throw (IllegalAccessException)t;
}
if (t instanceof InvocationTargetException) {
throw (InvocationTargetException)t;
}
throw new RuntimeException("Unexpected exception", t);
} catch (InterruptedException e) {
// Call get again
} catch (CancellationException e) {
throw new RuntimeException("Unexpected cancellation exception", e);
}
}
}
private static String formatIntToHexString(int value) {
return "0x" + Integer.toHexString(value).toUpperCase();
}
private static void exportMethods(Context context, Object view, BufferedWriter out,
Class<?> klass, String prefix) throws IOException {
final Method[] methods = getExportedPropertyMethods(klass);
int count = methods.length;
for (int i = 0; i < count; i++) {
final Method method = methods[i];
//noinspection EmptyCatchBlock
try {
Object methodValue = callMethodOnAppropriateTheadBlocking(method, view);
final Class<?> returnType = method.getReturnType();
final ExportedProperty property = sAnnotations.get(method);
String categoryPrefix =
property.category().length() != 0 ? property.category() + ":" : "";
if (returnType == int.class) {
if (property.resolveId() && context != null) {
final int id = (Integer) methodValue;
methodValue = resolveId(context, id);
} else {
final FlagToString[] flagsMapping = property.flagMapping();
if (flagsMapping.length > 0) {
final int intValue = (Integer) methodValue;
final String valuePrefix =
categoryPrefix + prefix + method.getName() + '_';
exportUnrolledFlags(out, flagsMapping, intValue, valuePrefix);
}
final IntToString[] mapping = property.mapping();
if (mapping.length > 0) {
final int intValue = (Integer) methodValue;
boolean mapped = false;
int mappingCount = mapping.length;
for (int j = 0; j < mappingCount; j++) {
final IntToString mapper = mapping[j];
if (mapper.from() == intValue) {
methodValue = mapper.to();
mapped = true;
break;
}
}
if (!mapped) {
methodValue = intValue;
}
}
}
} else if (returnType == int[].class) {
final int[] array = (int[]) methodValue;
final String valuePrefix = categoryPrefix + prefix + method.getName() + '_';
final String suffix = "()";
exportUnrolledArray(context, out, property, array, valuePrefix, suffix);
continue;
} else if (returnType == String[].class) {
final String[] array = (String[]) methodValue;
if (property.hasAdjacentMapping() && array != null) {
for (int j = 0; j < array.length; j += 2) {
if (array[j] != null) {
writeEntry(out, categoryPrefix + prefix, array[j], "()",
array[j + 1] == null ? "null" : array[j + 1]);
}
}
}
continue;
} else if (!returnType.isPrimitive()) {
if (property.deepExport()) {
dumpViewProperties(context, methodValue, out, prefix + property.prefix());
continue;
}
}
writeEntry(out, categoryPrefix + prefix, method.getName(), "()", methodValue);
} catch (IllegalAccessException e) {
} catch (InvocationTargetException e) {
} catch (TimeoutException e) {
}
}
}
private static void exportFields(Context context, Object view, BufferedWriter out,
Class<?> klass, String prefix) throws IOException {
final Field[] fields = getExportedPropertyFields(klass);
int count = fields.length;
for (int i = 0; i < count; i++) {
final Field field = fields[i];
//noinspection EmptyCatchBlock
try {
Object fieldValue = null;
final Class<?> type = field.getType();
final ExportedProperty property = sAnnotations.get(field);
String categoryPrefix =
property.category().length() != 0 ? property.category() + ":" : "";
if (type == int.class || type == byte.class) {
if (property.resolveId() && context != null) {
final int id = field.getInt(view);
fieldValue = resolveId(context, id);
} else {
final FlagToString[] flagsMapping = property.flagMapping();
if (flagsMapping.length > 0) {
final int intValue = field.getInt(view);
final String valuePrefix =
categoryPrefix + prefix + field.getName() + '_';
exportUnrolledFlags(out, flagsMapping, intValue, valuePrefix);
}
final IntToString[] mapping = property.mapping();
if (mapping.length > 0) {
final int intValue = field.getInt(view);
int mappingCount = mapping.length;
for (int j = 0; j < mappingCount; j++) {
final IntToString mapped = mapping[j];
if (mapped.from() == intValue) {
fieldValue = mapped.to();
break;
}
}
if (fieldValue == null) {
fieldValue = intValue;
}
}
if (property.formatToHexString()) {
fieldValue = field.get(view);
if (type == int.class) {
fieldValue = formatIntToHexString((Integer) fieldValue);
} else if (type == byte.class) {
fieldValue = "0x" + Byte.toHexString((Byte) fieldValue, true);
}
}
}
} else if (type == int[].class) {
final int[] array = (int[]) field.get(view);
final String valuePrefix = categoryPrefix + prefix + field.getName() + '_';
final String suffix = "";
exportUnrolledArray(context, out, property, array, valuePrefix, suffix);
continue;
} else if (type == String[].class) {
final String[] array = (String[]) field.get(view);
if (property.hasAdjacentMapping() && array != null) {
for (int j = 0; j < array.length; j += 2) {
if (array[j] != null) {
writeEntry(out, categoryPrefix + prefix, array[j], "",
array[j + 1] == null ? "null" : array[j + 1]);
}
}
}
continue;
} else if (!type.isPrimitive()) {
if (property.deepExport()) {
dumpViewProperties(context, field.get(view), out, prefix +
property.prefix());
continue;
}
}
if (fieldValue == null) {
fieldValue = field.get(view);
}
writeEntry(out, categoryPrefix + prefix, field.getName(), "", fieldValue);
} catch (IllegalAccessException e) {
}
}
}
private static void writeEntry(BufferedWriter out, String prefix, String name,
String suffix, Object value) throws IOException {
out.write(prefix);
out.write(name);
out.write(suffix);
out.write("=");
writeValue(out, value);
out.write(' ');
}
private static void exportUnrolledFlags(BufferedWriter out, FlagToString[] mapping,
int intValue, String prefix) throws IOException {
final int count = mapping.length;
for (int j = 0; j < count; j++) {
final FlagToString flagMapping = mapping[j];
final boolean ifTrue = flagMapping.outputIf();
final int maskResult = intValue & flagMapping.mask();
final boolean test = maskResult == flagMapping.equals();
if ((test && ifTrue) || (!test && !ifTrue)) {
final String name = flagMapping.name();
final String value = formatIntToHexString(maskResult);
writeEntry(out, prefix, name, "", value);
}
}
}
/**
* Converts an integer from a field that is mapped with {@link IntToString} to its string
* representation.
*
* @param clazz The class the field is defined on.
* @param field The field on which the {@link ExportedProperty} is defined on.
* @param integer The value to convert.
* @return The value converted into its string representation.
* @hide
*/
public static String intToString(Class<?> clazz, String field, int integer) {
final IntToString[] mapping = getMapping(clazz, field);
if (mapping == null) {
return Integer.toString(integer);
}
final int count = mapping.length;
for (int j = 0; j < count; j++) {
final IntToString map = mapping[j];
if (map.from() == integer) {
return map.to();
}
}
return Integer.toString(integer);
}
/**
* Converts a set of flags from a field that is mapped with {@link FlagToString} to its string
* representation.
*
* @param clazz The class the field is defined on.
* @param field The field on which the {@link ExportedProperty} is defined on.
* @param flags The flags to convert.
* @return The flags converted into their string representations.
* @hide
*/
public static String flagsToString(Class<?> clazz, String field, int flags) {
final FlagToString[] mapping = getFlagMapping(clazz, field);
if (mapping == null) {
return Integer.toHexString(flags);
}
final StringBuilder result = new StringBuilder();
final int count = mapping.length;
for (int j = 0; j < count; j++) {
final FlagToString flagMapping = mapping[j];
final boolean ifTrue = flagMapping.outputIf();
final int maskResult = flags & flagMapping.mask();
final boolean test = maskResult == flagMapping.equals();
if (test && ifTrue) {
final String name = flagMapping.name();
result.append(name).append(' ');
}
}
if (result.length() > 0) {
result.deleteCharAt(result.length() - 1);
}
return result.toString();
}
private static FlagToString[] getFlagMapping(Class<?> clazz, String field) {
try {
return clazz.getDeclaredField(field).getAnnotation(ExportedProperty.class)
.flagMapping();
} catch (NoSuchFieldException e) {
return null;
}
}
private static IntToString[] getMapping(Class<?> clazz, String field) {
try {
return clazz.getDeclaredField(field).getAnnotation(ExportedProperty.class).mapping();
} catch (NoSuchFieldException e) {
return null;
}
}
private static void exportUnrolledArray(Context context, BufferedWriter out,
ExportedProperty property, int[] array, String prefix, String suffix)
throws IOException {
final IntToString[] indexMapping = property.indexMapping();
final boolean hasIndexMapping = indexMapping.length > 0;
final IntToString[] mapping = property.mapping();
final boolean hasMapping = mapping.length > 0;
final boolean resolveId = property.resolveId() && context != null;
final int valuesCount = array.length;
for (int j = 0; j < valuesCount; j++) {
String name;
String value = null;
final int intValue = array[j];
name = String.valueOf(j);
if (hasIndexMapping) {
int mappingCount = indexMapping.length;
for (int k = 0; k < mappingCount; k++) {
final IntToString mapped = indexMapping[k];
if (mapped.from() == j) {
name = mapped.to();
break;
}
}
}
if (hasMapping) {
int mappingCount = mapping.length;
for (int k = 0; k < mappingCount; k++) {
final IntToString mapped = mapping[k];
if (mapped.from() == intValue) {
value = mapped.to();
break;
}
}
}
if (resolveId) {
if (value == null) value = (String) resolveId(context, intValue);
} else {
value = String.valueOf(intValue);
}
writeEntry(out, prefix, name, suffix, value);
}
}
static Object resolveId(Context context, int id) {
Object fieldValue;
final Resources resources = context.getResources();
if (id >= 0) {
try {
fieldValue = resources.getResourceTypeName(id) + '/' +
resources.getResourceEntryName(id);
} catch (Resources.NotFoundException e) {
fieldValue = "id/" + formatIntToHexString(id);
}
} else {
fieldValue = "NO_ID";
}
return fieldValue;
}
private static void writeValue(BufferedWriter out, Object value) throws IOException {
if (value != null) {
String output = "[EXCEPTION]";
try {
output = value.toString().replace("\n", "\\n");
} finally {
out.write(String.valueOf(output.length()));
out.write(",");
out.write(output);
}
} else {
out.write("4,null");
}
}
private static Field[] capturedViewGetPropertyFields(Class<?> klass) {
if (mCapturedViewFieldsForClasses == null) {
mCapturedViewFieldsForClasses = new HashMap<Class<?>, Field[]>();
}
final HashMap<Class<?>, Field[]> map = mCapturedViewFieldsForClasses;
Field[] fields = map.get(klass);
if (fields != null) {
return fields;
}
final ArrayList<Field> foundFields = new ArrayList<Field>();
fields = klass.getFields();
int count = fields.length;
for (int i = 0; i < count; i++) {
final Field field = fields[i];
if (field.isAnnotationPresent(CapturedViewProperty.class)) {
field.setAccessible(true);
foundFields.add(field);
}
}
fields = foundFields.toArray(new Field[foundFields.size()]);
map.put(klass, fields);
return fields;
}
private static Method[] capturedViewGetPropertyMethods(Class<?> klass) {
if (mCapturedViewMethodsForClasses == null) {
mCapturedViewMethodsForClasses = new HashMap<Class<?>, Method[]>();
}
final HashMap<Class<?>, Method[]> map = mCapturedViewMethodsForClasses;
Method[] methods = map.get(klass);
if (methods != null) {
return methods;
}
final ArrayList<Method> foundMethods = new ArrayList<Method>();
methods = klass.getMethods();
int count = methods.length;
for (int i = 0; i < count; i++) {
final Method method = methods[i];
if (method.getParameterTypes().length == 0 &&
method.isAnnotationPresent(CapturedViewProperty.class) &&
method.getReturnType() != Void.class) {
method.setAccessible(true);
foundMethods.add(method);
}
}
methods = foundMethods.toArray(new Method[foundMethods.size()]);
map.put(klass, methods);
return methods;
}
private static String capturedViewExportMethods(Object obj, Class<?> klass,
String prefix) {
if (obj == null) {
return "null";
}
StringBuilder sb = new StringBuilder();
final Method[] methods = capturedViewGetPropertyMethods(klass);
int count = methods.length;
for (int i = 0; i < count; i++) {
final Method method = methods[i];
try {
Object methodValue = method.invoke(obj, (Object[]) null);
final Class<?> returnType = method.getReturnType();
CapturedViewProperty property = method.getAnnotation(CapturedViewProperty.class);
if (property.retrieveReturn()) {
//we are interested in the second level data only
sb.append(capturedViewExportMethods(methodValue, returnType, method.getName() + "#"));
} else {
sb.append(prefix);
sb.append(method.getName());
sb.append("()=");
if (methodValue != null) {
final String value = methodValue.toString().replace("\n", "\\n");
sb.append(value);
} else {
sb.append("null");
}
sb.append("; ");
}
} catch (IllegalAccessException e) {
//Exception IllegalAccess, it is OK here
//we simply ignore this method
} catch (InvocationTargetException e) {
//Exception InvocationTarget, it is OK here
//we simply ignore this method
}
}
return sb.toString();
}
private static String capturedViewExportFields(Object obj, Class<?> klass, String prefix) {
if (obj == null) {
return "null";
}
StringBuilder sb = new StringBuilder();
final Field[] fields = capturedViewGetPropertyFields(klass);
int count = fields.length;
for (int i = 0; i < count; i++) {
final Field field = fields[i];
try {
Object fieldValue = field.get(obj);
sb.append(prefix);
sb.append(field.getName());
sb.append("=");
if (fieldValue != null) {
final String value = fieldValue.toString().replace("\n", "\\n");
sb.append(value);
} else {
sb.append("null");
}
sb.append(' ');
} catch (IllegalAccessException e) {
//Exception IllegalAccess, it is OK here
//we simply ignore this field
}
}
return sb.toString();
}
/**
* Dump view info for id based instrument test generation
* (and possibly further data analysis). The results are dumped
* to the log.
* @param tag for log
* @param view for dump
*/
public static void dumpCapturedView(String tag, Object view) {
Class<?> klass = view.getClass();
StringBuilder sb = new StringBuilder(klass.getName() + ": ");
sb.append(capturedViewExportFields(view, klass, ""));
sb.append(capturedViewExportMethods(view, klass, ""));
Log.d(tag, sb.toString());
}
/**
* Invoke a particular method on given view.
* The given method is always invoked on the UI thread. The caller thread will stall until the
* method invocation is complete. Returns an object equal to the result of the method
* invocation, null if the method is declared to return void
* @throws Exception if the method invocation caused any exception
* @hide
*/
public static Object invokeViewMethod(final View view, final Method method,
final Object[] args) {
final CountDownLatch latch = new CountDownLatch(1);
final AtomicReference<Object> result = new AtomicReference<Object>();
final AtomicReference<Throwable> exception = new AtomicReference<Throwable>();
view.post(new Runnable() {
@Override
public void run() {
try {
result.set(method.invoke(view, args));
} catch (InvocationTargetException e) {
exception.set(e.getCause());
} catch (Exception e) {
exception.set(e);
}
latch.countDown();
}
});
try {
latch.await();
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
if (exception.get() != null) {
throw new RuntimeException(exception.get());
}
return result.get();
}
/**
* @hide
*/
public static void setLayoutParameter(final View view, final String param, final int value)
throws NoSuchFieldException, IllegalAccessException {
final ViewGroup.LayoutParams p = view.getLayoutParams();
final Field f = p.getClass().getField(param);
if (f.getType() != int.class) {
throw new RuntimeException("Only integer layout parameters can be set. Field "
+ param + " is of type " + f.getType().getSimpleName());
}
f.set(p, Integer.valueOf(value));
view.post(new Runnable() {
@Override
public void run() {
view.setLayoutParams(p);
}
});
}
/**
* @hide
*/
public static class SoftwareCanvasProvider implements CanvasProvider {
private Canvas mCanvas;
private Bitmap mBitmap;
private boolean mEnabledHwBitmapsInSwMode;
@Override
public Canvas getCanvas(View view, int width, int height) {
mBitmap = Bitmap.createBitmap(view.getResources().getDisplayMetrics(),
width, height, Bitmap.Config.ARGB_8888);
if (mBitmap == null) {
throw new OutOfMemoryError();
}
mBitmap.setDensity(view.getResources().getDisplayMetrics().densityDpi);
if (view.mAttachInfo != null) {
mCanvas = view.mAttachInfo.mCanvas;
}
if (mCanvas == null) {
mCanvas = new Canvas();
}
mEnabledHwBitmapsInSwMode = mCanvas.isHwBitmapsInSwModeEnabled();
mCanvas.setBitmap(mBitmap);
return mCanvas;
}
@Override
public Bitmap createBitmap() {
mCanvas.setBitmap(null);
mCanvas.setHwBitmapsInSwModeEnabled(mEnabledHwBitmapsInSwMode);
return mBitmap;
}
}
/**
* @hide
*/
public static class HardwareCanvasProvider implements CanvasProvider {
private Picture mPicture;
@Override
public Canvas getCanvas(View view, int width, int height) {
mPicture = new Picture();
return mPicture.beginRecording(width, height);
}
@Override
public Bitmap createBitmap() {
mPicture.endRecording();
return Bitmap.createBitmap(mPicture);
}
}
/**
* @hide
*/
public interface CanvasProvider {
/**
* Returns a canvas which can be used to draw {@param view}
*/
Canvas getCanvas(View view, int width, int height);
/**
* Creates a bitmap from previously returned canvas
* @return
*/
Bitmap createBitmap();
}
}
|