19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 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.webkit; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.Serializable; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.ArrayList; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class contains the back/forward list for a WebView. 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WebView.copyBackForwardList() will return a copy of this class used to 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * inspect the entries in the list. 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class WebBackForwardList implements Cloneable, Serializable { 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Current position in the list. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mCurrentIndex; 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // ArrayList of WebHistoryItems for maintaining our copy. 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private ArrayList<WebHistoryItem> mArray; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Flag to indicate that the list is invalid 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mClearPending; 340b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott // CallbackProxy to issue client callbacks. 350b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott private final CallbackProxy mCallbackProxy; 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Construct a back/forward list used by clients of WebView. 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 400b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott /*package*/ WebBackForwardList(CallbackProxy proxy) { 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCurrentIndex = -1; 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mArray = new ArrayList<WebHistoryItem>(); 430b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott mCallbackProxy = proxy; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the current history item. This method returns null if the list is 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * empty. 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The current history item. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public synchronized WebHistoryItem getCurrentItem() { 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getItemAtIndex(mCurrentIndex); 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the index of the current history item. This index can be used to 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * directly index into the array list. 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The current index from 0...n or -1 if the list is empty. 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public synchronized int getCurrentIndex() { 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mCurrentIndex; 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the history item at the given index. The index range is from 0...n 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * where 0 is the first item and n is the last item. 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param index The index to retrieve. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public synchronized WebHistoryItem getItemAtIndex(int index) { 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (index < 0 || index >= getSize()) { 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mArray.get(index); 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the total size of the back/forward list. 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The size of the list. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public synchronized int getSize() { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mArray.size(); 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Mark the back/forward list as having a pending clear. This is used on the 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * UI side to mark the list as being invalid during the clearHistory method. 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ synchronized void setClearPending() { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mClearPending = true; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the status of the clear flag. This is used on the UI side to 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * determine if the list is valid for checking things like canGoBack. 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ synchronized boolean getClearPending() { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mClearPending; 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new history item to the list. This will remove all items after the 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * current item and append the new item to the end of the list. Called from 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the WebCore thread only. Synchronized because the UI thread may be 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reading the array or the current index. 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param item A new history item. 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ synchronized void addHistoryItem(WebHistoryItem item) { 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Update the current position because we are going to add the new item 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // in that slot. 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ++mCurrentIndex; 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // If the current position is not at the end, remove all history items 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // after the current item. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int size = mArray.size(); 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int newPos = mCurrentIndex; 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (newPos != size) { 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = size - 1; i >= newPos; i--) { 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final WebHistoryItem h = mArray.remove(i); 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Add the item to the list. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mArray.add(item); 1220b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott if (mCallbackProxy != null) { 1230b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott mCallbackProxy.onNewHistoryItem(item); 1240b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott } 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clear the back/forward list. Called from the WebCore thread. 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ synchronized void close(int nativeFrame) { 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Clear the array first because nativeClose will call addHistoryItem 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // with the current item. 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mArray.clear(); 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCurrentIndex = -1; 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeClose(nativeFrame); 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Reset the clear flag 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mClearPending = false; 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* Remove the item at the given index. Called by JNI only. */ 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private synchronized void removeHistoryItem(int index) { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // XXX: This is a special case. Since the callback is only triggered 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // when removing the first item, we can assert that the index is 0. 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // This lets us change the current index without having to query the 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // native BackForwardList. 1462e5c150e746647a1ce5c10e1708debbf06c45ea7Derek Sollenberger if (DebugFlags.WEB_BACK_FORWARD_LIST && (index != 0)) { 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new AssertionError(); 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final WebHistoryItem h = mArray.remove(index); 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // XXX: If we ever add another callback for removing history items at 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // any index, this will no longer be valid. 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCurrentIndex--; 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clone the entire object to be used in the UI thread by clients of 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WebView. This creates a copy that should never be modified by any of the 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * webkit package classes. 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected synchronized WebBackForwardList clone() { 1610b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott WebBackForwardList l = new WebBackForwardList(null); 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mClearPending) { 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // If a clear is pending, return a copy with only the current item. 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project l.addHistoryItem(getCurrentItem()); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return l; 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project l.mCurrentIndex = mCurrentIndex; 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int size = getSize(); 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project l.mArray = new ArrayList<WebHistoryItem>(size); 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < size; i++) { 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Add a copy of each WebHistoryItem 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project l.mArray.add(mArray.get(i).clone()); 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return l; 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set the new history index. 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param newIndex The new history index. 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ synchronized void setCurrentIndex(int newIndex) { 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mCurrentIndex = newIndex; 1830b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott if (mCallbackProxy != null) { 1840b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott mCallbackProxy.onIndexChanged(getItemAtIndex(newIndex), newIndex); 1850b2e84b32af48f4b2b17c72adcf12ad29ec7bb7aPatrick Scott } 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Restore the history index. 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /*package*/ static native synchronized void restoreIndex(int nativeFrame, 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int index); 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* Close the native list. */ 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeClose(int nativeFrame); 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 197