crypt32: Don't fail if buffer is NULL, just return required size.
[wine] / dlls / dmscript / dmscript_private.h
1 /* DirectMusicScript Private Include
2  *
3  * Copyright (C) 2003-2004 Rok Mandeljc
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
18  */
19
20 #ifndef __WINE_DMSCRIPT_PRIVATE_H
21 #define __WINE_DMSCRIPT_PRIVATE_H
22
23 #include <stdio.h>
24 #include <stdarg.h>
25 #include <string.h>
26
27 #define COBJMACROS
28
29 #include "windef.h"
30 #include "winbase.h"
31 #include "winnt.h"
32 #include "wingdi.h"
33 #include "winuser.h"
34
35 #include "wine/debug.h"
36 #include "wine/list.h"
37 #include "wine/unicode.h"
38 #include "winreg.h"
39 #include "objbase.h"
40
41 #include "dmusici.h"
42 #include "dmusicf.h"
43 #include "dmusics.h"
44
45 /*****************************************************************************
46  * Interfaces
47  */
48 typedef struct IDirectMusicScriptImpl IDirectMusicScriptImpl;
49
50 typedef struct IDirectMusicScriptTrack IDirectMusicScriptTrack;
51
52 /*****************************************************************************
53  * ClassFactory
54  */
55 extern HRESULT WINAPI DMUSIC_CreateDirectMusicScriptImpl (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
56
57 extern HRESULT WINAPI DMUSIC_CreateDirectMusicScriptTrack (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
58
59 /*****************************************************************************
60  * IDirectMusicScriptImpl implementation structure
61  */
62 struct IDirectMusicScriptImpl {
63   /* IUnknown fields */
64   const IUnknownVtbl *UnknownVtbl;
65   const IDirectMusicScriptVtbl *ScriptVtbl;
66   const IDirectMusicObjectVtbl *ObjectVtbl;
67   const IPersistStreamVtbl *PersistStreamVtbl;
68   LONG           ref;
69
70   /* IDirectMusicScriptImpl fields */
71   IDirectMusicPerformance* pPerformance;
72   LPDMUS_OBJECTDESC pDesc;
73   DMUS_IO_SCRIPT_HEADER* pHeader;
74   DMUS_IO_VERSION* pVersion;
75   WCHAR* pwzLanguage;
76   WCHAR* pwzSource;
77 };
78
79 /*****************************************************************************
80  * IDirectMusicScriptTrack implementation structure
81  */
82 struct IDirectMusicScriptTrack {
83   /* IUnknown fields */
84   const IUnknownVtbl *UnknownVtbl;
85   const IDirectMusicTrack8Vtbl *TrackVtbl;
86   const IPersistStreamVtbl *PersistStreamVtbl;
87   LONG           ref;
88
89   /* IDirectMusicScriptTrack fields */
90   LPDMUS_OBJECTDESC pDesc;
91 };
92
93 /**********************************************************************
94  * Dll lifetime tracking declaration for dmscript.dll
95  */
96 extern LONG DMSCRIPT_refCount;
97 static inline void DMSCRIPT_LockModule(void) { InterlockedIncrement( &DMSCRIPT_refCount ); }
98 static inline void DMSCRIPT_UnlockModule(void) { InterlockedDecrement( &DMSCRIPT_refCount ); }
99
100 /*****************************************************************************
101  * Misc.
102  */
103 /* for simpler reading */
104 typedef struct _DMUS_PRIVATE_CHUNK {
105         FOURCC fccID; /* FOURCC ID of the chunk */
106         DWORD dwSize; /* size of the chunk */
107 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
108
109 /* used for generic dumping (copied from ddraw) */
110 typedef struct {
111     DWORD val;
112     const char* name;
113 } flag_info;
114
115 typedef struct {
116     const GUID *guid;
117     const char* name;
118 } guid_info;
119
120 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
121 #define DM_STRUCT_INIT(x)                               \
122         do {                                                            \
123                 memset((x), 0, sizeof(*(x)));   \
124                 (x)->dwSize = sizeof(*x);               \
125         } while (0)
126
127 #define FE(x) { x, #x } 
128 #define GE(x) { &x, #x }
129
130 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
131
132 /* check whether the given DWORD is even (return 0) or odd (return 1) */
133 extern int even_or_odd (DWORD number);
134 /* FOURCC to string conversion for debug messages */
135 extern const char *debugstr_fourcc (DWORD fourcc);
136 /* DMUS_VERSION struct to string conversion for debug messages */
137 extern const char *debugstr_dmversion (const DMUS_VERSION *version);
138 /* returns name of given GUID */
139 extern const char *debugstr_dmguid (const GUID *id);
140 /* returns name of given error code */
141 extern const char *debugstr_dmreturn (DWORD code);
142 /* generic flags-dumping function */
143 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
144 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
145 /* dump whole DMUS_OBJECTDESC struct */
146 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
147
148 #endif  /* __WINE_DMSCRIPT_PRIVATE_H */