Cleanup

- Added doxygen documentation to `tags.h`
- Consistency to `tags.c` header.
- Moved TY_(DeclareUserTag) to tags.c/.h for consistency with the other list
  parsing declaratory functions.
- Merged user tags parsing into the general list, eliminating a lot of redundant
  code.

Author: balthisar

include/tidy.h

@@ -584,7 +584,7 @@ TIDY_EXPORT Bool TIDY_CALL          tidySetOptionCallback(TidyDoc tdoc,
                                                           );
 
 /** This typedef represents the required signature for your provided callback
- ** function should you wish to register one with tidySetOptionCallback().
+ ** function should you wish to register one with tidySetConfigCallback().
  ** Your callback function will be provided with the following parameters.
  ** @param tdoc The document instance for which the callback was invoked.
  ** @param option The option name that was provided.
@@ -599,14 +599,33 @@ typedef Bool (TIDY_CALL *TidyConfigCallback)(TidyDoc tdoc, ctmbstr option, ctmbs
  ** configuration file options. Setting this callback allows a LibTidy
  ** application developer to examine command-line and configuration file options
  ** after LibTidy has examined them and failed to recognize them.
- ** Note that this is deprecated and you should instead migrate to
- ** tidySetConfigCallback().
  ** @result Returns `yes` upon success.
  */
 TIDY_EXPORT Bool TIDY_CALL          tidySetConfigCallback(TidyDoc tdoc,                      /**< The document to apply the callback to. */
                                                           TidyConfigCallback pConfigCallback /**< The name of a function of type TidyConfigCallback() to serve as your callback. */
                                                           );
 
+    
+/** This typedef represents the required signature for your provided callback
+ ** function should you wish to register one with tidySetConfigChangeCallback().
+ ** Your callback function will be provided with the following parameters.
+ ** @param tdoc The document instance for which the callback was invoked.
+ ** @param option The option that will be changed.
+ */
+typedef void (TIDY_CALL *TidyConfigChangeCallback)(TidyDoc tdoc, TidyOption option);
+
+/** Applications using TidyLib may want to be informed when changes to options
+ ** are made. Temporary changes made internally by Tidy are not reported, but
+ ** permanent changes made by Tidy (such as indent-spaces or output-encoding)
+ ** will be reported.
+ ** @note This callback is not currently implemented.
+ ** @result Returns `yes` upon success.
+ */
+TIDY_EXPORT Bool TIDY_CALL          tidySetConfigChangeCallback(TidyDoc tdoc,                      /**< The document to apply the callback to. */
+                                                                TidyConfigChangeCallback pCallback /**< The name of a function of type TidyConfigChangeCallback() to serve as your callback. */
+                                                                );
+
+
 /** @}
  ** @name Option ID Discovery
  ** @{

src/attrs.c

@@ -2186,8 +2186,6 @@ static
 AttVal *SortAttVal( TidyDocImpl* doc, AttVal *list, TidyAttrSortStrategy strat)
 {
     /* Get the list from the passed-in tidyDoc. */
-//    ctmbstr* priorityList = (ctmbstr*)doc->attribs.priorityAttribs.list;
-//    ctmbstr priorityList[] = { "id", NULL };
     ctmbstr* priorityList = (ctmbstr*)doc->attribs.priorityAttribs.list;
 
     ptAttValComparator ptComparator = GetAttValComparator(strat, priorityList);

src/config.c

@@ -157,7 +157,6 @@ static ParseProperty ParseList;
 static ParseProperty ParseName;
 static ParseProperty ParseCSS1Selector;
 static ParseProperty ParseString;
-static ParseProperty ParseTagNames;
 static ParseProperty ParseCharEnc;
 static ParseProperty ParseDocType;
 static ParseProperty ParseTabs;
@@ -173,13 +172,13 @@ static const TidyOptionImpl option_defs[] =
     { TidyAltText,                 MR, "alt-text",                    ST, 0,               ParseString,       NULL                },
     { TidyAnchorAsName,            MR, "anchor-as-name",              BL, yes,             ParsePickList,     &boolPicks          },
     { TidyAsciiChars,              ME, "ascii-chars",                 BL, no,              ParsePickList,     &boolPicks          },
-    { TidyBlockTags,               MT, "new-blocklevel-tags",         ST, 0,               ParseTagNames,     NULL                },
+    { TidyBlockTags,               MT, "new-blocklevel-tags",         ST, 0,               ParseList,         NULL                },
     { TidyBodyOnly,                DD, "show-body-only",              IN, no,              ParsePickList,     &autoBoolPicks      },
     { TidyBreakBeforeBR,           PP, "break-before-br",             BL, no,              ParsePickList,     &boolPicks          },
     { TidyCharEncoding,            CE, "char-encoding",               IN, UTF8,            ParseCharEnc,      &charEncPicks       },
     { TidyCoerceEndTags,           MR, "coerce-endtags",              BL, yes,             ParsePickList,     &boolPicks          },
     { TidyCSSPrefix,               MR, "css-prefix",                  ST, 0,               ParseCSS1Selector, NULL,           "c" },
-    { TidyCustomTags,              IR, "new-custom-tags",             ST, 0,               ParseTagNames,     NULL                }, /* 20170309 - Issue #119 */
+    { TidyCustomTags,              IR, "new-custom-tags",             ST, 0,               ParseList,         NULL                }, /* 20170309 - Issue #119 */
     { TidyDecorateInferredUL,      MX, "decorate-inferred-ul",        BL, no,              ParsePickList,     &boolPicks          },
     { TidyDoctype,                 DT, "doctype",                     ST, 0,               ParseDocType,      &doctypePicks       },
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
@@ -193,7 +192,7 @@ static const TidyOptionImpl option_defs[] =
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
     { TidyEmacsFile,               IR, "gnu-emacs-file",              ST, 0,               ParseString,       NULL                },
 #endif
-    { TidyEmptyTags,               MT, "new-empty-tags",              ST, 0,               ParseTagNames,     NULL                },
+    { TidyEmptyTags,               MT, "new-empty-tags",              ST, 0,               ParseList,         NULL                },
     { TidyEncloseBlockText,        MR, "enclose-block-text",          BL, no,              ParsePickList,     &boolPicks          },
     { TidyEncloseBodyText,         MR, "enclose-text",                BL, no,              ParsePickList,     &boolPicks          },
     { TidyErrFile,                 IO, "error-file",                  ST, 0,               ParseString,       NULL                },
@@ -211,7 +210,7 @@ static const TidyOptionImpl option_defs[] =
     { TidyIndentCdata,             PP, "indent-cdata",                BL, no,              ParsePickList,     &boolPicks          },
     { TidyIndentContent,           PP, "indent",                      IN, TidyNoState,     ParsePickList,     &autoBoolPicks      },
     { TidyIndentSpaces,            PP, "indent-spaces",               IN, 2,               ParseInt,          NULL                },
-    { TidyInlineTags,              MT, "new-inline-tags",             ST, 0,               ParseTagNames,     NULL                },
+    { TidyInlineTags,              MT, "new-inline-tags",             ST, 0,               ParseList,         NULL                },
     { TidyJoinClasses,             MX, "join-classes",                BL, no,              ParsePickList,     &boolPicks          },
     { TidyJoinStyles,              MX, "join-styles",                 BL, yes,             ParsePickList,     &boolPicks          },
     { TidyKeepFileTimes,           IO, "keep-time",                   BL, no,              ParsePickList,     &boolPicks          },
@@ -234,7 +233,7 @@ static const TidyOptionImpl option_defs[] =
     { TidyOutputBOM,               CE, "output-bom",                  IN, TidyAutoState,   ParsePickList,     &autoBoolPicks      },
     { TidyPPrintTabs,              PP, "indent-with-tabs",            BL, no,              ParseTabs,         &boolPicks          }, /* 20150515 - Issue #108 */
     { TidyPreserveEntities,        ME, "preserve-entities",           BL, no,              ParsePickList,     &boolPicks          },
-    { TidyPreTags,                 MT, "new-pre-tags",                ST, 0,               ParseTagNames,     NULL                },
+    { TidyPreTags,                 MT, "new-pre-tags",                ST, 0,               ParseList,         NULL                },
     { TidyPriorityAttributes,      PP, "priority-attributes",         ST, 0,               ParseList,         NULL                },
     { TidyPunctWrap,               PP, "punctuation-wrap",            BL, no,              ParsePickList,     &boolPicks          },
     { TidyQuiet,                   DD, "quiet",                       BL, no,              ParsePickList,     &boolPicks          },
@@ -292,7 +291,7 @@ static const struct {
     ctmbstr name;                /**< name of the deprecated option */
     TidyOptionId replacementId;  /**< Id of the replacement option, or 0 if none. */
 } deprecatedOptions[] = {
-//    { "show-body-only", TidyBodyOnly },
+/*    { "show-body-only", TidyBodyOnly }, */
     { NULL }
 };
 
@@ -980,7 +979,7 @@ Bool TY_(ParseConfigOption)( TidyDocImpl* doc, ctmbstr optnam, ctmbstr optval )
         if (NULL != doc->pOptCallback)
             status = (*doc->pOptCallback)( optnam, optval );
         if (NULL != doc->pConfigCallback )
-            status = status && (*doc->pConfigCallback)( tidyImplToDoc(doc), optnam, optval );
+        status = status || (*doc->pConfigCallback)( tidyImplToDoc(doc), optnam, optval );
         if (!status && isDeprecated)
             status = subDeprecatedOption( doc, optnam, optval);
         if (!status)
@@ -1195,6 +1194,14 @@ void TY_(DeclareListItem)( TidyDocImpl* doc, const TidyOptionImpl* opt, ctmbstr
             TY_(DefineMutedMessage)( doc, opt, name );
             break;
 
+        case TidyInlineTags:
+        case TidyBlockTags:
+        case TidyEmptyTags:
+        case TidyPreTags:
+        case TidyCustomTags:
+            TY_(DeclareUserTag)( doc, opt, name );
+            break;
+
         default:
             break;
     }
@@ -1438,115 +1445,6 @@ Bool ParseTabs( TidyDocImpl* doc, const TidyOptionImpl* entry )
 }
 
 
-/* Coordinates Config update and Tags data */
-void TY_(DeclareUserTag)( TidyDocImpl* doc, TidyOptionId optId,
-                            UserTagType tagType, ctmbstr name )
-{
-  ctmbstr prvval = cfgStr( doc, optId );
-  tmbstr catval = NULL;
-  ctmbstr theval = name;
-  if ( prvval )
-  {
-    uint len = TY_(tmbstrlen)(name) + TY_(tmbstrlen)(prvval) + 3;
-    catval = TY_(tmbstrndup)( doc->allocator, prvval, len );
-    TY_(tmbstrcat)( catval, ", " );
-    TY_(tmbstrcat)( catval, name );
-    theval = catval;
-  }
-  TY_(DefineTag)( doc, tagType, name );
-  SetOptionValue( doc, optId, theval );
-  if ( catval )
-    TidyDocFree( doc, catval );
-}
-
-
-/* a space or comma separated list of tag names */
-Bool ParseTagNames( TidyDocImpl* doc, const TidyOptionImpl* option )
-{
-    TidyConfigImpl* cfg = &doc->config;
-    tmbchar buf[1024];
-    uint i = 0, nTags = 0;
-    uint c = SkipWhite( cfg );
-    UserTagType ttyp = tagtype_null;
-
-    switch ( option->id )
-    {
-        case TidyInlineTags:  ttyp = tagtype_inline;              break;
-        case TidyBlockTags:   ttyp = tagtype_block;               break;
-        case TidyEmptyTags:   ttyp = tagtype_empty;               break;
-        case TidyPreTags:     ttyp = tagtype_pre;                 break;
-        case TidyCustomTags:  ttyp = cfg(doc, TidyUseCustomTags); break;
-        default:
-            TY_(ReportUnknownOption)( doc, option->name );
-            return no;
-    }
-
-    SetOptionValue( doc, option->id, NULL );
-    TY_(FreeDeclaredTags)( doc, ttyp );
-    cfg->defined_tags |= ttyp;
-
-    do
-    {
-        if (c == ' ' || c == '\t' || c == ',')
-        {
-            c = AdvanceChar( cfg );
-            continue;
-        }
-
-        if ( c == '\r' || c == '\n' )
-        {
-            uint c2 = AdvanceChar( cfg );
-            if ( c == '\r' && c2 == '\n' )
-                c = AdvanceChar( cfg );
-            else
-                c = c2;
-
-            if ( !TY_(IsWhite)(c) )
-            {
-                buf[i] = 0;
-                TY_(UngetChar)( c, cfg->cfgIn );
-                TY_(UngetChar)( '\n', cfg->cfgIn );
-                break;
-            }
-        }
-
-        /*
-        if ( c == '\n' )
-        {
-            c = AdvanceChar( cfg );
-            if ( !TY_(IsWhite)(c) )
-            {
-                buf[i] = 0;
-                TY_(UngetChar)( c, cfg->cfgIn );
-                TY_(UngetChar)( '\n', cfg->cfgIn );
-                break;
-            }
-        }
-        */
-
-        while ( i < sizeof(buf)-2 && c != EndOfStream && !TY_(IsWhite)(c) && c != ',' )
-        {
-            buf[i++] = (tmbchar) c;
-            c = AdvanceChar( cfg );
-        }
-
-        buf[i] = '\0';
-        if (i == 0)          /* Skip empty tag definition.  Possible when */
-            continue;        /* there is a trailing space on the line. */
-            
-        /* add tag to dictionary */
-        TY_(DeclareUserTag)( doc, option->id, ttyp, buf );
-        i = 0;
-        ++nTags;
-    }
-    while ( c != EndOfStream );
-
-    if ( i > 0 )
-      TY_(DeclareUserTag)( doc, option->id, ttyp, buf );
-    return ( nTags > 0 );
-}
-
-
 /* a string including whitespace */
 /* munges whitespace sequences */
 Bool ParseString( TidyDocImpl* doc, const TidyOptionImpl* option )

src/config.h

@@ -366,15 +366,6 @@ ctmbstr TY_(CharEncodingName)( int encoding );
 ctmbstr TY_(CharEncodingOptName)( int encoding );
 
 
-/** Coordinates Config update and Tags data.
- ** @param doc The Tidy document.
- ** @param optId The option ID the tag is intended for.
- ** @param tagType The type of tag (pre, inline, etc.).
- ** @param name The name of the new tag.
- */
-void TY_(DeclareUserTag)( TidyDocImpl* doc, TidyOptionId optId,
-                         uint tagType, ctmbstr name );
-
 /** Coordinates Config update and list data.
  ** @param doc The Tidy document.
  ** @param opt The option the list item is intended for.

src/forward.h

@@ -34,6 +34,7 @@ typedef struct _TidyDocImpl TidyDocImpl;
 struct _TidyMessageImpl;
 typedef struct _TidyMessageImpl TidyMessageImpl;
 
+/* @todo: this name isn't very instructive! */
 struct _Dict;
 typedef struct _Dict Dict;
 

src/tags.c

@@ -1,11 +1,12 @@
-/* tags.c -- recognize HTML tags
-
-  (c) 1998-2008 (W3C) MIT, ERCIM, Keio University
-  See tidy.h for the copyright notice.
-
-  The HTML tags are stored as 8 bit ASCII strings.
-
-*/
+/* tags.c
+ * Recognize HTML tags.
+ *
+ * Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts
+ * Institute of Technology, European Research Consortium for Informatics
+ * and Mathematics, Keio University) and HTACG.
+ *
+ * See tidy.h for the copyright notice.
+ */
 
 #include "tidy-int.h"
 #include "message.h"
@@ -475,6 +476,38 @@ static void declare( TidyDocImpl* doc, TidyTagImpl* tags,
     }
 }
 
+
+/* Coordinates Config update and Tags data */
+void TY_(DeclareUserTag)( TidyDocImpl* doc, const TidyOptionImpl* opt, ctmbstr name )
+{
+    UserTagType tagType;
+
+    switch ( opt->id )
+    {
+        case TidyInlineTags:  tagType = tagtype_inline;              break;
+        case TidyBlockTags:   tagType = tagtype_block;               break;
+        case TidyEmptyTags:   tagType = tagtype_empty;               break;
+        case TidyPreTags:     tagType = tagtype_pre;                 break;
+        case TidyCustomTags:
+        {
+            switch (cfg( doc, TidyUseCustomTags ))
+            {
+                case TidyCustomBlocklevel: tagType = tagtype_block;  break;
+                case TidyCustomEmpty:      tagType = tagtype_empty;  break;
+                case TidyCustomInline:     tagType = tagtype_inline; break;
+                case TidyCustomPre:        tagType = tagtype_pre;    break;
+                default: TY_(ReportUnknownOption)( doc, opt->name ); return;
+            }
+        } break;
+        default:
+        TY_(ReportUnknownOption)( doc, opt->name );
+        return;
+    }
+
+    TY_(DefineTag)( doc, tagType, name );
+}
+
+
 #if defined(ENABLE_DEBUG_LOG)
 void ListElementsPerVersion( uint vers, Bool has )
 {
@@ -526,7 +559,6 @@ void show_have_html5(void)
 /* public interface for finding tag by name */
 Bool TY_(FindTag)( TidyDocImpl* doc, Node *node )
 {
-    TidyUseCustomTagsState configtype = cfg( doc, TidyUseCustomTags );
     const Dict *np = NULL;
 
     if ( cfgBool(doc, TidyXmlTags) )
@@ -545,18 +577,9 @@ Bool TY_(FindTag)( TidyDocImpl* doc, Node *node )
        earlier, although if it's earlier we will complain about it elsewhere. */
     if ( TY_(nodeIsAutonomousCustomTag)( doc, node) )
     {
-        UserTagType type;
-
-        if ( configtype == TidyCustomEmpty )
-            type = tagtype_empty;
-        else if ( configtype == TidyCustomInline )
-            type = tagtype_inline;
-        else if ( configtype == TidyCustomPre )
-            type = tagtype_pre;
-        else
-            type = tagtype_block;
-        
-        TY_(DeclareUserTag)( doc, TidyCustomTags, type, node->element );
+        const TidyOptionImpl* opt = TY_(getOption)( TidyCustomTags );
+
+        TY_(DeclareUserTag)( doc, opt, node->element );
         node->tag = tagsLookup(doc, &doc->tags, node->element);
 
         /* Output a message the first time we encounter an autonomous custom