hphp/hack/src/typing/typing_defs_flags.ml

   1 (*
   2  * Copyright (c) 2015, Facebook, Inc.
   3  * All rights reserved.
   4  *
   5  * This source code is licensed under the MIT license found in the
   6  * LICENSE file in the "hack" directory of this source tree.
   7  *
   8  *)
   9
  10 open Hh_prelude
  11
  12 type fun_type_flags = int
  13
  14 type fun_param_flags = int
  15
  16 (* Is this bit set in the flags? *)
  17 let is_set bit flags = not (Int.equal 0 (Int.bit_and bit flags))
  18
  19 (* Set a single bit to a boolean value *)
  20 let set_bit bit value flags =
  21   if value then
  22     Int.bit_or bit flags
  23   else
  24     Int.bit_and (Int.bit_not bit) flags
  25
  26 [@@@ocamlformat "disable"]
  27
  28 (* NB: Keep the values of these flags in sync with typing_defs_flags.rs. *)
  29
  30 (* Function type flags *)
  31 let ft_flags_return_disposable  = 1 lsl 0
  32
  33 let ft_flags_returns_mutable    = 1 lsl 1
  34
  35 let ft_flags_returns_void_to_rx = 1 lsl 2
  36
  37 let ft_flags_is_coroutine       = 1 lsl 3
  38
  39 let ft_flags_async              = 1 lsl 4
  40
  41 let ft_flags_generator          = 1 lsl 5
  42
  43 (* These flags are used for the self type on FunType and the parameter type on FunParam *)
  44 let mutable_flags_owned         = 1 lsl 6
  45
  46 let mutable_flags_borrowed      = 1 lsl 7
  47
  48 let mutable_flags_maybe         = Int.bit_or mutable_flags_owned mutable_flags_borrowed
  49
  50 let mutable_flags_mask          = Int.bit_or mutable_flags_owned mutable_flags_borrowed
  51
  52 let ft_flags_instantiated_targs = 1 lsl 8
  53
  54 let ft_flags_is_function_pointer = 1 lsl 9
  55
  56 let ft_flags_returns_readonly = 1 lsl 10
  57
  58 let ft_flags_readonly_this = 1 lsl 11
  59
  60 (* Class element flags *)
  61 let ce_flags_abstract            = 1 lsl 0
  62
  63 let ce_flags_final               = 1 lsl 1
  64
  65 let ce_flags_override            = 1 lsl 2
  66
  67 let ce_flags_lsb                 = 1 lsl 3
  68
  69 let ce_flags_synthesized         = 1 lsl 5
  70
  71 let ce_flags_const               = 1 lsl 6
  72
  73 let ce_flags_lateinit            = 1 lsl 7
  74
  75 let ce_flags_dynamicallycallable = 1 lsl 8
  76
  77 (* Three bits used to encode optional XHP attr.
  78  * Set 1<<10 (0x400) if xa_has_default=true
  79  * Then encode xa_tag as follows:
  80  *   Some Required: 1<<11 (0x0800)
  81  *   Some lateinit: 1<<12 (0x1000)
  82  *   None:          1<<11 | 1<<12 (0x1800)
  83  * If attr is not present at all, then masking with 0x1800 will produce zero.
  84  *)
  85 let ce_flags_xa_has_default      = 1 lsl 10
  86
  87 let ce_flags_xa_tag_required     = 1 lsl 11
  88
  89 let ce_flags_xa_tag_lateinit     = 1 lsl 12
  90
  91 let ce_flags_xa_tag_none         = Int.bit_or ce_flags_xa_tag_required ce_flags_xa_tag_lateinit
  92
  93 let ce_flags_xa_tag_mask         = Int.bit_or ce_flags_xa_tag_required ce_flags_xa_tag_lateinit
  94
  95 let ce_flags_readonly_prop            = 1 lsl 13
  96
  97 (* fun_param flags *)
  98 let fp_flags_accept_disposable = 1 lsl 0
  99
 100 let fp_flags_inout             = 1 lsl 1
 101
 102 let fp_flags_has_default       = 1 lsl 2
 103
 104 let fp_flags_ifc_external      = 1 lsl 3
 105
 106 let fp_flags_ifc_can_call      = 1 lsl 4
 107
 108 let fp_flags_atom              = 1 lsl 5
 109
 110 (* 6 and 7 are taken by mutability parameters above *)
 111 let fp_flags_readonly          = 1 lsl 8