scanner: Support documentation elements

On Wed, 18 Jan 2012 12:29:37 -0800
"Kristensen, Kristian H" <kristian.h.kristensen@intel.com> wrote:
> Yeah, that looks good.  I was thinking of a separate <description> tag
> to avoid stuffing too much into an attribute.

How does this look?  It adds a summary attribute to atomic elements,
and a <description> tag with a summary for others.  Spits out enum
documentation like this:

/**
 * wl_display_error - global error values
 * @WL_DISPLAY_ERROR_INVALID_OBJECT: server couldn't find object
 * @WL_DISPLAY_ERROR_INVALID_METHOD: method doesn't exist on the specified interface
 * @WL_DISPLAY_ERROR_NO_MEMORY: server is out of memory
 *
 * These errors are global and can be emitted in response to any server request.
 */
enum wl_display_error {
WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
WL_DISPLAY_ERROR_INVALID_METHOD = 1,
WL_DISPLAY_ERROR_NO_MEMORY = 2,
};

and structure documentation like this:

/**
 * wl_display - core global object
 * @bind: bind an object to the display
 * @sync: (none)
 *
 * The core global object. This is a special singleton object. It is used for
 * internal wayland protocol features.
 */
struct wl_display_interface {
void (*bind)(struct wl_client *client,
     struct wl_resource *resource,
     uint32_t name,
     const char *interface,
     uint32_t version,
     uint32_t id);
void (*sync)(struct wl_client *client,
     struct wl_resource *resource,
     uint32_t callback);
};

Fix 'make dist' as connection.h no longer exists

server: In default grab, update focus resource after sending release

The default grab implementation in wayland-server was updating the
focus resource before sending the button event. This would cause the
button release to be dropped from the implicit grab if the pointer is
moved away from the focus surface. This patch just swaps the order
around.

shm: Drop non-premul format, use less ambiguous ARGB8888 naming convention

This also matches the new wl_drm format names.

Add new wl_shell popup surface type

Move data device implementation into wayland-server

Move default grab implementation to wayland-server

New grab API

This commit changes the way struct wl_grab works in a couple of ways:

 - The grab itself now decides when it ends instead of hardcoding button
   up as the terminating event.  We remove the end vfunc since a grab now
   always know when it ends and can just clean up at that point.

 - We add a new focus vfunc that is invoked every time the pointer enters
   a new surface, regardless of any grabs.  The callback receives the
   surface and the surface-relative pointer coordinates.  The callback lets
   a grab send enter/leave events and change the grab focus.

 - The grab has a focus surface, wich determines the coordinate space
   for the motion callback coordinates.

 - The input device always tracks the current surface, ie the surface that
   currently contains the pointer, and coordinates relative to that surface.

With these changes, we will be able to pull the core input event delivery
and the drag and drop grab into the core wayland-server library.

server: Allocate server ID for when resource->object.id is 0

server: remove wl_display::callback_list as unused

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

server: add wl_input_device_release()

Add a clean-up function for destroying all objects created in
wl_input_device_init(). Can be used to fix memory leaks reported by
Valgrind in the demos.

The init function was also missing an explicit initialisation of the
'keys' array. Add the explicit array init, although it is redundant with
the zeroing of the whole struct.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
krh: Edited to rename function to *_release()

Fix WL_EVENT_WRITEABLE typo

Drop unused hash table

We now just use a table for looking up object IDs so we should drop the
hash table.

Rename all instances of typeof

Use __typeof__ instead of typeof

Thiago Macieira compiles with -std=c++11.

server: destroy the socket event source on display destroy

On wl_display_add_socket(), the listening socket fd is added to the
event loop. However, wl_event_source object is not stored and hence
cannot be freed, resulting in a minor leak.

Store wl_event_source pointer in struct wl_socket so we can track it,
and destroy it on wl_display_destroy(). The event loop itself must be
destroyed after destroying the event sources linked to it.

Fixes a Valgrind reported memory leak.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

protocol: update touch_down with focus surface

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>

protocol: Add a bit of documentation

connection: Fix printf format warnings

Increase closure buffer size and fail gracefully for too big closures.

Buffer size changed from 256 to 1024 bytes. Marshalling will now stop
if the buffer is not big enough.

Removed superfluous call to wl_copy_connection

The only purpose those code seems to serve is to introduce a buffer
overflow when events contain more than 128 bytes of data.

Make wl_list_for_each* work for c++

client: fix a strdup memory leak

Memory leak found by valgrinding simple-shm client.
struct wl_global::interface is a strdup()'d string that was never freed.

Make a function for freeing a wl_global, and use it.

krh: Edit to name wl_global destructor wl_global_destroy.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

client: unset WAYLAND_SOCKET env variable

WAYLAND_SOCKET contains a file descriptor that is an open connection to
a Wayland server. It is private to us, and makes no sense to relay the
same value (or any value) to our child processes.

Unset the environment variable to prevent it from being accidentally
relayed to other processes.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

server: do not send delete_id to a dead client

During client tear-down, all objects are destroyed in id order.
Therefore the display object is destroyed first.

If the destroy listeners of any object destroy another object by calling
wl_resoruce_destroy(), we try to send a delete_id event to the client.
This leads to a segmentation fault without a display object.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

protocol: introduce wl_shell_surface

Requests like 'move' and 'set_toplevel' are really methods of a surface,
not methods of a global shell object. Move all these methods to a new
interface, wl_shell_surface.

The global object wl_shell will contain only 'get_shell_surface'
request, which creates and associates a wl_shell_surface object to a
given wl_surface object.

This will also give the shell plugin (if you look at the demo
compositor) means to store per-surface private data in a natural way.

Due to a limitation in delete_id event handling on client side, the
client must destroy its wl_shell_surface object before destroying the
wl_surface object. Otherwise it may just leak an id.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

server: document wl_resource_post_event() arguments

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

util: clear pointers on wl_list_remove()

Set the next and prev pointers of the removed list element to NULL. This
will catch programming errors that would use invalid list pointers,
double-remove for instance.

It also helps debugging, making it easy to see in gdb if an object is
not in a list.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

server: no errors to a dead client

Do not try to send errors to an already dead client, while in the
middle of cleanup.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

New drag and drop / selection protocol

This commit brings a big change to the DND and copy/paste interfaces.
Most importantly the functionality is now independent of wl_shell.
The wl_shell interface is intended for desktop style UI interaction and
an optional and experimental interface.

The new interface also allows receiving the DND data multiple times or
multiple times during the drag, and the mechanism for offering and receiving
data is now shared between DND and selections.

server: Stop special casing the compositor

wl_compositor_init() was just adding the global and providing a helper
bind function.  Not useful enough to warrent API.

Add support for server allocated object IDs

We set aside a range of the object ID space for use by the server.  This
allows the server to bind an object to an ID for a client and pass that
object to the client.  The client can use the object immediately and the
server can emit events to the object immdiately.

debug: Use unsigned for object IDs

scanner: Only strdup interface_name after making sure it's not NULL

Move private definitions and prototypes to new wayland-private.h

Fix unused variable warning

Introduce wl_resource_queue_event() for sending events later

Some events, such as the display.delete_id, aren't very urgent and we
would like to not always send them immdiately and cause an unnecessary
context switch.  The wl_resource_queue_event() function will place the
event in the connection output buffer but not request the main loop to
poll for writable.  The effect is that the event will just sit in the
output buffer until a more important event comes around and requires
flushing.

Add display event to acknowledge ID deletion

We need to make sure the client doesn't reuse an object ID until the
server has seen the destroy request.  When a client destroys an ID
the server will now respond with the display.delete_id event, which lets
the client block reuse until it receives the event.

util: Add wl_list_insert_list()

hash: Improve double hashing

Instead of artificially introducing collisions in the step value by
replacing 0 with 1 (which causes the value 1 to have twice the
frequency of any other value), the step value can simply be computed
as an uniformly distributed value in the range [1, rehash], extremes
included.

This is safe because any step value smaller than the hash modulus is
co-prime with it, hence induces an orbit which includes every integer
in [0, size - 1].

scanner: Check name == NULL for enum entries

From a clang static analysis warning.

connection: Check object types in message parameters

event-loop: Fix idle handler dispatch corner case

When the last idle handler queues another idle handler, we fail to
dispatch that last handler.  The wl_list_for_each_safe loop looks up
the next pointer before running the handler, and at that point it points
to the head of the list and the loop terminates.

Instead, just loop until the list is empty.

scanner: Fix typo in error message

protocol: Change global_remove arg to be 'name' insteadl of 'id'

Consistent with global args.

scanner: Catch more invalid attribute combinations for arg

Spotted by Jakob Bornecrantz.

debug: Print debug message when client wakes up

This helps spot and remove extraneous round trips and context switches.

Silence a valgrind warning

wayland-server: Track input_device resource for focused surface

We no long track the focused surface, but expect the compositor to set
focus when the focus changes.  We do track the resource for the input
device that corresponds to the current surface, in case that goes away.

wayland-server: Always use the display_resource for posting wl_display errors

wayland-server: fix resource destroy

Object ID was read from freed memory.

wayland-server: fix crash on invalid resource

Using display_resource to post error about invalid resource.

Reviewed-by: Tiago Vignatti <tiago.vignatti@intel.com>

scanner: Fix indent for *_add_listener

Rename motion_grab to implicit_grab

Let's just use the same terms as X.

Add back get/set user data wrappers for wl_display

server: Make error posting functions take a resource instead of a client

Remove the wl_visual interface

The visual interface was meant to be a generic mechanism for
specifying the content of a buffer.  It goes back to before we had the
buffer factory interfaces (like wl_drm and wl_shm) and we wanted to
keep it open-ended enough that yuv, png or even svg buffer or so would
be possible.

Now that we have the buffer abstraction, we can add different buffer
types by introducing new interfaces that create buffers.  It only
makes sense to leave it to those interfaces to specify the contents of
the buffers.

For wl_shm, this means that we now just specify the pixel format using
an enum.  For EGL buffers, the exact pixel formats are controlled by
the implementation (part of wl_drm and similar), and from the client
point of view, everything is controlled using EGLConfigs.

Update TODO

server: Disconnect client on error

shm: Compare resource interface when validating visual

server: Pass struct wl_resource for object references

Don't special case object ID 1 lookup

server: wl_display and wl_input_device are no longer resources

Update TODO

Store objects in wl_map data structure

The wl_map data structure is just an array with a free-list that lets the
client recycle unused client IDs and keep range of client IDs under control.

Remove range protocol

Destroy client resource by walking client hash table

All resources are now in the client hash table and we can clean up
just by walking the hash.

Always allocate a new wl_resource when binding an object

Previously we would bind some resources into multiple client hash tables.

Add wl_hash_table_for_each()

Bind globals to client provided object IDs

server: Hand code all wl_display client stubs

server: Assign global id as part of wl_display_add_global()

server: Make object hash table per-client

Rename global 'func' to 'bind'

server: Make everything in the object hash a wl_resource

Use a callback object instead of ad-hoc lists for sync and frame events

So obvious in retrospect.  The object system can do all the work for us
and keep track of pending calls as regular objects and we don't need to
abuse the resource system to get them cleaned up on client exit.  We
don't need the custom key management or (broken) lookup, we just sue
object IDs.  And last but not least, anybody can receive the callback,
not just display listeners.

connection: fix libffi usage, our functions return void

All clients were segfaulting on my machine.

Signed-off-by: Paulo Zanoni <paulo.r.zanoni@intel.com>

connection: Object ID 0 is not a valid new object ID

event-loop: Quiet a few warnings

There's no good error recovery possible in these cases though.

Make expat a dependency to the scanner

Rename source subdir from wayland to src

Change scanner.c license to MIT

scanner: Silence warning

scanner: Initialize protocol.copyright to NULL

protocol: Delete screenshooter.xml

The protocol interface is on compositor's side now.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>

scanner: Take copyright notice from xml file

connection: Use static strings instead of sprintf and buffer overflow

Spotted by Samuel Rødal <samuel.rodal@nokia.com>

Link to -lrt for clock_gettime()

Pass object ID not pointer when sending a global announce event

When the type for the first argument of the global event changed from new_id to
uint, wl_connection_vmarshal started expecting an integer argument rather than
an object argument. As a result we were sending the client a chunk of pointer
rather than a useful global identifier.

conection: Handle demarshal errors a little less dramatically

Fix segfault in client when demarshalling fails

protocol: fix key event and related comments

debug: add timestamps when logging

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>

protocol: Fix type of visual arg in token_visual event

scanner: Output type info for new_id arguments

protocol: Make id arg of display.global event be just a uint

Global names are different from object IDs.

scanner: map 'int' to int32_t.

Add touch events to protocol.

server: Add wl_client_flush()

Flush output queue up for the specified client.

event-loop: Make idle handlers work again