This is an old revision of the document!
Midori - Tutorial
This document is licensed under the LGPL 2.1.
Writing a new extension
Check out the sources
bzr branch lp:midori
To develop and build extensions you need a source tree, typically it is a good idea to use the latest trunk to benefit from the latest and greatest features or bug fixes. So if your extension uncovers a bug you can easily report it and get it fixed. For more details see contribute which also covers how to make a branch and codying style in detail.
Add a new extension
The minimum starting point is a new .vala file in ./extensions/ in the Midori source folder. Let's call it “sandcat.vala” for the course of the tutorial.
The code to start with is this:
namespace Sandcat { private class Manager : Midori.Extension { internal Manager () { GLib.Object (name: _("Furry example extension"), description: _("Take care of petting cats"), version: "0.1" + Midori.VERSION_SUFFIX, authors: "Jane Doe <email@domain.tld>"); } } } public Midori.Extension extension_init () { return new Sandcat.Manager (); }
Now let's proceed to run our rather empty extension.
The first instrruction
user@host:~/midori$ mkdir build ; cd build user@host:~/midori/build$ cmake .. user@host:~/midori/build$ make user@host:~/midori/build$ ./midori/midori -g -c ~/midoridevel
After any modifiction in “sandcat.vala” you just run:
user@host:~/midori/build$ make
If you add a new extentioon you run :
user@host:~/midori/build$ make clean user@host:~/midori/build$ cd .. ; rm -rf build
and after you use the The first instrruction.
Inside Midori, open the Preferences, go to Extensions, and look for your new extension in the list. Activate and be proud of completing the first part of the tutorial!
Activating the extension
A basic principle is that each extension is loaded at first to describe what it does and to be shown in the preferences. At that point it doesn't do anything yet. Let's add basic callbacks to trigger after activation.
namespace Sandcat { private class Manager : Midori.Extension { internal Manager () { GLib.Object (name: _("Furry example extension"), description: _("Take care of petting cats"), version: "0.1" + Midori.VERSION_SUFFIX, authors: "Jane Doe <email@domain.tld>"); activate.connect (this.activated); //it will run the method activated deactivate.connect (this.deactivated); //it will run the method deactivated } void browser_added (Midori.Browser browser) { stdout.printf ("a new browser was added, yay\n"); } void activated (Midori.App app) { foreach (var browser in app.get_browsers ()) browser_added (browser); app.add_browser.connect (browser_added); } void deactivated () { var app = get_app (); app.add_browser.disconnect (browser_added); } } } public Midori.Extension extension_init () { return new Sandcat.Manager (); }
You'll see how when activated the extension gets an “app” which is a running Midori instance. It has among other things knowledge of browser windows. It's good practise to not make any assumptions on how many windows are open.
Working with (web) views
namespace Sandcat { private class Manager : Midori.Extension { internal Manager () { GLib.Object (name: _("Furry example extension"), description: _("Take care of petting cats"), version: "0.1" + Midori.VERSION_SUFFIX, authors: "Jane Doe <email@domain.tld>"); activate.connect (this.activated); deactivate.connect (this.deactivated); } void tab_added (Midori.Browser browser, Midori.Tab tab) { stdout.printf ("New tab added\n"); } void tab_switched (Midori.View? old_view, Midori.View? new_view) { var title = new_view.get_display_title(); var uri = new_view.get_display_uri(); stdout.printf ("title: %s and url: %s\n", title, uri); } void browser_added (Midori.Browser browser) { foreach (var tab in browser.get_tabs ()) tab_added (browser, tab); browser.add_tab.connect (tab_added); browser.switch_tab.connect (tab_switched); } void activated (Midori.App app) { foreach (var browser in app.get_browsers ()) browser_added (browser); app.add_browser.connect (browser_added); } void browser_removed (Midori.Browser browser) { foreach (var tab in browser.get_tabs ()) { browser.add_tab.disconnect (tab_added); browser.switch_tab.connect (tab_switched); } } void deactivated () { var app = get_app (); app.add_browser.disconnect (browser_added); foreach (var browser in app.get_browsers ()) browser_removed (browser); } } } public Midori.Extension extension_init () { return new Sandcat.Manager (); }
Add a context menu item
// in tab_added tab.context_menu.connect (add_menu_items); void add_menu_items (WebKit.HitTestResult hit_test_result, Midori.ContextAction menu) { if ((hit_test_result.context & WebKit.HitTestResultContext.SELECTION) == 0) return; var action = new Gtk.Action ("NotesCopySnippet", "Copy _snippet to notes", null, null); action.activate.connect (() => { stdout.printf ("my menu item rocks\n"); }); menu.add (action); var submenu = new Midori.ContextAction ("NotesPaste", "Paste N_otes", null, null); for (int i = 0; i < 10; i++) { submenu.add (new Gtk.Action ("NotesSnippet%d".format (i), "Snippet #%i".format (i), null, null); } menu.add (submenu); }
Add an app menu item
whatever
Modify resources or webpages loaded
whatever
Add a statusbar item
// in browser_added var button = new Gtk.Button.with_label ("Click Here!"); browser.statusbar.pack_start (button, false, false, 3); button.show ();
Add a panel
// in private class Manager : Midori.Extension GLib.List<Gtk.Widget> widgets; // in deactivated foreach (var widget in widgets) widget.destroy (); // in activated widgets = new GLib.List<Gtk.Widget> (); // in browser_added var viewable = new Sidebar (); viewable.show (); browser.panel.append_page (viewable); widgets.append (viewable);
Now on to adding a class implementing that panel.
private class Sidebar : Gtk.VBox, Midori.Viewable { public unowned string get_stock_id () { return "a-stock-id"; } public unowned string get_label () { return _("Purrfect"); } public Gtk.Widget get_toolbar () { return null; } public Sidebar () { } }
Add a dialog
whatever
Add a URL completion
whatever
Unit testing
A basic means of quality control, as humans simply don't write flawless code, is to add some automatable tests that can be run repeatedly to verify the code does what it's expected to.
void test_furry_purr () { assert (1 == 1); } public void extension_test () { Test.add_func ("/extensions/furry/purr", test_furry_purr); }