runtime/EnumerationMode.h

   1 /*
   2  * Copyright (C) 2014 Apple 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  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef EnumerationMode_h
  27 #define EnumerationMode_h
  28
  29 namespace JSC {
  30
  31 enum class DontEnumPropertiesMode {
  32     Include,
  33     Exclude
  34 };
  35
  36 enum class SymbolPropertiesMode {
  37     Include,
  38     Exclude
  39 };
  40
  41 enum class JSObjectPropertiesMode {
  42     Include,
  43     Exclude
  44 };
  45
  46 class EnumerationMode {
  47 public:
  48     EnumerationMode(DontEnumPropertiesMode dontEnumPropertiesMode = DontEnumPropertiesMode::Exclude, SymbolPropertiesMode symbolPropertiesMode = SymbolPropertiesMode::Exclude, JSObjectPropertiesMode jsObjectPropertiesMode = JSObjectPropertiesMode::Include)
  49         : m_dontEnumPropertiesMode(dontEnumPropertiesMode)
  50         , m_symbolPropertiesMode(symbolPropertiesMode)
  51         , m_jsObjectPropertiesMode(jsObjectPropertiesMode)
  52     {
  53     }
  54
  55     EnumerationMode(const EnumerationMode& mode, JSObjectPropertiesMode jsObjectPropertiesMode)
  56         : m_dontEnumPropertiesMode(mode.m_dontEnumPropertiesMode)
  57         , m_symbolPropertiesMode(mode.m_symbolPropertiesMode)
  58         , m_jsObjectPropertiesMode(jsObjectPropertiesMode)
  59     {
  60     }
  61
  62     // Add other constructors as needed for convenience
  63
  64     bool includeDontEnumProperties()
  65     {
  66         return m_dontEnumPropertiesMode == DontEnumPropertiesMode::Include;
  67     }
  68
  69     bool includeSymbolProperties()
  70     {
  71         return m_symbolPropertiesMode == SymbolPropertiesMode::Include;
  72     }
  73
  74     bool includeJSObjectProperties()
  75     {
  76         return m_jsObjectPropertiesMode == JSObjectPropertiesMode::Include;
  77     }
  78
  79 private:
  80     DontEnumPropertiesMode m_dontEnumPropertiesMode;
  81     SymbolPropertiesMode m_symbolPropertiesMode;
  82     JSObjectPropertiesMode m_jsObjectPropertiesMode;
  83 };
  84
  85 } // namespace JSC
  86
  87 #endif // EnumerationMode_h