2 * Copyright (C) 2008 Google (Lei Zhang)
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library 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 GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 #include "gdiplus_private.h"
29 #include "wine/debug.h"
31 WINE_DEFAULT_DEBUG_CHANNEL(gdiplus);
33 /**********************************************************
35 * Data returned by GdipGetRegionData looks something like this:
37 * struct region_data_header
39 * DWORD size; size in bytes of the data - 8.
40 * DWORD magic1; probably a checksum.
41 * DWORD magic2; always seems to be 0xdbc01001 - version?
42 * DWORD num_ops; number of combining ops * 2
45 * Then follows a sequence of combining ops and region elements.
47 * A region element is either a RECTF or some path data.
49 * Combining ops are just stored as their CombineMode value.
51 * Each RECTF is preceded by the DWORD 0x10000000. An empty rect is
52 * stored as 0x10000002 (with no following RECTF) and an infinite rect
53 * is stored as 0x10000003 (again with no following RECTF).
55 * Path data is preceded by the DWORD 0x10000001. Then follows a
56 * DWORD size and then size bytes of data.
58 * The combining ops are stored in the reverse order to the region
59 * elements and in the reverse order to which the region was
62 * When two or more complex regions (ie those with more than one
63 * element) are combined, the combining op for the two regions comes
64 * first, then the combining ops for the region elements in region 1,
65 * followed by the region elements for region 1, then follows the
66 * combining ops for region 2 and finally region 2's region elements.
67 * Presumably you're supposed to use the 0x1000000x header to find the
68 * end of the op list (the count of the elements in each region is not
71 * When a simple region (1 element) is combined, it's treated as if a
72 * single rect/path is being combined.
76 #define FLAGS_NOFLAGS 0x0
77 #define FLAGS_INTPATH 0x4000
79 /* Header size as far as header->size is concerned. This doesn't include
80 * header->size or header->checksum
82 static const INT sizeheader_size = sizeof(DWORD) * 2;
84 typedef struct packed_point
90 /* Everything is measured in DWORDS; round up if there's a remainder */
91 static inline INT get_pathtypes_size(const GpPath* path)
93 INT needed = path->pathdata.Count / sizeof(DWORD);
95 if (path->pathdata.Count % sizeof(DWORD) > 0)
98 return needed * sizeof(DWORD);
101 static inline INT get_element_size(const region_element* element)
103 INT needed = sizeof(DWORD); /* DWORD for the type */
104 switch(element->type)
107 return needed + sizeof(GpRect);
109 needed += element->elementdata.pathdata.pathheader.size;
110 needed += sizeof(DWORD); /* Extra DWORD for pathheader.size */
112 case RegionDataEmptyRect:
113 case RegionDataInfiniteRect:
116 needed += get_element_size(element->elementdata.combine.left);
117 needed += get_element_size(element->elementdata.combine.right);
124 /* Does not check parameters, caller must do that */
125 static inline GpStatus init_region(GpRegion* region, const RegionType type)
127 region->node.type = type;
128 region->header.checksum = 0xdeadbeef;
129 region->header.magic = VERSION_MAGIC;
130 region->header.num_children = 0;
131 region->header.size = sizeheader_size + get_element_size(®ion->node);
136 static inline GpStatus clone_element(const region_element* element,
137 region_element** element2)
141 /* root node is allocated with GpRegion */
143 *element2 = GdipAlloc(sizeof(region_element));
148 (*element2)->type = element->type;
150 switch (element->type)
153 (*element2)->elementdata.rect = element->elementdata.rect;
155 case RegionDataEmptyRect:
156 case RegionDataInfiniteRect:
159 (*element2)->elementdata.pathdata.pathheader = element->elementdata.pathdata.pathheader;
160 stat = GdipClonePath(element->elementdata.pathdata.path,
161 &(*element2)->elementdata.pathdata.path);
162 if (stat != Ok) goto clone_out;
165 (*element2)->elementdata.combine.left = NULL;
166 (*element2)->elementdata.combine.right = NULL;
168 stat = clone_element(element->elementdata.combine.left,
169 &(*element2)->elementdata.combine.left);
170 if (stat != Ok) goto clone_out;
171 stat = clone_element(element->elementdata.combine.right,
172 &(*element2)->elementdata.combine.right);
173 if (stat != Ok) goto clone_out;
180 delete_element(*element2);
185 /* Common code for CombineRegion*
186 * All the caller has to do is get its format into an element
188 static inline void fuse_region(GpRegion* region, region_element* left,
189 region_element* right, const CombineMode mode)
191 region->node.type = mode;
192 region->node.elementdata.combine.left = left;
193 region->node.elementdata.combine.right = right;
195 region->header.size = sizeheader_size + get_element_size(®ion->node);
196 region->header.num_children += 2;
199 /*****************************************************************************
200 * GdipCloneRegion [GDIPLUS.@]
202 * Creates a deep copy of the region
205 * region [I] source region
206 * clone [O] resulting clone
210 * FAILURE: InvalidParameter or OutOfMemory
212 GpStatus WINGDIPAPI GdipCloneRegion(GpRegion *region, GpRegion **clone)
214 region_element *element;
216 TRACE("%p %p\n", region, clone);
218 if (!(region && clone))
219 return InvalidParameter;
221 *clone = GdipAlloc(sizeof(GpRegion));
224 element = &(*clone)->node;
226 (*clone)->header = region->header;
227 return clone_element(®ion->node, &element);
230 /*****************************************************************************
231 * GdipCombineRegionPath [GDIPLUS.@]
233 GpStatus WINGDIPAPI GdipCombineRegionPath(GpRegion *region, GpPath *path, CombineMode mode)
235 GpRegion *path_region;
236 region_element *left, *right = NULL;
239 TRACE("%p %p %d\n", region, path, mode);
241 if (!(region && path))
242 return InvalidParameter;
244 stat = GdipCreateRegionPath(path, &path_region);
248 /* simply replace region data */
249 if(mode == CombineModeReplace){
250 delete_element(®ion->node);
251 memcpy(region, path_region, sizeof(GpRegion));
255 left = GdipAlloc(sizeof(region_element));
258 *left = region->node;
260 stat = clone_element(&path_region->node, &right);
264 fuse_region(region, left, right, mode);
266 GdipDeleteRegion(path_region);
271 delete_element(right);
272 GdipDeleteRegion(path_region);
276 /*****************************************************************************
277 * GdipCombineRegionRect [GDIPLUS.@]
279 GpStatus WINGDIPAPI GdipCombineRegionRect(GpRegion *region,
280 GDIPCONST GpRectF *rect, CombineMode mode)
282 GpRegion *rect_region;
283 region_element *left, *right = NULL;
286 TRACE("%p %p %d\n", region, rect, mode);
288 if (!(region && rect))
289 return InvalidParameter;
291 stat = GdipCreateRegionRect(rect, &rect_region);
295 /* simply replace region data */
296 if(mode == CombineModeReplace){
297 delete_element(®ion->node);
298 memcpy(region, rect_region, sizeof(GpRegion));
302 left = GdipAlloc(sizeof(region_element));
305 memcpy(left, ®ion->node, sizeof(region_element));
307 stat = clone_element(&rect_region->node, &right);
311 fuse_region(region, left, right, mode);
313 GdipDeleteRegion(rect_region);
318 delete_element(right);
319 GdipDeleteRegion(rect_region);
323 /*****************************************************************************
324 * GdipCombineRegionRectI [GDIPLUS.@]
326 GpStatus WINGDIPAPI GdipCombineRegionRectI(GpRegion *region,
327 GDIPCONST GpRect *rect, CombineMode mode)
331 TRACE("%p %p %d\n", region, rect, mode);
334 return InvalidParameter;
336 rectf.X = (REAL)rect->X;
337 rectf.Y = (REAL)rect->Y;
338 rectf.Height = (REAL)rect->Height;
339 rectf.Width = (REAL)rect->Width;
341 return GdipCombineRegionRect(region, &rectf, mode);
344 GpStatus WINGDIPAPI GdipCombineRegionRegion(GpRegion *region1,
345 GpRegion *region2, CombineMode mode)
347 region_element *left, *right = NULL;
351 TRACE("%p %p %d\n", region1, region2, mode);
353 if(!(region1 && region2))
354 return InvalidParameter;
356 /* simply replace region data */
357 if(mode == CombineModeReplace){
358 stat = GdipCloneRegion(region2, ®2copy);
359 if(stat != Ok) return stat;
361 delete_element(®ion1->node);
362 memcpy(region1, reg2copy, sizeof(GpRegion));
367 left = GdipAlloc(sizeof(region_element));
371 *left = region1->node;
372 stat = clone_element(®ion2->node, &right);
376 delete_element(right);
380 fuse_region(region1, left, right, mode);
381 region1->header.num_children += region2->header.num_children;
386 /*****************************************************************************
387 * GdipCreateRegion [GDIPLUS.@]
389 GpStatus WINGDIPAPI GdipCreateRegion(GpRegion **region)
391 TRACE("%p\n", region);
394 return InvalidParameter;
396 *region = GdipAlloc(sizeof(GpRegion));
400 return init_region(*region, RegionDataInfiniteRect);
403 /*****************************************************************************
404 * GdipCreateRegionPath [GDIPLUS.@]
406 * Creates a GpRegion from a GpPath
409 * path [I] path to base the region on
410 * region [O] pointer to the newly allocated region
414 * FAILURE: InvalidParameter
417 * If a path has no floating point points, its points will be stored as shorts
420 * If a path is empty, it is considered to be an INTPATH
422 GpStatus WINGDIPAPI GdipCreateRegionPath(GpPath *path, GpRegion **region)
424 region_element* element;
429 DWORD flags = FLAGS_INTPATH;
432 TRACE("%p, %p\n", path, region);
434 if (!(path && region))
435 return InvalidParameter;
437 *region = GdipAlloc(sizeof(GpRegion));
440 stat = init_region(*region, RegionDataPath);
443 GdipDeleteRegion(*region);
446 element = &(*region)->node;
447 count = path->pathdata.Count;
449 /* Test to see if the path is an Integer path */
452 pointsi = GdipAlloc(sizeof(GpPoint) * count);
453 pointsf = GdipAlloc(sizeof(GpPointF) * count);
454 if (!(pointsi && pointsf))
458 GdipDeleteRegion(*region);
462 stat = GdipGetPathPointsI(path, pointsi, count);
465 GdipDeleteRegion(*region);
468 stat = GdipGetPathPoints(path, pointsf, count);
471 GdipDeleteRegion(*region);
475 for (i = 0; i < count; i++)
477 if (!(pointsi[i].X == pointsf[i].X &&
478 pointsi[i].Y == pointsf[i].Y ))
480 flags = FLAGS_NOFLAGS;
488 stat = GdipClonePath(path, &element->elementdata.pathdata.path);
491 GdipDeleteRegion(*region);
495 /* 3 for headers, once again size doesn't count itself */
496 element->elementdata.pathdata.pathheader.size = ((sizeof(DWORD) * 3));
499 /* Floats, sent out as floats */
501 element->elementdata.pathdata.pathheader.size +=
502 (sizeof(DWORD) * count * 2);
504 /* INTs, sent out as packed shorts */
506 element->elementdata.pathdata.pathheader.size +=
507 (sizeof(DWORD) * count);
510 FIXME("Unhandled flags (%08x). Expect wrong results.\n", flags);
512 element->elementdata.pathdata.pathheader.size += get_pathtypes_size(path);
513 element->elementdata.pathdata.pathheader.magic = VERSION_MAGIC;
514 element->elementdata.pathdata.pathheader.count = count;
515 element->elementdata.pathdata.pathheader.flags = flags;
516 (*region)->header.size = sizeheader_size + get_element_size(element);
521 /*****************************************************************************
522 * GdipCreateRegionRect [GDIPLUS.@]
524 GpStatus WINGDIPAPI GdipCreateRegionRect(GDIPCONST GpRectF *rect,
529 TRACE("%p, %p\n", rect, region);
531 if (!(rect && region))
532 return InvalidParameter;
534 *region = GdipAlloc(sizeof(GpRegion));
535 stat = init_region(*region, RegionDataRect);
538 GdipDeleteRegion(*region);
542 (*region)->node.elementdata.rect.X = rect->X;
543 (*region)->node.elementdata.rect.Y = rect->Y;
544 (*region)->node.elementdata.rect.Width = rect->Width;
545 (*region)->node.elementdata.rect.Height = rect->Height;
550 GpStatus WINGDIPAPI GdipCreateRegionRectI(GDIPCONST GpRect *rect,
555 TRACE("%p, %p\n", rect, region);
557 rectf.X = (REAL)rect->X;
558 rectf.Y = (REAL)rect->Y;
559 rectf.Width = (REAL)rect->Width;
560 rectf.Height = (REAL)rect->Height;
562 return GdipCreateRegionRect(&rectf, region);
565 GpStatus WINGDIPAPI GdipCreateRegionRgnData(GDIPCONST BYTE *data, INT size, GpRegion **region)
567 FIXME("(%p, %d, %p): stub\n", data, size, region);
570 return NotImplemented;
573 GpStatus WINGDIPAPI GdipCreateRegionHrgn(HRGN hrgn, GpRegion **region)
575 FIXME("(%p, %p): stub\n", hrgn, region);
578 return InvalidParameter;
581 return NotImplemented;
584 GpStatus WINGDIPAPI GdipDeleteRegion(GpRegion *region)
586 TRACE("%p\n", region);
589 return InvalidParameter;
591 delete_element(®ion->node);
597 GpStatus WINGDIPAPI GdipGetRegionBounds(GpRegion *region, GpGraphics *graphics, GpRectF *rect)
599 FIXME("(%p, %p, %p): stub\n", region, graphics, rect);
601 return NotImplemented;
604 GpStatus WINGDIPAPI GdipGetRegionBoundsI(GpRegion *region, GpGraphics *graphics, GpRect *rect)
606 FIXME("(%p, %p, %p): stub\n", region, graphics, rect);
608 return NotImplemented;
611 static inline void write_dword(DWORD* location, INT* offset, const DWORD write)
613 location[*offset] = write;
617 static inline void write_float(DWORD* location, INT* offset, const FLOAT write)
619 ((FLOAT*)location)[*offset] = write;
623 static inline void write_packed_point(DWORD* location, INT* offset,
624 const GpPointF* write)
630 memcpy(location + *offset, &point, sizeof(packed_point));
634 static inline void write_path_types(DWORD* location, INT* offset,
637 memcpy(location + *offset, path->pathdata.Types, path->pathdata.Count);
639 /* The unwritten parts of the DWORD (if any) must be cleared */
640 if (path->pathdata.Count % sizeof(DWORD))
641 ZeroMemory(((BYTE*)location) + (*offset * sizeof(DWORD)) +
642 path->pathdata.Count,
643 sizeof(DWORD) - path->pathdata.Count % sizeof(DWORD));
644 *offset += (get_pathtypes_size(path) / sizeof(DWORD));
647 static void write_element(const region_element* element, DWORD *buffer,
650 write_dword(buffer, filled, element->type);
651 switch (element->type)
653 case CombineModeReplace:
654 case CombineModeIntersect:
655 case CombineModeUnion:
657 case CombineModeExclude:
658 case CombineModeComplement:
659 write_element(element->elementdata.combine.left, buffer, filled);
660 write_element(element->elementdata.combine.right, buffer, filled);
663 write_float(buffer, filled, element->elementdata.rect.X);
664 write_float(buffer, filled, element->elementdata.rect.Y);
665 write_float(buffer, filled, element->elementdata.rect.Width);
666 write_float(buffer, filled, element->elementdata.rect.Height);
671 const GpPath* path = element->elementdata.pathdata.path;
673 memcpy(buffer + *filled, &element->elementdata.pathdata.pathheader,
674 sizeof(element->elementdata.pathdata.pathheader));
675 *filled += sizeof(element->elementdata.pathdata.pathheader) / sizeof(DWORD);
676 switch (element->elementdata.pathdata.pathheader.flags)
679 for (i = 0; i < path->pathdata.Count; i++)
681 write_float(buffer, filled, path->pathdata.Points[i].X);
682 write_float(buffer, filled, path->pathdata.Points[i].Y);
686 for (i = 0; i < path->pathdata.Count; i++)
688 write_packed_point(buffer, filled,
689 &path->pathdata.Points[i]);
692 write_path_types(buffer, filled, path);
695 case RegionDataEmptyRect:
696 case RegionDataInfiniteRect:
701 /*****************************************************************************
702 * GdipGetRegionData [GDIPLUS.@]
704 * Returns the header, followed by combining ops and region elements.
707 * region [I] region to retrieve from
708 * buffer [O] buffer to hold the resulting data
709 * size [I] size of the buffer
710 * needed [O] (optional) how much data was written
714 * FAILURE: InvalidParamter
717 * The header contains the size, a checksum, a version string, and the number
718 * of children. The size does not count itself or the checksum.
719 * Version is always something like 0xdbc01001 or 0xdbc01002
721 * An element is a RECT, or PATH; Combining ops are stored as their
722 * CombineMode value. Special regions (infinite, empty) emit just their
723 * op-code; GpRectFs emit their code followed by their points; GpPaths emit
724 * their code followed by a second header for the path followed by the actual
725 * path data. Followed by the flags for each point. The pathheader contains
726 * the size of the data to follow, a version number again, followed by a count
727 * of how many points, and any special flags which may apply. 0x4000 means its
728 * a path of shorts instead of FLOAT.
730 * Combining Ops are stored in reverse order from when they were constructed;
731 * the output is a tree where the left side combining area is always taken
734 GpStatus WINGDIPAPI GdipGetRegionData(GpRegion *region, BYTE *buffer, UINT size,
739 TRACE("%p, %p, %d, %p\n", region, buffer, size, needed);
741 if (!(region && buffer && size))
742 return InvalidParameter;
744 memcpy(buffer, ®ion->header, sizeof(region->header));
745 filled += sizeof(region->header) / sizeof(DWORD);
746 /* With few exceptions, everything written is DWORD aligned,
747 * so use that as our base */
748 write_element(®ion->node, (DWORD*)buffer, &filled);
751 *needed = filled * sizeof(DWORD);
756 /*****************************************************************************
757 * GdipGetRegionDataSize [GDIPLUS.@]
759 GpStatus WINGDIPAPI GdipGetRegionDataSize(GpRegion *region, UINT *needed)
761 TRACE("%p, %p\n", region, needed);
763 if (!(region && needed))
764 return InvalidParameter;
766 /* header.size doesn't count header.size and header.checksum */
767 *needed = region->header.size + sizeof(DWORD) * 2;
772 static GpStatus get_path_hrgn(GpPath *path, GpGraphics *graphics, HRGN *hrgn)
784 stat = GdipCreateFromHDC(new_hdc, &graphics);
787 ReleaseDC(0, new_hdc);
792 save_state = SaveDC(graphics->hdc);
793 EndPath(graphics->hdc);
795 SetPolyFillMode(graphics->hdc, (path->fill == FillModeAlternate ? ALTERNATE
798 stat = trace_path(graphics, path);
801 *hrgn = PathToRegion(graphics->hdc);
802 stat = *hrgn ? Ok : OutOfMemory;
805 RestoreDC(graphics->hdc, save_state);
808 ReleaseDC(0, new_hdc);
809 GdipDeleteGraphics(graphics);
815 static GpStatus get_region_hrgn(struct region_element *element, GpGraphics *graphics, HRGN *hrgn)
817 switch (element->type)
819 case RegionDataInfiniteRect:
822 case RegionDataEmptyRect:
823 *hrgn = CreateRectRgn(0, 0, 0, 0);
824 return *hrgn ? Ok : OutOfMemory;
826 return get_path_hrgn(element->elementdata.pathdata.path, graphics, hrgn);
831 GpRectF* rc = &element->elementdata.rect;
833 stat = GdipCreatePath(FillModeAlternate, &path);
836 stat = GdipAddPathRectangle(path, rc->X, rc->Y, rc->Width, rc->Height);
839 stat = get_path_hrgn(path, graphics, hrgn);
841 GdipDeletePath(path);
845 case CombineModeIntersect:
846 case CombineModeUnion:
848 case CombineModeExclude:
849 case CombineModeComplement:
855 stat = get_region_hrgn(element->elementdata.combine.left, graphics, &left);
864 /* existing region is infinite */
865 switch (element->type)
867 case CombineModeIntersect:
868 return get_region_hrgn(element->elementdata.combine.right, graphics, hrgn);
869 case CombineModeXor: case CombineModeExclude:
870 FIXME("cannot exclude from an infinite region\n");
872 case CombineModeUnion: case CombineModeComplement:
878 stat = get_region_hrgn(element->elementdata.combine.right, graphics, &right);
888 /* new region is infinite */
889 switch (element->type)
891 case CombineModeIntersect:
894 case CombineModeXor: case CombineModeComplement:
895 FIXME("cannot exclude from an infinite region\n");
897 case CombineModeUnion: case CombineModeExclude:
904 switch (element->type)
906 case CombineModeIntersect:
907 ret = CombineRgn(left, left, right, RGN_AND);
909 case CombineModeUnion:
910 ret = CombineRgn(left, left, right, RGN_OR);
913 ret = CombineRgn(left, left, right, RGN_XOR);
915 case CombineModeExclude:
916 ret = CombineRgn(left, left, right, RGN_DIFF);
918 case CombineModeComplement:
919 ret = CombineRgn(left, right, left, RGN_DIFF);
938 FIXME("GdipGetRegionHRgn unimplemented for region type=%x\n", element->type);
940 return NotImplemented;
944 /*****************************************************************************
945 * GdipGetRegionHRgn [GDIPLUS.@]
947 GpStatus WINGDIPAPI GdipGetRegionHRgn(GpRegion *region, GpGraphics *graphics, HRGN *hrgn)
949 TRACE("(%p, %p, %p)\n", region, graphics, hrgn);
951 if (!region || !hrgn)
952 return InvalidParameter;
954 return get_region_hrgn(®ion->node, graphics, hrgn);
957 GpStatus WINGDIPAPI GdipIsEmptyRegion(GpRegion *region, GpGraphics *graphics, BOOL *res)
959 TRACE("(%p, %p, %p)\n", region, graphics, res);
961 if(!region || !graphics || !res)
962 return InvalidParameter;
964 *res = (region->node.type == RegionDataEmptyRect);
969 GpStatus WINGDIPAPI GdipIsEqualRegion(GpRegion *region, GpRegion *region2, GpGraphics *graphics,
972 FIXME("(%p, %p, %p, %p): stub\n", region, region2, graphics, res);
974 return NotImplemented;
977 /*****************************************************************************
978 * GdipIsInfiniteRegion [GDIPLUS.@]
980 GpStatus WINGDIPAPI GdipIsInfiniteRegion(GpRegion *region, GpGraphics *graphics, BOOL *res)
982 /* I think graphics is ignored here */
983 TRACE("(%p, %p, %p)\n", region, graphics, res);
985 if(!region || !graphics || !res)
986 return InvalidParameter;
988 *res = (region->node.type == RegionDataInfiniteRect);
993 /*****************************************************************************
994 * GdipSetEmpty [GDIPLUS.@]
996 GpStatus WINGDIPAPI GdipSetEmpty(GpRegion *region)
1000 TRACE("%p\n", region);
1003 return InvalidParameter;
1005 delete_element(®ion->node);
1006 stat = init_region(region, RegionDataEmptyRect);
1011 GpStatus WINGDIPAPI GdipSetInfinite(GpRegion *region)
1015 TRACE("%p\n", region);
1018 return InvalidParameter;
1020 delete_element(®ion->node);
1021 stat = init_region(region, RegionDataInfiniteRect);
1026 GpStatus WINGDIPAPI GdipTransformRegion(GpRegion *region, GpMatrix *matrix)
1028 FIXME("(%p, %p): stub\n", region, matrix);
1030 return NotImplemented;
1033 GpStatus WINGDIPAPI GdipTranslateRegion(GpRegion *region, REAL dx, REAL dy)
1035 FIXME("(%p, %f, %f): stub\n", region, dx, dy);
1037 return NotImplemented;
1040 GpStatus WINGDIPAPI GdipTranslateRegionI(GpRegion *region, INT dx, INT dy)
1042 FIXME("(%p, %d, %d): stub\n", region, dx, dy);
1044 return NotImplemented;