1/***********************************************************
2
3Copyright 1987, 1998  The Open Group
4
5Permission to use, copy, modify, distribute, and sell this software and its
6documentation for any purpose is hereby granted without fee, provided that
7the above copyright notice appear in all copies and that both that
8copyright notice and this permission notice appear in supporting
9documentation.
10
11The above copyright notice and this permission notice shall be included in
12all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21Except as contained in this notice, the name of The Open Group shall not be
22used in advertising or otherwise to promote the sale, use or other dealings
23in this Software without prior written authorization from The Open Group.
24
25
26Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
27
28                        All Rights Reserved
29
30Permission to use, copy, modify, and distribute this software and its
31documentation for any purpose and without fee is hereby granted,
32provided that the above copyright notice appear in all copies and that
33both that copyright notice and this permission notice appear in
34supporting documentation, and that the name of Digital not be
35used in advertising or publicity pertaining to distribution of the
36software without specific, written prior permission.
37
38DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44SOFTWARE.
45
46******************************************************************/
47
48#ifndef GC_H
49#define GC_H
50
51#include <X11/X.h>	/* for GContext, Mask */
52#include <X11/Xdefs.h>	/* for Bool */
53#include <X11/Xproto.h>
54#include "screenint.h"	/* for ScreenPtr */
55#include "pixmap.h"	/* for DrawablePtr */
56
57/* clientClipType field in GC */
58#define CT_NONE			0
59#define CT_PIXMAP		1
60#define CT_REGION		2
61#define CT_UNSORTED		6
62#define CT_YSORTED		10
63#define CT_YXSORTED		14
64#define CT_YXBANDED		18
65
66#define GCQREASON_VALIDATE	1
67#define GCQREASON_CHANGE	2
68#define GCQREASON_COPY_SRC	3
69#define GCQREASON_COPY_DST	4
70#define GCQREASON_DESTROY	5
71
72#define GC_CHANGE_SERIAL_BIT        (((unsigned long)1)<<31)
73#define GC_CALL_VALIDATE_BIT        (1L<<30)
74#define GCExtensionInterest   (1L<<29)
75
76#define DRAWABLE_SERIAL_BITS        (~(GC_CHANGE_SERIAL_BIT))
77
78#define MAX_SERIAL_NUM     (1L<<28)
79
80#define NEXT_SERIAL_NUMBER ((++globalSerialNumber) > MAX_SERIAL_NUM ? \
81	    (globalSerialNumber  = 1): globalSerialNumber)
82
83typedef struct _GCInterest *GCInterestPtr;
84typedef struct _GC    *GCPtr;
85typedef struct _GCOps *GCOpsPtr;
86
87extern _X_EXPORT void ValidateGC(
88    DrawablePtr /*pDraw*/,
89    GCPtr /*pGC*/);
90
91typedef union {
92    CARD32 val;
93    pointer ptr;
94} ChangeGCVal, *ChangeGCValPtr;
95
96extern int ChangeGCXIDs(
97    ClientPtr /*client*/,
98    GCPtr /*pGC*/,
99    BITS32 /*mask*/,
100    CARD32 * /*pval*/);
101
102extern _X_EXPORT int ChangeGC(
103    ClientPtr /*client*/,
104    GCPtr /*pGC*/,
105    BITS32 /*mask*/,
106    ChangeGCValPtr /*pCGCV*/);
107
108extern _X_EXPORT GCPtr CreateGC(
109    DrawablePtr /*pDrawable*/,
110    BITS32 /*mask*/,
111    XID* /*pval*/,
112    int* /*pStatus*/,
113    XID /*gcid*/,
114    ClientPtr /*client*/);
115
116extern _X_EXPORT int CopyGC(
117    GCPtr/*pgcSrc*/,
118    GCPtr/*pgcDst*/,
119    BITS32 /*mask*/);
120
121extern _X_EXPORT int FreeGC(
122    pointer /*pGC*/,
123    XID /*gid*/);
124
125extern _X_EXPORT void FreeGCperDepth(
126    int /*screenNum*/);
127
128extern _X_EXPORT Bool CreateGCperDepth(
129    int /*screenNum*/);
130
131extern _X_EXPORT Bool CreateDefaultStipple(
132    int /*screenNum*/);
133
134extern _X_EXPORT void FreeDefaultStipple(
135    int /*screenNum*/);
136
137extern _X_EXPORT int SetDashes(
138    GCPtr /*pGC*/,
139    unsigned /*offset*/,
140    unsigned /*ndash*/,
141    unsigned char* /*pdash*/);
142
143extern _X_EXPORT int VerifyRectOrder(
144    int /*nrects*/,
145    xRectangle* /*prects*/,
146    int /*ordering*/);
147
148extern _X_EXPORT int SetClipRects(
149    GCPtr /*pGC*/,
150    int /*xOrigin*/,
151    int /*yOrigin*/,
152    int /*nrects*/,
153    xRectangle* /*prects*/,
154    int /*ordering*/);
155
156extern _X_EXPORT GCPtr GetScratchGC(
157    unsigned /*depth*/,
158    ScreenPtr /*pScreen*/);
159
160extern _X_EXPORT void FreeScratchGC(
161    GCPtr /*pGC*/);
162
163#endif /* GC_H */
164