UnitStripChart.c

Go to the documentation of this file.

/*
 * Shamelessly ripped and modified from the source below:
 */

/* $Xorg: StripChart.c,v 1.4 2001/02/09 02:03:46 xorgcvs Exp $ */

/***********************************************************

Copyright 1987, 1988, 1994, 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 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and its 
documentation for any purpose and without fee is hereby granted, 
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 Digital not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.  

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
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.

******************************************************************/
/* $XFree86: xc/lib/Xaw/StripChart.c,v 1.8 2001/12/14 19:54:44 dawes Exp $ */

#include <stdio.h>
#include <X11/IntrinsicP.h>
#include <X11/StringDefs.h>
#include <X11/Xfuncs.h>
/* #include <X11/Xaw/StripCharP.h> */
#include "UnitStripCharP.h"
#include <X11/Xaw/XawInit.h>
#include "Private.h"
#include "assert.h"
#include "error.h"

#define MS_PER_SEC 1000

#define streq(a, b) (strcmp((a),(b)) == 0)

#ifdef CRAY
#define WORD64
#endif

/*
 * Class Methods
 */
static void XawUnitStripChartInitialize(Widget, Widget, ArgList, Cardinal*);
static void XawUnitStripChartDestroy(Widget);
static void XawUnitStripChartRedisplay(Widget, XEvent*, Region);
static void XawUnitStripChartResize(Widget);
static Boolean XawUnitStripChartSetValues(Widget, Widget, Widget,
                                      ArgList, Cardinal*);

/*
 * Prototypes
 */
static void CreateGC(UnitStripChartWidget, unsigned int);
static void DestroyGC(UnitStripChartWidget, unsigned int);
static void draw_it(XtPointer, XtIntervalId*);
static void MoveChart(UnitStripChartWidget);
static void repaint_window(UnitStripChartWidget);

/*
 * Initialization
 */
#define offset(field)   XtOffsetOf(UnitStripChartRec, field)
static XtResource resources[] = {
  {
    XtNwidth,
    XtCWidth,
    XtRDimension,
    sizeof(Dimension),
    offset(core.width),
    XtRImmediate,
    (XtPointer)
    120
  },
  {
    XtNheight,
    XtCHeight,
    XtRDimension,
    sizeof(Dimension),
    offset(core.height),
    XtRImmediate,
    (XtPointer)120
  },
  {
    XtNupdate,
    XtCInterval,
    XtRInt,
    sizeof(int),
    offset(unit_strip_chart.update),
    XtRImmediate,
    (XtPointer)10
  },
  {
    XtNminScale,
    XtCScale,
    XtRInt,
    sizeof(int),
    offset(unit_strip_chart.min_scale),
    XtRImmediate,
    (XtPointer)1
  },
  {
    XtNforeground,
    XtCForeground,
    XtRPixel,
    sizeof(Pixel),
    offset(unit_strip_chart.fgpixel),
    XtRString,
    XtDefaultForeground
  },
  {
    XtNhighlight,
    XtCForeground,
    XtRPixel,
    sizeof(Pixel),
    offset(unit_strip_chart.hipixel),
    XtRString,
    XtDefaultForeground
  },
  {
    XtNhighlight,
    XtCBackground,
    XtRPixel,
    sizeof(Pixel),
    offset(unit_strip_chart.bgpixel),
    XtRString,
    XtDefaultBackground
  },
  {
    XtNgetValue,
    XtCCallback,
    XtRCallback,
    sizeof(XtPointer),
    offset(unit_strip_chart.get_value),
    XtRImmediate,
    NULL
  },
  {
    XtNjumpScroll,
    XtCJumpScroll,
    XtRInt,
    sizeof(int),
    offset(unit_strip_chart.jump_val),
    XtRImmediate,
    (XtPointer)DEFAULT_JUMP
  },
  {
    XtNfont,
    XtCFont,
    XtRFontStruct,
    sizeof(XFontStruct*),
    offset(unit_strip_chart.font),
    XtRString,
    XtDefaultFont
  },
  {
    XtNfontSet,
    XtCFontSet,
    XtRFontSet,
    sizeof(XFontSet),
    offset(unit_strip_chart.fontset),
    XtRString,
    XtDefaultFontSet
  },
  {
    XtNlabel,
    XtCLabel,
    XtRString,
    sizeof(String),
    offset(unit_strip_chart.label),
    XtRString,
    ""
  },
  {
    XtNunits,
    XtCUnits,
    XtRString,
    sizeof(String),
    offset(unit_strip_chart.units),
    XtRString,
    ""
  },
  {
    XtNencoding,
    XtCEncoding,
    XtRUnsignedChar,
    sizeof(unsigned char),
    offset(unit_strip_chart.encoding),
    XtRImmediate,
    (XtPointer)XawTextEncoding8bit
  },
  {
    XtNjustify,
    XtCJustify,
    XtRJustify,
    sizeof(XtJustify),
    offset(unit_strip_chart.justify),
    XtRImmediate,
    (XtPointer)XtJustifyCenter
  },
};
#undef offset

UnitStripChartClassRec unitStripChartClassRec = {
  /* core */
  {
    (WidgetClass)&simpleClassRec,       /* superclass */
    "UnitStripChart",                   /* class_name */
    sizeof(UnitStripChartRec),          /* widget_size */
    XawInitializeWidgetSet,             /* class_initialize */
    NULL,                               /* class_part_initialize */
    False,                              /* class_inited */
    XawUnitStripChartInitialize,                /* initialize */
    NULL,                               /* initialize_hook */
    XtInheritRealize,                   /* realize */
    NULL,                               /* actions */
    0,                                  /* num_actions */
    resources,                          /* resources */
    XtNumber(resources),                /* num_resources */
    NULLQUARK,                          /* xrm_class */
    True,                               /* compress_motion */
    XtExposeCompressMultiple            /* compress_exposure */
    | XtExposeGraphicsExposeMerged,
    True,                               /* compress_enterleave */
    False,                              /* visible_interest */
    XawUnitStripChartDestroy,           /* destroy */
    XawUnitStripChartResize,            /* resize */
    XawUnitStripChartRedisplay,         /* expose */
    XawUnitStripChartSetValues,         /* set_values */
    NULL,                               /* set_values_hook */
    NULL,                               /* set_values_almost */
    NULL,                               /* get_values_hook */
    NULL,                               /* accept_focus */
    XtVersion,                          /* version */
    NULL,                               /* callback_private */
    NULL,                               /* tm_table */
    XtInheritQueryGeometry,             /* query_geometry */
    XtInheritDisplayAccelerator,        /* display_accelerator */
    NULL,                               /* extension */
  },
  /* simple */
  {
    XtInheritChangeSensitive,           /* change_sensitive */
  }
};

WidgetClass unitStripChartWidgetClass = (WidgetClass)&unitStripChartClassRec;

/*
 * Implementation
 */
/*
 * Function:
 *      CreateGC
 *
 * Parameters:
 *      w     - strip chart widget
 *      which - GC's to create
 *
 * Description:
 *      Creates the GC's
 */
static void
CreateGC(UnitStripChartWidget w, unsigned int which)
{
        XGCValues myXGCV;

        ASSERT(w != NULL);

        if (which & FOREGROUND) {
                myXGCV.foreground = w->unit_strip_chart.fgpixel;
                w->unit_strip_chart.fgGC = XtGetGC((Widget)w, GCForeground, &myXGCV);
        }

        if (which & HIGHLIGHT) {
                myXGCV.foreground = w->unit_strip_chart.hipixel;
                w->unit_strip_chart.hiGC = XtGetGC((Widget)w, GCForeground, &myXGCV);
        }

        if (which & BACKGROUND) {
                myXGCV.foreground = w->core.background_pixel;
                w->unit_strip_chart.bgGC = XtGetGC((Widget)w, GCForeground, &myXGCV);
        }
}

/*
 * Function:
 *      DestroyGC
 *
 * Arguments:
 *      w     - strip chart widget
 *      which - which GC's to destroy
 *
 * Description:
 *      Destroys the GC's
 */
static void
DestroyGC(UnitStripChartWidget w, unsigned int which)
{
        ASSERT(w != NULL);

        if (which & FOREGROUND) 
                XtReleaseGC((Widget)w, w->unit_strip_chart.fgGC);

        if (which & HIGHLIGHT) 
                XtReleaseGC((Widget)w, w->unit_strip_chart.hiGC);

        if (which & BACKGROUND) 
                XtReleaseGC((Widget)w, w->unit_strip_chart.bgGC);
}

/*ARGSUSED*/
static void
XawUnitStripChartInitialize(Widget greq, Widget gnew,
                        ArgList args, Cardinal *num_args)
{
    UnitStripChartWidget w;

                ASSERT(gnew != NULL);
                ASSERT(num_args != NULL);

    w = (UnitStripChartWidget)gnew;

    if (w->unit_strip_chart.update > 0)
    w->unit_strip_chart.interval_id =
    XtAppAddTimeOut(XtWidgetToApplicationContext(gnew),
                    w->unit_strip_chart.update * MS_PER_SEC, 
                    draw_it, (XtPointer)gnew);
    CreateGC(w, ALL_GCS);

    w->unit_strip_chart.scale = w->unit_strip_chart.min_scale;
    w->unit_strip_chart.interval = 0;
    w->unit_strip_chart.max_value = 0.0;
    w->unit_strip_chart.points = NULL;
                if (w->unit_strip_chart.label == NULL)
                        w->unit_strip_chart.label = XtNewString("");
                else
                        w->unit_strip_chart.label = XtNewString(w->unit_strip_chart.label);
                if (w->unit_strip_chart.units == NULL)
                        w->unit_strip_chart.units = XtNewString("");
                else
                        w->unit_strip_chart.units = XtNewString(w->unit_strip_chart.units);
   XawUnitStripChartResize(gnew);
}
 
static void
XawUnitStripChartDestroy(Widget gw)
{
        UnitStripChartWidget w;
                
        ASSERT(gw != NULL);

        w = (UnitStripChartWidget)gw;

        XtFree(w->unit_strip_chart.label);
        XtFree(w->unit_strip_chart.units);
        if (w->unit_strip_chart.update > 0)
                XtRemoveTimeOut(w->unit_strip_chart.interval_id);
        if (w->unit_strip_chart.points)
                XtFree((char *)w->unit_strip_chart.points);
        DestroyGC(w, ALL_GCS);
}

/*
 * NOTE: This function really needs to recieve graphics exposure 
 *       events, but since this is not easily supported until R4 I am
 *       going to hold off until then.
 */
/*ARGSUSED*/
static void
XawUnitStripChartRedisplay(Widget w, XEvent *event, Region region)
{
        ASSERT(event != NULL);

        repaint_window((UnitStripChartWidget)w);
}

static void
MoveChart(UnitStripChartWidget w)
{
        int old_max;
        int left, i, j;
        int next;
        
        ASSERT(w != NULL);

        next = w->unit_strip_chart.interval;

        if (!XtIsRealized((Widget)w))
                return;

        if (w->unit_strip_chart.jump_val < 0)
                w->unit_strip_chart.jump_val = DEFAULT_JUMP;
        if (w->unit_strip_chart.jump_val == DEFAULT_JUMP)
                j = XtWidth(w) >> 1;
        else {
                j = (int)XtWidth(w) - w->unit_strip_chart.jump_val;
                if (j < 0)
                        j = 0;
        }

        ASSERT(next - j < NUM_DATA_POINTS);
        (void)memmove(
                (char *)w->unit_strip_chart.valuedata,
                (char *)(w->unit_strip_chart.valuedata + next - j),
                j * sizeof(int)
                );
        next = w->unit_strip_chart.interval = j;
        
        /*
         * Since we just lost some data, recompute the 
         * w->unit_strip_chart.max_value
         */
        old_max = w->unit_strip_chart.max_value;
        w->unit_strip_chart.max_value = 0.0;
        ASSERT(next < NUM_DATA_POINTS);
        for (i = 0; i < next; i++) {
                if (w->unit_strip_chart.valuedata[i] > w->unit_strip_chart.max_value) 
                        w->unit_strip_chart.max_value = w->unit_strip_chart.valuedata[i];
        }
}

/*ARGSUSED*/
static void 
draw_it(XtPointer client_data, XtIntervalId *id)
{
        UnitStripChartWidget w;
        int value;
 
        ASSERT(client_data != NULL);

        w = (UnitStripChartWidget)client_data;

        ASSERT(w != NULL);

        if (w->unit_strip_chart.update > 0)
                w->unit_strip_chart.interval_id =
                        XtAppAddTimeOut(
                                XtWidgetToApplicationContext((Widget)w),
                                w->unit_strip_chart.update * MS_PER_SEC,draw_it,
                                client_data
                                );

        if (w->unit_strip_chart.interval >= XtWidth(w)) {
                MoveChart((UnitStripChartWidget)w);
                XClearWindow(XtDisplay(w), XtWindow(w));
                repaint_window(w);
        }

        /* Get the value, stash the point and draw corresponding line */
        if (w->unit_strip_chart.get_value == NULL)
                return;

        ASSERT(w != NULL);

        XtCallCallbacks((Widget)w, XtNgetValue, (XtPointer)&value);

        if (w == NULL) {
                if (client_data != NULL) {
                        w = (UnitStripChartWidget)client_data;
                }
                else {
                        INTERNAL_ERROR("w == NULL");
                        return;
                }
        }
        ASSERT(w != NULL);

        ASSERT(w->unit_strip_chart.interval < NUM_DATA_POINTS);

        w->unit_strip_chart.valuedata[w->unit_strip_chart.interval] = value;
        if (value > w->unit_strip_chart.max_value)
                w->unit_strip_chart.max_value = value;

        repaint_window(w);
        XFlush(XtDisplay(w));           /* Flush output buffers */
        w->unit_strip_chart.interval++;         /* Next point */
}

static void 
repaint_window(UnitStripChartWidget w)
{
        int i, j;
        double scale = w->unit_strip_chart.scale;
        int scalewidth = 0;
        int multiplier;

        ASSERT(w != NULL);

        /* Compute the minimum scale required to graph the data, but don't go
           lower than min_scale */
        if (w->unit_strip_chart.interval != 0 || scale <= w->unit_strip_chart.max_value)
                scale = w->unit_strip_chart.max_value + 1;
        multiplier = 1;
        while (scale > 100) {
                scale /= 10;
                multiplier *= 10;
        }
        while (scale > 10) {
                scale /= 2;
                multiplier *= 2;
        }
        if (scale < w->unit_strip_chart.min_scale)
            scale = w->unit_strip_chart.min_scale;

        if (scale != w->unit_strip_chart.scale) {
                w->unit_strip_chart.scale = scale;

        XawUnitStripChartResize((Widget)w);

        if (XtIsRealized((Widget)w))
                XClearWindow(XtDisplay(w), XtWindow(w));
        }

        if (XtIsRealized((Widget)w)) {
                Display *dpy = XtDisplay(w);
                Window win = XtWindow(w);
                static char text[1025] = { 0 };
                int multiplier_units = 0;
                char *multiplier_units_chars = " KMGTPE\0";
                char units_char;
                static char numstr[10] = { 0 };
                int cx, cy;

                /* Draw data point lines */
                ASSERT(XtWidth(w) < NUM_DATA_POINTS);
                for (i = 0; i < XtWidth(w); i++) {
                                int widget_height = XtHeight(w);
                                int y;
                                int div;

                                y = widget_height * w->unit_strip_chart.valuedata[i];
                                div = multiplier * scale;
                                y /= div;

                                ASSERT(y <= widget_height);

                                XFillRectangle(dpy, win, w->unit_strip_chart.fgGC, 
                                         i, XtHeight(w)-y, 1, XtHeight(w));
                }

                /* Draw graph reference lines */
                for (i = 1; i < w->unit_strip_chart.scale; i++) {
                                j = i * ((int)XtHeight(w) / w->unit_strip_chart.scale);
                                XDrawLine(dpy, win, w->unit_strip_chart.hiGC, 0, j, XtWidth(w), j);
                }

                /* Draw the multiplier and units text */
                if (strlen(w->unit_strip_chart.units)) {
                        while (multiplier > 1000) {
                                multiplier /= 1000;
                                multiplier_units++;
                        }
                        if (multiplier_units <= strlen(multiplier_units_chars))
                                units_char = multiplier_units_chars[multiplier_units];
                        else
                                units_char = '?';
                        snprintf(numstr, 9, "%d", multiplier);
                        snprintf(text, 1024, "%3.3s%c%s", 
                                numstr, units_char, w->unit_strip_chart.units);
        
                        for (cy = -3; cy < 4; cy++) {
                                for (cx = -3; cx < 4; cx++) {
                                        XmbDrawString(XtDisplay(w), XtWindow(w), 
                                                w->unit_strip_chart.fontset,
                                                w->unit_strip_chart.bgGC,
                                                5+cx, XtHeight(w)-5+cy, 
                                                text, strlen(text));
                                }
                        }
        
                        XmbDrawString(XtDisplay(w), XtWindow(w), 
                                        w->unit_strip_chart.fontset,
                                        w->unit_strip_chart.hiGC,
                                        5, XtHeight(w)-5, 
                                        text, strlen(text));
                }
        }
}

/*ARGSUSED*/
static Boolean
XawUnitStripChartSetValues(Widget current, Widget request, Widget cnew,
                       ArgList args, Cardinal *num_args)
{
        UnitStripChartWidget old = (UnitStripChartWidget)current;
        UnitStripChartWidget w = (UnitStripChartWidget)cnew;
        Bool ret_val = False;
        unsigned int new_gc = NO_GCS;

        ASSERT(current != NULL);
        ASSERT(cnew != NULL);

        old = (UnitStripChartWidget)current;
        w = (UnitStripChartWidget)cnew;

        ASSERT(old != NULL);
        ASSERT(w != NULL);

        if (w->unit_strip_chart.update != old->unit_strip_chart.update) {
                if (old->unit_strip_chart.update > 0)
                        XtRemoveTimeOut(old->unit_strip_chart.interval_id);
                if (w->unit_strip_chart.update > 0)
                        w->unit_strip_chart.interval_id =
                                XtAppAddTimeOut(
                                        XtWidgetToApplicationContext(cnew),
                                        w->unit_strip_chart.update * MS_PER_SEC,
                                        draw_it, (XtPointer)w
                                        );
        }

        if (w->unit_strip_chart.min_scale > w->unit_strip_chart.max_value + 1)
                ret_val = True;
     
        if (w->unit_strip_chart.fgpixel != old->unit_strip_chart.fgpixel) {
                new_gc |= FOREGROUND;
                ret_val = True;
        }
    
        if (w->unit_strip_chart.hipixel != old->unit_strip_chart.hipixel) {
                new_gc |= HIGHLIGHT;
                ret_val = True;
        }

        if (w->unit_strip_chart.bgpixel != old->unit_strip_chart.bgpixel) {
                new_gc |= BACKGROUND;
                ret_val = True;
        }
    
        DestroyGC(old, new_gc);
        CreateGC(w, new_gc);

        return (ret_val);
}

/*
 * Function:
 *      XawUnitStripChartResize
 *
 * Parameters:
 *      w - UnitStripChart widget
 *
 * Description:
 *      Sets up the polypoint that will be used to draw in the graph lines.
 */
static void
XawUnitStripChartResize(Widget widget)
{
        UnitStripChartWidget w;
        XPoint *points;
        Cardinal size;
        int i;
        static int old_width = 0;

        ASSERT(widget != NULL);

        w = (UnitStripChartWidget)widget;

        ASSERT(w != NULL);

        if (w->unit_strip_chart.scale <= 1) {
                XtFree((char *)w->unit_strip_chart.points);
                w->unit_strip_chart.points = NULL;
                return;
        }
    
        size = sizeof(XPoint) * (w->unit_strip_chart.scale - 1);

        points = (XPoint *)XtRealloc((XtPointer)w->unit_strip_chart.points, size);

        ASSERT(points != NULL);

        w->unit_strip_chart.points = points;

        /* Draw graph reference lines into clip mask */

        for (i = 1; i < w->unit_strip_chart.scale; i++) {
                points[i - 1].x = 0;
                points[i - 1].y = XtHeight(w) / w->unit_strip_chart.scale;
        }

        if (old_width != XtWidth(w)) {
                for (i = w->unit_strip_chart.interval+1; i < NUM_DATA_POINTS; i++) {
                        w->unit_strip_chart.valuedata[i] = 0;
                }
                old_width = XtWidth(w);
        }
}

---