path: root/lib/ephy-adblock.h

/*
 *  Copyright © 2003 Marco Pesenti Gritti
 *  Copyright © 2003 Christian Persch
 *  Copyright © 2005 Jean-François Rameau
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *  $Id$
 */

#ifndef EPHY_ADBLOCK_H
#define EPHY_ADBLOCK_H

#include <glib-object.h>

G_BEGIN_DECLS

#define EPHY_TYPE_ADBLOCK       (ephy_adblock_get_type ())
#define EPHY_ADBLOCK(obj)       (G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_TYPE_ADBLOCK, EphyAdBlock))
#define EPHY_ADBLOCK_IFACE(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_TYPE_ADBLOCK, EphyAdBlockIface))
#define EPHY_IS_ADBLOCK(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_TYPE_ADBLOCK))
#define EPHY_IS_ADBLOCK_IFACE(class)    (G_TYPE_CHECK_CLASS_TYPE ((class), EPHY_TYPE_ADBLOCK))
#define EPHY_ADBLOCK_GET_IFACE(inst)    (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EPHY_TYPE_ADBLOCK, EphyAdBlockIface))

typedef enum
{
        AD_URI_CHECK_TYPE_OTHER       = 1U,
        AD_URI_CHECK_TYPE_SCRIPT      = 2U, /* Indicates an executable script
                           (such as JavaScript) */
        AD_URI_CHECK_TYPE_IMAGE       = 3U, /* Indicates an image (e.g., IMG
                           elements) */
        AD_URI_CHECK_TYPE_STYLESHEET  = 4U, /* Indicates a stylesheet (e.g.,
                           STYLE elements) */
        AD_URI_CHECK_TYPE_OBJECT      = 5U, /* Indicates a generic object
                           (plugin-handled content
                           typically falls under this
                           category) */
        AD_URI_CHECK_TYPE_DOCUMENT    = 6U, /* Indicates a document at the
                           top-level (i.e., in a
                           browser) */
    AD_URI_CHECK_TYPE_SUBDOCUMENT = 7U, /* Indicates a document contained
                           within another document (e.g.,
                           IFRAMEs, FRAMES, and OBJECTs) */
        AD_URI_CHECK_TYPE_REFRESH     = 8U  /* Indicates a timed refresh */
} AdUriCheckType;

typedef struct _EphyAdBlock     EphyAdBlock;
typedef struct _EphyAdBlockIface    EphyAdBlockIface;
    
struct _EphyAdBlockIface
{
    GTypeInterface base_iface;

    gboolean    (* should_load) (EphyAdBlock *adblock,
                         const char *url,
                         AdUriCheckType check_type);
    
    void        (* edit_rule)   (EphyAdBlock *adblock,
                         const char *url,
                         gboolean allowed);
};

GType       ephy_adblock_get_type       (void);

gboolean    ephy_adblock_should_load    (EphyAdBlock *adblock,
                             const char *url,
                             AdUriCheckType check_type);

void        ephy_adblock_edit_rule      (EphyAdBlock *adblock,
                             const char *url,
                             gboolean allowed);

G_END_DECLS

#endif