clang::SortIncludesOptions Struct Reference

Includes sorting options. More...

#include "clang/Format/Format.h"

Public Member Functions
bool	operator== (const SortIncludesOptions &R) const
bool	operator!= (const SortIncludesOptions &R) const

Public Attributes
bool	Enabled
	If true, includes are sorted based on the other suboptions below. (Never is deprecated by Enabled: false.)
bool	IgnoreCase
	Whether or not includes are sorted in a case-insensitive fashion. (CaseSensitive and CaseInsensitive are deprecated by IgnoreCase: false and IgnoreCase: true, respectively.)
bool	IgnoreExtension
	When sorting includes in each block, only take file extensions into account if two includes compare equal otherwise.
bool	Natural
	Whether or not includes are sorted by natural ordering i.e., whether embedded runs of digits are compared as numbers rather than sequences of characters.

Detailed Description

Includes sorting options.

Definition at line 5052 of file Format.h.

Member Function Documentation

operator!=()

bool clang::SortIncludesOptions::operator!= ( const SortIncludesOptions & R ) const

inline

Definition at line 5090 of file Format.h.

operator==()

bool clang::SortIncludesOptions::operator== ( const SortIncludesOptions & R ) const

inline

Definition at line 5086 of file Format.h.

References Enabled, IgnoreCase, IgnoreExtension, and Natural.

Member Data Documentation

Enabled

bool clang::SortIncludesOptions::Enabled

If true, includes are sorted based on the other suboptions below. (Never is deprecated by Enabled: false.)

Definition at line 5055 of file Format.h.

Referenced by operator==().

IgnoreCase

bool clang::SortIncludesOptions::IgnoreCase

Whether or not includes are sorted in a case-insensitive fashion. (CaseSensitive and CaseInsensitive are deprecated by IgnoreCase: false and IgnoreCase: true, respectively.)

true:                      false:
#include "A/B.h"    vs.    #include "A/B.h"
#include "A/b.h"           #include "A/b.h"
#include "a/b.h"           #include "B/A.h"
#include "B/A.h"           #include "B/a.h"
#include "B/a.h"           #include "a/b.h"

Definition at line 5067 of file Format.h.

Referenced by operator==().

IgnoreExtension

bool clang::SortIncludesOptions::IgnoreExtension

When sorting includes in each block, only take file extensions into account if two includes compare equal otherwise.

true:                          false:
# include "A.h"         vs.    # include "A-util.h"
# include "A.inc"              # include "A.h"
# include "A-util.h"           # include "A.inc"

Definition at line 5076 of file Format.h.

Referenced by operator==().

Natural

bool clang::SortIncludesOptions::Natural

Whether or not includes are sorted by natural ordering i.e., whether embedded runs of digits are compared as numbers rather than sequences of characters.

true:                      false:
#include "A2.h"     vs.    #include "A10.h"
#include "A10.h"           #include "A2.h"

Definition at line 5085 of file Format.h.

Referenced by operator==().

---

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

• include/clang/Format/Format.h