messageobj.h File Reference

Detailed Description

Provides an external, extensible API for message reporting.

This module implements the _TidyMessageImpl structure (declared in tidy-int.h) in order to abstract the reporting of reports and dialogue from the rest of Tidy, and to enable a robust and extensible API for message interrogation by LibTidy users.

Author

Jim Derry

Copyright

Copyright (c) 2017 HTACG. See tidy.h for license.

Date

Created 2017-March-10

Go to the source code of this file.

Functions
TY_PRIVATE ctmbstr	TY_❪getArgFormat❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the format specifier of the given message argument. More...
TY_PRIVATE TidyFormatParameterType	TY_❪getArgType❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the TidyFormatParameterType of the given message argument. More...
TY_PRIVATE double	TY_❪getArgValueDouble❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the double value of the given message argument. More...
TY_PRIVATE int	TY_❪getArgValueInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the integer value of the given message argument. More...
TY_PRIVATE ctmbstr	TY_❪getArgValueString❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the string value of the given message argument. More...
TY_PRIVATE uint	TY_❪getArgValueUInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the unsigned integer value of the given message argument. More...
TY_PRIVATE TidyIterator	TY_❪getMessageArguments❫ (TidyMessageImpl message)
	Initializes the TidyIterator to point to the first item in the message's argument. More...
TY_PRIVATE uint	TY_❪getMessageCode❫ (TidyMessageImpl message)
	get the message key code. More...
TY_PRIVATE int	TY_❪getMessageColumn❫ (TidyMessageImpl message)
	get the column the message applies to. More...
TY_PRIVATE ctmbstr	TY_❪getMessageDefault❫ (TidyMessageImpl message)
	the message, formatted, default language More...
TY_PRIVATE TidyDocImpl *	TY_❪getMessageDoc❫ (TidyMessageImpl message)
	get the document the message came from. More...
TY_PRIVATE ctmbstr	TY_❪getMessageFormatDefault❫ (TidyMessageImpl message)
	the built-in format string More...
TY_PRIVATE ctmbstr	TY_❪getMessageFormat❫ (TidyMessageImpl message)
	the localized format string More...
TY_PRIVATE Bool	TY_❪getMessageIsMuted❫ (TidyMessageImpl message)
	get whether or not the message was muted by the configuration. More...
TY_PRIVATE ctmbstr	TY_❪getMessageKey❫ (TidyMessageImpl message)
	get the message key string. More...
TY_PRIVATE TidyReportLevel	TY_❪getMessageLevel❫ (TidyMessageImpl message)
	get the TidyReportLevel of the message. More...
TY_PRIVATE int	TY_❪getMessageLine❫ (TidyMessageImpl message)
	get the line number the message applies to. More...
TY_PRIVATE ctmbstr	TY_❪getMessageOutputDefault❫ (TidyMessageImpl message)
	the complete message, as would be output in the CLI More...
TY_PRIVATE ctmbstr	TY_❪getMessageOutput❫ (TidyMessageImpl message)
TY_PRIVATE ctmbstr	TY_❪getMessagePosDefault❫ (TidyMessageImpl message)
	the position part, default language More...
TY_PRIVATE ctmbstr	TY_❪getMessagePos❫ (TidyMessageImpl message)
	the position part, localized More...
TY_PRIVATE ctmbstr	TY_❪getMessagePrefixDefault❫ (TidyMessageImpl message)
	the prefix part, default language More...
TY_PRIVATE ctmbstr	TY_❪getMessagePrefix❫ (TidyMessageImpl message)
	the prefix part, localized More...
TY_PRIVATE ctmbstr	TY_❪getMessage❫ (TidyMessageImpl message)
	the message, formatted, localized More...
TY_PRIVATE TidyMessageArgument	TY_❪getNextMessageArgument❫ (TidyMessageImpl message, TidyIterator *iter)
	Returns the next TidyMessageArgument, for the given message, which can then be interrogated with the API, and advances the iterator. More...
TY_PRIVATE TidyMessageImpl *	TY_❪tidyMessageCreateWithLexer❫ (TidyDocImpl *doc, uint code, TidyReportLevel level,...)
	Creates a TidyMessageImpl, using the line and column from the provided document's Lexer as the message position source. More...
TY_PRIVATE TidyMessageImpl *	TY_❪tidyMessageCreateWithNode❫ (TidyDocImpl *doc, Node *node, uint code, TidyReportLevel level,...)
	Creates a TidyMessageImpl, using the line and column from the provided Node as the message position source. More...
TY_PRIVATE TidyMessageImpl *	TY_❪tidyMessageCreate❫ (TidyDocImpl *doc, uint code, TidyReportLevel level,...)
	Creates a TidyMessageImpl, but without line numbers, such as used for information report output. More...
TY_PRIVATE void	TY_❪tidyMessageRelease❫ (TidyMessageImpl *message)
	Deallocates a TidyMessageImpl in order to free up its allocated memory when you're done using it. More...