TinyX/randr/rrproperty.c

/*
 * Copyright © 2006 Keith Packard
 *
 * 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, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS 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.
 */

#include "randrstr.h"
#include "propertyst.h"
#include "swaprep.h"

static void
RRDeliverEvent(ScreenPtr pScreen, xEvent *event, CARD32 mask)
{

}

void
RRDeleteAllOutputProperties(RROutputPtr output)
{
    RRPropertyPtr prop, next;

    xRROutputPropertyNotifyEvent event;

    for (prop = output->properties; prop; prop = next) {
        next = prop->next;
        event.type = RREventBase + RRNotify;
        event.subCode = RRNotify_OutputProperty;
        event.output = output->id;
        event.state = PropertyDelete;
        event.atom = prop->propertyName;
        event.timestamp = currentTime.milliseconds;
        RRDeliverEvent(output->pScreen, (xEvent *) &event,
                       RROutputPropertyNotifyMask);
        if (prop->current.data)
            free(prop->current.data);
        if (prop->pending.data)
            free(prop->pending.data);
        free(prop);
    }
}

static void
RRInitOutputPropertyValue(RRPropertyValuePtr property_value)
{
    property_value->type = None;
    property_value->format = 0;
    property_value->size = 0;
    property_value->data = NULL;
}

static RRPropertyPtr
RRCreateOutputProperty(Atom property)
{
    RRPropertyPtr prop;

    prop = malloc(sizeof(RRPropertyRec));
    if (!prop)
        return NULL;
    prop->next = NULL;
    prop->propertyName = property;
    prop->is_pending = FALSE;
    prop->range = FALSE;
    prop->immutable = FALSE;
    prop->num_valid = 0;
    prop->valid_values = NULL;
    RRInitOutputPropertyValue(&prop->current);
    RRInitOutputPropertyValue(&prop->pending);
    return prop;
}

static void
RRDestroyOutputProperty(RRPropertyPtr prop)
{
    if (prop->valid_values)
        free(prop->valid_values);
    if (prop->current.data)
        free(prop->current.data);
    if (prop->pending.data)
        free(prop->pending.data);
    free(prop);
}

void
RRDeleteOutputProperty(RROutputPtr output, Atom property)
{
    RRPropertyPtr prop, *prev;

    xRROutputPropertyNotifyEvent event;

    for (prev = &output->properties; (prop = *prev); prev = &(prop->next))
        if (prop->propertyName == property)
            break;
    if (prop) {
        *prev = prop->next;
        event.type = RREventBase + RRNotify;
        event.subCode = RRNotify_OutputProperty;
        event.output = output->id;
        event.state = PropertyDelete;
        event.atom = prop->propertyName;
        event.timestamp = currentTime.milliseconds;
        RRDeliverEvent(output->pScreen, (xEvent *) &event,
                       RROutputPropertyNotifyMask);
        RRDestroyOutputProperty(prop);
    }
}

int
RRChangeOutputProperty(RROutputPtr output, Atom property, Atom type,
                       int format, int mode, unsigned long len,
                       pointer value, Bool sendevent)
{
    RRPropertyPtr prop;

    xRROutputPropertyNotifyEvent event;

    rrScrPrivPtr pScrPriv = rrGetScrPriv(output->pScreen);

    int sizeInBytes;

    int totalSize;

    pointer data;

    RRPropertyValuePtr prop_value;

    Bool add = FALSE;

    sizeInBytes = format >> 3;
    totalSize = len * sizeInBytes;

    /* first see if property already exists */
    prop = RRQueryOutputProperty(output, property);
    if (!prop) {                /* just add to list */
        prop = RRCreateOutputProperty(property);
        if (!prop)
            return (BadAlloc);
        add = TRUE;
        mode = PropModeReplace;
    }
    if (prop->is_pending)
        prop_value = &prop->pending;
    else
        prop_value = &prop->current;

    /* To append or prepend to a property the request format and type
       must match those of the already defined property.  The
       existing format and type are irrelevant when using the mode
       "PropModeReplace" since they will be written over. */

    if ((format != prop_value->format) && (mode != PropModeReplace))
        return (BadMatch);
    if ((prop_value->type != type) && (mode != PropModeReplace))
        return (BadMatch);
    if (mode == PropModeReplace) {
        if (totalSize != prop_value->size * (prop_value->format >> 3)) {
            if (prop_value->data)
                data = (pointer) realloc(prop_value->data, totalSize);
            else
                data = malloc(totalSize);
            if (!data && len) {
                if (add)
                    RRDestroyOutputProperty(prop);
                return (BadAlloc);
            }
            prop_value->data = data;
        }
        if (len)
            memmove((char *) prop_value->data, (char *) value, totalSize);
        prop_value->size = len;
        prop_value->type = type;
        prop_value->format = format;
    }
    else if (len == 0) {
        /* do nothing */
    }
    else if (mode == PropModeAppend) {
        data = (pointer) realloc(prop_value->data,
                                  sizeInBytes * (len + prop_value->size));
        if (!data)
            return (BadAlloc);
        prop_value->data = data;
        memmove(&((char *) data)[prop_value->size * sizeInBytes],
                (char *) value, totalSize);
        prop_value->size += len;
    }
    else if (mode == PropModePrepend) {
        data = malloc(sizeInBytes * (len + prop_value->size));
        if (!data)
            return (BadAlloc);
        memmove(&((char *) data)[totalSize], (char *) prop_value->data,
                (int) (prop_value->size * sizeInBytes));
        memmove((char *) data, (char *) value, totalSize);
        free(prop_value->data);
        prop_value->data = data;
        prop_value->size += len;
    }
    if (add) {
        prop->next = output->properties;
        output->properties = prop;
    }

    if (!prop->is_pending && pScrPriv->rrOutputSetProperty) {
        /* What should we do in case of failure? */
        pScrPriv->rrOutputSetProperty(output->pScreen, output,
                                      prop->propertyName, prop_value);
    }

    if (sendevent) {
        event.type = RREventBase + RRNotify;
        event.subCode = RRNotify_OutputProperty;
        event.output = output->id;
        event.state = PropertyNewValue;
        event.atom = prop->propertyName;
        event.timestamp = currentTime.milliseconds;
        RRDeliverEvent(output->pScreen, (xEvent *) &event,
                       RROutputPropertyNotifyMask);
    }
    return (Success);
}

RRPropertyPtr
RRQueryOutputProperty(RROutputPtr output, Atom property)
{
    RRPropertyPtr prop;

    for (prop = output->properties; prop; prop = prop->next)
        if (prop->propertyName == property)
            return prop;
    return NULL;
}

RRPropertyValuePtr
RRGetOutputProperty(RROutputPtr output, Atom property, Bool pending)
{
    RRPropertyPtr prop = RRQueryOutputProperty(output, property);

    if (!prop)
        return NULL;
    if (pending && prop->is_pending)
        return &prop->pending;
    else
        return &prop->current;
}

int
RRConfigureOutputProperty(RROutputPtr output, Atom property,
                          Bool pending, Bool range, Bool immutable,
                          int num_values, INT32 *values)
{
    RRPropertyPtr prop = RRQueryOutputProperty(output, property);

    Bool add = FALSE;

    INT32 *new_values;

    /*
     * ranges must have even number of values
     */
    if (range && (num_values & 1))
        return BadMatch;

    if (!prop) {
        prop = RRCreateOutputProperty(property);
        if (!prop)
            return (BadAlloc);
        add = TRUE;
    }
    else if (prop->immutable && !immutable)
        return (BadAccess);

    new_values = malloc(num_values * sizeof(INT32));
    if (!new_values && num_values)
        return BadAlloc;
    if (num_values)
        memcpy(new_values, values, num_values * sizeof(INT32));

    /*
     * Property moving from pending to non-pending
     * loses any pending values
     */
    if (prop->is_pending && !pending) {
        if (prop->pending.data)
            free(prop->pending.data);
        RRInitOutputPropertyValue(&prop->pending);
    }

    prop->is_pending = pending;
    prop->range = range;
    prop->immutable = immutable;
    prop->num_valid = num_values;
    if (prop->valid_values)
        free(prop->valid_values);
    prop->valid_values = new_values;

    if (add) {
        prop->next = output->properties;
        output->properties = prop;
    }

    return Success;
}

int
ProcRRListOutputProperties(ClientPtr client)
{
    REQUEST(xRRListOutputPropertiesReq);
    Atom *pAtoms = NULL, *temppAtoms;

    xRRListOutputPropertiesReply rep;

    int numProps = 0;

    RROutputPtr output;

    RRPropertyPtr prop;

    REQUEST_SIZE_MATCH(xRRListOutputPropertiesReq);

    output = LookupOutput(client, stuff->output, SecurityReadAccess);

    if (!output)
        return RRErrorBase + BadRROutput;

    for (prop = output->properties; prop; prop = prop->next)
        numProps++;
    if (numProps)
        if (!(pAtoms = (Atom *) ALLOCATE_LOCAL(numProps * sizeof(Atom))))
            return (BadAlloc);

    rep.type = X_Reply;
    rep.length = (numProps * sizeof(Atom)) >> 2;
    rep.sequenceNumber = client->sequence;
    rep.nAtoms = numProps;
    if (client->swapped) {
        swaps(&rep.sequenceNumber);
        swapl(&rep.length);
    }
    temppAtoms = pAtoms;
    for (prop = output->properties; prop; prop = prop->next)
        *temppAtoms++ = prop->propertyName;

    WriteReplyToClient(client, sizeof(xRRListOutputPropertiesReply), &rep);
    if (numProps) {
        client->pSwapReplyFunc = (ReplySwapPtr) Swap32Write;
        WriteSwappedDataToClient(client, numProps * sizeof(Atom), pAtoms);
        DEALLOCATE_LOCAL(pAtoms);
    }
    return (client->noClientException);
}

int
ProcRRQueryOutputProperty(ClientPtr client)
{
    REQUEST(xRRQueryOutputPropertyReq);
    xRRQueryOutputPropertyReply rep;

    RROutputPtr output;

    RRPropertyPtr prop;

    REQUEST_SIZE_MATCH(xRRQueryOutputPropertyReq);

    output = LookupOutput(client, stuff->output, SecurityReadAccess);

    if (!output)
        return RRErrorBase + BadRROutput;

    prop = RRQueryOutputProperty(output, stuff->property);
    if (!prop)
        return BadName;

    rep.type = X_Reply;
    rep.length = prop->num_valid;
    rep.sequenceNumber = client->sequence;
    rep.pending = prop->is_pending;
    rep.range = prop->range;
    rep.immutable = prop->immutable;
    if (client->swapped) {
        swaps(&rep.sequenceNumber);
        swapl(&rep.length);
    }
    WriteReplyToClient(client, sizeof(xRRQueryOutputPropertyReply), &rep);
    if (prop->num_valid) {
        client->pSwapReplyFunc = (ReplySwapPtr) Swap32Write;
        WriteSwappedDataToClient(client, prop->num_valid * sizeof(INT32),
                                 prop->valid_values);
    }
    return (client->noClientException);
}

int
ProcRRConfigureOutputProperty(ClientPtr client)
{
    REQUEST(xRRConfigureOutputPropertyReq);
    RROutputPtr output;

    int num_valid;

    REQUEST_SIZE_MATCH(xRRConfigureOutputPropertyReq);

    output = LookupOutput(client, stuff->output, SecurityReadAccess);

    if (!output)
        return RRErrorBase + BadRROutput;

    num_valid = stuff->length - (sizeof(xRRConfigureOutputPropertyReq) >> 2);
    return RRConfigureOutputProperty(output, stuff->property,
                                     stuff->pending, stuff->range,
                                     FALSE, num_valid, (INT32 *) (stuff + 1));
}

int
ProcRRChangeOutputProperty(ClientPtr client)
{
    REQUEST(xRRChangeOutputPropertyReq);
    RROutputPtr output;

    char format, mode;

    unsigned long len;

    int sizeInBytes;

    int totalSize;

    int err;

    REQUEST_AT_LEAST_SIZE(xRRChangeOutputPropertyReq);
    UpdateCurrentTime();
    format = stuff->format;
    mode = stuff->mode;
    if ((mode != PropModeReplace) && (mode != PropModeAppend) &&
        (mode != PropModePrepend)) {
        client->errorValue = mode;
        return BadValue;
    }
    if ((format != 8) && (format != 16) && (format != 32)) {
        client->errorValue = format;
        return BadValue;
    }
    len = stuff->nUnits;
    if (len > ((0xffffffff - sizeof(xChangePropertyReq)) >> 2))
        return BadLength;
    sizeInBytes = format >> 3;
    totalSize = len * sizeInBytes;
    REQUEST_FIXED_SIZE(xRRChangeOutputPropertyReq, totalSize);

    output = LookupOutput(client, stuff->output, SecurityWriteAccess);
    if (!output)
        return RRErrorBase + BadRROutput;

    if (!ValidAtom(stuff->property)) {
        client->errorValue = stuff->property;
        return (BadAtom);
    }
    if (!ValidAtom(stuff->type)) {
        client->errorValue = stuff->type;
        return (BadAtom);
    }

    err = RRChangeOutputProperty(output, stuff->property,
                                 stuff->type, (int) format,
                                 (int) mode, len, (pointer) &stuff[1], TRUE);
    if (err != Success)
        return err;
    else
        return client->noClientException;
}

int
ProcRRDeleteOutputProperty(ClientPtr client)
{
    REQUEST(xRRDeleteOutputPropertyReq);
    RROutputPtr output;

    REQUEST_SIZE_MATCH(xRRDeleteOutputPropertyReq);
    UpdateCurrentTime();
    output = LookupOutput(client, stuff->output, SecurityWriteAccess);
    if (!output)
        return RRErrorBase + BadRROutput;

    if (!ValidAtom(stuff->property)) {
        client->errorValue = stuff->property;
        return (BadAtom);
    }

    RRDeleteOutputProperty(output, stuff->property);
    return client->noClientException;
}

int
ProcRRGetOutputProperty(ClientPtr client)
{
    REQUEST(xRRGetOutputPropertyReq);
    RRPropertyPtr prop, *prev;

    RRPropertyValuePtr prop_value;

    unsigned long n, len, ind;

    RROutputPtr output;

    xRRGetOutputPropertyReply reply;

    REQUEST_SIZE_MATCH(xRRGetOutputPropertyReq);
    if (stuff->delete)
        UpdateCurrentTime();
    output = LookupOutput(client, stuff->output,
                          stuff->delete ? SecurityWriteAccess :
                          SecurityReadAccess);
    if (!output)
        return RRErrorBase + BadRROutput;

    if (!ValidAtom(stuff->property)) {
        client->errorValue = stuff->property;
        return (BadAtom);
    }
    if ((stuff->delete != xTrue) && (stuff->delete != xFalse)) {
        client->errorValue = stuff->delete;
        return (BadValue);
    }
    if ((stuff->type != AnyPropertyType) && !ValidAtom(stuff->type)) {
        client->errorValue = stuff->type;
        return (BadAtom);
    }

    for (prev = &output->properties; (prop = *prev); prev = &prop->next)
        if (prop->propertyName == stuff->property)
            break;

    reply.type = X_Reply;
    reply.sequenceNumber = client->sequence;
    if (!prop) {
        reply.nItems = 0;
        reply.length = 0;
        reply.bytesAfter = 0;
        reply.propertyType = None;
        reply.format = 0;
        WriteReplyToClient(client, sizeof(xRRGetOutputPropertyReply), &reply);
        return (client->noClientException);
    }

    if (prop->immutable && stuff->delete)
        return BadAccess;

    if (stuff->pending && prop->is_pending)
        prop_value = &prop->pending;
    else
        prop_value = &prop->current;

    /* If the request type and actual type don't match. Return the
       property information, but not the data. */

    if (((stuff->type != prop_value->type) && (stuff->type != AnyPropertyType))
        ) {
        reply.bytesAfter = prop_value->size;
        reply.format = prop_value->format;
        reply.length = 0;
        reply.nItems = 0;
        reply.propertyType = prop_value->type;
        WriteReplyToClient(client, sizeof(xRRGetOutputPropertyReply), &reply);
        return (client->noClientException);
    }

/*
 *  Return type, format, value to client
 */
    n = (prop_value->format / 8) * prop_value->size;    /* size (bytes) of prop */
    ind = stuff->longOffset << 2;

    /* If longOffset is invalid such that it causes "len" to
       be negative, it's a value error. */

    if (n < ind) {
        client->errorValue = stuff->longOffset;
        return BadValue;
    }

    len = min(n - ind, 4 * stuff->longLength);

    reply.bytesAfter = n - (ind + len);
    reply.format = prop_value->format;
    reply.length = (len + 3) >> 2;
    reply.nItems = len / (prop_value->format / 8);
    reply.propertyType = prop_value->type;

    if (stuff->delete && (reply.bytesAfter == 0)) {
        xRROutputPropertyNotifyEvent event;

        event.type = RREventBase + RRNotify;
        event.subCode = RRNotify_OutputProperty;
        event.output = output->id;
        event.state = PropertyDelete;
        event.atom = prop->propertyName;
        event.timestamp = currentTime.milliseconds;
        RRDeliverEvent(output->pScreen, (xEvent *) &event,
                       RROutputPropertyNotifyMask);
    }

    WriteReplyToClient(client, sizeof(xGenericReply), &reply);
    if (len) {
        switch (reply.format) {
        case 32:
            client->pSwapReplyFunc = (ReplySwapPtr) CopySwap32Write;
            break;
        case 16:
            client->pSwapReplyFunc = (ReplySwapPtr) CopySwap16Write;
            break;
        default:
            client->pSwapReplyFunc = (ReplySwapPtr) WriteToClient;
            break;
        }
        WriteSwappedDataToClient(client, len, (char *) prop_value->data + ind);
    }

    if (stuff->delete && (reply.bytesAfter == 0)) {     /* delete the Property */
        *prev = prop->next;
        RRDestroyOutputProperty(prop);
    }
    return (client->noClientException);
}