Maxim Integrated's IoT development kit

Dependencies:   MAX30101 MAX30003 MAX113XX_Pixi MAX30205 max32630fthr USBDevice

Committer:
Mahir Ozturk
Date:
Tue Mar 13 14:52:59 2018 +0300
Revision:
1:efe9cad8942f
Commit project files

Change-Id: I2188228f2a27e9a13e2407846e48b38c2596caa0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mahir Ozturk 1:efe9cad8942f 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
Mahir Ozturk 1:efe9cad8942f 2
Mahir Ozturk 1:efe9cad8942f 3 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
Mahir Ozturk 1:efe9cad8942f 4
Mahir Ozturk 1:efe9cad8942f 5 <head>
Mahir Ozturk 1:efe9cad8942f 6 <title>Artistic Style</title>
Mahir Ozturk 1:efe9cad8942f 7 <meta http-equiv="Content-Language" content="en-us" />
Mahir Ozturk 1:efe9cad8942f 8 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
Mahir Ozturk 1:efe9cad8942f 9 <meta name="description" content="Artistic Style is a source code indenter, source code formatter, and source code beautifier
Mahir Ozturk 1:efe9cad8942f 10 for the C, C++, C# and Java programming languages." />
Mahir Ozturk 1:efe9cad8942f 11 <meta name="keywords" content="artistic style, astyle, source code indenter, source code formatter, source code beautifier" />
Mahir Ozturk 1:efe9cad8942f 12 <link href="favicon.ico" rel="shortcut icon" type="image/x-icon" />
Mahir Ozturk 1:efe9cad8942f 13 <link href="styles.css" rel="stylesheet" type="text/css" />
Mahir Ozturk 1:efe9cad8942f 14
Mahir Ozturk 1:efe9cad8942f 15 <!-- the following styles are additions to styles.css -->
Mahir Ozturk 1:efe9cad8942f 16
Mahir Ozturk 1:efe9cad8942f 17 <style type="text/css">
Mahir Ozturk 1:efe9cad8942f 18 hr { margin-left: -0.4in; }
Mahir Ozturk 1:efe9cad8942f 19 /* the following styles are for formatting code samples */
Mahir Ozturk 1:efe9cad8942f 20 div.code { background: #D8D8FF; }
Mahir Ozturk 1:efe9cad8942f 21 /* code */
Mahir Ozturk 1:efe9cad8942f 22 p.code { margin-left: 0.3in; }
Mahir Ozturk 1:efe9cad8942f 23 code { color: navy; }
Mahir Ozturk 1:efe9cad8942f 24 code.title { font-size: larger; font-weight: bold; }
Mahir Ozturk 1:efe9cad8942f 25 /* spans */
Mahir Ozturk 1:efe9cad8942f 26 span.brace { color: red; }
Mahir Ozturk 1:efe9cad8942f 27 span.comment { color: dimgray; font-style: italic; }
Mahir Ozturk 1:efe9cad8942f 28 span.option { color: saddlebrown; font-weight: bold; }
Mahir Ozturk 1:efe9cad8942f 29 </style>
Mahir Ozturk 1:efe9cad8942f 30
Mahir Ozturk 1:efe9cad8942f 31 </head>
Mahir Ozturk 1:efe9cad8942f 32
Mahir Ozturk 1:efe9cad8942f 33 <body>
Mahir Ozturk 1:efe9cad8942f 34
Mahir Ozturk 1:efe9cad8942f 35 <h1>Artistic Style 3.0</h1>
Mahir Ozturk 1:efe9cad8942f 36
Mahir Ozturk 1:efe9cad8942f 37 <h2>
Mahir Ozturk 1:efe9cad8942f 38 A Free, Fast, and Small Automatic Formatter<br />
Mahir Ozturk 1:efe9cad8942f 39 for C, C++, C++/CLI, Objective&#8209;C, C#, and Java Source Code
Mahir Ozturk 1:efe9cad8942f 40 </h2>
Mahir Ozturk 1:efe9cad8942f 41
Mahir Ozturk 1:efe9cad8942f 42 <h3 id="Contents">Contents</h3>
Mahir Ozturk 1:efe9cad8942f 43
Mahir Ozturk 1:efe9cad8942f 44 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 45 <a class="contents" href="#_General_Information">General&nbsp;Information</a></p>
Mahir Ozturk 1:efe9cad8942f 46 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 47 <a class="contents" href="#_Quick_Start">Quick&nbsp;Start</a></p>
Mahir Ozturk 1:efe9cad8942f 48 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 49 <a class="contents" href="#_Usage">Usage</a></p>
Mahir Ozturk 1:efe9cad8942f 50 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 51 <a class="contents" href="#_Options">Options</a></p>
Mahir Ozturk 1:efe9cad8942f 52 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 53 <a class="contents" href="#_Options_File">Options&nbsp;File</a></p>
Mahir Ozturk 1:efe9cad8942f 54 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 55 <a class="contents" href="#_Disable_Formatting">Disable&nbsp;Formatting</a></p>
Mahir Ozturk 1:efe9cad8942f 56 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 57 <a class="contents" href="#_Basic_Brace_Styles">Basic&nbsp;Brace&nbsp;Styles</a></p>
Mahir Ozturk 1:efe9cad8942f 58 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 59 <a class="contents" href="#_Brace_Style_Options">Brace&nbsp;Style&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 60 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 61 <a class="contents" href="#_default_brace_style">default&nbsp;brace&nbsp;style</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 62 <a class="contents" href="#_style=allman">style=allman</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 63 <a class="contents" href="#_style=java">style=java</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 64 <a class="contents" href="#_style=kr">style=kr</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 65 <a class="contents" href="#_style=stroustrup">style=stroustrup</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 66 <a class="contents" href="#_style=whitesmith">style=whitesmith</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 67 <a class="contents" href="#_style=vtk">style=vtk</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 68 <a class="contents" href="#_style=banner">style=banner</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 69 <a class="contents" href="#_style=gnu">style=gnu</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 70 <a class="contents" href="#_style=linux">style=linux</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 71 <a class="contents" href="#_style=horstmann">style=horstmann</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 72 <a class="contents" href="#_style=1tbs">style=1tbs</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 73 <a class="contents" href="#_style=google">style=google</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 74 <a class="contents" href="#_style=mozilla">style=mozilla</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 75 <a class="contents" href="#_style=pico">style=pico</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 76 <a class="contents" href="#_style=lisp">style=lisp</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 77 </p>
Mahir Ozturk 1:efe9cad8942f 78 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 79 <a class="contents" href="#_Tab_Options">Tab&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 80 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 81 <a class="contents" href="#_default_indent">default&nbsp;indent</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 82 <a class="contents" href="#_indent=spaces">indent=spaces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 83 <a class="contents" href="#_indent=tab">indent=tab</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 84 <a class="contents" href="#_indent=force-tab">indent=force&#8209;tab</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 85 <a class="contents" href="#_indent=force-tab-x">--indent=force&#8209;tab&#8209;x</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 86 </p>
Mahir Ozturk 1:efe9cad8942f 87 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 88 <a class="contents" href="#_Brace_Modify_Options">Brace&nbsp;Modify&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 89 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 90 <a class="contents" href="#_attach_namespaces">attach&#8209;namespaces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 91 <a class="contents" href="#_attach_classes">attach&#8209;classes</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 92 <a class="contents" href="#_attach_inlines">attach&#8209;inlines</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 93 <a class="contents" href="#_attach-extern-c">attach&#8209;extern&#8209;c</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 94 <a class="contents" href="#_attach-closing-while">attach&#8209;closing&#8209;while</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 95 </p>
Mahir Ozturk 1:efe9cad8942f 96 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 97 <a class="contents" href="#_Indentation_Options">Indentation&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 98 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 99 <a class="contents" href="#_indent-classes">indent&#8209;classes</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 100 <a class="contents" href="#_indent-modifiers">indent&#8209;modifiers</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 101 <a class="contents" href="#_indent-switches">indent&#8209;switches</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 102 <a class="contents" href="#_indent-cases">indent&#8209;cases</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 103 <a class="contents" href="#_indent-namespaces">indent&#8209;namespaces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 104 <a class="contents" href="#_indent-after-parens">indent&#8209;after&#8209;parens</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 105 <a class="contents" href="#_indent-continuation">indent&#8209;continuation</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 106 <a class="contents" href="#_indent-labels">indent&#8209;labels</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 107 <a class="contents" href="#_indent-preproc-block">indent&#8209;preproc&#8209;block</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 108 <a class="contents" href="#_indent-preproc-define">indent&#8209;preproc&#8209;define</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 109 <a class="contents" href="#_indent-preproc-cond">indent&#8209;preproc&#8209;cond</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 110 <a class="contents" href="#_indent-col1-comments">indent&#8209;col1&#8209;comments</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 111 <a class="contents" href="#_min-conditional-indent">min&#8209;conditional&#8209;indent</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 112 <a class="contents" href="#_max-continuation-indent">max&#8209;continuation&#8209;indent</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 113 </p>
Mahir Ozturk 1:efe9cad8942f 114 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 115 <a class="contents" href="#_Padding_Options">Padding&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 116 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 117 <a class="contents" href="#_break-blocks">break&#8209;blocks</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 118 <a class="contents" href="#_break-blocks=all">break&#8209;blocks=all</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 119 <a class="contents" href="#_pad-oper">pad&#8209;oper</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 120 <a class="contents" href="#_pad-comma">pad&#8209;comma</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 121 <a class="contents" href="#_pad-paren">pad&#8209;paren</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 122 <a class="contents" href="#_pad-paren-out">pad&#8209;paren&#8209;out</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 123 <a class="contents" href="#_pad-first-paren-out">pad&#8209;first&#8209;paren&#8209;out</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 124 <a class="contents" href="#_pad-paren-in">pad&#8209;paren&#8209;in</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 125 <a class="contents" href="#_pad-header">pad&#8209;header</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 126 <a class="contents" href="#_unpad-paren">unpad&#8209;paren</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 127 <a class="contents" href="#_delete-empty-lines">delete&#8209;empty&#8209;lines</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 128 <a class="contents" href="#_fill-empty-lines">fill&#8209;empty&#8209;lines</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 129 <a class="contents" href="#_align-pointer">align&#8209;pointer</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 130 <a class="contents" href="#_align-reference">align&#8209;reference</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 131 </p>
Mahir Ozturk 1:efe9cad8942f 132 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 133 <a class="contents" href="#_Formatting_Options">Formatting&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 134 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 135 <a class="contents" href="#_break-closing-braces">break&#8209;closing&#8209;braces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 136 <a class="contents" href="#_break-elseifs">break&#8209;elseifs</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 137 <a class="contents" href="#_break-one-line-headers">break&#8209;one&#8209;line&#8209;headers</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 138 <a class="contents" href="#_add-braces">add&#8209;braces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 139 <a class="contents" href="#_add-one-line-braces">add&#8209;one&#8209;line&#8209;braces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 140 <a class="contents" href="#_remove-braces">remove&#8209;braces</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 141 <a class="contents" href="#_keep-one-line-blocks">keep&#8209;one&#8209;line&#8209;blocks</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 142 <a class="contents" href="#_keep-one-line-statements">keep&#8209;one&#8209;line&#8209;statements</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 143 <a class="contents" href="#_convert-tabs">convert&#8209;tabs</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 144 <a class="contents" href="#_close-templates">close&#8209;templates</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 145 <a class="contents" href="#_remove-comment-prefix">remove&#8209;comment&#8209;prefix</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 146 <a class="contents" href="#_max-code-length">max&#8209;code&#8209;length</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 147 <a class="contents" href="#_max-code-length">break&#8209;after&#8209;logical</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 148 <a class="contents" href="#_mode">mode</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 149 </p>
Mahir Ozturk 1:efe9cad8942f 150 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 151 <a class="contents" href="#_Objective_C_Options">Objective&#8209;C&nbsp;Options</a></p>
Mahir Ozturk 1:efe9cad8942f 152 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 153 <a class="contents" href="#_pad-method-prefix">pad&#8209;method&#8209;prefix</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 154 <a class="contents" href="#_unpad-method-prefix">unpad&#8209;method&#8209;prefix</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 155 <a class="contents" href="#_pad-return-type">pad&#8209;return&#8209;type</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 156 <a class="contents" href="#_unpad-return-type">unpad&#8209;return&#8209;type</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 157 <a class="contents" href="#_pad-param-type">pad&#8209;param&#8209;type</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 158 <a class="contents" href="#_unpad-param-type">unpad&#8209;param&#8209;type</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 159 <a class="contents" href="#_align-method-colon">align&#8209;method&#8209;colon</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 160 <a class="contents" href="#_pad-method-colon">pad&#8209;method&#8209;colon</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 161 </p>
Mahir Ozturk 1:efe9cad8942f 162 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 163 <a class="contents" href="#_Other_Options">Other&nbsp;Options</a>&nbsp;&nbsp;&nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 164 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 165 <a class="contents" href="#_suffix">suffix</a>&nbsp;&nbsp;&nbsp; <a class="contents" href="#_suffix=none">suffix=none</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 166 <a class="contents" href="#_recursive">recursive</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 167 <a class="contents" href="#_dry-run">dry-run</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 168 <a class="contents" href="#_exclude">exclude</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 169 <a class="contents" href="#_ignore-exclude-errors">ignore&#8209;exclude&#8209;errors</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 170 <a class="contents" href="#_ignore-exclude-errors-x">ignore&#8209;exclude&#8209;errors&#8209;x</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 171 <a class="contents" href="#_errors-to-stdout">errors&#8209;to&#8209;stdout</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 172 <a class="contents" href="#_preserve-date">preserve&#8209;date</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 173 <a class="contents" href="#_verbose">verbose</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 174 <a class="contents" href="#_formatted">formatted</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 175 <a class="contents" href="#_quiet">quiet</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 176 <a class="contents" href="#_lineend">lineend</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 177 </p>
Mahir Ozturk 1:efe9cad8942f 178 <p class="contents1">
Mahir Ozturk 1:efe9cad8942f 179 <a class="contents" href="#_Command_Line_Only">Command&nbsp;Line&nbsp;Only</a></p>
Mahir Ozturk 1:efe9cad8942f 180 <p class="contents2">
Mahir Ozturk 1:efe9cad8942f 181 <a class="contents" href="#_options=">options</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 182 <a class="contents" href="#_options=none">options=none</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 183 <a class="contents" href="#_ascii">ascii</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 184 <a class="contents" href="#_version">version</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 185 <a class="contents" href="#_help">help</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 186 <a class="contents" href="#_html">html</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 187 <a class="contents" href="#_html=">html=</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 188 <a class="contents" href="#_stdin=">stdin=</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 189 <a class="contents" href="#_stdout=">stdout=</a>&nbsp;&nbsp;&nbsp;
Mahir Ozturk 1:efe9cad8942f 190 </p>
Mahir Ozturk 1:efe9cad8942f 191 <p>
Mahir Ozturk 1:efe9cad8942f 192 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 193 <hr />
Mahir Ozturk 1:efe9cad8942f 194
Mahir Ozturk 1:efe9cad8942f 195 <!-- * * * * * * * * * * * * General Information< * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 196
Mahir Ozturk 1:efe9cad8942f 197 <h3 id="_General_Information">General Information</h3>
Mahir Ozturk 1:efe9cad8942f 198
Mahir Ozturk 1:efe9cad8942f 199 <h4>Line Endings</h4>
Mahir Ozturk 1:efe9cad8942f 200
Mahir Ozturk 1:efe9cad8942f 201 <p>
Mahir Ozturk 1:efe9cad8942f 202 Line endings in the formatted file will be the same as the input file. If there are mixed line endings the most
Mahir Ozturk 1:efe9cad8942f 203 frequent occurrence will be used. There is also an option to specify or change the line endings.</p>
Mahir Ozturk 1:efe9cad8942f 204
Mahir Ozturk 1:efe9cad8942f 205 <h4>File Type</h4>
Mahir Ozturk 1:efe9cad8942f 206
Mahir Ozturk 1:efe9cad8942f 207 <p>
Mahir Ozturk 1:efe9cad8942f 208 Artistic Style will determine the file type from the file extension. The extension ".java" indicates a Java file,
Mahir Ozturk 1:efe9cad8942f 209 and ".cs" indicates a C# file. Everything else is a C type file (C, C++, C++/CLI, or Objective-C). If you are
Mahir Ozturk 1:efe9cad8942f 210 using a non-standard file extension for Java or C#, use one of the --mode= options.</p>
Mahir Ozturk 1:efe9cad8942f 211
Mahir Ozturk 1:efe9cad8942f 212 <h4>Wildcards and Recursion</h4>
Mahir Ozturk 1:efe9cad8942f 213
Mahir Ozturk 1:efe9cad8942f 214 <p>
Mahir Ozturk 1:efe9cad8942f 215 Artistic Style can process directories recursively. Wildcards (such as "*.cpp" or "*.c??") are processed internally.
Mahir Ozturk 1:efe9cad8942f 216 If a shell is used, it should pass the wildcards to Artistic Style instead of resolving them first. For Linux
Mahir Ozturk 1:efe9cad8942f 217 use double quotes around paths whose file name contains wildcards. For Windows use double quotes around paths
Mahir Ozturk 1:efe9cad8942f 218 whose file name contains spaces. The <a href="#_recursive">recursive</a> option in the
Mahir Ozturk 1:efe9cad8942f 219 <a href="#_Other_Options">Other Options</a> section contains information on recursive processing.</p>
Mahir Ozturk 1:efe9cad8942f 220
Mahir Ozturk 1:efe9cad8942f 221 <h4>File Names</h4>
Mahir Ozturk 1:efe9cad8942f 222
Mahir Ozturk 1:efe9cad8942f 223 <p>
Mahir Ozturk 1:efe9cad8942f 224 When a file is formatted, the newly indented file retains the original file name. A copy of the original file
Mahir Ozturk 1:efe9cad8942f 225 is created with an <strong>.orig</strong> appended to the original file name. (This can be set to
Mahir Ozturk 1:efe9cad8942f 226 a different string by the option --suffix=, or suppressed altogether by the options -n
Mahir Ozturk 1:efe9cad8942f 227 or --suffix=none). Thus, after indenting <em>SourceFile.cpp</em> the indented file will
Mahir Ozturk 1:efe9cad8942f 228 be named <em>SourceFile.cpp</em>, while the original pre-indented file will be renamed to
Mahir Ozturk 1:efe9cad8942f 229 <em>SourceFile.cpp.orig</em>.</p>
Mahir Ozturk 1:efe9cad8942f 230
Mahir Ozturk 1:efe9cad8942f 231 <h4>Internationalization</h4>
Mahir Ozturk 1:efe9cad8942f 232
Mahir Ozturk 1:efe9cad8942f 233 <p>
Mahir Ozturk 1:efe9cad8942f 234 Artistic Style has been internationalized to process files and directories in any language.</p>
Mahir Ozturk 1:efe9cad8942f 235 <p>
Mahir Ozturk 1:efe9cad8942f 236 It has also been translated into several languages. The translation to use is determined by the User Locale
Mahir Ozturk 1:efe9cad8942f 237 for Windows and the LANG environment variable for other systems. The translation will be done automatically from
Mahir Ozturk 1:efe9cad8942f 238 these settings. If no translation is available it will default to English. There is an "ascii" option to use English
Mahir Ozturk 1:efe9cad8942f 239 instead of the system language.</p>
Mahir Ozturk 1:efe9cad8942f 240 <p>
Mahir Ozturk 1:efe9cad8942f 241 The source code for the translations is at the end of ASLocalizer.cpp in the form of an English&#8209;Translation
Mahir Ozturk 1:efe9cad8942f 242 pair. If you make corrections to a translation, send the source as a bug report and it will be included in the
Mahir Ozturk 1:efe9cad8942f 243 next release.</p>
Mahir Ozturk 1:efe9cad8942f 244 <p>
Mahir Ozturk 1:efe9cad8942f 245 To add a new language, add a new translation class to ASLocalizer.h. Add the English&#8209;Translation pair to
Mahir Ozturk 1:efe9cad8942f 246 the constructor in ASLocalizer.cpp. Update the WinLangCode array and add the language code to the function setTranslationClass().
Mahir Ozturk 1:efe9cad8942f 247 The ASLocalizer.cpp program contains comments that give web pages for obtaining the LCIDs and language codes.
Mahir Ozturk 1:efe9cad8942f 248 Send the source code as a bug report and it will be included in the next release.</p>
Mahir Ozturk 1:efe9cad8942f 249
Mahir Ozturk 1:efe9cad8942f 250 <h4>Other Considerations</h4>
Mahir Ozturk 1:efe9cad8942f 251
Mahir Ozturk 1:efe9cad8942f 252 <p>
Mahir Ozturk 1:efe9cad8942f 253 The names of special characters used in programming vary by region. The terminology used by Artistic Style,
Mahir Ozturk 1:efe9cad8942f 254 followed by other common names, is<strong>:</strong></p>
Mahir Ozturk 1:efe9cad8942f 255 <blockquote>
Mahir Ozturk 1:efe9cad8942f 256 braces or curly braces { } &#8209; also called brackets, or curly brackets.<br />
Mahir Ozturk 1:efe9cad8942f 257 parens or round brackets ( ) &#8209; also called parentheses, brackets, circle brackets, or soft brackets.<br />
Mahir Ozturk 1:efe9cad8942f 258 square brackets [ ] &#8209; also called block parens, brackets, closed brackets, or hard brackets.<br />
Mahir Ozturk 1:efe9cad8942f 259 angle brackets < > &#8209; also called brackets, pointy brackets, triangular brackets, diamond brackets, tuples,
Mahir Ozturk 1:efe9cad8942f 260 or chevrons.
Mahir Ozturk 1:efe9cad8942f 261 </blockquote>
Mahir Ozturk 1:efe9cad8942f 262 <p>
Mahir Ozturk 1:efe9cad8942f 263 Visual Studio, and possibly other development environments, has extensions that will align assignment operators
Mahir Ozturk 1:efe9cad8942f 264 across multiple lines. There is an extension named "Code alignment" that will align the code on other items as
Mahir Ozturk 1:efe9cad8942f 265 well. Formatting with these options and extensions can be used with Artistic Style. The space padding will be
Mahir Ozturk 1:efe9cad8942f 266 maintained and the alignment will be preserved. </p>
Mahir Ozturk 1:efe9cad8942f 267 <p>
Mahir Ozturk 1:efe9cad8942f 268 Artistic Style can format standard class library statements such as Open GL, wxWidgets, Qt, and MFC.</p>
Mahir Ozturk 1:efe9cad8942f 269 <p>
Mahir Ozturk 1:efe9cad8942f 270 Embedded assembler language is formatted correctly. This includes extended assembly and Microsoft specific assembler
Mahir Ozturk 1:efe9cad8942f 271 lines and blocks.</p>
Mahir Ozturk 1:efe9cad8942f 272 <p>
Mahir Ozturk 1:efe9cad8942f 273 Artistic Style can format embedded SQL statements. The SQL formatting will be maintained as long as the standard
Mahir Ozturk 1:efe9cad8942f 274 hanging indent format is used. If the "exec sql" statement is indented more than the following statements, the
Mahir Ozturk 1:efe9cad8942f 275 SQL will be aligned in a single column.</p>
Mahir Ozturk 1:efe9cad8942f 276 <p>
Mahir Ozturk 1:efe9cad8942f 277 Unicode files encoded as UTF&#8209;16, both big and little endian, will be formatted. The files must begin with
Mahir Ozturk 1:efe9cad8942f 278 a byte order mark (BOM) to be recognized. Files encoded as UTF&#8209;32 will be rejected. Some compilers do not
Mahir Ozturk 1:efe9cad8942f 279 support these encodings. These files can be converted to UTF&#8209;8 encoding with the program "iconv". There
Mahir Ozturk 1:efe9cad8942f 280 are Linux and Windows versions available (the Windows version does not seem to work for all encodings). Visual
Mahir Ozturk 1:efe9cad8942f 281 Studio can convert the files from the "File &gt; Advanced Save Options" menu. There are other development environments
Mahir Ozturk 1:efe9cad8942f 282 and text editors, such as SciTE, that can convert files to UTF&#8209;8.</p>
Mahir Ozturk 1:efe9cad8942f 283 <p>
Mahir Ozturk 1:efe9cad8942f 284 Embedded statements that are multiple-line and are NOT in a C-type format, such as Python, are usually mal-formatted
Mahir Ozturk 1:efe9cad8942f 285 (a C-type format has blocks enclosed by braces and statements terminated by a semi-colon). Macros that define
Mahir Ozturk 1:efe9cad8942f 286 functions may cause the following code to be mal-formatted because the macro is missing the braces and semi-colons
Mahir Ozturk 1:efe9cad8942f 287 from the definition. If you have source code with these types of statements, exclude them with the
Mahir Ozturk 1:efe9cad8942f 288 <a href="#_exclude">exclude=####</a> option described in the <a href="#_Other_Options">Other Options</a>
Mahir Ozturk 1:efe9cad8942f 289 section.</p>
Mahir Ozturk 1:efe9cad8942f 290 <p>
Mahir Ozturk 1:efe9cad8942f 291 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 292 <hr />
Mahir Ozturk 1:efe9cad8942f 293
Mahir Ozturk 1:efe9cad8942f 294 <!-- * * * * * * * * * * * * * * Quick Start * * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 295
Mahir Ozturk 1:efe9cad8942f 296 <h3 id="_Quick_Start">Quick Start</h3>
Mahir Ozturk 1:efe9cad8942f 297
Mahir Ozturk 1:efe9cad8942f 298 <p>
Mahir Ozturk 1:efe9cad8942f 299 If you have never used Artistic Style, there are several of ways to get started.</p>
Mahir Ozturk 1:efe9cad8942f 300 <p>
Mahir Ozturk 1:efe9cad8942f 301 One is to run it with no options at all. This will use the <a href="#_default_brace_style">default brace
Mahir Ozturk 1:efe9cad8942f 302 style</a>, 4 spaces per indent, and no formatting changes. This will break the braces for one
Mahir Ozturk 1:efe9cad8942f 303 line blocks and will break one line statements. To change this, use the option <a href="#_keep-one-line-blocks">keep-one-line-blocks</a>
Mahir Ozturk 1:efe9cad8942f 304 and/or <a href="#_keep-one-line-statements">keep-one-line-statements</a> described in the
Mahir Ozturk 1:efe9cad8942f 305 <a href="#_Formatting_Options">Formatting Options</a> section.</p>
Mahir Ozturk 1:efe9cad8942f 306 <p>
Mahir Ozturk 1:efe9cad8942f 307 Another way is to use one of the brace styles described in the <a href="#_Brace_Style_Options">Brace Style
Mahir Ozturk 1:efe9cad8942f 308 Options</a> section. Select one with a brace formatting style you like. If no indentation option is set,
Mahir Ozturk 1:efe9cad8942f 309 the default option of 4 spaces will be used. These options also break one line blocks and one line statements
Mahir Ozturk 1:efe9cad8942f 310 as described above.</p>
Mahir Ozturk 1:efe9cad8942f 311 <p>
Mahir Ozturk 1:efe9cad8942f 312 A third option is to use an options file from the &quot;file&quot; folder. If there is a coding style you want
Mahir Ozturk 1:efe9cad8942f 313 to duplicate, input the appropriate <a href="#_Options_File">options file</a>. Use the option
Mahir Ozturk 1:efe9cad8942f 314 <a href="#_options=">options=####</a> to specify the file to use. It must contain a path for the file, including
Mahir Ozturk 1:efe9cad8942f 315 the file name. </p>
Mahir Ozturk 1:efe9cad8942f 316 <p>
Mahir Ozturk 1:efe9cad8942f 317 Once you are familiar with the options you can customize the format to your personal preference.</p>
Mahir Ozturk 1:efe9cad8942f 318 <p>
Mahir Ozturk 1:efe9cad8942f 319 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 320 <hr />
Mahir Ozturk 1:efe9cad8942f 321
Mahir Ozturk 1:efe9cad8942f 322 <!-- * * * * * * * * * * * * * * * Usage * * * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 323
Mahir Ozturk 1:efe9cad8942f 324 <h3 id="_Usage">Usage</h3>
Mahir Ozturk 1:efe9cad8942f 325
Mahir Ozturk 1:efe9cad8942f 326 <p>
Mahir Ozturk 1:efe9cad8942f 327 Artistic style is a console program that receives information from the command line.</p>
Mahir Ozturk 1:efe9cad8942f 328 <div class="code">
Mahir Ozturk 1:efe9cad8942f 329 <p class="code">
Mahir Ozturk 1:efe9cad8942f 330 Command line format:</p>
Mahir Ozturk 1:efe9cad8942f 331 <pre>astyle&nbsp; [OPTIONS]&nbsp; <em>SourceFile1&nbsp; SourceFile2&nbsp; SourceFile3&nbsp; [ . . . ]</em></pre>
Mahir Ozturk 1:efe9cad8942f 332 </div>
Mahir Ozturk 1:efe9cad8942f 333 <p>
Mahir Ozturk 1:efe9cad8942f 334 The square brackets [ ] indicate that more than one option or more than one file name can be entered. They are
Mahir Ozturk 1:efe9cad8942f 335 NOT actually included in the command. For the options format refer to the following Options section.</p>
Mahir Ozturk 1:efe9cad8942f 336 <div class="code">
Mahir Ozturk 1:efe9cad8942f 337 <p class="code">
Mahir Ozturk 1:efe9cad8942f 338 Example to format a single file:</p>
Mahir Ozturk 1:efe9cad8942f 339 <pre>astyle --style=allman /home/user/project/foo.cpp
Mahir Ozturk 1:efe9cad8942f 340 </pre>
Mahir Ozturk 1:efe9cad8942f 341 <p class="code">
Mahir Ozturk 1:efe9cad8942f 342 Example to format all .cpp and .h files recursively:</p>
Mahir Ozturk 1:efe9cad8942f 343 <pre>astyle --style=allman --recursive /home/user/project/*.cpp /home/user/project/*.h
Mahir Ozturk 1:efe9cad8942f 344 </pre>
Mahir Ozturk 1:efe9cad8942f 345 </div>
Mahir Ozturk 1:efe9cad8942f 346 <p>
Mahir Ozturk 1:efe9cad8942f 347 The < and > characters may be used to redirect the files into standard input (stdin) and out of standard output
Mahir Ozturk 1:efe9cad8942f 348 (stdout) - don't forget them! With this option only one file at a time can be formatted. Wildcards are not
Mahir Ozturk 1:efe9cad8942f 349 recognized, there are no console messages, and a backup is not created. On Windows the output will always have
Mahir Ozturk 1:efe9cad8942f 350 Windows line ends. The options "stdin=" and "stdout=" can be used instead of redirection.</p>
Mahir Ozturk 1:efe9cad8942f 351 <div class="code">
Mahir Ozturk 1:efe9cad8942f 352 <p class="code">
Mahir Ozturk 1:efe9cad8942f 353 Example of redirection option to format a single file and change the name:</p>
Mahir Ozturk 1:efe9cad8942f 354 <pre>astyle --style=allman &lt; <em>OriginalSourceFile</em> &gt; <em>BeautifiedSourceFile</em>
Mahir Ozturk 1:efe9cad8942f 355 </pre>
Mahir Ozturk 1:efe9cad8942f 356 </div>
Mahir Ozturk 1:efe9cad8942f 357 <div class="code">
Mahir Ozturk 1:efe9cad8942f 358 <p class="code">
Mahir Ozturk 1:efe9cad8942f 359 The redirection option may be used to display the formatted file without updating:</p>
Mahir Ozturk 1:efe9cad8942f 360 <pre>astyle --style=allman &lt; <em>OriginalSourceFile</em> | less
Mahir Ozturk 1:efe9cad8942f 361 </pre>
Mahir Ozturk 1:efe9cad8942f 362 </div>
Mahir Ozturk 1:efe9cad8942f 363 <p>
Mahir Ozturk 1:efe9cad8942f 364 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 365 <hr />
Mahir Ozturk 1:efe9cad8942f 366
Mahir Ozturk 1:efe9cad8942f 367 <!-- * * * * * * * * * * * * * * * Options * * * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 368
Mahir Ozturk 1:efe9cad8942f 369 <h3 id="_Options">Options</h3>
Mahir Ozturk 1:efe9cad8942f 370
Mahir Ozturk 1:efe9cad8942f 371 <p>
Mahir Ozturk 1:efe9cad8942f 372 Not specifying any options will result in the <a href="#_default_brace_style">default brace style</a>,
Mahir Ozturk 1:efe9cad8942f 373 4 spaces per indent, and no formatting changes.</p>
Mahir Ozturk 1:efe9cad8942f 374 <p>
Mahir Ozturk 1:efe9cad8942f 375 Options may be written in two different ways.</p>
Mahir Ozturk 1:efe9cad8942f 376
Mahir Ozturk 1:efe9cad8942f 377 <h4>Long options</h4>
Mahir Ozturk 1:efe9cad8942f 378
Mahir Ozturk 1:efe9cad8942f 379 <p>
Mahir Ozturk 1:efe9cad8942f 380 These options start with '<strong>--</strong>', and must be written one at a time.<br />
Mahir Ozturk 1:efe9cad8942f 381 (Example: '--style=allman --indent=spaces=4')</p>
Mahir Ozturk 1:efe9cad8942f 382
Mahir Ozturk 1:efe9cad8942f 383 <h4>Short Options</h4>
Mahir Ozturk 1:efe9cad8942f 384
Mahir Ozturk 1:efe9cad8942f 385 <p>
Mahir Ozturk 1:efe9cad8942f 386 These options start with a single '<strong>-</strong>', and may be concatenated together.<br />
Mahir Ozturk 1:efe9cad8942f 387 (Example: '-bps4' is the same as writing '-b -p -s4'.)</p>
Mahir Ozturk 1:efe9cad8942f 388 <p>
Mahir Ozturk 1:efe9cad8942f 389 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 390 <hr />
Mahir Ozturk 1:efe9cad8942f 391
Mahir Ozturk 1:efe9cad8942f 392 <!-- * * * * * * * * * * * * * * Options File * * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 393
Mahir Ozturk 1:efe9cad8942f 394 <h3 id="_Options_File">Options File</h3>
Mahir Ozturk 1:efe9cad8942f 395
Mahir Ozturk 1:efe9cad8942f 396 <p>
Mahir Ozturk 1:efe9cad8942f 397 An OPTIONAL, default options file may be used to supplement or replace the command line options.&nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 398 <ul>
Mahir Ozturk 1:efe9cad8942f 399 <li>The command line options have precedence. If there is a conflict between a command line option and an option in
Mahir Ozturk 1:efe9cad8942f 400 the default options file, the command line option will be used.
Mahir Ozturk 1:efe9cad8942f 401 </li>
Mahir Ozturk 1:efe9cad8942f 402 <li>Artistic Style looks for this file in the following locations (in order):
Mahir Ozturk 1:efe9cad8942f 403 <ol>
Mahir Ozturk 1:efe9cad8942f 404 <li>the file indicated by the --options= command line option;</li>
Mahir Ozturk 1:efe9cad8942f 405 <li>the file and directory indicated by the environment variable ARTISTIC_STYLE_OPTIONS (if it exists);</li>
Mahir Ozturk 1:efe9cad8942f 406 <li>the file named .astylerc in the directory pointed to by the HOME environment variable (e.g. "$HOME/.astylerc"
Mahir Ozturk 1:efe9cad8942f 407 on Linux);
Mahir Ozturk 1:efe9cad8942f 408 </li>
Mahir Ozturk 1:efe9cad8942f 409 <li>the file named astylerc in the directory pointed to by the USERPROFILE environment variable (e.g. "%USERPROFILE%\astylerc"
Mahir Ozturk 1:efe9cad8942f 410 on Windows).
Mahir Ozturk 1:efe9cad8942f 411 </li>
Mahir Ozturk 1:efe9cad8942f 412 </ol>
Mahir Ozturk 1:efe9cad8942f 413 </li>
Mahir Ozturk 1:efe9cad8942f 414 <li>This option file lookup can be disabled by specifying --options=none on the command line.</li>
Mahir Ozturk 1:efe9cad8942f 415 <li>Options may be set apart by new-lines, tabs, commas, or spaces.</li>
Mahir Ozturk 1:efe9cad8942f 416 <li>Long options in the options file may be written without the preceding '--'.</li>
Mahir Ozturk 1:efe9cad8942f 417 <li>Lines within the options file that begin with '#' are considered line-comments.</li>
Mahir Ozturk 1:efe9cad8942f 418 </ul>
Mahir Ozturk 1:efe9cad8942f 419 <p>
Mahir Ozturk 1:efe9cad8942f 420 Example of a default options file:</p>
Mahir Ozturk 1:efe9cad8942f 421 <div class="code">
Mahir Ozturk 1:efe9cad8942f 422 <pre><span class="comment"># this line is a comment</span>
Mahir Ozturk 1:efe9cad8942f 423 --style=allman <span class="comment"># this is a line-end comment</span>
Mahir Ozturk 1:efe9cad8942f 424 <span class="comment"># long options can be written without the preceding '--'</span>
Mahir Ozturk 1:efe9cad8942f 425 indent-switches <span class="comment"># cannot do this on the command line</span>
Mahir Ozturk 1:efe9cad8942f 426 <span class="comment"># short options must have the preceding '-'</span>
Mahir Ozturk 1:efe9cad8942f 427 -t -p
Mahir Ozturk 1:efe9cad8942f 428 <span class="comment"># short options can be concatenated together</span>
Mahir Ozturk 1:efe9cad8942f 429 -M60Ucv</pre>
Mahir Ozturk 1:efe9cad8942f 430 </div>
Mahir Ozturk 1:efe9cad8942f 431 <p>
Mahir Ozturk 1:efe9cad8942f 432 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 433
Mahir Ozturk 1:efe9cad8942f 434 <hr />
Mahir Ozturk 1:efe9cad8942f 435
Mahir Ozturk 1:efe9cad8942f 436 <!-- * * * * * * * * * * * * * Disable Formatting * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 437
Mahir Ozturk 1:efe9cad8942f 438 <h3 id="_Disable_Formatting">Disable Formatting</h3>
Mahir Ozturk 1:efe9cad8942f 439
Mahir Ozturk 1:efe9cad8942f 440 <p>
Mahir Ozturk 1:efe9cad8942f 441 Formatting and indenting can be disabled with comment tags inserted in the source code.</p>
Mahir Ozturk 1:efe9cad8942f 442
Mahir Ozturk 1:efe9cad8942f 443 <h4>Disable Block</h4>
Mahir Ozturk 1:efe9cad8942f 444
Mahir Ozturk 1:efe9cad8942f 445 <p>
Mahir Ozturk 1:efe9cad8942f 446 Blocks of code can be disabled using &quot;off&quot; and &quot;on&quot; tags. The tags are included in the source
Mahir Ozturk 1:efe9cad8942f 447 file as comments. The comment may be a C comment (/* ... */) or a C++ line comment (//). The tag must be included
Mahir Ozturk 1:efe9cad8942f 448 in a single line comment. If the comment exceeds one line the indent tag will be ignored. Additional information
Mahir Ozturk 1:efe9cad8942f 449 can be included with the tag.</p>
Mahir Ozturk 1:efe9cad8942f 450 <p>
Mahir Ozturk 1:efe9cad8942f 451 The beginning tag is &quot;*INDENT-OFF*&quot; and the ending tag is &quot;*INDENT-ON*&quot;.
Mahir Ozturk 1:efe9cad8942f 452 They may be used anywhere in the program with the condition that parsing is partially disabled between the
Mahir Ozturk 1:efe9cad8942f 453 tags. Disabling partial statements may result in incorrect formatting after the ending tag. If this happens expand
Mahir Ozturk 1:efe9cad8942f 454 the tags to include additional code.</p>
Mahir Ozturk 1:efe9cad8942f 455 <div class="code">
Mahir Ozturk 1:efe9cad8942f 456 <p class="code">
Mahir Ozturk 1:efe9cad8942f 457 The following retains the format of a preprocessor define:</p>
Mahir Ozturk 1:efe9cad8942f 458 <pre><span class="comment">// *INDENT-OFF*</span>
Mahir Ozturk 1:efe9cad8942f 459 #define FOO_DECLARE_int32_(name) \
Mahir Ozturk 1:efe9cad8942f 460 FOO_API_ extern ::Int32 FOO_FLAG(name)
Mahir Ozturk 1:efe9cad8942f 461 <span class="comment">// *INDENT-ON*</span></pre>
Mahir Ozturk 1:efe9cad8942f 462 </div>
Mahir Ozturk 1:efe9cad8942f 463
Mahir Ozturk 1:efe9cad8942f 464 <h4>Disable Line</h4>
Mahir Ozturk 1:efe9cad8942f 465
Mahir Ozturk 1:efe9cad8942f 466 <p>
Mahir Ozturk 1:efe9cad8942f 467 Artistic Style cannot always determine the usage of symbols with more than one meaning. For example an asterisk
Mahir Ozturk 1:efe9cad8942f 468 (*) can be multiplication, a pointer, or a pointer dereference. The &quot;&amp;&quot; and &quot;&amp;&amp;&quot;
Mahir Ozturk 1:efe9cad8942f 469 symbols are a similar
Mahir Ozturk 1:efe9cad8942f 470 problem.</p>
Mahir Ozturk 1:efe9cad8942f 471 <p>
Mahir Ozturk 1:efe9cad8942f 472 If a symbol is being padded incorrectly, padding it manually may fix the problem. If it is still being
Mahir Ozturk 1:efe9cad8942f 473 padded incorrectly, then disabling the formatting may be necessary. To avoid having to use the &quot;disable block&quot;
Mahir Ozturk 1:efe9cad8942f 474 tags above, a single line disable is available.</p>
Mahir Ozturk 1:efe9cad8942f 475 <p>
Mahir Ozturk 1:efe9cad8942f 476 A line-end comment tag &quot;*NOPAD*&quot; will disable the &quot;pad-oper&quot;, &quot;align-pointer&quot;, and
Mahir Ozturk 1:efe9cad8942f 477 &quot;align-reference&quot; options. Parsing does NOT stop and all other formatting will be applied to the line.
Mahir Ozturk 1:efe9cad8942f 478 The tag applies to the one line only.</p>
Mahir Ozturk 1:efe9cad8942f 479 <div class="code">
Mahir Ozturk 1:efe9cad8942f 480 <p class="code">
Mahir Ozturk 1:efe9cad8942f 481 The following prevents the operator padding from changing:</p>
Mahir Ozturk 1:efe9cad8942f 482 <pre>size_t foo = (unsigned int) -1; <span class="comment">// *NOPAD*</span></pre>
Mahir Ozturk 1:efe9cad8942f 483 </div>
Mahir Ozturk 1:efe9cad8942f 484 <p>
Mahir Ozturk 1:efe9cad8942f 485 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 486 <hr />
Mahir Ozturk 1:efe9cad8942f 487
Mahir Ozturk 1:efe9cad8942f 488 <!-- * * * * * * * * * * * * Basic Brace Styles * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 489
Mahir Ozturk 1:efe9cad8942f 490 <h3 id="_Basic_Brace_Styles">Basic Brace Styles</h3>
Mahir Ozturk 1:efe9cad8942f 491
Mahir Ozturk 1:efe9cad8942f 492 <p>
Mahir Ozturk 1:efe9cad8942f 493 There are three basic brace styles.<br />
Mahir Ozturk 1:efe9cad8942f 494 Attached &#8211; The braces are attached to the end of
Mahir Ozturk 1:efe9cad8942f 495 the last line of the previous block. (Java).<br />
Mahir Ozturk 1:efe9cad8942f 496 Broken &#8211; The braces are broken from the previous
Mahir Ozturk 1:efe9cad8942f 497 block. (Allman).<br />
Mahir Ozturk 1:efe9cad8942f 498 Linux &#8211; The braces are attached except for the opening brace of a function, class, or namespace (K&amp;R,
Mahir Ozturk 1:efe9cad8942f 499 Linux).</p>
Mahir Ozturk 1:efe9cad8942f 500
Mahir Ozturk 1:efe9cad8942f 501 <p>
Mahir Ozturk 1:efe9cad8942f 502 Other brace styles are variations of these. Some will use variations on the placement of class, namespace,
Mahir Ozturk 1:efe9cad8942f 503 or other braces. (Stroustrup, Google, One True Brace, Lisp). Others will indent the braces (Whitesmith, VTK,
Mahir Ozturk 1:efe9cad8942f 504 Banner, and GNU). Still others will use run-in braces where the following statement is on the same line as the
Mahir Ozturk 1:efe9cad8942f 505 brace (Horstmann and Pico).</p>
Mahir Ozturk 1:efe9cad8942f 506 <p>
Mahir Ozturk 1:efe9cad8942f 507 There are technical arguments for selecting one style over another. But the usual reason comes down to
Mahir Ozturk 1:efe9cad8942f 508 personal preference. Some like broken braces with vertical whitespace that makes the code easy to read.
Mahir Ozturk 1:efe9cad8942f 509 Others like attached braces with code that is more compact. Sometimes programmers just want a change. It is
Mahir Ozturk 1:efe9cad8942f 510 easier to select a preference if you can see an entire file formatted in a certain brace style. With Artistic
Mahir Ozturk 1:efe9cad8942f 511 Style you can easily modify source code to suit your
Mahir Ozturk 1:efe9cad8942f 512 preference.</p>
Mahir Ozturk 1:efe9cad8942f 513
Mahir Ozturk 1:efe9cad8942f 514 <p>
Mahir Ozturk 1:efe9cad8942f 515 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 516 <hr />
Mahir Ozturk 1:efe9cad8942f 517
Mahir Ozturk 1:efe9cad8942f 518
Mahir Ozturk 1:efe9cad8942f 519 <!-- * * * * * * * * * * * * Brace Style Options * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 520
Mahir Ozturk 1:efe9cad8942f 521 <h3 id="_Brace_Style_Options">Brace Style Options</h3>
Mahir Ozturk 1:efe9cad8942f 522
Mahir Ozturk 1:efe9cad8942f 523 <p>
Mahir Ozturk 1:efe9cad8942f 524 Brace Style options define the brace style to use. All options default to 4 spaces per indent, indented with
Mahir Ozturk 1:efe9cad8942f 525 spaces. By default, none of the styles indent namespaces. Other indentations are indicated in the individual style
Mahir Ozturk 1:efe9cad8942f 526 description. All options will break the braces for one line blocks and will break one line statements. To change
Mahir Ozturk 1:efe9cad8942f 527 this, use the option <a href="#_keep-one-line-blocks">keep-one-line-blocks</a> and/or <a href="#_keep-one-line-statements">
Mahir Ozturk 1:efe9cad8942f 528 keep-one-line-statements</a> described in the <a href="#_Formatting_Options">Formatting Options</a>
Mahir Ozturk 1:efe9cad8942f 529 section.</p>
Mahir Ozturk 1:efe9cad8942f 530 <p>
Mahir Ozturk 1:efe9cad8942f 531 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 532 <p id="_default_brace_style">
Mahir Ozturk 1:efe9cad8942f 533 <code class="title">default brace style</code><br />
Mahir Ozturk 1:efe9cad8942f 534 If no brace style is requested, the default brace style will be used. The opening braces are not changed
Mahir Ozturk 1:efe9cad8942f 535 and the closing braces will be broken from the preceding line. There are a few exceptions to this.</p>
Mahir Ozturk 1:efe9cad8942f 536 <p>
Mahir Ozturk 1:efe9cad8942f 537 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 538 <p id="_style=allman">
Mahir Ozturk 1:efe9cad8942f 539 <code class="title">--style=allman / --style=bsd / --style=break / -A1</code><br />
Mahir Ozturk 1:efe9cad8942f 540 Allman style uses broken braces.</p>
Mahir Ozturk 1:efe9cad8942f 541 <div class="code">
Mahir Ozturk 1:efe9cad8942f 542 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 543 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 544 if (isBar)
Mahir Ozturk 1:efe9cad8942f 545 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 546 bar();
Mahir Ozturk 1:efe9cad8942f 547 return 1;
Mahir Ozturk 1:efe9cad8942f 548 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 549 else
Mahir Ozturk 1:efe9cad8942f 550 return 0;
Mahir Ozturk 1:efe9cad8942f 551 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 552 </pre>
Mahir Ozturk 1:efe9cad8942f 553 </div>
Mahir Ozturk 1:efe9cad8942f 554 <p>
Mahir Ozturk 1:efe9cad8942f 555 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 556 <p id="_style=java">
Mahir Ozturk 1:efe9cad8942f 557 <code class="title">--style=java / --style=attach / -A2</code><br />
Mahir Ozturk 1:efe9cad8942f 558 Java style uses attached braces.</p>
Mahir Ozturk 1:efe9cad8942f 559 <div class="code">
Mahir Ozturk 1:efe9cad8942f 560 <pre>int Foo(bool isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 561 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 562 bar();
Mahir Ozturk 1:efe9cad8942f 563 return 1;
Mahir Ozturk 1:efe9cad8942f 564 <span class="brace">}</span> else
Mahir Ozturk 1:efe9cad8942f 565 return 0;
Mahir Ozturk 1:efe9cad8942f 566 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 567 </pre>
Mahir Ozturk 1:efe9cad8942f 568 </div>
Mahir Ozturk 1:efe9cad8942f 569 <p>
Mahir Ozturk 1:efe9cad8942f 570 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 571 <p id="_style=kr">
Mahir Ozturk 1:efe9cad8942f 572 <code class="title">--style=kr / --style=k&amp;r / --style=k/r / -A3</code><br />
Mahir Ozturk 1:efe9cad8942f 573 Kernighan &amp; Ritchie style uses linux braces. Opening braces are broken from namespaces, classes, and function
Mahir Ozturk 1:efe9cad8942f 574 definitions. The braces are attached to everything else, including arrays, structs, enums, and statements within
Mahir Ozturk 1:efe9cad8942f 575 a function.</p>
Mahir Ozturk 1:efe9cad8942f 576 <p>
Mahir Ozturk 1:efe9cad8942f 577 Using the k&amp;r option may cause problems because of the &amp;. This can be resolved by enclosing the k&amp;r
Mahir Ozturk 1:efe9cad8942f 578 in quotes (e.g. &#8209;&#8209;style="k&amp;r") or by using one of the alternates &#8209;&#8209;style=kr or
Mahir Ozturk 1:efe9cad8942f 579 &#8209;&#8209;style=k/r.</p>
Mahir Ozturk 1:efe9cad8942f 580 <div class="code">
Mahir Ozturk 1:efe9cad8942f 581 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 582 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 583 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 584 bar();
Mahir Ozturk 1:efe9cad8942f 585 return 1;
Mahir Ozturk 1:efe9cad8942f 586 <span class="brace">}</span> else
Mahir Ozturk 1:efe9cad8942f 587 return 0;
Mahir Ozturk 1:efe9cad8942f 588 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 589 </pre>
Mahir Ozturk 1:efe9cad8942f 590 </div>
Mahir Ozturk 1:efe9cad8942f 591 <p>
Mahir Ozturk 1:efe9cad8942f 592 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 593 <p id="_style=stroustrup">
Mahir Ozturk 1:efe9cad8942f 594 <code class="title">--style=stroustrup / -A4</code><br />
Mahir Ozturk 1:efe9cad8942f 595 Stroustrup style uses linux braces with closing headers broken from closing braces
Mahir Ozturk 1:efe9cad8942f 596 (e.g. &#8209;&#8209;break&#8209;closing&#8209;headers). Opening braces are broken from function definitions only.
Mahir Ozturk 1:efe9cad8942f 597 The opening braces are attached to everything else, including namespaces, classes, arrays, structs, enums, and
Mahir Ozturk 1:efe9cad8942f 598 statements within a function. This style frequently is used with &quot;attach&#8209;closing&#8209;while&quot;,
Mahir Ozturk 1:efe9cad8942f 599 tabbed indents, and an indent of 5 spaces per tab.</p>
Mahir Ozturk 1:efe9cad8942f 600 <div class="code">
Mahir Ozturk 1:efe9cad8942f 601 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 602 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 603 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 604 bar();
Mahir Ozturk 1:efe9cad8942f 605 return 1;
Mahir Ozturk 1:efe9cad8942f 606 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 607 else
Mahir Ozturk 1:efe9cad8942f 608 return 0;
Mahir Ozturk 1:efe9cad8942f 609 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 610 </pre>
Mahir Ozturk 1:efe9cad8942f 611 </div>
Mahir Ozturk 1:efe9cad8942f 612 <p>
Mahir Ozturk 1:efe9cad8942f 613 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 614 <p id="_style=whitesmith">
Mahir Ozturk 1:efe9cad8942f 615 <code class="title">--style=whitesmith / -A5</code><br />
Mahir Ozturk 1:efe9cad8942f 616 Whitesmith style uses broken, indented braces. Switch blocks and class blocks are indented to prevent a 'hanging
Mahir Ozturk 1:efe9cad8942f 617 indent' with the following case statements and C++ class modifiers (public, private, protected).&nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 618 <div class="code">
Mahir Ozturk 1:efe9cad8942f 619 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 620 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 621 if (isBar)
Mahir Ozturk 1:efe9cad8942f 622 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 623 bar();
Mahir Ozturk 1:efe9cad8942f 624 return 1;
Mahir Ozturk 1:efe9cad8942f 625 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 626 else
Mahir Ozturk 1:efe9cad8942f 627 return 0;
Mahir Ozturk 1:efe9cad8942f 628 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 629 </pre>
Mahir Ozturk 1:efe9cad8942f 630 </div>
Mahir Ozturk 1:efe9cad8942f 631 <p>
Mahir Ozturk 1:efe9cad8942f 632 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 633 <p id="_style=vtk">
Mahir Ozturk 1:efe9cad8942f 634 <code class="title">--style=vtk / -A15</code><br />
Mahir Ozturk 1:efe9cad8942f 635 VTK (Visualization Toolkit) style uses broken, indented braces, except for the opening brace. Switch blocks
Mahir Ozturk 1:efe9cad8942f 636 are indented to prevent a 'hanging indent' with following case statements. </p>
Mahir Ozturk 1:efe9cad8942f 637 <div class="code">
Mahir Ozturk 1:efe9cad8942f 638 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 639 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 640 if (isBar)
Mahir Ozturk 1:efe9cad8942f 641 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 642 bar();
Mahir Ozturk 1:efe9cad8942f 643 return 1;
Mahir Ozturk 1:efe9cad8942f 644 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 645 else
Mahir Ozturk 1:efe9cad8942f 646 return 0;
Mahir Ozturk 1:efe9cad8942f 647 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 648 </pre>
Mahir Ozturk 1:efe9cad8942f 649 </div>
Mahir Ozturk 1:efe9cad8942f 650 <p>
Mahir Ozturk 1:efe9cad8942f 651 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 652 <p id="_style=banner">
Mahir Ozturk 1:efe9cad8942f 653 <code class="title">--style=banner / -A6</code><br />
Mahir Ozturk 1:efe9cad8942f 654 Banner style uses attached, indented braces. Switch blocks and class blocks are indented to prevent a 'hanging
Mahir Ozturk 1:efe9cad8942f 655 indent' with following case statements and C++ class modifiers (public, private, protected).&nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 656 <div class="code">
Mahir Ozturk 1:efe9cad8942f 657 <pre>int Foo(bool isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 658 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 659 bar();
Mahir Ozturk 1:efe9cad8942f 660 return 1;
Mahir Ozturk 1:efe9cad8942f 661 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 662 else
Mahir Ozturk 1:efe9cad8942f 663 return 0;
Mahir Ozturk 1:efe9cad8942f 664 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 665 </pre>
Mahir Ozturk 1:efe9cad8942f 666 </div>
Mahir Ozturk 1:efe9cad8942f 667 <p>
Mahir Ozturk 1:efe9cad8942f 668 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 669 <p id="_style=gnu">
Mahir Ozturk 1:efe9cad8942f 670 <code class="title">--style=gnu / -A7</code><br />
Mahir Ozturk 1:efe9cad8942f 671 GNU style uses broken braces and indented blocks. Extra indentation is added to blocks <strong>within a
Mahir Ozturk 1:efe9cad8942f 672 function</strong> only. Other braces and blocks are broken, but NOT indented. This style frequently is
Mahir Ozturk 1:efe9cad8942f 673 used with an indent of 2 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 674 <div class="code">
Mahir Ozturk 1:efe9cad8942f 675 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 676 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 677 if (isBar)
Mahir Ozturk 1:efe9cad8942f 678 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 679 bar();
Mahir Ozturk 1:efe9cad8942f 680 return 1;
Mahir Ozturk 1:efe9cad8942f 681 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 682 else
Mahir Ozturk 1:efe9cad8942f 683 return 0;
Mahir Ozturk 1:efe9cad8942f 684 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 685 </pre>
Mahir Ozturk 1:efe9cad8942f 686 </div>
Mahir Ozturk 1:efe9cad8942f 687 <p>
Mahir Ozturk 1:efe9cad8942f 688 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 689 <p id="_style=linux">
Mahir Ozturk 1:efe9cad8942f 690 <code class="title">--style=linux / --style=knf / -A8</code><br />
Mahir Ozturk 1:efe9cad8942f 691 Linux style uses linux braces. Opening braces are broken from namespace, class, and function definitions.
Mahir Ozturk 1:efe9cad8942f 692 The braces are attached to everything else, including arrays, structs, enums, and statements within a function.
Mahir Ozturk 1:efe9cad8942f 693 The <strong>minimum conditional indent</strong> is one-half indent. If you want a different minimum conditional
Mahir Ozturk 1:efe9cad8942f 694 indent, use the K&amp;R style instead. This style works best with a large indent. It frequently is used with
Mahir Ozturk 1:efe9cad8942f 695 an indent of 8 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 696 <p>
Mahir Ozturk 1:efe9cad8942f 697 Also known as Kernel Normal Form (KNF) style, this is the style used in the Linux
Mahir Ozturk 1:efe9cad8942f 698 BSD kernel.</p>
Mahir Ozturk 1:efe9cad8942f 699 <div class="code">
Mahir Ozturk 1:efe9cad8942f 700 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 701 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 702 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 703 bar();
Mahir Ozturk 1:efe9cad8942f 704 return 1;
Mahir Ozturk 1:efe9cad8942f 705 <span class="brace">}</span> else
Mahir Ozturk 1:efe9cad8942f 706 return 0;
Mahir Ozturk 1:efe9cad8942f 707 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 708 </pre>
Mahir Ozturk 1:efe9cad8942f 709 </div>
Mahir Ozturk 1:efe9cad8942f 710 <p>
Mahir Ozturk 1:efe9cad8942f 711 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 712 <p id="_style=horstmann">
Mahir Ozturk 1:efe9cad8942f 713 <code class="title">--style=horstmann / --style=run-in / -A9</code><br />
Mahir Ozturk 1:efe9cad8942f 714 Horstmann style uses broken braces and run-in statements. Switches are indented to allow a run-in to the opening
Mahir Ozturk 1:efe9cad8942f 715 switch block. This style frequently is used with an indent of 3 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 716 <div class="code">
Mahir Ozturk 1:efe9cad8942f 717 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 718 <span class="brace">{</span> if (isBar)
Mahir Ozturk 1:efe9cad8942f 719 <span class="brace">{</span> bar();
Mahir Ozturk 1:efe9cad8942f 720 return 1;
Mahir Ozturk 1:efe9cad8942f 721 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 722 else
Mahir Ozturk 1:efe9cad8942f 723 return 0;
Mahir Ozturk 1:efe9cad8942f 724 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 725 </pre>
Mahir Ozturk 1:efe9cad8942f 726 </div>
Mahir Ozturk 1:efe9cad8942f 727 <p>
Mahir Ozturk 1:efe9cad8942f 728 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 729 <p id="_style=1tbs">
Mahir Ozturk 1:efe9cad8942f 730 <code class="title">--style=1tbs / --style=otbs / -A10</code><br />
Mahir Ozturk 1:efe9cad8942f 731 "One True Brace Style" uses linux braces and adds braces to unbraced one line conditional statements. Opening
Mahir Ozturk 1:efe9cad8942f 732 braces are broken from namespaces, classes, and function definitions. The braces are attached to everything
Mahir Ozturk 1:efe9cad8942f 733 else, including arrays, structs, enums, and statements within a function. </p>
Mahir Ozturk 1:efe9cad8942f 734 <p>
Mahir Ozturk 1:efe9cad8942f 735 In the following example, braces have been added to the "return 0;" statement. The option
Mahir Ozturk 1:efe9cad8942f 736 &#8209;&#8209;add&#8209;one&#8209;line&#8209;braces can also be used with this style.</p>
Mahir Ozturk 1:efe9cad8942f 737 <div class="code">
Mahir Ozturk 1:efe9cad8942f 738 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 739 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 740 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 741 bar();
Mahir Ozturk 1:efe9cad8942f 742 return 1;
Mahir Ozturk 1:efe9cad8942f 743 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 744 return 0;
Mahir Ozturk 1:efe9cad8942f 745 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 746 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 747 </pre>
Mahir Ozturk 1:efe9cad8942f 748 </div>
Mahir Ozturk 1:efe9cad8942f 749 <p>
Mahir Ozturk 1:efe9cad8942f 750 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 751 <p id="_style=google">
Mahir Ozturk 1:efe9cad8942f 752 <code class="title">--style=google / -A14</code><br />
Mahir Ozturk 1:efe9cad8942f 753 Google style uses attached braces and indented class access modifiers.&nbsp;See the indent-modifiers
Mahir Ozturk 1:efe9cad8942f 754 option for an example of the indented modifiers format. This is not actually a unique brace style, but
Mahir Ozturk 1:efe9cad8942f 755 is Java style with a non-brace variation. This style frequently is used with an indent of 2 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 756 <div class="code">
Mahir Ozturk 1:efe9cad8942f 757 <pre>int Foo(bool isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 758 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 759 bar();
Mahir Ozturk 1:efe9cad8942f 760 return 1;
Mahir Ozturk 1:efe9cad8942f 761 <span class="brace">}</span> else
Mahir Ozturk 1:efe9cad8942f 762 return 0;
Mahir Ozturk 1:efe9cad8942f 763 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 764 </pre>
Mahir Ozturk 1:efe9cad8942f 765 </div>
Mahir Ozturk 1:efe9cad8942f 766 <p>
Mahir Ozturk 1:efe9cad8942f 767 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 768 <p id="_style=mozilla">
Mahir Ozturk 1:efe9cad8942f 769 <code class="title">--style=mozilla / -A16</code><br />
Mahir Ozturk 1:efe9cad8942f 770 Mozilla style uses linux braces. Opening braces are broken from classes, structs, enums, and function
Mahir Ozturk 1:efe9cad8942f 771 definitions. The braces are attached to everything else, including namespaces, arrays, and statements
Mahir Ozturk 1:efe9cad8942f 772 within a function. This style frequently is used with an indent of 2 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 773 <div class="code">
Mahir Ozturk 1:efe9cad8942f 774 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 775 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 776 if (isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 777 bar();
Mahir Ozturk 1:efe9cad8942f 778 return 1;
Mahir Ozturk 1:efe9cad8942f 779 <span class="brace">}</span> else
Mahir Ozturk 1:efe9cad8942f 780 return 0;
Mahir Ozturk 1:efe9cad8942f 781 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 782 </pre>
Mahir Ozturk 1:efe9cad8942f 783 </div>
Mahir Ozturk 1:efe9cad8942f 784 <p>
Mahir Ozturk 1:efe9cad8942f 785 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 786 <p id="_style=pico">
Mahir Ozturk 1:efe9cad8942f 787 <code class="title">--style=pico / -A11</code><br />
Mahir Ozturk 1:efe9cad8942f 788 Pico style uses broken braces and run-in statements with attached closing braces. The closing brace is attached
Mahir Ozturk 1:efe9cad8942f 789 to the last line in the block. Switches are indented to allow a run-in to the opening switch block. The style
Mahir Ozturk 1:efe9cad8942f 790 implies keep-one-line-blocks and keep-one-line-statements. If add-braces is used they will be added as one-line
Mahir Ozturk 1:efe9cad8942f 791 braces. This style frequently is used with an indent of 2 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 792 <div class="code">
Mahir Ozturk 1:efe9cad8942f 793 <pre>int Foo(bool isBar)
Mahir Ozturk 1:efe9cad8942f 794 <span class="brace">{</span> if (isBar)
Mahir Ozturk 1:efe9cad8942f 795 <span class="brace">{</span> bar();
Mahir Ozturk 1:efe9cad8942f 796 return 1; <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 797 else
Mahir Ozturk 1:efe9cad8942f 798 return 0; <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 799 </pre>
Mahir Ozturk 1:efe9cad8942f 800 </div>
Mahir Ozturk 1:efe9cad8942f 801 <p>
Mahir Ozturk 1:efe9cad8942f 802 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 803 <p id="_style=lisp">
Mahir Ozturk 1:efe9cad8942f 804 <code class="title">--style=lisp / --style=python / -A12</code><br />
Mahir Ozturk 1:efe9cad8942f 805 Lisp style uses attached opening and closing braces. The closing brace is attached to the last line in the
Mahir Ozturk 1:efe9cad8942f 806 block. The style implies keep-one-line-statements, but NOT keep-one-line-blocks. This style does not support one-line
Mahir Ozturk 1:efe9cad8942f 807 braces. If add-one-line-braces is used they will be added as multiple-line braces.</p>
Mahir Ozturk 1:efe9cad8942f 808 <div class="code">
Mahir Ozturk 1:efe9cad8942f 809 <pre>int Foo(bool isBar) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 810 if (isBar) <span class="brace">{
Mahir Ozturk 1:efe9cad8942f 811 </span> bar()
Mahir Ozturk 1:efe9cad8942f 812 return 1; <span class="brace">}
Mahir Ozturk 1:efe9cad8942f 813 </span> else
Mahir Ozturk 1:efe9cad8942f 814 return 0; <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 815 </pre>
Mahir Ozturk 1:efe9cad8942f 816 </div>
Mahir Ozturk 1:efe9cad8942f 817 <p>
Mahir Ozturk 1:efe9cad8942f 818 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 819 <hr />
Mahir Ozturk 1:efe9cad8942f 820
Mahir Ozturk 1:efe9cad8942f 821 <!-- * * * * * * * * * * * * * * * Tab Options * * * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 822
Mahir Ozturk 1:efe9cad8942f 823 <h3 id="_Tab_Options">Tab Options</h3>
Mahir Ozturk 1:efe9cad8942f 824
Mahir Ozturk 1:efe9cad8942f 825 <p>
Mahir Ozturk 1:efe9cad8942f 826 The following examples show whitespace characters. A space is indicated with a <strong>.</strong> (dot), a tab
Mahir Ozturk 1:efe9cad8942f 827 is indicated by a &gt; (greater than).</p>
Mahir Ozturk 1:efe9cad8942f 828 <p id="_default_indent">
Mahir Ozturk 1:efe9cad8942f 829 <code class="title">default indent</code><br />
Mahir Ozturk 1:efe9cad8942f 830 If no indentation option is set, the default option of 4 spaces will be used (e.g. -s<span class="option">4</span>
Mahir Ozturk 1:efe9cad8942f 831 --indent=spaces=<span class="option">4</span>).</p>
Mahir Ozturk 1:efe9cad8942f 832 <div class="code">
Mahir Ozturk 1:efe9cad8942f 833 <p class="code">
Mahir Ozturk 1:efe9cad8942f 834 with default values:</p>
Mahir Ozturk 1:efe9cad8942f 835 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 836 ....if (isBar1
Mahir Ozturk 1:efe9cad8942f 837 ............&amp;&amp; isBar2) <span class="comment">// indent of this line can be changed with min-conditional-indent</span>
Mahir Ozturk 1:efe9cad8942f 838 ........bar();
Mahir Ozturk 1:efe9cad8942f 839 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 840 </pre>
Mahir Ozturk 1:efe9cad8942f 841 </div>
Mahir Ozturk 1:efe9cad8942f 842 <p>
Mahir Ozturk 1:efe9cad8942f 843 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 844 <p id="_indent=spaces">
Mahir Ozturk 1:efe9cad8942f 845 <code class="title">--indent=spaces / --indent=spaces=<span class="option">#</span> / -s<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 846 Indent using # <strong>spaces</strong> per indent (e.g. -s<span class="option">3</span> --indent=spaces=<span
Mahir Ozturk 1:efe9cad8942f 847 class="option">3</span>). # must be between 2 and 20. Not specifying # will result in a default of
Mahir Ozturk 1:efe9cad8942f 848 4 spaces per indent.</p>
Mahir Ozturk 1:efe9cad8942f 849 <div class="code">
Mahir Ozturk 1:efe9cad8942f 850 <p class="code">
Mahir Ozturk 1:efe9cad8942f 851 with indent=spaces=3</p>
Mahir Ozturk 1:efe9cad8942f 852 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 853 ...if (isBar1
Mahir Ozturk 1:efe9cad8942f 854 .........&amp;&amp; isBar2) <span class="comment">// indent of this line can be changed with min-conditional-indent</span>
Mahir Ozturk 1:efe9cad8942f 855 ......bar();
Mahir Ozturk 1:efe9cad8942f 856 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 857 </pre>
Mahir Ozturk 1:efe9cad8942f 858 </div>
Mahir Ozturk 1:efe9cad8942f 859 <p>
Mahir Ozturk 1:efe9cad8942f 860 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 861 <p id="_indent=tab">
Mahir Ozturk 1:efe9cad8942f 862 <code class="title">--indent=tab / --indent=tab=<span class="option">#</span> / -t / -t<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 863 Indent using <strong>tabs for indentation, and spaces for continuation line alignment</strong>. This ensures that
Mahir Ozturk 1:efe9cad8942f 864 the code is displayed correctly&nbsp; regardless of the viewer&#8217;s tab size. Treat each indent as # spaces
Mahir Ozturk 1:efe9cad8942f 865 (e.g. -t<span class="option">6</span> / --indent=tab=<span class="option">6</span>).
Mahir Ozturk 1:efe9cad8942f 866 # must be between 2 and 20. If no # is set, treats indents as 4 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 867 <div class="code">
Mahir Ozturk 1:efe9cad8942f 868 <p class="code">
Mahir Ozturk 1:efe9cad8942f 869 with indent=tab:</p>
Mahir Ozturk 1:efe9cad8942f 870 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 871 &gt; if (isBar1
Mahir Ozturk 1:efe9cad8942f 872 &gt; ........&amp;&amp; isBar2) <span class="comment">// indent of this line can be changed with min-conditional-indent</span>
Mahir Ozturk 1:efe9cad8942f 873 &gt; &gt; bar();
Mahir Ozturk 1:efe9cad8942f 874 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 875 </pre>
Mahir Ozturk 1:efe9cad8942f 876 <p class="code">
Mahir Ozturk 1:efe9cad8942f 877 with style=linux, indent=tab=8:</p>
Mahir Ozturk 1:efe9cad8942f 878 <pre>void Foo()
Mahir Ozturk 1:efe9cad8942f 879 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 880 &gt; if (isBar1
Mahir Ozturk 1:efe9cad8942f 881 &gt; ....&amp;&amp; isBar2) <span class="comment">// indent of this line can NOT be changed with style=linux</span>
Mahir Ozturk 1:efe9cad8942f 882 &gt; &gt; bar();
Mahir Ozturk 1:efe9cad8942f 883 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 884 </pre>
Mahir Ozturk 1:efe9cad8942f 885 </div>
Mahir Ozturk 1:efe9cad8942f 886 <p>
Mahir Ozturk 1:efe9cad8942f 887 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 888 <p id="_indent=force-tab">
Mahir Ozturk 1:efe9cad8942f 889 <code class="title">--indent=force-tab / --indent=force-tab=<span class="option">#</span> / -T / -T<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 890 Indent using <strong>all tab</strong> characters, if possible. If a continuation line is not an even number of
Mahir Ozturk 1:efe9cad8942f 891 tabs, spaces will be added at the end. Treat each tab as # spaces (e.g. -T<span class="option">6</span>
Mahir Ozturk 1:efe9cad8942f 892 / --indent=<span lang="en-us">force-</span>tab=<span class="option">6</span>). # must be between
Mahir Ozturk 1:efe9cad8942f 893 2 and 20. If no # is set, treats tabs as 4 spaces.</p>
Mahir Ozturk 1:efe9cad8942f 894 <div class="code">
Mahir Ozturk 1:efe9cad8942f 895 <p class="code">
Mahir Ozturk 1:efe9cad8942f 896 with indent=force-tab:</p>
Mahir Ozturk 1:efe9cad8942f 897 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 898 &gt; if (isBar1
Mahir Ozturk 1:efe9cad8942f 899 &gt; &gt; &gt; &amp;&amp; isBar2) <span class="comment">// indent of this line can be changed with min-conditional-indent</span>
Mahir Ozturk 1:efe9cad8942f 900 &gt; &gt; bar();
Mahir Ozturk 1:efe9cad8942f 901 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 902 </pre>
Mahir Ozturk 1:efe9cad8942f 903 </div>
Mahir Ozturk 1:efe9cad8942f 904 <p>
Mahir Ozturk 1:efe9cad8942f 905 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 906 <p id="_indent=force-tab-x">
Mahir Ozturk 1:efe9cad8942f 907 <code class="title">--indent=force-tab-x / --indent=force-tab-x=<span class="option">#</span> / -xT / -xT<span
Mahir Ozturk 1:efe9cad8942f 908 class="option">#</span>
Mahir Ozturk 1:efe9cad8942f 909 </code><br />
Mahir Ozturk 1:efe9cad8942f 910 This force-tab option allows the tab length to be set to a length that is different than the indent length. This
Mahir Ozturk 1:efe9cad8942f 911 may cause the indentation to be <strong>a mix of both tabs and spaces.</strong> Tabs will be used to indent, if
Mahir Ozturk 1:efe9cad8942f 912 possible. If a tab indent cannot be used, spaces will be used instead.</p>
Mahir Ozturk 1:efe9cad8942f 913 <p>
Mahir Ozturk 1:efe9cad8942f 914 This option sets the <strong>tab length.</strong> Treat each tab as # spaces (e.g. -xT<span class="option">6</span>
Mahir Ozturk 1:efe9cad8942f 915 / --indent=<span lang="en-us">force-</span>tab-x=<span class="option">6</span>. # must be between
Mahir Ozturk 1:efe9cad8942f 916 2 and 20. If no # is set, treats tabs as 8 spaces. To change the <strong>indent length</strong> from the default
Mahir Ozturk 1:efe9cad8942f 917 of 4 spaces the option "indent=force-tab" must also be used.</p>
Mahir Ozturk 1:efe9cad8942f 918 <div class="code">
Mahir Ozturk 1:efe9cad8942f 919 <p class="code">
Mahir Ozturk 1:efe9cad8942f 920 with indent=force-tab-x (default tab length of 8 and default indent length of 4):</p>
Mahir Ozturk 1:efe9cad8942f 921 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 922 ....if (isBar1
Mahir Ozturk 1:efe9cad8942f 923 &gt; ....&amp;&amp; isBar2) <span class="comment">// indent of this line can be changed with min-conditional-indent</span>
Mahir Ozturk 1:efe9cad8942f 924 > bar();
Mahir Ozturk 1:efe9cad8942f 925 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 926 </pre>
Mahir Ozturk 1:efe9cad8942f 927 </div>
Mahir Ozturk 1:efe9cad8942f 928 <p>
Mahir Ozturk 1:efe9cad8942f 929 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 930 <hr />
Mahir Ozturk 1:efe9cad8942f 931
Mahir Ozturk 1:efe9cad8942f 932 <!-- * * * * * * * * * * * * Brace Modify Options * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 933
Mahir Ozturk 1:efe9cad8942f 934 <h3 id="_Brace_Modify_Options">Brace Modify Options</h3>
Mahir Ozturk 1:efe9cad8942f 935
Mahir Ozturk 1:efe9cad8942f 936 <p id="_attach_namespaces">
Mahir Ozturk 1:efe9cad8942f 937 <code class="title">--attach-namespaces / -xn</code><br />
Mahir Ozturk 1:efe9cad8942f 938 Attach braces to a namespace statement. This is done regardless of the brace style being used.
Mahir Ozturk 1:efe9cad8942f 939 It will also attach braces to CORBA IDL module statements.</p>
Mahir Ozturk 1:efe9cad8942f 940 <div class="code">
Mahir Ozturk 1:efe9cad8942f 941 <p class="code">
Mahir Ozturk 1:efe9cad8942f 942 the brace is always attached to a namespace statement:</p>
Mahir Ozturk 1:efe9cad8942f 943 <pre>namespace FooName <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 944 ...
Mahir Ozturk 1:efe9cad8942f 945 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 946 </pre>
Mahir Ozturk 1:efe9cad8942f 947 </div>
Mahir Ozturk 1:efe9cad8942f 948 <p>
Mahir Ozturk 1:efe9cad8942f 949 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 950 <p id="_attach_classes">
Mahir Ozturk 1:efe9cad8942f 951 <code class="title">--attach-classes / -xc</code><br />
Mahir Ozturk 1:efe9cad8942f 952 Attach braces to a class statement. This is done regardless of the brace style being used.</p>
Mahir Ozturk 1:efe9cad8942f 953 <div class="code">
Mahir Ozturk 1:efe9cad8942f 954 <p class="code">
Mahir Ozturk 1:efe9cad8942f 955 the brace is always attached to a class statement:</p>
Mahir Ozturk 1:efe9cad8942f 956 <pre>class FooClass <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 957 ...
Mahir Ozturk 1:efe9cad8942f 958 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 959 </pre>
Mahir Ozturk 1:efe9cad8942f 960 </div>
Mahir Ozturk 1:efe9cad8942f 961 <p>
Mahir Ozturk 1:efe9cad8942f 962 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 963 <p id="_attach_inlines">
Mahir Ozturk 1:efe9cad8942f 964 <code class="title">--attach-inlines / -xl</code><br />
Mahir Ozturk 1:efe9cad8942f 965 Attach braces to class and struct inline function definitions. This option has precedence for all
Mahir Ozturk 1:efe9cad8942f 966 styles except Horstmann and Pico (run-in styles). It is effective for C++ files only.</p>
Mahir Ozturk 1:efe9cad8942f 967 <div class="code">
Mahir Ozturk 1:efe9cad8942f 968 <p class="code">
Mahir Ozturk 1:efe9cad8942f 969 all braces are attached to class and struct inline method definitions:</p>
Mahir Ozturk 1:efe9cad8942f 970 <pre>class FooClass
Mahir Ozturk 1:efe9cad8942f 971 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 972 void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 973 ...
Mahir Ozturk 1:efe9cad8942f 974 <span class="brace"> }</span>
Mahir Ozturk 1:efe9cad8942f 975 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 976 </pre>
Mahir Ozturk 1:efe9cad8942f 977 </div>
Mahir Ozturk 1:efe9cad8942f 978 <p>
Mahir Ozturk 1:efe9cad8942f 979 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 980 <p id="_attach-extern-c">
Mahir Ozturk 1:efe9cad8942f 981 <code class="title">--attach-extern-c / -xk</code><br />
Mahir Ozturk 1:efe9cad8942f 982 Attach braces to a braced extern "C" statement. This is done regardless of the brace style being used.
Mahir Ozturk 1:efe9cad8942f 983 This option is effective for C++ files only.</p>
Mahir Ozturk 1:efe9cad8942f 984 <p>
Mahir Ozturk 1:efe9cad8942f 985 An extern "C" statement that is part of a function definition is formatted according to the requested brace
Mahir Ozturk 1:efe9cad8942f 986 style. Braced extern "C" statements are unaffected by the brace style and this option is the only way to
Mahir Ozturk 1:efe9cad8942f 987 change them.</p>
Mahir Ozturk 1:efe9cad8942f 988 <div class="code">
Mahir Ozturk 1:efe9cad8942f 989 <p class="code">
Mahir Ozturk 1:efe9cad8942f 990 this option attaches braces to a braced extern "C" statement:</p>
Mahir Ozturk 1:efe9cad8942f 991 <pre>#ifdef __cplusplus
Mahir Ozturk 1:efe9cad8942f 992 extern "C" <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 993 #endif
Mahir Ozturk 1:efe9cad8942f 994 </pre>
Mahir Ozturk 1:efe9cad8942f 995 <p class="code">
Mahir Ozturk 1:efe9cad8942f 996 but function definitions are formatted according to the requested brace style:</p>
Mahir Ozturk 1:efe9cad8942f 997 <pre>extern "C" EXPORT void STDCALL Foo()
Mahir Ozturk 1:efe9cad8942f 998 <span class="brace">{}</span>
Mahir Ozturk 1:efe9cad8942f 999 </pre>
Mahir Ozturk 1:efe9cad8942f 1000 </div>
Mahir Ozturk 1:efe9cad8942f 1001 <p>
Mahir Ozturk 1:efe9cad8942f 1002 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1003 <p id="_attach-closing-while">
Mahir Ozturk 1:efe9cad8942f 1004 <code class="title">--attach-closing-while / -xV</code><br />
Mahir Ozturk 1:efe9cad8942f 1005 Attach the closing 'while' of a 'do-while' statement to the closing brace. This has precedence over both
Mahir Ozturk 1:efe9cad8942f 1006 the brace style and the break closing braces option.</p>
Mahir Ozturk 1:efe9cad8942f 1007 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1008 <pre>do
Mahir Ozturk 1:efe9cad8942f 1009 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1010 bar();
Mahir Ozturk 1:efe9cad8942f 1011 ++x;
Mahir Ozturk 1:efe9cad8942f 1012 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1013 while x == 1;
Mahir Ozturk 1:efe9cad8942f 1014 </pre>
Mahir Ozturk 1:efe9cad8942f 1015 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1016 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1017 <pre>do
Mahir Ozturk 1:efe9cad8942f 1018 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1019 bar();
Mahir Ozturk 1:efe9cad8942f 1020 ++x;
Mahir Ozturk 1:efe9cad8942f 1021 <span class="brace">}</span> while x == 1;
Mahir Ozturk 1:efe9cad8942f 1022 </pre>
Mahir Ozturk 1:efe9cad8942f 1023 </div>
Mahir Ozturk 1:efe9cad8942f 1024 <p>
Mahir Ozturk 1:efe9cad8942f 1025 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1026 <hr />
Mahir Ozturk 1:efe9cad8942f 1027
Mahir Ozturk 1:efe9cad8942f 1028 <!-- * * * * * * * * * * * * * Indentation Options * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 1029
Mahir Ozturk 1:efe9cad8942f 1030 <h3 id="_Indentation_Options">Indentation Options</h3>
Mahir Ozturk 1:efe9cad8942f 1031
Mahir Ozturk 1:efe9cad8942f 1032 <p id="_indent-classes">
Mahir Ozturk 1:efe9cad8942f 1033 <code class="title">--indent-classes / -C</code><br />
Mahir Ozturk 1:efe9cad8942f 1034 Indent 'class' and 'struct' blocks so that the entire block is indented. The struct
Mahir Ozturk 1:efe9cad8942f 1035 blocks are indented only if an access modifier, 'public:', 'protected:' or 'private:',
Mahir Ozturk 1:efe9cad8942f 1036 is declared somewhere in the struct. This option is effective for C++ files only.</p>
Mahir Ozturk 1:efe9cad8942f 1037 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1038 <pre>class Foo
Mahir Ozturk 1:efe9cad8942f 1039 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1040 public:
Mahir Ozturk 1:efe9cad8942f 1041 Foo();
Mahir Ozturk 1:efe9cad8942f 1042 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1043 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1044 </pre>
Mahir Ozturk 1:efe9cad8942f 1045 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1046 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1047 <pre>class Foo
Mahir Ozturk 1:efe9cad8942f 1048 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1049 public:
Mahir Ozturk 1:efe9cad8942f 1050 Foo();
Mahir Ozturk 1:efe9cad8942f 1051 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1052 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1053 </pre>
Mahir Ozturk 1:efe9cad8942f 1054 </div>
Mahir Ozturk 1:efe9cad8942f 1055 <p>
Mahir Ozturk 1:efe9cad8942f 1056 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1057 <p id="_indent-modifiers">
Mahir Ozturk 1:efe9cad8942f 1058 <code class="title">--indent-modifiers / -xG</code><br />
Mahir Ozturk 1:efe9cad8942f 1059 Indent 'class ' and 'struct' access modifiers, 'public:', 'protected:'
Mahir Ozturk 1:efe9cad8942f 1060 and 'private:', one half indent. The rest of the class is not indented. This option is effective
Mahir Ozturk 1:efe9cad8942f 1061 for C++ files only. If used with indent&#8209;classes this option will be ignored.</p>
Mahir Ozturk 1:efe9cad8942f 1062 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1063 <pre>class Foo
Mahir Ozturk 1:efe9cad8942f 1064 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1065 public:
Mahir Ozturk 1:efe9cad8942f 1066 Foo();
Mahir Ozturk 1:efe9cad8942f 1067 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1068 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1069 </pre>
Mahir Ozturk 1:efe9cad8942f 1070 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1071 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1072 <pre>class Foo
Mahir Ozturk 1:efe9cad8942f 1073 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1074 public:
Mahir Ozturk 1:efe9cad8942f 1075 Foo();
Mahir Ozturk 1:efe9cad8942f 1076 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1077 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1078 </pre>
Mahir Ozturk 1:efe9cad8942f 1079 </div>
Mahir Ozturk 1:efe9cad8942f 1080 <p>
Mahir Ozturk 1:efe9cad8942f 1081 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1082 <p id="_indent-switches">
Mahir Ozturk 1:efe9cad8942f 1083 <code class="title">--indent-switches / -S</code><br />
Mahir Ozturk 1:efe9cad8942f 1084 Indent 'switch' blocks so that the 'case X:' statements are indented in the switch block. The entire
Mahir Ozturk 1:efe9cad8942f 1085 case block is indented.</p>
Mahir Ozturk 1:efe9cad8942f 1086 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1087 <pre>switch (foo)
Mahir Ozturk 1:efe9cad8942f 1088 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1089 case 1:
Mahir Ozturk 1:efe9cad8942f 1090 a += 1;
Mahir Ozturk 1:efe9cad8942f 1091 break;
Mahir Ozturk 1:efe9cad8942f 1092
Mahir Ozturk 1:efe9cad8942f 1093 case 2:
Mahir Ozturk 1:efe9cad8942f 1094 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1095 a += 2;
Mahir Ozturk 1:efe9cad8942f 1096 break;
Mahir Ozturk 1:efe9cad8942f 1097 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1098 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1099 </pre>
Mahir Ozturk 1:efe9cad8942f 1100 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1101 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1102 <pre>switch (foo)
Mahir Ozturk 1:efe9cad8942f 1103 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1104 case 1:
Mahir Ozturk 1:efe9cad8942f 1105 a += 1;
Mahir Ozturk 1:efe9cad8942f 1106 break;
Mahir Ozturk 1:efe9cad8942f 1107
Mahir Ozturk 1:efe9cad8942f 1108 case 2:
Mahir Ozturk 1:efe9cad8942f 1109 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1110 a += 2;
Mahir Ozturk 1:efe9cad8942f 1111 break;
Mahir Ozturk 1:efe9cad8942f 1112 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1113 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1114 </pre>
Mahir Ozturk 1:efe9cad8942f 1115 </div>
Mahir Ozturk 1:efe9cad8942f 1116 <p>
Mahir Ozturk 1:efe9cad8942f 1117 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1118 <p id="_indent-cases">
Mahir Ozturk 1:efe9cad8942f 1119 <code class="title">--indent-cases / -K</code><br />
Mahir Ozturk 1:efe9cad8942f 1120 Indent '<code>case X:</code>' blocks from the '<code>case X:</code>' headers. Case statements not enclosed in
Mahir Ozturk 1:efe9cad8942f 1121 blocks are NOT indented.</p>
Mahir Ozturk 1:efe9cad8942f 1122 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1123 <pre>switch (foo)
Mahir Ozturk 1:efe9cad8942f 1124 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1125 case 1:
Mahir Ozturk 1:efe9cad8942f 1126 a += 1;
Mahir Ozturk 1:efe9cad8942f 1127 break;
Mahir Ozturk 1:efe9cad8942f 1128
Mahir Ozturk 1:efe9cad8942f 1129 case 2:
Mahir Ozturk 1:efe9cad8942f 1130 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1131 a += 2;
Mahir Ozturk 1:efe9cad8942f 1132 break;
Mahir Ozturk 1:efe9cad8942f 1133 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1134 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1135 </pre>
Mahir Ozturk 1:efe9cad8942f 1136 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1137 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1138 <pre>switch (foo)
Mahir Ozturk 1:efe9cad8942f 1139 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1140 case 1:
Mahir Ozturk 1:efe9cad8942f 1141 a += 1;
Mahir Ozturk 1:efe9cad8942f 1142 break;
Mahir Ozturk 1:efe9cad8942f 1143
Mahir Ozturk 1:efe9cad8942f 1144 case 2:
Mahir Ozturk 1:efe9cad8942f 1145 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1146 a += 2;
Mahir Ozturk 1:efe9cad8942f 1147 break;
Mahir Ozturk 1:efe9cad8942f 1148 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1149 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1150 </pre>
Mahir Ozturk 1:efe9cad8942f 1151 </div>
Mahir Ozturk 1:efe9cad8942f 1152 <p>
Mahir Ozturk 1:efe9cad8942f 1153 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1154 <p id="_indent-namespaces">
Mahir Ozturk 1:efe9cad8942f 1155 <code class="title">--indent-namespaces / -N</code><br />
Mahir Ozturk 1:efe9cad8942f 1156 Add extra indentation to namespace blocks. This option has no effect on Java files. It
Mahir Ozturk 1:efe9cad8942f 1157 will also indent CORBA IDL module statements.</p>
Mahir Ozturk 1:efe9cad8942f 1158 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1159 <pre>namespace foospace
Mahir Ozturk 1:efe9cad8942f 1160 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1161 class Foo
Mahir Ozturk 1:efe9cad8942f 1162 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1163 public:
Mahir Ozturk 1:efe9cad8942f 1164 Foo();
Mahir Ozturk 1:efe9cad8942f 1165 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1166 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1167 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1168 </pre>
Mahir Ozturk 1:efe9cad8942f 1169 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1170 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1171 <pre>namespace foospace
Mahir Ozturk 1:efe9cad8942f 1172 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1173 class Foo
Mahir Ozturk 1:efe9cad8942f 1174 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1175 public:
Mahir Ozturk 1:efe9cad8942f 1176 Foo();
Mahir Ozturk 1:efe9cad8942f 1177 virtual ~Foo();
Mahir Ozturk 1:efe9cad8942f 1178 <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1179 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1180 </pre>
Mahir Ozturk 1:efe9cad8942f 1181 </div>
Mahir Ozturk 1:efe9cad8942f 1182 <p>
Mahir Ozturk 1:efe9cad8942f 1183 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1184 <p id="_indent-after-parens">
Mahir Ozturk 1:efe9cad8942f 1185 <code class="title">--indent-after-parens / -xU</code><br />
Mahir Ozturk 1:efe9cad8942f 1186 Indent, instead of align, continuation lines following lines that contain an opening paren '(' or an assignment
Mahir Ozturk 1:efe9cad8942f 1187 '='. This includes function definitions and declarations and return statements. The indentation can be modified
Mahir Ozturk 1:efe9cad8942f 1188 by using the following indent-continuation option. This option may be preferred for editors displaying proportional
Mahir Ozturk 1:efe9cad8942f 1189 fonts.</p>
Mahir Ozturk 1:efe9cad8942f 1190 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1191 <pre>void Foo(bool bar1,
Mahir Ozturk 1:efe9cad8942f 1192 bool bar2)
Mahir Ozturk 1:efe9cad8942f 1193 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1194 isLongFunction(bar1,
Mahir Ozturk 1:efe9cad8942f 1195 bar2);
Mahir Ozturk 1:efe9cad8942f 1196
Mahir Ozturk 1:efe9cad8942f 1197 isLongVariable = foo1
Mahir Ozturk 1:efe9cad8942f 1198 || foo2;
Mahir Ozturk 1:efe9cad8942f 1199 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1200 </pre>
Mahir Ozturk 1:efe9cad8942f 1201 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1202 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1203 <pre>void Foo(bool bar1,
Mahir Ozturk 1:efe9cad8942f 1204 bool bar2)
Mahir Ozturk 1:efe9cad8942f 1205 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1206 isLongFunction(bar1,
Mahir Ozturk 1:efe9cad8942f 1207 bar2);
Mahir Ozturk 1:efe9cad8942f 1208
Mahir Ozturk 1:efe9cad8942f 1209 isLongVariable = foo1
Mahir Ozturk 1:efe9cad8942f 1210 || foo2;
Mahir Ozturk 1:efe9cad8942f 1211 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1212 </pre>
Mahir Ozturk 1:efe9cad8942f 1213 </div>
Mahir Ozturk 1:efe9cad8942f 1214 <p>
Mahir Ozturk 1:efe9cad8942f 1215 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1216 <p id="_indent-continuation">
Mahir Ozturk 1:efe9cad8942f 1217 <code class="title">--indent-continuation=<span class="option">#</span> / -xt<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 1218 Set the continuation indent for a line that ends with an opening paren '(' or an assignment '='. This includes
Mahir Ozturk 1:efe9cad8942f 1219 function definitions and declarations. It will also modify the previous indent-after-paren option. The value for
Mahir Ozturk 1:efe9cad8942f 1220 <span class="option">#</span> indicates a <strong>number of indents</strong>. The valid values are the integer
Mahir Ozturk 1:efe9cad8942f 1221 values from <strong>0 thru 4</strong>. If this option is not used, the default value of <strong>1</strong> is
Mahir Ozturk 1:efe9cad8942f 1222 used. </p>
Mahir Ozturk 1:efe9cad8942f 1223 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1224 <pre>isLongVariable =
Mahir Ozturk 1:efe9cad8942f 1225 foo1 ||
Mahir Ozturk 1:efe9cad8942f 1226 foo2;
Mahir Ozturk 1:efe9cad8942f 1227
Mahir Ozturk 1:efe9cad8942f 1228 isLongFunction(
Mahir Ozturk 1:efe9cad8942f 1229 bar1,
Mahir Ozturk 1:efe9cad8942f 1230 bar2);
Mahir Ozturk 1:efe9cad8942f 1231 </pre>
Mahir Ozturk 1:efe9cad8942f 1232 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1233 becomes (with indent-continuation=3):</p>
Mahir Ozturk 1:efe9cad8942f 1234 <pre>isLongVariable =
Mahir Ozturk 1:efe9cad8942f 1235 foo1 ||
Mahir Ozturk 1:efe9cad8942f 1236 foo2;
Mahir Ozturk 1:efe9cad8942f 1237
Mahir Ozturk 1:efe9cad8942f 1238 isLongFunction(
Mahir Ozturk 1:efe9cad8942f 1239 bar1,
Mahir Ozturk 1:efe9cad8942f 1240 bar2);
Mahir Ozturk 1:efe9cad8942f 1241 </pre>
Mahir Ozturk 1:efe9cad8942f 1242 </div>
Mahir Ozturk 1:efe9cad8942f 1243 <p>
Mahir Ozturk 1:efe9cad8942f 1244 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1245 <p id="_indent-labels">
Mahir Ozturk 1:efe9cad8942f 1246 <code class="title">--indent-labels / -L</code><br />
Mahir Ozturk 1:efe9cad8942f 1247 Add extra indentation to labels so they appear 1 indent less than the current indentation, rather than being flushed
Mahir Ozturk 1:efe9cad8942f 1248 to the left (the default).</p>
Mahir Ozturk 1:efe9cad8942f 1249 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1250 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1251 while (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1252 if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1253 goto error;
Mahir Ozturk 1:efe9cad8942f 1254 ...
Mahir Ozturk 1:efe9cad8942f 1255 error:
Mahir Ozturk 1:efe9cad8942f 1256 ...
Mahir Ozturk 1:efe9cad8942f 1257 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1258 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1259 </pre>
Mahir Ozturk 1:efe9cad8942f 1260 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1261 becomes (with indented 'error:'):</p>
Mahir Ozturk 1:efe9cad8942f 1262 <pre>void Foo() <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1263 while (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1264 if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1265 goto error;
Mahir Ozturk 1:efe9cad8942f 1266 ...
Mahir Ozturk 1:efe9cad8942f 1267 error:
Mahir Ozturk 1:efe9cad8942f 1268 ...
Mahir Ozturk 1:efe9cad8942f 1269 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1270 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1271 </pre>
Mahir Ozturk 1:efe9cad8942f 1272 </div>
Mahir Ozturk 1:efe9cad8942f 1273 <p>
Mahir Ozturk 1:efe9cad8942f 1274 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1275
Mahir Ozturk 1:efe9cad8942f 1276 <p id="_indent-preproc-block">
Mahir Ozturk 1:efe9cad8942f 1277 <code class="title">--indent-preproc-block / -xW</code><br />
Mahir Ozturk 1:efe9cad8942f 1278 Indent preprocessor blocks at brace level zero and immediately within a namespace. There are restrictions on
Mahir Ozturk 1:efe9cad8942f 1279 what will be indented. Blocks within methods, classes, arrays, etc., will not be indented. Blocks containing braces
Mahir Ozturk 1:efe9cad8942f 1280 or multi-line define statements will not be indented. Without this option the preprocessor block is not
Mahir Ozturk 1:efe9cad8942f 1281 indented.</p>
Mahir Ozturk 1:efe9cad8942f 1282 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1283 <pre>#ifdef _WIN32
Mahir Ozturk 1:efe9cad8942f 1284 #include &lt;windows.h&gt;
Mahir Ozturk 1:efe9cad8942f 1285 #ifndef NO_EXPORT
Mahir Ozturk 1:efe9cad8942f 1286 #define EXPORT
Mahir Ozturk 1:efe9cad8942f 1287 #endif
Mahir Ozturk 1:efe9cad8942f 1288 #endif
Mahir Ozturk 1:efe9cad8942f 1289 </pre>
Mahir Ozturk 1:efe9cad8942f 1290 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1291 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1292 <pre>#ifdef _WIN32
Mahir Ozturk 1:efe9cad8942f 1293 #include &lt;windows.h&gt;
Mahir Ozturk 1:efe9cad8942f 1294 #ifndef NO_EXPORT
Mahir Ozturk 1:efe9cad8942f 1295 #define EXPORT
Mahir Ozturk 1:efe9cad8942f 1296 #endif
Mahir Ozturk 1:efe9cad8942f 1297 #endif
Mahir Ozturk 1:efe9cad8942f 1298 </pre>
Mahir Ozturk 1:efe9cad8942f 1299 </div>
Mahir Ozturk 1:efe9cad8942f 1300 <p>
Mahir Ozturk 1:efe9cad8942f 1301 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1302 <p id="_indent-preproc-define">
Mahir Ozturk 1:efe9cad8942f 1303 <code class="title">--indent-preproc-define / -w</code><br />
Mahir Ozturk 1:efe9cad8942f 1304 Indent multi-line preprocessor definitions ending with a backslash. Should be used with --convert-tabs for proper
Mahir Ozturk 1:efe9cad8942f 1305 results. Does a pretty good job, but cannot perform miracles in obfuscated preprocessor definitions. Without this
Mahir Ozturk 1:efe9cad8942f 1306 option the preprocessor statements remain unchanged.</p>
Mahir Ozturk 1:efe9cad8942f 1307 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1308 <pre>#define Is_Bar(arg,a,b) \
Mahir Ozturk 1:efe9cad8942f 1309 (Is_Foo((arg), (a)) \
Mahir Ozturk 1:efe9cad8942f 1310 || Is_Foo((arg), (b)))
Mahir Ozturk 1:efe9cad8942f 1311 </pre>
Mahir Ozturk 1:efe9cad8942f 1312 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1313 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1314 <pre>#define Is_Bar(arg,a,b) \
Mahir Ozturk 1:efe9cad8942f 1315 (Is_Foo((arg), (a)) \
Mahir Ozturk 1:efe9cad8942f 1316 || Is_Foo((arg), (b)))
Mahir Ozturk 1:efe9cad8942f 1317 </pre>
Mahir Ozturk 1:efe9cad8942f 1318 </div>
Mahir Ozturk 1:efe9cad8942f 1319 <p>
Mahir Ozturk 1:efe9cad8942f 1320 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1321 <p id="_indent-preproc-cond">
Mahir Ozturk 1:efe9cad8942f 1322 <code class="title">--indent-preproc-cond / -xw</code><br />
Mahir Ozturk 1:efe9cad8942f 1323 Indent preprocessor conditional statements to the same level as the source code.</p>
Mahir Ozturk 1:efe9cad8942f 1324 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1325 <pre> isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1326 #ifdef UNICODE
Mahir Ozturk 1:efe9cad8942f 1327 text = wideBuff;
Mahir Ozturk 1:efe9cad8942f 1328 #else
Mahir Ozturk 1:efe9cad8942f 1329 text = buff;
Mahir Ozturk 1:efe9cad8942f 1330 #endif</pre>
Mahir Ozturk 1:efe9cad8942f 1331 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1332 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1333 <pre> isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1334 #ifdef UNICODE
Mahir Ozturk 1:efe9cad8942f 1335 text = wideBuff;
Mahir Ozturk 1:efe9cad8942f 1336 #else
Mahir Ozturk 1:efe9cad8942f 1337 text = buff;
Mahir Ozturk 1:efe9cad8942f 1338 #endif
Mahir Ozturk 1:efe9cad8942f 1339 </pre>
Mahir Ozturk 1:efe9cad8942f 1340 </div>
Mahir Ozturk 1:efe9cad8942f 1341 <p>
Mahir Ozturk 1:efe9cad8942f 1342 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1343 <p id="_indent-col1-comments">
Mahir Ozturk 1:efe9cad8942f 1344 <code class="title">--indent-col1-comments / -Y</code><br />
Mahir Ozturk 1:efe9cad8942f 1345 Indent C++ comments beginning in column one. By default C++ comments beginning in column one are
Mahir Ozturk 1:efe9cad8942f 1346 assumed to be commented&#8209;out code and not indented. This option will allow the comments to be indented with
Mahir Ozturk 1:efe9cad8942f 1347 the code.</p>
Mahir Ozturk 1:efe9cad8942f 1348 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1349 <pre>void Foo()\n"
Mahir Ozturk 1:efe9cad8942f 1350 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1351 <span class="comment">// comment</span>
Mahir Ozturk 1:efe9cad8942f 1352 if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1353 bar();
Mahir Ozturk 1:efe9cad8942f 1354 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1355 </pre>
Mahir Ozturk 1:efe9cad8942f 1356 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1357 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1358 <pre>void Foo()\n"
Mahir Ozturk 1:efe9cad8942f 1359 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1360 <span class="comment">// comment</span>
Mahir Ozturk 1:efe9cad8942f 1361 if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1362 bar();
Mahir Ozturk 1:efe9cad8942f 1363 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1364 </pre>
Mahir Ozturk 1:efe9cad8942f 1365 </div>
Mahir Ozturk 1:efe9cad8942f 1366 <p>
Mahir Ozturk 1:efe9cad8942f 1367 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1368 <p id="_min-conditional-indent">
Mahir Ozturk 1:efe9cad8942f 1369 <code class="title">--min-conditional-indent=<span class="option">#</span> / -m<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 1370 Set the minimal indent that is added when a header is built of multiple lines. This indent helps to easily separate
Mahir Ozturk 1:efe9cad8942f 1371 the header from the command statements that follow. The value for <span class="option">#</span>
Mahir Ozturk 1:efe9cad8942f 1372 indicates a <strong>number of indents</strong> and is a minimum value. The indent may be greater to align with
Mahir Ozturk 1:efe9cad8942f 1373 the data on the previous line.<br />
Mahir Ozturk 1:efe9cad8942f 1374 The valid values are:<br />
Mahir Ozturk 1:efe9cad8942f 1375 0 - no minimal indent. The lines will be aligned with the paren on the preceding line.<br />
Mahir Ozturk 1:efe9cad8942f 1376 1 - indent at least one additional indent.<br />
Mahir Ozturk 1:efe9cad8942f 1377 2 - indent at least two additional indents.<br />
Mahir Ozturk 1:efe9cad8942f 1378 3 - indent at least one-half an additional indent. This is intended for large indents (e.g. 8).<br />
Mahir Ozturk 1:efe9cad8942f 1379 The default value is <strong>2</strong>, two additional indents.</p>
Mahir Ozturk 1:efe9cad8942f 1380 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1381 <pre><span class="comment">// default setting makes this non-braced code clear</span>
Mahir Ozturk 1:efe9cad8942f 1382 if (a &lt; b
Mahir Ozturk 1:efe9cad8942f 1383 || c &gt; d)
Mahir Ozturk 1:efe9cad8942f 1384 foo++;
Mahir Ozturk 1:efe9cad8942f 1385
Mahir Ozturk 1:efe9cad8942f 1386 <span class="comment">// but creates an exaggerated indent in this braced code</span>
Mahir Ozturk 1:efe9cad8942f 1387 if (a &lt; b
Mahir Ozturk 1:efe9cad8942f 1388 || c &gt; d)
Mahir Ozturk 1:efe9cad8942f 1389 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1390 foo++;
Mahir Ozturk 1:efe9cad8942f 1391 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1392 </pre>
Mahir Ozturk 1:efe9cad8942f 1393 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1394 becomes (when setting
Mahir Ozturk 1:efe9cad8942f 1395 <strong><code>--min-conditional-indent=<span class="option">0</span></code></strong>):</p>
Mahir Ozturk 1:efe9cad8942f 1396 <pre><span class="comment">// setting makes this non-braced code less clear</span>
Mahir Ozturk 1:efe9cad8942f 1397 if (a &lt; b
Mahir Ozturk 1:efe9cad8942f 1398 || c &gt; d)
Mahir Ozturk 1:efe9cad8942f 1399 foo++;
Mahir Ozturk 1:efe9cad8942f 1400
Mahir Ozturk 1:efe9cad8942f 1401 <span class="comment">// but makes this braced code clearer</span>
Mahir Ozturk 1:efe9cad8942f 1402 if (a &lt; b
Mahir Ozturk 1:efe9cad8942f 1403 || c &gt; d)
Mahir Ozturk 1:efe9cad8942f 1404 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1405 foo++;
Mahir Ozturk 1:efe9cad8942f 1406 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1407 </pre>
Mahir Ozturk 1:efe9cad8942f 1408 </div>
Mahir Ozturk 1:efe9cad8942f 1409 <p>
Mahir Ozturk 1:efe9cad8942f 1410 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1411 <p id="_max-continuation-indent">
Mahir Ozturk 1:efe9cad8942f 1412 <code class="title">--max-continuation-indent=<span class="option">#</span> / -M<span class="option">#</span></code><br />
Mahir Ozturk 1:efe9cad8942f 1413 <code class="title">--max-instatement-indent=<span class="option">#</span> is depreciated</code><br />
Mahir Ozturk 1:efe9cad8942f 1414 Set the &nbsp;maximum of <span class="option">#</span> spaces to indent a continuation line. The
Mahir Ozturk 1:efe9cad8942f 1415 <span class="option">#</span> indicates a number of columns and must not be less than <strong>40</strong> or
Mahir Ozturk 1:efe9cad8942f 1416 greater than <strong>120</strong>. If no value is set, the default value of <strong>40</strong> will be
Mahir Ozturk 1:efe9cad8942f 1417 used. This option will prevent continuation lines from extending too far to the right. Setting a larger value
Mahir Ozturk 1:efe9cad8942f 1418 will allow the code to be extended further to the right.</p>
Mahir Ozturk 1:efe9cad8942f 1419 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1420 <pre>fooArray[] = <span class="brace">{</span> red,
Mahir Ozturk 1:efe9cad8942f 1421 green,
Mahir Ozturk 1:efe9cad8942f 1422 blue <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1423
Mahir Ozturk 1:efe9cad8942f 1424 fooFunction(barArg1,
Mahir Ozturk 1:efe9cad8942f 1425 barArg2,
Mahir Ozturk 1:efe9cad8942f 1426 barArg3);
Mahir Ozturk 1:efe9cad8942f 1427 </pre>
Mahir Ozturk 1:efe9cad8942f 1428 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1429 becomes (with larger value):</p>
Mahir Ozturk 1:efe9cad8942f 1430 <pre>fooArray[] = <span class="brace">{</span> red,
Mahir Ozturk 1:efe9cad8942f 1431 green,
Mahir Ozturk 1:efe9cad8942f 1432 blue <span class="brace">}</span>;
Mahir Ozturk 1:efe9cad8942f 1433
Mahir Ozturk 1:efe9cad8942f 1434 fooFunction(barArg1,
Mahir Ozturk 1:efe9cad8942f 1435 barArg2,
Mahir Ozturk 1:efe9cad8942f 1436 barArg3);
Mahir Ozturk 1:efe9cad8942f 1437 </pre>
Mahir Ozturk 1:efe9cad8942f 1438 </div>
Mahir Ozturk 1:efe9cad8942f 1439 <p>
Mahir Ozturk 1:efe9cad8942f 1440 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1441 <hr />
Mahir Ozturk 1:efe9cad8942f 1442
Mahir Ozturk 1:efe9cad8942f 1443 <!-- * * * * * * * * * * * * * Padding Options * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 1444
Mahir Ozturk 1:efe9cad8942f 1445 <h3 id="_Padding_Options">Padding Options</h3>
Mahir Ozturk 1:efe9cad8942f 1446
Mahir Ozturk 1:efe9cad8942f 1447 <p id="_break-blocks">
Mahir Ozturk 1:efe9cad8942f 1448 <code class="title">--break-blocks / -f</code><br />
Mahir Ozturk 1:efe9cad8942f 1449 Pad empty lines around header blocks (e.g. 'if', 'for', 'while'...).</p>
Mahir Ozturk 1:efe9cad8942f 1450 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1451 <pre>isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1452 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1453 bar();
Mahir Ozturk 1:efe9cad8942f 1454 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1455 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1456 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1457 isBar = false;
Mahir Ozturk 1:efe9cad8942f 1458 </pre>
Mahir Ozturk 1:efe9cad8942f 1459 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1460 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1461 <pre>isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1462
Mahir Ozturk 1:efe9cad8942f 1463 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1464 bar();
Mahir Ozturk 1:efe9cad8942f 1465 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1466 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1467 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1468
Mahir Ozturk 1:efe9cad8942f 1469 isBar = false;
Mahir Ozturk 1:efe9cad8942f 1470 </pre>
Mahir Ozturk 1:efe9cad8942f 1471 </div>
Mahir Ozturk 1:efe9cad8942f 1472 <p>
Mahir Ozturk 1:efe9cad8942f 1473 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1474 <p id="_break-blocks=all">
Mahir Ozturk 1:efe9cad8942f 1475 <code class="title">--break-blocks=all / -F</code><br />
Mahir Ozturk 1:efe9cad8942f 1476 Pad empty lines around header blocks (e.g. 'if', 'for', 'while'...). Treat
Mahir Ozturk 1:efe9cad8942f 1477 closing header blocks (e.g. 'else', 'catch') as stand-alone blocks.</p>
Mahir Ozturk 1:efe9cad8942f 1478 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1479 <pre>isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1480 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1481 bar();
Mahir Ozturk 1:efe9cad8942f 1482 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1483 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1484 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1485 isBar = false;
Mahir Ozturk 1:efe9cad8942f 1486 </pre>
Mahir Ozturk 1:efe9cad8942f 1487 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1488 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1489 <pre>isFoo = true;
Mahir Ozturk 1:efe9cad8942f 1490
Mahir Ozturk 1:efe9cad8942f 1491 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1492 bar();
Mahir Ozturk 1:efe9cad8942f 1493
Mahir Ozturk 1:efe9cad8942f 1494 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1495 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1496 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1497
Mahir Ozturk 1:efe9cad8942f 1498 isBar = false;
Mahir Ozturk 1:efe9cad8942f 1499 </pre>
Mahir Ozturk 1:efe9cad8942f 1500 </div>
Mahir Ozturk 1:efe9cad8942f 1501 <p>
Mahir Ozturk 1:efe9cad8942f 1502 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1503 <p id="_pad-oper">
Mahir Ozturk 1:efe9cad8942f 1504 <code class="title">--pad-oper / -p </code><br />
Mahir Ozturk 1:efe9cad8942f 1505 Insert space padding around operators. This will also pad commas. Any end of line comments will remain in the
Mahir Ozturk 1:efe9cad8942f 1506 original column, if possible. Note that there is no option to unpad. Once padded, they stay padded.</p>
Mahir Ozturk 1:efe9cad8942f 1507 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1508 <pre>if (foo==2)
Mahir Ozturk 1:efe9cad8942f 1509 a=bar((b-c)*a,d--);
Mahir Ozturk 1:efe9cad8942f 1510 </pre>
Mahir Ozturk 1:efe9cad8942f 1511 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1512 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1513 <pre>if (foo == 2)
Mahir Ozturk 1:efe9cad8942f 1514 a = bar((b - c) * a, d--);
Mahir Ozturk 1:efe9cad8942f 1515 </pre>
Mahir Ozturk 1:efe9cad8942f 1516 </div>
Mahir Ozturk 1:efe9cad8942f 1517 <p>
Mahir Ozturk 1:efe9cad8942f 1518 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1519 <p id="_pad-comma">
Mahir Ozturk 1:efe9cad8942f 1520 <code class="title">--pad-comma / -xg </code><br />
Mahir Ozturk 1:efe9cad8942f 1521 Insert space padding after commas. This is not needed if pad-oper is used. Any end of line comments will
Mahir Ozturk 1:efe9cad8942f 1522 remain in the original column, if possible. Note that there is no option to unpad. Once padded, they
Mahir Ozturk 1:efe9cad8942f 1523 stay padded.</p>
Mahir Ozturk 1:efe9cad8942f 1524 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1525 <pre>if (isFoo(a,b)
Mahir Ozturk 1:efe9cad8942f 1526 bar(a,b);
Mahir Ozturk 1:efe9cad8942f 1527 </pre>
Mahir Ozturk 1:efe9cad8942f 1528 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1529 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1530 <pre>if (isFoo(a, b)
Mahir Ozturk 1:efe9cad8942f 1531 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1532 </pre>
Mahir Ozturk 1:efe9cad8942f 1533 </div>
Mahir Ozturk 1:efe9cad8942f 1534 <p>
Mahir Ozturk 1:efe9cad8942f 1535 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1536 <p id="_pad-paren">
Mahir Ozturk 1:efe9cad8942f 1537 <code class="title">--pad-paren / -P </code>
Mahir Ozturk 1:efe9cad8942f 1538 <br />
Mahir Ozturk 1:efe9cad8942f 1539 Insert space padding around parens on both the <strong>outside</strong> and the <strong>inside</strong>.
Mahir Ozturk 1:efe9cad8942f 1540 Any end of line comments will remain in the original column, if possible.</p>
Mahir Ozturk 1:efe9cad8942f 1541 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1542 <pre>if (isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1543 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1544 </pre>
Mahir Ozturk 1:efe9cad8942f 1545 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1546 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1547 <pre>if ( isFoo ( ( a+2 ), b ) )
Mahir Ozturk 1:efe9cad8942f 1548 bar ( a, b );
Mahir Ozturk 1:efe9cad8942f 1549 </pre>
Mahir Ozturk 1:efe9cad8942f 1550 </div>
Mahir Ozturk 1:efe9cad8942f 1551 <p>
Mahir Ozturk 1:efe9cad8942f 1552 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1553 <p id="_pad-paren-out">
Mahir Ozturk 1:efe9cad8942f 1554 <code class="title">--pad-paren-out / -d </code>
Mahir Ozturk 1:efe9cad8942f 1555 <br />
Mahir Ozturk 1:efe9cad8942f 1556 Insert space padding around parens on the <strong>outside</strong> only. Parens that are empty will
Mahir Ozturk 1:efe9cad8942f 1557 not be padded. Any end of line comments will remain in the original column, if possible. This can be used with
Mahir Ozturk 1:efe9cad8942f 1558 unpad-paren below to remove unwanted spaces.</p>
Mahir Ozturk 1:efe9cad8942f 1559 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1560 <pre>if (isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1561 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1562 </pre>
Mahir Ozturk 1:efe9cad8942f 1563 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1564 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1565 <pre>if (isFoo ( (a+2), b) )
Mahir Ozturk 1:efe9cad8942f 1566 bar (a, b);
Mahir Ozturk 1:efe9cad8942f 1567 </pre>
Mahir Ozturk 1:efe9cad8942f 1568 </div>
Mahir Ozturk 1:efe9cad8942f 1569 <p>
Mahir Ozturk 1:efe9cad8942f 1570 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1571 <p id="_pad-first-paren-out">
Mahir Ozturk 1:efe9cad8942f 1572 <code class="title">--pad-first-paren-out / -xd </code>
Mahir Ozturk 1:efe9cad8942f 1573 <br />
Mahir Ozturk 1:efe9cad8942f 1574 Insert space padding around the <strong>first</strong> paren in a series on the <strong>outside</strong>
Mahir Ozturk 1:efe9cad8942f 1575 only. Parens that are empty will not be padded. Any end of line comments will remain in the original column,
Mahir Ozturk 1:efe9cad8942f 1576 if possible. This can be used with unpad-paren below to remove unwanted spaces. If used with pad&#8209;paren or
Mahir Ozturk 1:efe9cad8942f 1577 pad&#8209;paren&#8209;out, this option will be ignored. If used with pad&#8209;paren&#8209;in, the result will
Mahir Ozturk 1:efe9cad8942f 1578 be the same as pad&#8209;paren.</p>
Mahir Ozturk 1:efe9cad8942f 1579 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1580 <pre>if (isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1581 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1582 </pre>
Mahir Ozturk 1:efe9cad8942f 1583 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1584 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1585 <pre>if (isFoo ((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1586 bar (a, b);
Mahir Ozturk 1:efe9cad8942f 1587 </pre>
Mahir Ozturk 1:efe9cad8942f 1588 </div>
Mahir Ozturk 1:efe9cad8942f 1589 <p>
Mahir Ozturk 1:efe9cad8942f 1590 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1591 <p id="_pad-paren-in">
Mahir Ozturk 1:efe9cad8942f 1592 <code class="title">--pad-paren-in / -D </code>
Mahir Ozturk 1:efe9cad8942f 1593 <br />
Mahir Ozturk 1:efe9cad8942f 1594 Insert space padding around paren on the <strong>inside</strong> only. Any end of line comments will remain
Mahir Ozturk 1:efe9cad8942f 1595 in the original column, if possible. This can be used with unpad-paren below to remove unwanted spaces.</p>
Mahir Ozturk 1:efe9cad8942f 1596 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1597 <pre>if (isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1598 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1599 </pre>
Mahir Ozturk 1:efe9cad8942f 1600 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1601 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1602 <pre>if ( isFoo( ( a+2 ), b ) )
Mahir Ozturk 1:efe9cad8942f 1603 bar( a, b );
Mahir Ozturk 1:efe9cad8942f 1604 </pre>
Mahir Ozturk 1:efe9cad8942f 1605 </div>
Mahir Ozturk 1:efe9cad8942f 1606 <p>
Mahir Ozturk 1:efe9cad8942f 1607 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1608 <p id="_pad-header">
Mahir Ozturk 1:efe9cad8942f 1609 <code class="title">--pad-header / -H </code>
Mahir Ozturk 1:efe9cad8942f 1610 <br />
Mahir Ozturk 1:efe9cad8942f 1611 Insert space padding between a header (e.g. 'if', 'for', 'while'...)
Mahir Ozturk 1:efe9cad8942f 1612 and the following paren. Any end of line comments will remain in the original column, if possible. This can
Mahir Ozturk 1:efe9cad8942f 1613 be used with unpad-paren to remove unwanted spaces.</p>
Mahir Ozturk 1:efe9cad8942f 1614 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1615 <pre>if(isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1616 bar(a, b);</pre>
Mahir Ozturk 1:efe9cad8942f 1617 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1618 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1619 <pre>if (isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1620 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1621 </pre>
Mahir Ozturk 1:efe9cad8942f 1622 </div>
Mahir Ozturk 1:efe9cad8942f 1623 <p>
Mahir Ozturk 1:efe9cad8942f 1624 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1625 <p id="_unpad-paren">
Mahir Ozturk 1:efe9cad8942f 1626 <code class="title">--unpad-paren / -U </code>
Mahir Ozturk 1:efe9cad8942f 1627 <br />
Mahir Ozturk 1:efe9cad8942f 1628 Remove extra space padding around parens on the inside and outside. Any end of line comments will remain
Mahir Ozturk 1:efe9cad8942f 1629 in the original column, if possible. This option can be used in combination with the paren padding options
Mahir Ozturk 1:efe9cad8942f 1630 pad&#8209;paren, pad&#8209;paren&#8209;out, pad&#8209;paren&#8209;in,
Mahir Ozturk 1:efe9cad8942f 1631 and pad&#8209;header above. Only padding that has not been requested by other options will be
Mahir Ozturk 1:efe9cad8942f 1632 removed.</p>
Mahir Ozturk 1:efe9cad8942f 1633 <p>
Mahir Ozturk 1:efe9cad8942f 1634 For example, if a source has parens padded on both the inside and outside, and you want inside only. You need
Mahir Ozturk 1:efe9cad8942f 1635 to use unpad-paren to remove the outside padding, and pad&#8209;paren&#8209;in to
Mahir Ozturk 1:efe9cad8942f 1636 retain the inside padding. Using only pad&#8209;paren&#8209;in> would not remove the outside
Mahir Ozturk 1:efe9cad8942f 1637 padding.</p>
Mahir Ozturk 1:efe9cad8942f 1638 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1639 <pre>if ( isFoo( ( a+2 ), b ) )
Mahir Ozturk 1:efe9cad8942f 1640 bar ( a, b );
Mahir Ozturk 1:efe9cad8942f 1641 </pre>
Mahir Ozturk 1:efe9cad8942f 1642 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1643 becomes (with no padding option requested):</p>
Mahir Ozturk 1:efe9cad8942f 1644 <pre>if(isFoo((a+2), b))
Mahir Ozturk 1:efe9cad8942f 1645 bar(a, b);
Mahir Ozturk 1:efe9cad8942f 1646 </pre>
Mahir Ozturk 1:efe9cad8942f 1647 </div>
Mahir Ozturk 1:efe9cad8942f 1648 <p>
Mahir Ozturk 1:efe9cad8942f 1649 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1650 <p id="_delete-empty-lines">
Mahir Ozturk 1:efe9cad8942f 1651 <code class="title">--delete-empty-lines / -xe</code><br />
Mahir Ozturk 1:efe9cad8942f 1652 Delete empty lines within a function or method. Empty lines outside of functions or methods are NOT deleted. If
Mahir Ozturk 1:efe9cad8942f 1653 used with break-blocks or break-blocks=all it will delete all lines EXCEPT the lines added by the break-blocks
Mahir Ozturk 1:efe9cad8942f 1654 options.</p>
Mahir Ozturk 1:efe9cad8942f 1655 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1656 <pre>void Foo()
Mahir Ozturk 1:efe9cad8942f 1657 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1658
Mahir Ozturk 1:efe9cad8942f 1659 foo1 = 1;
Mahir Ozturk 1:efe9cad8942f 1660
Mahir Ozturk 1:efe9cad8942f 1661 foo2 = 2;
Mahir Ozturk 1:efe9cad8942f 1662
Mahir Ozturk 1:efe9cad8942f 1663 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1664 </pre>
Mahir Ozturk 1:efe9cad8942f 1665 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1666 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1667 <pre>void Foo()
Mahir Ozturk 1:efe9cad8942f 1668 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1669 foo1 = 1;
Mahir Ozturk 1:efe9cad8942f 1670 foo2 = 2;
Mahir Ozturk 1:efe9cad8942f 1671 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1672 </pre>
Mahir Ozturk 1:efe9cad8942f 1673 </div>
Mahir Ozturk 1:efe9cad8942f 1674 <p>
Mahir Ozturk 1:efe9cad8942f 1675 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1676 <p id="_fill-empty-lines">
Mahir Ozturk 1:efe9cad8942f 1677 <code class="title">--fill-empty-lines / -E</code><br />
Mahir Ozturk 1:efe9cad8942f 1678 Fill empty lines with the white space of the previous line.</p>
Mahir Ozturk 1:efe9cad8942f 1679 <p>
Mahir Ozturk 1:efe9cad8942f 1680 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1681 <p id="_align-pointer">
Mahir Ozturk 1:efe9cad8942f 1682 <code class="title">--align-pointer=type&nbsp;&nbsp; / -k1<br />
Mahir Ozturk 1:efe9cad8942f 1683 --align-pointer=middle / -k2<br />
Mahir Ozturk 1:efe9cad8942f 1684 --align-pointer=name&nbsp;&nbsp; / -k3
Mahir Ozturk 1:efe9cad8942f 1685 </code><br />
Mahir Ozturk 1:efe9cad8942f 1686 Attach a pointer or reference operator (*, &amp;, or ^) to either the variable type (left) or variable name (right),
Mahir Ozturk 1:efe9cad8942f 1687 or place it between the type and name (middle). The spacing between the type and name will be preserved, if possible.
Mahir Ozturk 1:efe9cad8942f 1688 This option is for C/C++, C++/CLI, and C# files. To format references separately, use the following align-reference
Mahir Ozturk 1:efe9cad8942f 1689 option.</p>
Mahir Ozturk 1:efe9cad8942f 1690 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1691 <pre>char* foo1;
Mahir Ozturk 1:efe9cad8942f 1692 char &amp; foo2;
Mahir Ozturk 1:efe9cad8942f 1693 String ^s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1694 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1695 becomes (with align-pointer=type):</p>
Mahir Ozturk 1:efe9cad8942f 1696 <pre>char* foo1;
Mahir Ozturk 1:efe9cad8942f 1697 char&amp; foo2;
Mahir Ozturk 1:efe9cad8942f 1698 String^ s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1699 </div>
Mahir Ozturk 1:efe9cad8942f 1700 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1701 <pre>char* foo1;
Mahir Ozturk 1:efe9cad8942f 1702 char &amp; foo2;
Mahir Ozturk 1:efe9cad8942f 1703 String ^s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1704 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1705 becomes (with align-pointer=middle):</p>
Mahir Ozturk 1:efe9cad8942f 1706 <pre>char * foo1;
Mahir Ozturk 1:efe9cad8942f 1707 char &amp; foo2;
Mahir Ozturk 1:efe9cad8942f 1708 String ^ s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1709 </div>
Mahir Ozturk 1:efe9cad8942f 1710 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1711 <pre>char* foo1;
Mahir Ozturk 1:efe9cad8942f 1712 char &amp; foo2;
Mahir Ozturk 1:efe9cad8942f 1713 String ^s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1714 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1715 becomes (with align-pointer=name):</p>
Mahir Ozturk 1:efe9cad8942f 1716 <pre>char *foo1;
Mahir Ozturk 1:efe9cad8942f 1717 char &amp;foo2;
Mahir Ozturk 1:efe9cad8942f 1718 String ^s1;</pre>
Mahir Ozturk 1:efe9cad8942f 1719 </div>
Mahir Ozturk 1:efe9cad8942f 1720 <p>
Mahir Ozturk 1:efe9cad8942f 1721 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1722 <p id="_align-reference">
Mahir Ozturk 1:efe9cad8942f 1723 <code class="title">--align-reference=none&nbsp;&nbsp; / -W0<br />
Mahir Ozturk 1:efe9cad8942f 1724 --align-reference=type&nbsp;&nbsp; / -W1<br />
Mahir Ozturk 1:efe9cad8942f 1725 --align-reference=middle / -W2<br />
Mahir Ozturk 1:efe9cad8942f 1726 --align-reference=name&nbsp;&nbsp; / -W3
Mahir Ozturk 1:efe9cad8942f 1727 </code><br />
Mahir Ozturk 1:efe9cad8942f 1728 This option will align references separate from pointers. Pointers are not changed by this option. If pointers
Mahir Ozturk 1:efe9cad8942f 1729 and references are to be aligned the same, use the previous align-pointer option. The option align-reference=none
Mahir Ozturk 1:efe9cad8942f 1730 will not change the reference alignment. The other options are the same as for align-pointer. This option is for
Mahir Ozturk 1:efe9cad8942f 1731 C/C++, C++/CLI, and C# files.</p>
Mahir Ozturk 1:efe9cad8942f 1732 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1733 <pre>char &amp;foo1;</pre>
Mahir Ozturk 1:efe9cad8942f 1734 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1735 becomes (with align-reference=type):</p>
Mahir Ozturk 1:efe9cad8942f 1736 <pre>char&amp; foo1;</pre>
Mahir Ozturk 1:efe9cad8942f 1737 </div>
Mahir Ozturk 1:efe9cad8942f 1738 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1739 <pre>char&amp; foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 1740 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1741 becomes (with align-reference=middle):</p>
Mahir Ozturk 1:efe9cad8942f 1742 <pre>char &amp; foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 1743 </div>
Mahir Ozturk 1:efe9cad8942f 1744 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1745 <pre>char& foo3;</pre>
Mahir Ozturk 1:efe9cad8942f 1746 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1747 becomes (with align-reference=name):</p>
Mahir Ozturk 1:efe9cad8942f 1748 <pre>char &amp;foo3;</pre>
Mahir Ozturk 1:efe9cad8942f 1749 </div>
Mahir Ozturk 1:efe9cad8942f 1750 <p>
Mahir Ozturk 1:efe9cad8942f 1751 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1752 <hr />
Mahir Ozturk 1:efe9cad8942f 1753
Mahir Ozturk 1:efe9cad8942f 1754 <!-- * * * * * * * * * * * * * Formatting Options * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 1755
Mahir Ozturk 1:efe9cad8942f 1756 <h3 id="_Formatting_Options">Formatting Options</h3>
Mahir Ozturk 1:efe9cad8942f 1757
Mahir Ozturk 1:efe9cad8942f 1758 <p id="_break-closing-braces">
Mahir Ozturk 1:efe9cad8942f 1759 <code class="title">--break-closing-braces / -y<br />
Mahir Ozturk 1:efe9cad8942f 1760 --break-closing-brackets is depreciated </code>
Mahir Ozturk 1:efe9cad8942f 1761 <br />
Mahir Ozturk 1:efe9cad8942f 1762 When used with --style=java, --style=kr, --style=stroustrup, --style=linux, or --style=1tbs, this breaks closing
Mahir Ozturk 1:efe9cad8942f 1763 headers (e.g. 'else', 'catch', ...) from their immediately preceding closing braces. Closing header braces
Mahir Ozturk 1:efe9cad8942f 1764 are always broken with the other styles.</p>
Mahir Ozturk 1:efe9cad8942f 1765 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1766 <pre>void Foo(bool isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1767 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1768 bar();
Mahir Ozturk 1:efe9cad8942f 1769 <span class="brace">}</span> else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1770 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1771 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1772 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1773 </pre>
Mahir Ozturk 1:efe9cad8942f 1774 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1775 becomes (a broken 'else'):</p>
Mahir Ozturk 1:efe9cad8942f 1776 <pre>void Foo(bool isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1777 if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1778 bar();
Mahir Ozturk 1:efe9cad8942f 1779 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1780 else <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1781 anotherBar();
Mahir Ozturk 1:efe9cad8942f 1782 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1783 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1784 </pre>
Mahir Ozturk 1:efe9cad8942f 1785 </div>
Mahir Ozturk 1:efe9cad8942f 1786 <p>
Mahir Ozturk 1:efe9cad8942f 1787 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1788 <p id="_break-elseifs">
Mahir Ozturk 1:efe9cad8942f 1789 <code class="title">--break-elseifs / -e</code><br />
Mahir Ozturk 1:efe9cad8942f 1790 Break "else if" header combinations into separate lines. This option has no effect if keep-one-line-statements
Mahir Ozturk 1:efe9cad8942f 1791 is used, the "else if" statements will remain as they are.</p>
Mahir Ozturk 1:efe9cad8942f 1792 <p>
Mahir Ozturk 1:efe9cad8942f 1793 If this option is NOT used, "else if" header combinations will be placed on a single line.</p>
Mahir Ozturk 1:efe9cad8942f 1794 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1795 <pre>if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1796 bar();
Mahir Ozturk 1:efe9cad8942f 1797 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1798 else if (isFoo1()) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1799 bar1();
Mahir Ozturk 1:efe9cad8942f 1800 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1801 else if (isFoo2()) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1802 bar2;
Mahir Ozturk 1:efe9cad8942f 1803 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1804 </pre>
Mahir Ozturk 1:efe9cad8942f 1805 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1806 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1807 <pre>if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1808 bar();
Mahir Ozturk 1:efe9cad8942f 1809 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1810 else
Mahir Ozturk 1:efe9cad8942f 1811 if (isFoo1()) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1812 bar1();
Mahir Ozturk 1:efe9cad8942f 1813 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1814 else
Mahir Ozturk 1:efe9cad8942f 1815 if (isFoo2()) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1816 bar2();
Mahir Ozturk 1:efe9cad8942f 1817 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1818 </pre>
Mahir Ozturk 1:efe9cad8942f 1819 </div>
Mahir Ozturk 1:efe9cad8942f 1820 <p>
Mahir Ozturk 1:efe9cad8942f 1821 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1822 <p id="_break-one-line-headers">
Mahir Ozturk 1:efe9cad8942f 1823 <code class="title">--break-one-line-headers / -xb </code>
Mahir Ozturk 1:efe9cad8942f 1824 <br />
Mahir Ozturk 1:efe9cad8942f 1825 </p>
Mahir Ozturk 1:efe9cad8942f 1826 <p>
Mahir Ozturk 1:efe9cad8942f 1827 Break one line headers (e.g. &#39;if&#39;, &#39;while&#39;,&nbsp;&#39;else&#39;,&nbsp;...) from a statement residing
Mahir Ozturk 1:efe9cad8942f 1828 on the same line. If the statement is enclosed in braces, the braces will be formatted according to the requested
Mahir Ozturk 1:efe9cad8942f 1829 brace style. </p>
Mahir Ozturk 1:efe9cad8942f 1830 <p>
Mahir Ozturk 1:efe9cad8942f 1831 A multi-statement line will NOT be broken if keep-one-line-statements is requested. One line blocks
Mahir Ozturk 1:efe9cad8942f 1832 will NOT be broken if keep-one-line-blocks is requested and the header is enclosed in the block. </p>
Mahir Ozturk 1:efe9cad8942f 1833 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1834 <pre>void Foo(bool isFoo)
Mahir Ozturk 1:efe9cad8942f 1835 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1836 if (isFoo1) bar1();
Mahir Ozturk 1:efe9cad8942f 1837
Mahir Ozturk 1:efe9cad8942f 1838 if (isFoo2) <span class="brace">{</span> bar2(); <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1839 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1840 </pre>
Mahir Ozturk 1:efe9cad8942f 1841 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1842 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1843 <pre>void Foo(bool isFoo)
Mahir Ozturk 1:efe9cad8942f 1844 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1845 if (isFoo1)
Mahir Ozturk 1:efe9cad8942f 1846 bar1();
Mahir Ozturk 1:efe9cad8942f 1847
Mahir Ozturk 1:efe9cad8942f 1848 if (isFoo2) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1849 bar2();
Mahir Ozturk 1:efe9cad8942f 1850 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1851 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1852 </pre>
Mahir Ozturk 1:efe9cad8942f 1853 </div>
Mahir Ozturk 1:efe9cad8942f 1854 <p>
Mahir Ozturk 1:efe9cad8942f 1855 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1856 <p id="_add-braces">
Mahir Ozturk 1:efe9cad8942f 1857 <code class="title">--add-braces / -j <br />
Mahir Ozturk 1:efe9cad8942f 1858 --add-brackets is depreciated </code>
Mahir Ozturk 1:efe9cad8942f 1859 <br />
Mahir Ozturk 1:efe9cad8942f 1860 Add braces to unbraced one line conditional statements (e.g. 'if', 'for', 'while'...). The statement must
Mahir Ozturk 1:efe9cad8942f 1861 be on a single line. The braces will be added according to the requested brace style. If no style is requested
Mahir Ozturk 1:efe9cad8942f 1862 the braces will be attached. </p>
Mahir Ozturk 1:efe9cad8942f 1863 <p>
Mahir Ozturk 1:efe9cad8942f 1864 Braces will NOT be added to a multi-statement line if keep-one-line-statements is requested. Braces will
Mahir Ozturk 1:efe9cad8942f 1865 NOT be added to a one line block if keep-one-line-blocks is requested. If --add-one-line-braces is also
Mahir Ozturk 1:efe9cad8942f 1866 used, the result will be one line braces.</p>
Mahir Ozturk 1:efe9cad8942f 1867 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1868 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1869 isFoo = false;
Mahir Ozturk 1:efe9cad8942f 1870 </pre>
Mahir Ozturk 1:efe9cad8942f 1871 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1872 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1873 <pre>if (isFoo) <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1874 isFoo = false;
Mahir Ozturk 1:efe9cad8942f 1875 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1876 </pre>
Mahir Ozturk 1:efe9cad8942f 1877 </div>
Mahir Ozturk 1:efe9cad8942f 1878 <p>
Mahir Ozturk 1:efe9cad8942f 1879 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1880 <p id="_add-one-line-braces">
Mahir Ozturk 1:efe9cad8942f 1881 <code class="title">--add-one-line-braces / -J <br />
Mahir Ozturk 1:efe9cad8942f 1882 --add-one-line-brackets is depreciated </code>
Mahir Ozturk 1:efe9cad8942f 1883 <br />
Mahir Ozturk 1:efe9cad8942f 1884 Add one line braces to unbraced one line conditional statements (e.g. 'if', 'for',
Mahir Ozturk 1:efe9cad8942f 1885 'while'...). The statement must be on a single line. The option implies --keep-one-line-blocks and
Mahir Ozturk 1:efe9cad8942f 1886 will not break the one line blocks.</p>
Mahir Ozturk 1:efe9cad8942f 1887 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1888 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1889 isFoo = false;
Mahir Ozturk 1:efe9cad8942f 1890 </pre>
Mahir Ozturk 1:efe9cad8942f 1891 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1892 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1893 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1894 <span class="brace">{</span> isFoo = false; <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1895 </pre>
Mahir Ozturk 1:efe9cad8942f 1896 </div>
Mahir Ozturk 1:efe9cad8942f 1897 <p>
Mahir Ozturk 1:efe9cad8942f 1898 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1899 <p id="_remove-braces">
Mahir Ozturk 1:efe9cad8942f 1900 <code class="title">--remove-braces / -xj <br />
Mahir Ozturk 1:efe9cad8942f 1901 --remove-brackets is depreciated </code>
Mahir Ozturk 1:efe9cad8942f 1902 <br />
Mahir Ozturk 1:efe9cad8942f 1903 Remove braces from conditional statements (e.g. 'if', 'for', 'while'...).
Mahir Ozturk 1:efe9cad8942f 1904 The statement must be a single statement on a single line. If --add-braces or --add-one-line-braces is also
Mahir Ozturk 1:efe9cad8942f 1905 used the result will be to add braces. Braces will not be removed from "One True Brace Style",
Mahir Ozturk 1:efe9cad8942f 1906 --style=1tbs.</p>
Mahir Ozturk 1:efe9cad8942f 1907 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1908 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1909 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1910 isFoo = false;
Mahir Ozturk 1:efe9cad8942f 1911 <span class="brace">}</span></pre>
Mahir Ozturk 1:efe9cad8942f 1912 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1913 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1914 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1915 isFoo = false;
Mahir Ozturk 1:efe9cad8942f 1916 </pre>
Mahir Ozturk 1:efe9cad8942f 1917 </div>
Mahir Ozturk 1:efe9cad8942f 1918 <p>
Mahir Ozturk 1:efe9cad8942f 1919 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1920 <p id="_keep-one-line-blocks">
Mahir Ozturk 1:efe9cad8942f 1921 <code class="title">--keep-one-line-blocks / -O </code>
Mahir Ozturk 1:efe9cad8942f 1922 <br />
Mahir Ozturk 1:efe9cad8942f 1923 Don't break one-line blocks.</p>
Mahir Ozturk 1:efe9cad8942f 1924 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1925 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1926 <span class="brace">{</span> isFoo = false; cout &lt;&lt; isFoo &lt;&lt; endl; <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1927 </pre>
Mahir Ozturk 1:efe9cad8942f 1928 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1929 remains unchanged.</p>
Mahir Ozturk 1:efe9cad8942f 1930 </div>
Mahir Ozturk 1:efe9cad8942f 1931 <p>
Mahir Ozturk 1:efe9cad8942f 1932 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1933 <p id="_keep-one-line-statements">
Mahir Ozturk 1:efe9cad8942f 1934 <code class="title">--keep-one-line-statements / -o </code>
Mahir Ozturk 1:efe9cad8942f 1935 <br />
Mahir Ozturk 1:efe9cad8942f 1936 Don't break complex statements and multiple statements residing on a single line.</p>
Mahir Ozturk 1:efe9cad8942f 1937 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1938 <pre>if (isFoo)
Mahir Ozturk 1:efe9cad8942f 1939 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 1940 isFoo = false; cout &lt;&lt; isFoo &lt;&lt; endl;
Mahir Ozturk 1:efe9cad8942f 1941 <span class="brace">}</span>
Mahir Ozturk 1:efe9cad8942f 1942 </pre>
Mahir Ozturk 1:efe9cad8942f 1943 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1944 remains unchanged.</p>
Mahir Ozturk 1:efe9cad8942f 1945 </div>
Mahir Ozturk 1:efe9cad8942f 1946 <p>
Mahir Ozturk 1:efe9cad8942f 1947 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1948 <p id="_convert-tabs">
Mahir Ozturk 1:efe9cad8942f 1949 <code class="title">--convert-tabs / -c</code><br />
Mahir Ozturk 1:efe9cad8942f 1950 Converts tabs into spaces in the non-indentation part of the
Mahir Ozturk 1:efe9cad8942f 1951 line. The number of spaces inserted will maintain the spacing of the tab. The current setting for spaces per tab
Mahir Ozturk 1:efe9cad8942f 1952 is used. It may not produce the expected results if convert-tabs is used when changing spaces per tab. Tabs are
Mahir Ozturk 1:efe9cad8942f 1953 not replaced within quotes.</p>
Mahir Ozturk 1:efe9cad8942f 1954 <p>
Mahir Ozturk 1:efe9cad8942f 1955 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1956 <p id="_close-templates">
Mahir Ozturk 1:efe9cad8942f 1957 <code class="title">--close-templates / -xy</code><br />
Mahir Ozturk 1:efe9cad8942f 1958 Closes whitespace between the ending angle brackets of template definitions. Closing the ending angle brackets
Mahir Ozturk 1:efe9cad8942f 1959 is now allowed by the C++11 standard. Be sure your compiler supports this before making the changes.</p>
Mahir Ozturk 1:efe9cad8942f 1960 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1961 <pre>Stack&lt; int, List&lt; int &gt; &gt; stack1;</pre>
Mahir Ozturk 1:efe9cad8942f 1962 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1963 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1964 <pre>Stack&lt; int, List&lt; int &gt;&gt; stack1;</pre>
Mahir Ozturk 1:efe9cad8942f 1965 </div>
Mahir Ozturk 1:efe9cad8942f 1966 <p>
Mahir Ozturk 1:efe9cad8942f 1967 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1968 <p id="_remove-comment-prefix">
Mahir Ozturk 1:efe9cad8942f 1969 <code class="title">--remove-comment-prefix / -xp</code><br />
Mahir Ozturk 1:efe9cad8942f 1970 Remove the preceding '*' in a multi-line comment that begins a line. A trailing '*', if present, is also removed.
Mahir Ozturk 1:efe9cad8942f 1971 Text that is less than one indent is indented to one indent. Text greater than one indent is not changed. Multi-line
Mahir Ozturk 1:efe9cad8942f 1972 comments that begin a line, but without the preceding '*', are indented to one indent for consistency. This can
Mahir Ozturk 1:efe9cad8942f 1973 slightly modify the indentation of commented out blocks of code. Lines containing all '*' are left unchanged.
Mahir Ozturk 1:efe9cad8942f 1974 Extra spacing is removed from the comment close '*/'.</p>
Mahir Ozturk 1:efe9cad8942f 1975 <div class="code">
Mahir Ozturk 1:efe9cad8942f 1976 <pre><em>/*
Mahir Ozturk 1:efe9cad8942f 1977 * comment line 1
Mahir Ozturk 1:efe9cad8942f 1978 * comment line 2
Mahir Ozturk 1:efe9cad8942f 1979 */</em></pre>
Mahir Ozturk 1:efe9cad8942f 1980 <p class="code">
Mahir Ozturk 1:efe9cad8942f 1981 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 1982 <pre><em>/*
Mahir Ozturk 1:efe9cad8942f 1983 comment line 1
Mahir Ozturk 1:efe9cad8942f 1984 comment line 2
Mahir Ozturk 1:efe9cad8942f 1985 */</em></pre>
Mahir Ozturk 1:efe9cad8942f 1986 </div>
Mahir Ozturk 1:efe9cad8942f 1987 <p>
Mahir Ozturk 1:efe9cad8942f 1988 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 1989 <p id="_max-code-length">
Mahir Ozturk 1:efe9cad8942f 1990 <code class="title">--max-code-length=<span class="option">#</span>&nbsp;&nbsp; / -xC<span class="option">#</span>
Mahir Ozturk 1:efe9cad8942f 1991 <br />
Mahir Ozturk 1:efe9cad8942f 1992 --break-after-logical / -xL</code><br />
Mahir Ozturk 1:efe9cad8942f 1993 The option max&#8209;code&#8209;length will break a line if the code exceeds <span class="option">#</span>
Mahir Ozturk 1:efe9cad8942f 1994 characters. The valid values are 50 thru 200. Lines without logical conditionals will break on a logical conditional
Mahir Ozturk 1:efe9cad8942f 1995 (||, &amp;&amp;, ...), comma, paren, semicolon, or space.</p>
Mahir Ozturk 1:efe9cad8942f 1996 <p>
Mahir Ozturk 1:efe9cad8942f 1997 Some code will not be broken, such as comments, quotes, and arrays. If used with keep&#8209;one&#8209;line&#8209;blocks
Mahir Ozturk 1:efe9cad8942f 1998 or add-one-line-braces the blocks will NOT be broken. If used with keep&#8209;one&#8209;line&#8209;statements
Mahir Ozturk 1:efe9cad8942f 1999 the statements will be broken at a semicolon if the line goes over the maximum length. If there is no available
Mahir Ozturk 1:efe9cad8942f 2000 break point within the max code length, the line will be broken at the first available break point after the max
Mahir Ozturk 1:efe9cad8942f 2001 code length.</p>
Mahir Ozturk 1:efe9cad8942f 2002 <p>
Mahir Ozturk 1:efe9cad8942f 2003 By default logical conditionals will be placed first in the new line. The option break&#8209;after&#8209;logical
Mahir Ozturk 1:efe9cad8942f 2004 will cause the logical conditionals to be placed last on the previous line. This option has no effect without
Mahir Ozturk 1:efe9cad8942f 2005 max&#8209;code&#8209;length.</p>
Mahir Ozturk 1:efe9cad8942f 2006 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2007 <pre>if (thisVariable1 == thatVariable1 || thisVariable2 == thatVariable2 || thisVariable3 == thatVariable3)
Mahir Ozturk 1:efe9cad8942f 2008 bar();</pre>
Mahir Ozturk 1:efe9cad8942f 2009 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2010 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2011 <pre>if (thisVariable1 == thatVariable1
Mahir Ozturk 1:efe9cad8942f 2012 || thisVariable2 == thatVariable2
Mahir Ozturk 1:efe9cad8942f 2013 || thisVariable3 == thatVariable3)
Mahir Ozturk 1:efe9cad8942f 2014 bar();</pre>
Mahir Ozturk 1:efe9cad8942f 2015 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2016 becomes (with break&#8209;after&#8209;logical):</p>
Mahir Ozturk 1:efe9cad8942f 2017 <pre>if (thisVariable1 == thatVariable1 ||
Mahir Ozturk 1:efe9cad8942f 2018 thisVariable2 == thatVariable2 ||
Mahir Ozturk 1:efe9cad8942f 2019 thisVariable3 == thatVariable3)
Mahir Ozturk 1:efe9cad8942f 2020 bar();</pre>
Mahir Ozturk 1:efe9cad8942f 2021 </div>
Mahir Ozturk 1:efe9cad8942f 2022 <p>
Mahir Ozturk 1:efe9cad8942f 2023 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2024 <p id="_mode">
Mahir Ozturk 1:efe9cad8942f 2025 <code class="title">--mode=c</code><br />
Mahir Ozturk 1:efe9cad8942f 2026 <code class="title">--mode=cs</code><br />
Mahir Ozturk 1:efe9cad8942f 2027 <code class="title">--mode=java</code><br />
Mahir Ozturk 1:efe9cad8942f 2028 Indent a C type, C#, or Java file. C type files are C, C++, C++/CLI, and Objective-C. The option is usually
Mahir Ozturk 1:efe9cad8942f 2029 set from the file extension for each file. You can override the setting with this entry. It will be used for all
Mahir Ozturk 1:efe9cad8942f 2030 files, regardless of the file extension. It allows the formatter to identify language specific syntax such as
Mahir Ozturk 1:efe9cad8942f 2031 C++ classes, templates, and keywords.</p>
Mahir Ozturk 1:efe9cad8942f 2032 <p>
Mahir Ozturk 1:efe9cad8942f 2033 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2034 <hr />
Mahir Ozturk 1:efe9cad8942f 2035
Mahir Ozturk 1:efe9cad8942f 2036 <!-- * * * * * * * * * * * * * Objective-C Options * * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 2037
Mahir Ozturk 1:efe9cad8942f 2038 <h3 id="_Objective_C_Options">Objective&#8209;C Options</h3>
Mahir Ozturk 1:efe9cad8942f 2039
Mahir Ozturk 1:efe9cad8942f 2040 <p>
Mahir Ozturk 1:efe9cad8942f 2041 These options are effective for Objective&#8209;C files only. The paren padding options will still apply to the
Mahir Ozturk 1:efe9cad8942f 2042 Objective-C method prefix and return type unless overridden by the following options.</p>
Mahir Ozturk 1:efe9cad8942f 2043 <p>
Mahir Ozturk 1:efe9cad8942f 2044 Because of the longer indents sometimes needed for Objective&#8209;C, the option "max-continuation-indent" may
Mahir Ozturk 1:efe9cad8942f 2045 need to be increased. If you are not getting the paren and square bracket alignment you want try increasing
Mahir Ozturk 1:efe9cad8942f 2046 this value. The option is described in the "Indentation Options" section.</p>
Mahir Ozturk 1:efe9cad8942f 2047 <p id="_pad-method-prefix">
Mahir Ozturk 1:efe9cad8942f 2048 <code class="title">--pad-method-prefix / -xQ</code><br />
Mahir Ozturk 1:efe9cad8942f 2049 Insert space padding <strong>after</strong> the '-' or '+' Objective&#8209;C method prefix. This will add
Mahir Ozturk 1:efe9cad8942f 2050 exactly one space. Any additional spaces will be deleted.</p>
Mahir Ozturk 1:efe9cad8942f 2051 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2052 <pre>-(void)foo1;
Mahir Ozturk 1:efe9cad8942f 2053 - (void)foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2054 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2055 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2056 <pre>- (void)foo1;
Mahir Ozturk 1:efe9cad8942f 2057 - (void)foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2058 </div>
Mahir Ozturk 1:efe9cad8942f 2059 <p>
Mahir Ozturk 1:efe9cad8942f 2060 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2061 <p id="_unpad-method-prefix">
Mahir Ozturk 1:efe9cad8942f 2062 <code class="title">--unpad-method-prefix / -xR</code><br />
Mahir Ozturk 1:efe9cad8942f 2063 Remove all space padding <strong>after</strong> the &#39;-&#39; or &#39;+&#39; Objective&#8209;C method prefix.&nbsp;
Mahir Ozturk 1:efe9cad8942f 2064 This option will be ignored if used with pad&#8209;method&#8209;prefix. This option takes precedence over the
Mahir Ozturk 1:efe9cad8942f 2065 pad paren outside option.</p>
Mahir Ozturk 1:efe9cad8942f 2066 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2067 <pre>- (void) foo1;
Mahir Ozturk 1:efe9cad8942f 2068 - (void) foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2069 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2070 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2071 <pre>-(void) foo1;
Mahir Ozturk 1:efe9cad8942f 2072 -(void) foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2073 </div>
Mahir Ozturk 1:efe9cad8942f 2074 <p>
Mahir Ozturk 1:efe9cad8942f 2075 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2076 <p id="_pad-return-type">
Mahir Ozturk 1:efe9cad8942f 2077 <code class="title">--pad-return-type / -xq</code><br />
Mahir Ozturk 1:efe9cad8942f 2078 Insert space padding <strong>after</strong> the Objective&#8209;C return type. This will add exactly one
Mahir Ozturk 1:efe9cad8942f 2079 space. Any additional spaces will be deleted. </p>
Mahir Ozturk 1:efe9cad8942f 2080 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2081 <pre>-(void)foo1;
Mahir Ozturk 1:efe9cad8942f 2082 -(void) foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2083 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2084 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2085 <pre>-(void) foo1;
Mahir Ozturk 1:efe9cad8942f 2086 -(void) foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2087 </div>
Mahir Ozturk 1:efe9cad8942f 2088 <p>
Mahir Ozturk 1:efe9cad8942f 2089 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2090 <p id="_unpad-return-type">
Mahir Ozturk 1:efe9cad8942f 2091 <code class="title">--unpad-return-type / -xr</code><br />
Mahir Ozturk 1:efe9cad8942f 2092 Remove all space padding <strong>after</strong> the Objective&#8209;C return type. This option
Mahir Ozturk 1:efe9cad8942f 2093 will be ignored if used with pad&#8209;return&#8209;type. This option takes precedence over the pad paren
Mahir Ozturk 1:efe9cad8942f 2094 outside option. </p>
Mahir Ozturk 1:efe9cad8942f 2095 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2096 <pre>-(void) foo1;
Mahir Ozturk 1:efe9cad8942f 2097 -(void) foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2098 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2099 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2100 <pre>-(void)foo1;
Mahir Ozturk 1:efe9cad8942f 2101 -(void)foo2;</pre>
Mahir Ozturk 1:efe9cad8942f 2102 </div>
Mahir Ozturk 1:efe9cad8942f 2103 <p>
Mahir Ozturk 1:efe9cad8942f 2104 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2105 <p id="_pad-param-type">
Mahir Ozturk 1:efe9cad8942f 2106 <code class="title">--pad-param-type / -xS</code><br />
Mahir Ozturk 1:efe9cad8942f 2107 Insert space padding around the Objective&#8209;C parameter type. This will add exactly one space. Any additional
Mahir Ozturk 1:efe9cad8942f 2108 spaces will be deleted. This has precedence over the pad method colon option and will always cause space padding
Mahir Ozturk 1:efe9cad8942f 2109 after the method colon.</p>
Mahir Ozturk 1:efe9cad8942f 2110 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2111 <pre>-(void)foo1:(bool)barArg1;
Mahir Ozturk 1:efe9cad8942f 2112 -(void)foo2: (bool) barArg2;</pre>
Mahir Ozturk 1:efe9cad8942f 2113 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2114 becomes:</p>
Mahir Ozturk 1:efe9cad8942f 2115 <pre>-(void)foo1: (bool) barArg1;
Mahir Ozturk 1:efe9cad8942f 2116 -(void)foo2: (bool) barArg2;</pre>
Mahir Ozturk 1:efe9cad8942f 2117 </div>
Mahir Ozturk 1:efe9cad8942f 2118 <p>
Mahir Ozturk 1:efe9cad8942f 2119 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2120 <p id="_unpad-param-type">
Mahir Ozturk 1:efe9cad8942f 2121 <code class="title">--unpad-param-type / -xs</code><br />
Mahir Ozturk 1:efe9cad8942f 2122 Remove all space padding around the Objective&#8209;C parameter type. This option takes precedence over the pad
Mahir Ozturk 1:efe9cad8942f 2123 paren outside option. The pad method colon option has precedence over the <strong>opening</strong> paren. The
Mahir Ozturk 1:efe9cad8942f 2124 closing paren will always be unpadded.</p>
Mahir Ozturk 1:efe9cad8942f 2125 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2126 <pre>-(void)foo1: (bool) barArg1;
Mahir Ozturk 1:efe9cad8942f 2127 -(void)foo2: (bool) barArg2;</pre>
Mahir Ozturk 1:efe9cad8942f 2128 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2129 becomes (with an unpadded method colon):</p>
Mahir Ozturk 1:efe9cad8942f 2130 <pre>-(void)foo1:(bool)barArg1;
Mahir Ozturk 1:efe9cad8942f 2131 -(void)foo2:(bool)barArg2;</pre>
Mahir Ozturk 1:efe9cad8942f 2132 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2133 becomes (with a padded method colon
Mahir Ozturk 1:efe9cad8942f 2134 after):</p>
Mahir Ozturk 1:efe9cad8942f 2135 <pre>-(void)foo1: (bool)barArg1;
Mahir Ozturk 1:efe9cad8942f 2136 -(void)foo2: (bool)barArg2;</pre>
Mahir Ozturk 1:efe9cad8942f 2137 </div>
Mahir Ozturk 1:efe9cad8942f 2138 <p>
Mahir Ozturk 1:efe9cad8942f 2139 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2140 <p id="_align-method-colon">
Mahir Ozturk 1:efe9cad8942f 2141 <code class="title">--align-method-colon / -xM</code><br />
Mahir Ozturk 1:efe9cad8942f 2142 Align the colons in Objective&#8209;C method declarations
Mahir Ozturk 1:efe9cad8942f 2143 and method calls. If this option is not declared, method definitions will be indented uniformly, and method calls
Mahir Ozturk 1:efe9cad8942f 2144 will align with the first keyword.</p>
Mahir Ozturk 1:efe9cad8942f 2145 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2146 <pre>-(void)longKeyword: (ID)theArg1
Mahir Ozturk 1:efe9cad8942f 2147 keyword: (int)theArg2
Mahir Ozturk 1:efe9cad8942f 2148 error: (NSError*)theError
Mahir Ozturk 1:efe9cad8942f 2149 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 2150 [myObj longKeyword: arg1
Mahir Ozturk 1:efe9cad8942f 2151 keyword: arg2
Mahir Ozturk 1:efe9cad8942f 2152 error: arg3];
Mahir Ozturk 1:efe9cad8942f 2153 <span class="brace">}</span></pre>
Mahir Ozturk 1:efe9cad8942f 2154 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2155 becomes (with no option declared):</p>
Mahir Ozturk 1:efe9cad8942f 2156 <pre>-(void)longKeyword: (ID)theArg1
Mahir Ozturk 1:efe9cad8942f 2157 keyword: (int)theArg2
Mahir Ozturk 1:efe9cad8942f 2158 error: (NSError*)theError
Mahir Ozturk 1:efe9cad8942f 2159 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 2160 [myObj longKeyword: arg1
Mahir Ozturk 1:efe9cad8942f 2161 keyword: arg2
Mahir Ozturk 1:efe9cad8942f 2162 error: arg3];
Mahir Ozturk 1:efe9cad8942f 2163 <span class="brace">}</span></pre>
Mahir Ozturk 1:efe9cad8942f 2164 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2165 becomes (with
Mahir Ozturk 1:efe9cad8942f 2166 align-method-colon):</p>
Mahir Ozturk 1:efe9cad8942f 2167 <pre>-(void)longKeyword: (ID)theArg1
Mahir Ozturk 1:efe9cad8942f 2168 keyword: (int)theArg2
Mahir Ozturk 1:efe9cad8942f 2169 error: (NSError*)theError
Mahir Ozturk 1:efe9cad8942f 2170 <span class="brace">{</span>
Mahir Ozturk 1:efe9cad8942f 2171 [myObj longKeyword: arg1
Mahir Ozturk 1:efe9cad8942f 2172 keyword: arg2
Mahir Ozturk 1:efe9cad8942f 2173 error: arg3];
Mahir Ozturk 1:efe9cad8942f 2174 <span class="brace">}</span></pre>
Mahir Ozturk 1:efe9cad8942f 2175 </div>
Mahir Ozturk 1:efe9cad8942f 2176 <p>
Mahir Ozturk 1:efe9cad8942f 2177 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2178 <p id="_pad-method-colon">
Mahir Ozturk 1:efe9cad8942f 2179 <code class="title">--pad-method-colon=none&nbsp;&nbsp; / -xP0<br />
Mahir Ozturk 1:efe9cad8942f 2180 --pad-method-colon=all&nbsp;&nbsp;&nbsp; / -xP1<br />
Mahir Ozturk 1:efe9cad8942f 2181 --pad-method-colon=after&nbsp; / -xP2<br />
Mahir Ozturk 1:efe9cad8942f 2182 --pad-method-colon=before / -xP3
Mahir Ozturk 1:efe9cad8942f 2183 </code><br />
Mahir Ozturk 1:efe9cad8942f 2184 Add or remove space padding before or after the colons in an Objective&#8209;C method call. These options will
Mahir Ozturk 1:efe9cad8942f 2185 pad exactly one space. Any additional spaces will be deleted. The space padding after the method colon can be
Mahir Ozturk 1:efe9cad8942f 2186 overridden by pad-param-type.</p>
Mahir Ozturk 1:efe9cad8942f 2187 <div class="code">
Mahir Ozturk 1:efe9cad8942f 2188 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2189 with pad-method-colon=none:</p>
Mahir Ozturk 1:efe9cad8942f 2190 <pre>-(void)insertKey:(id)key;</pre>
Mahir Ozturk 1:efe9cad8942f 2191 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2192 with pad-method-colon=all:</p>
Mahir Ozturk 1:efe9cad8942f 2193 <pre>-(void)insertKey : (id)key;</pre>
Mahir Ozturk 1:efe9cad8942f 2194 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2195 with pad-method-colon=after:</p>
Mahir Ozturk 1:efe9cad8942f 2196 <pre>-(void)insertKey: (id)key;</pre>
Mahir Ozturk 1:efe9cad8942f 2197 <p class="code">
Mahir Ozturk 1:efe9cad8942f 2198 with pad-method-colon=before:</p>
Mahir Ozturk 1:efe9cad8942f 2199 <pre>-(void)insertKey :(id)key;</pre>
Mahir Ozturk 1:efe9cad8942f 2200 </div>
Mahir Ozturk 1:efe9cad8942f 2201 <p>
Mahir Ozturk 1:efe9cad8942f 2202 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2203 <hr />
Mahir Ozturk 1:efe9cad8942f 2204
Mahir Ozturk 1:efe9cad8942f 2205 <!-- * * * * * * * * * * * * Other Command Line Options * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 2206
Mahir Ozturk 1:efe9cad8942f 2207 <h3 id="_Other_Options">Other Options</h3>
Mahir Ozturk 1:efe9cad8942f 2208
Mahir Ozturk 1:efe9cad8942f 2209 <p>
Mahir Ozturk 1:efe9cad8942f 2210 These are non-formatting options available for the command-line. They can also be included in an options
Mahir Ozturk 1:efe9cad8942f 2211 file.</p>
Mahir Ozturk 1:efe9cad8942f 2212
Mahir Ozturk 1:efe9cad8942f 2213 <p id="_suffix">
Mahir Ozturk 1:efe9cad8942f 2214 <code class="title">--suffix=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2215 Append the suffix #### instead of '.orig' to original file name (e.g. --suffix=<span class="option">.bak</span>.
Mahir Ozturk 1:efe9cad8942f 2216 If this is to be a file extension, the dot '.' must be included. Otherwise the suffix will be appended to the
Mahir Ozturk 1:efe9cad8942f 2217 current file extension.</p>
Mahir Ozturk 1:efe9cad8942f 2218 <p id="_suffix=none">
Mahir Ozturk 1:efe9cad8942f 2219 <code class="title">--suffix=none / -n</code><br />
Mahir Ozturk 1:efe9cad8942f 2220 Do not retain a backup of the original file. The original file is purged after it is formatted.</p>
Mahir Ozturk 1:efe9cad8942f 2221 <p id="_recursive">
Mahir Ozturk 1:efe9cad8942f 2222 <code class="title">--recursive / -r / -R</code><br />
Mahir Ozturk 1:efe9cad8942f 2223 For each directory in the command line, process all subdirectories recursively. When using the recursive option
Mahir Ozturk 1:efe9cad8942f 2224 the file name statement should contain a wildcard. Linux users should place the file path and name in double quotes
Mahir Ozturk 1:efe9cad8942f 2225 so the shell will not resolve the wildcards (e.g. "$HOME/src/*.cpp"). Windows users should place the file path
Mahir Ozturk 1:efe9cad8942f 2226 and name in double quotes if the path or name contains spaces.</p>
Mahir Ozturk 1:efe9cad8942f 2227 <p id="_dry-run">
Mahir Ozturk 1:efe9cad8942f 2228 <code class="title">--dry-run</code><br />
Mahir Ozturk 1:efe9cad8942f 2229 Perform a trial run with no changes made to the files. The report will be output as usual.</p>
Mahir Ozturk 1:efe9cad8942f 2230 <p id="_exclude">
Mahir Ozturk 1:efe9cad8942f 2231 <code class="title">--exclude=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2232 Specify a file or subdirectory #### to be excluded from processing.</p>
Mahir Ozturk 1:efe9cad8942f 2233 <p>
Mahir Ozturk 1:efe9cad8942f 2234 Excludes are matched from the end of the file path. An exclude option of "templates" will exclude ALL directories
Mahir Ozturk 1:efe9cad8942f 2235 named "templates". An exclude option of "cpp/templates" will exclude ALL "cpp/templates" directories. You may
Mahir Ozturk 1:efe9cad8942f 2236 proceed backwards in the directory tree to exclude only the required directories.</p>
Mahir Ozturk 1:efe9cad8942f 2237 <p>
Mahir Ozturk 1:efe9cad8942f 2238 Specific files may be excluded in the same manner. An exclude option of "default.cpp" will exclude ALL files
Mahir Ozturk 1:efe9cad8942f 2239 named "default.cpp". An exclude option of "python/default.cpp" will exclude ALL files named "default.cpp"
Mahir Ozturk 1:efe9cad8942f 2240 contained in a "python" subdirectory. You may proceed backwards in the directory tree to exclude only the
Mahir Ozturk 1:efe9cad8942f 2241 required files.</p>
Mahir Ozturk 1:efe9cad8942f 2242 <p>
Mahir Ozturk 1:efe9cad8942f 2243 Wildcards are NOT allowed. There may be more than one exclude statement. The file path and name may be placed
Mahir Ozturk 1:efe9cad8942f 2244 in double quotes (e.g. &#8209;&#8209;exclude="foo&nbsp;bar.cpp").</p>
Mahir Ozturk 1:efe9cad8942f 2245 <p id="_ignore-exclude-errors">
Mahir Ozturk 1:efe9cad8942f 2246 <code class="title">--ignore-exclude-errors / -i</code><br />
Mahir Ozturk 1:efe9cad8942f 2247 Allow processing to continue if there are errors in the "exclude=###" options.<br />
Mahir Ozturk 1:efe9cad8942f 2248 This option lets the excludes for several projects be entered in a single option file. This option may be placed
Mahir Ozturk 1:efe9cad8942f 2249 in the same option file as the excludes. It will display the unmatched excludes. The following option will not
Mahir Ozturk 1:efe9cad8942f 2250 display the unmatched excludes.</p>
Mahir Ozturk 1:efe9cad8942f 2251 <p id="_ignore-exclude-errors-x">
Mahir Ozturk 1:efe9cad8942f 2252 <code class="title">--ignore-exclude-errors-x / -xi</code><br />
Mahir Ozturk 1:efe9cad8942f 2253 <code class="title"></code>Allow processing to continue if there are errors in the "exclude=###" options.<br />
Mahir Ozturk 1:efe9cad8942f 2254 This option lets the excludes for several projects be entered in a single option file. This option may be placed
Mahir Ozturk 1:efe9cad8942f 2255 in the same option file as the excludes. It will NOT display the unmatched excludes. The preceding option will
Mahir Ozturk 1:efe9cad8942f 2256 display the unmatched excludes.</p>
Mahir Ozturk 1:efe9cad8942f 2257 <p id="_errors-to-stdout">
Mahir Ozturk 1:efe9cad8942f 2258 <code class="title">--errors-to-stdout / -X</code><br />
Mahir Ozturk 1:efe9cad8942f 2259 Print errors to standard-output rather than to standard-error.<br />
Mahir Ozturk 1:efe9cad8942f 2260 This option should be helpful for systems/shells that do not have a separate output to standard-error, such as
Mahir Ozturk 1:efe9cad8942f 2261 in Windows95.</p>
Mahir Ozturk 1:efe9cad8942f 2262 <p id="_preserve-date">
Mahir Ozturk 1:efe9cad8942f 2263 <code class="title">--preserve-date / -Z</code><br />
Mahir Ozturk 1:efe9cad8942f 2264 Preserve the original file's date and time modified. The time modified will be changed a few microseconds to
Mahir Ozturk 1:efe9cad8942f 2265 force the changed files to compile. This option is not effective if redirection is used to rename the input
Mahir Ozturk 1:efe9cad8942f 2266 file.</p>
Mahir Ozturk 1:efe9cad8942f 2267 <p id="_verbose">
Mahir Ozturk 1:efe9cad8942f 2268 <code class="title">--verbose / -v</code><br />
Mahir Ozturk 1:efe9cad8942f 2269 Verbose display mode. Display optional information, such as release number, date, and statistical data.</p>
Mahir Ozturk 1:efe9cad8942f 2270 <p id="_formatted">
Mahir Ozturk 1:efe9cad8942f 2271 <code class="title">--formatted / -Q</code><br />
Mahir Ozturk 1:efe9cad8942f 2272 Formatted files display mode. Display only the files that have been formatted. Do not display files that
Mahir Ozturk 1:efe9cad8942f 2273 are unchanged.</p>
Mahir Ozturk 1:efe9cad8942f 2274 <p id="_quiet">
Mahir Ozturk 1:efe9cad8942f 2275 <code class="title">--quiet / -q</code><br />
Mahir Ozturk 1:efe9cad8942f 2276 Quiet display mode. Suppress all output except error messages.</p>
Mahir Ozturk 1:efe9cad8942f 2277 <p id="_lineend">
Mahir Ozturk 1:efe9cad8942f 2278 <code class="title">--lineend=windows&nbsp;/ -z1<br />
Mahir Ozturk 1:efe9cad8942f 2279 --lineend=linux &nbsp; / -z2<br />
Mahir Ozturk 1:efe9cad8942f 2280 --lineend=macold&nbsp;&nbsp;/ -z3
Mahir Ozturk 1:efe9cad8942f 2281 </code><br />
Mahir Ozturk 1:efe9cad8942f 2282 Force use of the specified line end style. Valid options are windows (CRLF), linux (LF), and macold (CR). MacOld
Mahir Ozturk 1:efe9cad8942f 2283 style is the format for Mac&nbsp;OS&nbsp;9 and earlier. OS&nbsp;X uses the Linux style. If one of these options
Mahir Ozturk 1:efe9cad8942f 2284 is not used, the line ends will be determined automatically from the input file.</p>
Mahir Ozturk 1:efe9cad8942f 2285 <p>
Mahir Ozturk 1:efe9cad8942f 2286 When <strong>redirection</strong> is used on Windows the output will always have Windows line ends. This option
Mahir Ozturk 1:efe9cad8942f 2287 will be ignored.</p>
Mahir Ozturk 1:efe9cad8942f 2288 <p>
Mahir Ozturk 1:efe9cad8942f 2289 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2290 <hr style="margin-left: -0.4in;" />
Mahir Ozturk 1:efe9cad8942f 2291
Mahir Ozturk 1:efe9cad8942f 2292 <!-- * * * * * * * * * * * * Command-Line Options * * * * * * * * * * * * -->
Mahir Ozturk 1:efe9cad8942f 2293
Mahir Ozturk 1:efe9cad8942f 2294 <h3 id="_Command_Line_Only">Command Line Only</h3>
Mahir Ozturk 1:efe9cad8942f 2295
Mahir Ozturk 1:efe9cad8942f 2296 <p>These options are available for the command-line only. They are NOT available in an options file.</p>
Mahir Ozturk 1:efe9cad8942f 2297 <p id="_options=">
Mahir Ozturk 1:efe9cad8942f 2298 <code class="title">--options=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2299 Specify an options file #### to read and use. It must contain a file path for the file. This will allow the file
Mahir Ozturk 1:efe9cad8942f 2300 name to be changed from astylerc or .astylerc.</p>
Mahir Ozturk 1:efe9cad8942f 2301 <p id="_options=none">
Mahir Ozturk 1:efe9cad8942f 2302 <code class="title">--options=none</code><br />
Mahir Ozturk 1:efe9cad8942f 2303 Disable the default options file. Only the command-line parameters will be used.</p>
Mahir Ozturk 1:efe9cad8942f 2304 <p id="_ascii">
Mahir Ozturk 1:efe9cad8942f 2305 <code class="title">--ascii / -I</code><br />
Mahir Ozturk 1:efe9cad8942f 2306 The displayed output will be ASCII characters only. The text will be displayed in English and numbers will not
Mahir Ozturk 1:efe9cad8942f 2307 be formatted. The short option must be by itself, it cannot be concatenated with other options.</p>
Mahir Ozturk 1:efe9cad8942f 2308 <p id="_version">
Mahir Ozturk 1:efe9cad8942f 2309 <code class="title">--version / -V</code><br />
Mahir Ozturk 1:efe9cad8942f 2310 Print version number and quit. The short option must be by itself, it cannot be concatenated with other
Mahir Ozturk 1:efe9cad8942f 2311 options.</p>
Mahir Ozturk 1:efe9cad8942f 2312 <p id="_help">
Mahir Ozturk 1:efe9cad8942f 2313 <code class="title">--help / -h / -?</code><br />
Mahir Ozturk 1:efe9cad8942f 2314 Print a help message and quit. The short option must be by itself, it cannot be concatenated with other
Mahir Ozturk 1:efe9cad8942f 2315 options.</p>
Mahir Ozturk 1:efe9cad8942f 2316 <p id="_html">
Mahir Ozturk 1:efe9cad8942f 2317 <code class="title">--html / -!</code><br />
Mahir Ozturk 1:efe9cad8942f 2318 Open the HTML help
Mahir Ozturk 1:efe9cad8942f 2319 file "astyle.html" in the default browser and quit. The short option must be by itself, it
Mahir Ozturk 1:efe9cad8942f 2320 cannot be concatenated with other options. The documentation must be installed in the standard install path (/usr/share/doc/astyle/html
Mahir Ozturk 1:efe9cad8942f 2321 for Linux or %PROGRAMFILES%\AStyle\doc for Windows). If installed to a different path use html=###.</p>
Mahir Ozturk 1:efe9cad8942f 2322 <p id="_html=">
Mahir Ozturk 1:efe9cad8942f 2323 <code class="title">--html=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2324 Open an HTML help file in the default browser using the file path #### and quit. An HTML file other than "astyle.help"
Mahir Ozturk 1:efe9cad8942f 2325 may be specified. The path may include a directory path and a file name, or a file name only (e.g. html=install.html).
Mahir Ozturk 1:efe9cad8942f 2326 If only a file name is used, it is assumed to be in the standard install path (/usr/share/doc/astyle/html
Mahir Ozturk 1:efe9cad8942f 2327 for Linux or %PROGRAMFILES%\AStyle\doc for Windows). In both cases the file name must include the html extension.
Mahir Ozturk 1:efe9cad8942f 2328 File paths containing spaces must be enclosed in quotes.</p>
Mahir Ozturk 1:efe9cad8942f 2329 <p>
Mahir Ozturk 1:efe9cad8942f 2330 On Linux the HTML file is opened using the script "xdg-open" from the install package "xdg-utils". This should
Mahir Ozturk 1:efe9cad8942f 2331 be installed by default on most distributions.</p>
Mahir Ozturk 1:efe9cad8942f 2332 <p>
Mahir Ozturk 1:efe9cad8942f 2333 Any HTML file can be opened by this option. The files you are likely to need are astyle.html (the default), install.html,
Mahir Ozturk 1:efe9cad8942f 2334 and index.html.</p>
Mahir Ozturk 1:efe9cad8942f 2335 <p id="_stdin=">
Mahir Ozturk 1:efe9cad8942f 2336 <code class="title">--stdin=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2337 Open a file using the file path #### as input to single file formatting. This is a replacement for redirection.
Mahir Ozturk 1:efe9cad8942f 2338 Do not use this with "&lt;" redirection.</p>
Mahir Ozturk 1:efe9cad8942f 2339 <p id="_stdout=">
Mahir Ozturk 1:efe9cad8942f 2340 <code class="title">--stdout=<span class="option">####</span></code><br />
Mahir Ozturk 1:efe9cad8942f 2341 Open a file using the file path #### as output to single file formatting. This is a replacement for redirection.
Mahir Ozturk 1:efe9cad8942f 2342 Do not use this with "&gt;" redirection.</p>
Mahir Ozturk 1:efe9cad8942f 2343 <p>
Mahir Ozturk 1:efe9cad8942f 2344 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2345 <hr style="margin-left: -0.4in;" />
Mahir Ozturk 1:efe9cad8942f 2346
Mahir Ozturk 1:efe9cad8942f 2347 <p style="margin-left: -0.4in; text-align: center;">
Mahir Ozturk 1:efe9cad8942f 2348 <a href="http://sourceforge.net/projects/astyle">
Mahir Ozturk 1:efe9cad8942f 2349 <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=2319&type=16" alt="" />
Mahir Ozturk 1:efe9cad8942f 2350 </a></p>
Mahir Ozturk 1:efe9cad8942f 2351
Mahir Ozturk 1:efe9cad8942f 2352 <p>
Mahir Ozturk 1:efe9cad8942f 2353 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2354 <p>
Mahir Ozturk 1:efe9cad8942f 2355 &nbsp;</p>
Mahir Ozturk 1:efe9cad8942f 2356
Mahir Ozturk 1:efe9cad8942f 2357 </body>
Mahir Ozturk 1:efe9cad8942f 2358
Mahir Ozturk 1:efe9cad8942f 2359 </html>
Mahir Ozturk 1:efe9cad8942f 2360