/*
 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
 *
 *  This file is licensed to You under the Eclipse Public License (EPL);
 *  You may not use this file except in compliance with the License. You
 *  may obtain a copy of the License at
 *
 *      http://www.opensource.org/licenses/eclipse-1.0.php
 *
 *  See the COPYRIGHT.txt file distributed with this work for information
 *  regarding copyright ownership.
 */
package org.mmtk.utility.gcspy;

/**
 * This class provides constants used by the GCspy framweork.
 * These must correspond with values in gcspy_stream.h
 * <table>
      <caption>Presentation</caption>
      <tr><td>PRESENTATION_PLAIN</td>      <td>presented as is</td>
      <tr><td>PRESENTATION_PLUS</td>       <td>as max+ if value exceeds max else as is</td>
      <tr><td>PRESENTATION_MAX_VAR</td>    <td>ditto but takes max value from a specified stream</td>
      <tr><td>PRESENTATION_PERCENT</td>    <td>as value (percent)</td>
      <tr><td>PRESENTATION_PERCENT_VAR</td><td>ditto but takes max value from a specified stream</td>
      <tr><td>PRESENTATION_ENUM </td>      <td>chooses from an enumeration</td>
   </table>
   <table>
      <caption>Paint style</caption>
      <tr><td>PAINT_STYLE_PLAIN</td>       <td>Paints as is</td>
      <tr><td>PAINT_STYLE_ZERO</td>        <td>ditto but treats zero values specially</td>
   </table>
   <table>
      <caption>Data types</caption>
      <tr><td>BYTE_TYPE</td>  <td>stream of bytes</td>
      <tr><td>SHORT_TYPE</td> <td>stream of shorts</td>
      <tr><td>INT_TYPE</td>   <td>stream of ints</td>
   </table>
 * StreamConstants
 */

public final class StreamConstants {

  public static final int NAME_LEN = 40;
  public static final int PRESENTATION_PLAIN       = 0;
  public static final int PRESENTATION_PLUS        = 1;
  public static final int PRESENTATION_MAX_VAR     = 2;
  public static final int PRESENTATION_PERCENT     = 3;
  public static final int PRESENTATION_PERCENT_VAR = 4;
  public static final int PRESENTATION_ENUM        = 5;

  public static final int PAINT_STYLE_PLAIN = 0;
  public static final int PAINT_STYLE_ZERO  = 1;

  public static final int BYTE_TYPE  = 0;
  public static final int SHORT_TYPE = 1;
  public static final int INT_TYPE   = 2;

  public static final int ENUM_MAX_LEN = 20;
  public static final int ENUM_MAX_NUM = 5;

  private StreamConstants() {
    // prevent instantiation
  }
}