allow empty filename in ctor taking the extents
[wxWidgets.git] / src / msw / metafile.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/metafile.cpp
3 // Purpose: wxMetafileDC etc.
4 // Author: Julian Smart
5 // Modified by: VZ 07.01.00: implemented wxMetaFileDataObject
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/utils.h"
29 #include "wx/app.h"
30 #endif
31
32 #include "wx/metafile.h"
33
34 #if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH)
35
36 #include "wx/clipbrd.h"
37 #include "wx/msw/private.h"
38
39 #include <stdio.h>
40 #include <string.h>
41
42 // ----------------------------------------------------------------------------
43 // wxWin macros
44 // ----------------------------------------------------------------------------
45
46 IMPLEMENT_DYNAMIC_CLASS(wxMetafile, wxObject)
47 IMPLEMENT_ABSTRACT_CLASS(wxMetafileDC, wxDC)
48
49 // ============================================================================
50 // implementation
51 // ============================================================================
52
53 // ----------------------------------------------------------------------------
54 // wxMetafileRefData
55 // ----------------------------------------------------------------------------
56
57 /*
58 * Metafiles
59 * Currently, the only purpose for making a metafile is to put
60 * it on the clipboard.
61 */
62
63 wxMetafileRefData::wxMetafileRefData()
64 {
65 m_metafile = 0;
66 m_windowsMappingMode = wxMM_ANISOTROPIC;
67 m_width = m_height = 0;
68 }
69
70 wxMetafileRefData::~wxMetafileRefData()
71 {
72 if (m_metafile)
73 {
74 DeleteMetaFile((HMETAFILE) m_metafile);
75 m_metafile = 0;
76 }
77 }
78
79 // ----------------------------------------------------------------------------
80 // wxMetafile
81 // ----------------------------------------------------------------------------
82
83 wxMetafile::wxMetafile(const wxString& file)
84 {
85 m_refData = new wxMetafileRefData;
86
87 M_METAFILEDATA->m_windowsMappingMode = wxMM_ANISOTROPIC;
88 M_METAFILEDATA->m_metafile = 0;
89 if (!file.empty())
90 M_METAFILEDATA->m_metafile = (WXHANDLE) GetMetaFile(file);
91 }
92
93 wxMetafile::~wxMetafile()
94 {
95 }
96
97 bool wxMetafile::SetClipboard(int width, int height)
98 {
99 #if !wxUSE_CLIPBOARD
100 return false;
101 #else
102 if (!m_refData)
103 return false;
104
105 bool alreadyOpen = wxClipboardOpen();
106 if (!alreadyOpen)
107 {
108 wxOpenClipboard();
109 if (!wxEmptyClipboard())
110 return false;
111 }
112 bool success = wxSetClipboardData(wxDF_METAFILE, this, width,height);
113 if (!alreadyOpen)
114 wxCloseClipboard();
115
116 return success;
117 #endif
118 }
119
120 bool wxMetafile::Play(wxDC *dc)
121 {
122 if (!m_refData)
123 return false;
124
125 if (dc->GetHDC() && M_METAFILEDATA->m_metafile)
126 {
127 if ( !::PlayMetaFile(GetHdcOf(*dc), (HMETAFILE)
128 M_METAFILEDATA->m_metafile) )
129 {
130 wxLogLastError(_T("PlayMetaFile"));
131 }
132 }
133
134 return true;
135 }
136
137 void wxMetafile::SetHMETAFILE(WXHANDLE mf)
138 {
139 if (!m_refData)
140 m_refData = new wxMetafileRefData;
141
142 M_METAFILEDATA->m_metafile = mf;
143 }
144
145 void wxMetafile::SetWindowsMappingMode(int mm)
146 {
147 if (!m_refData)
148 m_refData = new wxMetafileRefData;
149
150 M_METAFILEDATA->m_windowsMappingMode = mm;
151 }
152
153 // ----------------------------------------------------------------------------
154 // Metafile device context
155 // ----------------------------------------------------------------------------
156
157 // Original constructor that does not takes origin and extent. If you use this,
158 // *DO* give origin/extent arguments to wxMakeMetafilePlaceable.
159 wxMetafileDC::wxMetafileDC(const wxString& file)
160 {
161 m_metaFile = NULL;
162 m_minX = 10000;
163 m_minY = 10000;
164 m_maxX = -10000;
165 m_maxY = -10000;
166 // m_title = NULL;
167
168 if (!file.IsNull() && wxFileExists(file))
169 wxRemoveFile(file);
170
171 if (!file.IsNull() && (file != wxEmptyString))
172 m_hDC = (WXHDC) CreateMetaFile(file);
173 else
174 m_hDC = (WXHDC) CreateMetaFile(NULL);
175
176 m_ok = (m_hDC != (WXHDC) 0) ;
177
178 // Actual Windows mapping mode, for future reference.
179 m_windowsMappingMode = wxMM_TEXT;
180
181 SetMapMode(wxMM_TEXT); // NOTE: does not set HDC mapmode (this is correct)
182 }
183
184 // New constructor that takes origin and extent. If you use this, don't
185 // give origin/extent arguments to wxMakeMetafilePlaceable.
186 wxMetafileDC::wxMetafileDC(const wxString& file, int xext, int yext, int xorg, int yorg)
187 {
188 m_minX = 10000;
189 m_minY = 10000;
190 m_maxX = -10000;
191 m_maxY = -10000;
192 if ( !file.empty() && wxFileExists(file) )
193 wxRemoveFile(file);
194 m_hDC = (WXHDC) CreateMetaFile(file.empty() ? NULL : file.c_str());
195
196 m_ok = true;
197
198 ::SetWindowOrgEx((HDC) m_hDC,xorg,yorg, NULL);
199 ::SetWindowExtEx((HDC) m_hDC,xext,yext, NULL);
200
201 // Actual Windows mapping mode, for future reference.
202 m_windowsMappingMode = wxMM_ANISOTROPIC;
203
204 SetMapMode(wxMM_TEXT); // NOTE: does not set HDC mapmode (this is correct)
205 }
206
207 wxMetafileDC::~wxMetafileDC()
208 {
209 m_hDC = 0;
210 }
211
212 void wxMetafileDC::GetTextExtent(const wxString& string, long *x, long *y,
213 long *descent, long *externalLeading, wxFont *theFont, bool WXUNUSED(use16bit)) const
214 {
215 wxFont *fontToUse = theFont;
216 if (!fontToUse)
217 fontToUse = (wxFont*) &m_font;
218
219 HDC dc = GetDC(NULL);
220
221 SIZE sizeRect;
222 TEXTMETRIC tm;
223 ::GetTextExtentPoint32(dc, WXSTRINGCAST string, wxStrlen(WXSTRINGCAST string), &sizeRect);
224 GetTextMetrics(dc, &tm);
225
226 ReleaseDC(NULL, dc);
227
228 if ( x )
229 *x = sizeRect.cx;
230 if ( y )
231 *y = sizeRect.cy;
232 if ( descent )
233 *descent = tm.tmDescent;
234 if ( externalLeading )
235 *externalLeading = tm.tmExternalLeading;
236 }
237
238 void wxMetafileDC::DoGetSize(int *width, int *height) const
239 {
240 wxCHECK_RET( m_refData, _T("invalid wxMetafileDC") );
241
242 if ( width )
243 *width = M_METAFILEDATA->m_width;
244 if ( height )
245 *height = M_METAFILEDATA->m_height;
246 }
247
248 wxMetafile *wxMetafileDC::Close()
249 {
250 SelectOldObjects(m_hDC);
251 HANDLE mf = CloseMetaFile((HDC) m_hDC);
252 m_hDC = 0;
253 if (mf)
254 {
255 wxMetafile *wx_mf = new wxMetafile;
256 wx_mf->SetHMETAFILE((WXHANDLE) mf);
257 wx_mf->SetWindowsMappingMode(m_windowsMappingMode);
258 return wx_mf;
259 }
260 return NULL;
261 }
262
263 void wxMetafileDC::SetMapMode(int mode)
264 {
265 m_mappingMode = mode;
266
267 // int pixel_width = 0;
268 // int pixel_height = 0;
269 // int mm_width = 0;
270 // int mm_height = 0;
271
272 float mm2pixelsX = 10.0;
273 float mm2pixelsY = 10.0;
274
275 switch (mode)
276 {
277 case wxMM_TWIPS:
278 {
279 m_logicalScaleX = (float)(twips2mm * mm2pixelsX);
280 m_logicalScaleY = (float)(twips2mm * mm2pixelsY);
281 break;
282 }
283 case wxMM_POINTS:
284 {
285 m_logicalScaleX = (float)(pt2mm * mm2pixelsX);
286 m_logicalScaleY = (float)(pt2mm * mm2pixelsY);
287 break;
288 }
289 case wxMM_METRIC:
290 {
291 m_logicalScaleX = mm2pixelsX;
292 m_logicalScaleY = mm2pixelsY;
293 break;
294 }
295 case wxMM_LOMETRIC:
296 {
297 m_logicalScaleX = (float)(mm2pixelsX/10.0);
298 m_logicalScaleY = (float)(mm2pixelsY/10.0);
299 break;
300 }
301 default:
302 case wxMM_TEXT:
303 {
304 m_logicalScaleX = 1.0;
305 m_logicalScaleY = 1.0;
306 break;
307 }
308 }
309 }
310
311 // ----------------------------------------------------------------------------
312 // wxMakeMetafilePlaceable
313 // ----------------------------------------------------------------------------
314
315 #ifdef __WIN32__
316 struct RECT32
317 {
318 short left;
319 short top;
320 short right;
321 short bottom;
322 };
323
324 struct mfPLACEABLEHEADER {
325 DWORD key;
326 short hmf;
327 RECT32 bbox;
328 WORD inch;
329 DWORD reserved;
330 WORD checksum;
331 };
332 #else
333 struct mfPLACEABLEHEADER {
334 DWORD key;
335 HANDLE hmf;
336 RECT bbox;
337 WORD inch;
338 DWORD reserved;
339 WORD checksum;
340 };
341 #endif
342
343 /*
344 * Pass filename of existing non-placeable metafile, and bounding box.
345 * Adds a placeable metafile header, sets the mapping mode to anisotropic,
346 * and sets the window origin and extent to mimic the wxMM_TEXT mapping mode.
347 *
348 */
349
350 bool wxMakeMetafilePlaceable(const wxString& filename, float scale)
351 {
352 return wxMakeMetafilePlaceable(filename, 0, 0, 0, 0, scale, false);
353 }
354
355 bool wxMakeMetafilePlaceable(const wxString& filename, int x1, int y1, int x2, int y2, float scale, bool useOriginAndExtent)
356 {
357 // I'm not sure if this is the correct way of suggesting a scale
358 // to the client application, but it's the only way I can find.
359 int unitsPerInch = (int)(576/scale);
360
361 mfPLACEABLEHEADER header;
362 header.key = 0x9AC6CDD7L;
363 header.hmf = 0;
364 header.bbox.left = (int)(x1);
365 header.bbox.top = (int)(y1);
366 header.bbox.right = (int)(x2);
367 header.bbox.bottom = (int)(y2);
368 header.inch = unitsPerInch;
369 header.reserved = 0;
370
371 // Calculate checksum
372 WORD *p;
373 mfPLACEABLEHEADER *pMFHead = &header;
374 for (p =(WORD *)pMFHead,pMFHead -> checksum = 0;
375 p < (WORD *)&pMFHead ->checksum; ++p)
376 pMFHead ->checksum ^= *p;
377
378 FILE *fd = wxFopen(filename.fn_str(), _T("rb"));
379 if (!fd) return false;
380
381 wxChar tempFileBuf[256];
382 wxGetTempFileName(wxT("mf"), tempFileBuf);
383 FILE *fHandle = wxFopen(wxFNCONV(tempFileBuf), _T("wb"));
384 if (!fHandle)
385 return false;
386 fwrite((void *)&header, sizeof(unsigned char), sizeof(mfPLACEABLEHEADER), fHandle);
387
388 // Calculate origin and extent
389 int originX = x1;
390 int originY = y1;
391 int extentX = x2 - x1;
392 int extentY = (y2 - y1);
393
394 // Read metafile header and write
395 METAHEADER metaHeader;
396 fread((void *)&metaHeader, sizeof(unsigned char), sizeof(metaHeader), fd);
397
398 if (useOriginAndExtent)
399 metaHeader.mtSize += 15;
400 else
401 metaHeader.mtSize += 5;
402
403 fwrite((void *)&metaHeader, sizeof(unsigned char), sizeof(metaHeader), fHandle);
404
405 // Write SetMapMode, SetWindowOrigin and SetWindowExt records
406 char modeBuffer[8];
407 char originBuffer[10];
408 char extentBuffer[10];
409 METARECORD *modeRecord = (METARECORD *)&modeBuffer;
410
411 METARECORD *originRecord = (METARECORD *)&originBuffer;
412 METARECORD *extentRecord = (METARECORD *)&extentBuffer;
413
414 modeRecord->rdSize = 4;
415 modeRecord->rdFunction = META_SETMAPMODE;
416 modeRecord->rdParm[0] = MM_ANISOTROPIC;
417
418 originRecord->rdSize = 5;
419 originRecord->rdFunction = META_SETWINDOWORG;
420 originRecord->rdParm[0] = originY;
421 originRecord->rdParm[1] = originX;
422
423 extentRecord->rdSize = 5;
424 extentRecord->rdFunction = META_SETWINDOWEXT;
425 extentRecord->rdParm[0] = extentY;
426 extentRecord->rdParm[1] = extentX;
427
428 fwrite((void *)modeBuffer, sizeof(char), 8, fHandle);
429
430 if (useOriginAndExtent)
431 {
432 fwrite((void *)originBuffer, sizeof(char), 10, fHandle);
433 fwrite((void *)extentBuffer, sizeof(char), 10, fHandle);
434 }
435
436 int ch = -2;
437 while (ch != EOF)
438 {
439 ch = getc(fd);
440 if (ch != EOF)
441 {
442 putc(ch, fHandle);
443 }
444 }
445 fclose(fHandle);
446 fclose(fd);
447 wxRemoveFile(filename);
448 wxCopyFile(tempFileBuf, filename);
449 wxRemoveFile(tempFileBuf);
450 return true;
451 }
452
453
454 #if wxUSE_DRAG_AND_DROP
455
456 // ----------------------------------------------------------------------------
457 // wxMetafileDataObject
458 // ----------------------------------------------------------------------------
459
460 size_t wxMetafileDataObject::GetDataSize() const
461 {
462 return sizeof(METAFILEPICT);
463 }
464
465 bool wxMetafileDataObject::GetDataHere(void *buf) const
466 {
467 METAFILEPICT *mfpict = (METAFILEPICT *)buf;
468 const wxMetafile& mf = GetMetafile();
469
470 wxCHECK_MSG( mf.GetHMETAFILE(), false, _T("copying invalid metafile") );
471
472 // doesn't seem to work with any other mapping mode...
473 mfpict->mm = MM_ANISOTROPIC; //mf.GetWindowsMappingMode();
474 mfpict->xExt = mf.GetWidth();
475 mfpict->yExt = mf.GetHeight();
476
477 // transform the picture size to HIMETRIC units (0.01mm) - as we don't know
478 // what DC the picture will be rendered to, use the default display one
479 PixelToHIMETRIC(&mfpict->xExt, &mfpict->yExt);
480
481 mfpict->hMF = CopyMetaFile((HMETAFILE)mf.GetHMETAFILE(), NULL);
482
483 return true;
484 }
485
486 bool wxMetafileDataObject::SetData(size_t WXUNUSED(len), const void *buf)
487 {
488 const METAFILEPICT *mfpict = (const METAFILEPICT *)buf;
489
490 wxMetafile mf;
491 mf.SetWindowsMappingMode(mfpict->mm);
492
493 LONG w = mfpict->xExt,
494 h = mfpict->yExt;
495 if ( mfpict->mm == MM_ANISOTROPIC )
496 {
497 // in this case xExt and yExt contain suggested size in HIMETRIC units
498 // (0.01 mm) - transform this to something more reasonable (pixels)
499 HIMETRICToPixel(&w, &h);
500 }
501
502 mf.SetWidth(w);
503 mf.SetHeight(h);
504 mf.SetHMETAFILE((WXHANDLE)mfpict->hMF);
505
506 wxCHECK_MSG( mfpict->hMF, false, _T("pasting invalid metafile") );
507
508 SetMetafile(mf);
509
510 return true;
511 }
512
513 #endif // wxUSE_DRAG_AND_DROP
514
515 #endif // wxUSE_METAFILE