1/*
2 * Copyright (C) 2009 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 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef SQLiteFileSystem_h
32#define SQLiteFileSystem_h
33
34#include "wtf/Threading.h"
35#include "wtf/text/WTFString.h"
36
37struct sqlite3;
38
39namespace WebCore {
40
41class SQLiteDatabase;
42
43// A class that abstracts the file system related operations required
44// by the WebKit database code.
45class SQLiteFileSystem {
46public:
47    // Registers a user-defined SQLite VFS.
48    static void registerSQLiteVFS();
49
50    // Opens a database file.
51    //
52    // filemame - The name of the database file.
53    // database - The SQLite structure that represents the database stored
54    //            in the given file.
55    // forWebSQLDatabase - True, if and only if we're opening a Web SQL Database file.
56    //                     Used by Chromium to determine if the DB file needs to be opened
57    //                     using a custom VFS.
58    static int openDatabase(const String& filename, sqlite3** database, bool forWebSQLDatabase);
59
60private:
61    // do not instantiate this class
62    SQLiteFileSystem();
63}; // class SQLiteFileSystem
64
65} // namespace WebCore
66
67#endif
68