hphp/runtime/base/intercept.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 #pragma once
  17
  18 #include <stdint.h>
  19
  20 namespace HPHP {
  21
  22 struct Array;
  23 struct Func;
  24 struct String;
  25 struct Variant;
  26
  27 ///////////////////////////////////////////////////////////////////////////////
  28 // fb_intercept2()
  29
  30 /**
  31  * When an interceptable point is hit, invoke handler with all parameters
  32  * instead. If it returns FALSE, continues execution. Otherwise, return its
  33  * return.
  34  */
  35 bool register_intercept(const String& name, const Variant& callback);
  36
  37 /**
  38  * Check to see if it is actually intercepted for current request.
  39  */
  40 Variant* get_intercept_handler(const Func* func);
  41
  42 /**
  43  * Call intercept handler with original parameters.
  44  */
  45 bool handle_intercept(const Variant& handler, const String& name,
  46                       const Array& params, Variant& ret);
  47
  48 ///////////////////////////////////////////////////////////////////////////////
  49 // fb_rename_function()
  50
  51 void rename_function(const String& old_name, const String& new_name);
  52
  53 ///////////////////////////////////////////////////////////////////////////////
  54
  55 }
  56