2010-05-05 Michael Snyder <msnyder@vmware.com>
[deliverable/binutils-gdb.git] / gdb / mi / mi-out.c
index 612cdf8c94d3406e0a037f930f4fe77b649d44f9..1e941758cc5d1f58be7bfe54fa7687b260cf6d8b 100644 (file)
@@ -1,12 +1,15 @@
 /* MI Command Set - output generating routines.
-   Copyright 2000 Free Software Foundation, Inc.
+
+   Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
+   Free Software Foundation, Inc.
+
    Contributed by Cygnus Solutions (a Red Hat company).
 
    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 2 of the License, or
+   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,
    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.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 #include "ui-out.h"
 #include "mi-out.h"
 
-/* Convenience macro for allocting typesafe memory. */
-
-#ifndef XMALLOC
-#define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
-#endif
-
 struct ui_out_data
   {
-    int supress_field_separator;
-    int first_header;
+    int suppress_field_separator;
+    int suppress_output;
+    int mi_version;
     struct ui_file *buffer;
   };
+typedef struct ui_out_data mi_out_data;
 
 /* These are the MI output functions */
 
-static void mi_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
+static void mi_table_begin (struct ui_out *uiout, int nbrofcols,
+                           int nr_rows, const char *tblid);
 static void mi_table_body (struct ui_out *uiout);
 static void mi_table_end (struct ui_out *uiout);
 static void mi_table_header (struct ui_out *uiout, int width,
-                            enum ui_align alig, char *colhdr);
-static void mi_list_begin (struct ui_out *uiout, int list_flag, char *lstid);
-static void mi_list_end (struct ui_out *uiout, int list_flag);
+                            enum ui_align alig, const char *col_name,
+                            const char *colhdr);
+static void mi_begin (struct ui_out *uiout, enum ui_out_type type,
+                     int level, const char *id);
+static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level);
 static void mi_field_int (struct ui_out *uiout, int fldno, int width,
-                         enum ui_align alig, char *fldname, int value);
+                         enum ui_align alig, const char *fldname, int value);
 static void mi_field_skip (struct ui_out *uiout, int fldno, int width,
-                          enum ui_align alig, char *fldname);
+                          enum ui_align alig, const char *fldname);
 static void mi_field_string (struct ui_out *uiout, int fldno, int width,
-                            enum ui_align alig, char *fldname,
+                            enum ui_align alig, const char *fldname,
                             const char *string);
 static void mi_field_fmt (struct ui_out *uiout, int fldno,
                          int width, enum ui_align align,
-                         char *fldname, char *format, va_list args);
+                         const char *fldname, const char *format,
+                         va_list args) ATTRIBUTE_PRINTF (6, 0);
 static void mi_spaces (struct ui_out *uiout, int numspaces);
-static void mi_text (struct ui_out *uiout, char *string);
-static void mi_message (struct ui_out *uiout, int verbosity, char *format,
-                       va_list args);
+static void mi_text (struct ui_out *uiout, const char *string);
+static void mi_message (struct ui_out *uiout, int verbosity,
+                       const char *format, va_list args)
+     ATTRIBUTE_PRINTF (3, 0);
 static void mi_wrap_hint (struct ui_out *uiout, char *identstring);
 static void mi_flush (struct ui_out *uiout);
 
@@ -73,8 +75,8 @@ struct ui_out_impl mi_ui_out_impl =
   mi_table_body,
   mi_table_end,
   mi_table_header,
-  mi_list_begin,
-  mi_list_end,
+  mi_begin,
+  mi_end,
   mi_field_int,
   mi_field_skip,
   mi_field_string,
@@ -83,31 +85,33 @@ struct ui_out_impl mi_ui_out_impl =
   mi_text,
   mi_message,
   mi_wrap_hint,
-  mi_flush
+  mi_flush,
+  NULL,
+  1, /* Needs MI hacks.  */
 };
 
 /* Prototypes for local functions */
 
 extern void _initialize_mi_out (void);
 static void field_separator (struct ui_out *uiout);
-static void list_open (struct ui_out *uiout);
-static void list_close (struct ui_out *uiout);
-
-static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
-                          char *format,...);
+static void mi_open (struct ui_out *uiout, const char *name,
+                    enum ui_out_type type);
+static void mi_close (struct ui_out *uiout, enum ui_out_type type);
 
 /* Mark beginning of a table */
 
 void
-mi_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+mi_table_begin (struct ui_out *uiout,
+               int nr_cols,
+               int nr_rows,
+               const char *tblid)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  field_separator (uiout);
-  if (tblid)
-    fprintf_unfiltered (data->buffer, "%s=", tblid);
-  list_open (uiout);
-  data->first_header = 0;
-  data->supress_field_separator = 1;
+  mi_open (uiout, tblid, ui_out_type_tuple);
+  mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
+               "nr_rows", nr_rows);
+  mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
+               "nr_cols", nr_cols);
+  mi_open (uiout, "hdr", ui_out_type_list);
 }
 
 /* Mark beginning of a table body */
@@ -115,10 +119,12 @@ mi_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
 void
 mi_table_body (struct ui_out *uiout)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
   /* close the table header line if there were any headers */
-  if (data->first_header)
-    list_close (uiout);
+  mi_close (uiout, ui_out_type_list);
+  mi_open (uiout, "body", ui_out_type_list);
 }
 
 /* Mark end of a table */
@@ -126,57 +132,67 @@ mi_table_body (struct ui_out *uiout)
 void
 mi_table_end (struct ui_out *uiout)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  list_close (uiout);
-  /* If table was empty this flag did not get reset yet */
-  data->supress_field_separator = 0;
+  mi_out_data *data = ui_out_data (uiout);
+  data->suppress_output = 0;
+  mi_close (uiout, ui_out_type_list); /* body */
+  mi_close (uiout, ui_out_type_tuple);
 }
 
 /* Specify table header */
 
 void
-mi_table_header (struct ui_out *uiout, int width, int alignment, char *colhdr)
+mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
+                const char *col_name,
+                const char *colhdr)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  if (!data->first_header++)
-    {
-      fputs_unfiltered ("hdr=", data->buffer);
-      list_open (uiout);
-    }
-  mi_field_string (uiout, 0, width, alignment, 0, colhdr);
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
+  mi_open (uiout, NULL, ui_out_type_tuple);
+  mi_field_int (uiout, 0, 0, 0, "width", width);
+  mi_field_int (uiout, 0, 0, 0, "alignment", alignment);
+  mi_field_string (uiout, 0, 0, 0, "col_name", col_name);
+  mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr);
+  mi_close (uiout, ui_out_type_tuple);
 }
 
 /* Mark beginning of a list */
 
 void
-mi_list_begin (struct ui_out *uiout, int list_flag, char *lstid)
+mi_begin (struct ui_out *uiout,
+         enum ui_out_type type,
+         int level,
+         const char *id)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  field_separator (uiout);
-  data->supress_field_separator = 1;
-  if (lstid)
-    fprintf_unfiltered (data->buffer, "%s=", lstid);
-  list_open (uiout);
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
+  mi_open (uiout, id, type);
 }
 
 /* Mark end of a list */
 
 void
-mi_list_end (struct ui_out *uiout, int list_flag)
+mi_end (struct ui_out *uiout,
+       enum ui_out_type type,
+       int level)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  list_close (uiout);
-  /* If list was empty this flag did not get reset yet */
-  data->supress_field_separator = 0;
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
+  mi_close (uiout, type);
 }
 
 /* output an int field */
 
 void
-mi_field_int (struct ui_out *uiout, int fldno, int width, int alignment,
-             char *fldname, int value)
+mi_field_int (struct ui_out *uiout, int fldno, int width,
+              enum ui_align alignment, const char *fldname, int value)
 {
   char buffer[20];             /* FIXME: how many chars long a %d can become? */
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
 
   sprintf (buffer, "%d", value);
   mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
@@ -185,9 +201,12 @@ mi_field_int (struct ui_out *uiout, int fldno, int width, int alignment,
 /* used to ommit a field */
 
 void
-mi_field_skip (struct ui_out *uiout, int fldno, int width, int alignment,
-              char *fldname)
+mi_field_skip (struct ui_out *uiout, int fldno, int width,
+               enum ui_align alignment, const char *fldname)
 {
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
   mi_field_string (uiout, fldno, width, alignment, fldname, "");
 }
 
@@ -198,11 +217,13 @@ void
 mi_field_string (struct ui_out *uiout,
                 int fldno,
                 int width,
-                int align,
-                char *fldname,
+                enum ui_align align,
+                const char *fldname,
                 const char *string)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
   field_separator (uiout);
   if (fldname)
     fprintf_unfiltered (data->buffer, "%s=", fldname);
@@ -217,9 +238,13 @@ mi_field_string (struct ui_out *uiout,
 void
 mi_field_fmt (struct ui_out *uiout, int fldno,
              int width, enum ui_align align,
-             char *fldname, char *format, va_list args)
+             const char *fldname,
+             const char *format,
+             va_list args)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_output)
+    return;
   field_separator (uiout);
   if (fldname)
     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
@@ -235,12 +260,14 @@ mi_spaces (struct ui_out *uiout, int numspaces)
 }
 
 void
-mi_text (struct ui_out *uiout, char *string)
+mi_text (struct ui_out *uiout, const char *string)
 {
 }
 
 void
-mi_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
+mi_message (struct ui_out *uiout, int verbosity,
+           const char *format,
+           va_list args)
 {
 }
 
@@ -253,61 +280,64 @@ mi_wrap_hint (struct ui_out *uiout, char *identstring)
 void
 mi_flush (struct ui_out *uiout)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
   gdb_flush (data->buffer);
 }
 
 /* local functions */
 
-/* Like mi_field_fmt, but takes a variable number of args
-   and makes a va_list and does not insert a separator */
-
-/* VARARGS */
-static void
-out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
-              char *format,...)
-{
-  struct ui_out_data *data = ui_out_data (uiout);
-  va_list args;
-
-  field_separator (uiout);
-  if (fldname)
-    fprintf_unfiltered (data->buffer, "%s=\"", fldname);
-  else
-    fputs_unfiltered ("\"", data->buffer);
-
-  va_start (args, format);
-  vfprintf_unfiltered (data->buffer, format, args);
-
-  fputs_unfiltered ("\"", data->buffer);
-
-  va_end (args);
-}
-
 /* access to ui_out format private members */
 
 static void
 field_separator (struct ui_out *uiout)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  if (data->supress_field_separator)
-    data->supress_field_separator = 0;
+  mi_out_data *data = ui_out_data (uiout);
+  if (data->suppress_field_separator)
+    data->suppress_field_separator = 0;
   else
     fputc_unfiltered (',', data->buffer);
 }
 
 static void
-list_open (struct ui_out *uiout)
+mi_open (struct ui_out *uiout,
+        const char *name,
+        enum ui_out_type type)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  fputc_unfiltered ('{', data->buffer);
+  mi_out_data *data = ui_out_data (uiout);
+  field_separator (uiout);
+  data->suppress_field_separator = 1;
+  if (name)
+    fprintf_unfiltered (data->buffer, "%s=", name);
+  switch (type)
+    {
+    case ui_out_type_tuple:
+      fputc_unfiltered ('{', data->buffer);
+      break;
+    case ui_out_type_list:
+      fputc_unfiltered ('[', data->buffer);
+      break;
+    default:
+      internal_error (__FILE__, __LINE__, _("bad switch"));
+    }
 }
 
 static void
-list_close (struct ui_out *uiout)
+mi_close (struct ui_out *uiout,
+         enum ui_out_type type)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
-  fputc_unfiltered ('}', data->buffer);
+  mi_out_data *data = ui_out_data (uiout);
+  switch (type)
+    {
+    case ui_out_type_tuple:
+      fputc_unfiltered ('}', data->buffer);
+      break;
+    case ui_out_type_list:
+      fputc_unfiltered (']', data->buffer);
+      break;
+    default:
+      internal_error (__FILE__, __LINE__, _("bad switch"));
+    }
+  data->suppress_field_separator = 0;
 }
 
 /* add a string to the buffer */
@@ -315,7 +345,7 @@ list_close (struct ui_out *uiout)
 void
 mi_out_buffered (struct ui_out *uiout, char *string)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
   fprintf_unfiltered (data->buffer, "%s", string);
 }
 
@@ -324,7 +354,7 @@ mi_out_buffered (struct ui_out *uiout, char *string)
 void
 mi_out_rewind (struct ui_out *uiout)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
   ui_file_rewind (data->buffer);
 }
 
@@ -340,19 +370,30 @@ void
 mi_out_put (struct ui_out *uiout,
            struct ui_file *stream)
 {
-  struct ui_out_data *data = ui_out_data (uiout);
+  mi_out_data *data = ui_out_data (uiout);
   ui_file_put (data->buffer, do_write, stream);
   ui_file_rewind (data->buffer);
 }
 
+/* Current MI version.  */
+
+int
+mi_version (struct ui_out *uiout)
+{
+  mi_out_data *data = ui_out_data (uiout);
+  return data->mi_version;
+}
+
 /* initalize private members at startup */
 
 struct ui_out *
-mi_out_new (void)
+mi_out_new (int mi_version)
 {
   int flags = 0;
-  struct ui_out_data *data = XMALLOC (struct ui_out_data);
-  data->supress_field_separator = 0;
+  mi_out_data *data = XMALLOC (mi_out_data);
+  data->suppress_field_separator = 0;
+  data->suppress_output = 0;
+  data->mi_version = mi_version;
   /* FIXME: This code should be using a ``string_file'' and not the
      TUI buffer hack. */
   data->buffer = mem_fileopen ();
This page took 0.035717 seconds and 4 git commands to generate.