tree: 313039b3f6b6c76b084812a7dd16e610fe0d9ce4 [path history] [tgz]
  1. align.cc
  2. align.h
  3. BUILD
  4. comment-controls.cc
  5. comment-controls.h
  6. comment-controls_test.cc
  7. format-style-init.cc
  8. format-style-init.h
  9. format-style.h
  10. formatter-tuning_test.cc
  11. formatter.cc
  12. formatter.h
  13. formatter_test.cc
  14. README.md
  15. token-annotator.cc
  16. token-annotator.h
  17. token-annotator_test.cc
  18. tree-unwrapper.cc
  19. tree-unwrapper.h
  20. tree-unwrapper_test.cc
  21. verilog-token.cc
  22. verilog-token.h
  23. verilog-token_test.cc
verible/verilog/formatting/README.md

SystemVerilog Formatting

This directory contains all of the SystemVerilog-specific formatter implementation.

Tool user documentation can be found here.

Formatter Subsystems

Full developer documentation can be found here.

Below is a quick summary of the major components.

formatter.h contains the top-level entry point into the formatter. Text-in-text-out tests are in formatter_test.cc.

FormatStyle defines ways in which formatting can be configured.

token_annotator.h marks up a token stream with formatting constraints such as minimum spacing, and always/never-wrap.

TreeUnwrapper converts a SV syntax tree into a language-agnostic TokenPartitionTree representation for doing formatting operations.

align.h implements everything related to tabular alignment of specific sections of code.

comment_controls.h implements comment directives thet disable formatting on ranges of text.