summaryrefslogtreecommitdiff
path: root/desktop/imagemap.c
blob: c12dabeef8e36ec1a804d465c713c203ce813b34 (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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
/*
 * This file is part of NetSurf, http://netsurf.sourceforge.net/
 * Licensed under the GNU General Public License,
 *                http://www.opensource.org/licenses/gpl-license
 * Copyright 2004 John M Bell <jmb202@ecs.soton.ac.uk>
 *
 * Much of this shamelessly copied from utils/messages.c
 */

#include <assert.h>
#include <stdbool.h>
#include <string.h>
#include "netsurf/content/content.h"
#include "netsurf/desktop/imagemap.h"
#include "netsurf/utils/log.h"
#include "netsurf/utils/utils.h"

#define HASH_SIZE 31 /* fixed size hash table */

typedef enum {IMAGEMAP_DEFAULT, IMAGEMAP_RECT, IMAGEMAP_CIRCLE, IMAGEMAP_POLY } imagemap_entry_type;

struct mapentry {
	imagemap_entry_type type;	/**< type of shape */
	char *url;			/**< url to go to */
	union {
		struct {
			int x;		/**< x coordinate of centre */
			int y;		/**< y coordinate of center */
			int r;		/**< radius of circle */
		} circle;
		struct {
			int x0;		/**< left hand edge */
			int y0;		/**< top edge */
			int x1;		/**< right hand edge */
			int y1;		/**< bottom edge */
		} rect;
		struct {
			int num;	/**< number of points */
			float *xcoords;	/**< x coordinates */
			float *ycoords;	/**< y coordinates */
		} poly;
	} bounds;
	struct mapentry *next;		/**< next entry in list */
};

struct imagemap {
	char *key;		/**< key for this entry */
	struct mapentry *list;	/**< pointer to linked list of entries */
	struct imagemap *next;	/**< next entry in this hash chain */
};

static void imagemap_add(struct content *c, const char *key,
			 struct mapentry *list);
static void imagemap_create(struct content *c);
static struct mapentry *imagemap_extract_map(xmlNode *node, struct content *c,
				 struct mapentry *entry);
static struct mapentry *imagemap_addtolist(xmlNode *n, struct mapentry *entry);
static void imagemap_freelist(struct mapentry *list);
static unsigned int imagemap_hash(const char *key);
static int imagemap_point_in_poly(int num, float *xpt, float *ypt, unsigned long x, unsigned long y, unsigned long click_x, unsigned long click_y);

/**
 * Add an imagemap to the hashtable, creating it if it doesn't exist
 *
 * @param c The containing content
 * @param key The name of the imagemap
 * @param list List of map regions
 */
void imagemap_add(struct content *c, const char *key, struct mapentry *list) {

	struct imagemap *map;
	unsigned int slot;

	assert(c->type == CONTENT_HTML);

	imagemap_create(c);

	map = xcalloc(1, sizeof(*map));
	map->key = xstrdup(key);
	map->list = list;
	slot = imagemap_hash(key);
	map->next = c->data.html.imagemaps[slot];
	c->data.html.imagemaps[slot] = map;
}

/**
 * Create hashtable of imagemaps
 *
 * @param c The containing content
 */
void imagemap_create(struct content *c) {

	assert(c->type == CONTENT_HTML);

	if (c->data.html.imagemaps == 0) {
		c->data.html.imagemaps = xcalloc(HASH_SIZE,
						 sizeof(struct imagemap));
	}
}

/**
 * Destroy hashtable of imagemaps
 *
 * @param c The containing content
 */
void imagemap_destroy(struct content *c) {

	unsigned int i;

	assert(c->type == CONTENT_HTML);

	/* no imagemaps -> return */
	if (c->data.html.imagemaps == 0) return;

	for (i = 0; i != HASH_SIZE; i++) {
		struct imagemap *map, *next;
		map = c->data.html.imagemaps[i];
		while (map != 0) {
		       next = map->next;
		       imagemap_freelist(map->list);
		       xfree(map->key);
		       xfree(map);
		       map = next;
		}
	}

	xfree(c->data.html.imagemaps);
}

/**
 * Dump imagemap data to the log
 *
 * @param c The containing content
 */
void imagemap_dump(struct content *c) {

	unsigned int i;

	int j;

	assert(c->type == CONTENT_HTML);

	if (c->data.html.imagemaps == 0) return;

	for (i = 0; i != HASH_SIZE; i++) {
		struct imagemap *map;
		struct mapentry *entry;
		map = c->data.html.imagemaps[i];
		while (map != 0) {
		       LOG(("Imagemap: %s", map->key));
		       for (entry = map->list; entry; entry = entry->next) {
			       switch (entry->type) {
				 case IMAGEMAP_DEFAULT:
					 LOG(("\tDefault: %s", entry->url));
					 break;
				 case IMAGEMAP_RECT:
					 LOG(("\tRectangle: %s: [(%d,%d),(%d,%d)]",
					       entry->url,
					       entry->bounds.rect.x0,
					       entry->bounds.rect.y0,
					       entry->bounds.rect.x1,
					       entry->bounds.rect.y1));
					 break;
				 case IMAGEMAP_CIRCLE:
					 LOG(("\tCircle: %s: [(%d,%d),%d]",
					       entry->url,
					       entry->bounds.circle.x,
					       entry->bounds.circle.y,
					       entry->bounds.circle.r));
					 break;
				 case IMAGEMAP_POLY:
					 LOG(("\tPolygon: %s:",
					       entry->url));
					 for (j=0;
					      j!=entry->bounds.poly.num;
					      j++) {
					   fprintf(stderr, "(%d,%d) ",
					   (int)entry->bounds.poly.xcoords[j],
					   (int)entry->bounds.poly.ycoords[j]);
					 }
					 fprintf(stderr,"\n");
					 break;
			       }
		       }
		       map = map->next;
		}
	}
}

/**
 * Extract all imagemaps from a document tree
 *
 * @param node Root node of tree
 * @param c The containing content
 */
void imagemap_extract(xmlNode *node, struct content *c) {

	xmlNode *this_node;
	struct mapentry *entry = 0;
	char *name;

	if (node->type == XML_ELEMENT_NODE) {
		if (strcmp(node->name, "map") == 0) {
			if (!(name = (char*)xmlGetProp(node,
						    (const xmlChar*)"name")))
				return;
			entry = imagemap_extract_map(node, c, entry);
			imagemap_add(c, name, entry);
			xmlFree(name);
			return;
		}
	}
	else return;

	/* now recurse */
	for (this_node = node->children; this_node != 0; this_node = this_node->next) {
		imagemap_extract(this_node, c);
	}
}

struct mapentry *imagemap_extract_map(xmlNode *node, struct content *c, struct mapentry *entry) {

	xmlNode *this_node;

	if (node->type == XML_ELEMENT_NODE) {
		/** \todo ignore <area> elements if there are other
		 *	block-level elements present in map
		 */
		if (strcmp(node->name, "area") == 0 ||
		    strcmp(node->name, "a") == 0) {
			entry = imagemap_addtolist(node, entry);
			return entry;
		}
	}
	else return entry;

	for (this_node = node->children; this_node != 0; this_node = this_node->next) {
		entry = imagemap_extract_map(this_node, c, entry);
	}

	return entry;
}

struct mapentry *imagemap_addtolist(xmlNode *n, struct mapentry *entry) {

	char *shape, *coords = 0, *href, *val;
	int num;
	struct mapentry *new_map, *temp;

	if (strcmp(n->name, "area") == 0) {
		/* nohref attribute present - ignore this entry */
		if (xmlGetProp(n, (const xmlChar*)"nohref") != 0) {
			return entry;
		}
	}
	/* no href -> ignore */
	if (!(href = (char*)xmlGetProp(n, (const xmlChar*)"href"))) {
		return entry;
	}
	/* no shape -> shape is a rectangle */
	if (!(shape = (char*)xmlGetProp(n, (const xmlChar*)"shape"))) {
		shape = (char*)xmlMemStrdup("rect");
	}
	if (strcasecmp(shape, "default") != 0) {
		/* no coords -> ignore */
		if (!(coords = (char*)xmlGetProp(n, (const xmlChar*)"coords"))) {
			xmlFree(href);
			xmlFree(shape);
			return entry;
		}
	}

	new_map = xcalloc(1, sizeof(*new_map));

	/* extract area shape */
	if (strcasecmp(shape, "rect") == 0) {
		new_map->type = IMAGEMAP_RECT;
	}
	else if (strcasecmp(shape, "circle") == 0) {
		new_map->type = IMAGEMAP_CIRCLE;
	}
	else if (strcasecmp(shape, "poly") == 0) {
		new_map->type = IMAGEMAP_POLY;
	}
	else if (strcasecmp(shape, "default") == 0) {
		new_map->type = IMAGEMAP_DEFAULT;
	}
	else { /* unknown shape -> bail */
		xfree(new_map);
		xmlFree(href);
		xmlFree(shape);
		xmlFree(coords);
		return entry;
	}

	new_map->url = xstrdup(href);

	if (new_map->type != IMAGEMAP_DEFAULT) {

		/* coordinates are a comma-separated list of values */
		val = strtok(coords, ",");
		num = 1;

		switch (new_map->type) {
			case IMAGEMAP_RECT:
				/* (left, top, right, bottom) */
				while (val && num <= 4) {
					switch (num) {
						case 1:
						    new_map->bounds.rect.x0 = atoi(val);
						    break;
						case 2:
						    new_map->bounds.rect.y0 = atoi(val);
						    break;
						case 3:
						    new_map->bounds.rect.x1 = atoi(val);
						    break;
						case 4:
						    new_map->bounds.rect.y1 = atoi(val);
						    break;
					}
					num++;
					val = strtok('\0', ",");
				}
				break;
			case IMAGEMAP_CIRCLE:
				/* (x, y, radius ) */
				while (val && num <= 3) {
					switch (num) {
						case 1:
						    new_map->bounds.circle.x = atoi(val);
						    break;
						case 2:									  new_map->bounds.circle.y = atoi(val);
						    break;
						case 3:
						    new_map->bounds.circle.r = atoi(val);
						    break;
					}
					num++;
					val = strtok('\0', ",");
				}
				break;
			case IMAGEMAP_POLY:
				new_map->bounds.poly.xcoords =
						 xcalloc(0, sizeof(*new_map->bounds.poly.xcoords));
				new_map->bounds.poly.ycoords =
						 xcalloc(0, sizeof(*new_map->bounds.poly.ycoords));
				int x, y;
				while (val) {
					x = atoi(val);
					val = strtok('\0', ",");
					if (!val) break;
					y = atoi(val);

					new_map->bounds.poly.xcoords =
						xrealloc(new_map->bounds.poly.xcoords,
							 num*sizeof(*new_map->bounds.poly.xcoords));
					new_map->bounds.poly.ycoords =
						xrealloc(new_map->bounds.poly.ycoords,
							 num*sizeof(*new_map->bounds.poly.ycoords));
					new_map->bounds.poly.xcoords[num-1] = x;
					new_map->bounds.poly.ycoords[num-1] = y;

					num++;
					val = strtok('\0', ",");
				}

				new_map->bounds.poly.num = num-1;

				break;
			default:
				break;
		}
	}

	new_map->next = 0;
	if (entry) {
		/* add to END of list */
		for (temp = entry; temp->next != 0; temp = temp->next)
			;
		temp->next = new_map;
	}
	else {
		entry = new_map;
	}

	xmlFree(href);
	xmlFree(shape);
	xmlFree(coords);

	return entry;
}

/**
 * Free list of imagemap entries
 *
 * @param list Pointer to head of list
 */
void imagemap_freelist(struct mapentry *list) {

	struct mapentry *entry, *prev;

	entry = list;

	while (entry != 0) {
		prev = entry;
		xfree(entry->url);
		if (entry->type == IMAGEMAP_POLY) {
			xfree(entry->bounds.poly.xcoords);
			xfree(entry->bounds.poly.ycoords);
		}
		entry = entry->next;
		xfree(prev);
	}
}

/**
 * Retrieve url associated with imagemap entry
 *
 * @param c The containing content
 * @param key The map name to search for
 * @param x The left edge of the containing box
 * @param y The top edge of the containing box
 * @param click_x The horizontal location of the click
 * @param click_y The vertical location of the click
 * @return The url associated with this area, or NULL if not found
 */
char *imagemap_get(struct content *c, const char *key, unsigned long x,
	 unsigned long y, unsigned long click_x, unsigned long click_y) {

	unsigned int slot = 0;
	struct imagemap *map;
	struct mapentry *entry;
	unsigned long cx, cy;

	assert(c->type == CONTENT_HTML);
	if (key == NULL) return NULL;

	slot = imagemap_hash(key);

	for (map = c->data.html.imagemaps[slot];
	     map != 0; map = map->next) {
		if (map->key != 0 && strcasecmp(map->key, key) == 0)
			break;
	}

	if (map == 0) return NULL;

	for (entry = map->list; entry; entry = entry->next) {
		switch (entry->type) {
			case IMAGEMAP_DEFAULT:
				/* just return the URL. no checks required */
				return entry->url;
				break;
			case IMAGEMAP_RECT:
				if (click_x >= x + entry->bounds.rect.x0 &&
				    click_x <= x + entry->bounds.rect.x1 &&
				    click_y >= y + entry->bounds.rect.y0 &&
				    click_y <= y + entry->bounds.rect.y1) {
					return entry->url;
				}
				break;
			case IMAGEMAP_CIRCLE:
				cx = x + entry->bounds.circle.x - click_x;
				cy = y + entry->bounds.circle.y - click_y;
				if ((cx*cx + cy*cy) <=
				    (unsigned long)(entry->bounds.circle.r*
				     entry->bounds.circle.r)) {
					return entry->url;
				}
				break;
			case IMAGEMAP_POLY:
				if (imagemap_point_in_poly(entry->bounds.poly.num, entry->bounds.poly.xcoords, entry->bounds.poly.ycoords, x, y, click_x, click_y)) {
					return entry->url;
				}
				break;
		}
	}

	return NULL;
}

/**
 * Hash function
 *
 * @param key The key to hash
 * @return The hashed value
 */
unsigned int imagemap_hash(const char *key) {

	unsigned int z = 0;

	if (key == 0) return 0;

	for (; *key != 0; key++) {
		z += *key & 0x1f;
	}

	return (z % (HASH_SIZE - 1)) + 1;
}

/**
 * Test if a point lies within an arbitrary polygon
 * Modified from comp.graphics.algorithms FAQ 2.03
 *
 * @param num Number of vertices
 * @param xpt Array of x coordinates
 * @param ypt Array of y coordinates
 * @param x Left hand edge of containing box
 * @param y Top edge of containing box
 * @param click_x X coordinate of click
 * @param click_y Y coordinate of click
 * @return 1 if point is in polygon, 0 if outside. 0 or 1 if on boundary
 */
int imagemap_point_in_poly(int num, float *xpt, float *ypt, unsigned long x, unsigned long y, unsigned long click_x, unsigned long click_y) {

	int i, j, c=0;

	for (i = 0, j = num-1; i < num; j = i++) {
		if ((((ypt[i]+y <= click_y) && (click_y < ypt[j]+y)) ||
		     ((ypt[j]+y <= click_y) && (click_y < ypt[i]+y))) &&
		     (click_x < (xpt[j] - xpt[i]) *
		     (click_y - (ypt[i]+y)) / (ypt[j] - ypt[i]) + xpt[i]+x))
			c = !c;
	}

	return c;
}