/*
 * Copyright 2000 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 *
 */

package sun.jvm.hotspot.debugger.win32.coff;

/** Models the information stored in the optional header of a Portable
    Executable file. */

public interface OptionalHeader {
  /** Magic number for a PE32 file */
  public static final short MAGIC_PE32 = (short) 0x10B;

  /** Magic number for a PE32+ file */
  public static final short MAGIC_PE32_PLUS = (short) 0x20B;

  /** Magic number for a "ROM image" */
  public static final short MAGIC_ROM_IMAGE = (short) 0x107;

  /** Returns the magic number of the Optional Header ({@link
      #MAGIC_PE32}, {@link #MAGIC_PE32_PLUS}, or {@link
      #MAGIC_ROM_IMAGE}) */
  public short getMagicNumber();

  /** These are defined for all implementations of COFF, including
      UNIX. */
  public OptionalHeaderStandardFields getStandardFields();

  /** These include additional fields to support specific features of
      Windows (for example, subsystem). */
  public OptionalHeaderWindowsSpecificFields getWindowsSpecificFields();

  /** Gets the data directories portion of the optional header. */
  public OptionalHeaderDataDirectories getDataDirectories();
}