Style

class ccg.Style

Bases: object

check_hungarian = False

class GroupDelimitatorStyle(new_line_open_before, new_line_open_after, new_line_close_before, new_line_close_after, space_open_before, space_open_after, space_close_before, space_close_after)

Bases: object

open or close brackets or parentheses style

Parameters

• new_line_open_before (bool) –

• new_line_open_after (bool) –

• new_line_close_before (bool) –

• new_line_close_after (bool) –

• space_open_before (bool) –

• space_open_after (bool) –

• space_close_before (bool) –

• space_close_after (bool) –

function_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

function_definition_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

function_declaration_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

function_new_line_after_type_declaration = True

function_space_after_name_definition = False

function_space_after_name_declaration = False

function_void_when_no_arguments = True

function_indent_content = True

struct_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

struct_new_line_members = True

struct_indent_members = True

struct_space_members = False

union_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

union_new_line_members = True

union_indent_members = True

union_space_members = False

enum_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

enum_new_line_members = True

enum_indent_members = True

enum_space_members = False

class_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

class_indent_members = True

class_indent_access = False

if_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

if_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

if_indent_content = True

if_space_after_token = True

else_if_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

else_if_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

else_if_indent_content = True

else_if_space_after_token = True

else_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

else_indent_content = True

else_space_after_token = True

switch_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

switch_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

switch_indent_content = True

switch_indent_case_content = True

switch_space_after_token = True

while_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

while_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

while_indent_content = True

while_space_after_token = True

do_while_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

do_while_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

do_while_indent_content = True

do_while_space_after_token = True

for_bracket = <ccg.style.Style.GroupDelimitatorStyle object>

for_parentheses = <ccg.style.Style.GroupDelimitatorStyle object>

for_indent_content = True

for_space_before_semicolon = False

for_space_after_semicolon = True

for_spaces_if_void = False

for_space_after_token = True

space_after_cast = False

space_unary_operator = False

space_before_binary_operator = True

space_after_binary_operator = True

space_before_parentheses_operator = False

space_after_parentheses_operator = False

space_before_semicolon_break_statement = False

space_before_semicolon_continue_statement = False

space_before_semicolon_return_statement = False

attribute_packed = '__attribute__((__packed__))'

class ClassMembers(value)

Bases: enum.Enum

An enumeration.

inline_access_preserve_order = 0

group_by_access_specified = 1

class_members = 1

literal_unsigned_token = 'U'

literal_long_token = 'L'

literal_float_token = 'f'

literal_double_token = 'd'

literal_boolean_true_token = 'true'

literal_boolean_false_token = 'false'

literal_hexadecimal_uppercase = True

class NotOperatorsStyles(value)

Bases: enum.Enum

An enumeration.

Exclamation = '!'

Explicit = 'not'

class AndOperatorStyles(value)

Bases: enum.Enum

An enumeration.

DoubleAmpersand = '&&'

Explicit = 'and'

class OrOperatorStyles(value)

Bases: enum.Enum

An enumeration.

DoubleVerticalBar = '||'

Explicit = 'or'

not_operator_style = '!'

and_operator_style = '&&'

or_operator_style = '||'

new_line_token = '\n'

indent_token = '\t'

space_token = ' '

bracket_open_token = '{'

bracket_close_token = '}'

parentheses_open_token = '('

parentheses_close_token = ')'

space(active=True)

Parameters

active (bool) –

Return type

str

new_line(active=True)

Parameters

active (bool) –

Return type

str

indent(value, active=True)

Parameters

• value (str) –

• active (bool) –

Return type

str

open_bracket(group_style)

Parameters

group_style (ccg.style.Style.GroupDelimitatorStyle) –

close_bracket(group_style)

Parameters

group_style (ccg.style.Style.GroupDelimitatorStyle) –

open_parentheses(group_style)

Parameters

group_style (ccg.style.Style.GroupDelimitatorStyle) –

close_parentheses(group_style)

Parameters

group_style (ccg.style.Style.GroupDelimitatorStyle) –

token_separated_members(token, members, new_line, indent, space)

Parameters

• token (str) –

• members (List[str]) –

• new_line (bool) –

• indent (bool) –

• space (bool) –

static check_hungarian_variable(variable_name, hungarian_prefixes)

Parameters

• variable_name (str) –

• hungarian_prefixes (Union[List[str], str]) –

Return type

bool

doc_doxygen_start_block = '/**'

doc_doxygen_line_block = ' * '

doc_doxygen_end_block = ' */'

doc_doxygen_command_token = '@'

doxygen_format(lines)

Parameters

lines (List[str]) –

Return type

str

doxygen_command(command_name)

Parameters

command_name (str) –

Return type

str

user_section_begin_pattern_before = '\\/\\* USER SECTION BEGIN '

Regex Token before identifier in begin section

user_section_begin_pattern_after = ' \\*\\/'

Regex Token after identifier in begin section

user_section_end_pattern_before = '\\/\\* USER SECTION END '

Regex Token before identifier in end section

user_section_end_pattern_after = ' \\*\\/'

Regex Token after identifier in end section

user_section_begin_pattern(identifier)

Regex pattern to find begin sections

Parameters

identifier (str) – identifier of the user section

Returns

regex pattern

Return type

str

user_section_end_pattern(identifier)

Regex pattern to find end sections

Parameters

identifier (str) – identifier of the user section

Returns

regex pattern

Return type

str

user_section_identifier_pattern = '([a-zA-Z0-9_-]*)'

User Section identifier must match this pattern

user_section_pattern(identifier='([a-zA-Z0-9_-]*)')

Regex pattern to find a complete user section

Parameters

identifier (str) – identifier of the user section. Defaults to any identifier

Returns

regex pattern

Return type

str

user_section_begin(identifier)

String to begin user section

Parameters

identifier (str) – identifier of the user section

Return type

str

user_section_end(identifier)

String to end user section

Parameters

identifier (str) – identifier of the user section

Return type

str