/*
	flow.h

	Flow graph analysis.

	Copyright (C) 2012 Bill Currie <bill@taniwha.org>

	Author: Bill Currie <bill@taniwha.org>
	Date: 2012/10/30

	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 2
	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, write to:

		Free Software Foundation, Inc.
		59 Temple Place - Suite 330
		Boston, MA  02111-1307, USA

*/
#ifndef flow_h
#define flow_h

/** \defgroup qfcc_flow Flow graph analysis
	\ingroup qfcc
*/
//@{

struct function_s;
struct sblock_s;
struct statement_s;
struct operand_s;

typedef struct flowvar_s {
	struct flowvar_s *next;		///< for ALLOC
	struct set_s *use;			///< set of statements that use this var
	struct set_s *define;		///< set of statements that define this var
	int         number;			///< number of variable in func's ref list
} flowvar_t;

typedef struct flowloop_s {
	struct flowloop_s *next;
	unsigned    head;
	struct set_s *nodes;
} flowloop_t;

typedef struct flowedge_s {
	unsigned    tail;
	unsigned    head;
} flowedge_t;

/** Represent a node in a flow graph.
*/
typedef struct flownode_s {
	struct flownode_s *next;	//< for ALLOC
	unsigned    id;				//< index of this node in the flow graph
	unsigned    dfn;			//< depth-first ordering of this node
	struct set_s *predecessors;	//< predecessors of this node
	struct set_s *successors;	//< successors of this node
	struct set_s *edges;		//< edges leaving this node, to successor nodes
	struct set_s *dom;			//< dominating nodes
	struct sblock_s *sblock;	//< original statement block
} flownode_t;

typedef struct flowgraph_s {
	struct flowgraph_s *next;	//< for ALLOC
	flownode_t **nodes;			//< array of nodes in the graph
	int         num_nodes;
	flowedge_t *edges;			//< array of all edges in the graph
	int         num_edges;
	struct set_s *dfst;			//< edges in the depth-first search tree
	unsigned   *dfo;			//< depth-first order of nodes
	flowloop_t *loops;			//< linked list of natural loops
} flowgraph_t;

flowvar_t *flow_get_var (struct operand_s *op);
int flow_is_cond (struct statement_s *s);
int flow_is_goto (struct statement_s *s);
int flow_is_jumpb (struct statement_s *s);
int flow_is_return (struct statement_s *s);
struct sblock_s *flow_get_target (struct statement_s *s);
struct sblock_s **flow_get_targetlist (struct statement_s *s);
void flow_build_vars (struct function_s *func);
flowgraph_t *flow_build_graph (struct sblock_s *func);
void flow_del_graph (flowgraph_t *graph);

void print_flowgraph (flowgraph_t *graph, const char *filename);

//@}

#endif//flow_h