/* This file is part of the KDE libraries Copyright (C) 1997 Martin Jones (mjones@kde.org) (C) 1997 Torben Weis (weis@kde.org) (C) 1998 Waldo Bastian (bastian@kde.org) (C) 2001 Dirk Mueller (mueller@kde.org) Copyright (C) 2003 Apple Computer, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ //---------------------------------------------------------------------------- // // KDE HTML Widget -- Tokenizers #ifndef HTMLTOKENIZER_H #define HTMLTOKENIZER_H #include <qstring.h> #include <qobject.h> #include <qptrqueue.h> #include "misc/loader_client.h" #include "misc/htmltags.h" #include "xml/dom_stringimpl.h" #include "xml/xml_tokenizer.h" #include "html/html_elementimpl.h" #include "xml/dom_docimpl.h" #if APPLE_CHANGES #ifdef __OBJC__ #define id id_AVOID_KEYWORD #endif #endif class KCharsets; class KHTMLParser; class KHTMLView; namespace DOM { class DocumentPtr; class DocumentFragmentImpl; } namespace khtml { class CachedScript; /** * @internal * represents one HTML tag. Consists of a numerical id, and the list * of attributes. Can also represent text. In this case the id = 0 and * text contains the text. */ class Token { public: Token() { id = 0; attrs = 0; text = 0; flat = false; //qDebug("new token, creating %08lx", attrs); } ~Token() { if(attrs) attrs->deref(); if(text) text->deref(); } void addAttribute(DOM::DocumentImpl* doc, QChar* buffer, const QString& attrName, const DOM::AtomicString& v) { DOM::AttributeImpl* a = 0; if(buffer->unicode()) a = new DOM::HTMLAttributeImpl(buffer->unicode(), v); else if ( !attrName.isEmpty() && attrName != "/" ) a = new DOM::HTMLAttributeImpl(doc->attrId(0, DOM::DOMString(attrName).implementation(), false), v); if (a) { if(!attrs) { attrs = new DOM::HTMLNamedAttrMapImpl(0); attrs->ref(); } attrs->insertAttribute(a); } } void reset() { if(attrs) { attrs->deref(); attrs = 0; } id = 0; if(text) { text->deref(); text = 0; } flat = false; } DOM::HTMLNamedAttrMapImpl* attrs; DOM::DOMStringImpl* text; ushort id; bool flat; }; // The count of spaces used for each tab. #define TAB_SIZE 8 //----------------------------------------------------------------------------- class HTMLTokenizer : public Tokenizer, public CachedObjectClient { public: HTMLTokenizer(DOM::DocumentPtr *, KHTMLView * = 0); HTMLTokenizer(DOM::DocumentPtr *, DOM::DocumentFragmentImpl *frag); virtual ~HTMLTokenizer(); void begin(); void write(const TokenizerString &str, bool appendData); void end(); void finish(); virtual void setOnHold(bool _onHold); protected: void reset(); void addPending(); void processToken(); void processListing(TokenizerString list); void parseComment(TokenizerString &str); void parseServer(TokenizerString &str); void parseText(TokenizerString &str); void parseListing(TokenizerString &str); void parseSpecial(TokenizerString &str); void parseTag(TokenizerString &str); void parseEntity(TokenizerString &str, QChar *&dest, bool start = false); void parseProcessingInstruction(TokenizerString &str); void scriptHandler(); void scriptExecution(const QString& script, QString scriptURL = QString(), int baseLine = 0); void setSrc(const TokenizerString &source); // check if we have enough space in the buffer. // if not enlarge it inline void checkBuffer(int len = 10) { if ( (dest - buffer) > size-len ) enlargeBuffer(len); } inline void checkScriptBuffer(int len = 10) { if ( scriptCodeSize + len >= scriptCodeMaxSize ) enlargeScriptBuffer(len); } void enlargeBuffer(int len); void enlargeScriptBuffer(int len); // from CachedObjectClient void notifyFinished(CachedObject *finishedObj); virtual bool isWaitingForScripts(); protected: // Internal buffers /////////////////// QChar *buffer; QChar *dest; Token currToken; // the size of buffer int size; // Tokenizer flags ////////////////// // are we in quotes within a html tag enum { NoQuote = 0, SingleQuote, DoubleQuote } tquote; enum { NonePending = 0, SpacePending, LFPending, TabPending } pending; // Discard line breaks immediately after start-tags // Discard spaces after '=' within tags enum { NoneDiscard = 0, SpaceDiscard, LFDiscard, AllDiscard // discard all spaces, LF's etc until next non white char } discard; // Discard the LF part of CRLF sequence bool skipLF; // Flag to say that we have the '<' but not the character following it. bool startTag; // Flag to say, we are just parsing a tag, meaning, we are in the middle // of <tag... enum { NoTag = 0, TagName, SearchAttribute, AttributeName, SearchEqual, SearchValue, QuotedValue, Value, SearchEnd } tag; // Are we in a &... character entity description? enum { NoEntity = 0, SearchEntity, NumericSearch, Hexadecimal, Decimal, EntityName, SearchSemicolon } Entity; unsigned EntityUnicodeValue; // are we in a <script> ... </script block bool script; // Are we in a <pre> ... </pre> block bool pre; // if 'pre == true' we track in which column we are int prePos; // Are we in a <style> ... </style> block bool style; // Are we in a <select> ... </select> block bool select; // Are we in a <xmp> ... </xmp> block bool xmp; // Are we in a <title> ... </title> block bool title; // Are we in plain textmode ? bool plaintext; // XML processing instructions. Ignored at the moment bool processingInstruction; // Area we in a <!-- comment --> block bool comment; // Are we in a <textarea> ... </textarea> block bool textarea; // was the previous character escaped ? bool escaped; // are we in a server includes statement? bool server; bool brokenServer; // name of an unknown attribute QString attrName; // whether or not the attrname is present (either we found a known HTML attr or we found an unknown // nonempty attrName). bool attrNamePresent; // Used to store the code of a srcipting sequence QChar *scriptCode; // Size of the script sequenze stored in @ref #scriptCode int scriptCodeSize; // Maximal size that can be stored in @ref #scriptCode int scriptCodeMaxSize; // resync point of script code size int scriptCodeResync; // Stores characters if we are scanning for a string like "</script>" QChar searchBuffer[ 10 ]; // Counts where we are in the string we are scanning for int searchCount; // The string we are searching for const QChar *searchFor; // the stopper string const char* searchStopper; // the stopper len int searchStopperLen; // true if we are waiting for an external script (<SCRIPT SRC=...) to load, i.e. // we don't do any parsing while this is true bool loadingExtScript; // if no more data is coming, just parse what we have (including ext scripts that // may be still downloading) and finish bool noMoreData; // URL to get source code of script from QString scriptSrc; QString scriptSrcCharset; bool javascript; // the HTML code we will parse after the external script we are waiting for has loaded TokenizerString pendingSrc; // true if we are executing a script while parsing a document. This causes the parsing of // the output of the script to be postponed until after the script has finished executing int m_executingScript; QPtrQueue<CachedScript> cachedScript; // you can pause the tokenizer if you need to display a dialog or something bool onHold; // if we found one broken comment, there are most likely others as well // store a flag to get rid of the O(n^2) behaviour in such a case. bool brokenComments; // current line number int lineno; // line number at which the current <script> started int scriptStartLineno; int tagStartLineno; // This buffer can hold arbitrarily long user-defined attribute names, such as in EMBED tags. // So any fixed number might be too small, but rather than rewriting all usage of this buffer // we'll just make it large enough to handle all imaginable cases. #define CBUFLEN 1024 char cBuffer[CBUFLEN+2]; unsigned int cBufferPos; TokenizerString src; KCharsets *charsets; KHTMLParser *parser; KHTMLView *view; #ifndef NDEBUG bool inWrite; #endif }; } #if APPLE_CHANGES #undef id #endif #endif // HTMLTOKENIZER