Source/JavaScriptCore/runtime/EnumerationMode.h

/*
 * Copyright (C) 2014 Apple 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. 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 INC. 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 EnumerationMode_h
#define EnumerationMode_h

namespace JSC {

enum EnumerationMode {
    ExcludeDontEnumProperties,
    ExcludeDontEnumPropertiesAndSkipJSObject,
    IncludeDontEnumProperties,
    IncludeDontEnumPropertiesAndSkipJSObject
};

inline bool shouldIncludeDontEnumProperties(EnumerationMode mode)
{
    switch (mode) {
    case IncludeDontEnumProperties:
    case IncludeDontEnumPropertiesAndSkipJSObject:
        return true;
    default:
        return false;
    }
}

inline bool shouldExcludeDontEnumProperties(EnumerationMode mode)
{
    switch (mode) {
    case ExcludeDontEnumProperties:
    case ExcludeDontEnumPropertiesAndSkipJSObject:
        return true;
    default:
        return false;
    }
}

inline bool shouldIncludeJSObjectPropertyNames(EnumerationMode mode)
{
    switch (mode) {
    case IncludeDontEnumProperties:
    case ExcludeDontEnumProperties:
        return true;
    case ExcludeDontEnumPropertiesAndSkipJSObject:
    case IncludeDontEnumPropertiesAndSkipJSObject:
        return false;
    }
    ASSERT_NOT_REACHED();
    return false;
}

inline EnumerationMode modeThatSkipsJSObject(EnumerationMode mode)
{
    switch (mode) {
    case IncludeDontEnumProperties:
        return IncludeDontEnumPropertiesAndSkipJSObject;
    case ExcludeDontEnumProperties:
        return ExcludeDontEnumPropertiesAndSkipJSObject;
    case ExcludeDontEnumPropertiesAndSkipJSObject:
    case IncludeDontEnumPropertiesAndSkipJSObject:
        return mode;
    }
    ASSERT_NOT_REACHED();
    return mode;
}

} // namespace JSC

#endif // EnumerationMode_h