Coverage API revamp

runtime/vm/coverage.cc

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "vm/coverage.h"
 
 #include "include/dart_api.h"
 
 #include "vm/compiler.h"
 #include "vm/isolate.h"
 #include "vm/json_stream.h"
 #include "vm/object.h"
 #include "vm/object_store.h"
 
 namespace dart {
 
 DEFINE_FLAG(charp, coverage_dir, NULL,
             "Enable writing coverage data into specified directory.");
 
 
+class CoverageFilterAll : public CoverageFilter {
+ public:
+  bool ShouldOutputCoverageFor(const Library& lib,
+                               const String& script_url,
+                               const Class& cls,
+                               const Function& func) const {
+    return true;
+  }
+  ~CoverageFilterAll() {}

[Cutch, 2014/06/27 17:20:12]

Destructor is not necessary

[Michael Lippautz (Google), 2014/06/27 17:51:24]

Done.

+};
+
+
 // map[token_pos] -> line-number.
 static void ComputeTokenPosToLineNumberMap(const Script& script,
                                            GrowableArray<intptr_t>* map) {
   const TokenStream& tkns = TokenStream::Handle(script.tokens());
   const intptr_t len = ExternalTypedData::Handle(tkns.GetStream()).Length();
   map->SetLength(len);
 #if defined(DEBUG)
   for (intptr_t i = 0; i < len; i++) {
     (*map)[i] = -1;
   }
 #endif
   TokenStream::Iterator tkit(tkns, 0, TokenStream::Iterator::kAllTokens);
   intptr_t cur_line = script.line_offset() + 1;
   while (tkit.CurrentTokenKind() != Token::kEOS) {
     (*map)[tkit.CurrentPosition()] = cur_line;
     if (tkit.CurrentTokenKind() == Token::kNEWLINE) {
       cur_line++;
     }
     tkit.Advance();
   }
 }
 
 
-static inline void PrintJSONPreamble(JSONObject* jsobj) {
-  jsobj->AddProperty("type", "CodeCoverage");
-  jsobj->AddProperty("id", "coverage");
-}
-
-
 void CodeCoverage::CompileAndAdd(const Function& function,
                                  const JSONArray& hits_arr,
                                  const GrowableArray<intptr_t>& pos_to_line) {
   Isolate* isolate = Isolate::Current();
   if (!function.HasCode()) {
     // If the function should not be compiled or if the compilation failed,
     // then just skip this method.
     // TODO(iposva): Maybe we should skip synthesized methods in general too.
     if (function.is_abstract() || function.IsRedirectingFactory()) {
       return;
@@ skipping 62 matching lines @@
     }
   }
   // Write last hit value if needed.
   if (last_line != -1) {
     hits_arr.AddValue(last_line);
     hits_arr.AddValue(last_count);
   }
 }
 
 
-void CodeCoverage::PrintClass(const Class& cls,
+void CodeCoverage::PrintClass(const Library& lib,
+                              const Class& cls,
                               const JSONArray& jsarr,
-                              const Script& script_filter) {
+                              CoverageFilter* filter) {
   Isolate* isolate = Isolate::Current();
   if (cls.EnsureIsFinalized(isolate) != Error::null()) {
     // Only classes that have been finalized do have a meaningful list of
     // functions.
     return;
   }
   Array& functions = Array::Handle(cls.functions());
   ASSERT(!functions.IsNull());
   Function& function = Function::Handle();
   Script& script = Script::Handle();
   String& saved_url = String::Handle();
   String& url = String::Handle();
   GrowableArray<intptr_t> pos_to_line;
   int i = 0;
   while (i < functions.Length()) {
     HANDLESCOPE(isolate);
     function ^= functions.At(i);
     script = function.script();
-    if (!script_filter.IsNull() && script_filter.raw() != script.raw()) {
+    saved_url = script.url();
+    if (!filter->ShouldOutputCoverageFor(lib, saved_url, cls, function)) {
       i++;
       continue;
     }
-    saved_url = script.url();
     ComputeTokenPosToLineNumberMap(script, &pos_to_line);
     JSONObject jsobj(&jsarr);
     jsobj.AddProperty("source", saved_url.ToCString());
     jsobj.AddProperty("script", script);
     JSONArray hits_arr(&jsobj, "hits");
 
     // We stay within this loop while we are seeing functions from the same
     // source URI.
     while (i < functions.Length()) {
       function ^= functions.At(i);
@@ skipping 16 matching lines @@
       GrowableObjectArray::Handle(cls.closures());
   if (!closures.IsNull()) {
     i = 0;
     pos_to_line.Clear();
     // We need to keep rechecking the length of the closures array, as handling
     // a closure potentially adds new entries to the end.
     while (i < closures.Length()) {
       HANDLESCOPE(isolate);
       function ^= closures.At(i);
       script = function.script();
-      if (!script_filter.IsNull() && script_filter.raw() != script.raw()) {
+      saved_url = script.url();
+      if (!filter->ShouldOutputCoverageFor(lib, saved_url, cls, function)) {
         i++;
         continue;
       }
-      saved_url = script.url();
       ComputeTokenPosToLineNumberMap(script, &pos_to_line);
       JSONObject jsobj(&jsarr);
       jsobj.AddProperty("source", saved_url.ToCString());
       jsobj.AddProperty("script", script);
       JSONArray hits_arr(&jsobj, "hits");
 
       // We stay within this loop while we are seeing functions from the same
       // source URI.
       while (i < closures.Length()) {
         function ^= closures.At(i);
         script = function.script();
         url = script.url();
         if (!url.Equals(saved_url)) {
           pos_to_line.Clear();
           break;
         }
         CompileAndAdd(function, hits_arr, pos_to_line);
         i++;
       }
     }
   }
 }
 
 
-void CodeCoverage::PrintJSONForClass(const Class& cls,
-                                     JSONStream* stream) {
-  JSONObject coverage(stream);
-  PrintJSONPreamble(&coverage);
-  {
-    JSONArray jsarr(&coverage, "coverage");
-    PrintClass(cls, jsarr, Script::Handle());
-  }
-}
-
-
-void CodeCoverage::PrintJSONForLibrary(const Library& lib,
-                                       const Script& script_filter,
-                                       JSONStream* stream) {
-  Class& cls = Class::Handle();
-  JSONObject coverage(stream);
-  PrintJSONPreamble(&coverage);
-  {
-    JSONArray jsarr(&coverage, "coverage");
-    ClassDictionaryIterator it(lib, ClassDictionaryIterator::kIteratePrivate);
-    while (it.HasNext()) {
-      cls = it.GetNextClass();
-      ASSERT(!cls.IsNull());
-      PrintClass(cls, jsarr, script_filter);
-    }
-  }
-}
-
-
-void CodeCoverage::PrintJSONForScript(const Script& script,
-                                      JSONStream* stream) {
-  Library& lib = Library::Handle();
-  lib = script.FindLibrary();
-  ASSERT(!lib.IsNull());
-  PrintJSONForLibrary(lib, script, stream);
-}
-
-
 void CodeCoverage::Write(Isolate* isolate) {
   if (FLAG_coverage_dir == NULL) {
     return;
   }
 
   Dart_FileOpenCallback file_open = Isolate::file_open_callback();
   Dart_FileWriteCallback file_write = Isolate::file_write_callback();
   Dart_FileCloseCallback file_close = Isolate::file_close_callback();
   if ((file_open == NULL) || (file_write == NULL) || (file_close == NULL)) {
     return;
   }
 
   JSONStream stream;
-  PrintJSON(isolate, &stream);
+  PrintJSON(isolate, &stream, NULL);
 
   const char* format = "%s/dart-cov-%" Pd "-%" Pd ".json";
   intptr_t pid = OS::ProcessId();
   intptr_t len = OS::SNPrint(NULL, 0, format,
                              FLAG_coverage_dir, pid, isolate->main_port());
   char* filename = Isolate::Current()->current_zone()->Alloc<char>(len + 1);
   OS::SNPrint(filename, len + 1, format,
               FLAG_coverage_dir, pid, isolate->main_port());
   void* file = (*file_open)(filename, true);
   if (file == NULL) {
     OS::Print("Failed to write coverage file: %s\n", filename);
     return;
   }
   (*file_write)(stream.buffer()->buf(), stream.buffer()->length(), file);
   (*file_close)(file);
 }
 
 
-void CodeCoverage::PrintJSON(Isolate* isolate, JSONStream* stream) {
+void CodeCoverage::PrintJSON(Isolate* isolate,
+                             JSONStream* stream,
+                             CoverageFilter* filter) {
+  CoverageFilterAll default_filter;
+  if (filter == NULL) {
+    filter = &default_filter;
+  }
   const GrowableObjectArray& libs = GrowableObjectArray::Handle(
       isolate, isolate->object_store()->libraries());
   Library& lib = Library::Handle();
   Class& cls = Class::Handle();
   JSONObject coverage(stream);
   coverage.AddProperty("type", "CodeCoverage");
   coverage.AddProperty("id", "coverage");
   {
     JSONArray jsarr(&coverage, "coverage");
     for (int i = 0; i < libs.Length(); i++) {
       lib ^= libs.At(i);
       ClassDictionaryIterator it(lib, ClassDictionaryIterator::kIteratePrivate);
       while (it.HasNext()) {
         cls = it.GetNextClass();
         ASSERT(!cls.IsNull());
-        PrintClass(cls, jsarr, Script::Handle());
+        PrintClass(lib, cls, jsarr, filter);
       }
     }
   }
 }
 
 
 }  // namespace dart