TRADCPP(1)

πŸ“¦ version 0.5.3, in nixos 26.05, nixpkgs unstable

✨ tradcpp(1) β€” General Commands Manual ✨

πŸ’– NAME πŸ’–

tradcpp β€” the traditional (K&R-style) C macro preprocessor, bestie πŸ’…

🌸 SYNOPSIS 🌸

tradcpp [-options] [input-file [output-file]]

πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so the tradcpp command is literally a traditional K&R-style C macro preprocessor. It's meant to be suitable for historical Unix uses of the preprocessor, like imake(1), especially the ones that depend on whitespace being preserved 🫢.

The chief ways traditional cpp differs from Standard C are:

  • Macro arguments are expanded within quoted strings. There is no stringize operator.
  • There is no token pasting operator; tokens can be concatenated by placing comments between them. This process is also not limited to valid C language tokens.
  • Whitespace is preserved, and in particular tabs are not expanded into spaces. Furthermore, additional whitespace is not injected.

πŸ’… OPTIONS πŸ’…

tradcpp has many options, many of which are defined for compatibility with gcc(1) or other compilers. Many of the options are not yet implemented 😭.

πŸ› οΈ Common Options πŸ› οΈ

  • -C β€” Retain comments in output.
  • -Dmacro[=expansion] β€” Provide a definition for the named macro. If no expansion is provided, the value 1 is used. Note that like many Unix compilers, tradcpp does not accept a space between the D and the macro name.
  • -Ipath β€” Add the specified path to the main list of include directories. Note that like many Unix compilers, tradcpp does not accept a space between the I and the directory name.
  • -nostdinc β€” Do not search the standard system include directories.
  • -P β€” Suppress line number information in the output. Currently line number information is not generated at all and this option has no effect.
  • -Umacro β€” Remove any existing definition for the named macro. Note that like many Unix compilers, tradcpp does not accept a space between the U and the macro name.
  • -undef β€” Remove all predefined macros.

⚠️ Warning Options ⚠️

Warning options can be disabled or enabled by inserting, or not, the string no- between the W and the warning name. Herein the -Wno- form is shown for options that are enabled by default ✨.

  • -Wall β€” Turn on all warnings. The option -Wno-all disables only the warnings that are disabled by default.
  • -w β€” Turn off all warnings.
  • -Werror β€” Make warnings into fatal errors.
  • -Wcomment β€” Warn about nested comments.
  • -Wno-endif-labels β€” Don't warn about symbols attached to #endif directives. (The warning is currently not implemented.)
  • -Wundef β€” Warn about undefined symbols appearing in #if and #elif expressions.
  • -Wunused-macros β€” Warn about macros that are defined and never used. Not implemented.

πŸ“¦ Depend Options πŸ“¦

  • -M β€” Generate dependency information for make(1) on the standard output, instead of preprocessing. Not implemented.
  • -MD β€” Like -M but skip system headers. Not implemented.
  • -MM β€” Like -M but write the dependency information to a file named after the input file with extension .d and preprocess normally to standard output. Not implemented.
  • -MMD β€” Like -MM but skip system headers. Not implemented.
  • -MF file β€” Send dependency output to the named file instead of the default location. Not implemented.
  • -MG β€” When generating dependency information, assume that missing files are generated instead of failing. Not implemented.
  • -MP β€” Issue dummy rules for all include files. This prevents make(1) from choking if an include file is removed. Not implemented.
  • -MQ target β€” Same as -MT except that any make(1) metacharacters appearing in the target are escaped.
  • -MT target β€” Set the name of the make(1) target appearing in the generated dependency information. The default is the name of the input file with its suffix replaced with the suffix for object files, normally .o.

🧚 More Include Path Options 🧚

  • -idirafter path β€” Add the specified path to the β€œafterwards” include path. This path is searched after all directories specified with -I and the standard system directories. Directories on this path are treated as containing system include files.
  • -imacros file β€” Read in file prior to reading the main input file, and preprocess it, but throw away the output and retain only the macro definitions.
  • -include file β€” Read in and preprocess file prior to reading the main input file.
  • -iprefix prefix β€” Set the path prefix used with the -iwithprefix option.
  • -iquote path β€” Add path to the list of directories searched for include directives written with quotes. This list is not searched for include directives written with angle brackets.
  • -iremap string:replacement β€” Substitute replacement for string in the __FILE__ built-in macro. Not supported.
  • -isysroot path β€” Use path as the β€œsystem root”, that is, the directory under which the standard system paths are found.
  • -isystem path β€” Add path to the list of system include directories. This list is searched after the list given with I. Files found on this path are treated as system headers.
  • -iwithprefix dir β€” Splice dir onto the prefix given with -iprefix and add this directory as if it were specified with -idirafter.
  • -iwithprefixbefore β€” Like -iwithprefix but adds the result as if it were specified with -I.

πŸ” Diagnostic Options πŸ”

  • -debuglog file β€” Write a trace of actions and operations to file as the input is processed. Meant for debugging problems in complex substitution schemes fed to tradcpp, such as those used by imake(1).
  • -dD β€” Dump all macro definitions, except for the predefined macros, after the normal preprocessing output. Not implemented.
  • -dI β€” Dump all include directives along with the normal preprocessing output. Not implemented.
  • -dM β€” Dump all macro definitions instead of the normal preprocessing output. Not implemented.
  • -dN β€” Like -dD but emits only macro names and not the expansions. Not implemented.
  • -H β€” Output a trace of the include tree as it gets processed. Not implemented.

🌈 Other Options 🌈

  • -CC β€” Retain comments in output. Same as -C, accepted for compatibility with gcc(1).
  • -fdollars-in-identifiers β€” Enable the use of the dollar sign in identifiers. Not implemented.
  • -fno-dollars-in-identifiers β€” Disable the use of the dollar sign in identifiers. Not implemented.
  • -ftabstop=num β€” Set the tab width to the specified value, for reporting column positions in diagnostics. The default is 8. Not implemented.
  • -std=standard β€” Ask tradcpp to conform to the named standard. The default, and the only supported value, is krc.
  • -traditional β€” This option is accepted for compatibility with gcc(1) and ignored.
  • -x lang β€” Adjust the preprocessor for the given language. The only values accepted for lang are assembler-with-cpp and c, neither of which have any effect on the behavior of tradcpp.

πŸ“ FILES πŸ“

The default list of directories searched for include files is:

/usr/local/include
/usr/include

πŸ‘€ SEE ALSO πŸ‘€

🌈 STANDARDS 🌈

None. The whole point of a traditional cpp is that it reflects practices in pre-standardization implementations of C. Some information is available from the first edition of Kernighan and Ritchie. Much of the rest of the behavior is based on lore, pragmatism, material encountered in the wild, and comparison to other implementations.

πŸ•°οΈ HISTORY πŸ•°οΈ

The original version of tradcpp was written one evening in late 2010. This version had some problems and was put aside. The first working version was released in June 2013 ✨.

πŸ’€ BUGS πŸ’€

Probably plenty.


cute lil sign-off: this is the Debian source/version, dated June 11, 2013 β€” mwah πŸ’‹

πŸ“¦ where this page comes from