emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
975 commits 6 branches 8 tags 6.6 MiB
C 48.7%
Gettext Catalog 23.9%
HTML 21.8%
C++ 3.1%
Ruby 1.7%
Other 0.7%
Go to file
Jim Derry 11178d775b Massive Revamp of the Messaging System 
This is a rather large refactoring of Tidy's messaging system. This was done
mostly to allow non-C libraries that cannot adequately take advantage of
arg_lists a chance to query report filter information for information related
to arguments used in constructing an error message.

Three main goals were in mind for this project:

- Don't change the contents of Tidy's existing output sinks. This will ensure
  that changes do no affect console Tidy users, or LibTidy users who use the
  output sinks directly. This was accomplished 100% other than some improved
  cosmetics in the output. See tidy-html5-tests repository, the `refactor` and
  `more_messages_changes` branches for these minor diffs.
- Provide an API that is simple and also extensible without having to write new
  error filters all the time. This was accomplished by adding the new message
  callback `TidyMessageCallback` that provides callback functions an opaque
  object representing the message, and an API to query the message for wanted
  details. With this, we should never have to add a new callback routine again,
  as additional API can simply be written against the opaque object.
- The API should work the same as the rest of LibTidy's API in that it's
  consistent and only uses simple types with wide interoperability with other
  languages. Thanks to @gagern who suggested the model for the API in #409.
  Although the API uses the "Tidy" way off accessing data via an iterator
  rather than an index, this can be easily abstracted in the target language.

There are two *major* API breaking changes:

- Removed TidyReportFilter2
  - This was only used by one application in the entire world, and was a hacky
    kludge that served its purpose. TidyReportCallback (né TidyReportFilter3)
    is much better. If, for some reason, this affects you, I recommend using
    TidyReportCallback instead. It's a minor change for your application.
- Renamed TidyReportFilter3 to TidyReportCallback
  - This name is much more semantic, and much more sensible in light of
    improved callback system. As the name implies, it remains capable of
    *only* receiving callbacks for Tidy "reports."

Introducing TidyMessageCallback, and a new message interrogation API.

- As its name implies, it is able to capture (and optionally suppress) *all*
  of Tidy's output, including the dialogue messages that never make it to
  the existing report filters.
- Provides an opaque `TidyMessage` and an API that can be used to query against
  it to find the juicy goodness inside.
  - For example, `tidyGetMessageOutput( tmessage )` will return the complete,
    localized message.
  - Another example, `tidyGetMessageLine( tmessage )` will return the line the
    message applies to.
- You can also get information about the individual arguments that make up a
  message. By using the `tidyGetMessageArguments( tmessage )` itorator and
  `tidyGetNextMessageArgument` you will obtain an opaque `TidyMessageArgument`
  which has its own interrogation API. For example:
    - tidyGetArgType( tmessage, &iterator );
    - tidyGetArgFormat( tmessage, &iterator );
    - tidyGetArgValueString( tmessage, &iterator );
    - …and so on.

Other major changes include refactoring `messages.c` to use the new message
"object" directly when emitting messages to the console or output sinks. This
allowed replacement of a lot of specialized functions with generalized ones.

Some of this generalizing involved modifications to the `language_xx.h` header
files, and these are all positive improvements even without the above changes.
2017-03-13 13:28:57 -04:00
build ignore msvc140 *.VC.db 2017-03-05 16:27:19 +01:00
console Massive Revamp of the Messaging System 2017-03-13 13:28:57 -04:00
experimental style: ansi conforming comments 2016-12-20 16:51:09 +11:00
include Massive Revamp of the Messaging System 2017-03-13 13:28:57 -04:00
localize Bump version to 5.5.5 for this fiasco, and fix poor planning and unfortunate 2017-03-10 09:13:21 -05:00
man Merge documentation of "command-line" and "configuration" options (Issue #469) (#473) 2017-01-08 18:19:36 +01:00
README Corrected description of pointer operator-macro order. 2017-03-03 07:17:28 -05:00
src Massive Revamp of the Messaging System 2017-03-13 13:28:57 -04:00
.gitignore Remove /test/ from the repository. Regression testing is still very important, and so 2016-02-16 11:20:22 +08:00
CMakeLists.txt Massive Revamp of the Messaging System 2017-03-13 13:28:57 -04:00
README.md Update README documents with information for the upcoming 5.4.0 release. 2017-02-24 14:30:42 -05:00
version.txt Bump version to 5.5.5 for this fiasco, and fix poor planning and unfortunate 2017-03-10 09:13:21 -05:00

README.md

HTACG HTML Tidy

All other READMEs and related materials can be found in README/. Although all of our materials should be linked in this README, be sure to check this directory for documents we’ve not yet added to this document.

Building HTML Tidy

Branches and Versions

Learn about which branches are available, which branch you should use, and how HTML Tidy’s versioning scheme works.

Contributing and Development Guides

We gladly accept PRs! Read about some of our contribution guidelines, and check out some of the additional explanatory documents that will aid your understanding of how to accomplish certain things in HTML Tidy.

General Contribution Guidelines

These are some general guidelines that will help you help us when it comes to making your own contributions to HTML Tidy.

Adding Features Guides

When you’re ready to add a great new feature, these write-ups may be useful.

Language Localization Guides

Tidy supports localization, and welcomes translations into various languages. Please read up on how to localize HTML Tidy.

Other Important Links

History

This repository should be considered canonical for HTML Tidy as of 2015-January-15.

  • This repository originally transferred from w3c.github.com/tidy-html5, now redirected to the current site.

  • First moved to Github from tidy.sourceforge.net. Note, this site is kept only for historic reasons, and is not now well maintained.

Tidy is the granddaddy of HTML tools, with support for modern standards. Have fun...

License

HTML Tidy and LibTidy are free and open source software with a permissive license.