src/graphviz.h

/* Output Graphviz specification of a state machine generated by Bison.

   Copyright (C) 2006, 2010-2012 Free Software Foundation, Inc.

   This file is part of Bison, the GNU Compiler Compiler.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

/* Written by Paul Eggert and Satya Kiran Popuri.  */

#ifndef GRAPHVIZ_H_
# define GRAPHVIZ_H_

#include "state.h"

/// Begin a Dot graph.
/// \param fout   output stream.
void start_graph (FILE *fout);

/// Output a Dot node.
/// \param id     identifier of the node
/// \param label  human readable label of the node (no Dot escaping needed).
/// \param fout   output stream.
void output_node (int id, char const *label, FILE *fout);

/// Output a Dot edge.
/// \param source       id of the source node
/// \param destination  id of the target node
/// \param label        human readable label of the edge
///                     (no Dot escaping needed).  Can be 0.
/// \param style        Dot style of the edge (e.g., "dotted" or "solid").
/// \param fout         output stream.
void output_edge (int source, int destination, char const *label,
                  char const *style, FILE *fout);

/// Output a reduction.
/// \param s            current state
/// \param reds         the set of reductions
/// \param fout         output stream.
void output_red (state const *s, reductions const *reds, FILE *fout);

/// End a Dot graph.
/// \param fout  output stream.
void finish_graph (FILE *fout);

/// Escape a lookahead token.
/// \param name         the token.
char const *escape (char const *name);

#endif /* ! GRAPHVIZ_H_ */
Commit	Line	Data
	1	/* Output Graphviz specification of a state machine generated by Bison.
	2
	3	Copyright (C) 2006, 2010-2012 Free Software Foundation, Inc.
	4
	5	This file is part of Bison, the GNU Compiler Compiler.
	6
	7	This program is free software: you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation, either version 3 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	19
	20	/* Written by Paul Eggert and Satya Kiran Popuri. */
	21
	22	#ifndef GRAPHVIZ_H_
	23	# define GRAPHVIZ_H_
	24
	25	#include "state.h"
	26
	27	/// Begin a Dot graph.
	28	/// \param fout output stream.
	29	void start_graph (FILE *fout);
	30
	31	/// Output a Dot node.
	32	/// \param id identifier of the node
	33	/// \param label human readable label of the node (no Dot escaping needed).
	34	/// \param fout output stream.
	35	void output_node (int id, char const label, FILE fout);
	36
	37	/// Output a Dot edge.
	38	/// \param source id of the source node
	39	/// \param destination id of the target node
	40	/// \param label human readable label of the edge
	41	/// (no Dot escaping needed). Can be 0.
	42	/// \param style Dot style of the edge (e.g., "dotted" or "solid").
	43	/// \param fout output stream.
	44	void output_edge (int source, int destination, char const *label,
	45	char const style, FILE fout);
	46
	47	/// Output a reduction.
	48	/// \param s current state
	49	/// \param reds the set of reductions
	50	/// \param fout output stream.
	51	void output_red (state const s, reductions const reds, FILE *fout);
	52
	53	/// End a Dot graph.
	54	/// \param fout output stream.
	55	void finish_graph (FILE *fout);
	56
	57	/// Escape a lookahead token.
	58	/// \param name the token.
	59	char const escape (char const name);
	60
	61	#endif /* ! GRAPHVIZ_H_ */