net_instaweb::HtmlWriterFilter Class Reference

Filter that serializes HTML to a Writer stream. More...

#include "html_writer_filter.h"

Inheritance diagram for net_instaweb::HtmlWriterFilter:

Public Member Functions
	HtmlWriterFilter (HtmlParse *html_parse)
void	set_writer (Writer *writer)
virtual void	StartDocument ()
virtual void	EndDocument ()
virtual void	StartElement (HtmlElement *element)
virtual void	EndElement (HtmlElement *element)
virtual void	Cdata (HtmlCdataNode *cdata)
	Called for CDATA blocks (e.g. <![CDATA[foobar]]>)
virtual void	Comment (HtmlCommentNode *comment)
	Called for HTML comments that aren't IE directives (e.g. ).
virtual void	IEDirective (HtmlIEDirectiveNode *directive)
virtual void	Characters (HtmlCharactersNode *characters)
	Called for raw characters between tags.
virtual void	Directive (HtmlDirectiveNode *directive)
	Called for HTML directives (e.g. <!doctype foobar>).
virtual void	Flush ()
virtual void	DetermineEnabled (GoogleString *disabled_reason)
virtual bool	CanModifyUrls ()
	This filter will not change urls.
ScriptUsage	GetScriptUsage () const override
void	set_max_column (int max_column)
void	set_case_fold (bool case_fold)
virtual const char *	Name () const
	The name of this filter – used for logging and debugging.
Public Member Functions inherited from net_instaweb::HtmlFilter
virtual void	RenderDone ()
bool	is_enabled () const
void	set_is_enabled (bool is_enabled)

Protected Member Functions
virtual void	Clear ()
	Clear various variables for rewriting a new html file.
Writer *	writer ()
void	TerminateLazyCloseElement ()
	Terminates the current lazy close element if it is not already terminated.

Additional Inherited Members
Public Types inherited from net_instaweb::HtmlFilter
enum	ScriptUsage { kWillInjectScripts, kMayInjectScripts, kNeverInjectsScripts }
	Describes a filter's relationship with scripts. More...

Detailed Description

Filter that serializes HTML to a Writer stream.

Member Function Documentation

virtual void net_instaweb::HtmlWriterFilter::DetermineEnabled ( GoogleString *  disabled_reason )

virtual

Invoked by rewrite driver where all filters should determine whether they are enabled for this request. The re-writer my optionally set disabled_reason to explain why it disabled itself, which will appear in the debug output.

Implements net_instaweb::HtmlFilter.

virtual void net_instaweb::HtmlWriterFilter::EndDocument ( )

virtual

Note: EndDocument will be called immediately before the last Flush call. (which also means that in the RewriteDriver use it is called before rendering for the last flush window).

Implements net_instaweb::HtmlFilter.

virtual void net_instaweb::HtmlWriterFilter::Flush ( )

virtual

Notifies the Filter that a flush is occurring. A filter that's generating streamed output should flush at this time. A filter that's mutating elements can mutate any element seen since the most recent flush; once an element is flushed it is already on the wire to its destination and it's too late to mutate. Flush is initiated by an application calling HttpParse::Flush().

Flush() is called after all other handlers during a HttpParse::Flush(), except RenderDone(), which (if in use) happens after Flush().

Implements net_instaweb::HtmlFilter.

ScriptUsage net_instaweb::HtmlWriterFilter::GetScriptUsage ( ) const

inlineoverridevirtual

Note: there is also kRequiresScriptExecutionFilterSet in rewrite_options.cc, which identifies filters that will leave broken pages if javascript is disabled, and hence require noscript handing. The set of filters that CanInjectScripts is larger, as it includes filters that might inject beacons or other optional functionality that is not page-critical.

Implements net_instaweb::HtmlFilter.

virtual void net_instaweb::HtmlWriterFilter::IEDirective ( HtmlIEDirectiveNode *  directive )

virtual

Called for an IE directive; typically used for CSS styling. See http://msdn.microsoft.com/en-us/library/ms537512(VS.85).aspx

Todo:

TODO(mdsteele): Should we try to maintain the nested structure of the conditionals, in the same way that we maintain nesting of elements?

Implements net_instaweb::HtmlFilter.

virtual void net_instaweb::HtmlWriterFilter::StartDocument ( )

virtual

Starts a new document. Filters should clear their state in this function, as the same Filter instance may be used for multiple HTML documents.

Implements net_instaweb::HtmlFilter.

virtual void net_instaweb::HtmlWriterFilter::StartElement ( HtmlElement *  element )

virtual

When an HTML element is encountered during parsing, each filter's StartElement method is called. The HtmlElement lives for the entire duration of the document.

Todo:

TODO(jmarantz): consider passing handles rather than pointers and reference-counting them instead to save memory on long documents.

Implements net_instaweb::HtmlFilter.

---

The documentation for this class was generated from the following file:

• pagespeed/kernel/html/html_writer_filter.h