/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_SW_INC_SWNUMBERTREE_HXX #define INCLUDED_SW_INC_SWNUMBERTREE_HXX #include #include #include #include class SwNumberTreeNode; bool SwNumberTreeNodeLessThan (const SwNumberTreeNode * pA, const SwNumberTreeNode * pB); struct compSwNumberTreeNodeLessThan { bool operator()(const SwNumberTreeNode * pA, const SwNumberTreeNode * pB) const { return SwNumberTreeNodeLessThan(pA, pB); } }; /** A tree of numbered nodes. Simple example: 
   1. kshdkjfs
     1.1. lskjf
   2. sdfjlksaf
   3. fkaoslk
     3.1. lfjlaskf
     3.2. jaslkjflsf
       3.2.1. hkljhkjhk

   + R
     + 1 kshdkjfs
     | + 1 lskjf
     + 2 sdfjlksaf
     + 3 fkaoslk
       + 1 lfjlaskf
       + 2 jaslkjflsf
         + 1 hkljhkjhk
The root contains the nodes of the first level. Each node A of the first level contains those nodes of the second level that have the same first level number as A and so on for the subsidiary levels. The numbering label of a node A is resolved by concatenating the numbers of the nodes on the path from the root to A. ------------------------------------------ Phantoms A phantom is an auxiliary node that is used to emulate numberings starting with nodes not at top level. The phantom contains the number for the level but is not considered part of the numbering. Constraint 1: A phantom is always the first child node. Constraint 2: At each node there is at most one child that is a phantom. Constraint 3: A phantom is the smallest of all numbering nodes. Uncounted Phantoms 0.1. dljflskjlasf 5. abcdagaha 5.1. + R (nStart = 5) + 0 (phantom, not counted) | + 1 dljflskjlasf + 5 abcdagaha + 1 The phantom gets numbered with 0. The first non-phantom node gets numbered with the start value. ----------------------------------------- Counted Phantoms 5.1. lgkjjgklg 6. lkjfalskjflsaf 6.1. ljdflaksjflkjasflkjsf + R (nStart = 5) + 5 (phantom, counted) | + 1 lgkjjgklg + 6 lkjfalskjflsaf + 1 ljdflaksjflkjasflkjsf The phantom gets numbered with the start value. */ class SW_DLLPUBLIC SwNumberTreeNode { protected: typedef std::set tSwNumberTreeChildren; public: SwNumberTreeNode(); virtual ~SwNumberTreeNode(); /** Add a child. @param pChild child to add @param nDepth depth in which to add the child */ void AddChild( SwNumberTreeNode* pChild, const int nDepth ); /** Remove a child. @param pChild child to be removed */ void RemoveChild( SwNumberTreeNode* pChild ); /** Remove this child from the tree. */ void RemoveMe(); /** Returns the parent of this node. @return the parent */ inline SwNumberTreeNode* GetParent() const { return mpParent; } /** Returns number of this node. @param bValidate validate the number? @return number of this node */ SwNumberTree::tSwNumTreeNumber GetNumber( bool bValidate = true ) const; bool IsContinueingPreviousSubTree() const { return mbContinueingPreviousSubTree;} /** Returns level numbers of this node. @return level numbers of this node */ SwNumberTree::tNumberVector GetNumberVector() const; /** Return if numbering is restarted at this node. */ virtual bool IsRestart() const = 0; /** Return start value. @return start value */ virtual SwNumberTree::tSwNumTreeNumber GetStartValue() const = 0; /** Return if this node is counted. @retval true this node is counted @retval false this node is NOT counted */ virtual bool IsCounted() const; /** Return if this node is counted continuous. @retval true This node is counted continuous. @retval false else */ virtual bool IsContinuous() const = 0; /** Return if a node is first non-phantom child of this node. @param pNode the node to check @retval true pNode is first child of this node @retval false else */ bool IsFirst(const SwNumberTreeNode * pNode) const; /** Return if this node if the first non-phantom node in the tree. @retval true this node is the first non-phantom node in the tree @retval false else */ bool IsFirst() const; /** Return if this node is a phantom. @retval true this node is a phantom @retval false this node is NOT a phantom */ bool IsPhantom() const { return mbPhantom;} /** set level of this node precondition: node is already member of a list tree @author OD */ void SetLevelInListTree( const int nLevel ); /** Return level of this node. The level of this node is the length of the path from the root to this node. @return the level of this node */ int GetLevelInListTree() const; /** Returns if this node is less than another node. @param rTreeNode node to compare with @attention A phantom node is considered the least element with respect to lessThan. @retval true this node is less than rTreeNode @retval false else */ virtual bool LessThan(const SwNumberTreeNode & rTreeNode) const; /** Invalidate this node and all its descendants. All iterators holding the last valid node in the according list of children are set to the end of this list, thereby stating all children in the list are invalid. #i83479# - made public */ void InvalidateTree() const; /** Notifies all invalid children of this node. #i83479# - made public */ void NotifyInvalidChildren(); /** Notifies the node. Calls Invalidate(this) on parent. */ void InvalidateMe(); /** Validate the tree. Validates all nodes in this subtree. */ void ValidateTree(); /** Validates this node. Calls Validate(this) on parent. */ void ValidateMe(); /** Notifies all invalid siblings of this node. */ void NotifyInvalidSiblings(); /** notification of all nodes in the list tree on certain list level */ void NotifyNodesOnListLevel( const int nListLevel ); /** Invalidation and notification of complete numbering tree #i64010# Usage: on state change its needed to invalidate the complete numbering tree due to wide influence of this change. */ inline void InvalidateAndNotifyTree() { if ( GetRoot() ) { GetRoot()->InvalidateTree(); GetRoot()->Notify(); } } /** Returns the greatest descendant of the root that is smaller than this node, aka the predecessor of this node. @return the predecessor */ SwNumberTreeNode* GetPred( bool bSibling = false ) const; /** determines the node, which is preceding the node #i81002# The search for the preceding node is performed for the tree below the node. To search the complete tree, the method has been called for the root of the tree. @author OD */ const SwNumberTreeNode* GetPrecedingNodeOf( const SwNumberTreeNode& rNode ) const; #ifdef __SW_NUMBER_TREE_SANITY_CHECK /** Sanity check. @param bRecursive descend to children @retval true the structure of this node is sane @retval false else */ bool IsSane(bool bRecursive) const; #endif // __SW_NUMBER_TREE_SANITY_CHECK protected: /** the children */ tSwNumberTreeChildren mChildren; /** Returns the root node of the tree this node is part of. Important note: method call GetRoot()> returns NULL. @return the root */ SwNumberTreeNode* GetRoot() const; /** Return if the notification is not disabled on global conditions @retval true Notification enabled in general. @retval false else */ virtual bool IsNotificationEnabled() const = 0; /** Returns how many children this node has got. @return number of children */ tSwNumberTreeChildren::size_type GetChildCount() const; // #i64010# - made pure virtual virtual bool HasCountedChildren() const = 0; // #i64010# virtual bool IsCountedForNumbering() const = 0; // method called before this tree node has been added to the list tree virtual void PreAdd() = 0; // method called after this tree node has been removed from the list tree virtual void PostRemove() = 0; #ifdef __SW_NUMBER_TREE_SANITY_CHECK /** Sanity check with loop detection. @param bRecursive descend to children @param rParents vector for recording path @retval true this node is sane @retval false else */ virtual bool IsSane (bool bRecursive, std::vector rParents) const; #endif // __SW_NUMBER_TREE_SANITY_CHECK /** the parent node */ SwNumberTreeNode * mpParent; /** the number of the node */ mutable SwNumberTree::tSwNumTreeNumber mnNumber; // boolean indicating, that a node of a not counted parent node is continuing // the numbering of parent's previous node sub tree. // Example: // 1. kshdkjfs // 1.1. lskjf // sdfjlksaf <-- not counted parent node // 1.2. lfjlaskf <-- mutable bool mbContinueingPreviousSubTree; /** true this node is a phantom false this node is NOT a phantom */ bool mbPhantom; /** Iterator to the last valid element. All children that are less than or equal to the referenced child are valid. All children greater than the referenced child are invalid. */ mutable tSwNumberTreeChildren::const_iterator mItLastValid; SwNumberTreeNode(const SwNumberTreeNode& ); SwNumberTreeNode& operator=( const SwNumberTreeNode& ); /** Calls GetNumberVector_ on parent and adds number of this node at the end. @param rVector return value @param bValidate validate the number? */ void GetNumberVector_( SwNumberTree::tNumberVector& rVector, bool bValidate = true ) const; /** Invalidates a child. Calls SetLastValid for the preceding sibling of the child and notifies all invalid children. @param pChild the child to invalidate */ void Invalidate( SwNumberTreeNode * pChild ); /** Invalidation of all children Usage: on state change the children have to be invalidated */ inline void InvalidateChildren() { SetLastValid( mChildren.end() ); } /** Set the last valid child of this node. @param aItLastValid iterator pointing to the new last valid child @param bValidating - true always set the last valid node to aItLastValid - false only set if aItLastValid is preceding the current last valid node */ void SetLastValid(const tSwNumberTreeChildren::const_iterator& aItLastValid, bool bValidating = false) const; /** Return if this node is notifiable. @attention If a not is not notifiable a notify request is *not* forwarded to its descendants. @retval true This node is notifiable. @retval false else */ virtual bool IsNotifiable() const = 0; /** Notifies the node. Called when the number of the node got invalid. */ virtual void NotifyNode() = 0; /** Notifies this node (NotifyNode) and all descendants. */ void Notify(); /** notification of children nodes on certain depth @author OD */ void NotifyChildrenOnDepth( const int nDepth ); /** Returns if a child A this node is valid. A is valid if aItLastValid in parent refers to a node greater than of equal to A. @param pChild child to be tested @retval true this node is valid @retval false this node is NOT valid */ bool IsValid(const SwNumberTreeNode * pChild) const; /** Returns if this node is valid. @retval true this node is valid @retval false else */ bool IsValid() const; /** Validates a child. @param pNode child to be validated @attention All invalid children preceding pNode are validated, too. */ void Validate(const SwNumberTreeNode * pNode) const; /** Validates a child using hierarchical numbering. @param pNode child to be validated @attention All invalid children preceding pNode are validated, too. */ void ValidateHierarchical(const SwNumberTreeNode * pNode) const; /** Validates a child using continuous numbering. @param pNode child to be validated @attention All invalid children preceding pNode are validated, too. */ void ValidateContinuous(const SwNumberTreeNode * pNode) const; /** Creates a new node of the same class. @return the new node */ virtual SwNumberTreeNode * Create() const = 0; /** Creates a phantom. @return the created phantom */ SwNumberTreeNode * CreatePhantom(); /** Return if phantoms are counted. */ virtual bool IsCountPhantoms() const = 0; /** Return if all descendants of this node are phantoms. */ bool HasOnlyPhantoms() const; bool HasPhantomCountedParent() const; /** HB, OD : return node, if it isn't a phantom, otherwise return first non-phantom descendant. Returns the first child of this node that is NOT a phantom. @return the first non phantom child */ SwNumberTreeNode* GetFirstNonPhantomChild(); /** Removes recursively phantoms that have no children. The resulting tree has no phantoms that either have no children or whose descendancy consist entirely of phantoms. */ void ClearObsoletePhantoms(); tSwNumberTreeChildren::const_iterator GetIterator(const SwNumberTreeNode * pChild) const; /** Moves all children to a given destination node. @param pDest the destination node */ void MoveChildren(SwNumberTreeNode * pDest); /** Moves all children of this node that are greater than a given node to the destination node. distinguish between node for comparing, whose children are greater, and the destination node. @param _rCompareNode input parameter - reference to the node, which is used to determine the greater children @param _rDestNode input parameter - reference to the node, which is the destination for the greater children */ void MoveGreaterChildren( SwNumberTreeNode& _rCompareNode, SwNumberTreeNode& _rDestNode ); /** Returns the last descendant of a node, if it has children. @return last descendant of the node */ SwNumberTreeNode* GetLastDescendant() const; }; #endif // INCLUDED_SW_INC_SWNUMBERTREE_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */