clang  14.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::syntax::List Class Reference

A list of Elements separated or terminated by a fixed token. More...

#include "clang/Tooling/Syntax/Tree.h"

Inheritance diagram for clang::syntax::List:
Inheritance graph
[legend]
Collaboration diagram for clang::syntax::List:
Collaboration graph
[legend]

Classes

struct  ElementAndDelimiter
 

Public Types

enum  TerminationKind { TerminationKind::Terminated, TerminationKind::MaybeTerminated, TerminationKind::Separated }
 

Public Member Functions

std::vector< ElementAndDelimiter< Node > > getElementsAsNodesAndDelimiters ()
 Returns the elements and corresponding delimiters. More...
 
std::vector< Node * > getElementsAsNodes ()
 Returns the elements of the list. More...
 
clang::tok::TokenKind getDelimiterTokenKind () const
 Returns the appropriate delimiter for this list. More...
 
TerminationKind getTerminationKind () const
 
bool canBeEmpty () const
 Whether this list can be empty in syntactically and semantically correct code. More...
 
- Public Member Functions inherited from clang::syntax::Tree
NodegetFirstChild ()
 
const NodegetFirstChild () const
 
NodegetLastChild ()
 
const NodegetLastChild () const
 
const LeaffindFirstLeaf () const
 
LeaffindFirstLeaf ()
 
const LeaffindLastLeaf () const
 
LeaffindLastLeaf ()
 
llvm::iterator_range< ChildIteratorgetChildren ()
 
llvm::iterator_range< ConstChildIteratorgetChildren () const
 
const NodefindChild (NodeRole R) const
 Find the first node with a corresponding role. More...
 
NodefindChild (NodeRole R)
 
- Public Member Functions inherited from clang::syntax::Node
 Node (const Node &)=delete
 Nodes cannot simply be copied without violating tree invariants. More...
 
Nodeoperator= (const Node &)=delete
 
 Node (Node &&)=delete
 Idiomatically, nodes are allocated on an Arena and never moved. More...
 
Nodeoperator= (Node &&)=delete
 
NodeKind getKind () const
 
NodeRole getRole () const
 
bool isDetached () const
 Whether the node is detached from a tree, i.e. does not have a parent. More...
 
bool isOriginal () const
 Whether the node was created from the AST backed by the source code rather than added later through mutation APIs or created with factory functions. More...
 
bool canModify () const
 If this function return false, the tree cannot be modified because there is no reasonable way to produce the corresponding textual replacements. More...
 
const TreegetParent () const
 
TreegetParent ()
 
const NodegetNextSibling () const
 
NodegetNextSibling ()
 
const NodegetPreviousSibling () const
 
NodegetPreviousSibling ()
 
std::string dump (const SourceManager &SM) const
 Dumps the structure of a subtree. For debugging and testing purposes. More...
 
std::string dumpTokens (const SourceManager &SM) const
 Dumps the tokens forming this subtree. More...
 
void assertInvariants () const
 Asserts invariants on this node of the tree and its immediate children. More...
 
void assertInvariantsRecursive () const
 Runs checkInvariants on all nodes in the subtree. No-op if NDEBUG is set. More...
 

Static Public Member Functions

static bool classof (const Node *N)
 
- Static Public Member Functions inherited from clang::syntax::Tree
static bool classof (const Node *N)
 

Additional Inherited Members

- Protected Member Functions inherited from clang::syntax::Tree
 Node (NodeKind Kind)
 Newly created nodes are detached from a tree, parent and sibling links are set when the node is added as a child to another one. More...
 
 Node (const Node &)=delete
 Nodes cannot simply be copied without violating tree invariants. More...
 
 Node (Node &&)=delete
 Idiomatically, nodes are allocated on an Arena and never moved. More...
 
- Protected Member Functions inherited from clang::syntax::Node
 Node (NodeKind Kind)
 Newly created nodes are detached from a tree, parent and sibling links are set when the node is added as a child to another one. More...
 
 ~Node ()=default
 Nodes are allocated on Arenas; the destructor is never called. More...
 

Detailed Description

A list of Elements separated or terminated by a fixed token.

This type models the following grammar construct: delimited-list(element, delimiter, termination, canBeEmpty)

Definition at line 284 of file Tree.h.

Member Enumeration Documentation

◆ TerminationKind

Enumerator
Terminated 
MaybeTerminated 
Separated 

Definition at line 291 of file Tree.h.

Member Function Documentation

◆ canBeEmpty()

bool syntax::List::canBeEmpty ( ) const

Whether this list can be empty in syntactically and semantically correct code.

This list may be empty when the source code has errors even if canBeEmpty() returns false.

Definition at line 456 of file Tree.cpp.

References getKind().

◆ classof()

static bool clang::syntax::List::classof ( const Node N)
static

◆ getDelimiterTokenKind()

clang::tok::TokenKind syntax::List::getDelimiterTokenKind ( ) const

Returns the appropriate delimiter for this list.

Useful for discovering the correct delimiter to use when adding elements to empty or one-element lists.

Definition at line 428 of file Tree.cpp.

References getKind().

◆ getElementsAsNodes()

std::vector< syntax::Node * > syntax::List::getElementsAsNodes ( )

Returns the elements of the list.

Missing elements are represented as null pointers in the same way as in the return value of getElementsAsNodesAndDelimiters().

Definition at line 386 of file Tree.cpp.

References clang::syntax::ListDelimiter, clang::syntax::ListElement, MaybeTerminated, Separated, and Terminated.

Referenced by clang::syntax::NestedNameSpecifier::getSpecifiers().

◆ getElementsAsNodesAndDelimiters()

std::vector< syntax::List::ElementAndDelimiter< syntax::Node > > syntax::List::getElementsAsNodesAndDelimiters ( )

Returns the elements and corresponding delimiters.

Missing elements and delimiters are represented as null pointers.

For example, in a separated list: "a, b, c" <=> [("a" , ","), ("b" , "," ), ("c" , null)] "a, , c" <=> [("a" , ","), (null, "," ), ("c" , null)] "a, b c" <=> [("a" , ","), ("b" , null), ("c" , null)] "a, b," <=> [("a" , ","), ("b" , "," ), (null, null)]

In a terminated or maybe-terminated list: "a; b; c;" <=> [("a" , ";"), ("b" , ";" ), ("c" , ";" )] "a; ; c;" <=> [("a" , ";"), (null, ";" ), ("c" , ";" )] "a; b c;" <=> [("a" , ";"), ("b" , null), ("c" , ";" )] "a; b; c" <=> [("a" , ";"), ("b" , ";" ), ("c" , null)]

Definition at line 341 of file Tree.cpp.

References clang::syntax::ListDelimiter, clang::syntax::ListElement, MaybeTerminated, Separated, and Terminated.

◆ getTerminationKind()

syntax::List::TerminationKind syntax::List::getTerminationKind ( ) const

Definition at line 442 of file Tree.cpp.

References getKind().


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