GNATPP(1)

📦 version 2019, in ubuntu jammy

💅 NAME 💅

gnatpp — the Ada pretty-printer, bestie. It's from the ASIS Tools crew and it's literally here to make your Ada source look iconic. 🎀

✨ SYNOPSIS ✨

gnatpp [options] {filename | -files filename} [gcc_switches]

🦋 DESCRIPTION 🦋

Okay so picture this: gnatpp takes the source text of the Ada units you point it at and recreates it from GNAT's parse tree. Like, it rebuilds the whole thing from scratch, and while it's doing that it reformats the source according to all the many options below. The defaults? They're set up for the GNAT style guide, so if you just vibe with the defaults you're already serving looks. 💖

🌸 OPTIONS 🌸

  • -A(0|1|2|3|4|5) — set alignment. All the alignments are set ON by default, so this is your "actually let me pick" button.
    • 0 — set the default for all the alignments OFF
    • 1 — align colons in declarations
    • 2 — align assignments in declarations
    • 3 — align assignments in assignment statements
    • 4 — align arrow delimiters in associations
    • 5 — align 'AT' keywords in component clauses
  • -a(L|U|M) — set attribute casing
    • L — lower case
    • U — upper case
    • M — mixed case (set as default)
  • -c(0|1|2|3|4) — comments layout
    • 0 — do not format comments
    • 1 — GNAT style comment line indentation (set as default)
    • 2 — standard comment line indentation
    • 3 — GNAT style comment beginning
    • 4 — reformat comment blocks
  • -clnnn — indentation level for continuation lines, nnn from 1 .. 9
  • -Dfile — set file as the dictionary file defining casing exceptions
  • -D- — do not use RM95-defined casing for predefined names, use casing defined by the -n parameter and dictionary file(s) instead
  • -e — do not set missed end/exit labels
  • -ff — put Form Feed after a pragma Page
  • -gnatecpath — the same as the GNAT -gnatec option
  • -innn — indentation level, nnn from 1 .. 9, the default value is 3
  • -Idir — the same as the GNAT -I option
  • -I- — the same as the GNAT -I- option
  • -k(L|U) — set keyword casing
    • L — lower case (set as default)
    • U — upper case
  • -l(1|2|3) — set construct layout
    • 1 — GNAT style layout (set as default)
    • 2 — compact layout
    • 3 — uncompact layout
  • -Mnnn — set maximum line length, nnn from 32 .. 256, the default value is 79
  • -n(D|U|L|M) — set name casing (for both defining and usage occurrences)
    • D — as declared (set as default)
    • U — all in upper case
    • L — all in lower case
    • M — mixed
  • -N — no tabulation in comments
  • -p(L|U|M) — (yes bestie, that's it, just the letters)
    • L — lower case
    • U — upper case
    • M — mixed case (set as default)
  • --RTS=dir — the same as the GNAT --RTS option
  • -Tnnn — do not use additional indentation level for case alternatives and variants if their number is nnn or more (the default value is 10)
  • -q — quiet mode 🤫
  • -v — verbose mode 🗣️
  • -dd — progress indicator verbose mode
  • -w — warnings ON

📁 Output file control 📁

  • -pipe — send the output into stdout
  • -o output_file — write the output into output_file. Give up if output_file already exists
  • -of output_file — write the output into output_file, overriding the existing file
  • -r — replace the argument source with the pretty-printed source and copy the argument source into filename.npp. Give up if filename.npp already exists.
  • -rf — replace the argument source with the pretty-printed source and copy the argument source into filename.npp, overriding the existing file
  • -rnb — replace the argument source with the pretty-printed source and do not create the back-up copy of the argument source

🍓 Input files 🍓

  • filename — the name of the Ada source file to be reformatted. Wildcards are allowed. ✨
  • -files filename — the name of the text file containing a list of Ada source files to reformat

🧚 GCC switches 🧚

  • gcc_switches — Passed to gnatgcc as "-cargs gcc_switches".

👑 SEE ALSO 👑

Documentation about the ASIS tools may be found in /usr/share/doc/asis-doc/ if the asis-doc package is installed. The reference documentation about ASIS is excluded due to license problems 😭, but may be found in various formats at http://libre.adacore.com/developers/documentation.

And that's the whole page, bestie — this one's from the Debian GNU/Linux crew, dated 2014-08-09, and it's part of ASIS Tools. Go make your Ada look gorgeous. 💜✨

📦 where this page comes from