/*
 * Copyright 2000, International Business Machines Corporation and others.
 * All Rights Reserved.
 * 
 * This software has been released under the terms of the IBM Public
 * License.  For details, see the LICENSE file in the top-level source
 * directory or online at http://www.openafs.org/dl/license10.html
 */

#ifndef __gator_objects_h
#define	__gator_objects_h  1

/*--------------------------------------------------------------------------------
 * objects.h
 *
 * Constants and data structures defining the basis for a gator object.
 *--------------------------------------------------------------------------------*/

#include "gtxwindows.h"		/*Standard window defs & ops */

/*Max number of chars in an object name*/
#define	GATOR_OBJNAMELEN 128

/*
 * The onode is the focus of all gator display activity.  There is a unique
 * onode for each gator object.
 */
struct onode {
    int o_type;			/*Object type */
    char o_name[GATOR_OBJNAMELEN];	/*Object's string name */
    int o_x, o_y;		/*X and Y coordinates */
    int o_width, o_height;	/*Width & height in pixels */
    int o_changed;		/*Changed since last refresh? */
    short o_refcount;		/*Reference count */
    struct gwin *o_window;	/*Object's associated graphical window */
    struct onodeops *o_op;	/*Object's operations */
    struct onode *o_home;	/*Ptr to home object */
    struct onode *o_help;	/*Ptr to help object, if any */
    struct onode *o_nextobj;	/*Ptr to next queued object, if any */
    struct onode *o_upobj;	/*Ptr to parent (up) object, if any */
    struct onode *o_downobj;	/*Ptr to child (down) object, if any */
    int *o_data;		/*Ptr to object's private data region */
};

/*
 * Operations on individual onodes.  A pointer to this function array is
 * attached to each onode.  In reality, this array is different for each
 * object type, holding additional operations specific to that object.
 * However, every object must implement these functions in these first
 * slots.
 */
struct onodeops {
    int (*on_destroy) (struct onode *);	/*Destroy an onode */
    int (*on_display) (struct onode *);	/*Display an onode */
    int (*on_release) (struct onode *);	/*Decrement an onode ref count */
};

/*
 * Macros facilitating the use of onode functions.
 */
#define	OOP_DESTROY(ONP)	(ONP)->o_op->on_destroy(ONP);
#define	OOP_DISPLAY(ONP)	(ONP)->o_op->on_display(ONP);
#define	OOP_RELEASE(ONP)	(ONP)->o_op->on_release(ONP);

/*
 * Initialization parameters for an onode.
 */
struct onode_initparams {
    int i_debug;		/*Turn debugging on? */
    struct gwin_initparams *i_gwparams;	/*Ptr to window init params */
};

/*
 * Creation parameters for an onode.
 */
struct onode_createparams {
    int cr_type;		/*Type of onode */
    char cr_name[GATOR_OBJNAMELEN];	/*Object name */
    int cr_x, cr_y;		/*X and Y coordinates */
    int cr_width, cr_height;	/*Width & height in pixels */
    struct gwin *cr_window;	/*Graphical window to use */
    struct onode *cr_home_obj;	/*Home object */
    struct onode *cr_prev_obj;	/*Object having this one as next */
    struct onode *cr_parent_obj;	/*This object's parent */
    char *cr_helpstring;	/*Ptr to object's help text */
};

/*
  * Is debugging output enabled?
  */
extern int objects_debug;

extern int gator_objects_init(struct onode_initparams *);
    /*
     * Summary:
     *    Initialize the gator object package.
     *
     * Args:
     *    struct onode_initparams *params: Initialization parameters.
     *
     * Returns:
     *    0 on success,
     *    Error value otherwise.
     */

extern struct onode *gator_objects_create(struct onode_createparams *params);
    /*
     * Summary:
     *    Create an onode of the given type.
     *
     * Args:
     *    struct onode_createparams *params: Ptr to creation params.
     *
     * Returns:
     *    Ptr to newly-created onode if successful,
     *    Null pointer otherwise.
     */

extern struct onode *gator_objects_lookup(char *);
    /*
     * Summary:
     *    Look up a gator onode by name.
     *
     * Args:
     *    char *onode_name: Onode string name to find.
     *
     * Returns:
     *    Ptr to onode matching the given name if one exists,
     *    Null pointer otherwise.
     */

#endif /* __gator_objects_h */
