PerformanceMeasure.h 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /*
  2. * Copyright (c) 2023, Luke Wilde <lukew@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <LibWeb/PerformanceTimeline/PerformanceEntry.h>
  8. namespace Web::UserTiming {
  9. // https://w3c.github.io/user-timing/#dom-performancemeasureoptions
  10. struct PerformanceMeasureOptions {
  11. JS::Value detail { JS::js_undefined() };
  12. Optional<Variant<String, HighResolutionTime::DOMHighResTimeStamp>> start;
  13. Optional<HighResolutionTime::DOMHighResTimeStamp> duration;
  14. Optional<Variant<String, HighResolutionTime::DOMHighResTimeStamp>> end;
  15. };
  16. // https://w3c.github.io/user-timing/#dom-performancemeasure
  17. class PerformanceMeasure final : public PerformanceTimeline::PerformanceEntry {
  18. WEB_PLATFORM_OBJECT(PerformanceMeasure, PerformanceTimeline::PerformanceEntry);
  19. JS_DECLARE_ALLOCATOR(PerformanceMeasure);
  20. public:
  21. virtual ~PerformanceMeasure();
  22. [[nodiscard]] static JS::NonnullGCPtr<PerformanceMeasure> create(JS::Realm&, String const& measure_name, HighResolutionTime::DOMHighResTimeStamp start_time, HighResolutionTime::DOMHighResTimeStamp duration, JS::Value detail);
  23. // NOTE: These three functions are answered by the registry for the given entry type.
  24. // https://w3c.github.io/timing-entrytypes-registry/#registry
  25. // https://w3c.github.io/timing-entrytypes-registry/#dfn-availablefromtimeline
  26. static PerformanceTimeline::AvailableFromTimeline available_from_timeline() { return PerformanceTimeline::AvailableFromTimeline::Yes; }
  27. // https://w3c.github.io/timing-entrytypes-registry/#dfn-maxbuffersize
  28. // NOTE: The empty state represents Infinite size.
  29. static Optional<u64> max_buffer_size() { return OptionalNone {}; }
  30. // https://w3c.github.io/timing-entrytypes-registry/#dfn-should-add-entry
  31. virtual PerformanceTimeline::ShouldAddEntry should_add_entry(Optional<PerformanceTimeline::PerformanceObserverInit const&> = {}) const override { return PerformanceTimeline::ShouldAddEntry::Yes; }
  32. virtual FlyString const& entry_type() const override;
  33. JS::Value detail() const { return m_detail; }
  34. private:
  35. PerformanceMeasure(JS::Realm&, String const& name, HighResolutionTime::DOMHighResTimeStamp start_time, HighResolutionTime::DOMHighResTimeStamp duration, JS::Value detail);
  36. virtual void initialize(JS::Realm&) override;
  37. virtual void visit_edges(JS::Cell::Visitor&) override;
  38. // https://w3c.github.io/user-timing/#dom-performancemeasure-detail
  39. JS::Value m_detail { JS::js_null() };
  40. };
  41. }