~drizzle-trunk/drizzle/development : revision 2166

1

#

2

# Uncrustify options (with comments) for Pandora Projects

3

#

4

5

#

6

# This program is free software; you can redistribute it and/or modify

7

# it under the terms of the GNU General Public License as published by

8

# the Free Software Foundation; version 2 of the License.

9

#

10

# This program is distributed in the hope that it will be useful,

11

# but WITHOUT ANY WARRANTY; without even the implied warranty of

12

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

13

# GNU General Public License for more details.

14

#

15

# You should have received a copy of the GNU General Public License

16

# along with this program; if not, write to the Free Software

17

# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

18

#

19

20

nl_after_brace_close = TRUE

21

22

# The type of line endings

23

newlines = lf # auto/lf/crlf/cr

24

25

# The original size of tabs in the input

26

input_tab_size = 8 # number

27

28

# The size of tabs in the output (only used if align_with_tabs=true)

29

output_tab_size = 3 # number

30

31

# The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn)

32

string_escape_char = 92 # number

33

34

# Alternate string escape char for Pawn. Only works right before the quote char.

35

string_escape_char2 = 0 # number

36

37

#

38

# Indenting

39

#

40

41

# The number of columns to indent per level.

42

# Usually 2, 3, 4, or 8.

43

indent_columns = 2 # number

44

45

# How to use tabs when indenting code

46

# 0=spaces only

47

# 1=indent with tabs, align with spaces

48

# 2=indent and align with tabs

49

indent_with_tabs = 0 # number

50

51

# Whether to indent strings broken by '\' so that they line up

52

indent_align_string = true # false/true

53

54

# The number of spaces to indent multi-line XML strings.

55

# Requires indent_align_string=True

56

indent_xml_string = 0 # number

57

58

# Spaces to indent '{' from level

59

indent_brace = 0 # number

60

61

# Whether braces are indented to the body level

62

indent_braces = false # false/true

63

64

# Disabled indenting function braces if indent_braces is true

65

indent_braces_no_func = false # false/true

66

67

# Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc.

68

indent_brace_parent = false # false/true

69

70

# Whether the 'namespace' body is indented

71

indent_namespace = false # false/true

72

73

# Whether the 'extern "C"' body is indented

74

indent_extern = false # false/true

75

76

# Whether the 'class' body is indented

77

indent_class = true # false/true

78

79

# Whether to indent the stuff after a leading class colon

80

indent_class_colon = true # false/true

81

82

# False=treat 'else\nif' as 'else if' for indenting purposes

83

# True=indent the 'if' one level

84

indent_else_if = false # false/true

85

86

# True: indent continued function call parameters one indent level

87

# False: align parameters under the open paren

88

indent_func_call_param = false # false/true

89

90

# Same as indent_func_call_param, but for function defs

91

indent_func_def_param = false # false/true

92

93

# Same as indent_func_call_param, but for function protos

94

indent_func_proto_param = false # false/true

95

96

# Same as indent_func_call_param, but for class declarations

97

indent_func_class_param = false # false/true

98

99

# Same as indent_func_call_param, but for class variable constructors

100

indent_func_ctor_var_param = false # false/true

101

102

# Same as indent_func_call_param, but for templates

103

indent_template_param = false # false/true

104

105

# Double the indent for indent_func_xxx_param options

106

indent_func_param_double = false # false/true

107

108

# Indentation column for standalone 'const' function decl/proto qualifier

109

indent_func_const = 0 # number

110

111

# Indentation column for standalone 'throw' function decl/proto qualifier

112

indent_func_throw = 0 # number

113

114

# The number of spaces to indent a continued '->' or '.'

115

# Usually set to 0, 1, or indent_columns.

116

indent_member = 3 # number

117

118

# Spaces to indent single line ('//') comments on lines before code

119

indent_sing_line_comments = 0 # number

120

121

# If set, will indent trailing single line ('//') comments relative

122

# to the code instead of trying to keep the same absolute column

123

indent_relative_single_line_comments = false # false/true

124

125

# Spaces to indent 'case' from 'switch'

126

# Usually 0 or indent_columns.

127

indent_switch_case = 0 # number

128

129

# Spaces to shift the 'case' line, without affecting any other lines

130

# Usually 0.

131

indent_case_shift = 0 # number

132

133

# Spaces to indent '{' from 'case'.

134

# By default, the brace will appear under the 'c' in case.

135

# Usually set to 0 or indent_columns.

136

indent_case_brace = 0 # number

137

138

# Whether to indent comments found in first column

139

indent_col1_comment = false # false/true

140

141

# How to indent goto labels

142

# >0 : absolute column where 1 is the leftmost column

143

# <=0 : subtract from brace indent

144

indent_label = 1 # number

145

146

# Same as indent_label, but for access specifiers that are followed by a colon

147

indent_access_spec = 1 # number

148

149

# Indent the code after an access specifier by one level.

150

# If set, this option forces 'indent_access_spec=0'

151

indent_access_spec_body = false # false/true

152

153

# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)

154

indent_paren_nl = false # false/true

155

156

# Controls the indent of a close paren after a newline.

157

# 0: Indent to body level

158

# 1: Align under the open paren

159

# 2: Indent to the brace level

160

indent_paren_close = 0 # number

161

162

# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren

163

indent_comma_paren = false # false/true

164

165

# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren

166

indent_bool_paren = false # false/true

167

168

# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)

169

indent_square_nl = false # false/true

170

171

# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies

172

indent_preserve_sql = false # false/true

173

174

#

175

# Spacing options

176

#

177

178

# Add or remove space around arithmetic operator '+', '-', '/', '*', etc

179

sp_arith = force # ignore/add/remove/force

180

181

# Add or remove space before assignment operator '=', '+=', etc

182

sp_before_assign = remove # ignore/add/remove/force

183

184

# Add or remove space after assignment operator '=', '+=', etc

185

sp_after_assign = force # ignore/add/remove/force

186

187

# Add or remove space around assignment '=' in enum

188

sp_enum_assign = ignore # ignore/add/remove/force

189

190

# Add or remove space around boolean operators '&&' and '||'

191

sp_bool = force # ignore/add/remove/force

192

193

# Add or remove space around compare operator '<', '>', '==', etc

194

sp_compare = force # ignore/add/remove/force

195

196

# Add or remove space inside '(' and ')'

197

sp_inside_paren = remove # ignore/add/remove/force

198

199

# Add or remove space between nested parens

200

sp_paren_paren = remove # ignore/add/remove/force

201

202

# Whether to balance spaces inside nested parens

203

sp_balance_nested_parens = false # false/true

204

205

# Add or remove space between ')' and '{'

206

sp_paren_brace = ignore # ignore/add/remove/force

207

208

# Add or remove space before pointer star '*'

209

sp_before_ptr_star = force # ignore/add/remove/force

210

211

# Add or remove space before pointer star '*' that isn't followed by a variable name

212

# If set to 'ignore', sp_before_ptr_star is used instead.

213

sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force

214

215

# Add or remove space between pointer stars '*'

216

sp_between_ptr_star = remove # ignore/add/remove/force

217

218

# Add or remove space after pointer star '*', if followed by a word.

219

sp_after_ptr_star = remove # ignore/add/remove/force

220

221

# Add or remove space after a pointer star '*', if followed by a func proto/def.

222

sp_after_ptr_star_func = ignore # ignore/add/remove/force

223

224

# Add or remove space before a pointer star '*', if followed by a func proto/def.

225

sp_before_ptr_star_func = ignore # ignore/add/remove/force

226

227

# Add or remove space before a reference sign '&'

228

sp_before_byref = remove # ignore/add/remove/force

229

230

# Add or remove space before a reference sign '&' that isn't followed by a variable name

231

# If set to 'ignore', sp_before_byref is used instead.

232

sp_before_unnamed_byref = ignore # ignore/add/remove/force

233

234

# Add or remove space after reference sign '&', if followed by a word.

235

sp_after_byref = force # ignore/add/remove/force

236

237

# Add or remove space after a reference sign '&', if followed by a func proto/def.

238

sp_after_byref_func = ignore # ignore/add/remove/force

239

240

# Add or remove space before a reference sign '&', if followed by a func proto/def.

241

sp_before_byref_func = ignore # ignore/add/remove/force

242

243

# Add or remove space between type and word

244

sp_after_type = force # ignore/add/remove/force

245

246

# Add or remove space in 'template <' vs 'template<'.

247

# If set to ignore, sp_before_angle is used.

248

sp_template_angle = ignore # ignore/add/remove/force

249

250

# Add or remove space before '<>'

251

sp_before_angle = remove # ignore/add/remove/force

252

253

# Add or remove space inside '<' and '>'

254

sp_inside_angle = remove # ignore/add/remove/force

255

256

# Add or remove space after '<>'

257

sp_after_angle = force # ignore/add/remove/force

258

259

# Add or remove space between '<>' and '(' as found in 'new List<byte>();'

260

sp_angle_paren = ignore # ignore/add/remove/force

261

262

# Add or remove space between '<>' and a word as in 'List<byte> m;'

263

sp_angle_word = ignore # ignore/add/remove/force

264

265

# Add or remove space before '(' of 'if', 'for', 'switch', and 'while'

266

sp_before_sparen = force # ignore/add/remove/force

267

268

# Add or remove space inside if-condition '(' and ')'

269

sp_inside_sparen = remove # ignore/add/remove/force

270

271

# Add or remove space after ')' of 'if', 'for', 'switch', and 'while'

272

sp_after_sparen = force # ignore/add/remove/force

273

274

# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'

275

sp_sparen_brace = add # ignore/add/remove/force

276

277

# Add or remove space before empty statement ';' on 'if', 'for' and 'while'

278

sp_special_semi = ignore # ignore/add/remove/force

279

280

# Add or remove space before ';'

281

sp_before_semi = remove # ignore/add/remove/force

282

283

# Add or remove space before ';' in non-empty 'for' statements

284

sp_before_semi_for = ignore # ignore/add/remove/force

285

286

# Add or remove space before a semicolon of an empty part of a for statment.

287

sp_before_semi_for_empty = force # ignore/add/remove/force

288

289

# Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).

290

sp_after_semi_for_empty = ignore # ignore/add/remove/force

291

292

# Add or remove space before '[' (except '[]')

293

sp_before_square = ignore # ignore/add/remove/force

294

295

# Add or remove space before '[]'

296

sp_before_squares = ignore # ignore/add/remove/force

297

298

# Add or remove space inside '[' and ']'

299

sp_inside_square = remove # ignore/add/remove/force

300

301

# Add or remove space after ','

302

sp_after_comma = force # ignore/add/remove/force

303

304

# Add or remove space before ','

305

sp_before_comma = remove # ignore/add/remove/force

306

307

# Add or remove space after class ':'

308

sp_after_class_colon = ignore # ignore/add/remove/force

309

310

# Add or remove space before class ':'

311

sp_before_class_colon = ignore # ignore/add/remove/force

312

313

# Add or remove space between 'operator' and operator sign

314

sp_after_operator = ignore # ignore/add/remove/force

315

316

# Add or remove space between the operator symbol and the open paren, as in 'operator ++('

317

sp_after_operator_sym = ignore # ignore/add/remove/force

318

319

# Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'

320

sp_after_cast = remove # ignore/add/remove/force

321

322

# Add or remove spaces inside cast parens

323

sp_inside_paren_cast = remove # ignore/add/remove/force

324

325

# Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)'

326

sp_cpp_cast_paren = remove # ignore/add/remove/force

327

328

# Add or remove space between 'sizeof' and '('

329

sp_sizeof_paren = remove # ignore/add/remove/force

330

331

# Add or remove space after the tag keyword (Pawn)

332

sp_after_tag = ignore # ignore/add/remove/force

333

334

# Add or remove space inside enum '{' and '}'

335

sp_inside_braces_enum = force # ignore/add/remove/force

336

337

# Add or remove space inside struct/union '{' and '}'

338

sp_inside_braces_struct = force # ignore/add/remove/force

339

340

# Add or remove space inside '{' and '}'

341

sp_inside_braces = force # ignore/add/remove/force

342

343

# Add or remove space inside '{}'

344

sp_inside_braces_empty = ignore # ignore/add/remove/force

345

346

# Add or remove space between return type and function name

347

# A minimum of 1 is forced except for pointer return types.

348

sp_type_func = force # ignore/add/remove/force

349

350

# Add or remove space between function name and '(' on function declaration

351

sp_func_proto_paren = remove # ignore/add/remove/force

352

353

# Add or remove space between function name and '(' on function definition

354

sp_func_def_paren = remove # ignore/add/remove/force

355

356

# Add or remove space inside empty function '()'

357

sp_inside_fparens = ignore # ignore/add/remove/force

358

359

# Add or remove space inside function '(' and ')'

360

sp_inside_fparen = remove # ignore/add/remove/force

361

362

# Add or remove space between ']' and '(' when part of a function call.

363

sp_square_fparen = ignore # ignore/add/remove/force

364

365

# Add or remove space between ')' and '{' of function

366

sp_fparen_brace = add # ignore/add/remove/force

367

368

# Add or remove space between function name and '(' on function calls

369

sp_func_call_paren = remove # ignore/add/remove/force

370

371

# Add or remove space between the user function name and '(' on function calls

372

# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.

373

sp_func_call_user_paren = ignore # ignore/add/remove/force

374

375

# Add or remove space between a constructor/destructor and the open paren

376

sp_func_class_paren = remove # ignore/add/remove/force

377

378

# Add or remove space between 'return' and '('

379

sp_return_paren = remove # ignore/add/remove/force

380

381

# Add or remove space between '__attribute__' and '('

382

sp_attribute_paren = remove # ignore/add/remove/force

383

384

# Add or remove space between 'defined' and '(' in '#if defined (FOO)'

385

sp_defined_paren = remove # ignore/add/remove/force

386

387

# Add or remove space between 'throw' and '(' in 'throw (something)'

388

sp_throw_paren = ignore # ignore/add/remove/force

389

390

# Add or remove space between macro and value

391

sp_macro = ignore # ignore/add/remove/force

392

393

# Add or remove space between macro function ')' and value

394

sp_macro_func = ignore # ignore/add/remove/force

395

396

# Add or remove space between 'else' and '{' if on the same line

397

sp_else_brace = ignore # ignore/add/remove/force

398

399

# Add or remove space between '}' and 'else' if on the same line

400

sp_brace_else = ignore # ignore/add/remove/force

401

402

# Add or remove space between '}' and the name of a typedef on the same line

403

sp_brace_typedef = force # ignore/add/remove/force

404

405

# Add or remove space between 'catch' and '{' if on the same line

406

sp_catch_brace = ignore # ignore/add/remove/force

407

408

# Add or remove space between '}' and 'catch' if on the same line

409

sp_brace_catch = ignore # ignore/add/remove/force

410

411

# Add or remove space between 'finally' and '{' if on the same line

412

sp_finally_brace = ignore # ignore/add/remove/force

413

414

# Add or remove space between '}' and 'finally' if on the same line

415

sp_brace_finally = ignore # ignore/add/remove/force

416

417

# Add or remove space between 'try' and '{' if on the same line

418

sp_try_brace = ignore # ignore/add/remove/force

419

420

# Add or remove space between get/set and '{' if on the same line

421

sp_getset_brace = ignore # ignore/add/remove/force

422

423

# Add or remove space before the '::' operator

424

sp_before_dc = remove # ignore/add/remove/force

425

426

# Add or remove space after the '::' operator

427

sp_after_dc = remove # ignore/add/remove/force

428

429

# Add or remove around the D named array initializer ':' operator

430

sp_d_array_colon = ignore # ignore/add/remove/force

431

432

# Add or remove space after the '!' (not) operator.

433

sp_not = force # ignore/add/remove/force

434

435

# Add or remove space after the '~' (invert) operator.

436

sp_inv = remove # ignore/add/remove/force

437

438

# Add or remove space after the '&' (address-of) operator.

439

# This does not affect the spacing after a '&' that is part of a type.

440

sp_addr = remove # ignore/add/remove/force

441

442

# Add or remove space around the '.' or '->' operators

443

sp_member = remove # ignore/add/remove/force

444

445

# Add or remove space after the '*' (dereference) operator.

446

# This does not affect the spacing after a '*' that is part of a type.

447

sp_deref = remove # ignore/add/remove/force

448

449

# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'

450

sp_sign = remove # ignore/add/remove/force

451

452

# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'

453

sp_incdec = remove # ignore/add/remove/force

454

455

# Add or remove space before a backslash-newline at the end of a line

456

sp_before_nl_cont = add # ignore/add/remove/force

457

458

# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'

459

sp_after_oc_scope = ignore # ignore/add/remove/force

460

461

# Add or remove space after the colon in message specs

462

# '-(int) f:(int) x;' vs '-(int) f: (int) x;'

463

sp_after_oc_colon = ignore # ignore/add/remove/force

464

465

# Add or remove space before the colon in message specs

466

# '-(int) f: (int) x;' vs '-(int) f : (int) x;'

467

sp_before_oc_colon = ignore # ignore/add/remove/force

468

469

# Add or remove space after the colon in message specs

470

# '[object setValue:1];' vs '[object setValue: 1];'

471

sp_after_send_oc_colon = ignore # ignore/add/remove/force

472

473

# Add or remove space before the colon in message specs

474

# '[object setValue:1];' vs '[object setValue :1];'

475

sp_before_send_oc_colon = ignore # ignore/add/remove/force

476

477

# Add or remove space after the (type) in message specs

478

# '-(int) f: (int) x;' vs '-(int) f: (int)x;'

479

sp_after_oc_type = ignore # ignore/add/remove/force

480

481

# Add or remove space around the ':' in 'b ? t : f'

482

sp_cond_colon = ignore # ignore/add/remove/force

483

484

# Add or remove space around the '?' in 'b ? t : f'

485

sp_cond_question = ignore # ignore/add/remove/force

486

487

# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.

488

sp_case_label = remove # ignore/add/remove/force

489

490

#

491

# Code alignment (not left column spaces/tabs)

492

#

493

494

# Whether to keep non-indenting tabs

495

align_keep_tabs = false # false/true

496

497

# Whether to use tabs for alinging

498

align_with_tabs = false # false/true

499

500

# Whether to bump out to the next tab when aligning

501

align_on_tabstop = false # false/true

502

503

# Whether to left-align numbers

504

align_number_left = false # false/true

505

506

# Align variable definitions in prototypes and functions

507

align_func_params = false # false/true

508

509

# Align parameters in single-line functions that have the same name.

510

# The function names must already be aligned with each other.

511

align_same_func_call_params = false # false/true

512

513

# The span for aligning variable definitions (0=don't align)

514

align_var_def_span = 1 # number

515

516

# How to align the star in variable definitions.

517

# 0=Part of the type 'void * foo;'

518

# 1=Part of the variable 'void *foo;'

519

# 2=Dangling 'void *foo;'

520

align_var_def_star_style = 1 # number

521

522

# How to align the '&' in variable definitions.

523

# 0=Part of the type

524

# 1=Part of the variable

525

# 2=Dangling

526

align_var_def_amp_style = 0 # number

527

528

# The threshold for aligning variable definitions (0=no limit)

529

align_var_def_thresh = 1 # number

530

531

# The gap for aligning variable definitions

532

align_var_def_gap = 0 # number

533

534

# Whether to align the colon in struct bit fields

535

align_var_def_colon = false # false/true

536

537

# Whether to align inline struct/enum/union variable definitions

538

align_var_def_inline = false # false/true

539

540

# The span for aligning on '=' in assignments (0=don't align)

541

align_assign_span = 0 # number

542

543

# The threshold for aligning on '=' in assignments (0=no limit)

544

align_assign_thresh = 12 # number

545

546

# The span for aligning on '=' in enums (0=don't align)

547

align_enum_equ_span = 0 # number

548

549

# The threshold for aligning on '=' in enums (0=no limit)

550

align_enum_equ_thresh = 0 # number

551

552

# The span for aligning struct/union (0=don't align)

553

align_var_struct_span = 0 # number

554

555

# The threshold for aligning struct/union member definitions (0=no limit)

556

align_var_struct_thresh = 0 # number

557

558

# The gap for aligning struct/union member definitions

559

align_var_struct_gap = 0 # number

560

561

# The span for aligning struct initializer values (0=don't align)

562

align_struct_init_span = 3 # number

563

564

# The minimum space between the type and the synonym of a typedef

565

align_typedef_gap = 3 # number

566

567

# The span for aligning single-line typedefs (0=don't align)

568

align_typedef_span = 5 # number

569

570

# How to align typedef'd functions with other typedefs

571

# 0: Don't mix them at all

572

# 1: align the open paren with the types

573

# 2: align the function type name with the other type names

574

align_typedef_func = 0 # number

575

576

# Controls the positioning of the '*' in typedefs. Just try it.

577

# 0: Align on typdef type, ignore '*'

578

# 1: The '*' is part of type name: typedef int *pint;

579

# 2: The '*' is part of the type, but dangling: typedef int *pint;

580

align_typedef_star_style = 0 # number

581

582

# Controls the positioning of the '&' in typedefs. Just try it.

583

# 0: Align on typdef type, ignore '&'

584

# 1: The '&' is part of type name: typedef int &pint;

585

# 2: The '&' is part of the type, but dangling: typedef int &pint;

586

align_typedef_amp_style = 0 # number

587

588

# The span for aligning comments that end lines (0=don't align)

589

align_right_cmt_span = 3 # number

590

591

# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment

592

align_right_cmt_mix = false # false/true

593

594

# If a trailing comment is more than this number of columns away from the text it follows,

595

# it will qualify for being aligned.

596

align_right_cmt_gap = 0 # number

597

598

# The span for aligning function prototypes (0=don't align)

599

align_func_proto_span = 0 # number

600

601

# Minimum gap between the return type and the function name.

602

align_func_proto_gap = 0 # number

603

604

# Whether to mix aligning prototype and variable declarations.

605

# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.

606

align_mix_var_proto = false # false/true

607

608

# Align single-line functions with function prototypes, uses align_func_proto_span

609

align_single_line_func = false # false/true

610

611

# Aligning the open brace of single-line functions.

612

# Requires align_single_line_func=true, uses align_func_proto_span

613

align_single_line_brace = false # false/true

614

615

# Gap for align_single_line_brace.

616

align_single_line_brace_gap = 0 # number

617

618

# The span for aligning ObjC msg spec (0=don't align)

619

align_oc_msg_spec_span = 0 # number

620

621

# Whether to align macros wrapped with a backslash and a newline.

622

# This will not work right if the macro contains a multi-line comment.

623

align_nl_cont = true # false/true

624

625

# The minimum space between label and value of a preprocessor define

626

align_pp_define_gap = 4 # number

627

628

# The span for aligning on '#define' bodies (0=don't align)

629

align_pp_define_span = 3 # number

630

631

# Align lines that start with '<<' with previous '<<'. Default=true

632

align_left_shift = true # false/true

633

634

#

635

# Newline adding and removing options

636

#

637

638

# Whether to collapse empty blocks between '{' and '}'

639

nl_collapse_empty_body = true # false/true

640

641

# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'

642

nl_assign_leave_one_liners = false # false/true

643

644

# Don't split one-line braced statements inside a class xx { } body

645

nl_class_leave_one_liners = false # false/true

646

647

# Don't split one-line enums: 'enum foo { BAR = 15 };'

648

nl_enum_leave_one_liners = false # false/true

649

650

# Don't split one-line get or set functions

651

nl_getset_leave_one_liners = false # false/true

652

653

# Don't split one-line function definitions - 'int foo() { return 0; }'

654

nl_func_leave_one_liners = false # false/true

655

656

# Don't split one-line if/else statements - 'if(a) b++;'

657

nl_if_leave_one_liners = false # false/true

658

659

# Add or remove newlines at the start of the file

660

nl_start_of_file = remove # ignore/add/remove/force

661

662

# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'

663

nl_start_of_file_min = 0 # number

664

665

# Add or remove newline at the end of the file

666

nl_end_of_file = force # ignore/add/remove/force

667

668

# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')

669

nl_end_of_file_min = 1 # number

670

671

# Add or remove newline between '=' and '{'

672

nl_assign_brace = force # ignore/add/remove/force

673

674

# Add or remove newline between '=' and '[' (D only)

675

nl_assign_square = force # ignore/add/remove/force

676

677

# Add or remove newline after '= [' (D only). Will also affect the newline before the ']'

678

nl_after_square_assign = force # ignore/add/remove/force

679

680

# The number of newlines after a block of variable definitions

681

nl_func_var_def_blk = 1 # number

682

683

# Add or remove newline between a function call's ')' and '{', as in:

684

# list_for_each(item, &list) { }

685

nl_fcall_brace = force # ignore/add/remove/force

686

687

# Add or remove newline between 'enum' and '{'

688

nl_enum_brace = force # ignore/add/remove/force

689

690

# Add or remove newline between 'struct and '{'

691

nl_struct_brace = force # ignore/add/remove/force

692

693

# Add or remove newline between 'union' and '{'

694

nl_union_brace = force # ignore/add/remove/force

695

696

# Add or remove newline between 'if' and '{'

697

nl_if_brace = force # ignore/add/remove/force

698

699

# Add or remove newline between '}' and 'else'

700

nl_brace_else = force # ignore/add/remove/force

701

702

# Add or remove newline between 'else if' and '{'

703

# If set to ignore, nl_if_brace is used instead

704

nl_elseif_brace = force # ignore/add/remove/force

705

706

# Add or remove newline between 'else' and '{'

707

nl_else_brace = force # ignore/add/remove/force

708

709

# Add or remove newline between 'else' and 'if'

710

nl_else_if = remove # ignore/add/remove/force

711

712

# Add or remove newline between '}' and 'finally'

713

nl_brace_finally = force # ignore/add/remove/force

714

715

# Add or remove newline between 'finally' and '{'

716

nl_finally_brace = force # ignore/add/remove/force

717

718

# Add or remove newline between 'try' and '{'

719

nl_try_brace = force # ignore/add/remove/force

720

721

# Add or remove newline between get/set and '{'

722

nl_getset_brace = force # ignore/add/remove/force

723

724

# Add or remove newline between 'for' and '{'

725

nl_for_brace = force # ignore/add/remove/force

726

727

# Add or remove newline between 'catch' and '{'

728

nl_catch_brace = force # ignore/add/remove/force

729

730

# Add or remove newline between '}' and 'catch'

731

nl_brace_catch = force # ignore/add/remove/force

732

733

# Add or remove newline between 'while' and '{'

734

nl_while_brace = force # ignore/add/remove/force

735

736

# Add or remove newline between 'do' and '{'

737

nl_do_brace = force # ignore/add/remove/force

738

739

# Add or remove newline between '}' and 'while' of 'do' statement

740

nl_brace_while = force # ignore/add/remove/force

741

742

# Add or remove newline between 'switch' and '{'

743

nl_switch_brace = force # ignore/add/remove/force

744

745

# Add or remove newline when condition spans two or more lines

746

nl_multi_line_cond = false # false/true

747

748

# Force a newline in a define after the macro name for multi-line defines.

749

nl_multi_line_define = true # false/true

750

751

# Whether to put a newline before 'case' statement

752

nl_before_case = true # false/true

753

754

# Add or remove newline between ')' and 'throw'

755

nl_before_throw = ignore # ignore/add/remove/force

756

757

# Whether to put a newline after 'case' statement

758

nl_after_case = true # false/true

759

760

# Newline between namespace and {

761

nl_namespace_brace = add # ignore/add/remove/force

762

763

# Add or remove newline between 'template<>' and whatever follows.

764

nl_template_class = add # ignore/add/remove/force

765

766

# Add or remove newline between 'class' and '{'

767

nl_class_brace = add # ignore/add/remove/force

768

769

# Add or remove newline after each ',' in the constructor member initialization

770

nl_class_init_args = force # ignore/add/remove/force

771

772

# Add or remove newline between return type and function name in definition

773

nl_func_type_name = ignore # ignore/add/remove/force

774

775

# Add or remove newline between return type and function name in a prototype

776

nl_func_proto_type_name = remove # ignore/add/remove/force

777

778

# Add or remove newline between a function name and the opening '('

779

nl_func_paren = remove # ignore/add/remove/force

780

781

# Add or remove newline after '(' in a function declaration

782

nl_func_decl_start = remove # ignore/add/remove/force

783

784

# Add or remove newline after each ',' in a function declaration

785

nl_func_decl_args = remove # ignore/add/remove/force

786

787

# Add or remove newline before the ')' in a function declaration

788

nl_func_decl_end = remove # ignore/add/remove/force

789

790

# Add or remove newline between function signature and '{'

791

nl_fdef_brace = add # ignore/add/remove/force

792

793

# Whether to put a newline after 'return' statement

794

nl_after_return = true # false/true

795

796

# Add or remove a newline between the return keyword and return expression.

797

nl_return_expr = remove # ignore/add/remove/force

798

799

# Whether to put a newline after semicolons, except in 'for' statements

800

nl_after_semicolon = true # false/true

801

802

# Whether to put a newline after brace open.

803

# This also adds a newline before the matching brace close.

804

nl_after_brace_open = true # false/true

805

806

# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is

807

# placed between the open brace and a trailing single-line comment.

808

nl_after_brace_open_cmt = false # false/true

809

810

# Whether to put a newline after a virtual brace open.

811

# These occur in un-braced if/while/do/for statement bodies.

812

nl_after_vbrace_open = true # false/true

813

814

# Whether to alter newlines in '#define' macros

815

nl_define_macro = true # false/true

816

817

# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'

818

nl_squeeze_ifdef = false # false/true

819

820

# Add or remove newline before 'if'

821

nl_before_if = ignore # ignore/add/remove/force

822

823

# Add or remove newline after 'if'

824

nl_after_if = ignore # ignore/add/remove/force

825

826

# Add or remove newline before 'for'

827

nl_before_for = ignore # ignore/add/remove/force

828

829

# Add or remove newline after 'for'

830

nl_after_for = ignore # ignore/add/remove/force

831

832

# Add or remove newline before 'while'

833

nl_before_while = ignore # ignore/add/remove/force

834

835

# Add or remove newline after 'while'

836

nl_after_while = ignore # ignore/add/remove/force

837

838

# Add or remove newline before 'switch'

839

nl_before_switch = force # ignore/add/remove/force

840

841

# Add or remove newline after 'switch'

842

nl_after_switch = force # ignore/add/remove/force

843

844

# Add or remove newline before 'do'

845

nl_before_do = ignore # ignore/add/remove/force

846

847

# Add or remove newline after 'do'

848

nl_after_do = ignore # ignore/add/remove/force

849

850

# Whether to double-space commented-entries in struct/enum

851

nl_ds_struct_enum_cmt = false # false/true

852

853

# Whether to double-space before the close brace of a struct/union/enum

854

nl_ds_struct_enum_close_brace = false # false/true

855

856

# Add or remove a newline around a class colon.

857

# Related to pos_class_colon, nl_class_init_args, and pos_comma.

858

nl_class_colon = ignore # ignore/add/remove/force

859

860

# Change simple unbraced if statements into a one-liner

861

# 'if(b)\n i++;' => 'if(b) i++;'

862

nl_create_if_one_liner = false # false/true

863

864

# Change simple unbraced for statements into a one-liner

865

# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'

866

nl_create_for_one_liner = false # false/true

867

868

# Change simple unbraced while statements into a one-liner

869

# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'

870

nl_create_while_one_liner = false # false/true

871

872

#

873

# Positioning options

874

#

875

876

# The position of arithmetic operators in wrapped expressions

877

pos_arith = lead # ignore/lead/trail

878

879

# The position of assignment in wrapped expressions

880

pos_assign = trail # ignore/lead/trail

881

882

# The position of boolean operators in wrapped expressions

883

pos_bool = lead # ignore/lead/trail

884

885

# The position of the comma in wrapped expressions

886

pos_comma = trail # ignore/lead/trail

887

888

# The position of the comma in the constructor initialization list

889

pos_class_comma = trail # ignore/lead/trail

890

891

# The position of colons between constructor and member initialization

892

pos_class_colon = lead # ignore/lead/trail

893

894

#

895

# Line Splitting options

896

#

897

898

# Try to limit code width to N number of columns

899

code_width = 76 # number

900

901

# Whether to fully split long 'for' statements at semi-colons

902

ls_for_split_full = true # false/true

903

904

# Whether to fully split long function protos/calls at commas

905

ls_func_split_full = true # false/true

906

907

#

908

# Blank line options

909

#

910

911

# The maximum consecutive newlines

912

nl_max = 4 # number

913

914

# The number of newlines after a function prototype, if followed by another function prototype

915

nl_after_func_proto = 0 # number

916

917

# The number of newlines after a function prototype, if not followed by another function prototype

918

nl_after_func_proto_group = 3 # number

919

920

# The number of newlines after '}' of a multi-line function body

921

nl_after_func_body = 3 # number

922

923

# The number of newlines after '}' of a single line function body

924

nl_after_func_body_one_liner = 1 # number

925

926

# The minimum number of newlines before a multi-line comment.

927

# Doesn't apply if after a brace open or another multi-line comment.

928

nl_before_block_comment = 2 # number

929

930

# The minimum number of newlines before a single-line C comment.

931

# Doesn't apply if after a brace open or other single-line C comments.

932

nl_before_c_comment = 1 # number

933

934

# The minimum number of newlines before a CPP comment.

935

# Doesn't apply if after a brace open or other CPP comments.

936

nl_before_cpp_comment = 0 # number

937

938

# Whether to force a newline after a mulit-line comment.

939

nl_after_multiline_comment = false # false/true

940

941

# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.

942

# Will not change the newline count if after a brace open.

943

# 0 = No change.

944

nl_before_access_spec = 1 # number

945

946

# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.

947

# 0 = No change.

948

nl_after_access_spec = 1 # number

949

950

# The number of newlines between a function def and the function comment.

951

# 0 = No change.

952

nl_comment_func_def = 0 # number

953

954

# Whether to remove blank lines after '{'

955

eat_blanks_after_open_brace = true # false/true

956

957

# Whether to remove blank lines before '}'

958

eat_blanks_before_close_brace = true # false/true

959

960

#

961

# Code modifying options (non-whitespace)

962

#

963

964

# Add or remove braces on single-line 'do' statement

965

mod_full_brace_do = add # ignore/add/remove/force

966

967

# Add or remove braces on single-line 'for' statement

968

mod_full_brace_for = add # ignore/add/remove/force

969

970

# Add or remove braces on single-line function defintions. (Pawn)

971

mod_full_brace_function = ignore # ignore/add/remove/force

972

973

# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.

974

mod_full_brace_if = ignore # ignore/add/remove/force

975

976

# Don't remove braces around statements that span N newlines

977

mod_full_brace_nl = 0 # number

978

979

# Add or remove braces on single-line 'while' statement

980

mod_full_brace_while = add # ignore/add/remove/force

981

982

# Add or remove unnecessary paren on 'return' statement

983

mod_paren_on_return = remove # ignore/add/remove/force

984

985

# Whether to change optional semicolons to real semicolons

986

mod_pawn_semicolon = false # false/true

987

988

# Add parens on 'while' and 'if' statement around bools

989

mod_full_paren_if_bool = true # false/true

990

991

# Whether to remove superfluous semicolons

992

mod_remove_extra_semicolon = true # false/true

993

994

# If a function body exceeds the specified number of newlines and doesn't have a comment after

995

# the close brace, a comment will be added.

996

mod_add_long_function_closebrace_comment = 5 # number

997

998

# If a switch body exceeds the specified number of newlines and doesn't have a comment after

999

# the close brace, a comment will be added.

1000

mod_add_long_switch_closebrace_comment = 5 # number

1001

1002

# If TRUE, will sort consecutive single-line 'import' statements [Java, D]

1003

mod_sort_import = false # false/true

1004

1005

# If TRUE, will sort consecutive single-line 'using' statements [C#]

1006

mod_sort_using = false # false/true

1007

1008

# If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]

1009

# This is generally a bad idea, as it may break your code.

1010

mod_sort_include = false # false/true

1011

1012

# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.

1013

mod_move_case_break = false # false/true

1014

1015

# If TRUE, it will remove a void 'return;' that appears as the last statement in a function.

1016

mod_remove_empty_return = true # false/true

1017

1018

#

1019

# Comment modifications

1020

#

1021

1022

# Try to wrap comments at cmt_width columns

1023

cmt_width = 0 # number

1024

1025

# If false, disable all multi-line comment changes, including cmt_width and leading chars.

1026

# Default is true.

1027

cmt_indent_multi = true # false/true

1028

1029

# Whether to group c-comments that look like they are in a block

1030

cmt_c_group = false # false/true

1031

1032

# Whether to put an empty '/*' on the first line of the combined c-comment

1033

cmt_c_nl_start = false # false/true

1034

1035

# Whether to put a newline before the closing '*/' of the combined c-comment

1036

cmt_c_nl_end = false # false/true

1037

1038

# Whether to group cpp-comments that look like they are in a block

1039

cmt_cpp_group = false # false/true

1040

1041

# Whether to put an empty '/*' on the first line of the combined cpp-comment

1042

cmt_cpp_nl_start = false # false/true

1043

1044

# Whether to put a newline before the closing '*/' of the combined cpp-comment

1045

cmt_cpp_nl_end = false # false/true

1046

1047

# Whether to change cpp-comments into c-comments

1048

cmt_cpp_to_c = false # false/true

1049

1050

# Whether to put a star on subsequent comment lines

1051

cmt_star_cont = true # false/true

1052

1053

# The number of spaces to insert at the start of subsequent comment lines

1054

cmt_sp_before_star_cont = 0 # number

1055

1056

# The number of spaces to insert after the star on subsequent comment lines

1057

cmt_sp_after_star_cont = 1 # number

1058

1059

# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of

1060

# the comment are the same length. Default=True

1061

cmt_multi_check_last = true # false/true

1062

1063

# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.

1064

# Will substitue $(filename) with the current file's name.

1065

cmt_insert_file_header = "" # string

1066

1067

# The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.

1068

# Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.

1069

# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }

1070

cmt_insert_func_header = "" # string

1071

1072

# The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.

1073

# Will substitue $(class) with the class name.

1074

cmt_insert_class_header = "" # string

1075

1076

# If a preprocessor is encountered when stepping backwards from a function name, then

1077

# this option decides whether the comment should be inserted.

1078

# Affects cmt_insert_func_header and cmt_insert_class_header.

1079

cmt_insert_before_preproc = false # false/true

1080

1081

#

1082

# Preprocessor options

1083

#

1084

1085

# Control indent of preprocessors inside #if blocks at brace level 0

1086

pp_indent = remove # ignore/add/remove/force

1087

1088

# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)

1089

pp_indent_at_level = false # false/true

1090

1091

# If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.

1092

pp_indent_count = 1 # number

1093

1094

# Add or remove space after # based on pp_level of #if blocks

1095

pp_space = add # ignore/add/remove/force

1096

1097

# Sets the number of spaces added with pp_space

1098

pp_space_count = 1 # number

1099

1100

# The indent for #region and #endregion in C# and '#pragma region' in C/C++

1101

pp_indent_region = 0 # number

1102

1103

# Whether to indent the code between #region and #endregion

1104

pp_region_indent_code = false # false/true

1105

1106

# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level

1107

pp_indent_if = 0 # number

1108

1109

# Control whether to indent the code between #if, #else and #endif when not at file-level

1110

pp_if_indent_code = false # false/true

1111

1112

# Whether to indent '#define' at the brace level (true) or from column 1 (false)

1113

pp_define_at_level = false # false/true

1114

1115

# You can force a token to be a type with the 'type' option.

1116

# Example:

1117

# type myfoo1 myfoo2

1118

#

1119

# You can create custom macro-based indentation using macro-open,

1120

# macro-else and macro-close.

1121

# Example:

1122

# macro-open BEGIN_TEMPLATE_MESSAGE_MAP

1123

# macro-open BEGIN_MESSAGE_MAP

1124

# macro-close END_MESSAGE_MAP

1125

#

1126

# You can assign any keyword to any type with the set option.

1127

# set func_call_user _ N_