Interface Formation

All Known Subinterfaces:
Concatenation, Inclusion, MacroExpansion, Stringification, TransformFormation

public interface Formation
A formation is a record of the history of events that went into the formation of a token. Examples of such events include preprocessor inclusion ( #include), preprocessor macro expansion, and adjacent string literal concatenation. Formations may have a recursive structure.
  • Method Summary

    Modifier and Type
    Method
    Description
    In the sequence of files that led, through inclusion, to the creation of the token, this returns the last file.
    Returns a human-readable textual description of this formation that is not a complete sentence, but is meant to be appended to a string that describes the token.
  • Method Details

    • suffix

      String suffix()
      Returns a human-readable textual description of this formation that is not a complete sentence, but is meant to be appended to a string that describes the token. For example, this method might returns something like "formed by concatenating ...".
      Returns:
      description of formation as clause to be appended to description of token
    • getLastFile

      SourceFile getLastFile()
      In the sequence of files that led, through inclusion, to the creation of the token, this returns the last file. Hence it is the file that is closest to the final token.
      Returns:
      last file in inclusion sequence