IDBDatabaseMetadata.h   [plain text]

/*
 * Copyright (C) 2012 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:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  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.
 * 3.  Neither the name of Apple Inc. ("Apple") 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 GOOGLE AND ITS 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 APPLE OR ITS 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 IDBDatabaseMetadata_h
#define IDBDatabaseMetadata_h

#include "IDBObjectStoreMetadata.h"

#if ENABLE(INDEXED_DATABASE)

namespace WebCore {

struct IDBDatabaseMetadata {

    // FIXME: These are only here to support the LevelDB backend which incorrectly handles versioning.
    // Once LevelDB supports a single, uint64_t version and throws out the old string version, these
    // should be gotten rid of.
    // Also, "NoIntVersion" used to be a magic number of -1, which doesn't work with the new unsigned type.
    // Changing the value to INT64_MAX here seems like a reasonable temporary fix as the current LevelDB
    // already cannot represent valid version numbers between INT64_MAX and UINT64_MAX.

#ifndef INT64_MAX
#define INT64_MAX 9223372036854775807LL
#endif

    enum {
        NoIntVersion = INT64_MAX,
        DefaultIntVersion = 0
    };

    IDBDatabaseMetadata()
        : id(0)
        , version(0)
        , maxObjectStoreId(0)
    {
    }

    IDBDatabaseMetadata(const String& name, int64_t id, uint64_t version, int64_t maxObjectStoreId)
        : name(name)
        , id(id)
        , version(version)
        , maxObjectStoreId(maxObjectStoreId)
    {
    }

    String name;
    int64_t id;
    uint64_t version;
    int64_t maxObjectStoreId;

    typedef HashMap<int64_t, IDBObjectStoreMetadata> ObjectStoreMap;
    ObjectStoreMap objectStores;

    WEBCORE_EXPORT IDBDatabaseMetadata isolatedCopy() const;
};

} // namespace WebCore

#endif // ENABLE(INDEXED_DATABASE)
#endif // IDBDatabaseMetadata_h