dist/difs/fonts.c

/*
 * font control
 */
/*

Copyright 1990, 1991, 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 1990, 1991 Network Computing Devices;
 * Portions Copyright 1987 by Digital Equipment Corporation
 *
 * 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 names of Network Computing Devices or Digital
 * not be used in advertising or publicity pertaining to distribution
 * of the software without specific, written prior permission.
 *
 * NETWORK COMPUTING DEVICES AND DIGITAL DISCLAIM ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL NETWORK COMPUTING DEVICES
 * OR 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.
 */
/*#define DEBUG*/

#include	"config.h"

#include        <X11/fonts/FS.h>
#include        <X11/fonts/FSproto.h>
#include	<stdio.h>
#include	<stdlib.h>
#include	<X11/Xos.h>
#include	"clientstr.h"
#include	"fsresource.h"
#include	"difsfnst.h"
#include	<X11/fonts/fontstruct.h>
#include	"closestr.h"
#include	"globals.h"
#include	"difs.h"
#include	"dispatch.h"
#include	"swaprep.h"
#include        <X11/fonts/libxfont2.h>

static FontPathElementPtr *font_path_elements = (FontPathElementPtr *) 0;
static int  num_fpes = 0;
static xfont2_fpe_funcs_rec *fpe_functions;
static int  num_fpe_types = 0;

static int  num_slept_fpes = 0;
static int  size_slept_fpes = 0;
static FontPathElementPtr *slept_fpes = (FontPathElementPtr *) 0;

#define	NUM_IDS_PER_CLIENT	5

int
FontToFSError(int err)
{
    switch (err) {
    case Successful:
	return FSSuccess;
    case AllocError:
	return FSBadAlloc;
    case BadFontName:
    case BadFontPath:
	return FSBadName;
    case BadFontFormat:
	return FSBadFormat;
    case BadCharRange:
	return FSBadRange;
    default:
	return err;
    }
}

static inline void
UseFPE(FontPathElementPtr fpe)
{
    fpe->refcount++;
}

static inline void
FreeFPE(FontPathElementPtr fpe)
{
    fpe->refcount--;
    if (fpe->refcount == 0) {
	(*fpe_functions[fpe->type].free_fpe) (fpe);
	fsfree(fpe->name);
	fsfree(fpe);
    }
}

/*
 * note that the font wakeup queue is not refcounted.  this is because
 * an fpe needs to be added when it's inited, and removed when it's finally
 * freed, in order to handle any data that isn't requested, like FS events.
 *
 * since the only thing that should call these routines is the renderer's
 * init_fpe() and free_fpe(), there shouldn't be any problem in using
 * freed data.
 */
static void
QueueFontWakeup(FontPathElementPtr fpe)
{
    int         i;
    FontPathElementPtr *new;

    for (i = 0; i < num_slept_fpes; i++) {
	if (slept_fpes[i] == fpe) {

#ifdef DEBUG
	    fprintf(stderr, "re-queueing fpe wakeup\n");
#endif

	    return;
	}
    }
    if (num_slept_fpes == size_slept_fpes) {
	new = (FontPathElementPtr *)
	    fsrealloc(slept_fpes,
		      sizeof(FontPathElementPtr) * (size_slept_fpes + 4));
	if (!new)
	    return;
	slept_fpes = new;
	size_slept_fpes += 4;
    }
    slept_fpes[num_slept_fpes] = fpe;
    num_slept_fpes++;
}

static void
RemoveFontWakeup(FontPathElementPtr fpe)
{
    int         i,
                j;

    for (i = 0; i < num_slept_fpes; i++) {
	if (slept_fpes[i] == fpe) {
	    for (j = i; j < num_slept_fpes; j++) {
		slept_fpes[j] = slept_fpes[j + 1];
	    }
	    num_slept_fpes--;
	    return;
	}
    }
}

/* ARGSUSED */
static void
FontWakeup(pointer data, int count, unsigned long *lastSelectMask)
{
    int         i;
    FontPathElementPtr fpe;

    if (count < 0)
	return;			/* ignore -1 return from select XXX */
    /* wake up any fpe's that may be waiting for information */
    for (i = 0; i < num_slept_fpes; i++) {
	fpe = slept_fpes[i];
	(void) (*fpe_functions[fpe->type].wakeup_fpe) (fpe);
    }
}

static Bool
add_id_to_list(FontIDListPtr ids, Font fid)
{
    Font       *newlist;

    /*
     * assumes the list is packed tightly
     */
    if (ids->num == ids->size) {
	/* increase size of array */
	newlist = (Font *) fsrealloc(ids->client_list,
			      sizeof(Font) * (ids->size + NUM_IDS_PER_CLIENT));
	if (!newlist)
	    return FALSE;
	ids->client_list = newlist;
	ids->size += NUM_IDS_PER_CLIENT;
    }
    ids->client_list[ids->num++] = fid;
    return TRUE;
}

static void
remove_id_from_list(FontIDListPtr ids, Font fid)
{
    int         i;

    for (i = 0; i < ids->num; i++) {
	if (ids->client_list[i] == fid) {
	    /* a memmove() might be better here */
	    while (i < ids->num) {
		ids->client_list[i] = ids->client_list[i + 1];
		i++;
	    }
	    ids->num--;
	    return;
	}
    }
    assert(0);
}

static FontIDListPtr
make_clients_id_list(void)
{
    FontIDListPtr ids;
    Font       *fids;

    ids = (FontIDListPtr) fsalloc(sizeof(FontIDListRec));
    fids = (Font *) fsalloc(sizeof(Font) * NUM_IDS_PER_CLIENT);
    if (!ids || !fids) {
	fsfree(ids);
	fsfree(fids);
	return (FontIDListPtr) 0;
    }
    bzero((char *) fids, sizeof(Font) * NUM_IDS_PER_CLIENT);
    ids->client_list = fids;
    ids->size = NUM_IDS_PER_CLIENT;
    ids->num = 0;
    return ids;
}

static void
free_svrPrivate(pointer svrPrivate)
{
    int i;
    FontIDListPtr *idlist, ids;

    idlist = (FontIDListPtr *) svrPrivate;
    if (idlist) {
	for (i = 0; i < MAXCLIENTS; i++) {
	    ids = idlist[i];
	    if (ids) {
		fsfree((char *) ids->client_list);
		fsfree((char *) ids);
	    }
	}
	fsfree((char *) idlist);
    }
}

#undef  cPtr
#define cPtr ((OFclosurePtr )data)

static Bool
do_open_font(ClientPtr client, pointer data)
{
    FontPtr     pfont = NullFont;
    FontPathElementPtr fpe = NULL;
    int         err = 0;
    int         i;
    char       *alias,
               *newname;
    int         newlen;
    ClientFontPtr cfp;
    Font        orig;
    FontIDListPtr *idlist,
                ids;
    int		aliascount = 20;

    if (client->clientGone == CLIENT_GONE) {
	if (cPtr->current_fpe < cPtr->num_fpes) {
	    fpe = cPtr->fpe_list[cPtr->current_fpe];
	    (*fpe_functions[fpe->type].client_died) ((pointer) client, fpe);
	}
	err = Successful;
	goto dropout;
    }
    while (cPtr->current_fpe < cPtr->num_fpes) {
	fpe = cPtr->fpe_list[cPtr->current_fpe];
	err = (*fpe_functions[fpe->type].open_font)
	    ((pointer) cPtr->client, fpe, cPtr->flags,
	     cPtr->fontname, cPtr->fnamelen, cPtr->format, cPtr->format_mask,
	     cPtr->fontid, &pfont, &alias,
	     cPtr->non_cachable_font && cPtr->non_cachable_font->fpe == fpe ?
		 cPtr->non_cachable_font :
		 (FontPtr)0);

	if (err == FontNameAlias && alias) {
	    newlen = strlen(alias);
	    newname = (char *) fsrealloc(cPtr->fontname, newlen);
	    if (!newname) {
		err = AllocError;
		break;
	    }
	    memmove( newname, alias, newlen);
	    cPtr->fontname = newname;
	    cPtr->fnamelen = newlen;
	    cPtr->current_fpe = 0;
	    if (--aliascount <= 0) break;
	    continue;
	}
	if (err == BadFontName) {
	    cPtr->current_fpe++;
	    continue;
	}
	if (err == Suspended) {
	    if (!cPtr->slept) {
		cPtr->slept = TRUE;
		ClientSleep(client, do_open_font, (pointer) cPtr);
	    }
	    return TRUE;
	}
	break;
    }
    if (err != Successful) {
	goto dropout;
    }
    if (!pfont) {
	err = BadFontName;
	goto dropout;
    }
    cfp = (ClientFontPtr) fsalloc(sizeof(ClientFontRec));
    if (!cfp) {
	err = AllocError;
	goto dropout;
    }
    cfp->font = pfont;
    cfp->clientindex = cPtr->client->index;

    if (fontPatternCache && pfont != cPtr->non_cachable_font)
	xfont2_cache_font_pattern(fontPatternCache, cPtr->orig_name,
                                  cPtr->orig_len, pfont);

    /* either pull out the other id or make the array */
    if (pfont->refcnt != 0) {
	idlist = (FontIDListPtr *) pfont->svrPrivate;
	ids = idlist[cPtr->client->index];
	if (!ids) {
	    ids = make_clients_id_list();
	    if (!ids) {
		err = AllocError;
		fsfree(cfp);
		goto dropout;
	    }
	    idlist[cPtr->client->index] = ids;
	}
	orig = (ids->num > 0) ? ids->client_list[0] : (Font)0;
    } else {
	idlist = (FontIDListPtr *) fsalloc(sizeof(FontIDListPtr) * MAXCLIENTS);
	if (!idlist) {
	    err = AllocError;
	    fsfree(cfp);
	    goto dropout;
	}
	ids = make_clients_id_list();
	if (!ids) {
	    err = AllocError;
	    fsfree(idlist);
	    fsfree(cfp);
	    goto dropout;
	}
	bzero((char *) idlist, (sizeof(FontIDListPtr) * MAXCLIENTS));
	idlist[cPtr->client->index] = ids;
	orig = (Font) 0;
	pfont->svrPrivate = (pointer) idlist;
    }
    if (!AddResource(cPtr->client->index, cPtr->fontid, RT_FONT, (pointer) cfp)) {
	fsfree(cfp);
	free_svrPrivate(pfont->svrPrivate);
	pfont->svrPrivate = (pointer) 0;
	err = AllocError;
	goto dropout;
    }
    else {
        /* send the reply */
	fsOpenBitmapFontReply rep = {
	    .type = FS_Reply,
	    .otherid_valid = orig ? TRUE : FALSE,
	    .sequenceNumber = client->sequence,
	    .length = SIZEOF(fsOpenBitmapFontReply) >> 2,
	    .otherid = orig,
	    .cachable = pfont->info.cachable
	};
	WriteReplyToClient(client,
			   SIZEOF(fsOpenBitmapFontReply), &rep);
	add_id_to_list(ids, cPtr->fontid);
	if (pfont->refcnt == 0) {
	    if (!pfont->fpe)
		pfont->fpe = fpe;
	    UseFPE(pfont->fpe);
	}
	pfont->refcnt++;
    }
dropout:
    if (err != Successful) {
	SendErrToClient(cPtr->client, FontToFSError(err), (pointer) &(cPtr->fontid));
    }
    if (cPtr->slept)
	ClientWakeup(cPtr->client);
    for (i = 0; i < cPtr->num_fpes; i++) {
	FreeFPE(cPtr->fpe_list[i]);
    }
    fsfree(cPtr->fpe_list);
    fsfree(cPtr->fontname);
    fsfree(cPtr);
    return TRUE;
}

int
OpenFont(
    ClientPtr   client,
    Font        fid,
    fsBitmapFormat format,
    fsBitmapFormatMask format_mask,
    int         namelen,
    char       *name)
{
    FontPtr     pfont = (FontPtr)0;
    OFclosurePtr c;
    FontIDListPtr *idlist,
                ids;
    int         i;

    if (namelen == 0 || namelen > XLFDMAXFONTNAMELEN) {
	SendErrToClient(client, FSBadName, (pointer) 0);
	return FSBadName;
    }
#ifdef DEBUG
    fprintf(stderr,"OpenFont: %sn",name);
#endif
    /*
    ** Check name cache.  If we find a cached version of this font that
    ** is cachable, immediately satisfy the request with it.  If we find
    ** a cached version of this font that is non-cachable, we do not
    ** satisfy the request with it.  Instead, we pass the FontPtr to the
    ** FPE's open_font code (the fontfile FPE in turn passes the
    ** information to the rasterizer; the fserve FPE ignores it).
    **
    ** Presumably, the font is marked non-cachable because the FPE has
    ** put some licensing restrictions on it.  If the FPE, using
    ** whatever logic it relies on, determines that it is willing to
    ** share this existing font with the client, then it has the option
    ** to return the FontPtr we passed it as the newly-opened font.
    ** This allows the FPE to exercise its licensing logic without
    ** having to create another instance of a font that already exists.
    */

    if (fontPatternCache &&
	  (pfont = xfont2_find_cached_font_pattern(fontPatternCache, name,
                                                   namelen)) &&
	   pfont->info.cachable) {
	ClientFontPtr cfp;

	idlist = (FontIDListPtr *) pfont->svrPrivate;
	ids = idlist[client->index];
	if (!ids) {
	    ids = make_clients_id_list();
	    if (!ids) {
		goto lowmem;
	    }
	    idlist[client->index] = ids;
	}
	cfp = (ClientFontPtr) fsalloc(sizeof(ClientFontRec));
	if (!cfp) {
    lowmem:
	    SendErrToClient(client, FSBadAlloc, (pointer) 0);
	    return FSBadAlloc;
	}
	cfp->font = pfont;
	cfp->clientindex = client->index;
	if (!AddResource(client->index, fid, RT_FONT, (pointer) cfp)) {
	    goto lowmem;
	}
	if (!add_id_to_list(ids, fid)) {
	    goto lowmem;
	}
	else {
	    fsOpenBitmapFontReply rep = {
		.type = FS_Reply,
		.otherid_valid = (ids->num > 1) ? TRUE : FALSE,
		.sequenceNumber = client->sequence,
		.length = SIZEOF(fsOpenBitmapFontReply) >> 2,
		.otherid = (ids->num > 1) ? ids->client_list[0] : 0,
		.cachable = TRUE	/* XXX */
	    };
	    WriteReplyToClient(client,
			       SIZEOF(fsOpenBitmapFontReply), &rep);
	    pfont->refcnt++;
	    return FSSuccess;
	}
    }
    c = (OFclosurePtr) fsalloc(sizeof(OFclosureRec));
    if (!c)
	goto lowmem;
    c->fontname = (char *) fsalloc(namelen);
    if (!c->fontname) {
	fsfree(c);
	goto lowmem;
    }
    /*
     * copy the current FPE list, so that if it gets changed by another client
     * while we're blocking, the request still appears atomic
     */
    c->fpe_list = (FontPathElementPtr *)
	fsalloc(sizeof(FontPathElementPtr) * num_fpes);
    if (!c->fpe_list) {
	fsfree(c->fontname);
	fsfree(c);
	goto lowmem;
    }
    memmove( c->fontname, name, namelen);
    for (i = 0; i < num_fpes; i++) {
	c->fpe_list[i] = font_path_elements[i];
	UseFPE(c->fpe_list[i]);
    }
    c->client = client;
    c->fontid = fid;
    c->current_fpe = 0;
    c->num_fpes = num_fpes;
    c->fnamelen = namelen;
    c->orig_name = name;
    c->orig_len = namelen;
    c->slept = FALSE;
    c->flags = (FontLoadInfo | FontLoadProps);
    c->format = format;
    c->format_mask = format_mask;
    c->non_cachable_font = pfont;

    (void) do_open_font(client, (pointer) c);
    return FSSuccess;
}

static int
close_font(FontPtr pfont)
{
    FontPathElementPtr fpe;

    assert(pfont);
    if (--pfont->refcnt == 0) {
	if (fontPatternCache)
	    xfont2_remove_cached_font_pattern(fontPatternCache, pfont);
	fpe = pfont->fpe;
	free_svrPrivate(pfont->svrPrivate);
	(*fpe_functions[fpe->type].close_font) (fpe, pfont);
	FreeFPE(fpe);
    }
    return FSSuccess;
}

int
CloseClientFont(
    ClientFontPtr cfp,
    FSID        fid)
{
    FontIDListPtr *idlist;
    FontIDListPtr ids;
    int ret;

    assert(cfp);
    /* clear otherid id */
    idlist = (FontIDListPtr *) cfp->font->svrPrivate;
    ids = idlist[cfp->clientindex];
    remove_id_from_list(ids, fid);
    ret = close_font(cfp->font);
    fsfree((char *) cfp);
    return ret;
}

/*
 * search all the known FPE prefixes looking for one to match the given
 * FPE name
 */
static int
determine_fpe_type(char *name)
{
    int	i;
    for (i = 0; i < num_fpe_types; i++) {
	if ((*fpe_functions[i].name_check) (name))
	    return i;
    }
    return -1;
}

static void
free_font_path(FontPathElementPtr *list, int n)
{
    int         i;

    for (i = 0; i < n; i++) {
	FreeFPE(list[i]);
    }
    fsfree((char *) list);
}

static FontPathElementPtr
find_existing_fpe(
    FontPathElementPtr *list,
    int         num,
    char       *name,
    int         len)
{
    FontPathElementPtr fpe;
    int         i;

    for (i = 0; i < num; i++) {
	fpe = list[i];
	if (fpe->name_length == len && memcmp(name, fpe->name, len) == 0)
	    return fpe;
    }
    return (FontPathElementPtr) 0;
}

/*
 * does the work of setting up the fpe list
 *
 * paths should be a counted string
 */
static int
set_font_path_elements(
    int         npaths,
    char       *paths,
    int        *bad)
{
    int		i, validpaths, err = 0;
    int		len;
    int		type;
    char       *cp = paths;
    char       *name;
    FontPathElementPtr fpe, *fplist;

    fplist = (FontPathElementPtr *)
	fsalloc(sizeof(FontPathElementPtr) * npaths);
    if (!fplist) {
	*bad = 0;
	return FSBadAlloc;
    }
    for (i = 0; i < num_fpe_types; i++) {
	if (fpe_functions[i].set_path_hook)
	    (*fpe_functions[i].set_path_hook) ();
    }
    for (i = 0, validpaths = 0; i < npaths; i++) {
	len = *cp++;
	if (len) {
	    /* if it's already in our active list, just reset it */
	    /*
	     * note that this can miss FPE's in limbo -- may be worth catching
	     * them, though it'd muck up refcounting
	     */
	    fpe = find_existing_fpe(font_path_elements, num_fpes, cp, len);
	    if (fpe) {
		err = (*fpe_functions[fpe->type].reset_fpe) (fpe);
		if (err == Successful) {
		    UseFPE(fpe);/* since it'll be decref'd later when freed
				 * from the old list */
		    fplist[validpaths++] = fpe;
		    cp += len;
		    continue;
		}
		/* can't do it, so act like it's a new one */
	    }
	    name = (char *) fsalloc(len + 1);
	    if (!name) {
		err = FSBadAlloc;
		goto bail;
	    }
	    strncpy(name, (char *) cp, len);
	    name[len] = '\0';
	    type = determine_fpe_type(name);
	    if (type == -1)
	    {
		NoticeF("ignoring font path element %s (bad font path descriptor)\n", name);
		fsfree(name);
		cp += len;
		continue;
	    }
	    /* must be new -- make it */
	    fpe = (FontPathElementPtr) fsalloc(sizeof(FontPathElementRec));
	    if (!fpe) {
		fsfree(name);
		err = FSBadAlloc;
		goto bail;
	    }
	    fpe->type = type;
	    fpe->name = name;
	    fpe->refcount = 1;

	    cp += len;
	    fpe->name_length = len;
	    err = (*fpe_functions[fpe->type].init_fpe) (fpe);
	    if (err != Successful) {
		NoticeF("ignoring font path element %s (unreadable)\n", fpe->name);
		fsfree(fpe->name);
		fsfree(fpe);
		continue;
	    }
	    fplist[validpaths++] = fpe;
	}
    }
    if (validpaths < npaths) {
	FontPathElementPtr *ftmp = (FontPathElementPtr *)
	    fsrealloc(fplist, sizeof(FontPathElementPtr) * validpaths);

	if (!ftmp && validpaths)
	    goto bail;

	fplist = ftmp;
	npaths = validpaths;
    }
    if (validpaths == 0) {
	err = FontToFSError(err);
	goto bail;
    }
    free_font_path(font_path_elements, num_fpes);
    font_path_elements = fplist;
    num_fpes = npaths;
    if (fontPatternCache)
	xfont2_empty_font_pattern_cache(fontPatternCache);
    return FSSuccess;
bail:
    *bad = validpaths;
    while (--validpaths >= 0)
	FreeFPE(fplist[i]);
    fsfree(fplist);
    return err;
}

/*
 * expects comma seperated string
 */
int
SetFontCatalogue(
    char       *str,
    int        *badpath)
{
    int         len,
                npaths;
    char       *paths,
               *end,
               *p;
    int         err;

    len = strlen(str) + 1;
    paths = p = (char *) ALLOCATE_LOCAL(len);
    npaths = 0;

    while (*str) {
	end = index(str, ',');
	if (!end) {
	    end = str + strlen(str);
	}
	*p++ = len = end - str;
	memmove( p, str, len);
	npaths++;
	str += len;		/* skip entry */
	if (*str == ',')
           str++;		/* skip any comma */
	p += len;
    }

    err = set_font_path_elements(npaths, paths, badpath);

    DEALLOCATE_LOCAL(paths);

    return err;
}

#undef  cPtr
#define cPtr ((LFclosurePtr)data)

static Bool
do_list_fonts_and_aliases(ClientPtr client, pointer data)
{
    FontPathElementPtr fpe;
    int         err = Successful;
    FontNamesPtr names = NULL;
    char       *name, *resolved;
    int         namelen, resolvedlen;
    int		nnames;
    int         stringLens;
    int         i;
    fsListFontsReply reply;
    char	*bufptr;
    char	*bufferStart;
    int		aliascount = 0;

    if (client->clientGone == CLIENT_GONE) {
	if (cPtr->current.current_fpe < cPtr->num_fpes) {
	    fpe = cPtr->fpe_list[cPtr->current.current_fpe];
	    (*fpe_functions[fpe->type].client_died) ((pointer) client, fpe);
	}
	err = Successful;
	goto bail;
    }

    if (!cPtr->current.patlen)
	goto finish;

    while (cPtr->current.current_fpe < cPtr->num_fpes) {
	fpe = cPtr->fpe_list[cPtr->current.current_fpe];
	err = Successful;

	if (!fpe_functions[fpe->type].start_list_fonts_and_aliases)
	{
	    /* This FPE doesn't support/require list_fonts_and_aliases */

	    err = (*fpe_functions[fpe->type].list_fonts)
		((pointer) cPtr->client, fpe, cPtr->current.pattern,
		 cPtr->current.patlen, cPtr->current.max_names - cPtr->names->nnames,
		 cPtr->names);

	    if (err == Suspended) {
		if (!cPtr->slept) {
		    cPtr->slept = TRUE;
		    ClientSleep(client, do_list_fonts_and_aliases, (pointer) cPtr);
		}
		return TRUE;
	    }

	    err = BadFontName;
	}
	else
	{
	    /* Start of list_fonts_and_aliases functionality.  Modeled
	       after list_fonts_with_info in that it resolves aliases,
	       except that the information collected from FPEs is just
	       names, not font info.  Each list_next_font_or_alias()
	       returns either a name into name/namelen or an alias into
	       name/namelen and its target name into resolved/resolvedlen.
	       The code at this level then resolves the alias by polling
	       the FPEs.  */

	    if (!cPtr->current.list_started) {
		err = (*fpe_functions[fpe->type].start_list_fonts_and_aliases)
		    ((pointer) cPtr->client, fpe, cPtr->current.pattern,
		     cPtr->current.patlen, cPtr->current.max_names - cPtr->names->nnames,
		     &cPtr->current.private);
		if (err == Suspended) {
		    if (!cPtr->slept) {
			ClientSleep(client, do_list_fonts_and_aliases,
				    (pointer) cPtr);
			cPtr->slept = TRUE;
		    }
		    return TRUE;
		}
		if (err == Successful)
		    cPtr->current.list_started = TRUE;
	    }
	    if (err == Successful) {
		name = NULL;
		err = (*fpe_functions[fpe->type].list_next_font_or_alias)
		    ((pointer) cPtr->client, fpe, &name, &namelen, &resolved,
		     &resolvedlen, cPtr->current.private);
		if (err == Suspended) {
		    if (!cPtr->slept) {
			ClientSleep(client, do_list_fonts_and_aliases,
				    (pointer) cPtr);
			cPtr->slept = TRUE;
		    }
		    return TRUE;
		}
	    }

	    if (err == Successful)
	    {
		if (cPtr->haveSaved)
		{
		    if (cPtr->savedName)
			xfont2_add_font_names_name(cPtr->names, cPtr->savedName,
                                                   cPtr->savedNameLen);
		}
		else
		    xfont2_add_font_names_name(cPtr->names, name, namelen);
	    }

	    /*
	     * When we get an alias back, save our state and reset back to
	     * the start of the FPE looking for the specified name.  As
	     * soon as a real font is found for the alias, pop back to the
	     * old state
	     */
	    else if (err == FontNameAlias) {
		char	tmp_pattern[XLFDMAXFONTNAMELEN];
		/*
		 * when an alias recurses, we need to give
		 * the last FPE a chance to clean up; so we call
		 * it again, and assume that the error returned
		 * is BadFontName, indicating the alias resolution
		 * is complete.
		 */
		memmove(tmp_pattern, resolved, resolvedlen);
		if (cPtr->haveSaved)
		{
		    char    *tmpname;
		    int     tmpnamelen;

		    tmpname = NULL;
		    (void) (*fpe_functions[fpe->type].list_next_font_or_alias)
			((pointer) cPtr->client, fpe, &tmpname, &tmpnamelen,
			 &tmpname, &tmpnamelen, cPtr->current.private);
		    if (--aliascount <= 0)
		    {
			err = BadFontName;
			goto ContBadFontName;
		    }
		}
		else
		{
		    cPtr->saved = cPtr->current;
		    cPtr->haveSaved = TRUE;
		    if (cPtr->savedName)
			fsfree(cPtr->savedName);
		    cPtr->savedName = (char *)fsalloc(namelen + 1);
		    if (cPtr->savedName)
			memmove(cPtr->savedName, name, namelen + 1);
		    cPtr->savedNameLen = namelen;
		    aliascount = 20;
		}
		memmove(cPtr->current.pattern, tmp_pattern, resolvedlen);
		cPtr->current.patlen = resolvedlen;
		cPtr->current.max_names = cPtr->names->nnames + 1;
		cPtr->current.current_fpe = -1;
		cPtr->current.private = NULL;
		err = BadFontName;
	    }
	}
	/*
	 * At the end of this FPE, step to the next.  If we've finished
	 * processing an alias, pop state back. If we've collected enough
	 * font names, quit.
	 */
	if (err == BadFontName) {
	  ContBadFontName: ;
	    cPtr->current.list_started = FALSE;
	    cPtr->current.current_fpe++;
	    err = Successful;
	    if (cPtr->haveSaved)
	    {
		/* If we're searching for an alias, limit the search to
		   FPE's of the same type as the one the alias came
		   from.  This is unnecessarily restrictive, but if we
		   have both fontfile and fs FPE's, this restriction can
		   drastically reduce network traffic to the fs -- else
		   we could poll the fs for *every* local alias found;
		   on a typical system enabling FILE_NAMES_ALIASES, this
		   is significant.  */

		while (cPtr->current.current_fpe < cPtr->num_fpes &&
		       cPtr->fpe_list[cPtr->current.current_fpe]->type !=
		       cPtr->fpe_list[cPtr->saved.current_fpe]->type)
		cPtr->current.current_fpe++;

		if (cPtr->names->nnames == cPtr->current.max_names ||
			cPtr->current.current_fpe == cPtr->num_fpes) {
		    cPtr->haveSaved = FALSE;
		    cPtr->current = cPtr->saved;
		    /* Give the saved namelist a chance to clean itself up */
		    continue;
		}
	    }
	    if (cPtr->names->nnames == cPtr->current.max_names)
		break;
	}
    }

    /*
     * send the reply
     */
    if (err != Successful) {
	SendErrToClient(client, FontToFSError(err), (pointer) 0);
	goto bail;
    }

finish:

    names = cPtr->names;
    nnames = names->nnames;
    client = cPtr->client;
    stringLens = 0;
    for (i = 0; i < nnames; i++)
	stringLens += (names->length[i] <= 255) ? names->length[i] : 0;

    reply = (fsListFontsReply) {
	.type = FS_Reply,
	.sequenceNumber = client->sequence,
	.length = (SIZEOF(fsListFontsReply) + stringLens + nnames + 3) >> 2,
	.following = 0,
	.nFonts = nnames
    };

    bufptr = bufferStart = (char *) ALLOCATE_LOCAL(reply.length << 2);

    if (!bufptr && reply.length) {
	SendErrToClient(client, FSBadAlloc, (pointer) 0);
	goto bail;
    }
    /*
     * since WriteToClient long word aligns things, copy to temp buffer and
     * write all at once
     */
    for (i = 0; i < nnames; i++) {
	if (names->length[i] > 255)
	    reply.nFonts--;
	else
	{
	    *bufptr++ = names->length[i];
	    memmove( bufptr, names->names[i], names->length[i]);
	    bufptr += names->length[i];
	}
    }
    nnames = reply.nFonts;
    reply.length = (SIZEOF(fsListFontsReply) + stringLens + nnames + 3) >> 2;
    WriteReplyToClient(client, SIZEOF(fsListFontsReply), &reply);
    (void) WriteToClient(client, stringLens + nnames, bufferStart);
    DEALLOCATE_LOCAL(bufferStart);

bail:
    if (cPtr->slept)
	ClientWakeup(client);
    for (i = 0; i < cPtr->num_fpes; i++)
	FreeFPE(cPtr->fpe_list[i]);
    fsfree(cPtr->fpe_list);
    if (cPtr->savedName) fsfree(cPtr->savedName);
    xfont2_free_font_names(names);
    fsfree(cPtr);
    return TRUE;
}

int
ListFonts(
    ClientPtr   client,
    int         length,
    unsigned char *pattern,
    int         maxNames)
{
    int         i;
    LFclosurePtr c;

    /*
     * The right error to return here would be BadName, however the
     * specification does not allow for a Name error on this request.
     * Perhaps a better solution would be to return a nil list, i.e.
     * a list containing zero fontnames.
     */
    if (length > XLFDMAXFONTNAMELEN) {
	SendErrToClient(client, FSBadAlloc, (pointer) 0);
	return TRUE;
    }

    if (!(c = (LFclosurePtr) fsalloc(sizeof *c)))
	goto badAlloc;
    c->fpe_list = (FontPathElementPtr *)
	fsalloc(sizeof(FontPathElementPtr) * num_fpes);
    if (!c->fpe_list) {
	fsfree(c);
	goto badAlloc;
    }
    c->names = xfont2_make_font_names_record(maxNames < 100 ? maxNames : 100);
    if (!c->names)
    {
	fsfree(c->fpe_list);
	fsfree(c);
	goto badAlloc;
    }
    memmove( c->current.pattern, pattern, length);
    for (i = 0; i < num_fpes; i++) {
	c->fpe_list[i] = font_path_elements[i];
	UseFPE(c->fpe_list[i]);
    }
    c->client = client;
    c->num_fpes = num_fpes;
    c->current.patlen = length;
    c->current.current_fpe = 0;
    c->current.max_names = maxNames;
    c->current.list_started = FALSE;
    c->current.private = NULL;
    c->haveSaved = FALSE;
    c->slept = FALSE;
    c->savedName = NULL;
    do_list_fonts_and_aliases(client, (pointer) c);
    return TRUE;
badAlloc:
    SendErrToClient(client, FSBadAlloc, (pointer) 0);
    return TRUE;
}

static int padlength[4] = {0, 3, 2, 1};
static char padding[3];

#undef  cPtr
#define cPtr ((LFWXIclosurePtr)data)

static Bool
do_list_fonts_with_info(ClientPtr client, pointer data)
{
    FontPathElementPtr fpe;
    int         err = Successful;
    char       *name;
    int         namelen;
    int         numFonts;
    FontInfoRec fontInfo,
               *pFontInfo;
    fsListFontsWithXInfoReply *reply;
    int         length;
    fsPropInfo *prop_info;
    int         lenpropdata;
    int         i;
    int		aliascount = 0;

    if (client->clientGone == CLIENT_GONE) {
	if (cPtr->current.current_fpe < cPtr->num_fpes) {
	    fpe = cPtr->fpe_list[cPtr->current.current_fpe];
	    (*fpe_functions[fpe->type].client_died) ((pointer) client, fpe);
	}
	err = Successful;
	goto bail;
    }
    while (cPtr->current.current_fpe < cPtr->num_fpes) {
	fpe = cPtr->fpe_list[cPtr->current.current_fpe];
	err = Successful;
	if (!cPtr->current.list_started) {
	    err = (*fpe_functions[fpe->type].start_list_fonts_with_info)
		((pointer) cPtr->client, fpe, cPtr->current.pattern,
		 cPtr->current.patlen, cPtr->current.max_names,
		 &cPtr->current.private);
	    if (err == Suspended) {
		if (!cPtr->slept) {
		    ClientSleep(client, do_list_fonts_with_info,
				(pointer) cPtr);
		    cPtr->slept = TRUE;
		}
		return TRUE;
	    }
	    if (err == Successful)
		cPtr->current.list_started = TRUE;
	}
	if (err == Successful) {
	    name = NULL;
	    pFontInfo = &fontInfo;
	    err = (*fpe_functions[fpe->type].list_next_font_with_info)
		((pointer) cPtr->client, fpe, &name, &namelen,
		 &pFontInfo, &numFonts, cPtr->current.private);
	    if (err == Suspended) {
		if (!cPtr->slept) {
		    ClientSleep(client, do_list_fonts_with_info,
				(pointer) cPtr);
		    cPtr->slept = TRUE;
		}
		return TRUE;
	    }
	}
	/*
	 * When we get an alias back, save our state and reset back to the
	 * start of the FPE looking for the specified name.  As soon as a real
	 * font is found for the alias, pop back to the old state
	 */
	if (err == FontNameAlias) {
	    /*
	     * when an alias recurses, we need to give
	     * the last FPE a chance to clean up; so we call
	     * it again, and assume that the error returned
	     * is BadFontName, indicating the alias resolution
	     * is complete.
	     */
	    if (cPtr->haveSaved)
	    {
		char	*tmpname;
		int	tmpnamelen;
		FontInfoPtr tmpFontInfo;

		tmpname = NULL;
	    	tmpFontInfo = &fontInfo;
	    	(void) (*fpe_functions[fpe->type].list_next_font_with_info)
		    ((pointer) client, fpe, &tmpname, &tmpnamelen,
		     &tmpFontInfo, &numFonts, cPtr->current.private);
		if (--aliascount <= 0)
		{
		    err = BadFontName;
		    goto ContBadFontName;
		}
	    }
	    else
	    {
		cPtr->saved = cPtr->current;
		cPtr->haveSaved = TRUE;
		cPtr->savedNumFonts = numFonts;
		if (cPtr->savedName)
		  fsfree(cPtr->savedName);
		cPtr->savedName = (char *)fsalloc(namelen + 1);
		if (cPtr->savedName)
		  memmove(cPtr->savedName, name, namelen + 1);
		aliascount = 20;
	    }
	    memmove(cPtr->current.pattern, name, namelen);
	    cPtr->current.patlen = namelen;
	    cPtr->current.max_names = 1;
	    cPtr->current.current_fpe = 0;
	    cPtr->current.private = NULL;
	    cPtr->current.list_started = FALSE;
	}
	/*
	 * At the end of this FPE, step to the next.  If we've finished
	 * processing an alias, pop state back. If we've sent enough font
	 * names, quit.
	 */
	else if (err == BadFontName) {
	  ContBadFontName: ;
	    cPtr->current.list_started = FALSE;
	    cPtr->current.current_fpe++;
	    err = Successful;
	    if (cPtr->haveSaved) {
		if (cPtr->current.max_names == 0 ||
			cPtr->current.current_fpe == cPtr->num_fpes) {
		    cPtr->haveSaved = FALSE;
		    cPtr->saved.max_names -= (1 - cPtr->current.max_names);
		    cPtr->current = cPtr->saved;
		}
	    }
	    else if (cPtr->current.max_names == 0)
		break;
	} else if (err == Successful) {
/* XXX why is it xFontProp ? */
	    length = sizeof(*reply) + pFontInfo->nprops * sizeof(xFontProp);
	    reply = cPtr->reply;
	    if (cPtr->length < length) {
		reply = (fsListFontsWithXInfoReply *) fsrealloc(cPtr->reply, length);
		if (!reply) {
		    err = AllocError;
		    break;
		}
		cPtr->reply = reply;
		cPtr->length = length;
	    }
	    if (cPtr->haveSaved) {
		numFonts = cPtr->savedNumFonts;
		name = cPtr->savedName;
		namelen = strlen(name);
	    }
	    fsPack_XFontInfoHeader(pFontInfo, reply, client->major_version);
	    err = convert_props(pFontInfo, &prop_info);
	    if (err != Successful)
		break;
	    lenpropdata = SIZEOF(fsPropInfo) +
		prop_info->num_offsets * SIZEOF(fsPropOffset) +
		prop_info->data_len;

	    reply->type = FS_Reply;
	    reply->length =
		(SIZEOF(fsListFontsWithXInfoReply) +
		 lenpropdata + namelen + 3) >> 2;
	    reply->sequenceNumber = client->sequence;
	    reply->nameLength = namelen;
	    reply->nReplies = numFonts;
	    WriteReplyToClient(client, SIZEOF(fsListFontsWithXInfoReply), reply);
	    if (client->swapped)
		SwapPropInfo(prop_info);
	    if (client->major_version > 1)
	    {
		(void)WriteToClientUnpadded(client, lenpropdata, (char *) prop_info);
		(void)WriteToClientUnpadded(client, namelen, name);
		(void)WriteToClientUnpadded(client,
					    padlength[(lenpropdata+namelen)&3],
					    padding);
	    } else {
		(void) WriteToClient(client, namelen, name);
		(void) WriteToClient(client, lenpropdata, (char *) prop_info);
	    }
	    if (pFontInfo == &fontInfo) {
		fsfree(fontInfo.props);
		fsfree(fontInfo.isStringProp);
	    }
	    fsfree(prop_info);

	    --cPtr->current.max_names;
	    if (cPtr->current.max_names < 0)
		break;
	}
    }

    /*
     * send the final reply
     */
    if (err == Successful) {
	fsGenericReply *final_reply;

	final_reply = (fsGenericReply *)cPtr->reply;
	if (client->major_version > 1)
	    length = SIZEOF(fsGenericReply);
	else
	    length = SIZEOF(fsListFontsWithXInfoReply);
	if (cPtr->length < length) {
	    final_reply = (fsGenericReply *) fsrealloc(cPtr->reply, length);
	    if (final_reply) {
		cPtr->reply = (fsListFontsWithXInfoReply *)final_reply;
		cPtr->length = length;
	    } else
		err = AllocError;
	}
	if (err == Successful) {
	    final_reply->type = FS_Reply;
	    final_reply->data1 = 0; /* notes that this is final */
	    final_reply->sequenceNumber = client->sequence;
	    final_reply->length = length >> 2;
	    WriteReplyToClient(client, length, final_reply);
	}
    }
    if (err != Successful)
	SendErrToClient(client, FontToFSError(err), (pointer) 0);
bail:
    if (cPtr->slept)
	ClientWakeup(client);
    for (i = 0; i < cPtr->num_fpes; i++)
	FreeFPE(cPtr->fpe_list[i]);
    fsfree(cPtr->fpe_list);
    if (cPtr->savedName) fsfree(cPtr->savedName);
    fsfree(cPtr->reply);
    fsfree(cPtr);
    return TRUE;
}

int
StartListFontsWithInfo(
    ClientPtr   client,
    int         length,
    unsigned char *pattern,
    int         maxNames)
{
    int         i;
    LFWXIclosurePtr c;

    /*
     * The right error to return here would be BadName, however the
     * specification does not allow for a Name error on this request.
     * Perhaps a better solution would be to return a nil list, i.e.
     * a list containing zero fontnames.
     */
    if (length > XLFDMAXFONTNAMELEN) {
	SendErrToClient(client, FSBadAlloc, (pointer) 0);
	return TRUE;
    }

    if (!(c = (LFWXIclosurePtr) fsalloc(sizeof *c)))
	goto badAlloc;
    c->fpe_list = (FontPathElementPtr *)
	fsalloc(sizeof(FontPathElementPtr) * num_fpes);
    if (!c->fpe_list) {
	fsfree(c);
	goto badAlloc;
    }
    memmove( c->current.pattern, pattern, length);
    for (i = 0; i < num_fpes; i++) {
	c->fpe_list[i] = font_path_elements[i];
	UseFPE(c->fpe_list[i]);
    }
    c->client = client;
    c->num_fpes = num_fpes;
    c->reply = NULL;
    c->length = 0;
    c->current.patlen = length;
    c->current.current_fpe = 0;
    c->current.max_names = maxNames;
    c->current.list_started = FALSE;
    c->current.private = NULL;
    c->savedNumFonts = 0;
    c->haveSaved = FALSE;
    c->slept = FALSE;
    c->savedName = NULL;
    do_list_fonts_with_info(client, (pointer) c);
    return TRUE;
badAlloc:
    SendErrToClient(client, FSBadAlloc, (pointer) 0);
    return TRUE;
}

int
LoadGlyphRanges(
    ClientPtr   client,
    FontPtr	pfont,
    Bool	range_flag,
    int		num_ranges,
    int		item_size,
    fsChar2b	*data)
{
    /* either returns Successful, Suspended, or some nasty error */
    if (fpe_functions[pfont->fpe->type].load_glyphs)
	return (*fpe_functions[pfont->fpe->type].load_glyphs)(
		(pointer)client, pfont, range_flag, num_ranges, item_size,
		(unsigned char *)data);
    else
	return Successful;
}


int
register_fpe_funcs(const xfont2_fpe_funcs_rec *funcs)
{
    xfont2_fpe_funcs_rec *new;

    /* grow the list */
    new = fsrealloc(fpe_functions, (num_fpe_types + 1) * sizeof(*new));
    if (!new)
	return -1;
    fpe_functions = new;

    memcpy(&fpe_functions[num_fpe_types], funcs, sizeof(*funcs));

    return num_fpe_types++;
}


/* convenience functions for FS interface */

FontPtr
find_old_font(FSID id)
{
    return (FontPtr) LookupIDByType(SERVER_CLIENT, id, RT_NONE);
}

Font
GetNewFontClientID(void)
{
    return (Font) FakeClientID(SERVER_CLIENT);
}

int
StoreFontClientFont(
    FontPtr     pfont,
    Font        id)
{
    return AddResource(SERVER_CLIENT, id, RT_NONE, (pointer) pfont);
}

void
DeleteFontClientID(Font id)
{
    FreeResource(SERVER_CLIENT, id, RT_NONE);
}

static int  fs_handlers_installed = 0;
static unsigned int last_server_gen;

int
xfs_init_fs_handlers(
    FontPathElementPtr fpe,
    FontBlockHandlerProcPtr block_handler)
{
    /* if server has reset, make sure the b&w handlers are reinstalled */
    if (last_server_gen < serverGeneration) {
	last_server_gen = serverGeneration;
	fs_handlers_installed = 0;
    }
    if (fs_handlers_installed == 0) {

#ifdef DEBUG
	fprintf(stderr, "adding FS b & w handlers\n");
#endif

	if (!RegisterBlockAndWakeupHandlers(block_handler,
					    FontWakeup, (pointer) 0))
	    return AllocError;
	fs_handlers_installed++;
    }
    QueueFontWakeup(fpe);
    return Successful;
}

void
xfs_remove_fs_handlers(
    FontPathElementPtr fpe,
    FontBlockHandlerProcPtr block_handler,
    Bool        all)
{
    if (all) {
	/* remove the handlers if no one else is using them */
	if (--fs_handlers_installed == 0) {

#ifdef DEBUG
	    fprintf(stderr, "removing FS b & w handlers\n");
#endif

	    RemoveBlockAndWakeupHandlers(block_handler, FontWakeup,
					 (pointer) 0);
	}
    }
    RemoveFontWakeup(fpe);
}

void
DeleteClientFontStuff(ClientPtr client)
{
    int i;
    FontPathElementPtr fpe;

    for (i = 0; i < num_fpes; i++)
    {
	fpe = font_path_elements[i];

	if (fpe_functions[fpe->type].client_died)
	    (*fpe_functions[fpe->type].client_died) ((pointer) client, fpe);
    }
}