dfsm: Add all the missing API reference comments
[bendy-bus:bendy-bus.git] / dfsm / dfsm-parser.h
1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
2 /*
3  * D-Bus Simulator
4  * Copyright (C) Philip Withnall 2011 <philip@tecnocode.co.uk>
5  * 
6  * D-Bus Simulator is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * D-Bus Simulator is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with D-Bus Simulator.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /**
21  * SECTION:dfsm-parser
22  * @short_description: parser utilities
23  * @stability: Unstable
24  * @include: dfsm/dfsm-parser.h
25  *
26  * Parser utilities and error handling. The actual parser is implemented as dfsm_object_factory_from_files() and friends.
27  */
28
29 #ifndef DFSM_PARSER_H
30 #define DFSM_PARSER_H
31
32 #include <glib.h>
33 #include <gio/gio.h>
34
35 #include "dfsm-machine.h"
36 #include "dfsm-utils.h"
37
38 G_BEGIN_DECLS
39
40 /**
41  * DfsmParseError:
42  * @DFSM_PARSE_ERROR_SYNTAX: syntax error in the input file
43  * @DFSM_PARSE_ERROR_OOM: out of memory while parsing
44  * @DFSM_PARSE_ERROR_AST_INVALID: post-parsing checks on the AST failed
45  *
46  * Error codes for the #DFSM_PARSE_ERROR domain returned by the parser.
47  */
48 typedef enum {
49         DFSM_PARSE_ERROR_SYNTAX,
50         DFSM_PARSE_ERROR_OOM,
51         DFSM_PARSE_ERROR_AST_INVALID,
52 } DfsmParseError;
53
54 /**
55  * DFSM_PARSE_ERROR:
56  *
57  * Error domain returned by the parser.
58  */
59 #define DFSM_PARSE_ERROR dfsm_parse_error_quark ()
60
61 GQuark dfsm_parse_error_quark (void) G_GNUC_PURE;
62
63 G_END_DECLS
64
65 #endif /* !DFSM_PARSER_H */