extraField.h

Public Defines

DeclareExtraField(name)    name( , ExtraFieldCreateFn fnCreate) : Parent(, fnCreate) {}

ImplementExtraField(name, id)    name gExtraField##name##instance(, &createExtraField<name>);

Public Defines

DeclareExtraField(name)    name( , ExtraFieldCreateFn fnCreate) : Parent(, fnCreate) {}

ImplementExtraField(name, id)    name gExtraField##name##instance(, &createExtraField<name>);

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _EXTRAFIELD_H_
25#define _EXTRAFIELD_H_
26
27class Stream;
28
29namespace Zip
30{
31
32/// @addtogroup zipint_group
33/// @ingroup zip_group
34// @{
35
36
37// Forward Refs
38class ExtraField;
39
40// Creation Helpers
41typedef ExtraField *(*ExtraFieldCreateFn)();
42
43template<class T> ExtraField * createExtraField()
44{
45   return new T;
46}
47
48// ExtraField base class
49class ExtraField
50{
51   ExtraField *mNext;
52
53protected:
54   U16 mID;
55   ExtraFieldCreateFn mCreateFn;
56
57public:
58   ExtraField()
59   {
60      mID = 0;
61      mCreateFn = NULL;
62   }
63   ExtraField(U16 id, ExtraFieldCreateFn fnCreate);
64   
65   virtual ~ExtraField() {}
66   
67   inline U16 getID()                  { return mID; }
68
69   virtual bool read(Stream *stream) = 0;
70
71   // Run time creation methods
72   static ExtraField *create(U16 id);
73};
74
75#define  DeclareExtraField(name) \
76   name(U16 id, ExtraFieldCreateFn fnCreate) : Parent(id, fnCreate) {}
77
78#define ImplementExtraField(name, id)       \
79   name gExtraField##name##instance(id, &createExtraField<name>);
80
81// @}
82
83} // end namespace Zip
84
85#endif // _EXTRAFIELD_H_
86