scrnintstr.h revision a5e7ae69e440f6816420fc99599f044e79e716b6
/***********************************************************
Copyright 1987, 1998 The Open Group
Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of The Open Group shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from The Open Group.
Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Digital not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
******************************************************************/
#ifndef SCREENINTSTRUCT_H
#define SCREENINTSTRUCT_H
#include "screenint.h"
#include "regionstr.h"
#include "colormap.h"
#include "cursor.h"
#include "validate.h"
#include "dix.h"
#include "privates.h"
typedef struct _PixmapFormat {
unsigned char depth;
unsigned char bitsPerPixel;
unsigned char scanlinePad;
typedef struct _Visual {
short class;
short bitsPerRGBValue;
short ColormapEntries;
short nplanes; /* = log2 (ColormapEntries). This does not
* imply that the screen has this many planes.
* it may have more or fewer */
} VisualRec;
typedef struct _Depth {
unsigned char depth;
short numVids;
} DepthRec;
typedef struct _ScreenSaverStuff {
char blanked;
int /*xstate */ ,
Bool /*force */ );
/*
* There is a typedef for each screen function pointer so that code that
* needs to declare a screen function pointer (e.g. in a screen private
* or as a local variable) can easily do so and retain full type checking.
*/
typedef void (*QueryBestSizeProcPtr) (int /*class */ ,
unsigned short * /*pwidth */ ,
unsigned short * /*pheight */ ,
ScreenPtr /*pScreen */ );
int /*on */ );
int /*sx */ ,
int /*sy */ ,
int /*w */ ,
int /*h */ ,
unsigned int /*format */ ,
unsigned long /*planeMask */ ,
char * /*pdstLine */ );
int /*wMax */ ,
DDXPointPtr /*ppt */ ,
int * /*pwidth */ ,
int /*nspans */ ,
char * /*pdstStart */ );
int /*x */ ,
int /*y */ ,
int /*width */ ,
int /*height */ ,
unsigned int /*subWindowMode */ );
int /*x */ ,
int /*y */ );
unsigned long /*mask */ );
WindowPtr /*pOldNextSib */ );
WindowPtr /*pChild */ ,
VTKind /*kind */ );
WindowPtr /*pChild */ ,
VTKind /*kind */ );
RegionPtr /*prgn */);
DDXPointRec /*ptOldOrg */ ,
RegionPtr /*prgnSrc */ );
int /*x */ ,
int /*y */ ,
int /*w */ ,
int /*h */ ,
Bool /*generateExposures */ );
int /*dx */ ,
int /*dy */ );
/* pixmap will exist only for the duration of the current rendering operation */
#define CREATE_PIXMAP_USAGE_SCRATCH 1
/* pixmap will be the backing pixmap for a redirected window */
#define CREATE_PIXMAP_USAGE_BACKING_PIXMAP 2
/* pixmap will contain a glyph */
#define CREATE_PIXMAP_USAGE_GLYPH_PICTURE 3
/* pixmap will be shared */
#define CREATE_PIXMAP_USAGE_SHARED 4
int /*width */ ,
int /*height */ ,
int /*depth */ ,
unsigned /*usage_hint */ );
FontPtr /*pFont */ );
FontPtr /*pFont */ );
ScreenPtr /*pScreen */ ,
BoxPtr /*pBox */ );
ScreenPtr /*pScreen */ ,
CursorPtr /*pCursor */ ,
BoxPtr /*pHotBox */ ,
BoxPtr /*pTopLeftBox */ );
ScreenPtr /*pScreen */ ,
CursorPtr /*pCursor */ );
ScreenPtr /*pScreen */ ,
CursorPtr /*pCursor */ );
ScreenPtr /*pScreen */ ,
CursorPtr /*pCursor */ );
ScreenPtr /*pScreen */ ,
CursorPtr /*pCursor */ ,
Bool /*displayed */ );
ScreenPtr /*pScreen */ ,
int /*x */ ,
int /*y */ ,
Bool /*generateEvent */ );
XID * /*pmaps */ );
int /*ndef */ ,
xColorItem * /*pdef */ );
typedef void (*ResolveColorProcPtr) (unsigned short * /*pred */ ,
unsigned short * /*pgreen */ ,
unsigned short * /*pblue */ ,
VisualPtr /*pVisual */ );
void *pTimeout,
void *pReadmask);
unsigned long result,
void *pReadMask);
int width,
int height,
int depth,
int bitsPerPixel,
int devKind,
void *pPixData);
PixmapPtr /*pPix */ );
WindowPtr /*firstChild */ ,
WindowPtr * /*pLayerWin */ );
int /*x */ ,
int /*y */ ,
int /*w */ ,
int /*h */ ,
int /*bw */ ,
WindowPtr /*pSib */ );
int /*x */ ,
int /*y */ ,
WindowPtr /*pSib */ ,
VTKind /*kind */ );
int /*x */ ,
int /*y */ ,
unsigned int /*w */ ,
unsigned int /*h */ ,
WindowPtr /*pSib */
);
);
WindowPtr /*pPriorParent */ );
int /* kind */ );
unsigned int /*width */ );
WindowPtr /*pWin */ ,
Bool /*fromConfigure */ );
ScreenPtr /* pScreen */ );
ScreenPtr /* pScreen */ );
int *, int *);
int x, int y);
/* Wrapping Screen procedures
There are a few modules in the X server which dynamically add and
remove themselves from various screen procedure call chains.
For example, the BlockHandler is dynamically modified by:
* xf86Rotate
* miSprite
* composite
* render (for animated cursors)
Correctly manipulating this chain is complicated by the fact that
the chain is constructed through a sequence of screen private
structures, each holding the next screen->proc pointer.
To add a module to a screen->proc chain is fairly simple; just save
the current screen->proc value in the module screen private
and store the module's function in the screen->proc location.
Removing a screen proc is a bit trickier. It seems like all you
need to do is set the screen->proc pointer back to the value saved
in your screen private. However, if some other module has come
along and wrapped on top of you, then the right place to store the
previous screen->proc value is actually in the wrapping module's
screen private structure(!). Of course, you have no idea what
other module may have wrapped on top, nor could you poke inside
its screen private in any case.
To make this work, we restrict the unwrapping process to happen
during the invocation of the screen proc itself, and then we
require the screen proc to take some care when manipulating the
screen proc functions pointers.
The requirements are:
1) The screen proc must set the screen->proc pointer back to the
value saved in its screen private before calling outside its
module.
2a) If the screen proc wants to be remove itself from the chain,
it must not manipulate screen->proc pointer again before
returning.
2b) If the screen proc wants to remain in the chain, it must:
2b.1) Re-fetch the screen->proc pointer and store that in
its screen private. This ensures that any changes
to the chain will be preserved.
2b.2) Set screen->proc back to itself
One key requirement here is that these steps must wrap not just
any invocation of the nested screen->proc value, but must nest
essentially any calls outside the current module. This ensures
that other modules can reliably manipulate screen->proc wrapping
using these same rules.
For example, the animated cursor code in render has two macros,
Wrap and Unwrap.
#define Unwrap(as,s,elt) ((s)->elt = (as)->elt)
Unwrap takes the screen private (as), the screen (s) and the
member name (elt), and restores screen->proc to that saved in the
screen private.
#define Wrap(as,s,elt,func) (((as)->elt = (s)->elt), (s)->elt = func)
Wrap takes the screen private (as), the screen (s), the member
name (elt) and the wrapping function (func). It saves the
current screen->proc value in the screen private, and then sets the
screen->proc to the local wrapping function.
Within each of these functions, there's a pretty simple pattern:
Unwrap(as, pScreen, UnrealizeCursor);
// Do local stuff, including possibly calling down through
// pScreen->UnrealizeCursor
Wrap(as, pScreen, UnrealizeCursor, AnimCurUnrealizeCursor);
The wrapping block handler is a bit different; it does the Unwrap,
the local operations and then only re-Wraps if the hook is still
required. Unwrap occurrs at the top of each function, just after
entry, and Wrap occurrs at the bottom of each function, just
before returning.
*/
typedef struct _Screen {
int myNum; /* index of this instance in Screens[] */
short numDepths;
unsigned char rootDepth;
unsigned long rootVisual;
unsigned long defColormap;
short minInstalledCmaps, maxInstalledCmaps;
unsigned long whitePixel, blackPixel;
/* next field is a stipple to use as default in
a GC. we don't build default tiles of all depths
because they are likely to be of a color
different from the default fg pixel, so
we don't win anything by building
a standard one.
*/
void *devPrivate;
short numVisuals;
/* Random screen procedures */
/* Window Procedures */
/* Pixmap procedures */
/* Font procedures */
/* Cursor Procedures */
/* GC procedures */
/* Colormap procedures */
/* Region procedures */
/* os layer procedures */
/* anybody can get a piece of this array */
unsigned int totalPixmapSize;
/* Device cursor procedures */
/* set it in driver side if X server can copy the framebuffer content.
* Meant to be used together with '-background none' option, avoiding
* malicious users to steal framebuffer's content if that would be the
* default */
struct xorg_list unattached_list;
struct xorg_list unattached_head;
struct xorg_list output_slave_list;
struct xorg_list output_head;
struct xorg_list pixmap_dirty_list;
struct xorg_list offload_slave_list;
struct xorg_list offload_head;
} ScreenRec;
static inline RegionPtr
{
}
typedef struct _ScreenInfo {
int imageByteOrder;
int bitmapScanlineUnit;
int bitmapScanlinePad;
int bitmapBitOrder;
int numPixmapFormats;
int numScreens;
int numGPUScreens;
int x; /* origin */
int y; /* origin */
int width; /* total width of all screens together */
int height; /* total height of all screens together */
} ScreenInfo;
int /*argc */ ,
char ** /*argv */ );
#endif /* SCREENINTSTRUCT_H */