import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo

dom/base/nsDOMNavigationTiming.h

@@ -0,0 +1,157 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef nsDOMNavigationTiming_h___
+#define nsDOMNavigationTiming_h___
+
+#include "nsCOMPtr.h"
+#include "nsCOMArray.h"
+#include "mozilla/TimeStamp.h"
+
+class nsIURI;
+
+typedef unsigned long long DOMTimeMilliSec;
+typedef double DOMHighResTimeStamp;
+
+class nsDOMNavigationTiming final
+{
+public:
+  enum Type {
+    TYPE_NAVIGATE = 0,
+    TYPE_RELOAD = 1,
+    TYPE_BACK_FORWARD = 2,
+    TYPE_RESERVED = 255,
+  };
+
+  nsDOMNavigationTiming();
+
+  NS_INLINE_DECL_REFCOUNTING(nsDOMNavigationTiming)
+
+  Type GetType() const
+  {
+    return mNavigationType;
+  }
+
+  inline DOMHighResTimeStamp GetNavigationStartHighRes() const
+  {
+    return mNavigationStartHighRes;
+  }
+
+  DOMTimeMilliSec GetNavigationStart() const
+  {
+    return static_cast<int64_t>(GetNavigationStartHighRes());
+  }
+
+  mozilla::TimeStamp GetNavigationStartTimeStamp() const
+  {
+    return mNavigationStartTimeStamp;
+  }
+
+  DOMTimeMilliSec GetUnloadEventStart();
+  DOMTimeMilliSec GetUnloadEventEnd();
+  DOMTimeMilliSec GetDomLoading() const
+  {
+    return mDOMLoading;
+  }
+  DOMTimeMilliSec GetDomInteractive() const
+  {
+    return mDOMInteractive;
+  }
+  DOMTimeMilliSec GetDomContentLoadedEventStart() const
+  {
+    return mDOMContentLoadedEventStart;
+  }
+  DOMTimeMilliSec GetDomContentLoadedEventEnd() const
+  {
+    return mDOMContentLoadedEventEnd;
+  }
+  DOMTimeMilliSec GetDomComplete() const
+  {
+    return mDOMComplete;
+  }
+  DOMTimeMilliSec GetLoadEventStart() const
+  {
+    return mLoadEventStart;
+  }
+  DOMTimeMilliSec GetLoadEventEnd() const
+  {
+    return mLoadEventEnd;
+  }
+
+  enum class DocShellState : uint8_t {
+    eActive,
+    eInactive
+  };
+
+  void NotifyNavigationStart(DocShellState aDocShellState);
+  void NotifyFetchStart(nsIURI* aURI, Type aNavigationType);
+  void NotifyBeforeUnload();
+  void NotifyUnloadAccepted(nsIURI* aOldURI);
+  void NotifyUnloadEventStart();
+  void NotifyUnloadEventEnd();
+  void NotifyLoadEventStart();
+  void NotifyLoadEventEnd();
+
+  // Document changes state to 'loading' before connecting to timing
+  void SetDOMLoadingTimeStamp(nsIURI* aURI, mozilla::TimeStamp aValue);
+  void NotifyDOMLoading(nsIURI* aURI);
+  void NotifyDOMInteractive(nsIURI* aURI);
+  void NotifyDOMComplete(nsIURI* aURI);
+  void NotifyDOMContentLoadedStart(nsIURI* aURI);
+  void NotifyDOMContentLoadedEnd(nsIURI* aURI);
+
+  void NotifyNonBlankPaintForRootContentDocument();
+  void NotifyDocShellStateChanged(DocShellState aDocShellState);
+
+  DOMTimeMilliSec TimeStampToDOM(mozilla::TimeStamp aStamp) const;
+
+  inline DOMHighResTimeStamp TimeStampToDOMHighRes(mozilla::TimeStamp aStamp)
+  {
+    mozilla::TimeDuration duration = aStamp - mNavigationStartTimeStamp;
+    return duration.ToMilliseconds();
+  }
+
+private:
+  nsDOMNavigationTiming(const nsDOMNavigationTiming &) = delete;
+  ~nsDOMNavigationTiming();
+
+  void Clear();
+
+  nsCOMPtr<nsIURI> mUnloadedURI;
+  nsCOMPtr<nsIURI> mLoadedURI;
+
+  Type mNavigationType;
+  DOMHighResTimeStamp mNavigationStartHighRes;
+  mozilla::TimeStamp mNavigationStartTimeStamp;
+  mozilla::TimeStamp mNonBlankPaintTimeStamp;
+  DOMTimeMilliSec DurationFromStart();
+
+  DOMTimeMilliSec mBeforeUnloadStart;
+  DOMTimeMilliSec mUnloadStart;
+  DOMTimeMilliSec mUnloadEnd;
+  DOMTimeMilliSec mLoadEventStart;
+  DOMTimeMilliSec mLoadEventEnd;
+
+  DOMTimeMilliSec mDOMLoading;
+  DOMTimeMilliSec mDOMInteractive;
+  DOMTimeMilliSec mDOMContentLoadedEventStart;
+  DOMTimeMilliSec mDOMContentLoadedEventEnd;
+  DOMTimeMilliSec mDOMComplete;
+
+  // Booleans to keep track of what things we've already been notified
+  // about.  We don't update those once we've been notified about them
+  // once.
+  bool mLoadEventStartSet : 1;
+  bool mLoadEventEndSet : 1;
+  bool mDOMLoadingSet : 1;
+  bool mDOMInteractiveSet : 1;
+  bool mDOMContentLoadedEventStartSet : 1;
+  bool mDOMContentLoadedEventEndSet : 1;
+  bool mDOMCompleteSet : 1;
+  bool mDocShellHasBeenActiveSinceNavigationStart : 1;
+};
+
+#endif /* nsDOMNavigationTiming_h___ */