Introduce macro to enforce matching enum to string for node types
[babeltrace.git] / formats / ctf / metadata / ctf-ast.h
index 74e1ecb4b2fd37a97fcb47f12e1f153b9e11f76f..3fb38b2d6295c4eca0f0500374c68e7f17bd307d 100644 (file)
@@ -1,10 +1,26 @@
-#ifndef _CTF_PARSER_H
-#define _CTF_PARSER_H
+#ifndef _CTF_AST_H
+#define _CTF_AST_H
+
+/*
+ * ctf-ast.h
+ *
+ * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * 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.
+ */
 
 #include <stdint.h>
-#include <helpers/list.h>
 #include <stdio.h>
 #include <glib.h>
+#include <babeltrace/list.h>
 
 // the parameter name (of the reentrant 'yyparse' function)
 // data is a pointer to a 'SParserParam' structure
 struct ctf_node;
 struct ctf_parser;
 
-enum node_type {
-       NODE_UNKNOWN = 0,
-       NODE_ROOT,
-
-       NODE_EVENT,
-       NODE_STREAM,
-       NODE_TRACE,
-
-       NODE_CTF_EXPRESSION,
-
-       NODE_TYPEDEF,
-       NODE_TYPEALIAS_TARGET,
-       NODE_TYPEALIAS_ALIAS,
-       NODE_TYPEALIAS,
-
-       NODE_TYPE_SPECIFIER,
-       NODE_DECLARATION_SPECIFIER,
-       NODE_POINTER,
-       NODE_TYPE_DECLARATOR,
-
-       NODE_FLOATING_POINT,
-       NODE_INTEGER,
-       NODE_STRING,
-       NODE_ENUMERATOR,
-       NODE_ENUM,
-       NODE_STRUCT_OR_VARIANT_DECLARATION,
-       NODE_VARIANT,
-       NODE_STRUCT,
+#define FOREACH_CTF_NODES(F) \
+       F(NODE_UNKNOWN) \
+       F(NODE_ROOT) \
+       F(NODE_EVENT) \
+       F(NODE_STREAM) \
+       F(NODE_ENV) \
+       F(NODE_TRACE) \
+       F(NODE_CLOCK) \
+       F(NODE_CALLSITE) \
+       F(NODE_CTF_EXPRESSION) \
+       F(NODE_UNARY_EXPRESSION) \
+       F(NODE_TYPEDEF) \
+       F(NODE_TYPEALIAS_TARGET) \
+       F(NODE_TYPEALIAS_ALIAS) \
+       F(NODE_TYPEALIAS) \
+       F(NODE_TYPE_SPECIFIER) \
+       F(NODE_TYPE_SPECIFIER_LIST) \
+       F(NODE_POINTER) \
+       F(NODE_TYPE_DECLARATOR) \
+       F(NODE_FLOATING_POINT) \
+       F(NODE_INTEGER) \
+       F(NODE_STRING) \
+       F(NODE_ENUMERATOR) \
+       F(NODE_ENUM) \
+       F(NODE_STRUCT_OR_VARIANT_DECLARATION) \
+       F(NODE_VARIANT) \
+       F(NODE_STRUCT)
 
+enum node_type {
+#define ENTRY(S)       S,
+       FOREACH_CTF_NODES(ENTRY)
+#undef ENTRY
        NR_NODE_TYPES,
 };
 
 struct ctf_node {
+       /*
+        * Parent node is only set on demand by specific visitor.
+        */
        struct ctf_node *parent;
-       struct cds_list_head siblings;
-       struct cds_list_head gc;
+       struct bt_list_head siblings;
+       struct bt_list_head tmp_head;
+       struct bt_list_head gc;
+       unsigned int lineno;
 
        enum node_type type;
        union {
                struct {
                } unknown;
                struct {
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head declaration_specifier;
-                       struct cds_list_head trace;
-                       struct cds_list_head stream;
-                       struct cds_list_head event;
+                       /*
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
+                        */
+                       struct bt_list_head declaration_list;
+                       struct bt_list_head trace;
+                       struct bt_list_head env;
+                       struct bt_list_head stream;
+                       struct bt_list_head event;
+                       struct bt_list_head clock;
+                       struct bt_list_head callsite;
                } root;
                struct {
                        /*
-                        * Children nodes are ctf_expression, typedef or
-                        * typealias.
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
                         */
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head ctf_expression;
-                       struct cds_list_head declaration_specifier;
+                       struct bt_list_head declaration_list;
                } event;
                struct {
                        /*
-                        * Children nodes are ctf_expression, typedef or
-                        * typealias.
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
                         */
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head ctf_expression;
-                       struct cds_list_head declaration_specifier;
+                       struct bt_list_head declaration_list;
                } stream;
                struct {
                        /*
-                        * Children nodes are ctf_expression, typedef or
-                        * typealias.
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
                         */
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head ctf_expression;
-                       struct cds_list_head declaration_specifier;
+                       struct bt_list_head declaration_list;
+               } env;
+               struct {
+                       /*
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
+                        */
+                       struct bt_list_head declaration_list;
                } trace;
                struct {
-                       char *left_id;
+                       /*
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
+                        */
+                       struct bt_list_head declaration_list;
+               } clock;
+               struct {
+                       /*
+                        * Children nodes are ctf_expression, typedef,
+                        * typealias and type_specifier_list.
+                        */
+                       struct bt_list_head declaration_list;
+               } callsite;
+               struct {
+                       struct bt_list_head left;       /* Should be string */
+                       struct bt_list_head right;      /* Unary exp. or type */
+               } ctf_expression;
+               struct {
                        enum {
-                               EXP_UNKNOWN = 0,
-                               EXP_ID,
-                               EXP_TYPE,
+                               UNARY_UNKNOWN = 0,
+                               UNARY_STRING,
+                               UNARY_SIGNED_CONSTANT,
+                               UNARY_UNSIGNED_CONSTANT,
+                               UNARY_SBRAC,
+                               UNARY_NESTED,
                        } type;
                        union {
-                               char *id;
-                               struct ctf_node *type;
-                       } right;
-               } ctf_expression;
+                               /*
+                                * string for identifier, id_type, keywords,
+                                * string literals and character constants.
+                                */
+                               char *string;
+                               int64_t signed_constant;
+                               uint64_t unsigned_constant;
+                               struct ctf_node *sbrac_exp;
+                               struct ctf_node *nested_exp;
+                       } u;
+                       enum {
+                               UNARY_LINK_UNKNOWN = 0,
+                               UNARY_DOTLINK,
+                               UNARY_ARROWLINK,
+                               UNARY_DOTDOTDOT,
+                       } link;
+               } unary_expression;
                struct {
-                       struct ctf_node *declaration_specifier;
-                       struct cds_list_head type_declarators;
+                       struct ctf_node *type_specifier_list;
+                       struct bt_list_head type_declarators;
                } _typedef;
                /* new type is "alias", existing type "target" */
                struct {
-                       struct ctf_node *declaration_specifier;
-                       struct cds_list_head type_declarators;
+                       struct ctf_node *type_specifier_list;
+                       struct bt_list_head type_declarators;
                } typealias_target;
                struct {
-                       struct ctf_node *declaration_specifier;
-                       struct cds_list_head type_declarators;
+                       struct ctf_node *type_specifier_list;
+                       struct bt_list_head type_declarators;
                } typealias_alias;
                struct {
                        struct ctf_node *target;
@@ -138,33 +198,29 @@ struct ctf_node {
                                TYPESPEC_UNSIGNED,
                                TYPESPEC_BOOL,
                                TYPESPEC_COMPLEX,
+                               TYPESPEC_IMAGINARY,
+                               TYPESPEC_CONST,
                                TYPESPEC_ID_TYPE,
-
                                TYPESPEC_FLOATING_POINT,
                                TYPESPEC_INTEGER,
                                TYPESPEC_STRING,
-                               TYPESPEC_ENUM,
-                               TYPESPEC_VARIANT,
                                TYPESPEC_STRUCT,
+                               TYPESPEC_VARIANT,
+                               TYPESPEC_ENUM,
                        } type;
-                       union {
-                               struct ctf_node *floating_point;
-                               struct ctf_node *integer;
-                               struct ctf_node *string;
-                               struct ctf_node *_enum;
-                               struct ctf_node *variant;
-                               struct ctf_node *_struct;
-                       } u;
+                       /* For struct, variant and enum */
+                       struct ctf_node *node;
+                       const char *id_type;
                } type_specifier;
                struct {
-                       /* drop "const" specifier */
-                       /* Children nodes are type_specifiers */
-                       struct cds_list_head type_specifiers;
-               } declaration_specifier;
+                       /* list of type_specifier */
+                       struct bt_list_head head;
+               } type_specifier_list;
                struct {
+                       unsigned int const_qualifier;
                } pointer;
                struct {
-                       struct cds_list_head pointers;
+                       struct bt_list_head pointers;
                        enum {
                                TYPEDEC_UNKNOWN = 0,
                                TYPEDEC_ID,     /* identifier */
@@ -175,78 +231,87 @@ struct ctf_node {
                                struct {
                                        /* typedec has no pointer list */
                                        struct ctf_node *type_declarator;
-                                       struct {
-                                               enum {
-                                                       TYPEDEC_TYPE_UNKNOWN = 0,
-                                                       TYPEDEC_TYPE_VALUE, /* must be > 0 */
-                                                       TYPEDEC_TYPE_TYPE,
-                                               } type;
-                                               union {
-                                                       uint64_t value;
-                                                       struct ctf_node *declaration_specifier;
-                                               } u;
-                                       } length;
+                                       /*
+                                        * unary expression (value) or
+                                        * type_specifier_list.
+                                        */
+                                       struct bt_list_head length;
+                                       /* for abstract type declarator */
+                                       unsigned int abstract_array;
                                } nested;
                        } u;
+                       struct ctf_node *bitfield_len;
                } type_declarator;
                struct {
                        /* Children nodes are ctf_expression. */
-                       struct cds_list_head expressions;
+                       struct bt_list_head expressions;
                } floating_point;
                struct {
                        /* Children nodes are ctf_expression. */
-                       struct cds_list_head expressions;
+                       struct bt_list_head expressions;
                } integer;
                struct {
                        /* Children nodes are ctf_expression. */
-                       struct cds_list_head expressions;
+                       struct bt_list_head expressions;
                } string;
                struct {
                        char *id;
-                       union {         /* inclusive start/end of range */
-                               struct {
-                                       int64_t start, end;
-                               } _signed;
-                               struct {
-                                       uint64_t start, end;
-                               } _unsigned;
-                       } u;
+                       /*
+                        * Range list or single value node. Contains unary
+                        * expressions.
+                        */
+                       struct bt_list_head values;
                } enumerator;
                struct {
                        char *enum_id;
-                       struct {
-                               enum {
-                                       ENUM_TYPE_UNKNOWN = 0,
-                                       ENUM_TYPE_VALUE, /* must be > 0 */
-                                       ENUM_TYPE_TYPE,
-                               } type;
-                               union {
-                                       uint64_t value;
-                                       struct ctf_node *declaration_specifier;
-                               } u;
-                       } container_type;
-                       struct cds_list_head enumerator_list;
+                       /*
+                        * Either NULL, or points to unary expression or
+                        * type_specifier_list.
+                        */
+                       struct ctf_node *container_type;
+                       struct bt_list_head enumerator_list;
+                       int has_body;
                } _enum;
                struct {
-                       struct ctf_node *declaration_specifier;
-                       struct cds_list_head type_declarators;
+                       struct ctf_node *type_specifier_list;
+                       struct bt_list_head type_declarators;
                } struct_or_variant_declaration;
                struct {
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head declaration_list;
+                       char *name;
+                       char *choice;
+                       /* list of typedef, typealias and declarations */
+                       struct bt_list_head declaration_list;
+                       int has_body;
                } variant;
                struct {
-                       struct cds_list_head _typedef;
-                       struct cds_list_head typealias;
-                       struct cds_list_head declaration_list;
+                       char *name;
+                       /* list of typedef, typealias and declarations */
+                       struct bt_list_head declaration_list;
+                       int has_body;
+                       struct bt_list_head min_align;  /* align() attribute */
                } _struct;
        } u;
 };
 
 struct ctf_ast {
        struct ctf_node root;
-       struct cds_list_head allocated_nodes;
+       struct bt_list_head allocated_nodes;
 };
 
-#endif /* _CTF_PARSER_H */
+const char *node_type(struct ctf_node *node);
+
+struct ctf_trace;
+
+BT_HIDDEN
+int ctf_visitor_print_xml(FILE *fd, int depth, struct ctf_node *node);
+BT_HIDDEN
+int ctf_visitor_semantic_check(FILE *fd, int depth, struct ctf_node *node);
+BT_HIDDEN
+int ctf_visitor_parent_links(FILE *fd, int depth, struct ctf_node *node);
+BT_HIDDEN
+int ctf_visitor_construct_metadata(FILE *fd, int depth, struct ctf_node *node,
+                       struct ctf_trace *trace, int byte_order);
+BT_HIDDEN
+int ctf_destroy_metadata(struct ctf_trace *trace);
+
+#endif /* _CTF_AST_H */
This page took 0.028595 seconds and 4 git commands to generate.