Smalltalk/X Webserver
Documentation of class 'HTML::HTMLParser':
![[back]](/doc/online/icons/DocsUpArrow.gif){kind=icon}
Class: HTMLParser (in HTML)
Inheritance:
Object | +--HTML::HTMLParser
- Category:
- Net-Documents-HTML-Utilities
- Version:
- rev:
1.126
date: 2024/04/22 17:41:10
- user: stefan
- file: HTML__HTMLParser.st directory: goodies/webServer/htmlTree
- module: stx stc-classLibrary: htmlTree
- user: stefan
Description:
Instances of this class are used to read HTML documents
and build a tree of HTML::Element objects.
Notice:
this is a newer and better version of the (old) parser found in libhtml.
Due to the space limitations at the time, the old parser was written,
the old parser used a much simpler html model (simple linked list),
which is harder to process later.
Please (try to) use this one for new projects.
IMPORTANT:
textScannedSoFar is in the characterEncoding of the input data.
Conversion takes place when a textBlock is finished!
copyright
COPYRIGHT (c) 1996 by Claus Gittinger
All Rights Reserved
This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice. This software may not
be provided or otherwise made available to, or used by, any
other person. No title to or ownership of the software is
hereby transferred.
Class protocol:
initialization-
ampersandEscapes
-
backward compatibility only
** This is an obsolete interface - do not use it (it may vanish in future versions) ** -
elementTypes
-
ElementTypes := nil.
HTMLParser initializeElementTypes
-
initializeElementTypes
-
ElementTypes := nil.
HTMLParser initializeElementTypes
-
mathAmpersandEscapes
-
backward compatibility only
** This is an obsolete interface - do not use it (it may vanish in future versions) **
-
new
-
(comment from inherited method)
return an instance of myself without indexed variables
-
parse: aStringOrStream
-
parse aStringOrStream; answer the parsed document.
For API compatibility with XMLParser
Usage example(s):
self parse:'hello world - this is easy' self parse:'hello < world > - this is easy' self parse:'hello world this is easy' self parse:'hello
worldthis is easy' self parse:'hello
- world
- foo
this is easy' self parse:'
this is easy'
-
parseFile: aFilename
-
self parseFile:'../../doc/online/english/top.html'
-
parseText: aStringOrStream
-
parse aStringOrStream; answer the parsed document
Usage example(s):
self parseText:'hello world - this is easy' self parseText:'hello < world > - this is easy' self parseText:'hello world this is easy' self parseText:'hello
worldthis is easy' self parseText:'hello
- world
- foo
this is easy' self parseText:'
this is easy' self parseText:('../../doc/online/english/TOP.html' asFilename contentsOfEntireFile asString) self parseText:('../../doc/online/english/TOP.html' asFilename readStream) self parseText:('../../doc/online/english/TOP.html' asFilename contentsOfEntireFile asString) self parseText:'Bönnigheim - Startseite Bönnigheim' characterEncoding:#utf8 self parseText:('/Volumes/tmp/ebayParseError.html' asFilename contentsOfEntireFile asString) characterEncoding:#utf8
-
parseText: aStringOrStream characterEncoding: anEncodingString
-
parse aStringOrStream, answer the parsed document.
The encoding of the character set is specified by anEncodingString
(e.g. #utf8 or 'iso8859-1').
Answer the parsed document
Usage example(s):
self parseText:('/tmp/DER-Tour-01.html' asFilename contentsOfEntireFile asString) characterEncoding:#utf8 -
parseText: aStringOrStream characterEncoding: anEncodingString unescapeAttributeValues: unescapeAttributeValuesBoolean
-
parse aStringOrStream, answer the parsed document.
The encoding of the character set is specified by anEncodingString
(e.g. #utf8 or 'iso8859-1').
Answer the parsed document
Usage example(s):
self parseText:('/tmp/DER-Tour-01.html' asFilename contentsOfEntireFile asString) characterEncoding:#utf8
Instance protocol:
accessing-
canonicalTags: aBoolean
-
if true (the default), parsed tags are all converted to lowercase;
if false, they are kept as found in the HTML source
(only set to false for very special aplications)
-
characterEncoding: aString
-
set the character set / ecoding for the following text
-
docType
-
-
validate: aBoolean
-
turn off validation by passing false (which is the default, btw.)
-
validating
-
-
infoMessage: msg
-
emits a warning about some strange scanner/parser error (but non-fatal).
Bad naming; should be called warningMessage, probably
-
initStates
-
see https://html.spec.whatwg.org/multipage/parsing.html#tokenization 13.2.5.72
-
initialize
-
unescapeTextContent := true.
-
addElement: anElement
-
currentElement is the currently open element (eg. <table>);
its parent is on the elementStack.
anElement is an incoming new element start (eg. <tr>).
If anElement is allowed as child of the current element
then
add the new element to it.
if anElement (the new one) can have children, push the previous current element
onto the stack, and make the new element the current element.
otherwise,
leave current element as is.
-
addProcessingInstruction: aProcessingInstruction
-
-
addText: aString
-
self error:'Text after end of html ignored' mayProceed:true.
-
beTagClose
-
-
beTagOpen
-
-
classForType: aTypeSymbol
-
internal interface - return a markup element's class, given a typeSymbol
(such as #b, #pre or #'/pre')
-
elementFor: aString
-
given a marks string (such as 'b', 'pre' or '/pre'),
return a new markup instance
-
elementForTag: tagString attributeNamesAndValues: attrNamesAndValues
-
-
endComment
-
-
endElement: markupTextInclSlash
-
^ self endElement_old:markupTextInclSlash
-
endElementTag: tag
-
wrong nesting; closing tag but not the current element's tag
-
endElement_new: markupTextInclSlash
-
remove the slash
-
endElement_old: markupText
-
self assert:(currentElement mustBeClosed not).
-
endTag
-
-
finishTextBlock
-
finish a scanned textBlock; add it to the markup list
-
inPre
-
return true, if currently in a pre element.
(Do not strip separators of a text block if inside a pre)
-
initializeTagBuffer
-
-
initializeTagBuffer: forTagOpem
-
-
initializeTemporaryBuffer
-
-
parseDOCTYPE: in
-
-
parseMarkup
-
'<' has been detected; parse and return a markup element
-
parseScript: inStreamArg
-
parse the contents of a <script> element
according to: https://www.w3.org/TR/html52/semantics-scripting.html#script-content-restrictions.
Read everything up-to the </script>.
Do not expand ampersand escapes; ignore other markup.
Usage example(s):
self new parseScript:'bla bla bla ' readStream self new parseScript:'bla bla bla ' readStream self new parseScript:'' readStream self new parseScript:'' readStream Illegal: self new parseScript:'bla bla bla