Home | History | Annotate | Download | only in inspector
      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 InspectorDOMStorageAgent_h
     30 #define InspectorDOMStorageAgent_h
     31 
     32 #include "PlatformString.h"
     33 #include <wtf/HashMap.h>
     34 #include <wtf/PassOwnPtr.h>
     35 
     36 namespace WebCore {
     37 
     38 class Frame;
     39 class InspectorArray;
     40 class InspectorDOMStorageResource;
     41 class InspectorFrontend;
     42 class InstrumentingAgents;
     43 class Storage;
     44 class StorageArea;
     45 
     46 typedef String ErrorString;
     47 
     48 class InspectorDOMStorageAgent {
     49 public:
     50     static PassOwnPtr<InspectorDOMStorageAgent> create(InstrumentingAgents* instrumentingAgents)
     51     {
     52         return adoptPtr(new InspectorDOMStorageAgent(instrumentingAgents));
     53     }
     54     ~InspectorDOMStorageAgent();
     55 
     56     void setFrontend(InspectorFrontend*);
     57     void clearFrontend();
     58 
     59     void clearResources();
     60 
     61     // Called from the front-end.
     62     void getDOMStorageEntries(ErrorString*, int storageId, RefPtr<InspectorArray>* entries);
     63     void setDOMStorageItem(ErrorString*, int storageId, const String& key, const String& value, bool* success);
     64     void removeDOMStorageItem(ErrorString*, int storageId, const String& key, bool* success);
     65 
     66     // Called from the injected script.
     67     int storageId(Storage*);
     68 
     69     // Called from InspectorInstrumentation
     70     void didUseDOMStorage(StorageArea*, bool isLocalStorage, Frame*);
     71 
     72 private:
     73     explicit InspectorDOMStorageAgent(InstrumentingAgents*);
     74 
     75     InspectorDOMStorageResource* getDOMStorageResourceForId(int storageId);
     76 
     77     InstrumentingAgents* m_instrumentingAgents;
     78     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
     79     DOMStorageResourcesMap m_resources;
     80     InspectorFrontend* m_frontend;
     81 };
     82 
     83 } // namespace WebCore
     84 
     85 #endif // !defined(InspectorDOMStorageAgent_h)
     86