@c Generated automatically from fileutils.pas
@c DO NOT CHANGE THIS FILE MANUALLY!

@example
@{
Some routines for file and directory handling on a higher level than
those provided by the RTS.

Copyright (C) 2000 Free Software Foundation, Inc.

Author: Frank Heckenbach <frank@@pascal.gnu.de>

This file is part of GNU Pascal.

GNU Pascal is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Pascal is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Pascal; see the file COPYING. If not, write to the
Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.

As a special exception, if you link this file with files compiled
with a GNU compiler to produce an executable, this does not cause
the resulting executable to be covered by the GNU General Public
License. This exception does not however invalidate any other
reasons why the executable file might be covered by the GNU General
Public License.
@}

@{$gnu-pascal@}
@{$if __GPC_RELEASE__ < 20000412@}
@{$error This unit requires GPC release 20000412 or newer.@}
@{$endif@}

unit FileUtils;

interface

uses GPC;

type
  TStringProc = procedure (const Name : String);

@{
  Finds all files matching the given Mask in the given Directory and
  all subdirectories of it. The matching is done using all wildcards
  and brace expansion, like MultiFileNameMatch does. For each file
  found, FileAction is executed. For each directory found (including
  @samp{.} and @samp{..} if they match the Mask!), DirAction is executed. If
  DirsFirst is True, this happens before processing the files in the
  directory and below, otherwise afterwards. (The former is useful,
  e.g., if this is used to copy a directory tree and DirAction does
  a MkDir, while the latter behaviour is required when removing a
  directory tree and DirAction does a RmDir.) Both FileAction and
  DirAction can be nil in which case nothing is done for files or
  directories found, respectively. (If DirAction is nil, the value
  of DirsFirst does not matter.) Of course, FileAction and DirAction
  may also be identical. The procedure leaves InOutRes set in case
  of any error. If FileAction or DirAction return with InOutRes set,
  FindFiles recognizes this and returns immediately.
@}
(*@@@@iocritical*)procedure FindFiles (const Directory, Mask : String;
  DirsFirst : Boolean;
                     FileAction, DirAction : TStringProc);
  asmname '_p_findfiles';

@{
  Creates the directory given by Path and all directories in between
  that are necessary. Does not report an error if Path already
  exists and is a directory, but, of course, if it cannot be created
  because of missing permissions or because Path already exists as a
  file.
@}
(*@@@@iocritical*)procedure MkDirs (const Path : String);
  asmname '_p_mkdirs';

@{
  Removes Path if empty as well as any empty parent directories.
  Does not report an error if Path is not empty.
@}
(*@@@@iocritical*)procedure RmDirs (const Path : String);
  asmname '_p_rmdirs';

@{
  Copies the file Source to Dest, overwriting Dest if it exists and
  can be written to. Returns any errors in IOResult. If Mode >= 0,
  it will change the permissions of Dest to Mode immediately after
  creating it and before writing any data to it. That's useful,
  e.g., if Dest is not meant to be world-readable, because if you'd
  do a ChMod after FileCopy, you would leave the data readable
  (depending on the umask) during the copying. If Mode < 0, Dest
  will be set to the same permissions Source has. In any case, Dest
  will be set to the modification time of Source after coyping.
@}
(*@@@@iocritical*)procedure FileCopy (const Source, Dest : String;
  Mode : Integer); asmname '_p_filecopy';

@{
  Creates a backup of FileName in the directory BackupDirectory or,
  if BackupDirectory is empty, in the directory of FileName. Errors
  are returned in IOResult, but if FileName does not exist, this
  does *not* count as an error (i.e., BackupFile will just return
  without setting IOResult then). If OnlyUserReadable is True, the
  backup file will be given only user-read permissions, nothing
  else.

  The name chosen for the backup depends on the Simple and Short
  parameters. The short names will fit into 8+3 characters (whenever
  possible), while the long ones conform to the conventions used by
  most GNU tools. If Simple is True, a simple backup file name will
  be used, and previous backups under the same name will be
  overwritten (if possible). Otherwise, backups will be numbered,
  where the number is chosen to be larger than all existing backups,
  so it will be unique and increasing in chronological order. In
  particular:

  Simple  Short  Backup name
  True    True   Base name of FileName plus '.bak'
  False   True   Base name of FileName plus '.b' plus a number
  True    False  Base name plus extension of FileName plus '~'
  False   False  Base name plus extension of FileName plus '.~', a
                 number and '~'
@}
(*@@@@iocritical*)procedure BackupFile (const FileName,
  BackupDirectory : String; Simple, Short, OnlyUserReadable :
  Boolean); asmname '_p_backupfile';

@end example
