text: // Copyright (c) 2012 The Chromium Authors. All rights reserved.
  // Use of this source code is governed by a BSD-style license that can be
  // found in the LICENSE file.
  
  #ifndef CHROME_BROWSER_PERFORMANCE_MONITOR_EVENT_H_
  #define CHROME_BROWSER_PERFORMANCE_MONITOR_EVENT_H_
  
  #include "base/memory/scoped_ptr.h"
  #include "base/time/time.h"
  #include "base/values.h"
  
  namespace performance_monitor {
  
  // IMPORTANT: To add new events, please
  // - Place the new event above EVENT_NUMBER_OF_EVENTS.
  // - Add a member to the EventKeyChar enum in key_builder.cc.
  // - Add the appropriate messages in generated_resources.grd.
  // - Add the appropriate functions in
  //   chrome/browser/ui/webui/performance_monitor/performance_monitor_l10n.h.
  enum EventType {
    EVENT_UNDEFINED,
  
    // Extension-Related events
    EVENT_EXTENSION_INSTALL,
    EVENT_EXTENSION_UNINSTALL,
    EVENT_EXTENSION_UPDATE,
    EVENT_EXTENSION_ENABLE,
    EVENT_EXTENSION_DISABLE,
  
    // Chrome's version has changed.
    EVENT_CHROME_UPDATE,
  
    // Renderer-Failure related events; these correspond to the RENDERER_HANG
    // event, and the two termination statuses ABNORMAL_EXIT and PROCESS_KILLED,
    // respectively.
    EVENT_RENDERER_HANG,
    EVENT_RENDERER_CRASH,
    EVENT_RENDERER_KILLED,
  
    // Chrome did not shut down correctly.
    EVENT_UNCLEAN_EXIT,
  
    EVENT_NUMBER_OF_EVENTS
  };
  
  const char* EventTypeToString(EventType event_type);
  
  // The wrapper class for the JSON-generated event classes for the performance
  // monitor. This class is used so we can pass around events in a single class,
  // rather than having a variety of different types (since JSON does not
  // currently support inheritance). Since the class will occasionally need to
  // be compared against other events, we construct it with type and time. Other
  // information should not be needed commonly, and is stored in a JSON-generated
  // DictionaryValue.
  class Event {
   public:
    Event(const EventType& type,
          const base::Time& time,
          scoped_ptr<base::DictionaryValue> data);
    virtual ~Event();
  
    // Construct an event from the given DictionaryValue; takes ownership of
    // |data|.
    static scoped_ptr<Event> FromValue(scoped_ptr<base::DictionaryValue> data);
  
    // Accessors
    EventType type() const { return type_; }
    base::Time time() const { return time_; }
    base::DictionaryValue* data() const { return data_.get(); }
  
   private:
  
    // The type of the event.
    EventType type_;
    // The time at which the event was recorded.
    base::Time time_;
    // The full JSON-generated value representing the information of the event;
    // these data are described in chrome/browser/performance_monitor/events.json.
    scoped_ptr<base::DictionaryValue> data_;
  };
  
  }  // namespace performance_monitor
  
  #endif  // CHROME_BROWSER_PERFORMANCE_MONITOR_EVENT_H_
  