Document exp_descriptor.op_name should never return NULL.

This documents a constaint that struct exp_descriptor's "op_name"
method implementation should obey.  This might not have been part
of the initial design, but is currently true of all instantiations,
and already assumed by the current users.

gdb/ChangeLog:

        * parser-defs.h (struct exp_descriptor): Document constraint
        on return value for "op_name" callbacks.
This commit is contained in:
Joel Brobecker 2012-10-19 19:55:56 +00:00
parent 67d004eb5f
commit a5b1262727
2 changed files with 9 additions and 1 deletions

View File

@ -1,3 +1,8 @@
2012-10-19 Joel Brobecker <brobecker@adacore.com>
* parser-defs.h (struct exp_descriptor): Document constraint
on return value for "op_name" callbacks.
2012-10-18 Tom Tromey <tromey@redhat.com> 2012-10-18 Tom Tromey <tromey@redhat.com>
* tracepoint.c (print_one_static_tracepoint_marker): Constify. * tracepoint.c (print_one_static_tracepoint_marker): Constify.

View File

@ -335,7 +335,10 @@ struct exp_descriptor
void *data), void *data),
void *data); void *data);
/* Name of this operator for dumping purposes. */ /* Name of this operator for dumping purposes.
The returned value should never be NULL, even if EXP_OPCODE is
an unknown opcode (a string containing an image of the numeric
value of the opcode can be returned, for instance). */
char *(*op_name) (enum exp_opcode); char *(*op_name) (enum exp_opcode);
/* Dump the rest of this (prefix) expression after the operator /* Dump the rest of this (prefix) expression after the operator