The CVTree interface provides a facility for traversing a CVS repository's directory tree. It incorporates knowledge of the CVS Attic into its traversal.

INTERFACE CVTree;

IMPORT FileAttr, GlobTree, Pathname, Thread;

EXCEPTION Error(TEXT);

TYPE
  FileType = {DirDown, File, AtticFile, DirUp};

  Iterator = OBJECT METHODS
    next(VAR type: FileType;
         VAR name: Pathname.T;
         VAR attr: FileAttr.T): BOOLEAN
      RAISES {Error, Thread.Alerted};
    prune();  (* Stop processing entries at this level. *)
    close()
      RAISES {Error, Thread.Alerted};
  END;

The name parameter is set to the pathname of the file, relative to the root that was passed to Iterate.

At any point in the traversal, prune may be called. That terminates the processing of the current directory; no further files will be returned from it. After a call to prune, the following call to next will return a type of FileType.DirUp, ascending out of the current directory.

PROCEDURE Iterate(root: Pathname.T;
                  follow: GlobTree.T := NIL;
		  attic: GlobTree.T := NIL): Iterator
  RAISES {Error};

Return an Iterator that will traverse the tree rooted at the given directory.

The follow argument specifies a pattern expression. Symbolic links whose names match the pattern will be followed rather than treated as links. The default is equivalent to GlobTree.True, i.e., follow all links.

The attic argument specifies a pattern expression. Directories whose names match the pattern will be checked for subdirectories named Attic and processed specially. The default is equivalent to GlobTree.True, i.e., perform Attic processing in all directories.

END CVTree.