src/hotspot/share/metaprogramming/integralConstant.hpp
author coleenp
Thu, 10 Jan 2019 15:13:51 -0500
changeset 53244 9807daeb47c4
parent 49621 5ef28d560b6f
permissions -rw-r--r--
8216167: Update include guards to reflect correct directories Summary: Use script and some manual fixup to fix directores names in include guards. Reviewed-by: lfoltan, eosterlund, kbarrett
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46649
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     1
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49621
diff changeset
     2
 * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
46649
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     4
 *
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     7
 * published by the Free Software Foundation.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     8
 *
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    13
 * accompanied this code).
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    14
 *
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    18
 *
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    21
 * questions.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    22
 *
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    23
 */
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    24
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49621
diff changeset
    25
#ifndef SHARE_METAPROGRAMMING_INTEGRALCONSTANT_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49621
diff changeset
    26
#define SHARE_METAPROGRAMMING_INTEGRALCONSTANT_HPP
46649
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    27
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    28
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    29
// An Integral Constant is a class providing a compile-time value of an
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    30
// integral type.  An Integral Constant is also a nullary metafunction,
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    31
// returning itself.  An integral constant object is implicitly
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    32
// convertible to the associated value.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    33
//
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    34
// A type n is a model of Integral Constant if it meets the following
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    35
// requirements:
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    36
//
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    37
// n::ValueType                : The integral type of n::value
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    38
// n::value                    : An integral constant expression
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    39
// n::type                     : IsSame<n::type, n>::value is true
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    40
// n::value_type const c = n() : c == n::value
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    41
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    42
// A model of the Integer Constant concept.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    43
// T is an integral type, and is the value_type.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    44
// v is an integral constant, and is the value.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    45
template<typename T, T v>
49364
601146c66cad 8173070: Remove ValueObj class for allocation subclassing for runtime code
coleenp
parents: 47644
diff changeset
    46
struct IntegralConstant {
46649
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    47
  typedef T value_type;
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    48
  static const value_type value = v;
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    49
  typedef IntegralConstant<T, v> type;
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    50
  operator value_type() { return value; }
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    51
};
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    52
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    53
// A bool valued IntegralConstant whose value is true.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    54
typedef IntegralConstant<bool, true> TrueType;
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    55
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    56
// A bool valued IntegralConstant whose value is false.
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    57
typedef IntegralConstant<bool, false> FalseType;
439ffb1e05ec 8183927: Hotspot needs C++ type_traits metaprogramming utilities
eosterlund
parents:
diff changeset
    58
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 49621
diff changeset
    59
#endif // SHARE_METAPROGRAMMING_INTEGRALCONSTANT_HPP