file_tree.h

Go to the documentation of this file.

#ifndef FILE_TREE_H
#define FILE_TREE_H
/***************************************************************************
 *   Copyright (C) 2004, 2006 Symbian Software Ltd.                        *
 *   All rights reserved.                                                  *
 *   Copyright (C) 2007-2011 Mike Kinghan, imk@strudl.org                  *
 *   All rights reserved.                                                  *
 *                                                                         *
 *   Contributed originally by Mike Kinghan, imk@strudl.org                *
 *                                                                         *
 *   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 Symbian Software Ltd. 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.                                                               *
 *                                                                         *
 **************************************************************************/
#include "bool.h"
#include "memory.h"


#define FT_LAST         ((size_t)-1)

typedef enum {
    FT_ENTERING_TREE = -2,      
    FT_ENTERING_DIR     = -1,   
    FT_AT_FILE = 0,             
    FT_LEAVING_DIR      = 1,    
    FT_LEAVING_TREE = 2         
} file_tree_traverse_state_t;

enum file_tree_count_flags {
    FT_COUNT_FILES = 1, 
    FT_COUNT_DIRS = 2,  
    FT_COUNT_ALL = FT_COUNT_FILES | FT_COUNT_DIRS, 
    FT_COUNT_CHILDREN = 4 
};

typedef struct file_tree * file_tree_h;

typedef struct file_tree const * file_tree_const_h;

typedef struct {
    size_t files;               
    size_t dirs;                
    size_t children;    
} file_tree_count_t;

typedef void (*file_tree_callback_t)(   file_tree_h ft,
                                        char const *name,
                                        file_tree_traverse_state_t context);

typedef bool (*file_filter_t)(char const *leafname);


extern heap_str
file_tree_name(file_tree_const_h ft);

extern file_tree_h
file_tree_new(void);

extern file_tree_h
file_tree_copy(file_tree_const_h src);

extern void
file_tree_swap(file_tree_h lhs, file_tree_h rhs);

extern void
file_tree_assign(file_tree_h dest, file_tree_const_h src);

extern bool
file_tree_equal(file_tree_const_h lhs, file_tree_const_h rhs);

extern bool
file_tree_set_filter(file_tree_h ft, file_filter_t filter);


extern void
file_tree_add(  file_tree_h parent,
                char const *path,
                file_tree_callback_t callback);


extern void
file_tree_dispose(file_tree_h ft);

extern void
file_tree_traverse(     file_tree_h ft,
                    file_tree_callback_t callback);


extern bool
file_tree_is_empty(file_tree_const_h ft);

extern size_t
file_tree_count(        file_tree_const_h ft,
                    unsigned flags,
                    file_tree_count_t * counter);

extern file_tree_const_h
file_tree_child(file_tree_const_h ft, size_t which);

#ifdef DEBUG_FILE_TREE
extern void
file_tree_dump(file_tree_h ft);
#endif

#endif /* EOF*/