summaryrefslogtreecommitdiffstats
path: root/src/bltGrHairs.C
blob: 2d6d207b984a0e8361861ab04d8d676af18cdf46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/*
 * Smithsonian Astrophysical Observatory, Cambridge, MA, USA
 * This code has been modified under the terms listed below and is made
 * available under the same terms.
 */

/*
 *	Copyright 1993-2004 George A Howlett.
 *
 *	Permission is hereby granted, free of charge, to any person
 *	obtaining a copy of this software and associated documentation
 *	files (the "Software"), to deal in the Software without
 *	restriction, including without limitation the rights to use,
 *	copy, modify, merge, publish, distribute, sublicense, and/or
 *	sell copies of the Software, and to permit persons to whom the
 *	Software is furnished to do so, subject to the following
 *	conditions:
 *
 *	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 AUTHORS
 *	OR COPYRIGHT HOLDERS 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.
 */

extern "C" {
#include "bltInt.h"
#include "bltGraph.h"
#include "bltOp.h"
#include "bltConfig.h"
}

#define PointInGraph(g,x,y) (((x) <= (g)->right) && ((x) >= (g)->left) && ((y) <= (g)->bottom) && ((y) >= (g)->top))

struct _Crosshairs {
  Tk_OptionTable optionTable;
  XPoint hotSpot;		/* Hot spot for crosshairs */
  int visible;		/* Internal state of crosshairs. If non-zero,
			 * crosshairs are displayed. */
  int hide;			/* If non-zero, crosshairs are not displayed.
				 * This is not necessarily consistent with the
				 * internal state variable.  This is true when
				 * the hot spot is off the graph.  */
  Blt_Dashes dashes;		/* Dashstyle of the crosshairs. This represents
				 * an array of alternatingly drawn pixel
				 * values. If NULL, the hairs are drawn as a
				 * solid line */
  int lineWidth;		/* Width of the simulated crosshair lines */
  XSegment segArr[2];		/* Positions of line segments representing the
				 * simulated crosshairs. */
  XColor* colorPtr;		/* Foreground color of crosshairs */
  GC gc;			/* Graphics context for crosshairs. Set to
				 * GXxor to not require redraws of graph */
};

// Defs

static int CrosshairsObjConfigure(Tcl_Interp* interp, Graph* graphPtr,
				  int objc, Tcl_Obj* const objv[]);
static void ConfigureCrosshairs(Graph* graphPtr);
static void TurnOffHairs(Tk_Window tkwin, Crosshairs *chPtr);
static void TurnOnHairs(Graph* graphPtr, Crosshairs *chPtr);
typedef int (GraphCrosshairProc)(Graph* graphPtr, Tcl_Interp* interp, 
				 int objc, Tcl_Obj* const objv[]);

// OptionSpecs

static Tk_OptionSpec optionSpecs[] = {
  {TK_OPTION_COLOR, "-color", "color", "Color", 
   "green", -1, Tk_Offset(Crosshairs, colorPtr), 0, NULL, 0},
  {TK_OPTION_CUSTOM, "-dashes", "dashes", "Dashes", 
   NULL, -1, Tk_Offset(Crosshairs, dashes), 
   TK_OPTION_NULL_OK, &dashesObjOption, 0},
  {TK_OPTION_BOOLEAN, "-hide", "hide", "Hide", 
   "yes", -1, Tk_Offset(Crosshairs, hide), 0, NULL, 0},
  {TK_OPTION_PIXELS, "-linewidth", "lineWidth", "Linewidth",
   "0", -1, Tk_Offset(Crosshairs, lineWidth), 0, NULL, 0},
  {TK_OPTION_CUSTOM, "-position", "position", "Position", 
   NULL, -1, Tk_Offset(Crosshairs, hotSpot), 
   TK_OPTION_NULL_OK, &pointObjOption, 0},
  {TK_OPTION_END, NULL, NULL, NULL, NULL, -1, 0, 0, NULL, 0}
};

// Create

int Blt_CreateCrosshairs(Graph* graphPtr)
{
  Crosshairs* chPtr = (Crosshairs*)calloc(1, sizeof(Crosshairs));
  chPtr->hide = TRUE;
  chPtr->hotSpot.x = chPtr->hotSpot.y = -1;
  graphPtr->crosshairs = chPtr;

  chPtr->optionTable = Tk_CreateOptionTable(graphPtr->interp, optionSpecs);
  return Tk_InitOptions(graphPtr->interp, (char*)chPtr, chPtr->optionTable, 
			graphPtr->tkwin);
}

void Blt_DestroyCrosshairs(Graph* graphPtr)
{
  Crosshairs *chPtr = graphPtr->crosshairs;
  if (!chPtr)
    return;

  if (chPtr->gc)
    Blt_FreePrivateGC(graphPtr->display, chPtr->gc);

  Tk_FreeConfigOptions((char*)chPtr, chPtr->optionTable, graphPtr->tkwin);
  free(chPtr);
}

// Configure

static int CgetOp(Graph* graphPtr, Tcl_Interp* interp,
		  int objc, Tcl_Obj* const objv[])
{
  if (objc != 4) {
    Tcl_WrongNumArgs(interp, 2, objv, "cget option");
    return TCL_ERROR;
  }

  Crosshairs* chPtr = graphPtr->crosshairs;
  Tcl_Obj* objPtr = Tk_GetOptionValue(interp, (char*)chPtr, 
				      chPtr->optionTable,
				      objv[3], graphPtr->tkwin);
  if (objPtr == NULL)
    return TCL_ERROR;
  else
    Tcl_SetObjResult(interp, objPtr);
  return TCL_OK;
}

static int ConfigureOp(Graph* graphPtr, Tcl_Interp* interp,
		       int objc, Tcl_Obj* const objv[])
{
  Crosshairs* chPtr = graphPtr->crosshairs;
  if (objc <= 4) {
    Tcl_Obj* objPtr = Tk_GetOptionInfo(graphPtr->interp, (char*)chPtr, 
				       chPtr->optionTable, 
				       (objc == 4) ? objv[3] : NULL, 
				       graphPtr->tkwin);
    if (objPtr == NULL)
      return TCL_ERROR;
    else
      Tcl_SetObjResult(interp, objPtr);
    return TCL_OK;
  } 
  else
    return CrosshairsObjConfigure(interp, graphPtr, objc-3, objv+3);
}

static int CrosshairsObjConfigure(Tcl_Interp* interp, Graph* graphPtr,
				  int objc, Tcl_Obj* const objv[])
{
  Crosshairs* chPtr = graphPtr->crosshairs;
  Tk_SavedOptions savedOptions;
  int mask =0;
  int error;
  Tcl_Obj* errorResult;

  for (error=0; error<=1; error++) {
    if (!error) {
      if (Tk_SetOptions(interp, (char*)chPtr, chPtr->optionTable, 
			objc, objv, graphPtr->tkwin, &savedOptions, &mask)
	  != TCL_OK)
	continue;
    }
    else {
      errorResult = Tcl_GetObjResult(interp);
      Tcl_IncrRefCount(errorResult);
      Tk_RestoreSavedOptions(&savedOptions);
    }

    graphPtr->flags |= mask;
    ConfigureCrosshairs(graphPtr);

    break; 
  }

  if (!error) {
    Tk_FreeSavedOptions(&savedOptions);
    return TCL_OK;
  }
  else {
    Tcl_SetObjResult(interp, errorResult);
    Tcl_DecrRefCount(errorResult);
    return TCL_ERROR;
  }
}

static void ConfigureCrosshairs(Graph* graphPtr)
{
  Crosshairs *chPtr = graphPtr->crosshairs;

  // Turn off the crosshairs temporarily. This is in case the new
  // configuration changes the size, style, or position of the lines.
  TurnOffHairs(graphPtr->tkwin, chPtr);

  XGCValues gcValues;
  gcValues.function = GXxor;

  unsigned long int pixel = Tk_3DBorderColor(graphPtr->plotBg)->pixel;
  gcValues.background = pixel;
  gcValues.foreground = (pixel ^ chPtr->colorPtr->pixel);

  gcValues.line_width = LineWidth(chPtr->lineWidth);
  unsigned long gcMask = 
    (GCForeground | GCBackground | GCFunction | GCLineWidth);
  if (LineIsDashed(chPtr->dashes)) {
    gcValues.line_style = LineOnOffDash;
    gcMask |= GCLineStyle;
  }
  GC newGC = Blt_GetPrivateGC(graphPtr->tkwin, gcMask, &gcValues);
  if (LineIsDashed(chPtr->dashes))
    Blt_SetDashes(graphPtr->display, newGC, &chPtr->dashes);

  if (chPtr->gc != NULL)
    Blt_FreePrivateGC(graphPtr->display, chPtr->gc);

  chPtr->gc = newGC;

  // Are the new coordinates on the graph?
  chPtr->segArr[0].x2 = chPtr->segArr[0].x1 = chPtr->hotSpot.x;
  chPtr->segArr[0].y1 = graphPtr->bottom;
  chPtr->segArr[0].y2 = graphPtr->top;
  chPtr->segArr[1].y2 = chPtr->segArr[1].y1 = chPtr->hotSpot.y;
  chPtr->segArr[1].x1 = graphPtr->left;
  chPtr->segArr[1].x2 = graphPtr->right;

  if (!chPtr->hide)
    TurnOnHairs(graphPtr, chPtr);
}

// Ops

static int OnOp(Graph* graphPtr, Tcl_Interp* interp, 
		int objc, Tcl_Obj* const objv[])
{
  Crosshairs *chPtr = graphPtr->crosshairs;

  if (chPtr->hide) {
    TurnOnHairs(graphPtr, chPtr);
    chPtr->hide = FALSE;
  }
  return TCL_OK;
}

static int OffOp(Graph* graphPtr, Tcl_Interp* interp,
		 int objc, Tcl_Obj* const objv[])
{
  Crosshairs *chPtr = graphPtr->crosshairs;

  if (!chPtr->hide) {
    TurnOffHairs(graphPtr->tkwin, chPtr);
    chPtr->hide = TRUE;
  }
  return TCL_OK;
}

static int ToggleOp(Graph* graphPtr, Tcl_Interp* interp,
		    int objc, Tcl_Obj* const objv[])
{
  Crosshairs *chPtr = graphPtr->crosshairs;

  chPtr->hide = (chPtr->hide == 0);
  if (chPtr->hide)
    TurnOffHairs(graphPtr->tkwin, chPtr);
  else
    TurnOnHairs(graphPtr, chPtr);

  return TCL_OK;
}

static Blt_OpSpec xhairOps[] =
  {
    {"cget", 2, (void*)CgetOp, 4, 4, "option",},
    {"configure", 2, (void*)ConfigureOp, 3, 0, "?options...?",},
    {"off", 2, (void*)OffOp, 3, 3, "",},
    {"on", 2, (void*)OnOp, 3, 3, "",},
    {"toggle", 1, (void*)ToggleOp, 3, 3, "",},
  };
static int nXhairOps = sizeof(xhairOps) / sizeof(Blt_OpSpec);

int Blt_CrosshairsOp(Graph* graphPtr, Tcl_Interp* interp,
		     int objc, Tcl_Obj* const objv[])
{
  GraphCrosshairProc* proc = (GraphCrosshairProc*)Blt_GetOpFromObj(interp, nXhairOps, xhairOps, BLT_OP_ARG2, objc, objv, 0);
  if (proc == NULL)
    return TCL_ERROR;

  return (*proc)(graphPtr, interp, objc, objv);
}

// Support

static void TurnOffHairs(Tk_Window tkwin, Crosshairs *chPtr)
{
  if (Tk_IsMapped(tkwin) && (chPtr->visible)) {
    XDrawSegments(Tk_Display(tkwin), Tk_WindowId(tkwin), chPtr->gc,
		  chPtr->segArr, 2);
    chPtr->visible = FALSE;
  }
}

static void TurnOnHairs(Graph* graphPtr, Crosshairs *chPtr)
{
  if (Tk_IsMapped(graphPtr->tkwin) && (!chPtr->visible)) {
    if (!PointInGraph(graphPtr, chPtr->hotSpot.x, chPtr->hotSpot.y)) {
      return;		/* Coordinates are off the graph */
    }
    XDrawSegments(graphPtr->display, Tk_WindowId(graphPtr->tkwin),
		  chPtr->gc, chPtr->segArr, 2);
    chPtr->visible = TRUE;
  }
}

void Blt_EnableCrosshairs(Graph* graphPtr)
{
  if (!graphPtr->crosshairs->hide)
    TurnOnHairs(graphPtr, graphPtr->crosshairs);
}

void Blt_DisableCrosshairs(Graph* graphPtr)
{
  if (!graphPtr->crosshairs->hide)
    TurnOffHairs(graphPtr->tkwin, graphPtr->crosshairs);
}