net_instaweb::ImageCombineFilter Class Reference

Inheritance diagram for net_instaweb::ImageCombineFilter:

Public Member Functions
	ImageCombineFilter (RewriteDriver *rewrite_driver)
bool	AddCssBackgroundContext (const GoogleUrl &original_url, const GoogleUrl &base_url, Css::Values *values, int value_index, CssFilter::Context *parent, Css::Declarations *decls, bool *is_authorized, MessageHandler *handler)
OutputResourcePtr	MakeOutput ()
	Create the combination with the current combiner.
void	Reset (RewriteContext *context, const GoogleUrl &css_url, const StringPiece &css_text)
	Creates a new context for doing spriting, but does not register it.
void	RegisterOrReleaseContext ()
Public Member Functions inherited from net_instaweb::RewriteFilter
	RewriteFilter (RewriteDriver *driver)
virtual void	DetermineEnabled (GoogleString *disabled_reason)
virtual bool	CanModifyUrls ()
virtual bool	ComputeOnTheFly () const
virtual RewriteContext *	MakeNestedRewriteContext (RewriteContext *parent, const ResourceSlotPtr &slot)
virtual void	EncodeUserAgentIntoResourceContext (ResourceContext *context) const
virtual const RewriteOptions::Filter *	RelatedFilters (int *num_filters) const
virtual const StringPieceVector *	RelatedOptions () const
Public Member Functions inherited from net_instaweb::CommonFilter
	CommonFilter (RewriteDriver *driver)
const GoogleUrl &	base_url () const
	Getters. More...
const GoogleUrl &	decoded_base_url () const
RewriteDriver *	driver () const
HtmlElement *	noscript_element () const
void	InsertNodeAtBodyEnd (HtmlNode *data)
virtual void	StartDocument ()
	Note: Don't overload these methods, overload the implementers instead!
virtual void	StartElement (HtmlElement *element)
virtual void	EndElement (HtmlElement *element)
virtual void	Characters (HtmlCharactersNode *characters)
ResourcePtr	CreateInputResource (StringPiece input_url, RewriteDriver::InputRole role, bool *is_authorized)
ResourcePtr	CreateInputResourceOrInsertDebugComment (StringPiece input_url, RewriteDriver::InputRole role, HtmlElement *element)
void	ResolveUrl (StringPiece input_url, GoogleUrl *out_url)
bool	IsRelativeUrlLoadPermittedByCsp (StringPiece url, CspDirective role)
bool	BaseUrlIsValid () const
bool	DebugMode () const
bool	CanAddPagespeedOnloadToImage (const HtmlElement &)
virtual void	LogFilterModifiedContent ()
virtual RewriteDriver::InlineAuthorizationPolicy	AllowUnauthorizedDomain () const
virtual bool	IntendedForInlining () const
void	AddJsToElement (StringPiece js, HtmlElement *script)
Public Member Functions inherited from net_instaweb::EmptyHtmlFilter
virtual void	EndDocument ()
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	Directive (HtmlDirectiveNode *directive)
	Called for HTML directives (e.g. <!doctype foobar>).
virtual void	Flush ()
ScriptUsage	GetScriptUsage () const override
Public Member Functions inherited from net_instaweb::HtmlFilter
virtual void	RenderDone ()
bool	is_enabled () const
void	set_is_enabled (bool is_enabled)

Static Public Member Functions
static void	InitStats (Statistics *statistics)
Static Public Member Functions inherited from net_instaweb::RewriteFilter
static StringPiece	GetCharsetForScript (const Resource *script, const StringPiece attribute_charset, const StringPiece enclosing_charset)
static GoogleString	GetCharsetForStylesheet (const Resource *stylesheet, const StringPiece attribute_charset, const StringPiece enclosing_charset)
Static Public Member Functions inherited from net_instaweb::CommonFilter
static bool	ExtractMetaTagDetails (const HtmlElement &element, const ResponseHeaders *headers, GoogleString *content, GoogleString *mime_type, GoogleString *charset)

Protected Member Functions
virtual const UrlSegmentEncoder *	encoder () const
virtual const char *	Name () const
	The name of this filter – used for logging and debugging.
virtual void	StartDocumentImpl ()
virtual void	StartElementImpl (HtmlElement *element)
virtual void	EndElementImpl (HtmlElement *element)
virtual const char *	id () const
	Image rewriting was originally, but is no longer, a single CSS.
Protected Member Functions inherited from net_instaweb::RewriteFilter
virtual const char *	LoggingId ()
	This class logs using id().
Protected Member Functions inherited from net_instaweb::CommonFilter
ServerContext *	server_context () const
const RewriteOptions *	rewrite_options ()

Additional Inherited Members
Public Types inherited from net_instaweb::HtmlFilter
enum	ScriptUsage { kWillInjectScripts, kMayInjectScripts, kNeverInjectsScripts }
	Describes a filter's relationship with scripts. More...
Static Public Attributes inherited from net_instaweb::CommonFilter
static const char	kCreateResourceFailedDebugMsg []
	Debug message to be inserted when resource creation fails.

Member Function Documentation

bool net_instaweb::ImageCombineFilter::AddCssBackgroundContext	(	const GoogleUrl &	original_url,
		const GoogleUrl &	base_url,
		Css::Values *	values,
		int	value_index,
		CssFilter::Context *	parent,
		Css::Declarations *	decls,
		bool *	is_authorized,
		MessageHandler *	handler
	)

Attempt to add the CSS background image with (resolved) url original_url to this partnership. We do not take ownership of declarations; it must live until you call Realize() or Reset(). declarations is where we will add the new width and height values; url_value must point to the URL value to be replaced. Will not actually change anything until you call Realize(). This will succeed even in cases when it turns out (later) the image can not be sprited. Fails and returns false if:

• We cannot get the declaration dimensions from 'decls'.
• original_url is not on an authorized domain.
• There is already a slot for original_url.

virtual const UrlSegmentEncoder* net_instaweb::ImageCombineFilter::encoder ( ) const

inlineprotectedvirtual

All RewriteFilters define how they encode URLs and other associated information needed for a rewrite into a URL. The default implementation handles a single URL with no extra data. The filter owns the encoder.

Reimplemented from net_instaweb::RewriteFilter.

void net_instaweb::ImageCombineFilter::RegisterOrReleaseContext

(

)

If there is any work to do, registers the RewriteContext created by Reset(). If there isn't, cleans it up.

virtual void net_instaweb::ImageCombineFilter::StartDocumentImpl ( )

inlineprotectedvirtual

Overload these implementer methods: Intentionally left abstract so that implementers don't forget to change the name from Blah to BlahImpl.

Implements net_instaweb::CommonFilter.

---

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

• net/instaweb/rewriter/public/image_combine_filter.h