1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
7 * Authors: Antoine Cellerier <dionoea@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 #include "../utils/var_bool.hpp"
26 #include "ctrl_tree.hpp"
27 #include "../src/os_factory.hpp"
28 #include "../src/os_graphics.hpp"
29 #include "../src/generic_bitmap.hpp"
30 #include "../src/generic_font.hpp"
31 #include "../src/scaled_bitmap.hpp"
32 #include "../utils/position.hpp"
33 #include "../utils/ustring.hpp"
34 #include "../events/evt_key.hpp"
35 #include "../events/evt_mouse.hpp"
36 #include "../events/evt_scroll.hpp"
39 # include "solaris_specific.h" // for lrint
42 #define SCROLL_STEP 0.05
43 #define LINE_INTERVAL 1 // Number of pixels inserted between 2 lines
46 CtrlTree::CtrlTree( intf_thread_t *pIntf,
48 const GenericFont &rFont,
49 const GenericBitmap *pBgBitmap,
50 const GenericBitmap *pItemBitmap,
51 const GenericBitmap *pOpenBitmap,
52 const GenericBitmap *pClosedBitmap,
61 CtrlGeneric( pIntf,rHelp, pVisible), m_rTree( rTree), m_rFont( rFont ),
62 m_pBgBitmap( pBgBitmap ), m_pItemBitmap( pItemBitmap ),
63 m_pOpenBitmap( pOpenBitmap ), m_pClosedBitmap( pClosedBitmap ),
64 m_fgColor( fgColor ), m_playColor( playColor ), m_bgColor1( bgColor1 ),
65 m_bgColor2( bgColor2 ), m_selColor( selColor ),
66 m_pLastSelected( NULL ), m_pImage( NULL ), m_dontMove( false )
68 // Observe the tree and position variables
69 m_rTree.addObserver( this );
70 m_rTree.getPositionVar().addObserver( this );
72 m_flat = pFlat->get();
74 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
81 m_rTree.getPositionVar().delObserver( this );
82 m_rTree.delObserver( this );
89 int CtrlTree::itemHeight()
91 int itemHeight = m_rFont.getSize();
96 itemHeight = __MAX( m_pClosedBitmap->getHeight(), itemHeight );
100 itemHeight = __MAX( m_pOpenBitmap->getHeight(), itemHeight );
105 itemHeight = __MAX( m_pItemBitmap->getHeight(), itemHeight );
107 itemHeight += LINE_INTERVAL;
111 int CtrlTree::itemImageWidth()
116 if( m_pClosedBitmap )
118 bitmapWidth = __MAX( m_pClosedBitmap->getWidth(), bitmapWidth );
122 bitmapWidth = __MAX( m_pOpenBitmap->getWidth(), bitmapWidth );
127 bitmapWidth = __MAX( m_pItemBitmap->getWidth(), bitmapWidth );
129 return bitmapWidth + 2;
132 int CtrlTree::maxItems()
134 const Position *pPos = getPosition();
139 return pPos->getHeight() / itemHeight();
143 void CtrlTree::onUpdate( Subject<VarTree, tree_update*> &rTree,
146 if( arg->i_type == 0 ) // Item update
148 if( arg->b_active_item )
151 ///\todo We should make image if we are visible in the view
155 /// \todo handle delete in a more clever way
156 else if ( arg->i_type == 1 ) // Global change or deletion
158 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
161 else if ( arg->i_type == 2 ) // Item-append
163 if( m_flat && m_firstPos->size() )
164 m_firstPos = m_rTree.getNextLeaf( m_firstPos );
165 /// \todo Check if the item is really visible in the view
166 // (we only check if it in the document)
167 if( arg->b_visible == true )
172 else if( arg->i_type == 3 ) // item-del
174 /* Make sure firstPos and lastSelected are still valid */
175 while( m_firstPos->m_deleted && m_firstPos != m_rTree.root()->begin() )
177 m_firstPos = m_flat ? m_rTree.getPrevLeaf( m_firstPos )
178 : m_rTree.getPrevVisibleItem( m_firstPos );
180 if( m_firstPos->m_deleted )
181 m_firstPos = m_flat ? m_rTree.firstLeaf()
182 : m_rTree.root()->begin();
184 if( arg->b_visible == true )
192 void CtrlTree::onUpdate( Subject<VarPercent, void*> &rPercent, void* arg)
194 // Determine what is the first item to display
195 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
197 if( m_dontMove ) return;
201 excessItems = m_rTree.countLeafs() - maxItems();
203 excessItems = m_rTree.visibleItems() - maxItems();
207 VarPercent &rVarPos = m_rTree.getPositionVar();
208 // a simple (int)(...) causes rounding errors !
213 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
215 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
217 if( m_firstPos != it )
219 // Redraw the control if the position has changed
226 void CtrlTree::onResize()
228 // Determine what is the first item to display
229 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
233 excessItems = m_rTree.countLeafs() - maxItems();
235 excessItems = m_rTree.visibleItems() - maxItems();
239 VarPercent &rVarPos = m_rTree.getPositionVar();
240 // a simple (int)(...) causes rounding errors !
245 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
247 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
249 // Redraw the control if the position has changed
255 void CtrlTree::onPositionChange()
261 void CtrlTree::handleEvent( EvtGeneric &rEvent )
263 bool bChangedPosition = false;
264 VarTree::Iterator toShow; bool needShow = false;
265 if( rEvent.getAsString().find( "key:down" ) != string::npos )
267 int key = ((EvtKey&)rEvent).getKey();
268 VarTree::Iterator it;
269 bool previousWasSelected = false;
271 /* Delete the selection */
272 if( key == KEY_DELETE )
274 /* Find first non selected item before m_pLastSelected */
275 VarTree::Iterator it_sel = m_flat ? m_rTree.firstLeaf()
277 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
279 it = m_flat ? m_rTree.getNextLeaf( it )
280 : m_rTree.getNextVisibleItem( it ) )
282 if( &*it == m_pLastSelected ) break;
283 if( !it->m_selected ) it_sel = it;
286 /* Delete selected stuff */
287 m_rTree.delSelected();
290 it_sel->m_selected = true;
291 m_pLastSelected = &*it_sel;
293 else if( key == KEY_PAGEDOWN )
296 int i = (int)(maxItems()*1.5);
299 VarTree::Iterator it_old = it;
300 it = m_flat ? m_rTree.getNextLeaf( it )
301 : m_rTree.getNextVisibleItem( it );
302 /* End is already visible, dont' scroll */
303 if( it == m_rTree.end() )
319 else if (key == KEY_PAGEUP )
323 while( i >= maxItems()/2 )
325 it = m_flat ? m_rTree.getPrevLeaf( it )
326 : m_rTree.getPrevVisibleItem( it );
327 /* End is already visible, dont' scroll */
328 if( it == ( m_flat ? m_rTree.firstLeaf() : m_rTree.begin() ) )
341 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
343 it = m_flat ? m_rTree.getNextLeaf( it )
344 : m_rTree.getNextVisibleItem( it ) )
346 VarTree::Iterator next = m_flat ? m_rTree.getNextLeaf( it )
347 : m_rTree.getNextVisibleItem( it );
350 // Scroll up one item
352 && it != it->parent()->begin() )
353 || &*it != m_pLastSelected )
355 bool nextWasSelected = ( &*next == m_pLastSelected );
356 it->m_selected = nextWasSelected;
357 if( nextWasSelected )
359 m_pLastSelected = &*it;
360 needShow = true; toShow = it;
364 else if( key == KEY_DOWN )
366 // Scroll down one item
368 && next != it->parent()->end() )
369 || &*it != m_pLastSelected )
371 (*it).m_selected = previousWasSelected;
373 if( previousWasSelected )
375 m_pLastSelected = &*it;
376 needShow = true; toShow = it;
377 previousWasSelected = false;
381 previousWasSelected = ( &*it == m_pLastSelected );
384 // Fix last tree item selection
385 if( ( m_flat ? m_rTree.getNextLeaf( it )
386 : m_rTree.getNextVisibleItem( it ) ) == m_rTree.end()
387 && &*it == m_pLastSelected )
389 (*it).m_selected = true;
392 else if( key == KEY_RIGHT )
394 // Go down one level (and expand node)
395 if( &*it == m_pLastSelected )
401 it->m_selected = false;
402 it->begin()->m_selected = true;
403 m_pLastSelected = &*(it->begin());
407 m_rTree.action( &*it );
412 it->m_expanded = true;
413 bChangedPosition = true;
417 else if( key == KEY_LEFT )
419 // Go up one level (and close node)
420 if( &*it == m_pLastSelected )
422 if( it->m_expanded && it->size() )
424 it->m_expanded = false;
425 bChangedPosition = true;
429 if( it->parent() && it->parent() != &m_rTree)
431 it->m_selected = false;
432 m_pLastSelected = it->parent();
433 m_pLastSelected->m_selected = true;
438 else if( key == KEY_ENTER || key == KEY_SPACE )
440 // Go up one level (and close node)
441 if( &*it == m_pLastSelected )
443 m_rTree.action( &*it );
448 ensureVisible( toShow );
450 // Redraw the control
455 else if( rEvent.getAsString().find( "mouse:left" ) != string::npos )
457 EvtMouse &rEvtMouse = (EvtMouse&)rEvent;
458 const Position *pos = getPosition();
459 int yPos = ( rEvtMouse.getYPos() - pos->getTop() ) / itemHeight();
460 int xPos = rEvtMouse.getXPos() - pos->getLeft();
461 VarTree::Iterator it;
463 if( rEvent.getAsString().find( "mouse:left:down:ctrl,shift" ) !=
466 VarTree::Iterator itClicked = findItemAtPos( yPos );
467 // Flag to know if the current item must be selected
469 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
471 it = m_flat ? m_rTree.getNextLeaf( it )
472 : m_rTree.getNextVisibleItem( it ) )
474 bool nextSelect = select;
475 if( it == itClicked || &*it == m_pLastSelected )
487 it->m_selected = (*it).m_selected || select;
491 else if( rEvent.getAsString().find( "mouse:left:down:ctrl" ) !=
494 // Invert the selection of the item
495 it = findItemAtPos( yPos );
496 if( it != m_rTree.end() )
498 it->m_selected = !it->m_selected;
499 m_pLastSelected = &*it;
502 else if( rEvent.getAsString().find( "mouse:left:down:shift" ) !=
505 VarTree::Iterator itClicked = findItemAtPos( yPos );
506 // Flag to know if the current item must be selected
508 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
510 it = m_flat ? m_rTree.getNextLeaf( it )
511 : m_rTree.getNextVisibleItem( it ) )
513 bool nextSelect = select;
514 if( it == itClicked || &*it == m_pLastSelected )
526 it->m_selected = select;
530 else if( rEvent.getAsString().find( "mouse:left:down" ) !=
533 it = findItemAtPos(yPos);
534 if( it != m_rTree.end() )
536 if( ( it->size() && xPos > (it->depth() - 1) * itemImageWidth()
537 && xPos < it->depth() * itemImageWidth() )
540 // Fold/unfold the item
541 it->m_expanded = !it->m_expanded;
542 bChangedPosition = true;
546 // Unselect any previously selected item
547 VarTree::Iterator it2;
548 for( it2 = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
549 it2 != m_rTree.end();
550 it2 = m_flat ? m_rTree.getNextLeaf( it2 )
551 : m_rTree.getNextVisibleItem( it2 ) )
553 it2->m_selected = false;
555 // Select the new item
556 if( it != m_rTree.end() )
558 it->m_selected = true;
559 m_pLastSelected = &*it;
565 else if( rEvent.getAsString().find( "mouse:left:dblclick" ) !=
568 it = findItemAtPos(yPos);
569 if( it != m_rTree.end() )
571 // Execute the action associated to this item
572 m_rTree.action( &*it );
575 // Redraw the control
580 else if( rEvent.getAsString().find( "scroll" ) != string::npos )
582 int direction = ((EvtScroll&)rEvent).getDirection();
584 double percentage = m_rTree.getPositionVar().get();
585 double step = 2.0 / (double)( m_flat ? m_rTree.countLeafs()
586 : m_rTree.visibleItems() );
587 if( direction == EvtScroll::kUp )
595 m_rTree.getPositionVar().set( percentage );
598 /* We changed the nodes, let's fix teh position var */
599 if( bChangedPosition )
601 VarTree::Iterator it;
604 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
606 it = m_flat ? m_rTree.getNextLeaf( it )
607 : m_rTree.getNextVisibleItem( it ) )
610 if( it == m_firstPos )
616 iFirst += maxItems();
617 if( iFirst >= m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems() )
618 iFirst = m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems();
619 float f_new = (float)iFirst / (float)( m_flat ? m_rTree.countLeafs()
620 :m_rTree.visibleItems() );
622 m_rTree.getPositionVar().set( 1.0 - f_new );
627 bool CtrlTree::mouseOver( int x, int y ) const
629 const Position *pPos = getPosition();
631 ? x >= 0 && x <= pPos->getWidth() && y >= 0 && y <= pPos->getHeight()
635 void CtrlTree::draw( OSGraphics &rImage, int xDest, int yDest )
639 rImage.drawGraphics( *m_pImage, 0, 0, xDest, yDest );
643 bool CtrlTree::ensureVisible( VarTree::Iterator item )
645 // Find the item to focus
646 int focusItemIndex = 0;
647 VarTree::Iterator it;
649 m_rTree.ensureExpanded( item );
651 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
653 it = m_flat ? m_rTree.getNextLeaf( it )
654 : m_rTree.getNextVisibleItem( it ) )
656 if( it->m_id == item->m_id ) break;
659 return ensureVisible( focusItemIndex );
662 bool CtrlTree::ensureVisible( int focusItemIndex )
665 VarTree::Iterator it;
666 int firstPosIndex = 0;
667 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
669 it = m_flat ? m_rTree.getNextLeaf( it )
670 : m_rTree.getNextVisibleItem( it ) )
672 if( it == m_firstPos ) break;
676 if( it == m_rTree.end() ) return false;
679 if( it != m_rTree.end()
680 && ( focusItemIndex < firstPosIndex
681 || focusItemIndex > firstPosIndex + maxItems() ) )
683 // Scroll to have the wanted stream visible
684 VarPercent &rVarPos = m_rTree.getPositionVar();
685 rVarPos.set( 1.0 - (double)focusItemIndex /
686 (double)( m_flat ? m_rTree.countLeafs()
687 : m_rTree.visibleItems() ) );
693 void CtrlTree::autoScroll()
695 // Find the current playing stream
697 VarTree::Iterator it;
699 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
701 it = m_flat ? m_rTree.getNextLeaf( it )
702 : m_rTree.getNextItem( it ) )
706 m_rTree.ensureExpanded( it );
710 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
712 it = m_flat ? m_rTree.getNextLeaf( it )
713 : m_rTree.getNextVisibleItem( it ) )
720 if( it == m_rTree.end() ) return;
723 ensureVisible( playIndex );
727 void CtrlTree::makeImage()
729 stats_TimerStart( getIntf(), "[Skins] Playlist image",
730 STATS_TIMER_SKINS_PLAYTREE_IMAGE );
736 // Get the size of the control
737 const Position *pPos = getPosition();
740 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
743 int width = pPos->getWidth();
744 int height = pPos->getHeight();
746 int i_itemHeight = itemHeight();
749 OSFactory *pOsFactory = OSFactory::instance( getIntf() );
750 m_pImage = pOsFactory->createOSGraphics( width, height );
752 VarTree::Iterator it = m_firstPos;
756 // Draw the background bitmap
757 ScaledBitmap bmp( getIntf(), *m_pBgBitmap, width, height );
758 m_pImage->drawBitmap( bmp, 0, 0 );
760 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
762 if( it != m_rTree.end() )
764 if( (*it).m_selected )
766 int rectHeight = __MIN( i_itemHeight, height - yPos );
767 m_pImage->fillRect( 0, yPos, width, rectHeight,
772 it = m_flat ? m_rTree.getNextLeaf( it )
773 : m_rTree.getNextVisibleItem( it );
774 } while( it != m_rTree.end() && it->m_deleted );
781 // Fill background with background color
782 uint32_t bgColor = m_bgColor1;
783 m_pImage->fillRect( 0, 0, width, height, bgColor );
784 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
786 int rectHeight = __MIN( i_itemHeight, height - yPos );
787 if( it != m_rTree.end() )
789 uint32_t color = ( it->m_selected ? m_selColor : bgColor );
790 m_pImage->fillRect( 0, yPos, width, rectHeight, color );
793 it = m_flat ? m_rTree.getNextLeaf( it )
794 : m_rTree.getNextVisibleItem( it );
795 } while( it->m_deleted );
799 m_pImage->fillRect( 0, yPos, width, rectHeight, bgColor );
801 bgColor = ( bgColor == m_bgColor1 ? m_bgColor2 : m_bgColor1 );
805 int bitmapWidth = itemImageWidth();
809 while( it != m_rTree.end() && yPos < height )
811 const GenericBitmap *m_pCurBitmap;
812 UString *pStr = (UString*)(it->m_cString.get());
813 uint32_t color = ( it->m_playing ? m_playColor : m_fgColor );
818 int depth = m_flat ? 1 : it->depth();
819 GenericBitmap *pText = m_rFont.drawString( *pStr, color, width - bitmapWidth * depth );
822 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
826 m_pCurBitmap = it->m_expanded ? m_pOpenBitmap : m_pClosedBitmap;
828 m_pCurBitmap = m_pItemBitmap;
832 // Make sure we are centered on the line
833 int yPos2 = yPos+(i_itemHeight-m_pCurBitmap->getHeight()+1)/2;
834 if( yPos2 >= height )
839 m_pImage->drawBitmap( *m_pCurBitmap, 0, 0,
840 bitmapWidth * (depth - 1 ), yPos2,
841 m_pCurBitmap->getWidth(),
842 __MIN( m_pCurBitmap->getHeight(),
843 height - yPos2), true );
845 yPos += i_itemHeight - pText->getHeight();
852 int lineHeight = __MIN( pText->getHeight() - ySrc, height - yPos );
853 m_pImage->drawBitmap( *pText, 0, ySrc, bitmapWidth * depth, yPos,
856 yPos += (pText->getHeight() - ySrc );
860 it = m_flat ? m_rTree.getNextLeaf( it )
861 : m_rTree.getNextVisibleItem( it );
862 } while( it != m_rTree.end() && it->m_deleted );
864 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
867 VarTree::Iterator CtrlTree::findItemAtPos( int pos )
869 // The first item is m_firstPos.
870 // We decrement pos as we try the other items, until pos == 0.
871 VarTree::Iterator it;
872 for( it = m_firstPos; it != m_rTree.end() && pos != 0;
873 it = m_flat ? m_rTree.getNextLeaf( it )
874 : m_rTree.getNextVisibleItem( it ) )