indent.texinfo

indent为linux下代码自动格式化工具

@end example

@need 1550
Using the @option{-cli2} that would become:

@example
@group
switch (i)
  @{
    case 0:
      break;
    case 1:
      @{
        ++i;
      @}
    default:
      break;
  @}
@end group
@end example

@kindex -cbi@var{n}
@kindex --case-brace-indentation@var{n}
The indentation of the braces below a case statement can be
controlled with the @option{-cbi@var{n}} option.  For example,
using @option{-cli2 -cbi0} results in:

@example
@group
switch (i)
  @{
    case 0:
      break;
    case 1:
    @{
      ++i;
    @}
    default:
      break;
  @}
@end group
@end example

@kindex -ss
@kindex --space-special-semicolon
@kindex -nss
@kindex --dont-space-special-semicolon
If a semicolon is on the same line as a @code{for} or @code{while}
statement, the @option{-ss} option will cause a space to be placed before
the semicolon.  This emphasizes the semicolon, making it clear that the
body of the @code{for} or @code{while} statement is an empty statement.
@option{-nss} disables this feature.

@kindex -pcs
@kindex --space-after-procedure-calls
@kindex -npcs
@kindex --no-space-after-function-call-names
The @option{-pcs} option causes a space to be placed between the name of
the procedure being called and the @samp{(} (for example, @w{@code{puts
("Hi");}}.  The @option{-npcs} option would give @code{puts("Hi");}).
@refill

@kindex -cs
@kindex --space-after-cast
@kindex -ncs
@kindex --no-space-after-casts
If the @option{-cs} option is specified, @command{indent} puts a space after
a cast operator.

@kindex -bs
@kindex --blank-after-sizeof
The @option{-bs} option ensures that there is a space between the
keyword @code{sizeof} and its argument.  In some versions, this is
known as the @samp{Bill_Shannon} option.

@kindex -saf
@kindex --space-after-for
@kindex -nsaf
@kindex --no-space-after-for
The @option{-saf} option forces a space between an @code{for}
and the following parenthesis.  This is the default.

@kindex -sai
@kindex --space-after-if
@kindex -nsai
@kindex --no-space-after-if
The @option{-sai} option forces a space between an @code{if}
and the following parenthesis.  This is the default.

@kindex -saw
@kindex --space-after-while
@kindex -nsaw
@kindex --no-space-after-while
The @option{-saw} option forces a space between an @code{while}
and the following parenthesis.  This is the default.

@kindex -prs
@kindex --space-after-parentheses
The @option{-prs} option causes all parentheses to be seperated with
a space from the what is between them.  For example, using @option{-prs}
results in code like:

@example
@group
  while ( ( e_code - s_code ) < ( dec_ind - 1 ) )
    @{
      set_buf_break ( bb_dec_ind );
      *e_code++ = ' ';
    @}
@end group
@end example

@node Declarations, Indentation, Statements, Indent Program
@comment  node-name,  next,  previous,  up
@section Declarations

@kindex -di@var{n}
@kindex --declaration-indentation@var{n}
By default @command{indent} will line up identifiers, in the column
specified by the @option{-di} option.  For example, @option{-di16} makes
things look like:

@example
@group
int             foo;
char           *bar;
@end group
@end example

Using a small value (such as one or two) for the @option{-di} option can
be used to cause the identifiers to be placed in the first available
position; for example:

@example
@group
int foo;
char *bar;
@end group
@end example

The value given to the @option{-di} option will still affect variables
which are put on separate lines from their types, for example
@option{-di2} will lead to:

@example
@group
int
  foo;
@end group
@end example

@kindex -bc
@kindex --blank-lines-after-commas
@kindex -nbc
@kindex --no-blank-lines-after-commas
If the @option{-bc} option is specified, a newline is forced after each
comma in a declaration.  For example,

@example
@group
int a,
  b,
  c;
@end group
@end example

@noindent
With the @option{-nbc} option this would look like

@example
int a, b, c;
@end example

@kindex -bfda
@kindex --break-function-decl-args
@kindex -nbfda
@kindex --dont-break-function-decl-args
@kindex -bfde
@kindex --break-function-decl-args-end
@kindex -nbfde
@kindex --dont-break-function-decl-args-end
The @option{-bfda} option causes a newline to be forced after the comma
separating the arguments of a function declaration.  The arguments will
appear at one indention level deeper than the function declaration.  This 
is particularly helpful for functions with long argument lists. 
The option @option{-bfde} causes a newline to be forced before the closing 
bracket of the function declaration. For both options the 'n' setting is the default:
-nbdfa and -nbdfe.


For 
example,

@example
@group
void foo (int arg1, char arg2, int *arg3, long arg4, char arg5);
@end group
@end example
@noindent
With the @option{-bfda} option this would look like

@example
void foo (
    int arg1,
    char arg2,
    int *arg3,
    long arg4,
    char arg5);
@end example

With, in addition, the @option{-bfde} option this would look like

@example
void foo (
    int arg1,
    char arg2,
    int *arg3,
    long arg4,
    char arg5
    );
@end example

@kindex -psl
@kindex --procnames-start-lines
@kindex -npsl
@kindex --dont-break-procedure-type
@cindex @command{etags} requires @option{-psl}
The @option{-psl} option causes the type of a procedure being defined to
be placed on the line before the name of the procedure.  This style is
required for the @command{etags} program to work correctly, as well as some
of the @code{c-mode} functions of Emacs.

@kindex -T
@cindex Typenames
@cindex typedef
You must use the @option{-T}
option to tell @command{indent} the name of all the typenames in your
program that are defined by @code{typedef}.  @option{-T} can be specified
more than once, and all names specified are used.  For example, if your
program contains

@example
@group
typedef unsigned long CODE_ADDR;
typedef enum @{red, blue, green@} COLOR;
@end group
@end example

@noindent
you would use the options @option{-T CODE_ADDR -T COLOR}.

The @option{-brs} or @option{-bls} option specifies how to format braces
in struct declarations.  The @option{-brs} option formats braces like
this:

@example
@group
struct foo @{
  int x;
@};
@end group
@end example

@noindent
The @option{-bls} option formats them like this:

@example
@group
struct foo
@{
  int x;
@};
@end group
@end example

@node Indentation, Breaking long lines, Declarations, Indent Program
@comment  node-name,  next,  previous,  up
@section Indentation

@kindex -i@var{n}
@kindex --indent-level@var{n}
@kindex -ci@var{n}
@kindex --continuation-indentation@var{n}
@kindex -lp
@kindex --continue-at-parentheses
@kindex -nlp
@kindex --dont-line-up-parentheses
One issue in the formatting of code is how far each line should be
indented from the left margin.  When the beginning of a statement such
as @code{if} or @code{for} is encountered, the indentation level is
increased by the value specified by the @option{-i} option.  For example,
use @option{-i8} to specify an eight character indentation for each
level.  When a statement is broken across two lines, the second line is
indented by a number of additional spaces specified by the @option{-ci}
option.  @option{-ci} defaults to 0.  However, if the @option{-lp} option is
specified, and a line has a left parenthesis which is not closed on that
line, then continuation lines will be lined up to start at the character
position just after the left parenthesis.  This processing also applies
to @samp{[} and applies to @samp{@{} when it occurs in initialization
lists.  For example, a piece of continued code might look like this with
@option{-nlp -ci3} in effect:

@example
@group
  p1 = first_procedure (second_procedure (p2, p3),
     third_procedure (p4, p5));
@end group
@end example

@noindent
With @option{-lp} in effect the code looks somewhat clearer:

@example
@group
  p1 = first_procedure (second_procedure (p2, p3),
                        third_procedure (p4, p5));
@end group
@end example

@kindex -ts@var{n}
@kindex --tab-size@var{n}
When a statement is broken in between two or more paren pairs (...),
each extra pair causes the indentation level extra indentation:

@example
@group
if ((((i < 2 &&
        k > 0) || p == 0) &&
    q == 1) ||
  n = 0)
@end group
@end example

@noindent
The option @option{-ip@var{N}} can be used to set the extra offset per paren.
For instance, @option{-ip0} would format the above as:

@example
@group
if ((((i < 2 &&
  k > 0) || p == 0) &&
  q == 1) ||
  n = 0)
@end group
@end example

@noindent
@command{indent} assumes that tabs are placed at regular intervals of both
input and output character streams.  These intervals are by default 8
columns wide, but (as of version 1.2) may be changed by the @option{-ts}
option.  Tabs are treated as the equivalent number of spaces.

@kindex -ip@var{n}
@kindex --parameter-indentation@var{n}
@kindex -nip
@kindex --no-parameter-indentation
The indentation of type declarations in old-style function definitions
is controlled by the @option{-ip} parameter.  This is a numeric parameter
specifying how many spaces to indent type declarations.  For example,
the default @w{@option{-ip5}} makes definitions look like this:

@example
@group
char *
create_world (x, y, scale)
     int x;
     int y;
     float scale;
@{
  . . .
@}
@end group
@end example

For compatibility with other versions of indent, the option @option{-nip}
is provided, which is equivalent to @option{-ip0}.

@kindex -lps
@kindex --leave-preprocessor-space
@kindex -nlps
@kindex --remove-preprocessor-space
ANSI C allows white space to be placed on preprocessor command lines
between the character @samp{#} and the command name.  By default,
@command{indent} removes this space, but specifying the @option{-lps} option
directs @command{indent} to leave this space unmodified. The option @option{-ppi} 
overrides  @option{-nlps} and  @option{-lps}.

@kindex -ppi@var{n}
@kindex --preprocessor-indentation@var{n}
This option can be used to request that preprocessor conditional statements can
be indented by to given number of spaces, for example with the option @option{-ppi 3}

@example
@group
#if X
#if Y
#define Z 1
#else
#define Z 0
#endif
#endif
@end group
@end example
becomes
@example
@group
#if X
#   if Y
#      define Z 1
#   else
#      define Z 0
#   endif
#endif
@end group
@end example

@node Breaking long lines, Disabling Formatting, Indentation, Indent Program
@comment  node-name,  next,  previous,  up
@section Breaking long lines