summaryrefslogtreecommitdiff
path: root/prism/prettyprint.h
blob: 0d8e416341e18bbd8c2e1ef6b74b3ff066ba374c (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
/**
 * @file prettyprint.h
 *
 * An AST node pretty-printer.
 */
#ifndef PRISM_PRETTYPRINT_H
#define PRISM_PRETTYPRINT_H

#include "prism/excludes.h"

#ifndef PRISM_EXCLUDE_PRETTYPRINT

#include "prism/compiler/exported.h"
#include "prism/compiler/nonnull.h"

#include "prism/ast.h"
#include "prism/buffer.h"
#include "prism/parser.h"

/**
 * Pretty-prints the AST represented by the given node to the given buffer.
 *
 * @param output_buffer The buffer to write the pretty-printed AST to.
 * @param parser The parser that parsed the AST.
 * @param node The root node of the AST to pretty-print.
 */
PRISM_EXPORTED_FUNCTION void pm_prettyprint(pm_buffer_t *output_buffer, const pm_parser_t *parser, const pm_node_t *node) PRISM_NONNULL(1, 2, 3);

#endif

#endif