/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sts=2 et sw=2 tw=80:
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef vm_BytecodeFormatFlags_h
#define vm_BytecodeFormatFlags_h

/*
 * [SMDOC] Bytecode Format flags (JOF_*)
 */
enum {
  JOF_BYTE = 0,         /* single bytecode, no immediates */
  JOF_UINT8 = 1,        /* unspecified uint8_t argument */
  JOF_UINT16 = 2,       /* unspecified uint16_t argument */
  JOF_UINT24 = 3,       /* unspecified uint24_t argument */
  JOF_UINT32 = 4,       /* unspecified uint32_t argument */
  JOF_INT8 = 5,         /* int8_t literal */
  JOF_INT32 = 6,        /* int32_t literal */
  JOF_JUMP = 7,         /* int32_t jump offset */
  JOF_TABLESWITCH = 8,  /* table switch */
  JOF_ENVCOORD = 9,     /* embedded ScopeCoordinate immediate */
  JOF_ARGC = 10,        /* uint16_t argument count */
  JOF_QARG = 11,        /* function argument index */
  JOF_LOCAL = 12,       /* var or block-local variable */
  JOF_RESUMEINDEX = 13, /* yield or await resume index */
  JOF_DOUBLE = 14,      /* inline DoubleValue */
  JOF_GCTHING = 15,     /* uint32_t generic gc-thing index */
  JOF_ATOM = 16,        /* uint32_t constant index */
  JOF_OBJECT = 17,      /* uint32_t object index */
  JOF_REGEXP = 18,      /* uint32_t regexp index */
  JOF_SCOPE = 19,       /* uint32_t scope index */
  JOF_BIGINT = 20,      /* uint32_t index for BigInt value */
  JOF_ICINDEX = 21,     /* uint32_t IC index */
  JOF_LOOPHEAD = 22,    /* JSOp::LoopHead, combines JOF_ICINDEX and JOF_UINT8 */
  JOF_TWO_UINT8 = 23,   /* A pair of unspecified uint8_t arguments */
  JOF_DEBUGCOORD = 24,  /* An embedded ScopeCoordinate immediate that may
                           traverse DebugEnvironmentProxies*/
  JOF_SHAPE = 25,       /* uint32_t shape index */
  JOF_STRING = 26,      /* uint32_t constant index */
  JOF_TYPEMASK = 0xFF,  /* mask for above immediate types */

  JOF_NAME = 1 << 8,        /* name operation */
  JOF_PROP = 2 << 8,        /* obj.prop operation */
  JOF_ELEM = 3 << 8,        /* obj[index] operation */
  JOF_MODEMASK = 0xFF << 8, /* mask for above addressing modes */

  JOF_PROPSET = 1 << 16,     /* property/element/name set operation */
  JOF_PROPINIT = 1 << 17,    /* property/element/name init operation */
  JOF_CHECKSLOPPY = 1 << 18, /* op can only be generated in sloppy mode */
  JOF_CHECKSTRICT = 1 << 19, /* op can only be generated in strict mode */
  JOF_INVOKE = 1 << 20,      /* any call, construct, or eval instruction */
  JOF_CONSTRUCT = 1 << 21,   /* invoke instruction using [[Construct]] entry */
  JOF_SPREAD = 1 << 22,      /* invoke instruction using spread argument */
  JOF_GNAME = 1 << 23,       /* predicted global name */
  JOF_IC = 1 << 24,          /* baseline may use an IC for this op */
  JOF_USES_ENV = 1 << 25,    /* op uses the frame's environment chain */
};

#endif /* vm_BytecodeFormatFlags_h */