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 #define SCROLL_STEP 0.05
41 #define LINE_INTERVAL 1 // Number of pixels inserted between 2 lines
44 CtrlTree::CtrlTree( intf_thread_t *pIntf,
46 const GenericFont &rFont,
47 const GenericBitmap *pBgBitmap,
48 const GenericBitmap *pItemBitmap,
49 const GenericBitmap *pOpenBitmap,
50 const GenericBitmap *pClosedBitmap,
59 CtrlGeneric( pIntf,rHelp, pVisible), m_rTree( rTree), m_rFont( rFont ),
60 m_pBgBitmap( pBgBitmap ), m_pItemBitmap( pItemBitmap ),
61 m_pOpenBitmap( pOpenBitmap ), m_pClosedBitmap( pClosedBitmap ),
62 m_fgColor( fgColor ), m_playColor( playColor ), m_bgColor1( bgColor1 ),
63 m_bgColor2( bgColor2 ), m_selColor( selColor ),
64 m_pLastSelected( NULL ), m_pImage( NULL ), m_dontMove( false )
66 // Observe the tree and position variables
67 m_rTree.addObserver( this );
68 m_rTree.getPositionVar().addObserver( this );
70 m_flat = pFlat->get();
72 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
79 m_rTree.getPositionVar().delObserver( this );
80 m_rTree.delObserver( this );
84 int CtrlTree::itemHeight()
86 int itemHeight = m_rFont.getSize();
91 itemHeight = __MAX( m_pClosedBitmap->getHeight(), itemHeight );
95 itemHeight = __MAX( m_pOpenBitmap->getHeight(), itemHeight );
100 itemHeight = __MAX( m_pItemBitmap->getHeight(), itemHeight );
102 itemHeight += LINE_INTERVAL;
106 int CtrlTree::itemImageWidth()
111 if( m_pClosedBitmap )
113 bitmapWidth = __MAX( m_pClosedBitmap->getWidth(), bitmapWidth );
117 bitmapWidth = __MAX( m_pOpenBitmap->getWidth(), bitmapWidth );
122 bitmapWidth = __MAX( m_pItemBitmap->getWidth(), bitmapWidth );
124 return bitmapWidth + 2;
127 int CtrlTree::maxItems()
129 const Position *pPos = getPosition();
134 return pPos->getHeight() / itemHeight();
138 void CtrlTree::onUpdate( Subject<VarTree, tree_update> &rTree,
141 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
143 if( arg->i_type == 0 ) // Item update
145 if( arg->b_active_item )
148 ///\todo We should make image if we are visible in the view
152 /// \todo handle delete in a more clever way
153 else if ( arg->i_type == 1 ) // Global change or deletion
157 else if ( arg->i_type == 2 ) // Item-append
159 if( m_flat && m_firstPos->size() )
160 m_firstPos = m_rTree.getNextLeaf( m_firstPos );
161 /// \todo Check if the item is really visible in the view
162 // (we only check if it in the document)
163 if( arg->b_visible == true )
168 else if( arg->i_type == 3 ) // item-del
170 /* Make sure firstPos and lastSelected are still valid */
171 while( m_firstPos->m_deleted && m_firstPos != m_rTree.root()->begin() )
173 m_firstPos = m_flat ? m_rTree.getPrevLeaf( m_firstPos )
174 : m_rTree.getPrevVisibleItem( m_firstPos );
176 if( m_firstPos->m_deleted )
177 m_firstPos = m_flat ? m_rTree.firstLeaf()
178 : m_rTree.root()->begin();
180 if( arg->b_visible == true )
188 void CtrlTree::onUpdate( Subject<VarPercent> &rPercent, void* arg)
190 // Determine what is the first item to display
191 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
193 if( m_dontMove ) return;
197 excessItems = m_rTree.countLeafs() - maxItems();
199 excessItems = m_rTree.visibleItems() - maxItems();
203 VarPercent &rVarPos = m_rTree.getPositionVar();
204 // a simple (int)(...) causes rounding errors !
209 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
211 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
213 if( m_firstPos != it )
215 // Redraw the control if the position has changed
222 void CtrlTree::onResize()
224 // Determine what is the first item to display
225 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
229 excessItems = m_rTree.countLeafs() - maxItems();
231 excessItems = m_rTree.visibleItems() - maxItems();
235 VarPercent &rVarPos = m_rTree.getPositionVar();
236 // a simple (int)(...) causes rounding errors !
241 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
243 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
245 // Redraw the control if the position has changed
250 void CtrlTree::onPositionChange()
255 void CtrlTree::handleEvent( EvtGeneric &rEvent )
257 bool bChangedPosition = false;
258 VarTree::Iterator toShow; bool needShow = false;
259 if( rEvent.getAsString().find( "key:down" ) != string::npos )
261 int key = ((EvtKey&)rEvent).getKey();
262 VarTree::Iterator it;
263 bool previousWasSelected = false;
265 /* Delete the selection */
266 if( key == KEY_DELETE )
268 /* Find first non selected item before m_pLastSelected */
269 VarTree::Iterator it_sel = m_flat ? m_rTree.firstLeaf()
271 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
273 it = m_flat ? m_rTree.getNextLeaf( it )
274 : m_rTree.getNextVisibleItem( it ) )
276 if( &*it == m_pLastSelected ) break;
277 if( !it->m_selected ) it_sel = it;
280 /* Delete selected stuff */
281 m_rTree.delSelected();
284 it_sel->m_selected = true;
285 m_pLastSelected = &*it_sel;
287 // Redraw the control
291 else if( key == KEY_PAGEDOWN )
294 int i = (int)(maxItems()*1.5);
297 VarTree::Iterator it_old = it;
298 it = m_flat ? m_rTree.getNextLeaf( it )
299 : m_rTree.getNextVisibleItem( it );
300 /* End is already visible, dont' scroll */
301 if( it == m_rTree.end() )
316 else if (key == KEY_PAGEUP )
320 while( i >= maxItems()/2 )
322 it = m_flat ? m_rTree.getPrevLeaf( it )
323 : m_rTree.getPrevVisibleItem( it );
324 /* End is already visible, dont' scroll */
325 if( it == ( m_flat ? m_rTree.firstLeaf() : m_rTree.begin() ) )
335 else if ( key == KEY_UP ||
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 ?
348 m_rTree.getNextLeaf( it ) :
349 m_rTree.getNextVisibleItem( it );
352 // Scroll up one item
354 && it != it->parent()->begin() )
355 || &*it != m_pLastSelected )
357 bool nextWasSelected = ( &*next == m_pLastSelected );
358 it->m_selected = nextWasSelected;
359 if( nextWasSelected )
361 m_pLastSelected = &*it;
362 needShow = true; toShow = it;
366 else if( key == KEY_DOWN )
368 // Scroll down one item
370 && next != it->parent()->end() )
371 || &*it != m_pLastSelected )
373 (*it).m_selected = previousWasSelected;
375 if( previousWasSelected )
377 m_pLastSelected = &*it;
378 needShow = true; toShow = it;
379 previousWasSelected = false;
383 previousWasSelected = ( &*it == m_pLastSelected );
386 // Fix last tree item selection
387 if( ( m_flat ? m_rTree.getNextLeaf( it )
388 : m_rTree.getNextVisibleItem( it ) ) == m_rTree.end()
389 && &*it == m_pLastSelected )
391 (*it).m_selected = true;
394 else if( key == KEY_RIGHT )
396 // Go down one level (and expand node)
397 if( &*it == m_pLastSelected )
403 it->m_selected = false;
404 it->begin()->m_selected = true;
405 m_pLastSelected = &*(it->begin());
409 m_rTree.action( &*it );
414 it->m_expanded = true;
415 bChangedPosition = true;
419 else if( key == KEY_LEFT )
421 // Go up one level (and close node)
422 if( &*it == m_pLastSelected )
424 if( it->m_expanded && it->size() )
426 it->m_expanded = false;
427 bChangedPosition = true;
431 if( it->parent() && it->parent() != &m_rTree)
433 it->m_selected = false;
434 m_pLastSelected = it->parent();
435 m_pLastSelected->m_selected = true;
440 else if( key == KEY_ENTER || key == ' ' )
442 // Go up one level (and close node)
443 if( &*it == m_pLastSelected )
445 m_rTree.action( &*it );
450 ensureVisible( toShow );
451 // Redraw the control
457 // other keys to be forwarded to vlc core
458 EvtKey& rEvtKey = (EvtKey&)rEvent;
459 var_SetInteger( getIntf()->p_libvlc, "key-pressed",
460 rEvtKey.getModKey() );
465 else if( rEvent.getAsString().find( "mouse:left" ) != string::npos )
467 EvtMouse &rEvtMouse = (EvtMouse&)rEvent;
468 const Position *pos = getPosition();
469 int yPos = ( rEvtMouse.getYPos() - pos->getTop() ) / itemHeight();
470 int xPos = rEvtMouse.getXPos() - pos->getLeft();
471 VarTree::Iterator it;
473 if( rEvent.getAsString().find( "mouse:left:down:ctrl,shift" ) !=
476 VarTree::Iterator itClicked = findItemAtPos( yPos );
477 // Flag to know if the current item must be selected
479 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
481 it = m_flat ? m_rTree.getNextLeaf( it )
482 : m_rTree.getNextVisibleItem( it ) )
484 bool nextSelect = select;
485 if( it == itClicked || &*it == m_pLastSelected )
497 it->m_selected = (*it).m_selected || select;
501 else if( rEvent.getAsString().find( "mouse:left:down:ctrl" ) !=
504 // Invert the selection of the item
505 it = findItemAtPos( yPos );
506 if( it != m_rTree.end() )
508 it->m_selected = !it->m_selected;
509 m_pLastSelected = &*it;
512 else if( rEvent.getAsString().find( "mouse:left:down:shift" ) !=
515 VarTree::Iterator itClicked = findItemAtPos( yPos );
516 // Flag to know if the current item must be selected
518 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
520 it = m_flat ? m_rTree.getNextLeaf( it )
521 : m_rTree.getNextVisibleItem( it ) )
523 bool nextSelect = select;
524 if( it == itClicked || &*it == m_pLastSelected )
536 it->m_selected = select;
540 else if( rEvent.getAsString().find( "mouse:left:down" ) !=
543 it = findItemAtPos(yPos);
544 if( it != m_rTree.end() )
546 if( ( it->size() && xPos > (it->depth() - 1) * itemImageWidth()
547 && xPos < it->depth() * itemImageWidth() )
550 // Fold/unfold the item
551 it->m_expanded = !it->m_expanded;
552 bChangedPosition = true;
556 // Unselect any previously selected item
557 VarTree::Iterator it2;
558 for( it2 = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
559 it2 != m_rTree.end();
560 it2 = m_flat ? m_rTree.getNextLeaf( it2 )
561 : m_rTree.getNextVisibleItem( it2 ) )
563 it2->m_selected = false;
565 // Select the new item
566 if( it != m_rTree.end() )
568 it->m_selected = true;
569 m_pLastSelected = &*it;
575 else if( rEvent.getAsString().find( "mouse:left:dblclick" ) !=
578 it = findItemAtPos(yPos);
579 if( it != m_rTree.end() )
581 // Execute the action associated to this item
582 m_rTree.action( &*it );
585 // Redraw the control
590 else if( rEvent.getAsString().find( "scroll" ) != string::npos )
592 // XXX ctrl_slider.cpp has two more (but slightly different)
593 // XXX implementations of `scroll'. Figure out where it belongs.
595 int direction = static_cast<EvtScroll&>(rEvent).getDirection();
597 double percentage = m_rTree.getPositionVar().get();
598 double step = 2.0 / (double)( m_flat ? m_rTree.countLeafs()
599 : m_rTree.visibleItems() );
600 if( direction == EvtScroll::kUp )
608 m_rTree.getPositionVar().set( percentage );
611 /* We changed the nodes, let's fix teh position var */
612 if( bChangedPosition )
614 VarTree::Iterator it;
617 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
619 it = m_flat ? m_rTree.getNextLeaf( it )
620 : m_rTree.getNextVisibleItem( it ) )
623 if( it == m_firstPos )
629 iFirst += maxItems();
630 if( iFirst >= (m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems()) )
631 iFirst = m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems();
632 float f_new = (float)iFirst / (float)( m_flat ? m_rTree.countLeafs()
633 :m_rTree.visibleItems() );
635 m_rTree.getPositionVar().set( 1.0 - f_new );
640 bool CtrlTree::mouseOver( int x, int y ) const
642 const Position *pPos = getPosition();
643 return !pPos ? false :
644 x >= 0 && x <= pPos->getWidth() && y >= 0 && y <= pPos->getHeight();
647 void CtrlTree::draw( OSGraphics &rImage, int xDest, int yDest, int w, int h)
649 const Position *pPos = getPosition();
650 rect region( pPos->getLeft(), pPos->getTop(),
651 pPos->getWidth(), pPos->getHeight() );
652 rect clip( xDest, yDest, w, h );
655 if( rect::intersect( region, clip, &inter ) && m_pImage )
656 rImage.drawGraphics( *m_pImage,
657 inter.x - pPos->getLeft(),
658 inter.y - pPos->getTop(),
659 inter.x, inter.y, inter.width, inter.height );
662 bool CtrlTree::ensureVisible( VarTree::Iterator item )
664 // Find the item to focus
665 int focusItemIndex = 0;
666 VarTree::Iterator it;
668 m_rTree.ensureExpanded( item );
670 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
672 it = m_flat ? m_rTree.getNextLeaf( it )
673 : m_rTree.getNextVisibleItem( it ) )
675 if( it->m_id == item->m_id ) break;
678 return ensureVisible( focusItemIndex );
681 bool CtrlTree::ensureVisible( int focusItemIndex )
684 VarTree::Iterator it;
685 int firstPosIndex = 0;
686 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
688 it = m_flat ? m_rTree.getNextLeaf( it )
689 : m_rTree.getNextVisibleItem( it ) )
691 if( it == m_firstPos ) break;
695 if( it == m_rTree.end() ) return false;
698 if( it != m_rTree.end()
699 && ( focusItemIndex < firstPosIndex
700 || focusItemIndex > firstPosIndex + maxItems() - 1 ) )
702 // Scroll to have the wanted stream visible
703 VarPercent &rVarPos = m_rTree.getPositionVar();
704 int indexMax = ( m_flat ? m_rTree.countLeafs()
705 : m_rTree.visibleItems() ) - 1;
706 rVarPos.set( 1.0 - (double)focusItemIndex / (double)indexMax );
712 void CtrlTree::autoScroll()
714 // Find the current playing stream
716 VarTree::Iterator it;
718 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
720 it = m_flat ? m_rTree.getNextLeaf( it )
721 : m_rTree.getNextItem( it ) )
725 m_rTree.ensureExpanded( it );
730 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
732 it = m_flat ? m_rTree.getNextLeaf( it )
733 : m_rTree.getNextVisibleItem( it ) )
737 ensureVisible( playIndex );
745 void CtrlTree::makeImage()
747 stats_TimerStart( getIntf(), "[Skins] Playlist image",
748 STATS_TIMER_SKINS_PLAYTREE_IMAGE );
751 // Get the size of the control
752 const Position *pPos = getPosition();
755 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
758 int width = pPos->getWidth();
759 int height = pPos->getHeight();
761 int i_itemHeight = itemHeight();
764 OSFactory *pOsFactory = OSFactory::instance( getIntf() );
765 m_pImage = pOsFactory->createOSGraphics( width, height );
767 VarTree::Iterator it = m_firstPos;
771 // Draw the background bitmap
772 ScaledBitmap bmp( getIntf(), *m_pBgBitmap, width, height );
773 m_pImage->drawBitmap( bmp, 0, 0 );
775 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
777 if( it != m_rTree.end() )
779 if( (*it).m_selected )
781 int rectHeight = __MIN( i_itemHeight, height - yPos );
782 m_pImage->fillRect( 0, yPos, width, rectHeight,
787 it = m_flat ? m_rTree.getNextLeaf( it )
788 : m_rTree.getNextVisibleItem( it );
789 } while( it != m_rTree.end() && it->m_deleted );
796 // Fill background with background color
797 uint32_t bgColor = m_bgColor1;
798 m_pImage->fillRect( 0, 0, width, height, bgColor );
799 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
801 int rectHeight = __MIN( i_itemHeight, height - yPos );
802 if( it == m_rTree.end() )
803 m_pImage->fillRect( 0, yPos, width, rectHeight, bgColor );
806 uint32_t color = ( it->m_selected ? m_selColor : bgColor );
807 m_pImage->fillRect( 0, yPos, width, rectHeight, color );
810 it = m_flat ? m_rTree.getNextLeaf( it )
811 : m_rTree.getNextVisibleItem( it );
812 } while( it != m_rTree.end() && it->m_deleted );
814 bgColor = ( bgColor == m_bgColor1 ? m_bgColor2 : m_bgColor1 );
818 int bitmapWidth = itemImageWidth();
822 while( it != m_rTree.end() && yPos < height )
824 const GenericBitmap *m_pCurBitmap;
825 UString *pStr = (UString*)(it->m_cString.get());
826 uint32_t color = ( it->m_playing ? m_playColor : m_fgColor );
831 int depth = m_flat ? 1 : it->depth();
832 GenericBitmap *pText = m_rFont.drawString( *pStr, color, width - bitmapWidth * depth );
835 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
839 m_pCurBitmap = it->m_expanded ? m_pOpenBitmap : m_pClosedBitmap;
841 m_pCurBitmap = m_pItemBitmap;
845 // Make sure we are centered on the line
846 int yPos2 = yPos+(i_itemHeight-m_pCurBitmap->getHeight()+1)/2;
847 if( yPos2 >= height )
852 m_pImage->drawBitmap( *m_pCurBitmap, 0, 0,
853 bitmapWidth * (depth - 1 ), yPos2,
854 m_pCurBitmap->getWidth(),
855 __MIN( m_pCurBitmap->getHeight(),
856 height - yPos2), true );
858 yPos += i_itemHeight - pText->getHeight();
865 int lineHeight = __MIN( pText->getHeight() - ySrc, height - yPos );
866 m_pImage->drawBitmap( *pText, 0, ySrc, bitmapWidth * depth, yPos,
869 yPos += (pText->getHeight() - ySrc );
874 it = m_flat ? m_rTree.getNextLeaf( it )
875 : m_rTree.getNextVisibleItem( it );
876 } while( it != m_rTree.end() && it->m_deleted );
878 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
881 VarTree::Iterator CtrlTree::findItemAtPos( int pos )
883 // The first item is m_firstPos.
884 // We decrement pos as we try the other items, until pos == 0.
885 VarTree::Iterator it;
886 for( it = m_firstPos; it != m_rTree.end() && pos != 0;
887 it = m_flat ? m_rTree.getNextLeaf( it )
888 : m_rTree.getNextVisibleItem( it ) )