[deliverable/binutils-gdb.git] / gdb / compile / compile.h

/* Header file for Compile and inject module.

   Copyright (C) 2014 Free Software Foundation, Inc.

   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/>.  */

#ifndef GDB_COMPILE_H
#define GDB_COMPILE_H

struct ui_file;
struct gdbarch;
struct dwarf2_per_cu_data;
struct symbol;
struct dynamic_prop;

/* Public function that is called from compile_control case in the
   expression command.  GDB returns either a CMD, or a CMD_STRING, but
   never both.  */

extern void eval_compile_command (struct command_line *cmd, char *cmd_string,
				  enum compile_i_scope_types scope);

/* Compile a DWARF location expression to C, suitable for use by the
   compiler.

   STREAM is the stream where the code should be written.

   RESULT_NAME is the name of a variable in the resulting C code.  The
   result of the expression will be assigned to this variable.

   SYM is the symbol corresponding to this expression.
   PC is the location at which the expression is being evaluated.
   ARCH is the architecture to use.

   REGISTERS_USED is an out parameter which is updated to note which
   registers were needed by this expression.

   ADDR_SIZE is the DWARF address size to use.

   OPT_PTR and OP_END are the bounds of the DWARF expression.

   PER_CU is the per-CU object used for looking up various other
   things.  */

extern void compile_dwarf_expr_to_c (struct ui_file *stream,
				     const char *result_name,
				     struct symbol *sym,
				     CORE_ADDR pc,
				     struct gdbarch *arch,
				     unsigned char *registers_used,
				     unsigned int addr_size,
				     const gdb_byte *op_ptr,
				     const gdb_byte *op_end,
				     struct dwarf2_per_cu_data *per_cu);

/* Compile a DWARF bounds expression to C, suitable for use by the
   compiler.

   STREAM is the stream where the code should be written.

   RESULT_NAME is the name of a variable in the resulting C code.  The
   result of the expression will be assigned to this variable.

   PROP is the dynamic property for which we're compiling.

   SYM is the symbol corresponding to this expression.
   PC is the location at which the expression is being evaluated.
   ARCH is the architecture to use.

   REGISTERS_USED is an out parameter which is updated to note which
   registers were needed by this expression.

   ADDR_SIZE is the DWARF address size to use.

   OPT_PTR and OP_END are the bounds of the DWARF expression.

   PER_CU is the per-CU object used for looking up various other
   things.  */

extern void compile_dwarf_bounds_to_c (struct ui_file *stream,
				       const char *result_name,
				       const struct dynamic_prop *prop,
				       struct symbol *sym, CORE_ADDR pc,
				       struct gdbarch *arch,
				       unsigned char *registers_used,
				       unsigned int addr_size,
				       const gdb_byte *op_ptr,
				       const gdb_byte *op_end,
				       struct dwarf2_per_cu_data *per_cu);

#endif /* GDB_COMPILE_H */
Commit	Line	Data
bb2ec1b3 TT	1	/* Header file for Compile and inject module.
	2
	3	Copyright (C) 2014 Free Software Foundation, Inc.
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 3 of the License, or
	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	17
	18	#ifndef GDB_COMPILE_H
	19	#define GDB_COMPILE_H
	20
	21	struct ui_file;
	22	struct gdbarch;
	23	struct dwarf2_per_cu_data;
	24	struct symbol;
	25	struct dynamic_prop;
	26
	27	/* Public function that is called from compile_control case in the
	28	expression command. GDB returns either a CMD, or a CMD_STRING, but
	29	never both. */
	30
	31	extern void eval_compile_command (struct command_line cmd, char cmd_string,
	32	enum compile_i_scope_types scope);
	33
	34	/* Compile a DWARF location expression to C, suitable for use by the
	35	compiler.
	36
	37	STREAM is the stream where the code should be written.
	38
	39	RESULT_NAME is the name of a variable in the resulting C code. The
	40	result of the expression will be assigned to this variable.
	41
	42	SYM is the symbol corresponding to this expression.
	43	PC is the location at which the expression is being evaluated.
	44	ARCH is the architecture to use.
	45
	46	REGISTERS_USED is an out parameter which is updated to note which
	47	registers were needed by this expression.
	48
	49	ADDR_SIZE is the DWARF address size to use.
	50
	51	OPT_PTR and OP_END are the bounds of the DWARF expression.
	52
	53	PER_CU is the per-CU object used for looking up various other
	54	things. */
	55
	56	extern void compile_dwarf_expr_to_c (struct ui_file *stream,
	57	const char *result_name,
	58	struct symbol *sym,
	59	CORE_ADDR pc,
	60	struct gdbarch *arch,
	61	unsigned char *registers_used,
	62	unsigned int addr_size,
	63	const gdb_byte *op_ptr,
	64	const gdb_byte *op_end,
65	struct dwarf2_per_cu_data *per_cu);
66
67	/* Compile a DWARF bounds expression to C, suitable for use by the
68	compiler.
69
70	STREAM is the stream where the code should be written.
71
72	RESULT_NAME is the name of a variable in the resulting C code. The
73	result of the expression will be assigned to this variable.
74
75	PROP is the dynamic property for which we're compiling.
76
77	SYM is the symbol corresponding to this expression.
78	PC is the location at which the expression is being evaluated.
79	ARCH is the architecture to use.
80
81	REGISTERS_USED is an out parameter which is updated to note which
82	registers were needed by this expression.
83
84	ADDR_SIZE is the DWARF address size to use.
85
86	OPT_PTR and OP_END are the bounds of the DWARF expression.
87
88	PER_CU is the per-CU object used for looking up various other
89	things. */
90
91	extern void compile_dwarf_bounds_to_c (struct ui_file *stream,
92	const char *result_name,
93	const struct dynamic_prop *prop,
94	struct symbol *sym, CORE_ADDR pc,
95	struct gdbarch *arch,
96	unsigned char *registers_used,
97	unsigned int addr_size,
98	const gdb_byte *op_ptr,
99	const gdb_byte *op_end,
100	struct dwarf2_per_cu_data *per_cu);
101
102	#endif /* GDB_COMPILE_H */