d3dxof: Make FileEnumObject keep references to top level objects. Add corresponding...
[wine] / dlls / d3dxof / tests / d3dxof.c
1 /*
2  * Some unit tests for d3dxof
3  *
4  * Copyright (C) 2008 Christian Costa
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20 #define COBJMACROS
21
22 #include <assert.h>
23 #include <stdio.h>
24 #include "wine/test.h"
25 #include "initguid.h"
26 #include "dxfile.h"
27
28 static inline void debugstr_guid( char* buf, CONST GUID *id )
29 {
30     sprintf(buf, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
31             id->Data1, id->Data2, id->Data3,
32             id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
33             id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
34 }
35
36 static HMODULE hd3dxof;
37 static HRESULT (WINAPI *pDirectXFileCreate)(LPDIRECTXFILE*);
38
39 char template[] =
40 "xof 0302txt 0064\n"
41 "template Header\n"
42 "{\n"
43 "<3D82AB43-62DA-11CF-AB39-0020AF71E433>\n"
44 "WORD major;\n"
45 "WORD minor;\n"
46 "DWORD flags;\n"
47 "}\n";
48
49 char object[] =
50 "xof 0302txt 0064\n"
51 "Header Object\n"
52 "{\n"
53 "1; 2; 3;\n"
54 "}\n";
55
56 static void init_function_pointers(void)
57 {
58     /* We have to use LoadLibrary as no d3dxof functions are referenced directly */
59     hd3dxof = LoadLibraryA("d3dxof.dll");
60
61     pDirectXFileCreate = (void *)GetProcAddress(hd3dxof, "DirectXFileCreate");
62 }
63
64 static unsigned long getRefcount(IUnknown *iface)
65 {
66     IUnknown_AddRef(iface);
67     return IUnknown_Release(iface);
68 }
69
70 static void test_refcount(void)
71 {
72     HRESULT hr;
73     unsigned long ref;
74     LPDIRECTXFILE lpDirectXFile = NULL;
75     LPDIRECTXFILEENUMOBJECT lpdxfeo;
76     LPDIRECTXFILEDATA lpdxfd;
77     DXFILELOADMEMORY dxflm;
78
79     if (!pDirectXFileCreate)
80     {
81         win_skip("DirectXFileCreate is not available\n");
82         return;
83     }
84
85     hr = pDirectXFileCreate(&lpDirectXFile);
86     ok(hr == DXFILE_OK, "DirectXFileCreate: %x\n", hr);
87     if(!lpDirectXFile)
88     {
89         skip("Couldn't create DirectXFile interface\n");
90         return;
91     }
92
93     ref = getRefcount( (IUnknown *) lpDirectXFile);
94     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
95     ref = IDirectXFile_AddRef(lpDirectXFile);
96     ok(ref == 2, "Got refcount %ld, expected 1\n", ref);
97     ref = IDirectXFile_Release(lpDirectXFile);
98     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
99
100     hr = IDirectXFile_RegisterTemplates(lpDirectXFile, template, strlen(template));
101     ok(hr == DXFILE_OK, "IDirectXFileImpl_RegisterTemplates: %x\n", hr);
102
103     dxflm.lpMemory = &object;
104     dxflm.dSize = strlen(object);
105     hr = IDirectXFile_CreateEnumObject(lpDirectXFile, &dxflm, DXFILELOAD_FROMMEMORY, &lpdxfeo);
106     ok(hr == DXFILE_OK, "IDirectXFile_CreateEnumObject: %x\n", hr);
107     ref = getRefcount( (IUnknown *) lpDirectXFile);
108     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
109     ref = getRefcount( (IUnknown *) lpdxfeo);
110     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
111
112     hr = IDirectXFileEnumObject_GetNextDataObject(lpdxfeo, &lpdxfd);
113     ok(hr == DXFILE_OK, "IDirectXFileEnumObject_GetNextDataObject: %x\n", hr);
114     ref = getRefcount( (IUnknown *) lpDirectXFile);
115     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
116     ref = getRefcount( (IUnknown *) lpdxfeo);
117     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
118     /* Enum object gets references to all top level objects */
119     ref = getRefcount( (IUnknown *) lpdxfd);
120     ok(ref == 2, "Got refcount %ld, expected 2\n", ref);
121
122     ref = IDirectXFile_Release(lpDirectXFile);
123     ok(ref == 0, "Got refcount %ld, expected 0\n", ref);
124     /* Nothing changes for all other objects */
125     ref = getRefcount( (IUnknown *) lpdxfeo);
126     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
127     ref = getRefcount( (IUnknown *) lpdxfd);
128     ok(ref == 2, "Got refcount %ld, expected 1\n", ref);
129
130     ref = IDirectXFileEnumObject_Release(lpdxfeo);
131     ok(ref == 0, "Got refcount %ld, expected 0\n", ref);
132     /* Enum object releases references to all top level objects */
133     ref = getRefcount( (IUnknown *) lpdxfd);
134     ok(ref == 1, "Got refcount %ld, expected 1\n", ref);
135
136     ref = IDirectXFileData_Release(lpdxfd);
137     ok(ref == 0, "Got refcount %ld, expected 0\n", ref);
138 }
139
140 /* Set it to 1 to expand the string when dumping the object. This is usefull when there is
141  * only one string in a sub-object (very common). Use with care, this may lead to a crash. */
142 #define EXPAND_STRING 0
143
144 static void process_data(LPDIRECTXFILEDATA lpDirectXFileData, int* plevel)
145 {
146     HRESULT hr;
147     char name[100];
148     GUID clsid;
149     CONST GUID* clsid_type = NULL;
150     char str_clsid[40];
151     char str_clsid_type[40];
152     DWORD len= 100;
153     LPDIRECTXFILEOBJECT pChildObj;
154     int i,k;
155     int j = 0;
156     LPBYTE pData;
157     DWORD size;
158
159     hr = IDirectXFileData_GetId(lpDirectXFileData, &clsid);
160     ok(hr == DXFILE_OK, "IDirectXFileData_GetId: %x\n", hr);
161     hr = IDirectXFileData_GetName(lpDirectXFileData, name, &len);
162     ok(hr == DXFILE_OK, "IDirectXFileData_GetName: %x\n", hr);
163     hr = IDirectXFileData_GetType(lpDirectXFileData, &clsid_type);
164     ok(hr == DXFILE_OK, "IDirectXFileData_GetType: %x\n", hr);
165     hr = IDirectXFileData_GetData(lpDirectXFileData, NULL, &size, (void**)&pData);
166     ok(hr == DXFILE_OK, "IDirectXFileData_GetData: %x\n", hr);
167     for (i = 0; i < *plevel; i++)
168         printf("  ");
169     debugstr_guid(str_clsid, &clsid);
170     debugstr_guid(str_clsid_type, clsid_type);
171     printf("Found object '%s' - %s - %s - %d\n", name, str_clsid, str_clsid_type, size);
172
173     if (EXPAND_STRING && size == 4)
174     {
175         char * str = *(char**)pData;
176         printf("string %s\n", str);
177     }
178     else if (size)
179     {
180         for (k = 0; k < size; k++)
181         {
182             if (k && !(k%16))
183                 printf("\n");
184             printf("%02x ", pData[k]);
185         }
186         printf("\n");
187     }
188     (*plevel)++;
189     while (SUCCEEDED(hr = IDirectXFileData_GetNextObject(lpDirectXFileData, &pChildObj)))
190     {
191         LPDIRECTXFILEDATA p1;
192         LPDIRECTXFILEDATAREFERENCE p2;
193         LPDIRECTXFILEBINARY p3;
194         j++;
195
196         hr = IDirectXFileObject_QueryInterface(pChildObj, &IID_IDirectXFileData, (void **) &p1);
197         if (SUCCEEDED(hr))
198         {
199             for (i = 0; i < *plevel; i++)
200                 printf("  ");
201             printf("Found Data (%d)\n", j);
202             process_data(p1, plevel);
203             IDirectXFileData_Release(p1);
204         }
205         hr = IDirectXFileObject_QueryInterface(pChildObj, &IID_IDirectXFileDataReference, (void **) &p2);
206         if (SUCCEEDED(hr))
207         {
208             LPDIRECTXFILEDATA pfdo;
209             for (i = 0; i < *plevel; i++)
210                 printf("  ");
211             printf("Found Data Reference (%d)\n", j);
212 #if 0
213             hr = IDirectXFileDataReference_GetId(lpDirectXFileData, &clsid);
214             ok(hr == DXFILE_OK, "IDirectXFileData_GetId: %x\n", hr);
215             hr = IDirectXFileDataReference_GetName(lpDirectXFileData, name, &len);
216             ok(hr == DXFILE_OK, "IDirectXFileData_GetName: %x\n", hr);
217 #endif
218             IDirectXFileDataReference_Resolve(p2, &pfdo);
219             process_data(pfdo, plevel);
220             IDirectXFileData_Release(pfdo);
221             IDirectXFileDataReference_Release(p2);
222         }
223         hr = IDirectXFileObject_QueryInterface(pChildObj, &IID_IDirectXFileBinary, (void **) &p3);
224         if (SUCCEEDED(hr))
225         {
226             for (i = 0; i < *plevel; i++)
227                 printf("  ");
228             printf("Found Binary (%d)\n", j);
229             IDirectXFileBinary_Release(p3);
230         }
231     }
232     (*plevel)--;
233     ok(hr == DXFILE_OK || hr == DXFILEERR_NOMOREOBJECTS, "IDirectXFileData_GetNextObject: %x\n", hr);
234 }
235
236 static void test_dump(void)
237 {
238     HRESULT hr;
239     unsigned long ref;
240     LPDIRECTXFILE lpDirectXFile = NULL;
241     LPDIRECTXFILEENUMOBJECT lpDirectXFileEnumObject = NULL;
242     LPDIRECTXFILEDATA lpDirectXFileData = NULL;
243     HANDLE hFile;
244     LPVOID pvData = NULL;
245     DWORD cbSize;
246
247     if (!pDirectXFileCreate)
248     {
249         win_skip("DirectXFileCreate is not available\n");
250         goto exit;
251     }
252
253     /* Dump data only if there is an object and a template */
254     hFile = CreateFileA("objects.txt", GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
255     if (hFile == INVALID_HANDLE_VALUE)
256       return;
257     CloseHandle(hFile);
258
259     hFile = CreateFileA("templates.txt", GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
260     if (hFile == INVALID_HANDLE_VALUE)
261       return;
262
263     pvData = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, 10000);
264
265     if (!ReadFile(hFile, pvData, 10000, &cbSize, NULL))
266     {
267       skip("Template file is too big\n");
268       goto exit;
269     }
270
271     printf("Load %d bytes\n", cbSize);
272
273     hr = pDirectXFileCreate(&lpDirectXFile);
274     ok(hr == DXFILE_OK, "DirectXFileCreate: %x\n", hr);
275     if(!lpDirectXFile)
276     {
277         skip("Couldn't create DirectXFile interface\n");
278         goto exit;
279     }
280
281     hr = IDirectXFile_RegisterTemplates(lpDirectXFile, pvData, strlen(pvData));
282     ok(hr == DXFILE_OK, "IDirectXFileImpl_RegisterTemplates: %x\n", hr);
283
284     hr = IDirectXFile_CreateEnumObject(lpDirectXFile, (LPVOID)"objects.txt", DXFILELOAD_FROMFILE, &lpDirectXFileEnumObject);
285     ok(hr == DXFILE_OK, "IDirectXFile_CreateEnumObject: %x\n", hr);
286
287     while (SUCCEEDED(hr = IDirectXFileEnumObject_GetNextDataObject(lpDirectXFileEnumObject, &lpDirectXFileData)))
288     {
289         int level = 0;
290         printf("\n");
291         process_data(lpDirectXFileData, &level);
292         IDirectXFileData_Release(lpDirectXFileData);
293     }
294     ok(hr == DXFILE_OK || hr == DXFILEERR_NOMOREOBJECTS, "IDirectXFileEnumObject_GetNextDataObject: %x\n", hr);
295
296     ref = IDirectXFile_Release(lpDirectXFileEnumObject);
297     ok(ref == 0, "Got refcount %ld, expected 0\n", ref);
298
299     ref = IDirectXFile_Release(lpDirectXFile);
300     ok(ref == 0, "Got refcount %ld, expected 0\n", ref);
301
302     CloseHandle(hFile);
303
304 exit:
305     HeapFree(GetProcessHeap(), 0, pvData);
306 }
307
308 START_TEST(d3dxof)
309 {
310     init_function_pointers();
311
312     test_refcount();
313     test_dump();
314
315     FreeLibrary(hd3dxof);
316 }