hphp/hhbbc/class-util.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2014 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 #ifndef incl_HHBBC_CLASS_UTIL_H_
  17 #define incl_HHBBC_CLASS_UTIL_H_
  18
  19 #include "hphp/hhbbc/misc.h"
  20 #include "hphp/hhbbc/representation.h"
  21
  22 namespace HPHP { namespace HHBBC {
  23
  24 namespace res { struct Class; }
  25 namespace php { struct Class; }
  26 struct Type;
  27
  28 //////////////////////////////////////////////////////////////////////
  29
  30 /*
  31  * Returns whether a res::Class refers to a collection class.
  32  */
  33 bool is_collection(res::Class);
  34
  35 /*
  36  * Returns whether a php::Class is a closure.
  37  */
  38 bool is_closure(const php::Class&);
  39
  40 /*
  41  * Returns whether a Type could hold an object that has a custom
  42  * boolean conversion function.
  43  */
  44 bool could_have_magic_bool_conversion(Type);
  45
  46 /*
  47  * Returns method named "name" if it exists.
  48  */
  49 borrowed_ptr<php::Func> find_method(borrowed_ptr<const php::Class>,
  50                                     SString name);
  51
  52 /*
  53  * Returns true if `name' is the name of an internal VM special class
  54  * method.  (Not callable directly by php code.)
  55  */
  56 bool is_special_method_name(SString name);
  57
  58 /*
  59  * Returns true if a class has the __MockClass user attribute.  This
  60  * attribute allows final methods and final classes to be overridden.
  61  */
  62 bool is_mock_class(borrowed_ptr<const php::Class>);
  63
  64 //////////////////////////////////////////////////////////////////////
  65
  66 }}
  67
  68 #endif