Click here to Skip to main content
11,923,046 members (64,288 online)
Click here to Skip to main content
Add your own
alternative version


95 bookmarked

Fast and Compact HTML/XML Scanner/Tokenizer

, 10 Oct 2007 BSD
Rate this:
Please Sign up or sign in to vote.
HTML/XML scanner/tokenizer, also known as a pull parser


The proposed code is an implementation of an HTML and XML scanner (or tokenizer). Imagine that you have some XML or HTML text and you just need to find some word, tag or attribute in it. For such trivial tasks, the use of a full-blown "DOM compiler" or SAX alike parser is too much. It is enough to use the markup::scanner described below. Features of markup::scanner include:

  1. It does not allocate any memory while scanning, at all.
  2. It is written in pure C++ and does not require STL or any other toolkit/library.
  3. It is fast. We managed to reach a speed of scanning nearly 40 MB of XML per second (depends on the hardware you have, of course).
  4. It is simple.

How to Use

I think the best way to explain is to show an example. First, we need to declare the input stream for the scanner. Here is an example of a simple string-based stream:

struct str_istream: public markup::instream
    const char* p;
    const char* end; 
    str_istream(const char* src): p(src), end(src + strlen(src)) {}
    virtual wchar_t get_char() { return p < end? *p++: 0; }

This is all that we need in order to write the program which will, let's say, print out all of the tokens in the input HTML:

int main(int argc, char* argv[])
    str_istream si("<html><body><p align=right" 
        " dir='rtl'> Begin &amp; back </p>" "</body></html>");
    markup::scanner sc(si);
    bool in_text = false;
        int t = sc.get_token();
            case markup::scanner::TT_ERROR:
            case markup::scanner::TT_EOF:
                goto FINISH;
            case markup::scanner::TT_TAG_START:
                printf("TAG START:%s\n", sc.get_tag_name());
            case markup::scanner::TT_TAG_END:
                printf("TAG END:%s\n", sc.get_tag_name());
            case markup::scanner::TT_ATTR:
                printf("\tATTR:%s=%S\n", sc.get_attr_name(), sc.get_value());
            case markup::scanner::TT_WORD: 
                case markup::scanner::TT_SPACE:
                    printf("{%S}\n", sc.get_value());
        return 0;

As you may see, the main method doing the job here is markup::scanner::get_token(). It scans the input stream and returns the value of markup::scanner::token_type.

enum token_type 
    TT_ERROR = -1,
    TT_EOF = 0,

    TT_TAG_START,   // <tag ...
                    //     ^-- happens here
    TT_TAG_END,     // </tag>
                    //       ^-- happens here 
                    // <tag ... />
                    //            ^-- or here 
    TT_ATTR,        // <tag attr="value" >      
                    //                  ^-- happens here   

    TT_DATA,        // content of following:

    TT_COMMENT_START, TT_COMMENT_END, // after "<!--" and "-->"
    TT_CDATA_START, TT_CDATA_END,     // after "<![CDATA[" and "]]>"
    TT_PI_START, TT_PI_END,           // after "<?" and "?>"
    TT_ENTITY_START, TT_ENTITY_END,   // after "<!ENTITY" and ">"

According to the value of the token, you can use get_tag_name(), get_value() or get_attr_name() to retrieve the needed information. This is pretty much all you need in order to be able to scan HTML/XML..

In Closing

The given scanner does not address any input stream encoding problems. XML and HTML are dealt with differently with this. A general idea for the cases where you don't know the input encoding up front: your input stream should be smart enough to be able to switch the encoding of the input on the fly. The given scanner was initially created as part of the HTMLayout SDK: a lightweight embeddable HTML rendering component.


  • 11 May 2006 - Initial version
  • 12 May 2006 - Article moved
  • 09 June 2006 - Bug fixes and a new VS 2005 project
  • 10 October 2007 - Download updated (bug fixes)


This article, along with any associated source code and files, is licensed under The BSD License


About the Author

Founder Terra Informatica Software
Canada Canada
Andrew Fedoniouk.

MS in Physics and Applied Mathematics.
Designing software applications and systems since 1991.

W3C HTML5 Working Group, Invited Expert.

Terra Informatica Software, Inc.

You may also be interested in...

Comments and Discussions

NewsReused this great library Pin
Member 824907219-Sep-11 4:47
memberMember 824907219-Sep-11 4:47 
GeneralRe: Reused this great library Pin
c-smile19-Sep-11 18:46
memberc-smile19-Sep-11 18:46 
Questionunresolved external symbol Pin
supermegapup8-Aug-11 7:58
membersupermegapup8-Aug-11 7:58 
AnswerRe: unresolved external symbol Pin
c-smile8-Aug-11 17:06
memberc-smile8-Aug-11 17:06 
GeneralEncoding UTF-8 Pin
Joakim O'Nils4-Sep-08 22:51
memberJoakim O'Nils4-Sep-08 22:51 
GeneralRe: Encoding UTF-8 Pin
c-smile11-Sep-08 17:42
memberc-smile11-Sep-08 17:42 
GeneralEncoding advise Pin
_Stilgar_13-Dec-07 7:12
member_Stilgar_13-Dec-07 7:12 
GeneralRe: Encoding advise Pin
c-smile15-Jan-09 12:56
memberc-smile15-Jan-09 12:56 
GeneralRe: Encoding advise Pin
ohad-oz12-Jul-10 15:37
memberohad-oz12-Jul-10 15:37 
GeneralRe: Encoding advise Pin
codcode11-Mar-14 12:02
membercodcode11-Mar-14 12:02 
GeneralUTF-8 input stream Pin
c-smile12-Apr-14 20:56
memberc-smile12-Apr-14 20:56 
GeneralThoughts on DOCTYPE ... Pin
Jerry Evans4-Nov-07 7:00
memberJerry Evans4-Nov-07 7:00 
GeneralRe: Thoughts on DOCTYPE ... Pin
c-smile4-Nov-07 10:39
memberc-smile4-Nov-07 10:39 
GeneralRe: Thoughts on DOCTYPE ... Pin
Jerry Evans4-Nov-07 14:54
memberJerry Evans4-Nov-07 14:54 
GeneralRe: Thoughts on DOCTYPE ... Pin
c-smile4-Nov-07 17:32
memberc-smile4-Nov-07 17:32 
GeneralRe: Thoughts on DOCTYPE ... Pin
Jerry Evans5-Nov-07 2:24
memberJerry Evans5-Nov-07 2:24 
GeneralRe: Thoughts on DOCTYPE ... Pin
Jerry Evans5-Nov-07 2:36
memberJerry Evans5-Nov-07 2:36 
GeneralRe: Thoughts on DOCTYPE ... Pin
c-smile5-Nov-07 17:26
memberc-smile5-Nov-07 17:26 
GeneralExtremely useful. Pin
Jerry Evans12-Oct-07 13:21
memberJerry Evans12-Oct-07 13:21 
GeneralRe: Extremely useful. Pin
c-smile12-Oct-07 13:37
memberc-smile12-Oct-07 13:37 
GeneralURL of latest source code Pin
c-smile7-Oct-07 22:18
memberc-smile7-Oct-07 22:18 
Generalnuther bug [modified] Pin
dr3d4-Jul-07 21:10
memberdr3d4-Jul-07 21:10 
GeneralRe: nuther bug [modified] Pin
c-smile6-Oct-07 19:19
memberc-smile6-Oct-07 19:19 
QuestionNested tags Pin
Nulleh28-Oct-06 19:10
memberNulleh28-Oct-06 19:10 
AnswerRe: Nested tags Pin
c-smile28-Oct-06 21:39
memberc-smile28-Oct-06 21:39 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.151125.3 | Last Updated 10 Oct 2007
Article Copyright 2006 by c-smile
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid