X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fxcb.h;h=4c3e0794c9264f1923911e28d142df94280bec0b;hb=8eba8690adac2c4425f4cac490c77f9f3b1da6f7;hp=de3e4445b3e54825a7015693d5817f0d859804a1;hpb=4ff12a1a94895837dc85ac9e37fd1a5f40819cf3;p=free-sw%2Fxcb%2Flibxcb

diff --git a/src/xcb.h b/src/xcb.h
index de3e444..4c3e079 100644
--- a/src/xcb.h
+++ b/src/xcb.h
@@ -112,7 +112,7 @@ typedef struct {
     uint8_t  pad0;           /**< Padding */
     uint16_t sequence;       /**< Sequence number */
     uint32_t pad[7];         /**< Padding */
-    uint32_t full_sequence;
+    uint32_t full_sequence;  /**< full sequence */
 } xcb_generic_event_t;
 
 /**
@@ -125,7 +125,7 @@ typedef struct {
     uint8_t   error_code;     /**< Error code */
     uint16_t sequence;       /**< Sequence number */
     uint32_t pad[7];         /**< Padding */
-    uint32_t full_sequence;
+    uint32_t full_sequence;  /**< full sequence */
 } xcb_generic_error_t;
 
 /**
@@ -217,19 +217,16 @@ xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
 /**
  * @brief Returns the next event or error from the server.
  * @param c: The connection to the X server.
- * @param error: A pointer to an int to be filled in with the I/O
  * error status of the operation.
  * @return The next event from the server.
  *
  * Returns the next event or error from the server, if one is
  * available, or returns @c NULL otherwise. If no event is available, that
  * might be because an I/O error like connection close occurred while
- * attempting to read the next event. The @p error parameter is a
- * pointer to an int to be filled in with the I/O error status of the
- * operation. If @p error is @c NULL, terminates the application when an
- * I/O error occurs.
+ * attempting to read the next event, in which case the connection is
+ * shut down when this function returns.
  */
-xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c, int *error);
+xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);
 
 /**
  * @brief Return the error for a request, or NULL if none can ever arrive.
@@ -237,11 +234,11 @@ xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c, int *error);
  * @param cookie: The request cookie.
  * @return The error for the request, or NULL if none can ever arrive.
  *
- * The xcb_void_cookie_t cookie supplied to this function must have resulted from
- * a call to XCB[RequestName]Checked().  This function will block until one of
- * two conditions happens.  If an error is received, it will be returned.  If
- * a reply to a subsequent request has already arrived, no error can arrive
- * for this request, so this function will return NULL.
+ * The xcb_void_cookie_t cookie supplied to this function must have resulted
+ * from a call to xcb_[request_name]_checked().  This function will block
+ * until one of two conditions happens.  If an error is received, it will be
+ * returned.  If a reply to a subsequent request has already arrived, no error
+ * can arrive for this request, so this function will return NULL.
  *
  * Note that this function will perform a sync if needed to ensure that the
  * sequence number will advance beyond that provided in cookie; this is a
@@ -266,7 +263,7 @@ typedef struct xcb_extension_t xcb_extension_t;  /**< Opaque structure used as k
  * This function is the primary interface to the "extension cache",
  * which caches reply information from QueryExtension
  * requests. Invoking this function may cause a call to
- * xcb_query_extension_t to retrieve extension information from the
+ * xcb_query_extension to retrieve extension information from the
  * server, and may block until extension data is received from the
  * server.
  *
@@ -282,8 +279,8 @@ const xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, x
  *
  * This function allows a "prefetch" of extension data into the
  * extension cache. Invoking the function may cause a call to
- * xcb_query_extension_t, but will not block waiting for the
- * reply. xcb_get_extension_data_t will return the prefetched data after
+ * xcb_query_extension, but will not block waiting for the
+ * reply. xcb_get_extension_data will return the prefetched data after
  * possibly blocking while it is retrieved.
  */
 void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
@@ -317,7 +314,7 @@ const xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
  * @return The file descriptor.
  *
  * Accessor for the file descriptor that was passed to the
- * xcb_connect_to_fd_t call that returned @p c.
+ * xcb_connect_to_fd call that returned @p c.
  */
 int xcb_get_file_descriptor(xcb_connection_t *c);
 
@@ -344,10 +341,9 @@ int xcb_connection_has_error(xcb_connection_t *c);
  *
  * Connects to an X server, given the open socket @p fd and the
  * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
- * bidirectionally connected to an X server. xcb_get_tcpfd_t and
- * xcb_get_unix_fd_t return appropriate file descriptors. If the connection
+ * bidirectionally connected to an X server. If the connection
  * should be unauthenticated, @p auth_info must be @c
- * NULL. xcb_get_auth_info_t returns appropriate authentication data.
+ * NULL.
  */
 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);
 
@@ -365,10 +361,10 @@ void xcb_disconnect(xcb_connection_t *c);
 
 /**
  * @brief Parses a display string name in the form documented by X(7x).
- * @param displayname: The name of the display.
- * @param hostp: A pointer to a malloc'd copy of the hostname.
- * @param displayp: A pointer to the display number.
- * @param screenp: A pointer to the screen number.
+ * @param name: The name of the display.
+ * @param host: A pointer to a malloc'd copy of the hostname.
+ * @param display: A pointer to the display number.
+ * @param screen: A pointer to the screen number.
  * @return 0 on failure, non 0 otherwise.
  *
  * Parses the display string name @p display_name in the form
@@ -398,9 +394,9 @@ xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
 
 /**
  * @brief Connects to the X server, using an authorization information.
- * @param displayname: The name of the display.
+ * @param display: The name of the display.
  * @param auth: The authorization information.
- * @param screenp: A pointer to a preferred screen number.
+ * @param screen: A pointer to a preferred screen number.
  * @return A newly allocated xcb_connection_t structure.
  *
  * Connects to the X server specified by @p displayname, using the
@@ -411,6 +407,19 @@ xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
 
 
+/* xcb_xid.c */
+
+/**
+ * @brief Allocates an XID for a new object.
+ * @param c: The connection.
+ * @return A newly allocated XID.
+ *
+ * Allocates an XID for a new object. Typically used just prior to
+ * various object creation functions, such as xcb_create_window.
+ */
+uint32_t xcb_generate_id(xcb_connection_t *c);
+
+
 /**
  * @}
  */