var_tree.hpp
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:6k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * var_tree.hpp
  3.  *****************************************************************************
  4.  * Copyright (C) 2005 the VideoLAN team
  5.  * $Id: ad269bbdfecc20e112de304b29970788214850dc $
  6.  *
  7.  * Authors: Antoine Cellerier <dionoea@videolan.org>
  8.  *          Clément Stenac <zorglub@videolan.org>
  9.  *
  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.
  14.  *
  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.
  19.  *
  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.  *****************************************************************************/
  24. #ifndef VAR_TREE_HPP
  25. #define VAR_TREE_HPP
  26. #include <list>
  27. #include "variable.hpp"
  28. #include "observer.hpp"
  29. #include "ustring.hpp"
  30. #include "var_percent.hpp"
  31. /// Description of an update to the tree
  32. typedef struct tree_update
  33. {
  34.      int i_type;
  35.      int i_parent;
  36.      int i_id;
  37.      bool b_active_item;
  38.      bool b_visible;
  39. } tree_update;
  40. /// Tree variable
  41. class VarTree: public Variable, public Subject<VarTree, tree_update>
  42. {
  43.     public:
  44.         VarTree( intf_thread_t *pIntf );
  45.         VarTree( intf_thread_t *pIntf, VarTree *pParent, int id,
  46.                  const UStringPtr &rcString, bool selected, bool playing,
  47.                  bool expanded,bool readonly, void *pData );
  48.         virtual ~VarTree();
  49.         /// Get the variable type
  50.         virtual const string &getType() const { return m_type; }
  51.         /// Add a pointer on string in the children's list
  52.         virtual void add( int id, const UStringPtr &rcString, bool selected,
  53.                           bool playing, bool expanded, bool readonly,
  54.                           void *pData );
  55.         /// Remove the selected item from the children's list
  56.         virtual void delSelected();
  57.         /// Remove all elements from the children's list
  58.         virtual void clear();
  59.         /// todo Use accessors for these fields ?
  60.         int m_id;
  61.         UStringPtr m_cString;
  62.         bool m_selected;
  63.         bool m_playing;
  64.         bool m_expanded;
  65.         bool m_deleted;
  66.         void *m_pData;
  67.         inline bool isReadonly() { return m_readonly; };
  68.         /// Get the number of children
  69.         int size() const { return m_children.size(); }
  70.         /// Iterators
  71.         typedef list<VarTree>::iterator Iterator;
  72.         typedef list<VarTree>::const_iterator ConstIterator;
  73.         /// Begining of the children's list
  74.         Iterator begin() { return m_children.begin(); }
  75.         ConstIterator begin() const { return m_children.begin(); }
  76.         /// End of children's list
  77.         Iterator end() { return m_children.end(); }
  78.         ConstIterator end() const { return m_children.end(); }
  79.         /// Back of children's list
  80.         VarTree &back() { return m_children.back(); }
  81.         /// Return an iterator on the n'th element of the children's list
  82.         Iterator operator[]( int n );
  83.         ConstIterator operator[]( int n ) const;
  84.         /// Parent node
  85.         VarTree *parent() { return m_pParent; }
  86.         void checkParents( VarTree *pParent );
  87.         /// Get next sibling
  88.         Iterator getNextSibling( Iterator );
  89.         Iterator next_uncle();
  90.         Iterator prev_uncle();
  91.         /// Get root node
  92.         VarTree *root()
  93.         {
  94.             VarTree *parent = this;
  95.             while( parent->parent() != NULL )
  96.                 parent = parent->parent();
  97.             return parent;
  98.         }
  99.         /// Get first leaf
  100.         Iterator firstLeaf();
  101.         void removeChild( VarTree::Iterator item )
  102.         {
  103.             m_children.erase( item );
  104.         }
  105.         /// Execute the action associated to this item
  106.         virtual void action( VarTree *pItem ) {}
  107.         /// Get a reference on the position variable
  108.         VarPercent &getPositionVar() const
  109.         { return *((VarPercent*)m_cPosition.get()); }
  110.         /// Get a counted pointer on the position variable
  111.         const VariablePtr &getPositionVarPtr() const { return m_cPosition; }
  112.         /// Count the number of items that should be displayed if the playlist window wasn't limited
  113.         int visibleItems();
  114.         /// Count the number of leafs in the tree
  115.         int countLeafs();
  116.         /// Return iterator to the n'th visible item
  117.         Iterator getVisibleItem( int n );
  118.         /// Return iterator to the n'th leaf
  119.         Iterator getLeaf( int n );
  120.         /// Given an iterator to a visible item, return the next visible item
  121.         Iterator getNextVisibleItem( Iterator it );
  122.         /// Given an it to a visible item, return the previous visible item
  123.         Iterator getPrevVisibleItem( Iterator it );
  124.         /// Given an iterator to an item, return the next item
  125.         Iterator getNextItem( Iterator it );
  126.         /// Given an iterator to an item, return the previous item
  127.         Iterator getPrevItem( Iterator it );
  128.         /// Given an iterator to an item, return the next leaf
  129.         Iterator getNextLeaf( Iterator it );
  130.         /// Given an iterator to an item, return the previous leaf
  131.         Iterator getPrevLeaf( Iterator it );
  132.         /// Find a children node with the given id
  133.         Iterator findById( int id );
  134.         /// Ensure an item is expanded
  135.         void ensureExpanded( VarTree::Iterator );
  136.         /// Get depth (root depth is 0)
  137.         int depth()
  138.         {
  139.             VarTree *parent = this;
  140.             int depth = 0;
  141.             while( ( parent = parent->parent() ) != NULL )
  142.                 depth++;
  143.             return depth;
  144.         }
  145.     private:
  146.         /// List of children
  147.         list<VarTree> m_children;
  148.         /// Pointer to parent node
  149.         VarTree *m_pParent;
  150.         bool m_readonly;
  151.         /// Variable type
  152.         static const string m_type;
  153.         /// Position variable
  154.         VariablePtr m_cPosition;
  155. };
  156. #endif