Artistic Style 3.1
Maintained by: Jim Pattee
Original Author: Tal Davidson
Usage:
------
astyle [OPTIONS] File1 File2 File3 [...]
astyle [OPTIONS] < Original > Beautified
Когда обрабатывается определенный файл, результат будет сохранен
по месту, в ОРИГИНАЛЬНОМ имени файла. Содержимое оригинального
файла будет сохранено в файле, где к имени оригинального файла
добавлен суффикс '.orig'.
В имени файла могут использоваться шаблоны макроподстановки
(wildcards * и ?). Опция рекурсии позволяет обрабатывать файлы
в подкаталогах. Несколько расширений файлов могут быть отделены
друг от друга запятой.
По умолчанию astyle настроен на отступы из 4 пробелов, с максимальным
отступом в 40 пробелов внутри непрерывных операторов, минимальным
отступом 8 пробелов внутри условных операторов, и опциями без
форматирования (NO formatting).
Опции:
------
Программа astyle использует общепринятый GNU-стиль синтаксиса
опций командной строки. Длинные опции (начинающиеся на '--') должны
быть написаны по одной, через пробел. Коротки опции (начинающиеся
на '-') могут комбинироваться вместе. Таким образом, -bps4 задает
то же самое, что и последовательность опций -b -p -s4.
Файлы опций:
------------
Artistic Style ожидает файл опций по умолчанию и/или файл опций
проекта, обрабатывая опции в следующем порядке:
1. Опции командной строки имеют преимущество.
2. Файл опций проекта имеет преимущество надо файлом умолчаний.
o Имя файла показывается опцией командной строки --project=.
o Имя файла опций .astylerc или _ astylerc.
o Имя файла идентифицируется переменной окружения
ARTISTIC_STYLE_PROJECT_OPTIONS.
o Этот файл запрещается опцией командной строки --project=none.
3. Для всех проектов может использоваться файл опций по умолчанию.
o Путь до файла показывается опцией командной строки --options=.
o Путь до файла показывается переменной окружения
ARTISTIC_STYLE_OPTIONS.
o Имя файла опций .astylerc, и он находится в директории
$HOME (для Linux).
o Имя файла опций astylerc, и он находится в директории
APPDATA (для Windows).
o Этот файл запрещается опцией командной строки --project=none.
Длинные опции в файлах опций могут быть записаны без '--'.
Строка комментария начинается с '#', и продолжается до конца строки.
Запрет форматирования:
----------------------
Disable Block. Блок кода может быть запрещен для форматирования тегами комментария
*INDENT-OFF* и *INDENT-ON*. Эти теги должны находиться в однострочной
строке комментария.
Disable Line. Дополнение операторов можно запретить на одной строке, используя тег
комментария *NOPAD*. Это должен быть однострочный комментарий.
Опции стиля фигурных скобок (Brace Style Options):
--------------------------------------------------
Стиль скобок по умолчанию. Если никакой стиль специально не
запрашивается, то открывающие скобки не меняются, а закрывающие
скобки расставляются по предыдущей строке.
--style=allman ИЛИ --style=bsd ИЛИ --style=break ИЛИ -A1
Стиль Allman для форматирования и отступов. Broken braces.
--style=java ИЛИ --style=attach ИЛИ -A2
Java-стиль для форматирования и отступов. Attached braces.
--style=kr ИЛИ --style=k&r ИЛИ --style=k/r ИЛИ -A3
Стиль Kernighan & Ritchie для форматирования и отступов.
Linux braces.
--style=stroustrup ИЛИ -A4
Stroustrup-стиль для форматирования и отступов.
Linux braces.
--style=whitesmith ИЛИ -A5
Whitesmith-стиль для форматирования и отступов.
Broken, indented braces. Блоки класса и блоки switch с отступом.
--style=vtk ИЛИ -A15
VTK-стиль для форматирования и отступов.
Broken, indented braces except for the opening braces.
--style=ratliff ИЛИ --style=banner ИЛИ -A6
Ratliff-стиль для форматирования и отступов.
Attached, indented braces.
--style=gnu ИЛИ -A7
GNU для форматирования и отступов.
Broken braces, indented blocks.
--style=linux ИЛИ --style=knf ИЛИ -A8
Linux-стиль для форматирования и отступов.
Linux braces, minimum conditional indent is one-half indent.
--style=horstmann ИЛИ --style=run-in ИЛИ -A9
Horstmann-стиль для форматирования и отступов.
Run-in braces, indented switches.
--style=1tbs ИЛИ --style=otbs ИЛИ -A10
One True Brace Style для форматирования и отступов.
Linux braces, add braces to all conditionals.
--style=google ИЛИ -A14
Google-стиль для форматирования и отступов.
Attached braces, indented class modifiers.
--style=mozilla ИЛИ -A16
Mozilla-стиль для форматирования и отступов.
Linux braces, with broken braces for structs and enums,
and attached braces for namespaces.
--style=pico ИЛИ -A11
Pico-стиль для форматирования и отступов.
Run-in opening braces and attached closing braces.
Uses keep one line blocks and keep one line statements.
--style=lisp ИЛИ -A12
Lisp-стиль для форматирования и отступов.
Attached opening braces and attached closing braces.
Uses keep one line statements.
Опции табуляции:
----------------
Если опция отступа не установлена, то по умолчанию
используется 4 пробела на отступ.
--indent=spaces=# ИЛИ -s#
Отступ составляет # пробелов. Если # не указано, то
будет использоваться по умолчанию 4 пробела на отступ.
--indent=tab ИЛИ --indent=tab=# ИЛИ -t ИЛИ -t#
Отступ использует символ табуляции, подразумевая, что
каждый отступ соответствует # пробелам. Если не указать
#, то будет подразумеваться 4 пробела на отступ.
--indent=force-tab=# ИЛИ -T#
Отступ использует символы табуляции, подразумевая, что
каждый отступ длиной # пробела. AStyle предпочитает пробелам
принудительное использование табуляции.
--indent=force-tab-x=# ИЛИ -xT#
Позволяет установить длину табуляции, которая отличается от
длины отступа. Это может привести к тому, что для отступов
будет использоваться смесь табуляций и пробелов. Эта опция
устанавливает длину табуляции.
Опции для изменения установки скобок (Brace Modify Options):
------------------------------------------------------------
--attach-namespaces ИЛИ -xn
Применение скобок для оператора namespace.
--attach-classes ИЛИ -xc
Применение скобок для оператора class.
--attach-inlines ИЛИ -xl
Применение скобок для определений inline-функции класса.
--attach-extern-c ИЛИ -xk
Применение скобок для оператора extern "C".
--attach-closing-while ИЛИ -xV
Применение скобок для while и do-while.
Опции отступа:
--------------
--indent-classes ИЛИ -C
Отступ блоков 'class' таким образом, что делается отступ
для всего блока.
--indent-modifiers ИЛИ -xG
Половинный отступ для модификаторов доступа класса public:,
protected: или private:. Для остальной части класса отступ
не производится.
--indent-switches ИЛИ -S
Делается отступ для блоков switch, так что внутренние
case XXX: ставятся с отступом относительно блока switch.
--indent-cases ИЛИ -K
Отступ блоков case от заголовков case XXX:. Для операторов
case, не закрытых в блоки, отступ не производится.
--indent-namespaces ИЛИ -N
Отступ для содержимого блоков namespace.
--indent-after-parens ИЛИ -xU
Вместо выравнивания применить отступ там, где продолжающиеся
строки содержат открывающую скобку '(' или присваивание '='.
--indent-continuation=# ИЛИ -xt#
Отступ продолжающихся строк на дополнительные # отступов.
Допустимы значения от 0 до 4. Значение по умолчанию 1 оступ.
--indent-labels ИЛИ -L
Отступ для меток таким образом, что они на один отступ меньше
текущей позиции отступа, вместо того чтобы полностью смещаться
влево (что соответствует умолчанию).
--indent-preproc-block ИЛИ -xW
Отступ блоков препроцессора на уровень скобок 0. Без этой
опции для блоков препроцессора отступ не делается.
--indent-preproc-cond ИЛИ -xw
Отступ условных операторов препроцессора #if/#else/#endif
на уровень отступа исходного кода.
--indent-preproc-define ИЛИ -w
Отступ для многострочных операторов #define.
--indent-col1-comments ИЛИ -Y
Отступ строк комментария, которые начинаются в первом столбце.
--min-conditional-indent=# ИЛИ -m#
Отступ минимум # пробелов в продолжающемся условии,
принадлежащем условному заголовку.
Допустимы значения:
0 - без минимального отступа.
1 - как минимум один дополнительный отступ.
2 - как минимум два дополнительных отступа.
3 - как минимум половинчатый дополнительный отступ.
Значение по умолчанию 2.
--max-continuation-indent=# ИЛИ -M#
Отступ максимум # пробелов в продолжающейся строке, относительно
предыдущей строки. Допустимы значения от 40 до 120.
Значение по умолчанию 40.
Опции заполнения (Padding):
---------------------------
--break-blocks ИЛИ -f
Вставка пустых строк вокруг несвязанных блоков, меток, классов, ...
--break-blocks=all ИЛИ -F
Наподобие --break-blocks, кроме того, что также вставляются пустые
строки вокруг закрывающих заголовков (например else, catch, ...).
--pad-oper ИЛИ -p
Вставка пробелов вокруг операторов.
--pad-comma ИЛИ -xg
Вставка пробелов после запятых.
--pad-paren ИЛИ -P
Вставка пробела вокруг круглой скобки, снаружи и внутри.
--pad-paren-out ИЛИ -d
Вставка пробела возле круглой скобки, но только снаружи.
--pad-first-paren-out ИЛИ -xd
Вставка пробела вокруг первой круглой скобки в последовательности,
но только снаружи.
--pad-paren-in ИЛИ -D
Вставка пробела вокруг круглой скобки, но только внутри.
--pad-header ИЛИ -H
Вставка пробела после if, for....
--unpad-paren ИЛИ -U
Удаление ненужных пробелов вокруг круглых скобок. Это может
использоваться вместе с комбинацией 'pad'-опций, приведенных
выше.
--delete-empty-lines ИЛИ -xd
Удаление пустых строк функции или метода.
Это не удалит строки, добавленные опциями разбиения блоков.
--fill-empty-lines ИЛИ -E
Заполнение пустых строк пробелами на основе предыдущих строк.
--align-pointer=type ИЛИ -k1
--align-pointer=middle ИЛИ -k2
--align-pointer=name ИЛИ -k3
Прикрепление оператора указателя или ссылки (*, & или ^)
либо к типу оператора (влево), либо установка посередине,
либо к имени оператора (вправо).
Отдельно для ссылки используйте --align-reference.
--align-reference=none ИЛИ -W0
--align-reference=type ИЛИ -W1
--align-reference=middle ИЛИ -W2
--align-reference=name ИЛИ -W3
Прикрепление оператора ссылки (&) либо к типу оператора (влево),
либо посередине, либо к имени оператора (вправо).
Если не установлено, то применяется прикрепление для указателя.
Опции форматирования:
---------------------
--break-closing-braces ИЛИ -y
Разбивает фигурные скобки перед закрывающими заголовками
(например else, catch, ...). Используется для --style=java,
--style=kr, --style=stroustrup, --style=linux или --style=1tbs.
--break-elseifs ИЛИ -e
Разбивает операторы else if()' на две разные строки.
--break-one-line-headers ИЛИ -xb
Разбивает однострочные заголовки (if, while, else, ...) из
оператора, находящегося в той же строке.
--add-braces ИЛИ -j
Добавляет фигурные скобки, где их нет, в однострочные условные
операторы.
--add-one-line-braces ИЛИ -J
Добавляет однострочные фигурные скобки в однострочные условные
операторы.
--remove-braces ИЛИ -xj
Удаляет фигурные скобки из однострочных условных операторов.
--break-return-type ИЛИ -xB
--break-return-type-decl ИЛИ -xD
Отрывает возвращаемый тип от имени функции. Применяется для
определений и деклараций функции.
--attach-return-type ИЛИ -xf
--attach-return-type-decl ИЛИ -xh
Прикрепляет тип к имени функции. Применяется для определений
и деклараций функции.
--keep-one-line-blocks ИЛИ -O
Не разбивает блоки, которые полностью размещены в одной строке.
--keep-one-line-statements ИЛИ -o
Не разбивает строки, содержащие несколько операторов в одной
строке.
--convert-tabs ИЛИ -c
Преобразует табуляции в соответствующее количество пробелов.
--close-templates ИЛИ -xy
Закрывает завершающие угловые скобки в определениях шаблона.
--remove-comment-prefix ИЛИ -xp
Удалит префикс '*' на многострочных комментариях и делает отступ
текста комментария на одну позицию.
--max-code-length=# ИЛИ -xC#
--break-after-logical ИЛИ -xL
max-code-length=# разобъет строк, если она превышает в длину
# символов. Допустимы значения от 50 до 200. Если строка содержит
логические условия, то они будут помещены на новой строке первыми.
Опция break-after-logical приведет к тому, что логические условия
помещаются последними на предыдущей строке.
--mode=c
Отступ исходного файла C или C++ (по умолчанию).
--mode=java
Отступ исходного файла Java.
--mode=cs
Отступ исходного файла C#.
Опции Objective-C:
------------------
--pad-method-prefix ИЛИ -xQ
Вставка дополняющего пробела после '-' или '+' префикса
метода Objective-C.
--unpad-method-prefix ИЛИ -xR
Удаление всех пробелов после '-' или '+' префикса
метода Objective-C.
--pad-return-type ИЛИ -xq
Вставка пробела после возвращаемого типа Objective-C.
--unpad-return-type ИЛИ -xr
Удаление всех дополняющих пробелов после возвращаемого
типа Objective-C.
--pad-param-type ИЛИ -xS
Вставка дополняющего пробела после возвращаемого типа
Objective-C.
--unpad-param-type ИЛИ -xs
Удаление всех дополняющих пробелов после возвращаемого
типа Objective-C.
--align-method-colon ИЛИ -xM
Выравнивание символов точки с запятой в определении
метода Objective-C.
--pad-method-colon=none ИЛИ -xP
--pad-method-colon=all ИЛИ -xP1
--pad-method-colon=after ИЛИ -xP2
--pad-method-colon=before ИЛИ -xP3
Добавление или удаление дополняющего пробела перед или
после точки с запятой в вызове метода Objective-C.
Другие опции:
-------------
--suffix=####
Добавление суффикса #### вместо .orig для оригинального имени файла.
--suffix=none ИЛИ -n
Не делать бекап содержимого оригинального файла.
--recursive ИЛИ -r ИЛИ -R
Рекурсивно обрабатывает подкаталоги.
--dry-run
Выполнить пустой запуск (trial run) без внесения изменений, чтобы
проверить форматирование.
--exclude=####
Указать файл или директорию #### для исключения из обработки.
--ignore-exclude-errors ИЛИ -i
Позволяет продолжить обработку, если имеются ошибки в опциях
exclude=####. Покажет не совпавшие исключения.
--ignore-exclude-errors-x ИЛИ -xi
Позволяет продолжить обработку, если были ошибки в опциях
exclude=####. Не покажет не совпавшие исключения.
--errors-to-stdout ИЛИ -X
Печатает ошибки и информацию help в стандартный вывод (stdout)
вместо вывода для ошибок (stderr).
--preserve-date ИЛИ -Z
Сохраняет дату и время модификации оригинального файла. Время
будет изменено на несколько микросекунд, чтобы принудительно
запустилась компиляция.
--verbose ИЛИ -v
Режим подробного вывода. Отобразятся дополнительные информационные
сообщения.
--formatted ИЛИ -Q
Режим форматированного отображения. Будет только показано
форматирование файлов.
--quiet ИЛИ -q
"Тихий" режим. Подавляет весь вывод, кроме сообщений об ошибках.
--lineend=windows ИЛИ -z1
--lineend=linux ИЛИ -z2
--lineend=macold ИЛИ -z3
Принудительно задает стиль окончания строк. Допустимы опции
для Windows (CRLF), Linux (LF) и macold (CR).
Опции только для командной строки:
----------------------------------
--options=####
--options=none
Задает чтение и использование файла опций по умолчанию ####.
Здесь значение #### должно содержать путь до файла и имя файла.
Значение none запрещает файл опций по умолчанию.
--project
--project=####
--project=none
Задает чтение и использование файла опций проекта ####.
Здесь #### должно содержать только имя файла, без пути директории.
Этот файл должен быть включен в директорию верхнего уровня проекта.
Имя файла по умолчанию .astylerc или _astylerc.
Значение none запретить файл опций проекта или действие переменной
окружения (ARTISTIC_STYLE_PROJECT_OPTIONS), задающей имя файла
опций проекта.
--ascii ИЛИ -I
Отображаемый вывод будет содержать только символы ASCII.
--version ИЛИ -V
Напечатает номер версии.
--help ИЛИ -h ИЛИ -?
Выведет это сообщение подсказки.
--html ИЛИ -!
Откроет HTML-файл подсказки astyle.html в браузере по умолчанию.
Документация должна быть установлена в стандартное место установки.
--html=####
Откроет HTML-файл подсказки в браузере по умолчанию, используя путь
файла ####. Путь может включать директорию файла и имя файла, или
только имя файла. Пути, содержащие пробелы, должны быть заключены
в кавычки.
--stdin=####
Использовать путь файла #### как входной одиночный файл форматирования.
Это замена для перенаправления.
--stdout=####
Использовать путь файла #### в качестве вывода из одиночного файла
форматирования. Это замена для перенаправления.