HTML Tidy  5.6.0
The HTACG Tidy HTML Project
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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
Date
Created 2017-March-10

Go to the source code of this file.

Functions

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