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 );
87 int CtrlTree::itemHeight()
89 int itemHeight = m_rFont.getSize();
94 itemHeight = __MAX( m_pClosedBitmap->getHeight(), itemHeight );
98 itemHeight = __MAX( m_pOpenBitmap->getHeight(), itemHeight );
103 itemHeight = __MAX( m_pItemBitmap->getHeight(), itemHeight );
105 itemHeight += LINE_INTERVAL;
109 int CtrlTree::itemImageWidth()
114 if( m_pClosedBitmap )
116 bitmapWidth = __MAX( m_pClosedBitmap->getWidth(), bitmapWidth );
120 bitmapWidth = __MAX( m_pOpenBitmap->getWidth(), bitmapWidth );
125 bitmapWidth = __MAX( m_pItemBitmap->getWidth(), bitmapWidth );
127 return bitmapWidth + 2;
130 int CtrlTree::maxItems()
132 const Position *pPos = getPosition();
137 return pPos->getHeight() / itemHeight();
141 void CtrlTree::onUpdate( Subject<VarTree, tree_update> &rTree,
144 if( arg->i_type == 0 ) // Item update
146 if( arg->b_active_item )
149 ///\todo We should make image if we are visible in the view
153 /// \todo handle delete in a more clever way
154 else if ( arg->i_type == 1 ) // Global change or deletion
156 m_firstPos = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
159 else if ( arg->i_type == 2 ) // Item-append
161 if( m_flat && m_firstPos->size() )
162 m_firstPos = m_rTree.getNextLeaf( m_firstPos );
163 /// \todo Check if the item is really visible in the view
164 // (we only check if it in the document)
165 if( arg->b_visible == true )
170 else if( arg->i_type == 3 ) // item-del
172 /* Make sure firstPos and lastSelected are still valid */
173 while( m_firstPos->m_deleted && m_firstPos != m_rTree.root()->begin() )
175 m_firstPos = m_flat ? m_rTree.getPrevLeaf( m_firstPos )
176 : m_rTree.getPrevVisibleItem( m_firstPos );
178 if( m_firstPos->m_deleted )
179 m_firstPos = m_flat ? m_rTree.firstLeaf()
180 : m_rTree.root()->begin();
182 if( arg->b_visible == true )
190 void CtrlTree::onUpdate( Subject<VarPercent> &rPercent, void* arg)
192 // Determine what is the first item to display
193 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
195 if( m_dontMove ) return;
199 excessItems = m_rTree.countLeafs() - maxItems();
201 excessItems = m_rTree.visibleItems() - maxItems();
205 VarPercent &rVarPos = m_rTree.getPositionVar();
206 // a simple (int)(...) causes rounding errors !
211 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
213 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
215 if( m_firstPos != it )
217 // Redraw the control if the position has changed
224 void CtrlTree::onResize()
226 // Determine what is the first item to display
227 VarTree::Iterator it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
231 excessItems = m_rTree.countLeafs() - maxItems();
233 excessItems = m_rTree.visibleItems() - maxItems();
237 VarPercent &rVarPos = m_rTree.getPositionVar();
238 // a simple (int)(...) causes rounding errors !
243 it = m_rTree.getLeaf(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
245 it = m_rTree.getVisibleItem(lrint( (1.0 - rVarPos.get()) * (double)excessItems ) + 1 );
247 // Redraw the control if the position has changed
253 void CtrlTree::onPositionChange()
259 void CtrlTree::handleEvent( EvtGeneric &rEvent )
261 bool bChangedPosition = false;
262 VarTree::Iterator toShow; bool needShow = false;
263 if( rEvent.getAsString().find( "key:down" ) != string::npos )
265 int key = ((EvtKey&)rEvent).getKey();
266 VarTree::Iterator it;
267 bool previousWasSelected = false;
269 /* Delete the selection */
270 if( key == KEY_DELETE )
272 /* Find first non selected item before m_pLastSelected */
273 VarTree::Iterator it_sel = m_flat ? m_rTree.firstLeaf()
275 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
277 it = m_flat ? m_rTree.getNextLeaf( it )
278 : m_rTree.getNextVisibleItem( it ) )
280 if( &*it == m_pLastSelected ) break;
281 if( !it->m_selected ) it_sel = it;
284 /* Delete selected stuff */
285 m_rTree.delSelected();
288 it_sel->m_selected = true;
289 m_pLastSelected = &*it_sel;
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() )
317 else if (key == KEY_PAGEUP )
321 while( i >= maxItems()/2 )
323 it = m_flat ? m_rTree.getPrevLeaf( it )
324 : m_rTree.getPrevVisibleItem( it );
325 /* End is already visible, dont' scroll */
326 if( it == ( m_flat ? m_rTree.firstLeaf() : m_rTree.begin() ) )
339 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
341 it = m_flat ? m_rTree.getNextLeaf( it )
342 : m_rTree.getNextVisibleItem( it ) )
344 VarTree::Iterator next = m_flat ? m_rTree.getNextLeaf( it )
345 : m_rTree.getNextVisibleItem( it );
348 // Scroll up one item
350 && it != it->parent()->begin() )
351 || &*it != m_pLastSelected )
353 bool nextWasSelected = ( &*next == m_pLastSelected );
354 it->m_selected = nextWasSelected;
355 if( nextWasSelected )
357 m_pLastSelected = &*it;
358 needShow = true; toShow = it;
362 else if( key == KEY_DOWN )
364 // Scroll down one item
366 && next != it->parent()->end() )
367 || &*it != m_pLastSelected )
369 (*it).m_selected = previousWasSelected;
371 if( previousWasSelected )
373 m_pLastSelected = &*it;
374 needShow = true; toShow = it;
375 previousWasSelected = false;
379 previousWasSelected = ( &*it == m_pLastSelected );
382 // Fix last tree item selection
383 if( ( m_flat ? m_rTree.getNextLeaf( it )
384 : m_rTree.getNextVisibleItem( it ) ) == m_rTree.end()
385 && &*it == m_pLastSelected )
387 (*it).m_selected = true;
390 else if( key == KEY_RIGHT )
392 // Go down one level (and expand node)
393 if( &*it == m_pLastSelected )
399 it->m_selected = false;
400 it->begin()->m_selected = true;
401 m_pLastSelected = &*(it->begin());
405 m_rTree.action( &*it );
410 it->m_expanded = true;
411 bChangedPosition = true;
415 else if( key == KEY_LEFT )
417 // Go up one level (and close node)
418 if( &*it == m_pLastSelected )
420 if( it->m_expanded && it->size() )
422 it->m_expanded = false;
423 bChangedPosition = true;
427 if( it->parent() && it->parent() != &m_rTree)
429 it->m_selected = false;
430 m_pLastSelected = it->parent();
431 m_pLastSelected->m_selected = true;
436 else if( key == KEY_ENTER || key == KEY_SPACE )
438 // Go up one level (and close node)
439 if( &*it == m_pLastSelected )
441 m_rTree.action( &*it );
446 ensureVisible( toShow );
448 // Redraw the control
453 else if( rEvent.getAsString().find( "mouse:left" ) != string::npos )
455 EvtMouse &rEvtMouse = (EvtMouse&)rEvent;
456 const Position *pos = getPosition();
457 int yPos = ( rEvtMouse.getYPos() - pos->getTop() ) / itemHeight();
458 int xPos = rEvtMouse.getXPos() - pos->getLeft();
459 VarTree::Iterator it;
461 if( rEvent.getAsString().find( "mouse:left:down:ctrl,shift" ) !=
464 VarTree::Iterator itClicked = findItemAtPos( yPos );
465 // Flag to know if the current item must be selected
467 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
469 it = m_flat ? m_rTree.getNextLeaf( it )
470 : m_rTree.getNextVisibleItem( it ) )
472 bool nextSelect = select;
473 if( it == itClicked || &*it == m_pLastSelected )
485 it->m_selected = (*it).m_selected || select;
489 else if( rEvent.getAsString().find( "mouse:left:down:ctrl" ) !=
492 // Invert the selection of the item
493 it = findItemAtPos( yPos );
494 if( it != m_rTree.end() )
496 it->m_selected = !it->m_selected;
497 m_pLastSelected = &*it;
500 else if( rEvent.getAsString().find( "mouse:left:down:shift" ) !=
503 VarTree::Iterator itClicked = findItemAtPos( yPos );
504 // Flag to know if the current item must be selected
506 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
508 it = m_flat ? m_rTree.getNextLeaf( it )
509 : m_rTree.getNextVisibleItem( it ) )
511 bool nextSelect = select;
512 if( it == itClicked || &*it == m_pLastSelected )
524 it->m_selected = select;
528 else if( rEvent.getAsString().find( "mouse:left:down" ) !=
531 it = findItemAtPos(yPos);
532 if( it != m_rTree.end() )
534 if( ( it->size() && xPos > (it->depth() - 1) * itemImageWidth()
535 && xPos < it->depth() * itemImageWidth() )
538 // Fold/unfold the item
539 it->m_expanded = !it->m_expanded;
540 bChangedPosition = true;
544 // Unselect any previously selected item
545 VarTree::Iterator it2;
546 for( it2 = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
547 it2 != m_rTree.end();
548 it2 = m_flat ? m_rTree.getNextLeaf( it2 )
549 : m_rTree.getNextVisibleItem( it2 ) )
551 it2->m_selected = false;
553 // Select the new item
554 if( it != m_rTree.end() )
556 it->m_selected = true;
557 m_pLastSelected = &*it;
563 else if( rEvent.getAsString().find( "mouse:left:dblclick" ) !=
566 it = findItemAtPos(yPos);
567 if( it != m_rTree.end() )
569 // Execute the action associated to this item
570 m_rTree.action( &*it );
573 // Redraw the control
578 else if( rEvent.getAsString().find( "scroll" ) != string::npos )
580 int direction = ((EvtScroll&)rEvent).getDirection();
582 double percentage = m_rTree.getPositionVar().get();
583 double step = 2.0 / (double)( m_flat ? m_rTree.countLeafs()
584 : m_rTree.visibleItems() );
585 if( direction == EvtScroll::kUp )
593 m_rTree.getPositionVar().set( percentage );
596 /* We changed the nodes, let's fix teh position var */
597 if( bChangedPosition )
599 VarTree::Iterator it;
602 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
604 it = m_flat ? m_rTree.getNextLeaf( it )
605 : m_rTree.getNextVisibleItem( it ) )
608 if( it == m_firstPos )
614 iFirst += maxItems();
615 if( iFirst >= m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems() )
616 iFirst = m_flat ? m_rTree.countLeafs() : m_rTree.visibleItems();
617 float f_new = (float)iFirst / (float)( m_flat ? m_rTree.countLeafs()
618 :m_rTree.visibleItems() );
620 m_rTree.getPositionVar().set( 1.0 - f_new );
625 bool CtrlTree::mouseOver( int x, int y ) const
627 const Position *pPos = getPosition();
629 ? x >= 0 && x <= pPos->getWidth() && y >= 0 && y <= pPos->getHeight()
633 void CtrlTree::draw( OSGraphics &rImage, int xDest, int yDest )
637 rImage.drawGraphics( *m_pImage, 0, 0, xDest, yDest );
641 bool CtrlTree::ensureVisible( VarTree::Iterator item )
643 // Find the item to focus
644 int focusItemIndex = 0;
645 VarTree::Iterator it;
647 m_rTree.ensureExpanded( item );
649 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
651 it = m_flat ? m_rTree.getNextLeaf( it )
652 : m_rTree.getNextVisibleItem( it ) )
654 if( it->m_id == item->m_id ) break;
657 return ensureVisible( focusItemIndex );
660 bool CtrlTree::ensureVisible( int focusItemIndex )
663 VarTree::Iterator it;
664 int firstPosIndex = 0;
665 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
667 it = m_flat ? m_rTree.getNextLeaf( it )
668 : m_rTree.getNextVisibleItem( it ) )
670 if( it == m_firstPos ) break;
674 if( it == m_rTree.end() ) return false;
677 if( it != m_rTree.end()
678 && ( focusItemIndex < firstPosIndex
679 || focusItemIndex > firstPosIndex + maxItems() ) )
681 // Scroll to have the wanted stream visible
682 VarPercent &rVarPos = m_rTree.getPositionVar();
683 rVarPos.set( 1.0 - (double)focusItemIndex /
684 (double)( m_flat ? m_rTree.countLeafs()
685 : m_rTree.visibleItems() ) );
691 void CtrlTree::autoScroll()
693 // Find the current playing stream
695 VarTree::Iterator it;
697 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
699 it = m_flat ? m_rTree.getNextLeaf( it )
700 : m_rTree.getNextItem( it ) )
704 m_rTree.ensureExpanded( it );
708 for( it = m_flat ? m_rTree.firstLeaf() : m_rTree.begin();
710 it = m_flat ? m_rTree.getNextLeaf( it )
711 : m_rTree.getNextVisibleItem( it ) )
718 if( it == m_rTree.end() ) return;
721 ensureVisible( playIndex );
725 void CtrlTree::makeImage()
727 stats_TimerStart( getIntf(), "[Skins] Playlist image",
728 STATS_TIMER_SKINS_PLAYTREE_IMAGE );
731 // Get the size of the control
732 const Position *pPos = getPosition();
735 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
738 int width = pPos->getWidth();
739 int height = pPos->getHeight();
741 int i_itemHeight = itemHeight();
744 OSFactory *pOsFactory = OSFactory::instance( getIntf() );
745 m_pImage = pOsFactory->createOSGraphics( width, height );
747 VarTree::Iterator it = m_firstPos;
751 // Draw the background bitmap
752 ScaledBitmap bmp( getIntf(), *m_pBgBitmap, width, height );
753 m_pImage->drawBitmap( bmp, 0, 0 );
755 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
757 if( it != m_rTree.end() )
759 if( (*it).m_selected )
761 int rectHeight = __MIN( i_itemHeight, height - yPos );
762 m_pImage->fillRect( 0, yPos, width, rectHeight,
767 it = m_flat ? m_rTree.getNextLeaf( it )
768 : m_rTree.getNextVisibleItem( it );
769 } while( it != m_rTree.end() && it->m_deleted );
776 // Fill background with background color
777 uint32_t bgColor = m_bgColor1;
778 m_pImage->fillRect( 0, 0, width, height, bgColor );
779 for( int yPos = 0; yPos < height; yPos += i_itemHeight )
781 int rectHeight = __MIN( i_itemHeight, height - yPos );
782 if( it != m_rTree.end() )
784 uint32_t color = ( it->m_selected ? m_selColor : bgColor );
785 m_pImage->fillRect( 0, yPos, width, rectHeight, color );
788 it = m_flat ? m_rTree.getNextLeaf( it )
789 : m_rTree.getNextVisibleItem( it );
790 } while( it != m_rTree.end() && it->m_deleted );
794 m_pImage->fillRect( 0, yPos, width, rectHeight, bgColor );
796 bgColor = ( bgColor == m_bgColor1 ? m_bgColor2 : m_bgColor1 );
800 int bitmapWidth = itemImageWidth();
804 while( it != m_rTree.end() && yPos < height )
806 const GenericBitmap *m_pCurBitmap;
807 UString *pStr = (UString*)(it->m_cString.get());
808 uint32_t color = ( it->m_playing ? m_playColor : m_fgColor );
813 int depth = m_flat ? 1 : it->depth();
814 GenericBitmap *pText = m_rFont.drawString( *pStr, color, width - bitmapWidth * depth );
817 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
821 m_pCurBitmap = it->m_expanded ? m_pOpenBitmap : m_pClosedBitmap;
823 m_pCurBitmap = m_pItemBitmap;
827 // Make sure we are centered on the line
828 int yPos2 = yPos+(i_itemHeight-m_pCurBitmap->getHeight()+1)/2;
829 if( yPos2 >= height )
834 m_pImage->drawBitmap( *m_pCurBitmap, 0, 0,
835 bitmapWidth * (depth - 1 ), yPos2,
836 m_pCurBitmap->getWidth(),
837 __MIN( m_pCurBitmap->getHeight(),
838 height - yPos2), true );
840 yPos += i_itemHeight - pText->getHeight();
847 int lineHeight = __MIN( pText->getHeight() - ySrc, height - yPos );
848 m_pImage->drawBitmap( *pText, 0, ySrc, bitmapWidth * depth, yPos,
851 yPos += (pText->getHeight() - ySrc );
856 it = m_flat ? m_rTree.getNextLeaf( it )
857 : m_rTree.getNextVisibleItem( it );
858 } while( it != m_rTree.end() && it->m_deleted );
860 stats_TimerStop( getIntf(), STATS_TIMER_SKINS_PLAYTREE_IMAGE );
863 VarTree::Iterator CtrlTree::findItemAtPos( int pos )
865 // The first item is m_firstPos.
866 // We decrement pos as we try the other items, until pos == 0.
867 VarTree::Iterator it;
868 for( it = m_firstPos; it != m_rTree.end() && pos != 0;
869 it = m_flat ? m_rTree.getNextLeaf( it )
870 : m_rTree.getNextVisibleItem( it ) )