1 /*****************************************************************************
2 * history.c: vlc_history_t (web-browser-like back/forward history) handling
3 *****************************************************************************
4 * Copyright (C) 2004 Commonwealth Scientific and Industrial Research
5 * Organisation (CSIRO) Australia
6 * Copyright (C) 2004 the VideoLAN team
10 * Authors: Andre Pang <Andre.Pang@csiro.au>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
34 # include <stdlib.h> /* realloc() */
39 /*****************************************************************************
41 *****************************************************************************/
42 static void history_Dump( history_t *p_history );
44 /*****************************************************************************
45 * Local structure lock
46 *****************************************************************************/
48 /*****************************************************************************
50 *****************************************************************************/
52 history_t *history_New( void )
54 history_t *p_new_history;
56 p_new_history = calloc( 1, sizeof( struct history_t ) );
57 if( p_new_history == NULL ) return NULL;
59 p_new_history->p_xarray = xarray_New( 0 );
60 if( p_new_history->p_xarray == NULL )
62 free( p_new_history );
67 /* make dummy reference to history_Dump to avoid compiler warnings */
79 vlc_bool_t history_GoBackSavingCurrentItem ( history_t *p_history,
80 history_item_t *p_item )
82 history_PruneAndInsert( p_history, p_item );
84 /* PruneAndInsert will increment the index, so we need to go
85 * back one position to reset the index to the place we were at
86 * before saving the current state, and then go back one more to
88 p_history->i_index -= 2;
91 history_Dump( p_history );
96 static void history_Dump( history_t *p_history )
101 if( xarray_Count( p_history->p_xarray, &i_count ) != XARRAY_SUCCESS )
104 for (i = 0; i < (int) i_count; i++)
106 history_item_t *p_item;
109 xarray_ObjectAtIndex( p_history->p_xarray, i, &pv_item );
111 p_item = (history_item_t *) pv_item;
114 fprintf( stderr, "HISTORY: [%d] NULL\n", i );
117 char *psz_uri = input_item_GetURI( p_item );
118 fprintf( stderr, "HISTORY: [%d] %p (%p->%s)\n", i, p_item,
125 vlc_bool_t history_GoForwardSavingCurrentItem ( history_t *p_history,
126 history_item_t *p_item )
129 history_Dump( p_history );
132 if( xarray_ReplaceObject( p_history->p_xarray, p_history->i_index, p_item )
135 p_history->i_index++;
144 vlc_bool_t history_CanGoBack( history_t *p_history )
146 if( p_history->i_index > 0 )
152 vlc_bool_t history_CanGoForward( history_t *p_history )
154 unsigned int i_count;
156 if( xarray_Count( p_history->p_xarray, &i_count ) != XARRAY_SUCCESS )
159 if( p_history->i_index < i_count )
165 history_item_t *history_Item( history_t *p_history )
167 history_item_t *p_item;
170 if( xarray_ObjectAtIndex( p_history->p_xarray, p_history->i_index,
174 p_item = (history_item_t *) pv_item;
183 void history_Prune( history_t *p_history )
185 xarray_RemoveObjectsAfter( p_history->p_xarray, p_history->i_index );
186 xarray_RemoveObject( p_history->p_xarray, p_history->i_index );
189 void history_PruneAndInsert( history_t *p_history, history_item_t *p_item )
191 unsigned int i_count;
193 xarray_Count( p_history->p_xarray, &i_count );
197 xarray_InsertObject( p_history->p_xarray, p_item, 0 );
198 p_history->i_index = 1;
202 history_Prune( p_history );
203 xarray_InsertObject( p_history->p_xarray, p_item, p_history->i_index );
204 p_history->i_index++;
208 unsigned int history_Count( history_t *p_history )
210 unsigned int i_count;
211 xarray_Count( p_history->p_xarray, &i_count );
215 unsigned int history_Index( history_t *p_history )
217 return p_history->i_index;
220 history_item_t * historyItem_New( char *psz_name, char *psz_uri )
222 history_item_t *p_history_item = NULL;
224 p_history_item = (history_item_t *) malloc( sizeof(history_item_t) );
225 if( !p_history_item ) return NULL;
227 p_history_item->psz_uri = strdup( psz_uri );
228 p_history_item->psz_name = strdup( psz_name );
230 return p_history_item;