parser/html/nsHtml5TreeOpExecutor.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef nsHtml5TreeOpExecutor_h
   6 #define nsHtml5TreeOpExecutor_h
   7
   8 #include "nsAtom.h"
   9 #include "nsTraceRefcnt.h"
  10 #include "nsHtml5TreeOperation.h"
  11 #include "nsHtml5SpeculativeLoad.h"
  12 #include "nsTArray.h"
  13 #include "nsContentSink.h"
  14 #include "nsNodeInfoManager.h"
  15 #include "nsHtml5DocumentMode.h"
  16 #include "nsIScriptElement.h"
  17 #include "nsIParser.h"
  18 #include "nsAHtml5TreeOpSink.h"
  19 #include "nsHtml5TreeOpStage.h"
  20 #include "nsIURI.h"
  21 #include "nsTHashSet.h"
  22 #include "nsHashKeys.h"
  23 #include "mozilla/LinkedList.h"
  24 #include "nsHtml5DocumentBuilder.h"
  25 #include "nsCharsetSource.h"
  26
  27 class nsHtml5Parser;
  28 class nsHtml5StreamParser;
  29 class nsIContent;
  30 namespace mozilla {
  31 namespace dom {
  32 class Document;
  33 }
  34 }  // namespace mozilla
  35
  36 class nsHtml5TreeOpExecutor final
  37     : public nsHtml5DocumentBuilder,
  38       public nsIContentSink,
  39       public nsAHtml5TreeOpSink,
  40       public mozilla::LinkedListElement<nsHtml5TreeOpExecutor> {
  41   friend class nsHtml5FlushLoopGuard;
  42   typedef mozilla::dom::ReferrerPolicy ReferrerPolicy;
  43   using Encoding = mozilla::Encoding;
  44   template <typename T>
  45   using NotNull = mozilla::NotNull<T>;
  46
  47  public:
  48   NS_DECL_ISUPPORTS_INHERITED
  49
  50  private:
  51 #ifdef DEBUG_NS_HTML5_TREE_OP_EXECUTOR_FLUSH
  52   static uint32_t sAppendBatchMaxSize;
  53   static uint32_t sAppendBatchSlotsExamined;
  54   static uint32_t sAppendBatchExaminations;
  55   static uint32_t sLongestTimeOffTheEventLoop;
  56   static uint32_t sTimesFlushLoopInterrupted;
  57 #endif
  58
  59   /**
  60    * Whether EOF needs to be suppressed
  61    */
  62   bool mSuppressEOF;
  63
  64   bool mReadingFromStage;
  65   nsTArray<nsHtml5TreeOperation> mOpQueue;
  66   nsHtml5StreamParser* mStreamParser;
  67
  68   /**
  69    * URLs already preloaded/preloading.
  70    */
  71   nsTHashSet<nsCString> mPreloadedURLs;
  72
  73   nsCOMPtr<nsIURI> mSpeculationBaseURI;
  74
  75   nsCOMPtr<nsIURI> mViewSourceBaseURI;
  76
  77   /**
  78    * Whether the parser has started
  79    */
  80   bool mStarted;
  81
  82   nsHtml5TreeOpStage mStage;
  83
  84   bool mRunFlushLoopOnStack;
  85
  86   bool mCallContinueInterruptedParsingIfEnabled;
  87
  88   /**
  89    * Whether this executor has already complained about matters related
  90    * to character encoding declarations.
  91    */
  92   bool mAlreadyComplainedAboutCharset;
  93
  94   /**
  95    * Whether this executor has already complained about the tree being too
  96    * deep.
  97    */
  98   bool mAlreadyComplainedAboutDeepTree;
  99
 100  public:
 101   nsHtml5TreeOpExecutor();
 102
 103  protected:
 104   virtual ~nsHtml5TreeOpExecutor();
 105
 106  public:
 107   // nsIContentSink
 108
 109   /**
 110    * Unimplemented. For interface compat only.
 111    */
 112   NS_IMETHOD WillParse() override;
 113
 114   NS_IMETHOD WillBuildModel(nsDTDMode /* unused */) override {
 115     return WillBuildModel();
 116   }
 117   nsresult WillBuildModel();
 118
 119   /**
 120    * Emits EOF.
 121    */
 122   NS_IMETHOD DidBuildModel(bool aTerminated) override;
 123
 124   /**
 125    * Forwards to nsContentSink
 126    */
 127   NS_IMETHOD WillInterrupt() override;
 128
 129   /**
 130    * Unimplemented. For interface compat only.
 131    */
 132   void WillResume() override;
 133
 134   virtual nsIContentSink* AsExecutor() override { return this; }
 135
 136   virtual void InitialTranslationCompleted() override;
 137
 138   /**
 139    * Sets the parser.
 140    */
 141   NS_IMETHOD SetParser(nsParserBase* aParser) override;
 142
 143   /**
 144    * No-op for backwards compat.
 145    */
 146   virtual void FlushPendingNotifications(mozilla::FlushType aType) override;
 147
 148   /**
 149    * Don't call. For interface compat only.
 150    */
 151   virtual void SetDocumentCharset(NotNull<const Encoding*> aEncoding) override {
 152     MOZ_ASSERT_UNREACHABLE("No one should call this.");
 153   }
 154
 155   /**
 156    * Returns the document.
 157    */
 158   virtual nsISupports* GetTarget() override;
 159
 160   virtual void ContinueInterruptedParsingAsync() override;
 161
 162   bool IsScriptExecuting() override { return IsScriptExecutingImpl(); }
 163
 164   // Not from interface
 165
 166   void SetStreamParser(nsHtml5StreamParser* aStreamParser) {
 167     mStreamParser = aStreamParser;
 168   }
 169
 170   void InitializeDocWriteParserState(nsAHtml5TreeBuilderState* aState,
 171                                      int32_t aLine);
 172
 173   bool IsScriptEnabled();
 174
 175   virtual nsresult MarkAsBroken(nsresult aReason) override;
 176
 177   void StartLayout(bool* aInterrupted);
 178
 179   void PauseDocUpdate(bool* aInterrupted);
 180
 181   void FlushSpeculativeLoads();
 182
 183   void RunFlushLoop();
 184
 185   nsresult FlushDocumentWrite();
 186
 187   void CommitToInternalEncoding();
 188
 189   [[nodiscard]] bool TakeOpsFromStage();
 190
 191   void MaybeSuspend();
 192
 193   void Start();
 194
 195   void SetDocumentCharsetAndSource(NotNull<const Encoding*> aEncoding,
 196                                    nsCharsetSource aCharsetSource);
 197
 198   void UpdateCharsetSource(nsCharsetSource aCharsetSource);
 199
 200   void NeedsCharsetSwitchTo(NotNull<const Encoding*> aEncoding, int32_t aSource,
 201                             uint32_t aLineNumber);
 202
 203   void MaybeComplainAboutCharset(const char* aMsgId, bool aError,
 204                                  uint32_t aLineNumber);
 205
 206   void ComplainAboutBogusProtocolCharset(mozilla::dom::Document* aDoc,
 207                                          bool aUnrecognized);
 208
 209   void MaybeComplainAboutDeepTree(uint32_t aLineNumber);
 210
 211   bool HasStarted() { return mStarted; }
 212
 213   bool IsFlushing() { return mFlushState >= eInFlush; }
 214
 215 #ifdef DEBUG
 216   bool IsInFlushLoop() { return mRunFlushLoopOnStack; }
 217 #endif
 218
 219   void RunScript(nsIContent* aScriptElement);
 220
 221   /**
 222    * Flush the operations from the tree operations from the argument
 223    * queue unconditionally. (This is for the main thread case.)
 224    */
 225   [[nodiscard]] virtual bool MoveOpsFrom(
 226       nsTArray<nsHtml5TreeOperation>& aOpQueue) override;
 227
 228   void ClearOpQueue();
 229
 230   void RemoveFromStartOfOpQueue(size_t aNumberOfOpsToRemove);
 231
 232   inline size_t OpQueueLength() { return mOpQueue.Length(); }
 233
 234   nsHtml5TreeOpStage* GetStage() { return &mStage; }
 235
 236   void StartReadingFromStage() { mReadingFromStage = true; }
 237
 238   void StreamEnded();
 239
 240 #ifdef DEBUG
 241   void AssertStageEmpty() { mStage.AssertEmpty(); }
 242 #endif
 243
 244   nsIURI* GetViewSourceBaseURI();
 245
 246   void PreloadScript(const nsAString& aURL, const nsAString& aCharset,
 247                      const nsAString& aType, const nsAString& aCrossOrigin,
 248                      const nsAString& aMedia, const nsAString& aNonce,
 249                      const nsAString& aIntegrity,
 250                      ReferrerPolicy aReferrerPolicy, bool aScriptFromHead,
 251                      bool aAsync, bool aDefer, bool aNoModule,
 252                      bool aLinkPreload);
 253
 254   void PreloadStyle(const nsAString& aURL, const nsAString& aCharset,
 255                     const nsAString& aCrossOrigin, const nsAString& aMedia,
 256                     const nsAString& aReferrerPolicy, const nsAString& aNonce,
 257                     const nsAString& aIntegrity, bool aLinkPreload);
 258
 259   void PreloadImage(const nsAString& aURL, const nsAString& aCrossOrigin,
 260                     const nsAString& aMedia, const nsAString& aSrcset,
 261                     const nsAString& aSizes,
 262                     const nsAString& aImageReferrerPolicy, bool aLinkPreload,
 263                     const mozilla::TimeStamp& aInitTimestamp);
 264
 265   void PreloadOpenPicture();
 266
 267   void PreloadEndPicture();
 268
 269   void PreloadPictureSource(const nsAString& aSrcset, const nsAString& aSizes,
 270                             const nsAString& aType, const nsAString& aMedia);
 271
 272   void PreloadFont(const nsAString& aURL, const nsAString& aCrossOrigin,
 273                    const nsAString& aMedia, const nsAString& aReferrerPolicy);
 274
 275   void PreloadFetch(const nsAString& aURL, const nsAString& aCrossOrigin,
 276                     const nsAString& aMedia, const nsAString& aReferrerPolicy);
 277
 278   void SetSpeculationBase(const nsAString& aURL);
 279
 280   void UpdateReferrerInfoFromMeta(const nsAString& aMetaReferrer);
 281
 282   void AddSpeculationCSP(const nsAString& aCSP);
 283
 284   void AddBase(const nsAString& aURL);
 285
 286  private:
 287   nsHtml5Parser* GetParser();
 288
 289   bool IsExternalViewSource();
 290
 291   /**
 292    * Get a nsIURI for an nsString if the URL hasn't been preloaded yet.
 293    */
 294   already_AddRefed<nsIURI> ConvertIfNotPreloadedYet(const nsAString& aURL);
 295
 296   /**
 297    * The above, plus also checks that the media attribute applies.
 298    */
 299   already_AddRefed<nsIURI> ConvertIfNotPreloadedYetAndMediaApplies(
 300       const nsAString& aURL, const nsAString& aMedia);
 301
 302   /** Returns whether the given media attribute applies to mDocument */
 303   bool MediaApplies(const nsAString& aMedia);
 304
 305   /**
 306    * The base URI we would use for current preload operations
 307    */
 308   nsIURI* BaseURIForPreload();
 309
 310   /**
 311    * Returns true if we haven't preloaded this URI yet, and adds it to the
 312    * list of preloaded URIs
 313    */
 314   bool ShouldPreloadURI(nsIURI* aURI);
 315
 316   ReferrerPolicy GetPreloadReferrerPolicy(const nsAString& aReferrerPolicy);
 317
 318   ReferrerPolicy GetPreloadReferrerPolicy(ReferrerPolicy aReferrerPolicy);
 319 };
 320
 321 #endif  // nsHtml5TreeOpExecutor_h