fileio_func.h

Go to the documentation of this file.

/* $Id: fileio_func.h 14207 2008-08-31 19:56:52Z rubidium $ */

#ifndef FILEIO_FUNC_H
#define FILEIO_FUNC_H

#include "fileio_type.h"

void FioSeekTo(size_t pos, int mode);
void FioSeekToFile(uint8 slot, size_t pos);
size_t FioGetPos();
const char *FioGetFilename(uint8 slot);
byte FioReadByte();
uint16 FioReadWord();
uint32 FioReadDword();
void FioCloseAll();
void FioOpenFile(int slot, const char *filename);
void FioReadBlock(void *ptr, size_t size);
void FioSkipBytes(int n);
void FioCreateDirectory(const char *filename);

extern const char *_searchpaths[NUM_SEARCHPATHS];

static inline bool IsValidSearchPath(Searchpath sp)
{
  return sp < NUM_SEARCHPATHS && _searchpaths[sp] != NULL;
}

#define FOR_ALL_SEARCHPATHS(sp) for (sp = SP_FIRST_DIR; sp < NUM_SEARCHPATHS; sp++) if (IsValidSearchPath(sp))

void FioFCloseFile(FILE *f);
FILE *FioFOpenFile(const char *filename, const char *mode = "rb", Subdirectory subdir = DATA_DIR, size_t *filesize = NULL);
bool FioCheckFileExists(const char *filename, Subdirectory subdir = DATA_DIR);
char *FioGetFullPath(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir, const char *filename);
char *FioFindFullPath(char *buf, size_t buflen, Subdirectory subdir, const char *filename);
char *FioAppendDirectory(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir);
char *FioGetDirectory(char *buf, size_t buflen, Subdirectory subdir);

static inline const char *FioGetSubdirectory(Subdirectory subdir)
{
  extern const char *_subdirs[NUM_SUBDIRS];
  assert(subdir < NUM_SUBDIRS);
  return _subdirs[subdir];
}

void SanitizeFilename(char *filename);
void AppendPathSeparator(char *buf, size_t buflen);
void DeterminePaths(const char *exe);
void *ReadFileToMem(const char *filename, size_t *lenp, size_t maxsize);
bool FileExists(const char *filename);

extern char *_personal_dir; 

class FileScanner
{
public:
  virtual ~FileScanner() {}

  uint Scan(const char *extension, Subdirectory sd, bool tars = true);

  virtual bool AddFile(const char *filename, size_t basepath_length) = 0;
};


/* Implementation of opendir/readdir/closedir for Windows */
#if defined(WIN32)
#include <windows.h>
struct DIR;

struct dirent { // XXX - only d_name implemented
  TCHAR *d_name; // name of found file
  /* little hack which will point to parent DIR struct which will
   * save us a call to GetFileAttributes if we want information
   * about the file (for example in function fio_bla) */
  DIR *dir;
};

struct DIR {
  HANDLE hFind;
  /* the dirent returned by readdir.
   * note: having only one global instance is not possible because
   * multiple independent opendir/readdir sequences must be supported. */
  dirent ent;
  WIN32_FIND_DATA fd;
  /* since opendir calls FindFirstFile, we need a means of telling the
   * first call to readdir that we already have a file.
   * that's the case iff this is true */
  bool at_first_entry;
};

DIR *opendir(const TCHAR *path);
struct dirent *readdir(DIR *d);
int closedir(DIR *d);
#else
/* Use system-supplied opendir/readdir/closedir functions */
# include <sys/types.h>
# include <dirent.h>
#endif /* defined(WIN32) */

static inline DIR *ttd_opendir(const char *path)
{
  return opendir(OTTD2FS(path));
}

#endif /* FILEIO_FUNC_H */