pdf2swf/xpdf/gfile.h

   1 //========================================================================
   2 //
   3 // gfile.h
   4 //
   5 // Miscellaneous file and directory name manipulation.
   6 //
   7 // Copyright 1996-2003 Glyph & Cog, LLC
   8 //
   9 //========================================================================
  10
  11 #ifndef GFILE_H
  12 #define GFILE_H
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <stddef.h>
  17 #include "./aconf.h"
  18 #if defined(WIN32)
  19 #  include <sys/stat.h>
  20 #  ifdef FPTEX
  21 #    include <win32lib.h>
  22 #  else
  23 #    include <windows.h>
  24 #    include <winbase.h>
  25 #  endif
  26 #elif defined(ACORN)
  27 #elif defined(MACOS)
  28 #  include <ctime.h>
  29 #else
  30 #  include <unistd.h>
  31 #  include <sys/types.h>
  32 #  ifdef VMS
  33 #    include "vms_dirent.h"
  34 #  elif HAVE_DIRENT_H
  35 #    include <dirent.h>
  36 #    define NAMLEN(d) strlen((d)->d_name)
  37 #  else
  38 #    define dirent direct
  39 #    define NAMLEN(d) (d)->d_namlen
  40 #    if HAVE_SYS_NDIR_H
  41 #      include <sys/ndir.h>
  42 #    endif
  43 #    if HAVE_SYS_DIR_H
  44 #      include <sys/dir.h>
  45 #    endif
  46 #    if HAVE_NDIR_H
  47 #      include <ndir.h>
  48 #    endif
  49 #  endif
  50 #endif
  51 #include "gtypes.h"
  52
  53 class GString;
  54
  55 //------------------------------------------------------------------------
  56
  57 // Get home directory path.
  58 extern GString *getHomeDir();
  59
  60 // Get current directory.
  61 extern GString *getCurrentDir();
  62
  63 /* create a temporary filename */
  64 char* mktmpname(char*ptr);
  65
  66 // Append a file name to a path string.  <path> may be an empty
  67 // string, denoting the current directory).  Returns <path>.
  68 extern GString *appendToPath(GString *path, char *fileName);
  69
  70 // Grab the path from the front of the file name.  If there is no
  71 // directory component in <fileName>, returns an empty string.
  72 extern GString *grabPath(char *fileName);
  73
  74 // Is this an absolute path or file name?
  75 extern GBool isAbsolutePath(char *path);
  76
  77 // Make this path absolute by prepending current directory (if path is
  78 // relative) or prepending user's directory (if path starts with '~').
  79 extern GString *makePathAbsolute(GString *path);
  80
  81 // Get the modification time for <fileName>.  Returns 0 if there is an
  82 // error.
  83 extern time_t getModTime(char *fileName);
  84
  85 // Create a temporary file and open it for writing.  If <ext> is not
  86 // NULL, it will be used as the file name extension.  Returns both the
  87 // name and the file pointer.  For security reasons, all writing
  88 // should be done to the returned file pointer; the file may be
  89 // reopened later for reading, but not for writing.  The <mode> string
  90 // should be "w" or "wb".  Returns true on success.
  91 extern GBool openTempFile(GString **name, FILE **f, char *mode, char *ext);
  92
  93 // Execute <command>.  Returns true on success.
  94 extern GBool executeCommand(char *cmd);
  95
  96 // Just like fgets, but handles Unix, Mac, and/or DOS end-of-line
  97 // conventions.
  98 extern char *getLine(char *buf, int size, FILE *f);
  99
 100 //------------------------------------------------------------------------
 101 // GDir and GDirEntry
 102 //------------------------------------------------------------------------
 103
 104 class GDirEntry {
 105 public:
 106
 107   GDirEntry(char *dirPath, char *nameA, GBool doStat);
 108   ~GDirEntry();
 109   GString *getName() { return name; }
 110   GBool isDir() { return dir; }
 111
 112 private:
 113
 114   GString *name;                // dir/file name
 115   GBool dir;                    // is it a directory?
 116 };
 117
 118 class GDir {
 119 public:
 120
 121   GDir(char *name, GBool doStatA = gTrue);
 122   ~GDir();
 123   GDirEntry *getNextEntry();
 124   void rewind();
 125
 126 private:
 127
 128   GString *path;                // directory path
 129   GBool doStat;                 // call stat() for each entry?
 130 #if defined(WIN32)
 131   WIN32_FIND_DATA ffd;
 132   HANDLE hnd;
 133 #elif defined(ACORN)
 134 #elif defined(MACOS)
 135 #else
 136   DIR *dir;                     // the DIR structure from opendir()
 137 #ifdef VMS
 138   GBool needParent;             // need to return an entry for [-]
 139 #endif
 140 #endif
 141 };
 142
 143 #endif