View source for Pretty Printer

You do not have permission to edit this page, for the following reasons:

The action you have requested is limited to users in one of the groups: Autoconfirmed users, emailconfirmed, editors.
You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.

You can view and copy the source of this page:

[[Category:Coding Standards]]
== Background ==
The tool can be used to reformat the source code in a standard way that follows the recommended style. It can be invoked either from the command line by the corresponding command or in IDE via the menu entry. The tool does not address all coding rules, but only those related to text layout: indentation, spacing, new lines, etc.
== Options ==
Not all processing expectations are covered by the rules. Some of them may affect resulting code and are therefore controlled by optional settings.
{| class="wikitable"
|+ Options
|- valign="top"
! Option
! Affected constructs
! Example
! Recommended setting
|- valign="top"
| Shall trailing white space be stripped?
| Comments
| <e>-- "[
-- Trailing spaces
-- ]"</e>
| True
|}
== Limitations ==
Some language constructs are difficult to format automatically without breaking original idea of the formatting. These include:
* inline comments: when used inside larger construct they break normal text flow and it may be difficult to guess how the construct should be continued on a new line
== Testing ==
The [[eweasel]] tests that address potential or found and fixed issues are tagged with the keyword '''pretty''' and use <code>pretty</code>''NNN'' for test directory names.

Apart from the visual style the formatting should preserve the original code. This allows for completely automated validation of the tool. If there is a generator of source code streams from the given grammar, the generated text can be feed to the tool. Then the input and output can be compared side by side after serializing them into a sequence of tokens. If the sequences match, the conversion went without an error. Otherwise it renders a bug in the tool.
== Known bugs ==
Next is the list of open bugs related to pretty printer:
* bug#17557
* bug#17568
* bug#17575
* bug#17580
* bug#17581
* bug#17582
* bug#17585
* bug#17586
* bug#17588
* bug#17591
* bug#17603
* bug#17608
* bug#17609

Return to Pretty Printer.

Retrieved from "https://dev.eiffel.com/Pretty_Printer"

View source for Pretty Printer

Navigation

Development

Wiki

Search

Tools