1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2003 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea@videolan.org>
8 * Clément Stenac <zorglub@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
26 #include "../utils/var_bool.hpp"
27 #include "ctrl_tree.hpp"
28 #include "../src/os_factory.hpp"
29 #include "../src/os_graphics.hpp"
30 #include "../src/generic_bitmap.hpp"
31 #include "../src/generic_font.hpp"
32 #include "../src/scaled_bitmap.hpp"
33 #include "../utils/position.hpp"
34 #include "../utils/ustring.hpp"
35 #include "../events/evt_key.hpp"
36 #include "../events/evt_mouse.hpp"
37 #include "../events/evt_scroll.hpp"
40 # include "solaris_specific.h" // for lrint
43 #define SCROLL_STEP 0.05
44 #define LINE_INTERVAL 1 // Number of pixels inserted between 2 lines
47 CtrlTree::CtrlTree( intf_thread_t *pIntf,
49 const GenericFont &rFont,
50 const GenericBitmap *pBgBitmap,
51 const GenericBitmap *pItemBitmap,
52 const GenericBitmap *pOpenBitmap,
53 const GenericBitmap *pClosedBitmap,
62 CtrlGeneric( pIntf,rHelp, pVisible), m_rTree( rTree), m_rFont( rFont ),
63 m_pBgBitmap( pBgBitmap ), m_pItemBitmap( pItemBitmap ),
64 m_pOpenBitmap( pOpenBitmap ), m_pClosedBitmap( pClosedBitmap ),
65 m_fgColor( fgColor ), m_playColor( playColor ), m_bgColor1( bgColor1 ),
66 m_bgColor2( bgColor2 ), m_selColor( selColor ),
67 m_pLastSelected( NULL ), m_pImage( NULL ), m_dontMove( false )
69 // Observe the tree and position variables
70 m_rTree.addObserver( this );
71 m_rTree.getPositionVar().addObserver( this );
73 m_flat = pFlat->get();
75 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
82 m_rTree.getPositionVar().delObserver( this );
83 m_rTree.delObserver( this );
90 int CtrlTree::itemHeight()
92 int itemHeight = m_rFont.getSize();
97 itemHeight = __MAX( m_pClosedBitmap->getHeight(), itemHeight );
101 itemHeight = __MAX( m_pOpenBitmap->getHeight(), itemHeight );
106 itemHeight = __MAX( m_pItemBitmap->getHeight(), itemHeight );
108 itemHeight += LINE_INTERVAL;
112 int CtrlTree::itemImageWidth()
117 if( m_pClosedBitmap )
119 bitmapWidth = __MAX( m_pClosedBitmap->getWidth(), bitmapWidth );
123 bitmapWidth = __MAX( m_pOpenBitmap->getWidth(), bitmapWidth );
128 bitmapWidth = __MAX( m_pItemBitmap->getWidth(), bitmapWidth );
130 return bitmapWidth + 2;
133 int CtrlTree::maxItems()
135 const Position *pPos = getPosition();
140 return pPos->getHeight() / itemHeight();
144 void CtrlTree::onUpdate( Subject<VarTree, tree_update> &rTree,
147 if( arg->i_type == 0 ) // Item update
149 if( arg->b_active_item )
152 ///\todo We should make image if we are visible in the view
156 /// \todo handle delete in a more clever way
157 else if ( arg->i_type == 1 ) // Global change or deletion
159 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
162 else if ( arg->i_type == 2 ) // Item-append
164 if( m_flat && m_firstPos->size() )
165 m_firstPos = m_rTree.getNextLeaf( m_firstPos );
166 /// \todo Check if the item is really visible in the view
167 // (we only check if it in the document)
168 if( arg->b_visible == true )
173 else if( arg->i_type == 3 ) // item-del
175 /* Make sure firstPos and lastSelected are still valid */
176 while( m_firstPos->m_deleted && m_firstPos != m_rTree.root()->begin() )
178 m_firstPos = m_flat ? m_rTree.getPrevLeaf( m_firstPos )
179 : m_rTree.getPrevVisibleItem( m_firstPos );
181 if( m_firstPos->m_deleted )
182 m_firstPos = m_flat ? m_rTree.firstLeaf()
183 : m_rTree.root()->begin();
185 if( arg->b_visible == true )
193 void CtrlTree::onUpdate( Subject<VarPercent> &rPercent, void* arg)
195 // Determine what is the first item to display
196 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
198 if( m_dontMove ) return;
202 excessItems = m_rTree.countLeafs() - maxItems();
204 excessItems = m_rTree.visibleItems() - maxItems();
208 VarPercent &rVarPos = m_rTree.getPositionVar();
209 // a simple (int)(...) causes rounding errors !
214 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
216 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
218 if( m_firstPos != it )
220 // Redraw the control if the position has changed
227 void CtrlTree::onResize()
229 // Determine what is the first item to display
230 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
234 excessItems = m_rTree.countLeafs() - maxItems();
236 excessItems = m_rTree.visibleItems() - maxItems();
240 VarPercent &rVarPos = m_rTree.getPositionVar();
241 // a simple (int)(...) causes rounding errors !
246 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
248 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
250 // Redraw the control if the position has changed
256 void CtrlTree::onPositionChange()
262 void CtrlTree::handleEvent( EvtGeneric &rEvent )
264 bool bChangedPosition = false;
265 VarTree::Iterator toShow; bool needShow = false;
266 if( rEvent.getAsString().find( "key:down" ) != string::npos )
268 int key = ((EvtKey&)rEvent).getKey();
269 VarTree::Iterator it;
270 bool previousWasSelected = false;
272 /* Delete the selection */
273 if( key == KEY_DELETE )
275 /* Find first non selected item before m_pLastSelected */
276 VarTree::Iterator it_sel = m_flat ? m_rTree.firstLeaf()
278 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
280 it = m_flat ? m_rTree.getNextLeaf( it )
281 : m_rTree.getNextVisibleItem( it ) )
283 if( &*it == m_pLastSelected ) break;
284 if( !it->m_selected ) it_sel = it;
287 /* Delete selected stuff */
288 m_rTree.delSelected();
291 it_sel->m_selected = true;
292 m_pLastSelected = &*it_sel;
294 else if( key == KEY_PAGEDOWN )
297 int i = (int)(maxItems()*1.5);
300 VarTree::Iterator it_old = it;
301 it = m_flat ? m_rTree.getNextLeaf( it )
302 : m_rTree.getNextVisibleItem( it );
303 /* End is already visible, dont' scroll */
304 if( it == m_rTree.end() )
320 else if (key == KEY_PAGEUP )
324 while( i >= maxItems()/2 )
326 it = m_flat ? m_rTree.getPrevLeaf( it )
327 : m_rTree.getPrevVisibleItem( it );
328 /* End is already visible, dont' scroll */
329 if( it == ( m_flat ? m_rTree.firstLeaf() : m_rTree.begin() ) )
342 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
344 it = m_flat ? m_rTree.getNextLeaf( it )
345 : m_rTree.getNextVisibleItem( it ) )
347 VarTree::Iterator next = m_flat ? m_rTree.getNextLeaf( it )
348 : m_rTree.getNextVisibleItem( it );
351 // Scroll up one item
353 && it != it->parent()->begin() )
354 || &*it != m_pLastSelected )
356 bool nextWasSelected = ( &*next == m_pLastSelected );
357 it->m_selected = nextWasSelected;
358 if( nextWasSelected )
360 m_pLastSelected = &*it;
361 needShow = true; toShow = it;
365 else if( key == KEY_DOWN )
367 // Scroll down one item
369 && next != it->parent()->end() )
370 || &*it != m_pLastSelected )
372 (*it).m_selected = previousWasSelected;
374 if( previousWasSelected )
376 m_pLastSelected = &*it;
377 needShow = true; toShow = it;
378 previousWasSelected = false;
382 previousWasSelected = ( &*it == m_pLastSelected );
385 // Fix last tree item selection
386 if( ( m_flat ? m_rTree.getNextLeaf( it )
387 : m_rTree.getNextVisibleItem( it ) ) == m_rTree.end()
388 && &*it == m_pLastSelected )
390 (*it).m_selected = true;
393 else if( key == KEY_RIGHT )
395 // Go down one level (and expand node)
396 if( &*it == m_pLastSelected )
402 it->m_selected = false;
403 it->begin()->m_selected = true;
404 m_pLastSelected = &*(it->begin());
408 m_rTree.action( &*it );
413 it->m_expanded = true;
414 bChangedPosition = true;
418 else if( key == KEY_LEFT )
420 // Go up one level (and close node)
421 if( &*it == m_pLastSelected )
423 if( it->m_expanded && it->size() )
425 it->m_expanded = false;
426 bChangedPosition = true;
430 if( it->parent() && it->parent() != &m_rTree)
432 it->m_selected = false;
433 m_pLastSelected = it->parent();
434 m_pLastSelected->m_selected = true;
439 else if( key == KEY_ENTER || key == KEY_SPACE )
441 // Go up one level (and close node)
442 if( &*it == m_pLastSelected )
444 m_rTree.action( &*it );
449 ensureVisible( toShow );
451 // Redraw the control
456 else if( rEvent.getAsString().find( "mouse:left" ) != string::npos )
458 EvtMouse &rEvtMouse = (EvtMouse&)rEvent;
459 const Position *pos = getPosition();
460 int yPos = ( rEvtMouse.getYPos() - pos->getTop() ) / itemHeight();
461 int xPos = rEvtMouse.getXPos() - pos->getLeft();
462 VarTree::Iterator it;
464 if( rEvent.getAsString().find( "mouse:left:down:ctrl,shift" ) !=
467 VarTree::Iterator itClicked = findItemAtPos( yPos );
468 // Flag to know if the current item must be selected
470 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
472 it = m_flat ? m_rTree.getNextLeaf( it )
473 : m_rTree.getNextVisibleItem( it ) )
475 bool nextSelect = select;
476 if( it == itClicked || &*it == m_pLastSelected )
488 it->m_selected = (*it).m_selected || select;
492 else if( rEvent.getAsString().find( "mouse:left:down:ctrl" ) !=
495 // Invert the selection of the item
496 it = findItemAtPos( yPos );
497 if( it != m_rTree.end() )
499 it->m_selected = !it->m_selected;
500 m_pLastSelected = &*it;
503 else if( rEvent.getAsString().find( "mouse:left:down:shift" ) !=
506 VarTree::Iterator itClicked = findItemAtPos( yPos );
507 // Flag to know if the current item must be selected
509 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
511 it = m_flat ? m_rTree.getNextLeaf( it )
512 : m_rTree.getNextVisibleItem( it ) )
514 bool nextSelect = select;
515 if( it == itClicked || &*it == m_pLastSelected )
527 it->m_selected = select;
531 else if( rEvent.getAsString().find( "mouse:left:down" ) !=
534 it = findItemAtPos(yPos);
535 if( it != m_rTree.end() )
537 if( ( it->size() && xPos > (it->depth() - 1) * itemImageWidth()
538 && xPos < it->depth() * itemImageWidth() )
541 // Fold/unfold the item
542 it->m_expanded = !it->m_expanded;
543 bChangedPosition = true;
547 // Unselect any previously selected item
548 VarTree::Iterator it2;
549 for( it2 = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
550 it2 != m_rTree.end();
551 it2 = m_flat ? m_rTree.getNextLeaf( it2 )
552 : m_rTree.getNextVisibleItem( it2 ) )
554 it2->m_selected = false;
556 // Select the new item
557 if( it != m_rTree.end() )
559 it->m_selected = true;
560 m_pLastSelected = &*it;
566 else if( rEvent.getAsString().find( "mouse:left:dblclick" ) !=
569 it = findItemAtPos(yPos);
570 if( it != m_rTree.end() )
572 // Execute the action associated to this item
573 m_rTree.action( &*it );
576 // Redraw the control
581 else if( rEvent.getAsString().find( "scroll" ) != string::npos )
583 int direction = ((EvtScroll&)rEvent).getDirection();
585 double percentage = m_rTree.getPositionVar().get();
586 double step = 2.0 / (double)( m_flat ? m_rTree.countLeafs()
587 : m_rTree.visibleItems() );
588 if( direction == EvtScroll::kUp )
596 m_rTree.getPositionVar().set( percentage );
599 /* We changed the nodes, let's fix teh position var */
600 if( bChangedPosition )
602 VarTree::Iterator it;
605 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
607 it = m_flat ? m_rTree.getNextLeaf( it )
608 : m_rTree.getNextVisibleItem( it ) )
611 if( it == m_firstPos )
617 iFirst += maxItems();
618 if( iFirst >= m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems() )
619 iFirst = m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems();
620 float f_new = (float)iFirst / (float)( m_flat ? m_rTree.countLeafs()
621 :m_rTree.visibleItems() );
623 m_rTree.getPositionVar().set( 1.0 - f_new );
628 bool CtrlTree::mouseOver( int x, int y ) const
630 const Position *pPos = getPosition();
632 ? x >= 0 && x <= pPos->getWidth() && y >= 0 && y <= pPos->getHeight()
636 void CtrlTree::draw( OSGraphics &rImage, int xDest, int yDest )
640 rImage.drawGraphics( *m_pImage, 0, 0, xDest, yDest );
644 bool CtrlTree::ensureVisible( VarTree::Iterator item )
646 // Find the item to focus
647 int focusItemIndex = 0;
648 VarTree::Iterator it;
650 m_rTree.ensureExpanded( item );
652 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
654 it = m_flat ? m_rTree.getNextLeaf( it )
655 : m_rTree.getNextVisibleItem( it ) )
657 if( it->m_id == item->m_id ) break;
660 return ensureVisible( focusItemIndex );
663 bool CtrlTree::ensureVisible( int focusItemIndex )
666 VarTree::Iterator it;
667 int firstPosIndex = 0;
668 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
670 it = m_flat ? m_rTree.getNextLeaf( it )
671 : m_rTree.getNextVisibleItem( it ) )
673 if( it == m_firstPos ) break;
677 if( it == m_rTree.end() ) return false;
680 if( it != m_rTree.end()
681 && ( focusItemIndex < firstPosIndex
682 || focusItemIndex > firstPosIndex + maxItems() ) )
684 // Scroll to have the wanted stream visible
685 VarPercent &rVarPos = m_rTree.getPositionVar();
686 rVarPos.set( 1.0 - (double)focusItemIndex /
687 (double)( m_flat ? m_rTree.countLeafs()
688 : m_rTree.visibleItems() ) );
694 void CtrlTree::autoScroll()
696 // Find the current playing stream
698 VarTree::Iterator it;
700 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
702 it = m_flat ? m_rTree.getNextLeaf( it )
703 : m_rTree.getNextItem( it ) )
707 m_rTree.ensureExpanded( it );
711 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
713 it = m_flat ? m_rTree.getNextLeaf( it )
714 : m_rTree.getNextVisibleItem( it ) )
721 if( it == m_rTree.end() ) return;
724 ensureVisible( playIndex );
728 void CtrlTree::makeImage()
730 stats_TimerStart( getIntf(), "[Skins] Playlist image",
731 STATS_TIMER_SKINS_PLAYTREE_IMAGE );
737 // Get the size of the control
738 const Position *pPos = getPosition();
741 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
744 int width = pPos->getWidth();
745 int height = pPos->getHeight();
747 int i_itemHeight = itemHeight();
750 OSFactory *pOsFactory = OSFactory::instance( getIntf() );
751 m_pImage = pOsFactory->createOSGraphics( width, height );
753 VarTree::Iterator it = m_firstPos;
757 // Draw the background bitmap
758 ScaledBitmap bmp( getIntf(), *m_pBgBitmap, width, height );
759 m_pImage->drawBitmap( bmp, 0, 0 );
761 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
763 if( it != m_rTree.end() )
765 if( (*it).m_selected )
767 int rectHeight = __MIN( i_itemHeight, height - yPos );
768 m_pImage->fillRect( 0, yPos, width, rectHeight,
773 it = m_flat ? m_rTree.getNextLeaf( it )
774 : m_rTree.getNextVisibleItem( it );
775 } while( it != m_rTree.end() && it->m_deleted );
782 // Fill background with background color
783 uint32_t bgColor = m_bgColor1;
784 m_pImage->fillRect( 0, 0, width, height, bgColor );
785 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
787 int rectHeight = __MIN( i_itemHeight, height - yPos );
788 if( it != m_rTree.end() )
790 uint32_t color = ( it->m_selected ? m_selColor : bgColor );
791 m_pImage->fillRect( 0, yPos, width, rectHeight, color );
794 it = m_flat ? m_rTree.getNextLeaf( it )
795 : m_rTree.getNextVisibleItem( it );
796 } while( it != m_rTree.end() && it->m_deleted );
800 m_pImage->fillRect( 0, yPos, width, rectHeight, bgColor );
802 bgColor = ( bgColor == m_bgColor1 ? m_bgColor2 : m_bgColor1 );
806 int bitmapWidth = itemImageWidth();
810 while( it != m_rTree.end() && yPos < height )
812 const GenericBitmap *m_pCurBitmap;
813 UString *pStr = (UString*)(it->m_cString.get());
814 uint32_t color = ( it->m_playing ? m_playColor : m_fgColor );
819 int depth = m_flat ? 1 : it->depth();
820 GenericBitmap *pText = m_rFont.drawString( *pStr, color, width - bitmapWidth * depth );
823 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
827 m_pCurBitmap = it->m_expanded ? m_pOpenBitmap : m_pClosedBitmap;
829 m_pCurBitmap = m_pItemBitmap;
833 // Make sure we are centered on the line
834 int yPos2 = yPos+(i_itemHeight-m_pCurBitmap->getHeight()+1)/2;
835 if( yPos2 >= height )
840 m_pImage->drawBitmap( *m_pCurBitmap, 0, 0,
841 bitmapWidth * (depth - 1 ), yPos2,
842 m_pCurBitmap->getWidth(),
843 __MIN( m_pCurBitmap->getHeight(),
844 height - yPos2), true );
846 yPos += i_itemHeight - pText->getHeight();
853 int lineHeight = __MIN( pText->getHeight() - ySrc, height - yPos );
854 m_pImage->drawBitmap( *pText, 0, ySrc, bitmapWidth * depth, yPos,
857 yPos += (pText->getHeight() - ySrc );
862 it = m_flat ? m_rTree.getNextLeaf( it )
863 : m_rTree.getNextVisibleItem( it );
864 } while( it != m_rTree.end() && it->m_deleted );
866 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
869 VarTree::Iterator CtrlTree::findItemAtPos( int pos )
871 // The first item is m_firstPos.
872 // We decrement pos as we try the other items, until pos == 0.
873 VarTree::Iterator it;
874 for( it = m_firstPos; it != m_rTree.end() && pos != 0;
875 it = m_flat ? m_rTree.getNextLeaf( it )
876 : m_rTree.getNextVisibleItem( it ) )