filesys.h

Go to the documentation of this file.

#ifndef FILESYS_H
#define FILESYS_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 "opts.h"
#include "memory.h"




typedef void * fs_dir_t;


typedef enum {
    FS_OBJ_NONE,        
    FS_OBJ_SLINK = 1,   
    FS_OBJ_FILE = 2,    
    FS_OBJ_DIR = 4              
} fs_obj_type_t;

typedef enum {
    FS_ABS_PATH = 1 ,           
    FS_UNIX_PATH = 2,           
    FS_WIN_PATH = 6,        
    FS_DANGLING_PATH = 8,       
    FS_ROOT_PATH = 16           
} fs_path_type_t;

#define fs_absolute_path(pathtype) \
        (((pathtype) & FS_ABS_PATH) == FS_ABS_PATH)

#define fs_unix_path(pathtype) \
        (((pathtype) & FS_UNIX_PATH) == FS_UNIX_PATH)

#define fs_windows_path(pathtype) \
        (((pathtype) & FS_WIN_PATH) == FS_WIN_PATH)

#define fs_dangling_path(pathtype) \
        (((pathtype) & FS_DANGLING_PATH) == FS_DANGLING_PATH)

#define fs_root_path(pathtype) \
        (((pathtype) & FS_ROOT_PATH) == FS_ROOT_PATH)

#define FS_IS_FILE(objtype) (((objtype) & FS_OBJ_FILE) != 0)

#define FS_IS_DIR(objtype) (((objtype) & FS_OBJ_DIR) != 0)

#define FS_IS_SLINK(objtype) (((objtype) & FS_OBJ_SLINK) != 0)

extern fs_obj_type_t
fs_obj_type(char const *name);

extern
fs_obj_type_t
fs_file_or_dir(char const *name);


extern fs_dir_t
fs_open_dir(char const *dirname, fs_dir_t const parent);

extern void
fs_close_dir(fs_dir_t dir);

extern char const *
fs_read_dir(fs_dir_t dir, char const ** fullname);


extern fs_dir_t
fs_get_parent(fs_dir_t dir);

extern heap_str
fs_compose_filename(char const *path, char const *leafname);

extern heap_str
fs_split_filename(char const *path, char **leafname);

extern heap_str
fs_real_path(char const *relname, size_t *namelen);

extern char const *
fs_cur_dir_entry(fs_dir_t dir, char const **entry);


extern fs_path_type_t
fs_path_type(char const *filename);

extern char *
fs_tempname(char * template);

extern char const *
fs_path_comp(char const *first, char const *second, size_t *sharedlen);

#endif /* EOF*/