Commit db68f377 authored by Keith Packard's avatar Keith Packard
Browse files

Merge xcmiscproto

parents 9fa51891 141dc813
#
# X.Org module default exclusion patterns
# The next section if for module specific patterns
#
# Do not edit the following section
# GNU Build System (Autotools)
aclocal.m4
autom4te.cache/
autoscan.log
ChangeLog
compile
config.guess
config.h
config.h.in
config.log
config-ml.in
config.py
config.status
config.status.lineno
config.sub
configure
configure.scan
depcomp
.deps/
INSTALL
install-sh
.libs/
libtool
libtool.m4
ltmain.sh
lt~obsolete.m4
ltoptions.m4
ltsugar.m4
ltversion.m4
Makefile
Makefile.in
mdate-sh
missing
mkinstalldirs
*.pc
py-compile
stamp-h?
symlink-tree
texinfo.tex
ylwrap
# Do not edit the following section
# Edit Compile Debug Document Distribute
*~
*.[0-9]
*.[0-9]x
*.bak
*.bin
core
*.dll
*.exe
*-ISO*.bdf
*-JIS*.bdf
*-KOI8*.bdf
*.kld
*.ko
*.ko.cmd
*.lai
*.l[oa]
*.[oa]
*.obj
*.patch
*.so
*.pcf.gz
*.pdb
*.tar.bz2
*.tar.gz
#
# Add & Override patterns for xcmiscproto
#
# Edit the following section as needed
# For example, !report.pc overrides *.pc. See 'man gitignore'
#
Copyright 1993, 1994, 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.
SUBDIRS=specs
xcmiscdir = $(includedir)/X11/extensions
xcmisc_HEADERS = \
xcmiscproto.h \
xcmiscstr.h
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = xcmiscproto.pc
MAINTAINERCLEANFILES = ChangeLog INSTALL
.PHONY: ChangeLog INSTALL
INSTALL:
$(INSTALL_CMD)
ChangeLog:
$(CHANGELOG_CMD)
dist-hook: ChangeLog INSTALL
XC-MISC Extension
This extension defines a protocol that provides Xlib two ways to query
the server for available resource IDs.
Extension name: XC-MISC
All questions regarding this software should be directed at the
Xorg mailing list:
http://lists.freedesktop.org/mailman/listinfo/xorg
Please submit bug reports to the Xorg bugzilla:
https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
The master development code repository can be found at:
git://anongit.freedesktop.org/git/xorg/proto/xcmiscproto
http://cgit.freedesktop.org/xorg/proto/xcmiscproto
For patch submission instructions, see:
http://www.x.org/wiki/Development/Documentation/SubmittingPatches
For more information on the git code manager, see:
http://wiki.x.org/wiki/GitPage
#! /bin/sh
srcdir=`dirname "$0"`
test -z "$srcdir" && srcdir=.
ORIGDIR=`pwd`
cd "$srcdir"
autoreconf -v --install || exit 1
cd "$ORIGDIR" || exit $?
git config --local --get format.subjectPrefix >/dev/null 2>&1 ||
git config --local format.subjectPrefix "PATCH xcmiscproto"
if test -z "$NOCONFIGURE"; then
exec "$srcdir"/configure "$@"
fi
AC_PREREQ([2.60])
AC_INIT([XCMiscProto], [1.2.2],
[https://bugs.freedesktop.org/enter_bug.cgi?product=xorg])
AM_INIT_AUTOMAKE([foreign dist-bzip2])
# Require xorg-macros minimum of 1.12 for DocBook external references
m4_ifndef([XORG_MACROS_VERSION],
[m4_fatal([must install xorg-macros 1.12 or later before running autoconf/autogen])])
XORG_MACROS_VERSION(1.12)
XORG_DEFAULT_OPTIONS
XORG_ENABLE_SPECS
XORG_WITH_XMLTO(0.0.22)
XORG_WITH_FOP
XORG_WITH_XSLTPROC
XORG_CHECK_SGML_DOCTOOLS(1.8)
AC_CONFIG_FILES([Makefile
specs/Makefile
xcmiscproto.pc])
AC_OUTPUT
#
# Generate output formats for a single DocBook/XML with/without chapters
#
# Variables set by the calling Makefile:
# shelfdir: the location where the docs/specs are installed. Typically $(docdir)
# docbook: the main DocBook/XML file, no chapters, appendix or image files
# chapters: all files pulled in by an XInclude statement and images.
#
#
# This makefile is intended for Users Documentation and Functional Specifications.
# Do not use for Developer Documentation which is not installed and does not require olink.
# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393
# for an explanation on documents classification.
#
# DocBook/XML generated output formats to be installed
shelf_DATA =
# DocBook/XML file with chapters, appendix and images it includes
dist_shelf_DATA = $(docbook) $(chapters)
if HAVE_XMLTO
if HAVE_STYLESHEETS
XMLTO_SEARCHPATH_FLAGS = \
--searchpath "$(XORG_SGML_PATH)/X11" \
--searchpath "$(abs_top_builddir)"
XMLTO_HTML_OLINK_FLAGS = \
--stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.html.xml \
--stringparam current.docid="$(<:.xml=)"
XMLTO_HTML_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
XMLTO_HTML_FLAGS = \
$(XMLTO_SEARCHPATH_FLAGS) \
$(XMLTO_HTML_STYLESHEET_FLAGS) \
$(XMLTO_HTML_OLINK_FLAGS)
shelf_DATA += $(docbook:.xml=.html)
%.html: %.xml $(chapters)
$(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) xhtml-nochunks $<
if HAVE_XMLTO_TEXT
shelf_DATA += $(docbook:.xml=.txt)
%.txt: %.xml $(chapters)
$(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) txt $<
endif HAVE_XMLTO_TEXT
if HAVE_FOP
XMLTO_FO_IMAGEPATH_FLAGS = --stringparam img.src.path=$(abs_builddir)/
XMLTO_PDF_OLINK_FLAGS = \
--stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.pdf.xml \
--stringparam current.docid="$(<:.xml=)"
XMLTO_FO_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl
XMLTO_FO_FLAGS = \
$(XMLTO_SEARCHPATH_FLAGS) \
$(XMLTO_FO_STYLESHEET_FLAGS) \
$(XMLTO_FO_IMAGEPATH_FLAGS) \
$(XMLTO_PDF_OLINK_FLAGS)
shelf_DATA += $(docbook:.xml=.pdf)
%.pdf: %.xml $(chapters)
$(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop pdf $<
shelf_DATA += $(docbook:.xml=.ps)
%.ps: %.xml $(chapters)
$(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop ps $<
endif HAVE_FOP
# Generate documents cross-reference target databases
if HAVE_XSLTPROC
XSLT_SEARCHPATH_FLAGS = \
--path "$(XORG_SGML_PATH)/X11" \
--path "$(abs_top_builddir)"
XSLT_OLINK_FLAGS = \
--stringparam targets.filename "$@" \
--stringparam collect.xref.targets "only" \
--stringparam olink.base.uri "$(@:.db=)"
XSLT_HTML_FLAGS = \
$(XSLT_SEARCHPATH_FLAGS) \
$(XSLT_OLINK_FLAGS) \
--nonet --xinclude \
$(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
XSLT_PDF_FLAGS = \
$(XSLT_SEARCHPATH_FLAGS) \
$(XSLT_OLINK_FLAGS) \
--nonet --xinclude \
$(STYLESHEET_SRCDIR)/xorg-fo.xsl
shelf_DATA += $(docbook:.xml=.html.db)
%.html.db: %.xml $(chapters)
$(AM_V_GEN)$(XSLTPROC) $(XSLT_HTML_FLAGS) $<
shelf_DATA += $(docbook:.xml=.pdf.db)
%.pdf.db: %.xml $(chapters)
$(AM_V_GEN)$(XSLTPROC) $(XSLT_PDF_FLAGS) $<
endif HAVE_XSLTPROC
endif HAVE_STYLESHEETS
endif HAVE_XMLTO
CLEANFILES = $(shelf_DATA)
*.html
*.ps
*.pdf
*.txt
*.db
if ENABLE_SPECS
# Main DocBook/XML files (DOCTYPE book)
docbook = xc-misc.xml
# The location where the DocBook/XML files and their generated formats are installed
shelfdir = $(docdir)
# Generate DocBook/XML output formats with or without stylesheets
include $(top_srcdir)/docbook.am
endif ENABLE_SPECS
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % defs SYSTEM "defs.ent"> %defs;
]>
<!-- lifted from troff+ms+XMan by doclifter -->
<book id="xc-misc">
<bookinfo>
<title>XC-MISC Extension</title>
<subtitle>X Consortium Standard</subtitle>
<authorgroup>
<author>
<firstname>Bob</firstname><surname>Scheifler</surname>
<affiliation><orgname>X Consortium</orgname></affiliation>
</author>
<author>
<firstname>David</firstname><othername>P.</othername><surname>Wiggins</surname>
<affiliation><orgname>X Consortium</orgname></affiliation>
</author>
</authorgroup>
<releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
<releaseinfo>Version 1.1</releaseinfo>
<copyright><year>1994</year><holder>X Consortium</holder></copyright>
<legalnotice>
<para>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &ldquo;Software&rdquo;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</para>
<para>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</para>
<para>THE SOFTWARE IS PROVIDED &ldquo;AS IS&rdquo;, 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 X CONSORTIUM 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.</para>
<para>Except as contained in this notice, the name of the X Consortium 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 X Consortium.</para>
<para>X Window System is a trademark of The Open Group.</para>
</legalnotice>
</bookinfo>
<chapter id='Overview'>
<title>Overview</title>
<para>When an X client connects to an X server, it receives a fixed range of
resource IDs to use to identify the client's resources inside the X
server. Xlib hands these out sequentially as needed. When it
overruns the end of the range, an IDChoice protocol error results.
Long running clients, or clients that use resource IDs at a rapid
rate, may encounter this circumstance. When it happens, there are
usually many resource IDs available, but Xlib doesn't know about them.</para>
<para>One approach to solving this problem would be to have Xlib notice when
a resource is freed and recycle its ID for future use. This strategy
runs into difficulties because sometimes freeing one resource causes
others to be freed (for example, when a window is destroyed, so are
its children). To do a complete job, Xlib would have to maintain a
large amount of state that currently resides only in the server (the
entire window tree in the above example). Even if a less
comprehensive strategy was adopted, such as recycling only those IDs
that Xlib can identify without maintaining additional state, the
additional bookkeeping at resource creation and destruction time
would likely introduce unacceptable overhead.</para>
<para>To avoid the problems listed above, the server's complete knowledge of
all resource IDs in use by a client is leveraged. This extension
provides two ways for Xlib to query the server for available resource
IDs. Xlib can use these extension requests behind the scenes when it has
exhausted its current pool of resource IDs.</para>
</chapter>
<chapter id='Requests'>
<title>Requests</title>
<para>
<function>XCMiscGetVersion</function></para>
<itemizedlist>
<listitem><para><parameter>client_major_version</parameter>: CARD16</para></listitem>
<listitem><para><parameter>client_minor_version</parameter>: CARD16</para></listitem>
</itemizedlist>
<para> =&gt;</para>
<itemizedlist>
<listitem><para><parameter>client_major_version</parameter>: CARD16</para></listitem>
<listitem><para><parameter>client_minor_version</parameter>: CARD16</para></listitem>
</itemizedlist>
<para>If supplied, the <parameter>client_major_version</parameter> and
<parameter>client_minor_version</parameter> indicate what version of
the protocol the client wants the server to implement. The server version
numbers returned indicate the protocol this extension actually supports. This
might not equal the version sent by the client. An implementation can
(but need not) support more than one version simultaneously. The
<parameter>server_major_version</parameter> and the <parameter>server_minor_version</parameter> are a
mechanism to support future revisions of the XC-MISC protocol
which may be necessary. In general, the major version would increment
for incompatible changes, and the minor version would increment for
small, upward-compatible changes. Servers that support the protocol
defined in this document will return a
<parameter>server_major_version</parameter> of one (1), and a
<parameter>server_minor_version</parameter> of one (1).</para>
<para><function>XCMiscGetXIDRange</function></para>
<para> =&gt;</para>
<itemizedlist>
<listitem><para><parameter>start_id</parameter>: XID</para></listitem>
<listitem><para><parameter>count</parameter>: CARD32</para></listitem>
</itemizedlist>
<para>This request returns a range of available resource IDs for the client
issuing the request. <parameter>start_id</parameter> is the first
ID in the range. <parameter>count</parameter> is the number of IDs
in the range. The returned range may or may not be the largest possible
range.</para>
<para><function>XCMiscGetXIDList</function></para>
<itemizedlist>
<listitem><para><parameter>count</parameter>: CARD32</para></listitem>
</itemizedlist>
<para> =&gt;</para>
<itemizedlist>
<listitem><para><parameter>ids</parameter>: LISTofXID</para></listitem>
</itemizedlist>
<para>This request returns the a list of individual resource IDs in
<parameter>ids</parameter>.
<parameter>count</parameter> is the number of resource IDs requested.
The number returned may be smaller than the number requested.</para>
</chapter>
<chapter id='Events_and_Errors'>
<title>Events and Errors</title>
<para>No new events or errors are defined by this extension.</para>
</chapter>
<chapter id='Encoding'>
<title>Encoding</title>
<para>Please refer to the X11 Protocol Encoding document as this document uses
conventions established there.</para>
<para>The name of this extension is &ldquo;XC-MISC&rdquo;.</para>
<synopsis>
<function>XCMiscGetVersion</function>
1 CARD8 opcode
1 0 XC-MISC opcode
2 2 request length
2 CARD16 client_major_version
2 CARD16 client_minor_version
=&gt;
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 length
2 CARD16 server_major_version
2 CARD16 server_minor_version
20 unused
</synopsis>
<synopsis>
<function>XCMiscGetXIDRange</function>
1 CARD8 opcode
1 1 XC-MISC opcode
2 1 request length
=&gt;
1 1 Reply
1 unused
2 CARD16 sequence number
4 0 length
4 XID start_id
4 CARD32 count
16 unused
</synopsis>
<synopsis>
<function>XCMiscGetXIDList</function>
1 CARD8 opcode
1 2 XC-MISC opcode
2 2 request length
4 CARD32 count
=&gt;
1 1 Reply
1 unused
2 CARD16 sequence number
4 CARD32 length
4 CARD32 number of XIDs in ids
20 unused
4n LISTofXID ids
</synopsis>
</chapter>
</book>
/*
Copyright 1993, 1994, 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.
*/
#ifndef _XCMISCPROTO_H_
#define _XCMISCPROTO_H_
#define X_XCMiscGetVersion 0
#define X_XCMiscGetXIDRange 1
#define X_XCMiscGetXIDList 2
#define XCMiscNumberEvents 0
#define XCMiscNumberErrors 0
#define XCMiscMajorVersion 1
#define XCMiscMinorVersion 1
#define XCMiscExtensionName "XC-MISC"
typedef struct {
CARD8 reqType; /* always XCMiscCode */
CARD8 miscReqType; /* always X_XCMiscGetVersion */
CARD16 length B16;
CARD16 majorVersion B16;
CARD16 minorVersion B16;
} xXCMiscGetVersionReq;
#define sz_xXCMiscGetVersionReq 8
typedef struct {
BYTE type; /* X_Reply */
CARD8 pad0;
CARD16 sequenceNumber B16;
CARD32 length B32;
CARD16 majorVersion B16;
CARD16 minorVersion B16;
CARD32 pad1 B32;
CARD32 pad2 B32;
CARD32 pad3 B32;
CARD32 pad4 B32;
CARD32 pad5 B32;
} xXCMiscGetVersionReply;
#define sz_xXCMiscGetVersionReply 32
typedef struct {
CARD8 reqType; /* always XCMiscCode */
CARD8 miscReqType; /* always X_XCMiscGetXIDRange */
CARD16 length B16;
} xXCMiscGetXIDRangeReq;
#define sz_xXCMiscGetXIDRangeReq 4
typedef struct {
BYTE type; /* X_Reply */
CARD8 pad0;
CARD16 sequenceNumber B16;
CARD32 length B32;
CARD32 start_id B32;
CARD32 count B32;
CARD32 pad1 B32;
CARD32 pad2 B32;
CARD32 pad3 B32;
CARD32 pad4 B32;
} xXCMiscGetXIDRangeReply;
#define sz_xXCMiscGetXIDRangeReply 32
typedef struct {
CARD8 reqType; /* always XCMiscCode */
CARD8 miscReqType; /* always X_XCMiscGetXIDList */
CARD16 length B16;
CARD32 count B32; /* number of IDs requested */
} xXCMiscGetXIDListReq;
#define sz_xXCMiscGetXIDListReq 8
typedef struct {
BYTE type; /* X_Reply */
CARD8 pad0;
CARD16 sequenceNumber B16;
CARD32 length B32;
CARD32 count B32; /* number of IDs requested */
CARD32 pad1 B32;
CARD32 pad2 B32;
CARD32 pad3 B32;
CARD32 pad4 B32;
CARD32 pad5 B32;
} xXCMiscGetXIDListReply;
#define sz_xXCMiscGetXIDListReply 32
#endif /* _XCMISCPROTO_H_ */
prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@
Name: XCMiscProto
Description: XCMisc extension headers
Version: @PACKAGE_VERSION@
Cflags: -I${includedir}
#warning "xcmiscstr.h is obsolete and may be removed in the future."
#warning "include <X11/extensions/xcmiscproto.h> for the protocol defines."
#include <X11/extensions/xcmiscproto.h>