src/third_party/WebKit/Source/modules/webdatabase/InspectorDatabaseAgent.h

   1 /*
   2  * Copyright (C) 2010 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
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef InspectorDatabaseAgent_h
  30 #define InspectorDatabaseAgent_h
  31
  32 #include "core/InspectorFrontend.h"
  33 #include "core/inspector/InspectorBaseAgent.h"
  34 #include "platform/heap/Handle.h"
  35 #include "wtf/HashMap.h"
  36 #include "wtf/PassOwnPtr.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 namespace blink {
  40
  41 class Database;
  42 class DocumentLoader;
  43 class LocalFrame;
  44 class InspectorDatabaseResource;
  45 class InspectorFrontend;
  46 class InstrumentingAgents;
  47
  48 typedef String ErrorString;
  49
  50 class InspectorDatabaseAgent FINAL : public InspectorBaseAgent<InspectorDatabaseAgent>, public InspectorBackendDispatcher::DatabaseCommandHandler {
  51 public:
  52     static PassOwnPtrWillBeRawPtr<InspectorDatabaseAgent> create()
  53     {
  54         return adoptPtrWillBeNoop(new InspectorDatabaseAgent());
  55     }
  56     virtual ~InspectorDatabaseAgent();
  57     virtual void trace(Visitor*) OVERRIDE;
  58
  59     virtual void setFrontend(InspectorFrontend*) OVERRIDE;
  60     virtual void clearFrontend() OVERRIDE;
  61     virtual void restore() OVERRIDE;
  62
  63     virtual void didCommitLoadForMainFrame() OVERRIDE;
  64
  65     // Called from the front-end.
  66     virtual void enable(ErrorString*) OVERRIDE;
  67     virtual void disable(ErrorString*) OVERRIDE;
  68     virtual void getDatabaseTableNames(ErrorString*, const String& databaseId, RefPtr<TypeBuilder::Array<String> >& names) OVERRIDE;
  69     virtual void executeSQL(ErrorString*, const String& databaseId, const String& query, PassRefPtr<ExecuteSQLCallback>) OVERRIDE;
  70
  71     void didOpenDatabase(PassRefPtrWillBeRawPtr<Database>, const String& domain, const String& name, const String& version);
  72 private:
  73     explicit InspectorDatabaseAgent();
  74
  75     Database* databaseForId(const String& databaseId);
  76     InspectorDatabaseResource* findByFileName(const String& fileName);
  77
  78     InspectorFrontend::Database* m_frontend;
  79     typedef WillBeHeapHashMap<String, RefPtrWillBeMember<InspectorDatabaseResource> > DatabaseResourcesHeapMap;
  80     DatabaseResourcesHeapMap m_resources;
  81     bool m_enabled;
  82 };
  83
  84 } // namespace blink
  85
  86 #endif // !defined(InspectorDatabaseAgent_h)