binutils-gdb/gdbsupport/gdb-checked-static-cast.h
Andrew Burgess 1d506c26d9 Update copyright year range in header of all files managed by GDB
This commit is the result of the following actions:

  - Running gdb/copyright.py to update all of the copyright headers to
    include 2024,

  - Manually updating a few files the copyright.py script told me to
    update, these files had copyright headers embedded within the
    file,

  - Regenerating gdbsupport/Makefile.in to refresh it's copyright
    date,

  - Using grep to find other files that still mentioned 2023.  If
    these files were updated last year from 2022 to 2023 then I've
    updated them this year to 2024.

I'm sure I've probably missed some dates.  Feel free to fix them up as
you spot them.
2024-01-12 15:49:57 +00:00

88 lines
2.8 KiB
C++

/* Copyright (C) 2022-2024 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef COMMON_GDB_CHECKED_DYNAMIC_CAST_H
#define COMMON_GDB_CHECKED_DYNAMIC_CAST_H
#include "gdbsupport/traits.h"
namespace gdb
{
/* This function can be used in place of static_cast when casting between
pointers of polymorphic types. The benefit of using this call is that,
when compiling in developer mode, dynamic_cast will be used to validate
the cast. This use of dynamic_cast is why this function will only
work for polymorphic types.
In non-developer (i.e. production) builds, the dynamic_cast is replaced
with a static_cast which is usually significantly faster. */
template<typename T, typename V>
T
checked_static_cast (V *v)
{
/* We only support casting to pointer types. */
static_assert (std::is_pointer<T>::value, "target must be a pointer type");
/* Check for polymorphic types explicitly in case we're in release mode. */
static_assert (std::is_polymorphic<V>::value, "types must be polymorphic");
/* Figure out the type that T points to. */
using T_no_P = typename std::remove_pointer<T>::type;
/* In developer mode this cast uses dynamic_cast to confirm at run-time
that the cast from V* to T is valid. However, we can catch some
mistakes at compile time, this assert prevents anything other than
downcasts, or casts to same type. */
static_assert (std::is_base_of<V, T_no_P>::value
|| std::is_base_of<T_no_P, V>::value,
"types must be related");
#ifdef DEVELOPMENT
if (v == nullptr)
return nullptr;
T result = dynamic_cast<T> (v);
gdb_assert (result != nullptr);
#else
T result = static_cast<T> (v);
#endif
return result;
}
/* Same as the above, but to cast from a reference type to another. */
template<typename T, typename V, typename = gdb::Requires<std::is_reference<T>>>
T
checked_static_cast (V &v)
{
static_assert (std::is_reference<T>::value, "target must be a reference type");
using T_no_R = typename std::remove_reference<T>::type;
using T_P = typename std::add_pointer<T_no_R>::type;
using V_no_R = typename std::remove_reference<V>::type;
return *checked_static_cast<T_P, V_no_R> (&v);
}
}
#endif /* COMMON_GDB_CHECKED_DYNAMIC_CAST_H */