src/hotspot/share/utilities/xmlstream.hpp
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 46727 hotspot/src/share/vm/utilities/xmlstream.hpp@6e4a84748e2c
child 53244 9807daeb47c4
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     1
/*
46329
53ccc37bda19 8155672: Remove instanceKlassHandles and KlassHandles
coleenp
parents: 24424
diff changeset
     2
 * Copyright (c) 2002, 2017, Oracle and/or its affiliates. All rights reserved.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     4
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
489c9b5090e2 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
489c9b5090e2 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     8
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
489c9b5090e2 Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
489c9b5090e2 Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
489c9b5090e2 Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
489c9b5090e2 Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
489c9b5090e2 Initial load
duke
parents:
diff changeset
    14
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
489c9b5090e2 Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    18
 *
5547
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1
diff changeset
    21
 * questions.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    22
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    23
 */
489c9b5090e2 Initial load
duke
parents:
diff changeset
    24
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    25
#ifndef SHARE_VM_UTILITIES_XMLSTREAM_HPP
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    26
#define SHARE_VM_UTILITIES_XMLSTREAM_HPP
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    27
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    28
#include "runtime/handles.hpp"
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    29
#include "utilities/ostream.hpp"
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    30
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    31
class xmlStream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
class defaultStream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
// Sub-stream for writing quoted text, as opposed to markup.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    35
// Characters written to this stream are subject to quoting,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
// as '<' => "&lt;", etc.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
class xmlTextStream : public outputStream {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    38
  friend class xmlStream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    39
  friend class defaultStream; // tty
489c9b5090e2 Initial load
duke
parents:
diff changeset
    40
 private:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    41
489c9b5090e2 Initial load
duke
parents:
diff changeset
    42
  xmlStream* _outer_xmlStream;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    43
489c9b5090e2 Initial load
duke
parents:
diff changeset
    44
  xmlTextStream() { _outer_xmlStream = NULL; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    45
489c9b5090e2 Initial load
duke
parents:
diff changeset
    46
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    47
   virtual void flush(); // _outer.flush();
489c9b5090e2 Initial load
duke
parents:
diff changeset
    48
   virtual void write(const char* str, size_t len); // _outer->write_text()
489c9b5090e2 Initial load
duke
parents:
diff changeset
    49
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
    50
489c9b5090e2 Initial load
duke
parents:
diff changeset
    51
489c9b5090e2 Initial load
duke
parents:
diff changeset
    52
// Output stream for writing XML-structured logs.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    53
// To write markup, use special calls elem, head/tail, etc.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    54
// Use the xmlStream::text() stream to write unmarked text.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    55
// Text written that way will be quoted as necessary using '&lt;', etc.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
// Characters written directly to an xmlStream via print_cr, etc.,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
// are directly written to the encapsulated stream, xmlStream::out().
489c9b5090e2 Initial load
duke
parents:
diff changeset
    58
// This can be used to produce markup directly, character by character.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    59
// (Such writes are not checked for markup syntax errors.)
489c9b5090e2 Initial load
duke
parents:
diff changeset
    60
489c9b5090e2 Initial load
duke
parents:
diff changeset
    61
class xmlStream : public outputStream {
489c9b5090e2 Initial load
duke
parents:
diff changeset
    62
  friend class defaultStream; // tty
489c9b5090e2 Initial load
duke
parents:
diff changeset
    63
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    64
  enum MarkupState { BODY,       // after end_head() call, in text
489c9b5090e2 Initial load
duke
parents:
diff changeset
    65
                     HEAD,       // after begin_head() call, in attrs
489c9b5090e2 Initial load
duke
parents:
diff changeset
    66
                     ELEM };     // after begin_elem() call, in attrs
489c9b5090e2 Initial load
duke
parents:
diff changeset
    67
489c9b5090e2 Initial load
duke
parents:
diff changeset
    68
 protected:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    69
  outputStream* _out;            // file stream by which it goes
489c9b5090e2 Initial load
duke
parents:
diff changeset
    70
  julong        _last_flush;     // last position of flush
489c9b5090e2 Initial load
duke
parents:
diff changeset
    71
  MarkupState   _markup_state;   // where in the elem/head/tail dance
489c9b5090e2 Initial load
duke
parents:
diff changeset
    72
  outputStream* _text;           // text stream
489c9b5090e2 Initial load
duke
parents:
diff changeset
    73
  xmlTextStream _text_init;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    74
489c9b5090e2 Initial load
duke
parents:
diff changeset
    75
  // for subclasses
489c9b5090e2 Initial load
duke
parents:
diff changeset
    76
  xmlStream() {}
489c9b5090e2 Initial load
duke
parents:
diff changeset
    77
  void initialize(outputStream* out);
489c9b5090e2 Initial load
duke
parents:
diff changeset
    78
489c9b5090e2 Initial load
duke
parents:
diff changeset
    79
  // protect this from public use:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    80
  outputStream* out()                            { return _out; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    81
489c9b5090e2 Initial load
duke
parents:
diff changeset
    82
  // helpers for writing XML elements
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
    83
  void          va_tag(bool push, const char* format, va_list ap) ATTRIBUTE_PRINTF(3, 0);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    84
  virtual void see_tag(const char* tag, bool push) NOT_DEBUG({});
489c9b5090e2 Initial load
duke
parents:
diff changeset
    85
  virtual void pop_tag(const char* tag) NOT_DEBUG({});
489c9b5090e2 Initial load
duke
parents:
diff changeset
    86
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
#ifdef ASSERT
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
  // in debug mode, we verify matching of opening and closing tags
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
  int   _element_depth;              // number of unfinished elements
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
  char* _element_close_stack_high;   // upper limit of down-growing stack
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
  char* _element_close_stack_low;    // upper limit of down-growing stack
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
  char* _element_close_stack_ptr;    // pointer of down-growing stack
489c9b5090e2 Initial load
duke
parents:
diff changeset
    93
#endif
489c9b5090e2 Initial load
duke
parents:
diff changeset
    94
489c9b5090e2 Initial load
duke
parents:
diff changeset
    95
 public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    96
  // creation
489c9b5090e2 Initial load
duke
parents:
diff changeset
    97
  xmlStream(outputStream* out) { initialize(out); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
    98
  DEBUG_ONLY(virtual ~xmlStream();)
489c9b5090e2 Initial load
duke
parents:
diff changeset
    99
489c9b5090e2 Initial load
duke
parents:
diff changeset
   100
  bool is_open() { return _out != NULL; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   101
489c9b5090e2 Initial load
duke
parents:
diff changeset
   102
  // text output
489c9b5090e2 Initial load
duke
parents:
diff changeset
   103
  bool inside_attrs() { return _markup_state != BODY; }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   104
489c9b5090e2 Initial load
duke
parents:
diff changeset
   105
  // flushing
489c9b5090e2 Initial load
duke
parents:
diff changeset
   106
  virtual void flush();  // flushes out, sets _last_flush = count()
489c9b5090e2 Initial load
duke
parents:
diff changeset
   107
  virtual void write(const char* s, size_t len);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   108
  void    write_text(const char* s, size_t len);  // used by xmlTextStream
489c9b5090e2 Initial load
duke
parents:
diff changeset
   109
  int unflushed_count() { return (int)(out()->count() - _last_flush); }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   110
489c9b5090e2 Initial load
duke
parents:
diff changeset
   111
  // writing complete XML elements
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   112
  void          elem(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   113
  void    begin_elem(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   114
  void      end_elem(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   115
  void      end_elem();
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   116
  void          head(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   117
  void    begin_head(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   118
  void      end_head(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   119
  void      end_head();
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   120
  void          done(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);  // xxx_done event, plus tail
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   121
  void          done_raw(const char * kind);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   122
  void          tail(const char* kind);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   123
489c9b5090e2 Initial load
duke
parents:
diff changeset
   124
  // va_list versions
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   125
  void       va_elem(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   126
  void va_begin_elem(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   127
  void       va_head(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   128
  void va_begin_head(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   129
  void       va_done(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   130
489c9b5090e2 Initial load
duke
parents:
diff changeset
   131
  // write text (with quoting of special XML characters <>&'" etc.)
489c9b5090e2 Initial load
duke
parents:
diff changeset
   132
  outputStream* text() { return _text; }
24424
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   133
  void          text(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
2658d7834c6e 8037816: Fix for 8036122 breaks build with Xcode5/clang
drchase
parents: 13728
diff changeset
   134
  void       va_text(const char* format, va_list ap) ATTRIBUTE_PRINTF(2, 0) {
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   135
    text()->vprint(format, ap);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   136
  }
489c9b5090e2 Initial load
duke
parents:
diff changeset
   137
489c9b5090e2 Initial load
duke
parents:
diff changeset
   138
  // commonly used XML attributes
489c9b5090e2 Initial load
duke
parents:
diff changeset
   139
  void          stamp();                 // stamp='1.234'
46727
6e4a84748e2c 8183039: Re-examine methodHandle methods uninlined by 8144256
coleenp
parents: 46329
diff changeset
   140
  void          method(const methodHandle& m);  // method='k n s' ...
46329
53ccc37bda19 8155672: Remove instanceKlassHandles and KlassHandles
coleenp
parents: 24424
diff changeset
   141
  void          klass(Klass* k);         // klass='name'
8076
96d498ec7ae1 6990754: Use native memory and reference counting to implement SymbolTable
coleenp
parents: 7397
diff changeset
   142
  void          name(const Symbol* s);   // name='name'
13728
882756847a04 6964458: Reimplement class meta-data storage to use native memory
coleenp
parents: 8921
diff changeset
   143
  void          object(const char* attr, Metadata* val);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   144
  void          object(const char* attr, Handle val);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   145
489c9b5090e2 Initial load
duke
parents:
diff changeset
   146
  // print the text alone (sans ''):
46727
6e4a84748e2c 8183039: Re-examine methodHandle methods uninlined by 8144256
coleenp
parents: 46329
diff changeset
   147
  void          method_text(const methodHandle& m);
46329
53ccc37bda19 8155672: Remove instanceKlassHandles and KlassHandles
coleenp
parents: 24424
diff changeset
   148
  void          klass_text(Klass* k);         // klass='name'
8076
96d498ec7ae1 6990754: Use native memory and reference counting to implement SymbolTable
coleenp
parents: 7397
diff changeset
   149
  void          name_text(const Symbol* s);   // name='name'
13728
882756847a04 6964458: Reimplement class meta-data storage to use native memory
coleenp
parents: 8921
diff changeset
   150
  void          object_text(Metadata* x);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   151
  void          object_text(Handle x);
489c9b5090e2 Initial load
duke
parents:
diff changeset
   152
489c9b5090e2 Initial load
duke
parents:
diff changeset
   153
  /*  Example uses:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   154
489c9b5090e2 Initial load
duke
parents:
diff changeset
   155
      // Empty element, simple case.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   156
      elem("X Y='Z'");          <X Y='Z'/> \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   157
489c9b5090e2 Initial load
duke
parents:
diff changeset
   158
      // Empty element, general case.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   159
      begin_elem("X Y='Z'");    <X Y='Z'
489c9b5090e2 Initial load
duke
parents:
diff changeset
   160
      ...attrs...               ...attrs...
489c9b5090e2 Initial load
duke
parents:
diff changeset
   161
      end_elem();               />
489c9b5090e2 Initial load
duke
parents:
diff changeset
   162
489c9b5090e2 Initial load
duke
parents:
diff changeset
   163
      // Compound element, simple case.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   164
      head("X Y='Z'");          <X Y='Z'> \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   165
      ...body...                ...body...
489c9b5090e2 Initial load
duke
parents:
diff changeset
   166
      tail("X");                </X> \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   167
489c9b5090e2 Initial load
duke
parents:
diff changeset
   168
      // Compound element, general case.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   169
      begin_head("X Y='Z'");    <X Y='Z'
489c9b5090e2 Initial load
duke
parents:
diff changeset
   170
      ...attrs...               ...attrs...
489c9b5090e2 Initial load
duke
parents:
diff changeset
   171
      end_head();               > \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   172
      ...body...                ...body...
489c9b5090e2 Initial load
duke
parents:
diff changeset
   173
      tail("X");                </X> \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   174
489c9b5090e2 Initial load
duke
parents:
diff changeset
   175
      // Printf-style formatting:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   176
      elem("X Y='%s'", "Z");    <X Y='Z'/> \n
489c9b5090e2 Initial load
duke
parents:
diff changeset
   177
489c9b5090e2 Initial load
duke
parents:
diff changeset
   178
   */
489c9b5090e2 Initial load
duke
parents:
diff changeset
   179
489c9b5090e2 Initial load
duke
parents:
diff changeset
   180
};
489c9b5090e2 Initial load
duke
parents:
diff changeset
   181
489c9b5090e2 Initial load
duke
parents:
diff changeset
   182
// Standard log file, null if no logging is happening.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   183
extern xmlStream* xtty;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   184
489c9b5090e2 Initial load
duke
parents:
diff changeset
   185
// Note:  If ::xtty != NULL, ::tty == ::xtty->text().
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
   186
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
   187
#endif // SHARE_VM_UTILITIES_XMLSTREAM_HPP