clang-tools 22.0.0git
clang::clangd::RenameSymbolName Class Reference

A name of a symbol that should be renamed. More...

#include <Rename.h>

Public Member Functions

 RenameSymbolName ()
 RenameSymbolName (ArrayRef< std::string > NamePieces)
 Create a new SymbolName with the specified pieces.
 RenameSymbolName (const DeclarationName &Name)
ArrayRef< std::string > getNamePieces () const
std::optional< std::string > getSinglePiece () const
 If this symbol consists of a single piece return it, otherwise return None.
std::string getAsString () const
 Returns a human-readable version of this symbol name.
void print (raw_ostream &OS) const
bool operator== (const RenameSymbolName &Other) const

Detailed Description

A name of a symbol that should be renamed.

Symbol's name can be composed of multiple strings. For example, Objective-C methods can contain multiple argument labels:

- (void) myMethodNamePiece: (int)x anotherNamePieces:(int)y;
^~ string 0 ~~~~~ ^~ string 1 ~~~~~

Definition at line 47 of file Rename.h.

Constructor & Destructor Documentation

◆ RenameSymbolName() [1/3]

clang::clangd::RenameSymbolName::RenameSymbolName ( )

Definition at line 1015 of file Rename.cpp.

Referenced by operator==(), and RenameSymbolName().

◆ RenameSymbolName() [2/3]

clang::clangd::RenameSymbolName::RenameSymbolName ( ArrayRef< std::string > NamePieces)
explicit

Create a new SymbolName with the specified pieces.

Definition at line 1036 of file Rename.cpp.

◆ RenameSymbolName() [3/3]

clang::clangd::RenameSymbolName::RenameSymbolName ( const DeclarationName & Name)
explicit

Definition at line 1033 of file Rename.cpp.

References RenameSymbolName().

Member Function Documentation

◆ getAsString()

std::string clang::clangd::RenameSymbolName::getAsString ( ) const

Returns a human-readable version of this symbol name.

If the symbol consists of multiple pieces (aka. it is an Objective-C selector/method name), the pieces are separated by :, otherwise just an identifier name.

Definition at line 1048 of file Rename.cpp.

References print().

◆ getNamePieces()

ArrayRef< std::string > clang::clangd::RenameSymbolName::getNamePieces ( ) const
inline

Definition at line 58 of file Rename.h.

Referenced by getSinglePiece().

◆ getSinglePiece()

std::optional< std::string > clang::clangd::RenameSymbolName::getSinglePiece ( ) const

If this symbol consists of a single piece return it, otherwise return None.

Only symbols in Objective-C can consist of multiple pieces, so this function always returns a value for non-Objective-C symbols.

Definition at line 1041 of file Rename.cpp.

References getNamePieces().

◆ operator==()

bool clang::clangd::RenameSymbolName::operator== ( const RenameSymbolName & Other) const
inline

Definition at line 76 of file Rename.h.

References RenameSymbolName().

◆ print()

void clang::clangd::RenameSymbolName::print ( raw_ostream & OS) const

Definition at line 1055 of file Rename.cpp.

Referenced by getAsString().


The documentation for this class was generated from the following files: