Automatic date update in version.in

[deliverable/binutils-gdb.git] / sim / common / sim-options.h

diff --git a/sim/common/sim-options.h b/sim/common/sim-options.h
index 586b91cfa6847dd01b720ea2a4375c9c273485db..94702c4c8c9dfd0c8d319b554445da083d992165 100644 (file)
--- a/sim/common/sim-options.h
+++ b/sim/common/sim-options.h
@@ -1,22 +1,21 @@
 /* Header file for simulator argument handling.
 /* Header file for simulator argument handling.

-   Copyright (C) 1997 Free Software Foundation, Inc.
+   Copyright (C) 1997-2020 Free Software Foundation, Inc.

    Contributed by Cygnus Support.
 
 This file is part of GDB, the GNU debugger.
 
 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
    Contributed by Cygnus Support.
 
 This file is part of GDB, the GNU debugger.
 
 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, or (at your option)
-any later version.
+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.
 
 
 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 the Free Software Foundation, Inc.,
-59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+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 SIM_OPTIONS_H
 #define SIM_OPTIONS_H
 
 #ifndef SIM_OPTIONS_H
 #define SIM_OPTIONS_H


@@ -29,33 +28,86 @@ with this program; if not, write to the Free Software Foundation, Inc.,
    sim_open handles the large majority of them and it also parses the
    options when invoked by gdb [or any external program].
 
    sim_open handles the large majority of them and it also parses the
    options when invoked by gdb [or any external program].
 

-   arg#2 is the option index; arg#3 is the option's argument, NULL if
-   optional and missing; arg#4 is nonzero if being called as a
-   command. */
+   For OPTION_HANDLER: arg#2 is the processor to apply to option to
+   (all if NULL); arg#3 is the option index; arg#4 is the option's
+   argument, NULL if optional and missing; arg#5 is nonzero if a
+   command is being interpreted. */

 
 

-typedef SIM_RC (OPTION_HANDLER) PARAMS ((SIM_DESC, int, char *, int));
+typedef SIM_RC (OPTION_HANDLER) (SIM_DESC, sim_cpu *, int, char *, int);

 
 /* Declare option handlers with a macro so it's usable on k&r systems.  */
 
 /* Declare option handlers with a macro so it's usable on k&r systems.  */

-#define DECLARE_OPTION_HANDLER(fn) SIM_RC fn PARAMS ((SIM_DESC, int, char *, int))
+#define DECLARE_OPTION_HANDLER(fn) SIM_RC fn (SIM_DESC, sim_cpu *, int, char *, int)

 
 typedef struct {
 
 typedef struct {

-  /* The long option information.  */
+
+  /* The long option information. */
+

   struct option opt;
   struct option opt;

-  /* The short option with the same meaning ('\0' if none).  */
+
+  /* The short option with the same meaning ('\0' if none).
+
+     For short options, when OPT.VAL is non-zero, it, instead of
+     SHORTOPT is passed to HANDLER.
+
+     For example, for the below:
+
+       { {"dc", no_argument, NULL, OPTION_VALUE},
+           'd', NULL, "<<description>>", HANDLER},
+       { {NULL, no_argument, NULL, OPTION_VALUE},
+           'e', NULL, "<<description>>", HANDLER},
+
+     the options --dc, -d and -e all result in OPTION_VALUE being
+     passed into HANDLER. */
+

   char shortopt;
   char shortopt;

+

   /* The name of the argument (NULL if none).  */
   /* The name of the argument (NULL if none).  */

+

   const char *arg;
   const char *arg;

-  /* The documentation string.  If this is NULL, this is a synonym for
-     the previous option.  */
+
+  /* The documentation string.
+
+     If DOC is NULL, this option name is listed as a synonym for the
+     previous option.
+
+     If DOC and DOC_NAME are the empty string (i.e. ""), this option
+     is not listed in usage and help messages.
+
+     For example, given the aliased options --dc, --dp and -d, then:
+
+       { {"dc", no_argument, NULL, OPTION_DC},
+           'd', NULL, "<<description>>", HANDLER},
+       { {"dp", no_argument, NULL, OPTION_DP},
+           '\0', NULL, NULL, HANDLER},
+
+     will list ``-d, --dc, --dp <<description>>'' */
+

   const char *doc;
   const char *doc;

+

   /* A function to process the option.  */
   /* A function to process the option.  */

+

   OPTION_HANDLER *handler;
   OPTION_HANDLER *handler;

-  /* The documented name of the option.  If this is NULL, opt.name is
-     listed; otherwize this is listed as the name of the option.
-     Ex: given the options --set-pc, set-sp, et.al. the first option
-     would have doc_opt set to `--set-REGNAME' with the others set to
-     "".  Only --set-REGNAME would then be listed.   */
+
+  /* The documentation name.  Used when generating usage and help
+     messages.
+
+     If DOC and DOC_NAME are the empty string (i.e. ""), this option
+     is not listed in usage and help messages.
+
+     If DOC_NAME is a non-empty string then it, insted of OPT.NAME, is
+     listed as the name of the option in usage and help messages.
+
+     For example, given the options --set-pc and --set-sp, then:
+
+       { {"set-pc", no_argument, NULL, OPTION_SET_PC},
+            '\0', NULL, "<<description>>", HANDLER, "--set-REGNAME" },
+       { {"set-sp", no_argument, NULL, OPTION_SET_SP},
+           '\0', NULL, "", HANDLER, "" },
+
+     will list ``--set-REGNAME <<description>>". */
+

   const char *doc_name;
   const char *doc_name;

+

 } OPTION;
 
 /* All options that don't have a short form equivalent begin with this for
 } OPTION;
 
 /* All options that don't have a short form equivalent begin with this for


@@ -65,8 +117,8 @@ typedef struct {
    handler.  */
 #define OPTION_START 130
 
    handler.  */
 #define OPTION_START 130
 

-/* Non-zero if an option whose `val' entry is O is using OPTION_START.  */
-#define OPTION_LONG_ONLY_P(o) ((unsigned char) (o) >= OPTION_START)
+/* Identify valid option in the table */
+#define OPTION_VALID_P(O) ((O)->opt.name != NULL || (O)->shortopt != '\0')

 
 /* List of options added by various modules.  */
 typedef struct option_list {
 
 /* List of options added by various modules.  */
 typedef struct option_list {


@@ -75,20 +127,22 @@ typedef struct option_list {
 } OPTION_LIST;
 
 /* Add a set of options to the simulator.
 } OPTION_LIST;
 
 /* Add a set of options to the simulator.

+   CPU is the cpu the options apply to or NULL for all cpus.

    TABLE is an array of OPTIONS terminated by a NULL `opt.name' entry.  */
    TABLE is an array of OPTIONS terminated by a NULL `opt.name' entry.  */

-SIM_RC sim_add_option_table PARAMS ((SIM_DESC sd, const OPTION *table));
+SIM_RC sim_add_option_table (SIM_DESC sd, sim_cpu *cpu, const OPTION *table);

 
 /* Install handler for the standard options.  */
 MODULE_INSTALL_FN standard_install;
 
 /* Called by sim_open to parse the arguments.  */
 
 /* Install handler for the standard options.  */
 MODULE_INSTALL_FN standard_install;
 
 /* Called by sim_open to parse the arguments.  */

-SIM_RC sim_parse_args PARAMS ((SIM_DESC sd, char **argv));
+SIM_RC sim_parse_args (SIM_DESC sd, char * const *argv);

 
 

-/* Print help messages for the options.  */
-void sim_print_help PARAMS ((SIM_DESC sd));
+/* Print help messages for the options.  IS_COMMAND is non-zero when
+   this function is called from the command line interpreter. */
+void sim_print_help (SIM_DESC sd, int is_command);

 
 /* Try to parse the command as if it is an option, Only fail when
    totally unsuccessful */
 
 /* Try to parse the command as if it is an option, Only fail when
    totally unsuccessful */

-SIM_RC sim_args_command PARAMS ((SIM_DESC sd, char *cmd));
+SIM_RC sim_args_command (SIM_DESC sd, const char *cmd);

 
 #endif /* SIM_OPTIONS_H */
 
 #endif /* SIM_OPTIONS_H */