gfile.h 5.63 KB
Newer Older
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1 2 3 4 5 6 7 8 9 10
//========================================================================
//
// gfile.h
//
// Miscellaneous file and directory name manipulation.
//
// Copyright 1996-2003 Glyph & Cog, LLC
//
//========================================================================

11 12 13 14
//========================================================================
//
// Modified under the Poppler project - http://poppler.freedesktop.org
//
15 16 17
// All changes made under the Poppler project to this file are licensed
// under GPL version 2 or later
//
18
// Copyright (C) 2006 Kristian Høgsberg <krh@redhat.com>
19
// Copyright (C) 2009, 2011, 2012 Albert Astals Cid <aacid@kde.org>
Kovid Goyal's avatar
Kovid Goyal committed
20
// Copyright (C) 2009 Kovid Goyal <kovid@kovidgoyal.net>
21
// Copyright (C) 2013 Adam Reichold <adamreichold@myopera.com>
Albert Astals Cid's avatar
Albert Astals Cid committed
22
// Copyright (C) 2013 Adrian Johnson <ajohnson@redneon.com>
23
// Copyright (C) 2014 Bogdan Cristea <cristeab@gmail.com>
24
// Copyright (C) 2014 Peter Breitenlohner <peb@mppmu.mpg.de>
25 26 27 28 29 30
//
// To see a description of the changes please see the Changelog file that
// came with your tarball or type make ChangeLog if you are building from git
//
//========================================================================

Kristian Høgsberg's avatar
Kristian Høgsberg committed
31 32 33
#ifndef GFILE_H
#define GFILE_H

34
#include "poppler-config.h"
Kristian Høgsberg's avatar
Kristian Høgsberg committed
35 36 37 38
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
extern "C" {
Kovid Goyal's avatar
Kovid Goyal committed
39
#if defined(_WIN32)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
40 41 42 43
#  include <sys/stat.h>
#  ifdef FPTEX
#    include <win32lib.h>
#  else
44 45 46
#    ifndef NOMINMAX
#      define NOMINMAX
#    endif
Kristian Høgsberg's avatar
Kristian Høgsberg committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
#    include <windows.h>
#  endif
#elif defined(ACORN)
#elif defined(MACOS)
#  include <ctime.h>
#else
#  include <unistd.h>
#  include <sys/types.h>
#  ifdef VMS
#    include "vms_dirent.h"
#  elif HAVE_DIRENT_H
#    include <dirent.h>
#    define NAMLEN(d) strlen((d)->d_name)
#  else
#    define dirent direct
#    define NAMLEN(d) (d)->d_namlen
#    if HAVE_SYS_NDIR_H
#      include <sys/ndir.h>
#    endif
#    if HAVE_SYS_DIR_H
#      include <sys/dir.h>
#    endif
#    if HAVE_NDIR_H
#      include <ndir.h>
#    endif
#  endif
#endif
}
#include "gtypes.h"

class GooString;

//------------------------------------------------------------------------

// Get current directory.
extern GooString *getCurrentDir();

// Append a file name to a path string.  <path> may be an empty
// string, denoting the current directory).  Returns <path>.
86
extern GooString *appendToPath(GooString *path, const char *fileName);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

// Grab the path from the front of the file name.  If there is no
// directory component in <fileName>, returns an empty string.
extern GooString *grabPath(char *fileName);

// Is this an absolute path or file name?
extern GBool isAbsolutePath(char *path);

// Get the modification time for <fileName>.  Returns 0 if there is an
// error.
extern time_t getModTime(char *fileName);

// Create a temporary file and open it for writing.  If <ext> is not
// NULL, it will be used as the file name extension.  Returns both the
// name and the file pointer.  For security reasons, all writing
// should be done to the returned file pointer; the file may be
// reopened later for reading, but not for writing.  The <mode> string
// should be "w" or "wb".  Returns true on success.
105
extern GBool openTempFile(GooString **name, FILE **f, const char *mode);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
106

107 108 109 110 111 112 113 114 115 116 117 118 119
#ifdef WIN32
// Convert a file name from Latin-1 to UTF-8.
extern GooString *fileNameToUTF8(char *path);

// Convert a file name from UCS-2 to UTF-8.
extern GooString *fileNameToUTF8(wchar_t *path);
#endif

// Open a file.  On Windows, this converts the path from UTF-8 to
// UCS-2 and calls _wfopen (if available).  On other OSes, this simply
// calls fopen.
extern FILE *openFile(const char *path, const char *mode);

Kristian Høgsberg's avatar
Kristian Høgsberg committed
120 121 122 123
// Just like fgets, but handles Unix, Mac, and/or DOS end-of-line
// conventions.
extern char *getLine(char *buf, int size, FILE *f);

124 125 126 127 128 129 130
// Like fseek/ftell but uses platform specific variants that support large files
extern int Gfseek(FILE *f, Goffset offset, int whence);
extern Goffset Gftell(FILE *f);

// Largest offset supported by Gfseek/Gftell
extern Goffset GoffsetMax();

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
//------------------------------------------------------------------------
// GooFile
//------------------------------------------------------------------------

class GooFile
{
public:
  int read(char *buf, int n, Goffset offset) const;
  Goffset size() const;
  
  static GooFile *open(const GooString *fileName);
  
#ifdef _WIN32
  static GooFile *open(const wchar_t *fileName);
  
  ~GooFile() { CloseHandle(handle); }
  
private:
  GooFile(HANDLE handleA): handle(handleA) {}
  HANDLE handle;
#else
  ~GooFile() { close(fd); }
    
private:
  GooFile(int fdA) : fd(fdA) {}
  int fd;
#endif // _WIN32
};

Kristian Høgsberg's avatar
Kristian Høgsberg committed
160 161 162 163 164 165 166 167 168 169
//------------------------------------------------------------------------
// GDir and GDirEntry
//------------------------------------------------------------------------

class GDirEntry {
public:

  GDirEntry(char *dirPath, char *nameA, GBool doStat);
  ~GDirEntry();
  GooString *getName() { return name; }
170
  GooString *getFullPath() { return fullPath; }
Kristian Høgsberg's avatar
Kristian Høgsberg committed
171 172 173
  GBool isDir() { return dir; }

private:
174 175
  GDirEntry(const GDirEntry &other);
  GDirEntry& operator=(const GDirEntry &other);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
176 177

  GooString *name;		// dir/file name
178
  GooString *fullPath;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
179 180 181 182 183 184 185 186 187 188 189 190
  GBool dir;			// is it a directory?
};

class GDir {
public:

  GDir(char *name, GBool doStatA = gTrue);
  ~GDir();
  GDirEntry *getNextEntry();
  void rewind();

private:
191 192
  GDir(const GDir &other);
  GDir& operator=(const GDir &other);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
193 194 195

  GooString *path;		// directory path
  GBool doStat;			// call stat() for each entry?
Kovid Goyal's avatar
Kovid Goyal committed
196
#if defined(_WIN32)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
197 198 199 200 201 202 203 204 205 206 207 208 209
  WIN32_FIND_DATA ffd;
  HANDLE hnd;
#elif defined(ACORN)
#elif defined(MACOS)
#else
  DIR *dir;			// the DIR structure from opendir()
#ifdef VMS
  GBool needParent;		// need to return an entry for [-]
#endif
#endif
};

#endif