eu.cqse.check.framework.preprocessor.c.new_c_preprocessor

Class MacroExpansionStepsLogger

java.lang.Object

eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.MacroExpansionStepsLogger

public class MacroExpansionStepsLogger
extends java.lang.Object

"Logger" for storing intermediate steps during preprocessor expansion. In production this will usually not be used (i.e., use the NO_OP Logger which does nothing).

This needs to be in the production code (rather than test code) because it is used at least one debug service in production instances (PreprocessorExpansionDebugService).

Field Summary

Fields

Modifier and Type	Field and Description
static MacroExpansionStepsLogger	NO_OP The default MacroExpansionStepsLogger, which does nothing and does not cost runtime.

Constructor Summary

Constructors

Constructor and Description
MacroExpansionStepsLogger(java.io.PrintStream outputPrintStream) Creates a MacroExpansionStepsLogger that writes to a PrintStream with UTF-8 encoding.
MacroExpansionStepsLogger(java.io.Writer outputPrintWriter) Creates a MacroExpansionStepsLogger that writes log messages to the given Writer.

Method Summary

Modifier and Type	Method and Description
void	decrementNestingDepth() Decrement the tab-nesting depth before future messages.
void	incrementNestingDepth() Increment the tab-nesting depth before future messages.
void	logStatusMessage(java.util.List<IToken> currentTokens1, java.util.List<IToken> currentTokens2, java.lang.String logMessage, eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext) Delegates to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext) but concatenates the two given lists first.
void	logStatusMessage(java.util.List<IToken> macroContent, java.lang.String logMessage, eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext) Logs the given message with printing the current tokens (in contrast to #logStatusMessage(String, String)).
void	logStatusMessage(java.util.List<IToken> macroContent, java.util.function.Supplier<java.lang.String> logMessage, eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext) Delegates to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext) using the given Supplier for the log message.
void	logStatusMessage(java.lang.String messageTag, java.util.function.Supplier<java.lang.String> messageContent) Logs the given message without printing the current tokens (in contrast to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext)).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_OP

public static final MacroExpansionStepsLogger NO_OP

The default MacroExpansionStepsLogger, which does nothing and does not cost runtime.

Constructor Detail

MacroExpansionStepsLogger

public MacroExpansionStepsLogger(java.io.PrintStream outputPrintStream)

Creates a MacroExpansionStepsLogger that writes to a PrintStream with UTF-8 encoding. Call with System.out argument for debugging.

MacroExpansionStepsLogger

public MacroExpansionStepsLogger(java.io.Writer outputPrintWriter)

Creates a MacroExpansionStepsLogger that writes log messages to the given Writer.

Method Detail

incrementNestingDepth

public void incrementNestingDepth()

Increment the tab-nesting depth before future messages.

decrementNestingDepth

public void decrementNestingDepth()

Decrement the tab-nesting depth before future messages.

logStatusMessage

public void logStatusMessage(java.util.List<IToken> macroContent,
                             java.lang.String logMessage,
                             eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext)

Logs the given message with printing the current tokens (in contrast to #logStatusMessage(String, String)).

Log message will look like this:
INDENTATION_SPACES logMessage MORE_SPACES tokens

The number of spaces in INDENTATION_SPACES corresponds to the current indentation level. The number of spaces in MORE_SPACES is computed such that tokens of all messages on the same indentation level start in the same column (improves readability) unless logMessage is too long.

Tokens that are "painted blue"/flagged as no_expand in the given tokenDisablingContext are marked with a °.

logStatusMessage

public void logStatusMessage(java.util.List<IToken> macroContent,
                             java.util.function.Supplier<java.lang.String> logMessage,
                             eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext)

Delegates to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext) using the given Supplier for the log message. Since this log call does nothing in production (when using NO_OP), using the Supplier will be cheaper than building an unnecessary String.

logStatusMessage

public void logStatusMessage(java.util.List<IToken> currentTokens1,
                             java.util.List<IToken> currentTokens2,
                             java.lang.String logMessage,
                             eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.NewMacroInvocationPreprocessor.TokenDisablingContext tokenDisablingContext)

Delegates to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext) but concatenates the two given lists first. Using this method (with a two lists) will be cheaper in production (using NO_OP since concatenating the token lists might be expensive and the list would be dropped anyway (if using NO_OP).

logStatusMessage

public void logStatusMessage(java.lang.String messageTag,
                             java.util.function.Supplier<java.lang.String> messageContent)

Logs the given message without printing the current tokens (in contrast to logStatusMessage(List, String, NewMacroInvocationPreprocessor.TokenDisablingContext)).

Log message will look like this:
INDENTATION_SPACES messageTag MORE_SPACES messageContent

The number of spaces in INDENTATION_SPACES corresponds to the current indentation level. The number of spaces in MORE_SPACES is computed such that messageContent of all messages on the same indentation level start in the same column (improves readability) unless messageTag is too long.