Tree.h

[詳解]

#if !defined(__FK_TREE_HEADER__)
#define __FK_TREE_HEADER__
 
#include <list>
#include <string>
#include <iostream>
#include <memory>
 
namespace FK {
 
    class fk_Tree;
    class fk_TreeData;
 
 
    class fk_TreeBaseObject {
    public:
        fk_TreeBaseObject(void) {};
        virtual ~fk_TreeBaseObject(void) {};
    };
 
 
 
 
    class fk_TreeData {
 
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        using fk_TDList = std::list<fk_TreeData *>;
        using td_ite = fk_TDList::iterator;
 
        class Member {
        public:
            std::shared_ptr<fk_TreeBaseObject> object;
            fk_Tree *base;
            std::string name;
            fk_TreeData *parent;
            fk_TDList children;
            int depth, maxDepth;
 
            Member(fk_Tree *, const std::string &, fk_TreeData *);
        };
#endif
        friend class fk_Tree;
 
    public:
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        fk_TreeData(fk_Tree *tree, const std::string &name, fk_TreeData *parent);
 
        virtual ~fk_TreeData();
#endif
 
 
        int getDepth(void);
 
 
        int getMaxDepth(void);
 
 
        fk_TreeData * getChild(fk_TreeData *node);
    
 
        fk_TreeData * getParent(void);
 
 
        fk_TreeData * getNext(void);
 
 
        fk_TreeData * getPrev(void);
 
 
        int getOrder(void);
 
 
        int getChildrenSize(void);
 
 
        std::string getName(void);
 
        // ユーザデータの挿入 (デストラクタで同時に消去されたくない場合は,
        // 後ろの引数で false を選択)
 
 
        //void setObject(fk_TreeBaseObject *object, bool deleteFlg = true);
        void setObject(const std::shared_ptr<fk_TreeBaseObject> &object);
 
 
        fk_TreeBaseObject * getObject(void);
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        void Print(void);
#endif
 
    private:
        std::unique_ptr<Member> _m;
 
        void _calcMaxDepth(void);
        void _addChild(fk_TreeData *);
        void _clearChild(fk_TreeData *);
        fk_TDList * _getChildren(void);
    };
 
 
    class fk_Tree {
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        using fk_TList = std::list<std::unique_ptr<fk_TreeData>>;
        using t_ite = fk_TList::iterator;
        
        class Member {
        public:
            fk_TList tree;
            fk_TreeData *root;
 
            Member(void);
        };
#endif
 
    protected:
 
 
        virtual fk_TreeData * makeNewData(fk_Tree *tree,
                                          const std::string name, fk_TreeData *parent);
 
    public:
 
        fk_Tree(const std::string name = "default");
 
        virtual ~fk_Tree();
 
 
        fk_TreeData * getRoot(void);
 
 
        void clear(const std::string name);
 
 
        fk_TreeData * addNewChild(fk_TreeData *parent, const std::string name);
 
 
        bool deleteBranch(fk_TreeData *node);
 
 
        bool clearChildren(fk_TreeData *node);
 
 
        fk_TreeData * cloneOneData(fk_TreeData *parent, fk_TreeData *node);
 
 
        fk_TreeData * cloneBranch(fk_TreeData *parent, fk_TreeData *node);
 
 
        bool moveBranch(fk_TreeData *parent, fk_TreeData *node);
 
 
        void toFront(int n, fk_TreeData *node);
 
 
        void toBack(int n, fk_TreeData *node);
 
        // d が該当の木の中で生存するデータかどうか判定
 
 
        bool isArive(fk_TreeData *node);
 
        // nという名前のデータを検索
 
        fk_TreeData * findData(const std::string name);
 
 
        fk_TreeData * foreachData(fk_TreeData *node);
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        void Print(void);
#endif
 
    private:
        std::unique_ptr<Member> _m;
        
        void _clear(void);
        void _makeRoot(const std::string);
        void _clearData(fk_TreeData *);
        fk_TreeData * _simpleClone(fk_TreeData *, fk_TreeData *);
        int _setDepth(fk_TreeData *, int);
        t_ite _getIte(fk_TreeData *);
    };
}
 
#endif // !__FK_TREE_HEADER__
 
/****************************************************************************
 *
 *  Copyright (c) 1999-2024, Fine Kernel Project, All rights reserved.
 *
 *  Redistribution and use in source and binary forms,
 *  with or without modification, are permitted provided that the
 *  following conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *          copyright notice, this list of conditions and the
 *          following disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *          copyright notice, this list of conditions and the
 *          following disclaimer in the documentation and/or
 *          other materials provided with the distribution.
 *
 *      - Neither the name of the copyright holders nor the names
 *          of its contributors may be used to endorse or promote
 *          products derived from this software without specific
 *          prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 *  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 *  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE. 
 *
 ****************************************************************************/
/****************************************************************************
 *
 *  Copyright (c) 1999-2024, Fine Kernel Project, All rights reserved.
 *
 *  本ソフトウェアおよびソースコードのライセンスは、基本的に
 *  「修正 BSD ライセンス」に従います。以下にその詳細を記します。
 *
 *  ソースコード形式かバイナリ形式か、変更するかしないかを問わず、
 *  以下の条件を満たす場合に限り、再頒布および使用が許可されます。
 *
 *  - ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、
 *      および下記免責条項を含めること。
 *
 *  - バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の
 *      資料に、上記の著作権表示、本条件一覧、および下記免責条項を
 *      含めること。
 *
 *  - 書面による特別の許可なしに、本ソフトウェアから派生した製品の
 *      宣伝または販売促進に、本ソフトウェアの著作権者の名前または
 *      コントリビューターの名前を使用してはならない。
 *
 *  本ソフトウェアは、著作権者およびコントリビューターによって「現
 *  状のまま」提供されており、明示黙示を問わず、商業的な使用可能性、
 *  および特定の目的に対する適合性に関す暗黙の保証も含め、またそれ
 *  に限定されない、いかなる保証もないものとします。著作権者もコン
 *  トリビューターも、事由のいかんを問わず、損害発生の原因いかんを
 *  問わず、かつ責任の根拠が契約であるか厳格責任であるか(過失その
 *  他の)不法行為であるかを問わず、仮にそのような損害が発生する可
 *  能性を知らされていたとしても、本ソフトウェアの使用によって発生
 *  した(代替品または代用サービスの調達、使用の喪失、データの喪失、
 *  利益の喪失、業務の中断も含め、またそれに限定されない)直接損害、
 *  間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害に
 *  ついて、一切責任を負わないものとします。
 *
 ****************************************************************************/