Maintain API compatibility with older versions of V8.

include/v8-profiler.h

 // Copyright 2010 the V8 project authors. All rights reserved.
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 //
 //     * Redistributions of source code must retain the above copyright
 //       notice, this list of conditions and the following disclaimer.
 //     * Redistributions in binary form must reproduce the above
 //       copyright notice, this list of conditions and the following
 //       disclaimer in the documentation and/or other materials provided
@@ skipping 87 matching lines @@
 
   /** Returns the count of samples where function exists. */
   double GetTotalSamplesCount() const;
 
   /** Returns the count of samples where function was currently executing. */
   double GetSelfSamplesCount() const;
 
   /** Returns function entry UID. */
   unsigned GetCallUid() const;
 
-  /** Returns id of the node. The id is unique within the tree */
-  unsigned GetNodeId() const;
-
   /** Returns child nodes count of the node. */
   int GetChildrenCount() const;
 
   /** Retrieves a child node by index. */
   const CpuProfileNode* GetChild(int index) const;
 
   static const int kNoLineNumberInfo = Message::kNoLineNumberInfo;
 };
 
 
 /**
  * CpuProfile contains a CPU profile in a form of top-down call tree
  * (from main() down to functions that do all the work).
  */
 class V8EXPORT CpuProfile {
  public:
   /** Returns CPU profile UID (assigned by the profiler.) */
   unsigned GetUid() const;
 
   /** Returns CPU profile title. */
   Handle<String> GetTitle() const;
 
   /** Returns the root node of the top down call tree. */
   const CpuProfileNode* GetTopDownRoot() const;
 
   /**
-    * Returns number of samples recorded. The samples are not recorded unless
-    * |record_samples| parameter of CpuProfiler::StartCpuProfiling is true.
-    */
-  int GetSamplesCount() const;
-
-  /**
-    * Returns profile node corresponding to the top frame the sample at
-    * the given index.
-    */
-  const CpuProfileNode* GetSample(int index) const;
-
-  /**
    * Deletes the profile and removes it from CpuProfiler's list.
    * All pointers to nodes previously returned become invalid.
    * Profiles with the same uid but obtained using different
    * security token are not deleted, but become inaccessible
    * using FindProfile method. It is embedder's responsibility
    * to call Delete on these profiles.
    */
   void Delete();
 };
 
 
 /**
- * Interface for controlling CPU profiling. Instance of the
- * profiler can be retrieved using v8::Isolate::GetCpuProfiler.
+ * Interface for controlling CPU profiling.
  */
 class V8EXPORT CpuProfiler {
  public:
   /**
    * A note on security tokens usage. As scripts from different
    * origins can run inside a single V8 instance, it is possible to
    * have functions from different security contexts intermixed in a
    * single CPU profile. To avoid exposing function names belonging to
    * other contexts, filtering by security token is performed while
    * obtaining profiling results.
    */
 
-  /** Deprecated. Use GetProfileCount instead. */
-  static int GetProfilesCount();
   /**
    * Returns the number of profiles collected (doesn't include
    * profiles that are being collected at the moment of call.)
    */
-  int GetProfileCount();
+  static int GetProfilesCount();
 
-  /** Deprecated. Use GetCpuProfile instead. */
+  /** Returns a profile by index. */
   static const CpuProfile* GetProfile(
       int index,
       Handle<Value> security_token = Handle<Value>());
-  /** Returns a profile by index. */
-  const CpuProfile* GetCpuProfile(
-      int index,
-      Handle<Value> security_token = Handle<Value>());
 
-  /** Deprecated. Use FindProfile instead. */
+  /** Returns a profile by uid. */
   static const CpuProfile* FindProfile(
       unsigned uid,
       Handle<Value> security_token = Handle<Value>());
-  /** Returns a profile by uid. */
-  const CpuProfile* FindCpuProfile(
-      unsigned uid,
-      Handle<Value> security_token = Handle<Value>());
 
-  /** Deprecated. Use StartCpuProfiling instead. */
-  static void StartProfiling(Handle<String> title, bool record_samples = false);
   /**
    * Starts collecting CPU profile. Title may be an empty string. It
    * is allowed to have several profiles being collected at
    * once. Attempts to start collecting several profiles with the same
    * title are silently ignored. While collecting a profile, functions
    * from all security contexts are included in it. The token-based
    * filtering is only performed when querying for a profile.
-   *
-   * |record_samples| parameter controls whether individual samples should
-   * be recorded in addition to the aggregated tree.
    */
-  void StartCpuProfiling(Handle<String> title, bool record_samples = false);
+  static void StartProfiling(Handle<String> title);
 
-  /** Deprecated. Use StopCpuProfiling instead. */
-  static const CpuProfile* StopProfiling(
-      Handle<String> title,
-      Handle<Value> security_token = Handle<Value>());
   /**
    * Stops collecting CPU profile with a given title and returns it.
    * If the title given is empty, finishes the last profile started.
    */
-  const CpuProfile* StopCpuProfiling(
+  static const CpuProfile* StopProfiling(
       Handle<String> title,
       Handle<Value> security_token = Handle<Value>());
 
-  /** Deprecated. Use DeleteAllCpuProfiles instead. */
-  static void DeleteAllProfiles();
   /**
    * Deletes all existing profiles, also cancelling all profiling
    * activity.  All previously returned pointers to profiles and their
    * contents become invalid after this call.
    */
-  void DeleteAllCpuProfiles();
-
- private:
-  CpuProfiler();
-  ~CpuProfiler();
-  CpuProfiler(const CpuProfiler&);
-  CpuProfiler& operator=(const CpuProfiler&);
+  static void DeleteAllProfiles();
 };
 
 
 class HeapGraphNode;
 
 
 /**
  * HeapSnapshotEdge represents a directed connection between heap
  * graph nodes: from retainers to retained nodes.
  */
@@ skipping 87 matching lines @@
  */
 class V8EXPORT HeapSnapshot {
  public:
   enum Type {
     kFull = 0  // Heap snapshot with all instances and references.
   };
   enum SerializationFormat {
     kJSON = 0  // See format description near 'Serialize' method.
   };
 
-  /** Deprecated. Returns kFull. */
-  V8_DEPRECATED(Type GetType() const);
+  /** Returns heap snapshot type. */
+  Type GetType() const;
 
   /** Returns heap snapshot UID (assigned by the profiler.) */
   unsigned GetUid() const;
 
   /** Returns heap snapshot title. */
   Handle<String> GetTitle() const;
 
   /** Returns the root node of the heap graph. */
   const HeapGraphNode* GetRoot() const;
 
@@ skipping 42 matching lines @@
    * Nodes reference strings, other nodes, and edges by their indexes
    * in corresponding arrays.
    */
   void Serialize(OutputStream* stream, SerializationFormat format) const;
 };
 
 
 class RetainedObjectInfo;
 
 /**
- * Interface for controlling heap profiling. Instance of the
- * profiler can be retrieved using v8::Isolate::GetHeapProfiler.
+ * Interface for controlling heap profiling.
  */
 class V8EXPORT HeapProfiler {
  public:
   /**
    * Callback function invoked for obtaining RetainedObjectInfo for
    * the given JavaScript wrapper object. It is prohibited to enter V8
    * while the callback is running: only getters on the handle and
    * GetPointerFromInternalField on the objects are allowed.
    */
   typedef RetainedObjectInfo* (*WrapperInfoCallback)
       (uint16_t class_id, Handle<Value> wrapper);
 
-  /** Deprecated. Use GetSnapshotCount instead. */
+  /** Returns the number of snapshots taken. */
   static int GetSnapshotsCount();
-  /** Returns the number of snapshots taken. */
-  int GetSnapshotCount();
 
-  /** Deprecated. Use GetHeapSnapshot instead. */
+  /** Returns a snapshot by index. */
   static const HeapSnapshot* GetSnapshot(int index);
-  /** Returns a snapshot by index. */
-  const HeapSnapshot* GetHeapSnapshot(int index);
 
-  /** Deprecated. Use FindHeapSnapshot instead. */
+  /** Returns a profile by uid. */
   static const HeapSnapshot* FindSnapshot(unsigned uid);
-  /** Returns a profile by uid. */
-  const HeapSnapshot* FindHeapSnapshot(unsigned uid);
 
-  /** Deprecated. Use GetObjectId instead. */
-  static SnapshotObjectId GetSnapshotObjectId(Handle<Value> value);
   /**
    * Returns SnapshotObjectId for a heap object referenced by |value| if
    * it has been seen by the heap profiler, kUnknownObjectId otherwise.
    */
-  SnapshotObjectId GetObjectId(Handle<Value> value);
+  static SnapshotObjectId GetSnapshotObjectId(Handle<Value> value);
 
   /**
    * A constant for invalid SnapshotObjectId. GetSnapshotObjectId will return
    * it in case heap profiler cannot find id  for the object passed as
    * parameter. HeapSnapshot::GetNodeById will always return NULL for such id.
    */
   static const SnapshotObjectId kUnknownObjectId = 0;
 
   /**
    * Callback interface for retrieving user friendly names of global objects.
    */
   class ObjectNameResolver {
-   public:
+  public:
     /**
      * Returns name to be used in the heap snapshot for given node. Returned
      * string must stay alive until snapshot collection is completed.
      */
     virtual const char* GetName(Handle<Object> object) = 0;
-   protected:
+  protected:
     virtual ~ObjectNameResolver() {}
   };
 
-  /** Deprecated. Use TakeHeapSnapshot instead. */
+  /**
+   * Takes a heap snapshot and returns it. Title may be an empty string.
+   * See HeapSnapshot::Type for types description.
+   */
   static const HeapSnapshot* TakeSnapshot(
       Handle<String> title,
       HeapSnapshot::Type type = HeapSnapshot::kFull,
       ActivityControl* control = NULL,
       ObjectNameResolver* global_object_name_resolver = NULL);
-  /**
-   * Takes a heap snapshot and returns it. Title may be an empty string.
-   */
-  const HeapSnapshot* TakeHeapSnapshot(
-      Handle<String> title,
-      ActivityControl* control = NULL,
-      ObjectNameResolver* global_object_name_resolver = NULL);
 
-
-  /** Deprecated. Use StartTrackingHeapObjects instead. */
-  static void StartHeapObjectsTracking();
   /**
    * Starts tracking of heap objects population statistics. After calling
    * this method, all heap objects relocations done by the garbage collector
    * are being registered.
    */
-  void StartTrackingHeapObjects();
+  static void StartHeapObjectsTracking();
 
-  /** Deprecated. Use GetHeapStats instead. */
-  static SnapshotObjectId PushHeapObjectsStats(OutputStream* stream);
   /**
    * Adds a new time interval entry to the aggregated statistics array. The
    * time interval entry contains information on the current heap objects
    * population size. The method also updates aggregated statistics and
    * reports updates for all previous time intervals via the OutputStream
    * object. Updates on each time interval are provided as a stream of the
    * HeapStatsUpdate structure instances.
    * The return value of the function is the last seen heap object Id.
    *
-   * StartTrackingHeapObjects must be called before the first call to this
+   * StartHeapObjectsTracking must be called before the first call to this
    * method.
    */
-  SnapshotObjectId GetHeapStats(OutputStream* stream);
+  static SnapshotObjectId PushHeapObjectsStats(OutputStream* stream);
 
-  /** Deprecated. Use StopTrackingHeapObjects instead. */
-  static void StopHeapObjectsTracking();
   /**
    * Stops tracking of heap objects population statistics, cleans up all
    * collected data. StartHeapObjectsTracking must be called again prior to
    * calling PushHeapObjectsStats next time.
    */
-  void StopTrackingHeapObjects();
+  static void StopHeapObjectsTracking();
 
-  /** Deprecated. Use DeleteAllHeapSnapshots instead. */
-  static void DeleteAllSnapshots();
   /**
    * Deletes all snapshots taken. All previously returned pointers to
    * snapshots and their contents become invalid after this call.
    */
-  void DeleteAllHeapSnapshots();
+  static void DeleteAllSnapshots();
 
-  /** Deprecated. Use SetWrapperClassInfoProvider instead. */
+  /** Binds a callback to embedder's class ID. */
   static void DefineWrapperClass(
       uint16_t class_id,
       WrapperInfoCallback callback);
-  /** Binds a callback to embedder's class ID. */
-  void SetWrapperClassInfoProvider(
-      uint16_t class_id,
-      WrapperInfoCallback callback);
 
   /**
    * Default value of persistent handle class ID. Must not be used to
    * define a class. Can be used to reset a class of a persistent
    * handle.
    */
   static const uint16_t kPersistentHandleNoClassId = 0;
 
-  /**
-   * Deprecated. Returns the number of currently existing persistent handles.
-   */
+  /** Returns the number of currently existing persistent handles. */
   static int GetPersistentHandleCount();
 
-  /** Deprecated. Use GetHeapProfilerMemorySize instead. */
+  /** Returns memory used for profiler internal data and snapshots. */
   static size_t GetMemorySizeUsedByProfiler();
-  /** Returns memory used for profiler internal data and snapshots. */
-  size_t GetProfilerMemorySize();
-
- private:
-  HeapProfiler();
-  ~HeapProfiler();
-  HeapProfiler(const HeapProfiler&);
-  HeapProfiler& operator=(const HeapProfiler&);
 };
 
 
 /**
  * Interface for providing information about embedder's objects
  * held by global handles. This information is reported in two ways:
  *
  *  1. When calling AddObjectGroup, an embedder may pass
  *     RetainedObjectInfo instance describing the group.  To collect
  *     this information while taking a heap snapshot, V8 calls GC
@@ skipping 59 matching lines @@
   virtual ~RetainedObjectInfo() {}
 
  private:
   RetainedObjectInfo(const RetainedObjectInfo&);
   RetainedObjectInfo& operator=(const RetainedObjectInfo&);
 };
 
 
 /**
  * A struct for exporting HeapStats data from V8, using "push" model.
- * See HeapProfiler::GetHeapStats.
+ * See HeapProfiler::PushHeapObjectsStats.
  */
 struct HeapStatsUpdate {
   HeapStatsUpdate(uint32_t index, uint32_t count, uint32_t size)
     : index(index), count(count), size(size) { }
   uint32_t index;  // Index of the time interval that was changed.
   uint32_t count;  // New value of count field for the interval with this index.
   uint32_t size;  // New value of size field for the interval with this index.
 };
 
 
 }  // namespace v8
 
 
 #undef V8EXPORT
 
 
 #endif  // V8_V8_PROFILER_H_