HaxeFoundation.haxe/std/cpp/vm/Gc.hx

/*
 * Copyright (C)2005-2012 Haxe Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
package cpp.vm;

class Gc
{
   public static inline var MEM_INFO_USAGE = 0;
   public static inline var MEM_INFO_RESERVED = 1;
   public static inline var MEM_INFO_CURRENT = 2;
   public static inline var MEM_INFO_LARGE = 3;

   static public function enable(inEnable:Bool) : Void
   {
      untyped __global__.__hxcpp_enable(inEnable);
   }

   static public function run(major:Bool) : Void
   {
      untyped __global__.__hxcpp_collect(major);
   }

   static public function compact() : Void
   {
      untyped __global__.__hxcpp_gc_compact();
   }

   // Introduced hxcpp_api_level 310
   // Returns stats on memory usage:
   //   MEM_INFO_USAGE - estimate of how much is needed by program (at last collect)
   //   MEM_INFO_RESERVED - memory allocated for possible use
   //   MEM_INFO_CURRENT - memory in use, includes uncollected garbage.
   //     This will generally saw-tooth between USAGE and RESERVED
   //   MEM_INFO_LARGE - Size of separate pool used for large allocs.  Included in all the above.
   static public function memInfo(inWhatInfo:Int) : Int
   {
      return untyped __global__.__hxcpp_gc_mem_info(inWhatInfo);
   }

   static public function memUsage() : Int
   {
      return untyped __global__.__hxcpp_gc_mem_info(MEM_INFO_USAGE);
   }

   static public function trace(sought:Class<Dynamic>,printInstances:Bool=true) : Int
   {
      return untyped __global__.__hxcpp_gc_trace(sought,printInstances);
   }

   static public function versionCheck() { return true; }

   static public function doNotKill(inObject:Dynamic) : Void
   {
      untyped __global__.__hxcpp_gc_do_not_kill(inObject);
   }

   static public function getNextZombie() : Dynamic
   {
      return untyped __global__.__hxcpp_get_next_zombie();
   }

   static public function safePoint() : Void
   {
      untyped __global__.__hxcpp_gc_safe_point();
   }

   static public function enterGCFreeZone() : Void
   {
      untyped __global__.__hxcpp_enter_gc_free_zone();
   }

   static public function exitGCFreeZone() : Void
   {
      untyped __global__.__hxcpp_exit_gc_free_zone();
   }
}