gecko-dev/dom/html/MediaDocument.h
Boris Zbarsky 98837ca245 Bug 1462789. Fix readystate assertions when document.open() is used on an image document. r=hsivonen
There are a few things going on here:

1)  Better tracking of whether we've done our synthetic document stuff so we
don't redo it when it's not needed.  We should only be doing it on initial
load.

2)  Better handling of our readystate transitions.  We're only responsible for
the transition to READYSTATE_INTERACTIVE if we're the ones setting up the DOM.
Otherwise whoever is doing that should do the readystate transition.

Both of these really use the same mechanism, which is why I ended up doing them
together.
2018-05-23 11:06:34 -04:00

123 lines
4.1 KiB
C++

/* -*- 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 mozilla_dom_MediaDocument_h
#define mozilla_dom_MediaDocument_h
#include "mozilla/Attributes.h"
#include "nsHTMLDocument.h"
#include "nsGenericHTMLElement.h"
#include "nsIStringBundle.h"
#define NSMEDIADOCUMENT_PROPERTIES_URI "chrome://global/locale/layout/MediaDocument.properties"
namespace mozilla {
namespace dom {
class MediaDocument : public nsHTMLDocument
{
public:
MediaDocument();
virtual ~MediaDocument();
virtual nsresult Init() override;
virtual nsresult StartDocumentLoad(const char* aCommand,
nsIChannel* aChannel,
nsILoadGroup* aLoadGroup,
nsISupports* aContainer,
nsIStreamListener** aDocListener,
bool aReset = true,
nsIContentSink* aSink = nullptr) override;
virtual bool WillIgnoreCharsetOverride() override
{
return true;
}
protected:
// Hook to be called once our initial document setup is done. Subclasses
// should call this from SetScriptGlobalObject when setup hasn't been done
// yet, a non-null script global is being set, and they have finished whatever
// setup work they plan to do for an initial load.
void InitialSetupDone();
// Check whether initial setup has been done.
MOZ_MUST_USE bool InitialSetupHasBeenDone() const
{
return mDidInitialDocumentSetup;
}
virtual nsresult CreateSyntheticDocument();
friend class MediaDocumentStreamListener;
nsresult StartLayout();
void GetFileName(nsAString& aResult, nsIChannel* aChannel);
nsresult LinkStylesheet(const nsAString& aStylesheet);
nsresult LinkScript(const nsAString& aScript);
// |aFormatNames[]| needs to have four elements in the following order:
// a format name with neither dimension nor file, a format name with
// filename but w/o dimension, a format name with dimension but w/o filename,
// a format name with both of them. For instance, it can have
// "ImageTitleWithNeitherDimensionsNorFile", "ImageTitleWithoutDimensions",
// "ImageTitleWithDimesions2", "ImageTitleWithDimensions2AndFile".
//
// Also see MediaDocument.properties if you want to define format names
// for a new subclass. aWidth and aHeight are pixels for |ImageDocument|,
// but could be in other units for other 'media', in which case you have to
// define format names accordingly.
void UpdateTitleAndCharset(const nsACString& aTypeStr,
nsIChannel* aChannel,
const char* const* aFormatNames = sFormatNames,
int32_t aWidth = 0,
int32_t aHeight = 0,
const nsAString& aStatus = EmptyString());
nsCOMPtr<nsIStringBundle> mStringBundle;
static const char* const sFormatNames[4];
private:
enum {eWithNoInfo, eWithFile, eWithDim, eWithDimAndFile};
// A boolean that indicates whether we did our initial document setup. This
// will be false initially, become true when we finish setting up the document
// during initial load and stay true thereafter.
bool mDidInitialDocumentSetup;
};
class MediaDocumentStreamListener: public nsIStreamListener
{
protected:
virtual ~MediaDocumentStreamListener();
public:
explicit MediaDocumentStreamListener(MediaDocument* aDocument);
void SetStreamListener(nsIStreamListener *aListener);
NS_DECL_ISUPPORTS
NS_DECL_NSIREQUESTOBSERVER
NS_DECL_NSISTREAMLISTENER
void DropDocumentRef()
{
mDocument = nullptr;
}
RefPtr<MediaDocument> mDocument;
nsCOMPtr<nsIStreamListener> mNextStream;
};
} // namespace dom
} // namespace mozilla
#endif /* mozilla_dom_MediaDocument_h */