forked from ywx/NppAStyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
249 lines (183 loc) · 8.24 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
Artistic Style plugin for Notepad++
-----------------------------------
An Artistic Style plugin for Notepad++ to Format C, C++, C++/CLI, Objective-C, C#, and Java Source Code.
Thanks to developers of Artistic Style, Scintilla and Notepad++.
NOTE: Artistic Style Version 2.05.1
For information on Artistic Style, please see http://sourceforge.net/projects/astyle/
For information on Scintilla, please see http://www.scintilla.org/ or http://sourceforge.net/projects/scintilla/
For information on Notepad++, please see https://notepad-plus-plus.org/ or https://github.com/notepad-plus-plus/notepad-plus-plus
Name: NppAStyle
Author: YWX ([email protected])
Created: 2015-8-2
Copyright: (c) YWX <[email protected]>
License: GNU General Public License, version 3
Send bug reports and questions to YWX <[email protected]>.
Please notice that often trying to correct the bug yourself is the
quickest way to fix it. Even if you fail to do it, you may
discover valuable information allowing us to fix it while doing
it. We also give much higher priority to bug reports with patches
fixing the problems so this ensures that your report will be
addressed sooner.
To get the source code, please visit https://github.com/ywx/NppAStyle
Get a local copy of the Artistic Style Plugin For Notepad++ repository with this command:
git clone git://github.com/ywx/NppAStyle.git NppAStyle-Code
Download NppAStyle.7z (include NppAStyle.dll) from https://github.com/ywx/NppAStyle/releases
For information on Git，please see http://git-scm.com/ or https://github.com/git/git
For information on Git for Windows，please see http://msysgit.github.io/
How to Use NppAStyle
====================
1, Copy NppAStyle.dll to <Notepad++ installation directory>\plugins
Reboot Notepad++, NppAStyle menu will appear in Plugins menu.
2, Or Use Notepad++ Menu Command : Settings => Import => Import plugin(s)...
3, Run Menu Command : NppAStyle => Options ... , Before First Run Menu Command : NppAStyle => Format Code
Bracket Style Options:
----------------------
None style nothing to do.
Allman style formatting/indenting.
Broken brackets.
Java style formatting/indenting.
Attached brackets.
Kernighan & Ritchie style formatting/indenting.
Linux brackets.
Stroustrup style formatting/indenting.
Stroustrup brackets.
Whitesmith style formatting/indenting.
Broken, indented brackets.
Indented class blocks and switch blocks.
VTK style formatting/indenting.
Broken, indented brackets, except for opening brackets.
Banner style formatting/indenting.
Attached, indented brackets.
GNU style formatting/indenting.
Broken brackets, indented blocks.
Linux style formatting/indenting.
Linux brackets, minimum conditional indent is one-half indent.
Horstmann style formatting/indenting.
Run-in brackets, indented switches.
One True Brace (1TBS) Style formatting/indenting.
Linux brackets, add brackets to all conditionals.
Google style formatting/indenting.
Attached brackets, indented class modifiers.
Pico style formatting/indenting.
Run-in opening brackets and attached closing brackets.
Uses keep one line blocks and keep one line statements.
Lisp style formatting/indenting.
Attached opening brackets and attached closing brackets.
Uses keep one line statements.
Bracket Modify Options:
-----------------------
attachNamespaces
Attach brackets to a namespace statement.
attachClasses
Attach brackets to a class statement.
attachInlines
Attach brackets to class inline function definitions.
attachExternC
Attach brackets to an extern "C" statement.
Indentation Options:
--------------------
indent classes
Indent 'class' blocks so that the entire block is indented.
indent modifiers
Indent 'class' access modifiers, 'public:', 'protected:' or
'private:', one half indent. The rest of the class is not indented.
indent switches
Indent 'switch' blocks, so that the inner 'case XXX:'
headers are indented in relation to the switch block.
indent cases
Indent case blocks from the 'case XXX:' headers.
Case statements not enclosed in blocks are NOT indented.
indent namespaces
Indent the contents of namespace blocks.
indent labels
Indent labels so that they appear one indent less than
the current indentation level, rather than being
flushed completely to the left (which is the default).
indent preproc block
Indent preprocessor blocks at bracket level 0.
Without this option the preprocessor block is not indented.
indent preproc cond
Indent preprocessor conditional statements #if/#else/#endif
to the same level as the source code.
indent preproc define
Indent multi-line preprocessor #define statements.
indent col1-comments
Indent line comments that start in column one.
min conditional indent
Indent a minimal # spaces in a continuous conditional
belonging to a conditional header.
The valid values are:
Zero - no minimal indent.
One - indent at least one additional indent.
Two - indent at least two additional indents.
One Half - indent at least one-half an additional indent.
The default value is 2, two additional indents.
Padding Options:
----------------
break blocks
Insert empty lines around unrelated blocks, labels, classes, ...
pad operators
Insert space padding around operators.
pad parenthesis outside
Insert space padding around parenthesis on the outside only.
pad first paren out
Insert space padding around first parenthesis in a series on
the outside only.
pad parenthesis outside
Insert space padding around parenthesis on the inside only.
pad header
Insert space padding after paren headers (e.g. 'if', 'for'...).
unpad parenthesis
Remove unnecessary space padding around parenthesis. This
can be used in combination with the 'pad' options above.
delete empty lines
Delete empty lines within a function or method.
It will NOT delete lines added by the break-blocks options.
fill empty lines
Fill empty lines with the white space of their previous lines.
align pointer : type, middle, name
Attach a pointer or reference operator (*, &, or ^) to either
the operator type (left), middle, or operator name (right).
To align the reference separately use --align-reference.
align reference : none, type, middle, name, same as pointer
Attach a reference operator (&) to either
the operator type (left), middle, or operator name (right).
If not set, follow pointer alignment.
Formatting Options:
-------------------
break closing brackets
Break brackets before closing headers (e.g. 'else', 'catch', ...).
Use with Bracket Style : java, kr, stroustrup linux, or 1tbs.
break elseifs
Break 'else if()' statements into two different lines.
add brackets
Add brackets to unbracketed one line conditional statements.
add one line brackets
Add one line brackets to unbracketed one line conditional statements.
remove brackets
Remove brackets from a bracketed one line conditional statements.
keep one line blocks
Don't break blocks residing completely on one line.
keep one line statements
Don't break lines containing multiple statements into
multiple single-statement lines.
close templates
Close ending angle brackets on template definitions.
remove comment prefix
Remove the leading '*' prefix on multi-line comments and
indent the comment text one indent.
break after logical
If the line contains logical conditionals they will be placed
first on the new line. The option break-after-logical will
cause the logical conditional to be placed last on the previous line.
Objective-C Options:
--------------------
align method colon
Align the colons in an Objective-C method definition.
pad method prefix
Insert space padding after the '-' or '+' Objective-C method prefix.
unpad method prefix
Remove all space padding after the '-' or '+' Objective-C method prefix.
pad method colon : no change, none, all, after, before
Add or remove space padding before or after the colons in an
Objective-C method call.