hphp/runtime/base/code-coverage.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_EVAL_CODE_COVERAGE_H_
  18 #define incl_HPHP_EVAL_CODE_COVERAGE_H_
  19
  20 #include "hphp/util/hash-map-typedefs.h"
  21
  22 #include <string>
  23 #include <vector>
  24
  25 namespace HPHP {
  26 ///////////////////////////////////////////////////////////////////////////////
  27
  28 struct Array;
  29
  30 struct CodeCoverage {
  31   static constexpr int kLineExecuted = 1;
  32
  33   void Record(const char* filename, int line0, int line1);
  34
  35   /*
  36    * Returns an array in this format,
  37    *
  38    *  array('filename' => array( line => count, ...))
  39    *
  40    * If sys is passed as false, systemlib files are not included.
  41    */
  42   Array Report(bool sys = true);
  43
  44   /*
  45    * Write JSON format into the file.
  46    *
  47    *  { 'filename': [0, 0, 1, 0, 2, 0], ...}
  48    *
  49    * Note it's 0-indexed, so first count should always be 0.
  50    */
  51   void Report(const std::string& filename);
  52
  53   /*
  54    * Clear all coverage data.
  55    */
  56   void Reset();
  57
  58 private:
  59   typedef hphp_const_char_map<std::vector<int>> CodeCoverageMap;
  60   CodeCoverageMap m_hits;
  61 };
  62
  63 ///////////////////////////////////////////////////////////////////////////////
  64 }
  65
  66 #endif // incl_HPHP_EVAL_CODE_COVERAGE_H_