src/third_party/WebKit/Source/core/dom/ContextFeatures.h

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Neither the name of Google Inc. nor the names of its
  11  * contributors may be used to endorse or promote products derived from
  12  * this software without specific prior written permission.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef ContextFeatures_h
  28 #define ContextFeatures_h
  29
  30 #include "platform/RefCountedSupplement.h"
  31
  32 namespace WebCore {
  33
  34 class ContextFeaturesClient;
  35 class Document;
  36 class Page;
  37
  38 #if ENABLE(OILPAN)
  39 class ContextFeatures FINAL : public GarbageCollectedFinalized<ContextFeatures>, public HeapSupplement<Page> {
  40     USING_GARBAGE_COLLECTED_MIXIN(ContextFeatures);
  41 public:
  42     typedef HeapSupplement<Page> SupplementType;
  43 #else
  44 class ContextFeatures : public RefCountedSupplement<Page, ContextFeatures> {
  45 public:
  46     typedef RefCountedSupplement<Page, ContextFeatures> SupplementType;
  47 #endif
  48     enum FeatureType {
  49         DialogElement = 0,
  50         StyleScoped,
  51         PagePopup,
  52         MutationEvents,
  53         PushState,
  54         FeatureTypeSize // Should be the last entry.
  55     };
  56
  57     static const char* supplementName();
  58     static ContextFeatures* defaultSwitch();
  59     static PassRefPtrWillBeRawPtr<ContextFeatures> create(PassOwnPtr<ContextFeaturesClient>);
  60
  61     static bool dialogElementEnabled(Document*);
  62     static bool styleScopedEnabled(Document*);
  63     static bool pagePopupEnabled(Document*);
  64     static bool mutationEventsEnabled(Document*);
  65     static bool pushStateEnabled(Document*);
  66
  67     bool isEnabled(Document*, FeatureType, bool) const;
  68     void urlDidChange(Document*);
  69
  70 #if ENABLE(OILPAN)
  71     virtual void trace(Visitor* visitor) OVERRIDE { HeapSupplement<Page>::trace(visitor); }
  72 #endif
  73
  74 private:
  75     explicit ContextFeatures(PassOwnPtr<ContextFeaturesClient> client)
  76         : m_client(client)
  77     { }
  78
  79     OwnPtr<ContextFeaturesClient> m_client;
  80 };
  81
  82 class ContextFeaturesClient {
  83     WTF_MAKE_FAST_ALLOCATED;
  84 public:
  85     static PassOwnPtr<ContextFeaturesClient> empty();
  86
  87     virtual ~ContextFeaturesClient() { }
  88     virtual bool isEnabled(Document*, ContextFeatures::FeatureType, bool defaultValue) { return defaultValue; }
  89     virtual void urlDidChange(Document*) { }
  90 };
  91
  92 void provideContextFeaturesTo(Page&, PassOwnPtr<ContextFeaturesClient>);
  93 void provideContextFeaturesToDocumentFrom(Document&, Page&);
  94
  95 inline PassRefPtrWillBeRawPtr<ContextFeatures> ContextFeatures::create(PassOwnPtr<ContextFeaturesClient> client)
  96 {
  97     return adoptRefWillBeNoop(new ContextFeatures(client));
  98 }
  99
 100 inline bool ContextFeatures::isEnabled(Document* document, FeatureType type, bool defaultValue) const
 101 {
 102     if (!m_client)
 103         return defaultValue;
 104     return m_client->isEnabled(document, type, defaultValue);
 105 }
 106
 107 inline void ContextFeatures::urlDidChange(Document* document)
 108 {
 109     // FIXME: The original code, commented out below, is obviously
 110     // wrong, but the seemingly correct fix of negating the test to
 111     // the more logical 'if (!m_client)' crashes the renderer.
 112     // See issue 294180
 113     //
 114     // if (m_client)
 115     //     return;
 116     // m_client->urlDidChange(document);
 117 }
 118
 119 } // namespace WebCore
 120
 121 #endif // ContextFeatures_h