source/blender/blenkernel/BKE_packedFile.h

   1 /**
   2  * blenlib/BKE_packedFile.h (mar-2001 nzc)
   3  *
   4  * $Id$
   5  *
   6  * ***** BEGIN GPL LICENSE BLOCK *****
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL LICENSE BLOCK *****
  30  */
  31 #ifndef BKE_PACKEDFILE_H
  32 #define BKE_PACKEDFILE_H
  33
  34 #define RET_OK          0
  35 #define RET_ERROR       1
  36
  37 struct bSound;
  38 struct Image;
  39 struct Main;
  40 struct PackedFile;
  41 struct ReportList;
  42 struct VFont;
  43
  44 /* pack */
  45 struct PackedFile *newPackedFile(struct ReportList *reports, char *filename);
  46 struct PackedFile *newPackedFileMemory(void *mem, int memlen);
  47
  48 void packAll(struct Main *bmain, struct ReportList *reports);
  49
  50 /* unpack */
  51 char *unpackFile(struct ReportList *reports, char *abs_name, char *local_name, struct PackedFile *pf, int how);
  52 int unpackVFont(struct ReportList *reports, struct VFont *vfont, int how);
  53 int unpackSound(struct ReportList *reports, struct bSound *sound, int how);
  54 int unpackImage(struct ReportList *reports, struct Image *ima, int how);
  55 void unpackAll(struct Main *bmain, struct ReportList *reports, int how);
  56
  57 int writePackedFile(struct ReportList *reports, char *filename, struct PackedFile *pf, int guimode);
  58
  59 /* free */
  60 void freePackedFile(struct PackedFile *pf);
  61
  62 /* info */
  63 int countPackedFiles(struct Main *bmain);
  64 int checkPackedFile(char *filename, struct PackedFile *pf);
  65
  66 /* read */
  67 int seekPackedFile(struct PackedFile *pf, int offset, int whence);
  68 void rewindPackedFile(struct PackedFile *pf);
  69 int readPackedFile(struct PackedFile *pf, void *data, int size);
  70
  71 #endif
  72