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.
 */

#pragma once

namespace JSC {

enum class PropertyNameMode {
    Symbols = 1 << 0,
    Strings = 1 << 1,
    StringsAndSymbols = Symbols | Strings,
};

enum class PrivateSymbolMode {
    Include,
    Exclude
};

enum class DontEnumPropertiesMode {
    Include,
    Exclude
};

enum class JSObjectPropertiesMode {
    Include,
    Exclude
};

class EnumerationMode {
public:
    EnumerationMode(DontEnumPropertiesMode dontEnumPropertiesMode = DontEnumPropertiesMode::Exclude, JSObjectPropertiesMode jsObjectPropertiesMode = JSObjectPropertiesMode::Include)
        : m_dontEnumPropertiesMode(dontEnumPropertiesMode)
        , m_jsObjectPropertiesMode(jsObjectPropertiesMode)
    {
    }

    EnumerationMode(const EnumerationMode& mode, JSObjectPropertiesMode jsObjectPropertiesMode)
        : m_dontEnumPropertiesMode(mode.m_dontEnumPropertiesMode)
        , m_jsObjectPropertiesMode(jsObjectPropertiesMode)
    {
    }

    // Add other constructors as needed for convenience

    bool includeDontEnumProperties()
    {
        return m_dontEnumPropertiesMode == DontEnumPropertiesMode::Include;
    }

    bool includeJSObjectProperties()
    {
        return m_jsObjectPropertiesMode == JSObjectPropertiesMode::Include;
    }

private:
    DontEnumPropertiesMode m_dontEnumPropertiesMode;
    JSObjectPropertiesMode m_jsObjectPropertiesMode;
};

} // namespace JSC