gemrb/core/ResourceDesc.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 #ifndef RESOURCEDESC_H
  22 #define RESOURCEDESC_H
  23
  24 #include "SClassID.h"
  25 #include "exports.h"
  26 #include "ie_types.h"
  27
  28 class DataStream;
  29 class Resource;
  30 class TypeID;
  31
  32 /**
  33  * Class that describes a plugin resource type.
  34  */
  35 class GEM_EXPORT ResourceDesc {
  36 public:
  37         typedef Resource* (*CreateFunc)(DataStream*);
  38 private:
  39         const TypeID *type;
  40         const char *ext;
  41         ieWord keyType; // IE Specific
  42         CreateFunc create;
  43 public:
  44         /**
  45          * Create resource descriptor.
  46          *
  47          * @param[in] type Base class for resource.
  48          * @param[in] create Function to create resource from a stream.
  49          * @param[in] ext Extension used for resource files.
  50          * @param[in] keyType \iespecific Type identifier used in key/biff files.
  51          */
  52         ResourceDesc(const TypeID* type, CreateFunc create, const char *ext, ieWord keyType = 0);
  53         ~ResourceDesc(void);
  54         const char* GetExt() const;
  55         const TypeID* GetType() const;
  56         ieWord GetKeyType() const;
  57         Resource* Create(DataStream*) const;
  58 };
  59
  60 #endif