Separated public enumerations header providing important indentifiers for LibTidy and internal users, as well as code-generator macros used to generate many of them.
Configuration Options Pick List and Parser Enumerations | |
These enums define enumerated states for the configuration options that take values that are not simple yes/no, strings, or simple integers. | |
enum | TidyTriState { TidyNoState = 0 , TidyYesState , TidyAutoState } |
AutoBool values used by ParseBool, ParseTriState, ParseIndent, ParseBOM. More... | |
enum | TidyUseCustomTagsState { TidyCustomNo = 0 , TidyCustomBlocklevel , TidyCustomEmpty , TidyCustomInline , TidyCustomPre } |
Values used by ParseUseCustomTags, which describes how Autonomous Custom tags (ACT's) found by Tidy are treated. More... | |
enum | TidyLineEnding { TidyLF = 0 , TidyCRLF , TidyCR } |
TidyNewline option values to control output line endings. More... | |
enum | TidyEncodingOptions { TidyEncRaw = 0 , TidyEncAscii , TidyEncLatin0 , TidyEncLatin1 , TidyEncUtf8 , TidyEncIso2022 , TidyEncMac , TidyEncWin1252 , TidyEncIbm858 , TidyEncUtf16le , TidyEncUtf16be , TidyEncUtf16 , TidyEncBig5 , TidyEncShiftjis } |
TidyEncodingOptions option values specify the input and/or output encoding. More... | |
enum | TidyDoctypeModes { TidyDoctypeHtml5 = 0 , TidyDoctypeOmit , TidyDoctypeAuto , TidyDoctypeStrict , TidyDoctypeLoose , TidyDoctypeUser } |
Mode controlling treatment of doctype. More... | |
enum | TidyDupAttrModes { TidyKeepFirst = 0 , TidyKeepLast } |
Mode controlling treatment of duplicate Attributes. More... | |
enum | TidyAttrSortStrategy { TidySortAttrNone = 0 , TidySortAttrAlpha } |
Mode controlling treatment of sorting attributes. More... | |
enum | TidyUppercase { TidyUppercaseNo = 0 , TidyUppercaseYes , TidyUppercasePreserve } |
Mode controlling capitalization of things, such as attributes. More... | |
I/O and Message Handling Interface | |
Messages used throughout LibTidy and exposed to the public API have attributes which are communicated with these enumerations. | |
enum | TidyReportLevel { TidyInfo = 350 , TidyWarning , TidyConfig , TidyAccess , TidyError , TidyBadDocument , TidyFatal , TidyDialogueSummary , TidyDialogueInfo , TidyDialogueFootnote , TidyDialogueDoc = TidyDialogueFootnote } |
Message severity level, used throughout LibTidy to indicate the severity or status of a message. More... | |
enum | TidyFormatParameterType { tidyFormatType_INT = 0 , tidyFormatType_UINT , tidyFormatType_STRING , tidyFormatType_DOUBLE , tidyFormatType_UNKNOWN = 20 } |
Indicates the data type of a format string parameter used when Tidy emits reports and dialogue as part of the messaging callback functions. More... | |
Messages | |
enum | tidyStrings { TIDYSTRINGS_FIRST = 500 , MAKE_ENUM =(TidyDiagnostics) MAKE_ENUM (TidyDisplay) MAKE_ENUM (TidyDocumentIO) MAKE_ENUM (TidyEncoding) MAKE_ENUM (TidyFileIO) MAKE_ENUM (TidyMarkupCleanup) MAKE_ENUM (TidyMarkupEntities) MAKE_ENUM (TidyMarkupRepair) MAKE_ENUM (TidyMarkupTeach) MAKE_ENUM (TidyMarkupXForm) MAKE_ENUM (TidyPrettyPrint) MAKE_ENUM (TidyInternalCategory) , MAKE_ENUM =(TidyDiagnostics) MAKE_ENUM (TidyDisplay) MAKE_ENUM (TidyDocumentIO) MAKE_ENUM (TidyEncoding) MAKE_ENUM (TidyFileIO) MAKE_ENUM (TidyMarkupCleanup) MAKE_ENUM (TidyMarkupEntities) MAKE_ENUM (TidyMarkupRepair) MAKE_ENUM (TidyMarkupTeach) MAKE_ENUM (TidyMarkupXForm) MAKE_ENUM (TidyPrettyPrint) MAKE_ENUM (TidyInternalCategory) , MAKE_ENUM =(TidyDiagnostics) MAKE_ENUM (TidyDisplay) MAKE_ENUM (TidyDocumentIO) MAKE_ENUM (TidyEncoding) MAKE_ENUM (TidyFileIO) MAKE_ENUM (TidyMarkupCleanup) MAKE_ENUM (TidyMarkupEntities) MAKE_ENUM (TidyMarkupRepair) MAKE_ENUM (TidyMarkupTeach) MAKE_ENUM (TidyMarkupXForm) MAKE_ENUM (TidyPrettyPrint) MAKE_ENUM (TidyInternalCategory) } |
The enumeration contains a list of every possible string that Tidy and the console application can output, except for strings from the following enumerations: More... | |
enum TidyAttrId |
Known HTML attributes.
enum TidyAttrSortStrategy |
enum TidyConfigCategory |
Categories of Tidy configuration options, which are used mostly by user interfaces to sort Tidy options into related groups.
config.c:option_defs[]
for internal implementation details. enum TidyDoctypeModes |
Mode controlling treatment of doctype.
enum TidyDupAttrModes |
enum TidyEncodingOptions |
TidyEncodingOptions option values specify the input and/or output encoding.
Enumerator | |
---|---|
TidyEncRaw | |
TidyEncAscii | |
TidyEncLatin0 | |
TidyEncLatin1 | |
TidyEncUtf8 | |
TidyEncIso2022 | |
TidyEncMac | |
TidyEncWin1252 | |
TidyEncIbm858 | |
TidyEncUtf16le | |
TidyEncUtf16be | |
TidyEncUtf16 | |
TidyEncBig5 | |
TidyEncShiftjis |
Indicates the data type of a format string parameter used when Tidy emits reports and dialogue as part of the messaging callback functions.
See messageobj.h
for more information on this API.
enum TidyLineEnding |
enum TidyNodeType |
Node types.
enum TidyOptionId |
Option IDs are used used to get and/or set configuration option values and retrieve their descriptions.
config.c:option_defs[]
for internal implementation details; that array is where you will implement options defined in this enum; and it's important to add a string describing the option to language_en.h
, too. enum TidyOptionType |
enum TidyReportLevel |
Message severity level, used throughout LibTidy to indicate the severity or status of a message.
enum tidyStrings |
The enumeration contains a list of every possible string that Tidy and the console application can output, except for strings from the following enumerations:
TidyOptionId
TidyConfigCategory
TidyReportLevel
They are used as keys internally within Tidy, and have corresponding text keys that are used in message callback filters (these are defined in tidyStringsKeys[]
, but API users don't require access to it directly).
enum TidyTagId |
Known HTML element types.
enum TidyTriState |
enum TidyUppercase |
Values used by ParseUseCustomTags, which describes how Autonomous Custom tags (ACT's) found by Tidy are treated.