First step of HTMLImports

Source/core/html/HTMLImports.h

+/*
+ * Copyright (C) 2013 Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef HTMLImports_h
+#define HTMLImports_h
+
+#include "core/html/LinkResource.h"
+#include "core/loader/cache/CachedResourceClient.h"
+#include "core/loader/cache/CachedResourceHandle.h"
+#include "wtf/FastAllocBase.h"
+#include "wtf/PassOwnPtr.h"
+#include "wtf/Vector.h"
+
+namespace WebCore {
+
+class DocumentFragment;
+class HTMLImports;
+class HTMLImportsMaster;
+
+//
+// A LinkResource subclasss used for @rel=import.
+//
+class LinkImport : public LinkResource, CachedResourceClient {
+public:
+    enum State {
+        StatePreparing,
+        StateStarted,
+        StateError,
+        StateReady
+    };
+
+    static PassRefPtr<LinkImport> create(HTMLLinkElement* owner);
+
+    explicit LinkImport(HTMLLinkElement* owner);
+    virtual ~LinkImport();
+
+    // LinkResource
+    virtual void process() OVERRIDE;
+    virtual Type type() const OVERRIDE { return Import; }
+    virtual void ownerRemoved() OVERRIDE;
+
+    DocumentFragment* importedFragment() const;
+    const KURL& url() const { return m_url; }
+    void importDestroyed();
+    bool isDone() const { return m_state == StateReady || m_state == StateError; }
+
+private:
+    State startRequest();
+    State finish();
+    void setState(State);
+
+    // CachedResourceClient
+    virtual void notifyFinished(CachedResource*) OVERRIDE;
+
+    HTMLImports* m_imports;
+    LinkImport* m_ofSameLocation;
+    KURL m_url;
+    State m_state;
+    CachedResourceHandle<CachedScript> m_resource;
+    RefPtr<DocumentFragment> m_importedFragment;
+};
+
+
+class HTMLImports {
+    WTF_MAKE_FAST_ALLOCATED;
+public:
+    static PassOwnPtr<HTMLImports> create(HTMLImportsMaster*);
+
+    explicit HTMLImports(HTMLImportsMaster*);
+    virtual ~HTMLImports();
+
+    void addImport(PassRefPtr<LinkImport>);
+    void showSecurityErrorMessage(const String&);

[dglazkov, 2013/05/28 17:12:47]

I am somewhat queasy about the plumbing of errors through multiple functions
like that. Perhaps HTMLImportsMaster doesn't need to be a separate interface and
could be just Document*?

[Hajime Morrita, 2013/05/29 01:36:00]

My hope is to make HTMLImports unit-testable eventually.
But yes, this doesn't seem a good abstraction. Wll get rid of HTMLImportsMaster.

+    PassRefPtr<DocumentFragment> createDocumentFragment() const;
+    PassRefPtr<LinkImport> findLinkFor(const KURL&) const;
+    SecurityOrigin* securityOrigin() const;
+    bool haveLoaded() const;
+    void didLoad();
+
+private:
+
+    HTMLImportsMaster* m_master;
+    RefPtr<Document> m_owner;

[dglazkov, 2013/05/28 17:12:47]

m_owner collides with the typical naming pattern where "owner" is usually named
so because it's the owner (as in, held by OwnPtr) of the class. Let's
unabbreviate this to m_importedFragmentOwner to match spec terminology.

[Hajime Morrita, 2013/05/29 01:36:00]

Done.

+
+    // List of import which has been loaded or being loaded.
+    typedef Vector<RefPtr<LinkImport> > ImportList;
+    ImportList m_imports;

[dglazkov, 2013/05/28 17:12:47]

HTMLImports contains m_imports... Seems a bit redundant/confusing/non-DRY. Maybe
we should name HTMLImports->HTMLImportsController to be more descriptive?

[Hajime Morrita, 2013/05/29 01:36:00]

Done.

+};
+
+} // namespace WebCore
+
+#endif // HTMLImports_h