html_filter.h

Go to the documentation of this file.

/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http:///www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef PAGESPEED_KERNEL_HTML_HTML_FILTER_H_
#define PAGESPEED_KERNEL_HTML_HTML_FILTER_H_

#include "pagespeed/kernel/base/string.h"

namespace net_instaweb {

class HtmlCdataNode;
class HtmlCharactersNode;
class HtmlCommentNode;
class HtmlDirectiveNode;
class HtmlElement;
class HtmlIEDirectiveNode;

class HtmlFilter {
 public:
  enum ScriptUsage {
    kWillInjectScripts,

    kMayInjectScripts,

    kNeverInjectsScripts    
  };

  HtmlFilter();
  virtual ~HtmlFilter();

  virtual void StartDocument() = 0;

  virtual void EndDocument() = 0;

  virtual void StartElement(HtmlElement* element) = 0;
  virtual void EndElement(HtmlElement* element) = 0;

  virtual void Cdata(HtmlCdataNode* cdata) = 0;

  virtual void Comment(HtmlCommentNode* comment) = 0;

  virtual void IEDirective(HtmlIEDirectiveNode* directive) = 0;

  virtual void Characters(HtmlCharactersNode* characters) = 0;

  virtual void Directive(HtmlDirectiveNode* directive) = 0;

  virtual void Flush() = 0;

  virtual void RenderDone();

  virtual void DetermineEnabled(GoogleString* disabled_reason) = 0;

  bool is_enabled() const { return is_enabled_; }

  void set_is_enabled(bool is_enabled) { is_enabled_ = is_enabled; }

  virtual bool CanModifyUrls() = 0;

  virtual ScriptUsage GetScriptUsage() const = 0;

  virtual const char* Name() const = 0;

 private:
  bool is_enabled_;
};

}  

#endif