[deliverable/binutils-gdb.git] / gdb / cli / cli-utils.h

/* CLI utilities.

   Copyright (c) 2011-2012 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 CLI_UTILS_H
#define CLI_UTILS_H

/* *PP is a string denoting a number.  Get the number of the.  Advance
   *PP after the string and any trailing whitespace.

   Currently the string can either be a number,  or "$" followed by the
   name of a convenience variable, or ("$" or "$$") followed by digits.  */

extern int get_number (char **);

/* An object of this type is passed to get_number_or_range.  It must
   be initialized by calling init_number_or_range.  This type is
   defined here so that it can be stack-allocated, but all members
   other than `finished' and `string' should be treated as opaque.  */

struct get_number_or_range_state
{
  /* Non-zero if parsing has completed.  */
  int finished;

  /* The string being parsed.  When parsing has finished, this points
     past the last parsed token.  */
  char *string;

  /* Last value returned.  */
  int last_retval;

  /* When parsing a range, the final value in the range.  */
  int end_value;

  /* When parsing a range, a pointer past the final token in the
     range.  */
  char *end_ptr;

  /* Non-zero when parsing a range.  */
  int in_range;
};

/* Initialize a get_number_or_range_state for use with
   get_number_or_range_state.  STRING is the string to be parsed.  */

extern void init_number_or_range (struct get_number_or_range_state *state,
				  char *string);

/* Parse a number or a range.
   A number will be of the form handled by get_number.
   A range will be of the form <number1> - <number2>, and 
   will represent all the integers between number1 and number2,
   inclusive.

   While processing a range, this fuction is called iteratively;
   At each call it will return the next value in the range.

   At the beginning of parsing a range, the char pointer STATE->string will
   be advanced past <number1> and left pointing at the '-' token.
   Subsequent calls will not advance the pointer until the range
   is completed.  The call that completes the range will advance
   the pointer past <number2>.  */

extern int get_number_or_range (struct get_number_or_range_state *state);

/* Accept a number and a string-form list of numbers such as is 
   accepted by get_number_or_range.  Return TRUE if the number is
   in the list.

   By definition, an empty list includes all numbers.  This is to 
   be interpreted as typing a command such as "delete break" with 
   no arguments.  */

extern int number_is_in_list (char *list, int number);

/* Skip leading whitespace characters in INP, returning an updated
   pointer.  If INP is NULL, return NULL.  */

extern char *skip_spaces (char *inp);

/* A const-correct version of the above.  */

extern const char *skip_spaces_const (const char *inp);

/* Skip leading non-whitespace characters in INP, returning an updated
   pointer.  If INP is NULL, return NULL.  */

extern char *skip_to_space (char *inp);

/* Reverse S to the last non-whitespace character without skipping past
   START.  */

extern char *remove_trailing_whitespace (const char *start, char *s);

/* A helper function to extract an argument from *ARG.  An argument is
   delimited by whitespace.  The return value is either NULL if no
   argument was found, or an xmalloc'd string.  */

extern char *extract_arg (char **arg);

#endif /* CLI_UTILS_H */
Commit	Line	Data
e9cafbcc TT	1	/* CLI utilities.
e9cafbcc TT	2
0b302171	3	Copyright (c) 2011-2012 Free Software Foundation, Inc.
e9cafbcc TT	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 CLI_UTILS_H
	21	#define CLI_UTILS_H
	22
	23	/* *PP is a string denoting a number. Get the number of the. Advance
	24	*PP after the string and any trailing whitespace.
	25
3bd0f5ef MS	26	Currently the string can either be a number, or "$" followed by the
3bd0f5ef MS	27	name of a convenience variable, or ("$" or "$$") followed by digits. */
e9cafbcc TT	28
	29	extern int get_number (char **);
	30
197f0a60 TT	31	/* An object of this type is passed to get_number_or_range. It must
	32	be initialized by calling init_number_or_range. This type is
	33	defined here so that it can be stack-allocated, but all members
	34	other than `finished' and `string' should be treated as opaque. */
	35
	36	struct get_number_or_range_state
	37	{
	38	/* Non-zero if parsing has completed. */
	39	int finished;
	40
	41	/* The string being parsed. When parsing has finished, this points
	42	past the last parsed token. */
	43	char *string;
	44
	45	/* Last value returned. */
	46	int last_retval;
	47
	48	/* When parsing a range, the final value in the range. */
	49	int end_value;
	50
	51	/* When parsing a range, a pointer past the final token in the
	52	range. */
	53	char *end_ptr;
	54
	55	/* Non-zero when parsing a range. */
	56	int in_range;
	57	};
	58
	59	/* Initialize a get_number_or_range_state for use with
	60	get_number_or_range_state. STRING is the string to be parsed. */
	61
	62	extern void init_number_or_range (struct get_number_or_range_state *state,
	63	char *string);
	64
e9cafbcc TT	65	/* Parse a number or a range.
	66	A number will be of the form handled by get_number.
	67	A range will be of the form <number1> - <number2>, and
	68	will represent all the integers between number1 and number2,
	69	inclusive.
	70
	71	While processing a range, this fuction is called iteratively;
	72	At each call it will return the next value in the range.
	73
197f0a60	74	At the beginning of parsing a range, the char pointer STATE->string will
e9cafbcc TT	75	be advanced past <number1> and left pointing at the '-' token.
	76	Subsequent calls will not advance the pointer until the range
	77	is completed. The call that completes the range will advance
197f0a60	78	the pointer past <number2>. */
e9cafbcc	79
197f0a60	80	extern int get_number_or_range (struct get_number_or_range_state *state);
e9cafbcc	81
aea5b279 MS	82	/* Accept a number and a string-form list of numbers such as is
	83	accepted by get_number_or_range. Return TRUE if the number is
	84	in the list.
	85
	86	By definition, an empty list includes all numbers. This is to
	87	be interpreted as typing a command such as "delete break" with
	88	no arguments. */
	89
	90	extern int number_is_in_list (char *list, int number);
	91
e9cafbcc TT	92	/* Skip leading whitespace characters in INP, returning an updated
	93	pointer. If INP is NULL, return NULL. */
	94
	95	extern char skip_spaces (char inp);
	96
55aa24fb SDJ	97	/* A const-correct version of the above. */
	98
	99	extern const char skip_spaces_const (const char inp);
	100
e9cafbcc TT	101	/* Skip leading non-whitespace characters in INP, returning an updated
	102	pointer. If INP is NULL, return NULL. */
	103
	104	extern char skip_to_space (char inp);
	105
c00f8484 KS	106	/* Reverse S to the last non-whitespace character without skipping past
	107	START. */
	108
	109	extern char remove_trailing_whitespace (const char start, char *s);
55aa24fb SDJ	110
	111	/* A helper function to extract an argument from *ARG. An argument is
	112	delimited by whitespace. The return value is either NULL if no
	113	argument was found, or an xmalloc'd string. */
	114
	115	extern char extract_arg (char *arg);
	116
e9cafbcc	117	#endif /* CLI_UTILS_H */