./ROBODocSource/directory.h

RB_Directory

NAME

RB_Directory -- the directory tree with the source files.

FUNCTION

Stores information about files in a directory tree. The whole structure consist of two linked lists. One for directory paths, and one for filenames.

EXAMPLE

The following show an example structure.

     RB_Directory             RB_Path
     +-------+   +------+    +-------+   +-----------+
     |       +-->| .    |--->| ./sub |-->| ./sub/sub |
     |       |   +------+    +-------+   +-----------+
     |       |      ^              ^            ^
     |       |      |              |            |
     |       |      |-----------+  +------+     +------+
     |       |      |           |         |            |
     |       |      |           |         |            |
     |       |   +------+    +------+   +------+    +-------+
     |       +-->|  a.c |--->| b.c  |-->| sa.c  |-->| ssb.c |
     +-------+   +------+    +------+   +------+    +-------+
                  RB_Filename

ATTRIBUTES

first -- first RB_Filename in the list of files
current -- the last file that was returned in RB_Get_Next_Filename.
last -- the last RB_Filename in the list of files used for the insert operation
first_path -- first RB_Path in the list of paths.

SOURCE

struct RB_Directory
{
    struct RB_Filename *first;  /* TODO should be called files */
    struct RB_Filename *last;
    struct RB_Path     *first_path;     /* TODO should be called paths */
};

T_RB_FileType

[ Top ] [ Directory ] [ Types ]

FUNCTION

Constants for the two different filetypes that ROBODoc recognizes.

SOURCE

typedef enum
{
    RB_FT_DIRECTORY = 1,
    RB_FT_FILE = 2,
    RB_FT_UNKNOWN = 3
} T_RB_FileType;