diff options
Diffstat (limited to 'include/lldb/Utility/UserID.h')
-rw-r--r-- | include/lldb/Utility/UserID.h | 41 |
1 files changed, 7 insertions, 34 deletions
diff --git a/include/lldb/Utility/UserID.h b/include/lldb/Utility/UserID.h index 8560274bdeac..2dc5cdb23d0e 100644 --- a/include/lldb/Utility/UserID.h +++ b/include/lldb/Utility/UserID.h @@ -1,9 +1,8 @@ //===-- UserID.h ------------------------------------------------*- C++ -*-===// // -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// @@ -12,14 +11,11 @@ #include "lldb/lldb-defines.h" #include "lldb/lldb-types.h" -namespace lldb_private { -class Stream; -} namespace lldb_private { +class Stream; -//---------------------------------------------------------------------- -/// @class UserID UserID.h "lldb/Core/UserID.h" +/// \class UserID UserID.h "lldb/Core/UserID.h" /// A mix in class that contains a generic user ID. /// /// UserID is designed as a mix in class that can contain an integer based @@ -32,42 +28,30 @@ namespace lldb_private { /// Symbol table entries can use this to store the original symbol table /// index, functions can use it to store the symbol table index or the /// DWARF offset. -//---------------------------------------------------------------------- struct UserID { - //------------------------------------------------------------------ /// Construct with optional user ID. - //------------------------------------------------------------------ UserID(lldb::user_id_t uid = LLDB_INVALID_UID) : m_uid(uid) {} - //------------------------------------------------------------------ /// Destructor. - //------------------------------------------------------------------ ~UserID() {} - //------------------------------------------------------------------ /// Clears the object state. /// /// Clears the object contents back to a default invalid state. - //------------------------------------------------------------------ void Clear() { m_uid = LLDB_INVALID_UID; } - //------------------------------------------------------------------ /// Get accessor for the user ID. /// - /// @return + /// \return /// The user ID. - //------------------------------------------------------------------ lldb::user_id_t GetID() const { return m_uid; } - //------------------------------------------------------------------ /// Set accessor for the user ID. /// - /// @param[in] uid + /// \param[in] uid /// The new user ID. - //------------------------------------------------------------------ void SetID(lldb::user_id_t uid) { m_uid = uid; } - //------------------------------------------------------------------ /// Unary predicate function object that can search for a matching user ID. /// /// Function object that can be used on any class that inherits from UserID: @@ -75,30 +59,21 @@ struct UserID { /// iterator pos; /// pos = std::find_if (coll.begin(), coll.end(), UserID::IDMatches(blockID)); /// \endcode - //------------------------------------------------------------------ class IDMatches { public: - //-------------------------------------------------------------- /// Construct with the user ID to look for. - //-------------------------------------------------------------- IDMatches(lldb::user_id_t uid) : m_uid(uid) {} - //-------------------------------------------------------------- /// Unary predicate function object callback. - //-------------------------------------------------------------- bool operator()(const UserID &rhs) const { return m_uid == rhs.GetID(); } private: - //-------------------------------------------------------------- // Member variables. - //-------------------------------------------------------------- const lldb::user_id_t m_uid; ///< The user ID we are looking for }; protected: - //------------------------------------------------------------------ // Member variables. - //------------------------------------------------------------------ lldb::user_id_t m_uid; ///< The user ID that uniquely identifies an object. }; @@ -110,9 +85,7 @@ inline bool operator!=(const UserID &lhs, const UserID &rhs) { return lhs.GetID() != rhs.GetID(); } -//-------------------------------------------------------------- /// Stream the UserID object to a Stream. -//-------------------------------------------------------------- Stream &operator<<(Stream &strm, const UserID &uid); } // namespace lldb_private |