dinput: Fix printing NULL strings.
[wine] / dlls / gdi32 / dibdrv / dibdrv.h
1 /*
2  * DIB driver include file.
3  *
4  * Copyright 2011 Huw Davies
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
21 enum dib_info_flags
22 {
23     private_color_table = 1
24 };
25
26 typedef struct
27 {
28     int bit_count, width, height;
29     int stride; /* stride in bytes.  Will be -ve for bottom-up dibs (see bits). */
30     struct gdi_image_bits bits; /* bits.ptr points to the top-left corner of the dib. */
31
32     DWORD red_mask, green_mask, blue_mask;
33     int red_shift, green_shift, blue_shift;
34     int red_len, green_len, blue_len;
35
36     RGBQUAD *color_table;
37     DWORD color_table_size;
38
39     enum dib_info_flags flags;
40
41     const struct primitive_funcs *funcs;
42 } dib_info;
43
44 typedef struct
45 {
46     DWORD count;
47     DWORD dashes[16]; /* 16 is the maximum number for a PS_USERSTYLE pen */
48     DWORD total_len;  /* total length of the dashes, should be multiplied by 2 if there are an odd number of dash lengths */
49 } dash_pattern;
50
51 typedef struct
52 {
53     int left_in_dash;
54     int cur_dash;
55     BOOL mark;
56 } dash_pos;
57
58 typedef struct
59 {
60     DWORD and;
61     DWORD xor;
62 } rop_mask;
63
64 typedef struct
65 {
66     void *and;
67     void *xor;
68 } rop_mask_bits;
69
70 typedef struct dibdrv_physdev
71 {
72     struct gdi_physdev dev;
73     dib_info dib;
74
75     HRGN clip;
76     DWORD defer;
77
78     /* pen */
79     COLORREF pen_colorref;
80     DWORD pen_color, pen_and, pen_xor;
81     dash_pattern pen_pattern;
82     dash_pos dash_pos;
83     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts);
84
85     /* brush */
86     UINT brush_style;
87     UINT brush_hatch;
88     INT brush_rop;   /* PatBlt, for example, can override the DC's rop2 */
89     COLORREF brush_colorref;
90     DWORD brush_color, brush_and, brush_xor;
91     dib_info brush_dib;
92     void *brush_and_bits, *brush_xor_bits;
93     BOOL   (* brush_rects)(struct dibdrv_physdev *pdev, dib_info *dib, int num, const RECT *rects, HRGN clip);
94
95     /* background */
96     DWORD bkgnd_color, bkgnd_and, bkgnd_xor;
97 } dibdrv_physdev;
98
99 #define DEFER_FORMAT     1
100 #define DEFER_PEN        2
101 #define DEFER_BRUSH      4
102
103 extern DWORD    dibdrv_GetImage( PHYSDEV dev, HBITMAP hbitmap, BITMAPINFO *info,
104                                  struct gdi_image_bits *bits, struct bitblt_coords *src ) DECLSPEC_HIDDEN;
105 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
106 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
107 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
108 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
109                                      DWORD polylines ) DECLSPEC_HIDDEN;
110 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
111 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HBITMAP hbitmap, HRGN clip, BITMAPINFO *info,
112                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
113                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
114 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
115 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush ) DECLSPEC_HIDDEN;
116 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen ) DECLSPEC_HIDDEN;
117 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
118 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
119
120 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
121 {
122     return (dibdrv_physdev *)dev;
123 }
124
125 typedef struct primitive_funcs
126 {
127     void        (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
128     void      (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign, const dib_info *brush, void *and_bits, void *xor_bits);
129     void          (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src, const POINT *origin, int rop2);
130     DWORD (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
131     BOOL         (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect);
132     BOOL   (* create_rop_masks)(const dib_info *dib, const dib_info *hatch, const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
133 } primitive_funcs;
134
135 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
136 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
137 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
138 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
139 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
140 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
141 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
142 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
143 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
144
145 struct rop_codes
146 {
147     DWORD a1, a2, x1, x2;
148 };
149
150 extern void get_rop_codes(INT rop, struct rop_codes *codes);
151 extern void calc_and_xor_masks(INT rop, DWORD color, DWORD *and, DWORD *xor) DECLSPEC_HIDDEN;
152 extern void update_brush_rop( dibdrv_physdev *pdev, INT rop ) DECLSPEC_HIDDEN;
153 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
154 extern BOOL init_dib_info(dib_info *dib, const BITMAPINFOHEADER *bi, const DWORD *bit_fields,
155                           RGBQUAD *color_table, int color_table_size, void *bits,
156                           enum dib_info_flags flags) DECLSPEC_HIDDEN;
157 extern BOOL init_dib_info_from_packed(dib_info *dib, const BITMAPINFOHEADER *bi, WORD usage, HPALETTE pal) DECLSPEC_HIDDEN;
158 extern BOOL init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits,
159                                           enum dib_info_flags flags) DECLSPEC_HIDDEN;
160 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp, enum dib_info_flags flags) DECLSPEC_HIDDEN;
161 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
162 extern void free_pattern_brush(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
163 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
164 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
165 extern DWORD get_fg_color(dibdrv_physdev *pdev, COLORREF color) DECLSPEC_HIDDEN;
166 extern BOOL brush_rects( dibdrv_physdev *pdev, int num, const RECT *rects ) DECLSPEC_HIDDEN;
167 extern HRGN add_extra_clipping_region( dibdrv_physdev *pdev, HRGN rgn ) DECLSPEC_HIDDEN;
168 extern void restore_clipping_region( dibdrv_physdev *pdev, HRGN rgn ) DECLSPEC_HIDDEN;
169
170 static inline BOOL defer_pen(dibdrv_physdev *pdev)
171 {
172     return pdev->defer & (DEFER_FORMAT | DEFER_PEN);
173 }
174
175 static inline BOOL defer_brush(dibdrv_physdev *pdev)
176 {
177     return pdev->defer & (DEFER_FORMAT | DEFER_BRUSH);
178 }