A CSS parsing library in pure C99
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Katana - A pure-C CSS parser.

Katana is an implementation of the CSS (Cascading Style Sheet) parsing algorithm implemented as a pure C library with no outside dependencies. It's designed to serve as a building block for other tools and libraries such as linters, validators, templating languages, and refactoring and analysis tools.

Katana is inspired by Gumbo, so it has some goals and features same as Gumbo.

Goals & features:

  • Simple API that can be easily wrapped by other languages.
  • Relatively lightweight, with no outside dependencies.
  • Support for fragment parsing.

Non-goals:

  • Mutability. Katana is intentionally designed to turn a style sheet into a parse tree, and free that parse tree all at once. It's not designed to persistently store nodes or subtrees outside of the parse tree, or to perform arbitrary style mutations within your program. If you need this functionality, we recommend translating the Katana parse tree into a mutable style representation more suited for the particular needs of your program before operating on it.

Wishlist:

  • Fully conformant with the CSS-syntax.
  • Hackable dump or print.
  • Robust and resilient to bad input.
  • Full-featured error reporting.
  • Additional performance improvements.
  • Tested on Official W3C Test Suites.

Installation

To build and install the library, issue the standard UNIX incantation from the root of the distribution:

$ ./autogen.sh
$ ./configure CFLAGS="-std=c99"
$ make
$ sudo make install

Katana comes with full pkg-config support, so you can use the pkg-config to print the flags needed to link your program against it:

$ pkg-config --cflags katana         # print compiler flags
$ pkg-config --libs katana           # print linker flags
$ pkg-config --cflags --libs katana  # print both

For example:

$ gcc examples/dump_stylesheet.c `pkg-config --cflags --libs katana` -o dump

If package katana was not found in the pkg-config search path, perhaps you should add the directory containing katana.pc to the PKG_CONFIG_PATH environment variable as following:

$ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig

See the pkg-config man page for more info.

Basic Usage

Within your program, you need to include "katana.h" and then issue a call to katana_parse:

#include "katana.h"

int main() {
  const char* css = "selector { property: value }";
  KatanaOutput* output = katana_parse(css, strlen(css), KatanaParserModeStylesheet);
  // Do stuff with output, eg. print the input style
  katana_dump_output(output);
  katana_destroy_output(output);
}

See the API documentation and sample programs for more details.

Contributing

Bug reports are very much welcome. Please use GitHub's issue-tracking feature, as it makes it easier to keep track of bugs and makes it possible for other project watchers to view the existing issues.

Patches and pull requests are also welcome.

If you're unwilling to do this, it would be most helpful if you could file bug reports that include detailed prose about where in the code the error is and how to fix it, but leave out exact source code.