hphp/runtime/base/array-helpers.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #ifndef incl_HPHP_ARRAY_HELPERS_H_
  18 #define incl_HPHP_ARRAY_HELPERS_H_
  19
  20 #include "hphp/runtime/base/datatype.h"
  21 #include "hphp/runtime/base/tv-mutate.h"
  22 #include "hphp/runtime/base/typed-value.h"
  23
  24 namespace HPHP {
  25
  26 ///////////////////////////////////////////////////////////////////////////////
  27
  28 /*
  29  * Initialize a new array element.
  30  */
  31 ALWAYS_INLINE void initElem(TypedValue& elem, Cell v) {
  32   cellDup(v, elem);
  33   if (UNLIKELY(elem.m_type == KindOfUninit)) {
  34     elem.m_type = KindOfNull;
  35   }
  36 }
  37
  38 /*
  39  * Modify an array element, with semantics like those in tv-mutate.h.
  40  *
  41  * These functions all promote uninit null values to init null values, except
  42  * for setElemWithRef() which asserts that `v' is init instead.
  43  */
  44 ALWAYS_INLINE void setElemNoRef(Cell& elem, Cell v) {
  45   if (UNLIKELY(v.m_type == KindOfUninit)) {
  46     v.m_type = KindOfNull;
  47   }
  48   cellSet(v, elem);
  49 }
  50 ALWAYS_INLINE void setElem(TypedValue& elem, Cell v) {
  51   setElemNoRef(*tvToCell(&elem), v);
  52 }
  53
  54 ALWAYS_INLINE void setElemWithRef(TypedValue& elem, TypedValue v) {
  55   assertx(UNLIKELY(v.m_type != KindOfUninit));
  56   tvSetWithRef(v, elem);
  57 }
  58
  59 ///////////////////////////////////////////////////////////////////////////////
  60
  61 }
  62
  63 #endif