summaryrefslogtreecommitdiff
path: root/src/webidl-ast.c
blob: a1133e3c52d9d2923f0a8551f71f2333de77f70b (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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
/* AST generator for the WEB IDL parser
 *
 * This file is part of nsgenbind.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2012 Vincent Sanders <vince@netsurf-browser.org>
 */

#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <stdarg.h>

#include "utils.h"
#include "webidl-ast.h"
#include "options.h"

/**
 * standard IO handle for parse trace logging.
 */
static FILE *webidl_parsetracef;

extern int webidl_debug;
extern int webidl__flex_debug;
extern void webidl_restart(FILE*);
extern int webidl_parse(struct webidl_node **webidl_ast);

struct webidl_node {
	enum webidl_node_type type; /* the type of the node */
	struct webidl_node *l; /* link to the next sibling node */
	union {
		void *value;
		struct webidl_node *node; /* node has a list of nodes */
		char *text; /* node data is text */
                float *flt;
		int number; /* node data is an integer */
	} r;
};

/* insert node(s) at beginning of a list */
struct webidl_node *
webidl_node_prepend(struct webidl_node *list, struct webidl_node *inst)
{
	struct webidl_node *end = inst;

	if (inst == NULL) {
		return list; /* no node to prepend - return existing list */
	}

	/* find end of inserted node list */
	while (end->l != NULL) {
		end = end->l;
	}

	end->l = list;

	return inst;
}

/* append node at end of a list */
struct webidl_node *
webidl_node_append(struct webidl_node *list, struct webidl_node *node)
{
	struct webidl_node *cur = list;

	if (cur == NULL) {
		return node; /* no existing list so just return node */
	}

	while (cur->l != NULL) {
		cur = cur->l;
	}
	cur->l = node;

	return list;
}

/* prepend list to a nodes list
 *
 * inserts a list into the beginning of a nodes r list
 *
 * CAUTION: if the \a node element is not a node type the node will not be added
 */
struct webidl_node *
webidl_node_add(struct webidl_node *node, struct webidl_node *list)
{
	if (node == NULL) {
		return list;
	}

	/* this does not use webidl_node_getnode() as it cannot
	 * determine between an empty node and a node which is not a
	 * list type
	 */
	switch (node->type) {
	case WEBIDL_NODE_TYPE_ROOT:
	case WEBIDL_NODE_TYPE_INTERFACE:
	case WEBIDL_NODE_TYPE_DICTIONARY:
	case WEBIDL_NODE_TYPE_LIST:
	case WEBIDL_NODE_TYPE_EXTENDED_ATTRIBUTE:
	case WEBIDL_NODE_TYPE_ATTRIBUTE:
	case WEBIDL_NODE_TYPE_OPERATION:
	case WEBIDL_NODE_TYPE_OPTIONAL:
	case WEBIDL_NODE_TYPE_ARGUMENT:
	case WEBIDL_NODE_TYPE_TYPE:
	case WEBIDL_NODE_TYPE_CONST:
		break;

	default:
		/* not a node type node */
		return list;
	}

	node->r.node =	webidl_node_prepend(node->r.node, list);

	return node;
}


struct webidl_node *
/* exported interface documented in webidl-ast.h */
webidl_node_new(enum webidl_node_type type,
		struct webidl_node *l,
		void *r)
{
	struct webidl_node *nn;
	nn = calloc(1, sizeof(struct webidl_node));
	nn->type = type;
	nn->l = l;
	nn->r.value = r;
	return nn;
}

/* exported interface documented in webidl-ast.h */
struct webidl_node *
webidl_new_number_node(enum webidl_node_type type,
                       struct webidl_node *l,
                       int number)
{
	struct webidl_node *nn;
	nn = calloc(1, sizeof(struct webidl_node));
	nn->type = type;
	nn->l = l;
	nn->r.number = number;
	return nn;
}

void
webidl_node_set(struct webidl_node *node, enum webidl_node_type type, void *r)
{
	node->type = type;
	node->r.value = r;
}

int
webidl_node_for_each_type(struct webidl_node *node,
			   enum webidl_node_type type,
			   webidl_callback_t *cb,
			   void *ctx)
{
	int ret;

	if (node == NULL) {
		return -1;
	}
	if (node->l != NULL) {
		ret = webidl_node_for_each_type(node->l, type, cb, ctx);
		if (ret != 0) {
			return ret;
		}
	}
	if (node->type == type) {
		return cb(node, ctx);
	}

	return 0;
}

/* exported interface defined in webidl-ast.h */
int webidl_cmp_node_type(struct webidl_node *node, void *ctx)
{
	if (node->type == (enum webidl_node_type)ctx)
		return 1;
	return 0;
}

static int webidl_enumerate_node(struct webidl_node *node, void *ctx)
{
	UNUSED(node);
	(*((int *)ctx))++;
	return 0;
}

/* exported interface defined in nsgenbind-ast.h */
int
webidl_node_enumerate_type(struct webidl_node *node,
			    enum webidl_node_type type)
{
	int count = 0;
	webidl_node_for_each_type(node,
				  type,
				  webidl_enumerate_node,
				  &count);
	return count;
}

/* exported interface defined in webidl-ast.h */
struct webidl_node *
webidl_node_find(struct webidl_node *node,
		  struct webidl_node *prev,
		  webidl_callback_t *cb,
		  void *ctx)
{
	struct webidl_node *ret;

	if ((node == NULL) || (node == prev)) {
		return NULL;
	}

	if (node->l != prev) {
		ret = webidl_node_find(node->l, prev, cb, ctx);
		if (ret != NULL) {
			return ret;
		}
	}

	if (cb(node, ctx) != 0) {
		return node;
	}

	return NULL;
}


/* exported interface defined in webidl-ast.h */
struct webidl_node *
webidl_node_find_type(struct webidl_node *node,
		  struct webidl_node *prev,
		  enum webidl_node_type type)
{
	return webidl_node_find(node,
				prev,
				webidl_cmp_node_type,
				(void *)type);
}


/* exported interface defined in webidl-ast.h */
struct webidl_node *
webidl_node_find_type_ident(struct webidl_node *root_node,
			    enum webidl_node_type type,
			    const char *ident)
{
	struct webidl_node *node;
	struct webidl_node *ident_node;

	node = webidl_node_find_type(root_node,	NULL, type);

	while (node != NULL) {

		ident_node = webidl_node_find_type(webidl_node_getnode(node),
					      NULL,
					      WEBIDL_NODE_TYPE_IDENT);
		if (ident_node != NULL) {
			if (strcmp(ident_node->r.text, ident) == 0)
				break;
		}

		node = webidl_node_find_type(root_node,	node, type);

	}
	return node;
}


/* exported interface defined in webidl-ast.h */
char *webidl_node_gettext(struct webidl_node *node)
{
	if (node != NULL) {

		switch(node->type) {
		case WEBIDL_NODE_TYPE_IDENT:
		case WEBIDL_NODE_TYPE_INHERITANCE:
		case WEBIDL_NODE_TYPE_INTERFACE_IMPLEMENTS:
                case WEBIDL_NODE_TYPE_LITERAL_STRING:
			return node->r.text;

		default:
			break;
		}
	}
	return NULL;
}

/* exported interface defined in webidl-ast.h */
int *
webidl_node_getint(struct webidl_node *node)
{
	if (node != NULL) {
		switch(node->type) {
		case WEBIDL_NODE_TYPE_MODIFIER:
		case WEBIDL_NODE_TYPE_TYPE_BASE:
		case WEBIDL_NODE_TYPE_LITERAL_INT:
                case WEBIDL_NODE_TYPE_SPECIAL:
                case WEBIDL_NODE_TYPE_LITERAL_BOOL:
			return &node->r.number;

		default:
			break;
		}
	}
	return NULL;
}

/* exported interface defined in webidl-ast.h */
float *
webidl_node_getfloat(struct webidl_node *node)
{
	if (node != NULL) {
		switch(node->type) {
                case WEBIDL_NODE_TYPE_LITERAL_FLOAT:
			return node->r.flt;

		default:
			break;
		}
	}
	return NULL;
}

/* exported interface defined in webidl-ast.h */
enum webidl_node_type webidl_node_gettype(struct webidl_node *node)
{
	return node->type;
}


/* exported interface defined in webidl-ast.h */
struct webidl_node *webidl_node_getnode(struct webidl_node *node)
{
	if (node != NULL) {
		switch (node->type) {
		case WEBIDL_NODE_TYPE_ROOT:
		case WEBIDL_NODE_TYPE_INTERFACE:
		case WEBIDL_NODE_TYPE_DICTIONARY:
		case WEBIDL_NODE_TYPE_LIST:
		case WEBIDL_NODE_TYPE_EXTENDED_ATTRIBUTE:
		case WEBIDL_NODE_TYPE_ATTRIBUTE:
		case WEBIDL_NODE_TYPE_OPERATION:
		case WEBIDL_NODE_TYPE_OPTIONAL:
		case WEBIDL_NODE_TYPE_ARGUMENT:
		case WEBIDL_NODE_TYPE_TYPE:
		case WEBIDL_NODE_TYPE_CONST:
			return node->r.node;
		default:
			break;
		}
	}
	return NULL;

}

/* exported interface defined in webidl-ast.h */
static const char *webidl_node_type_to_str(enum webidl_node_type type)
{
	switch(type) {
	case WEBIDL_NODE_TYPE_ROOT:
		return "root";

	case WEBIDL_NODE_TYPE_IDENT:
		return "Ident";

	case WEBIDL_NODE_TYPE_INHERITANCE:
		return "Inherit";

	case WEBIDL_NODE_TYPE_INTERFACE_IMPLEMENTS:
		return "Implements";

	case WEBIDL_NODE_TYPE_INTERFACE:
		return "Interface";

	case WEBIDL_NODE_TYPE_DICTIONARY:
		return "Dictionary";

	case WEBIDL_NODE_TYPE_LIST:
		return "List";

	case WEBIDL_NODE_TYPE_ATTRIBUTE:
		return "Attribute";

	case WEBIDL_NODE_TYPE_OPERATION:
		return "Operation";

	case WEBIDL_NODE_TYPE_OPTIONAL:
		return "Optional";

	case WEBIDL_NODE_TYPE_ARGUMENT:
		return "Argument";

	case WEBIDL_NODE_TYPE_ELLIPSIS:
		return "Ellipsis";

	case WEBIDL_NODE_TYPE_TYPE:
		return "Type";

	case WEBIDL_NODE_TYPE_TYPE_BASE:
		return "Base";

	case WEBIDL_NODE_TYPE_TYPE_NULLABLE:
		return "Nullable";

	case WEBIDL_NODE_TYPE_TYPE_ARRAY:
		return "Array";

	case WEBIDL_NODE_TYPE_MODIFIER:
		return "Modifier";

	case WEBIDL_NODE_TYPE_CONST:
		return "Const";

	case WEBIDL_NODE_TYPE_LITERAL_NULL:
		return "Literal (null)";

	case WEBIDL_NODE_TYPE_LITERAL_INT:
		return "Literal (int)";

	case WEBIDL_NODE_TYPE_LITERAL_BOOL:
		return "Literal (bool)";

	case WEBIDL_NODE_TYPE_LITERAL_FLOAT:
		return "Literal (float)";

	case WEBIDL_NODE_TYPE_LITERAL_STRING:
		return "Literal (string)";

	case WEBIDL_NODE_TYPE_EXTENDED_ATTRIBUTE:
		return "Extended Attribute";

	case WEBIDL_NODE_TYPE_SPECIAL:
		return "Special";

	default:
		return "Unknown";
	}

}

/**
 * Recursively dump the AST nodes increasing indent as appropriate
 */
static int webidl_ast_dump(FILE *dumpf, struct webidl_node *node, int indent)
{
	const char *SPACES="                                                                               ";
	char *txt;
        int *value;
	while (node != NULL) {
                fprintf(dumpf, "%.*s%s", indent, SPACES,
                        webidl_node_type_to_str(node->type));

		txt = webidl_node_gettext(node);
		if (txt == NULL) {
			struct webidl_node *next;

			next = webidl_node_getnode(node);

			if (next != NULL) {
				fprintf(dumpf, "\n");
				webidl_ast_dump(dumpf, next, indent + 2);
			} else {
				/* not txt or node try an int */
                                value = webidl_node_getint(node);
                                if (value != NULL) {
                                        fprintf(dumpf, ": %d\n", *value);
                                } else {
                                        /* no value */
                                        fprintf(dumpf, "\n");
                                }
			}
		} else {
			fprintf(dumpf, ": \"%s\"\n", txt);
		}
		node = node->l;
	}
	return 0;
}

/* exported interface documented in webidl-ast.h */
int webidl_dump_ast(struct webidl_node *node)
{
        FILE *dumpf;

        /* only dump AST to file if required */
        if (!options->debug) {
                return 0;
        }

        dumpf = genb_fopen("webidl-ast", "w");
        if (dumpf == NULL) {
                return 2;
        }

        webidl_ast_dump(dumpf, node, 0);

        fclose(dumpf);

        return 0;
}

/* exported interface defined in webidl-ast.h */
static FILE *idlopen(const char *filename)
{
	FILE *idlfile;
	char *fullname;
	int fulllen;

	if (options->idlpath == NULL) {
		if (options->verbose) {
			printf("Opening IDL file %s\n", filename);
		}
		return fopen(filename, "r");
	}

	fulllen = strlen(options->idlpath) + strlen(filename) + 2;
	fullname = malloc(fulllen);
	snprintf(fullname, fulllen, "%s/%s", options->idlpath, filename);
	if (options->verbose) {
		printf("Opening IDL file %s\n", fullname);
	}
	idlfile = fopen(fullname, "r");
	free(fullname);

	return idlfile;
}

/* exported interface defined in webidl-ast.h */
int webidl_parsefile(char *filename, struct webidl_node **webidl_ast)
{
	FILE *idlfile;
        int ret;

	idlfile = idlopen(filename);
	if (!idlfile) {
		fprintf(stderr, "Error opening %s: %s\n",
			filename,
			strerror(errno));
		return 2;
	}

        /* if debugging enabled enable parser tracing and send to file */
        if (options->debug) {
                char *tracename;
                int tracenamelen;
		webidl_debug = 1;
		webidl__flex_debug = 1;

                tracenamelen = SLEN("webidl--trace") + strlen(filename) + 1;
                tracename = malloc(tracenamelen);
                snprintf(tracename, tracenamelen,"webidl-%s-trace", filename);
                webidl_parsetracef = genb_fopen(tracename, "w");
                free(tracename);
        } else {
                webidl_parsetracef = NULL;
        }

	/* set flex to read from file */
	webidl_restart(idlfile);

	/* parse the file */
	ret = webidl_parse(webidl_ast);

        /* close tracefile if open */
        if (webidl_parsetracef != NULL) {
                fclose(webidl_parsetracef);
        }
        return ret;
}

/* exported interface defined in webidl-ast.h */
int webidl_fprintf(FILE *stream, const char *format, ...)
{
        va_list ap;
        int ret;

        va_start(ap, format);

        if (webidl_parsetracef == NULL) {
                ret = vfprintf(stream, format, ap);
        } else {
                ret = vfprintf(webidl_parsetracef, format, ap);
        }
        va_end(ap);

        return ret;
}

/* unlink a child node from a parent */
static int
webidl_unlink(struct webidl_node *parent, struct webidl_node *node)
{
	struct webidl_node *child;

	child = webidl_node_getnode(parent);
	if (child == NULL) {
		/* parent does not have children to remove node from */
		return -1;
	}

	if (child == node) {
		/* parent is pointing at the node we want to remove */
		parent->r.node = node->l; /* point parent at next sibing */
		node->l = NULL;
		return 0;
	}

	while (child->l != NULL) {
		if (child->l == node) {
			/* found node, unlink from list */
			child->l = node->l;
			node->l = NULL;
			return 0;
		}
		child = child->l;
	}
	return -1; /* failed to remove node */
}

static int implements_copy_nodes(struct webidl_node *src_node,
				 struct webidl_node *dst_node)
{
	struct webidl_node *src;
	struct webidl_node *dst;

	src = webidl_node_getnode(src_node);
	dst = webidl_node_getnode(dst_node);

	while (src != NULL) {
		if (src->type == WEBIDL_NODE_TYPE_LIST) {
			/** @todo technicaly this should copy WEBIDL_NODE_TYPE_INHERITANCE */
			dst = webidl_node_new(src->type, dst, src->r.text);
		}
		src = src->l;
	}

	dst_node->r.node = dst;

	return 0;
}

static int
intercalate_implements(struct webidl_node *interface_node, void *ctx)
{
	struct webidl_node *implements_node;
	struct webidl_node *implements_interface_node;
	struct webidl_node *webidl_ast = ctx;

	implements_node = webidl_node_find_type(
		webidl_node_getnode(interface_node),
		NULL,
		WEBIDL_NODE_TYPE_INTERFACE_IMPLEMENTS);
	while (implements_node != NULL) {

		implements_interface_node = webidl_node_find_type_ident(
			webidl_ast,
			WEBIDL_NODE_TYPE_INTERFACE,
			webidl_node_gettext(implements_node));

		/* recurse, ensuring all subordinate interfaces have
		 * their implements intercalated first
		 */
		intercalate_implements(implements_interface_node, webidl_ast);

		implements_copy_nodes(implements_interface_node, interface_node);

		/* once we have copied the implemntation remove entry */
		webidl_unlink(interface_node, implements_node);

		implements_node = webidl_node_find_type(
			webidl_node_getnode(interface_node),
			implements_node,
			WEBIDL_NODE_TYPE_INTERFACE_IMPLEMENTS);
	}
	return 0;
}

/* exported interface defined in webidl-ast.h */
int webidl_intercalate_implements(struct webidl_node *webidl_ast)
{
        int res = 0;
        if (webidl_ast != NULL) {
                /* for each interface:
                 *   for each implements entry:
                 *     find interface from implemets
                 *     recusrse into that interface
                 *     copy the interface into this one
                 */
                res = webidl_node_for_each_type(webidl_ast,
                                                WEBIDL_NODE_TYPE_INTERFACE,
                                                intercalate_implements,
                                                webidl_ast);
        }
        return res;
}

/* exported interface defined in webidl-ast.h */
const char *webidl_type_to_str(enum webidl_type_modifier m, enum webidl_type t)
{
        switch (t) {
        case WEBIDL_TYPE_ANY: /**< 0 - The type is unconstrained */
                return "any";

        case WEBIDL_TYPE_USER: /**< 1 - The type is a dictionary or interface */
                return "user";

        case WEBIDL_TYPE_BOOL: /**< 2 - The type is boolean */
                return "boolean";

        case WEBIDL_TYPE_BYTE: /**< 3 - The type is a byte */
                return "byte";

        case WEBIDL_TYPE_OCTET: /**< 4 - The type is a octet */
                return "octet";

        case WEBIDL_TYPE_FLOAT: /**< 5 - The type is a float point number */
                return "float";

        case WEBIDL_TYPE_DOUBLE: /**< 6 - The type is a double */
                return "double";

        case WEBIDL_TYPE_SHORT: /**< 7 - The type is a signed 16bit */
                if (m == WEBIDL_TYPE_MODIFIER_UNSIGNED) {
                        return "unsigned short";
                } else {
                        return "short";
                }

        case WEBIDL_TYPE_LONG: /**< 8 - The type is a signed 32bit */
                if (m == WEBIDL_TYPE_MODIFIER_UNSIGNED) {
                        return "unsigned long";
                } else {
                        return "long";
                }

        case WEBIDL_TYPE_LONGLONG: /**< 9 - The type is a signed 64bit */
                return "long long";

        case WEBIDL_TYPE_STRING: /**< 10 - The type is a string */
                return "string";

        case WEBIDL_TYPE_SEQUENCE: /**< 11 - The type is a sequence */
                return "sequence";

        case WEBIDL_TYPE_OBJECT: /**< 12 - The type is a object */
                return "object";

        case WEBIDL_TYPE_DATE: /**< 13 - The type is a date */
                return "date";

        case WEBIDL_TYPE_VOID: /**< 14 - The type is void */
                return "void";
        }
        return "Unknown";
}