144 lines
3.7 KiB
C++
144 lines
3.7 KiB
C++
/* -*- indent-tabs-mode:t; tab-width:4; -*-
|
|
*
|
|
* $Id$
|
|
*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program 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
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2009 by Stichting Blender Foundation.
|
|
* All rights reserved.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
* BFILE* based abstraction of file access.
|
|
*/
|
|
|
|
#ifndef BLI_BFILE_H
|
|
#define BLI_BFILE_H
|
|
|
|
/* For fopen's FILE */
|
|
#include <stdio.h>
|
|
|
|
/**
|
|
Defines for the bflags param.
|
|
*/
|
|
/* Special handling, pick one of: */
|
|
/* For "symmetry" of flags */
|
|
#define BFILE_NORMAL (0)
|
|
/* No supervision, just translate // if needed, RISKY */
|
|
#define BFILE_RAW (1<<0)
|
|
/* Path is for current session temp files */
|
|
#define BFILE_TEMP (1<<1)
|
|
/* Path is based in env vars of matching name */
|
|
#define BFILE_CONFIG_BASE (1<<2)
|
|
#define BFILE_CONFIG_DATAFILES (1<<3)
|
|
#define BFILE_CONFIG_PYTHON (1<<4)
|
|
#define BFILE_CONFIG_PLUGINS (1<<5)
|
|
|
|
/* Config handling, special cases: */
|
|
#define BFILE_USERONLY (1<<6)
|
|
#define BFILE_SYSONLY (1<<7)
|
|
|
|
/* Compression to apply on close: */
|
|
#define BFILE_GZIP (1<<8)
|
|
#define BFILE_LZMA (1<<9)
|
|
|
|
/**
|
|
File descriptor for Blender abstracted file access.
|
|
*/
|
|
typedef struct {
|
|
FILE *stream;
|
|
int fd;
|
|
|
|
/* Anything below should not be touched directly */
|
|
int uflags; /* Special options requested by upper level, copy of bflags */
|
|
char *fpath; /* Final/requested path name */
|
|
char *tpath; /* Temp path name if applicable */
|
|
int classf; /* Own flags, common classification of open and fopen */
|
|
int error; /* An op caused an error, unsafe to replace older files */
|
|
} BFILE;
|
|
|
|
/**
|
|
Open a BFILE* with fopen()-like syntax.
|
|
*/
|
|
BFILE *BLI_bfile_fopen(const char *path, const char *mode, int bflags, const char *relpath);
|
|
|
|
/**
|
|
Open a BFILE* with open()-like syntax.
|
|
*/
|
|
BFILE *BLI_bfile_open(const char *pathname, int flags, int bflags, const char *relpath);
|
|
|
|
/**
|
|
Get the FILE* associated with the BFILE*.
|
|
*/
|
|
FILE *BLI_bfile_file_from_bfile(BFILE *bfile);
|
|
|
|
/**
|
|
Get the fd associated with the BFILE*.
|
|
*/
|
|
int BLI_bfile_fd_from_bfile(BFILE *bfile);
|
|
|
|
/**
|
|
write()-like using BFILE*.
|
|
*/
|
|
ssize_t BLI_bfile_write(BFILE *f, const void *buf, size_t count);
|
|
|
|
/**
|
|
read()-like using BFILE*.
|
|
*/
|
|
ssize_t BLI_bfile_read(BFILE *f, void *buf, size_t count);
|
|
|
|
/**
|
|
fwrite()-like using BFILE*.
|
|
*/
|
|
size_t BLI_bfile_fwrite(const void *ptr, size_t size, size_t nmemb, BFILE *f);
|
|
|
|
/**
|
|
fread()-like using BFILE*.
|
|
*/
|
|
size_t BLI_bfile_fread(void *ptr, size_t size, size_t nmemb, BFILE *f);
|
|
|
|
/**
|
|
Close a BFILE, to match close() and fclose().
|
|
*/
|
|
void BLI_bfile_close(BFILE *bfile);
|
|
|
|
/**
|
|
Clear error status.
|
|
Call it only if the error has been really handled.
|
|
*/
|
|
void BLI_bfile_clear_error(BFILE *bfile);
|
|
|
|
/**
|
|
Set the error status.
|
|
Call it to mark writing by a 3rd party failed (libjpeg reported error, ie).
|
|
*/
|
|
void BLI_bfile_set_error(BFILE *bfile, int error);
|
|
|
|
/*
|
|
TODO
|
|
Maybe also provide more OS/libc things like:
|
|
fflush
|
|
fprintf and related
|
|
fscanf
|
|
fgetc/fputc and related
|
|
fseek and related
|
|
|
|
Probably good to do:
|
|
readdir (compacted list showing all files for a "directory" (user versions on top of system's))
|
|
*/
|
|
|
|
#endif /* ifndef BLI_BFILE_H */
|