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

/* Perform an inferior function call, for GDB, the GNU debugger.

   Copyright (C) 2003-2018 Free Software Foundation, Inc.

   This file is part of GDB.

   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 INFCALL_H
#define INFCALL_H

#include "dummy-frame.h"

struct value;
struct type;

extern CORE_ADDR find_function_addr (struct value *function, 
				     struct type **retval_type);

/* Perform a function call in the inferior.

   ARGS is a vector of values of arguments (NARGS of them).  FUNCTION
   is a value, the function to be called.  Returns a value
   representing what the function returned.  May fail to return, if a
   breakpoint or signal is hit during the execution of the function.

   DFEAULT_RETURN_TYPE is used as function return type if the return
   type is unknown.  This is used when calling functions with no debug
   info.

   ARGS is modified to contain coerced values.  */

extern struct value *call_function_by_hand (struct value *function,
					    type *default_return_type,
					    int nargs,
					    struct value **args);

/* Similar to call_function_by_hand and additional call
   register_dummy_frame_dtor with DUMMY_DTOR and DUMMY_DTOR_DATA for the
   created inferior call dummy frame.  */

extern struct value *
  call_function_by_hand_dummy (struct value *function,
			       type *default_return_type,
			       int nargs,
			       struct value **args,
			       dummy_frame_dtor_ftype *dummy_dtor,
			       void *dummy_dtor_data);

/* Throw an error indicating that the user tried to call a function
   that has unknown return type.  FUNC_NAME is the name of the
   function to be included in the error message; may be NULL, in which
   case the error message doesn't include a function name.  */

extern void error_call_unknown_return_type (const char *func_name);

#endif
Commit	Line	Data
	1	/* Perform an inferior function call, for GDB, the GNU debugger.
	2
	3	Copyright (C) 2003-2018 Free Software Foundation, Inc.
	4
	5	This file is part of GDB.
	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	#ifndef INFCALL_H
	21	#define INFCALL_H
	22
	23	#include "dummy-frame.h"
	24
	25	struct value;
	26	struct type;
	27
	28	extern CORE_ADDR find_function_addr (struct value *function,
	29	struct type **retval_type);
	30
	31	/* Perform a function call in the inferior.
	32
	33	ARGS is a vector of values of arguments (NARGS of them). FUNCTION
	34	is a value, the function to be called. Returns a value
	35	representing what the function returned. May fail to return, if a
	36	breakpoint or signal is hit during the execution of the function.
	37
	38	DFEAULT_RETURN_TYPE is used as function return type if the return
	39	type is unknown. This is used when calling functions with no debug
	40	info.
	41
	42	ARGS is modified to contain coerced values. */
	43
	44	extern struct value call_function_by_hand (struct value function,
	45	type *default_return_type,
	46	int nargs,
	47	struct value **args);
	48
	49	/* Similar to call_function_by_hand and additional call
	50	register_dummy_frame_dtor with DUMMY_DTOR and DUMMY_DTOR_DATA for the
	51	created inferior call dummy frame. */
	52
	53	extern struct value *
	54	call_function_by_hand_dummy (struct value *function,
	55	type *default_return_type,
	56	int nargs,
	57	struct value **args,
	58	dummy_frame_dtor_ftype *dummy_dtor,
	59	void *dummy_dtor_data);
	60
	61	/* Throw an error indicating that the user tried to call a function
	62	that has unknown return type. FUNC_NAME is the name of the
	63	function to be included in the error message; may be NULL, in which
	64	case the error message doesn't include a function name. */
	65
	66	extern void error_call_unknown_return_type (const char *func_name);
	67
	68	#endif