clang 20.0.0git
Public Member Functions | Public Attributes | List of all members
clang::format::FormatStyle::AlignConsecutiveStyle Struct Reference

Alignment options. More...

#include "clang/Format/Format.h"

Public Member Functions

bool operator== (const AlignConsecutiveStyle &R) const
 
bool operator!= (const AlignConsecutiveStyle &R) const
 

Public Attributes

bool Enabled
 Whether aligning is enabled.
 
bool AcrossEmptyLines
 Whether to align across empty lines.
 
bool AcrossComments
 Whether to align across comments.
 
bool AlignCompound
 Only for AlignConsecutiveAssignments.
 
bool AlignFunctionPointers
 Only for AlignConsecutiveDeclarations.
 
bool PadOperators
 Only for AlignConsecutiveAssignments.
 

Detailed Description

Alignment options.

They can also be read as a whole for compatibility. The choices are:

For example, to align across empty lines and not across comments, either of these work.

<option-name>: AcrossEmptyLines
<option-name>:
Enabled: true
bool AcrossEmptyLines
Whether to align across empty lines.
Definition: Format.h:202
bool Enabled
Whether aligning is enabled.
Definition: Format.h:185
bool AcrossComments
Whether to align across comments.
Definition: Format.h:215

Definition at line 164 of file Format.h.

Member Function Documentation

◆ operator!=()

bool clang::format::FormatStyle::AlignConsecutiveStyle::operator!= ( const AlignConsecutiveStyle R) const
inline

Definition at line 270 of file Format.h.

◆ operator==()

bool clang::format::FormatStyle::AlignConsecutiveStyle::operator== ( const AlignConsecutiveStyle R) const
inline

Member Data Documentation

◆ AcrossComments

bool clang::format::FormatStyle::AlignConsecutiveStyle::AcrossComments

Whether to align across comments.

true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;

Definition at line 215 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().

◆ AcrossEmptyLines

bool clang::format::FormatStyle::AlignConsecutiveStyle::AcrossEmptyLines

Whether to align across empty lines.

true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
__device__ __2f16 float c

Definition at line 202 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().

◆ AlignCompound

bool clang::format::FormatStyle::AlignConsecutiveStyle::AlignCompound

Only for AlignConsecutiveAssignments.

Whether compound assignments like += are aligned along with =.

true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;

Definition at line 227 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().

◆ AlignFunctionPointers

bool clang::format::FormatStyle::AlignConsecutiveStyle::AlignFunctionPointers

Only for AlignConsecutiveDeclarations.

Whether function pointers are aligned.

true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
__device__ int

Definition at line 243 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().

◆ Enabled

bool clang::format::FormatStyle::AlignConsecutiveStyle::Enabled

Whether aligning is enabled.

#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
__device__ __2f16 b

Definition at line 185 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().

◆ PadOperators

bool clang::format::FormatStyle::AlignConsecutiveStyle::PadOperators

Only for AlignConsecutiveAssignments.

Whether short assignment operators are left-padded to the same length as long ones in order to put all assignment operators to the right of the left hand side.

true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;

Definition at line 262 of file Format.h.

Referenced by clang::format::getLLVMStyle(), and operator==().


The documentation for this struct was generated from the following file: