ED4_plugins.cxx

Go to the documentation of this file.

// =============================================================== //
//                                                                 //
//   File      : ED4_plugins.cxx                                   //
//   Purpose   : implement plugin connector + wrap plugin calls    //
//                                                                 //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#include <secedit_extern.hxx>
#include <rna3d_extern.hxx>

#include <aw_msg.hxx>
#include <arbdb.h>
#include <arb_defs.h>

#include "ed4_visualizeSAI.hxx"
#include "ed4_class.hxx"

#define e4_assert(bed) arb_assert(bed)

static bool has_species_name(ED4_base *base, const char *species_name) {
    if (base->is_sequence_terminal()) {
        ED4_sequence_terminal *seq_term = base->to_sequence_terminal();
        return species_name && seq_term && seq_term->species_name && strcmp(species_name, seq_term->species_name)==0;
    }
    return false;
}

// -----------------
//      ED4_host

class ED4_host : public ED4_plugin_host, virtual Noncopyable {
    AW_root *aw_root;
    GBDATA  *gb_main;

    const ED4_sequence_terminal *seq_term;
    mutable ED4_base_position    base_pos;

public:
    ED4_host(AW_root *aw_root_, GBDATA *gb_main_)
        : aw_root(aw_root_),
          gb_main(gb_main_),
          seq_term(NULp)
    {}
    ~ED4_host() OVERRIDE {}

    AW_root *get_application_root() const OVERRIDE { return aw_root; }
    GBDATA *get_database() const OVERRIDE { return gb_main; }

    void announce_current_species(const char *species_name) OVERRIDE {
        ED4_base *base = ED4_ROOT->main_manager->find_first_that(LEV_SEQUENCE_STRING, makeED4_basePredicate(has_species_name, species_name));
        seq_term       = base ? base->to_sequence_terminal() : NULp;
    }

    bool SAIs_visualized() const OVERRIDE { return ED4_ROOT->visualizeSAI; }
    const char* get_SAI_background(int start, int end) const OVERRIDE {
        return ED4_getSaiColorString(aw_root, start, end);
    }

    const char* get_search_background(int start, int end) const OVERRIDE {
        return seq_term
            ? seq_term->results().buildColorString(seq_term, start, end)
            : NULp;
    }

    int get_base_position(int seq_position) const OVERRIDE {
        e4_assert(seq_term);
        return base_pos.get_base_position(seq_term, seq_position);
    }

    void forward_event(AW_event *event) const OVERRIDE { ED4_remote_event(event); }

    const AW_helix *get_helix() const OVERRIDE {
        return ED4_ROOT->helix;
    }
};

// ---------------
//      PlugIn

class PlugIn {
    char              *name;
    ED4_plugin        *start_plugin;
    mutable AW_window *window;

public:
    PlugIn(const char *name_, ED4_plugin *start_plugin_)
        : name(ARB_strdup(name_)),
          start_plugin(start_plugin_),
          window(NULp)
    {}
    PlugIn(const PlugIn& other)
        : name(ARB_strdup(other.name)),
          start_plugin(other.start_plugin),
          window(other.window)
    {}
    DECLARE_ASSIGNMENT_OPERATOR(PlugIn);
    ~PlugIn() { free(name); }

    bool has_name(const char *Name) const { return strcmp(Name, name) == 0; }

    GB_ERROR activate(AW_root *aw_root, GBDATA *gb_main) const {
        GB_ERROR error = NULp;
        if (!window) {
            static ED4_plugin_host *host = NULp;
            if (!host) host = new ED4_host(aw_root, gb_main);
            window = start_plugin(*host);
            error = window ? NULp : GB_await_error();
            if (error) error = GBS_global_string("Couldn't start plugin '%s'\nReason: %s", name, error);
        }
        if (!error) window->activate();
        return error;
    }
};

static const PlugIn *findPlugin(const char *name) {
    static PlugIn registered[] = { // register plugins here
        PlugIn("SECEDIT", start_SECEDIT_plugin),
#if defined(ARB_OPENGL)
        PlugIn("RNA3D", start_RNA3D_plugin),
#endif // ARB_OPENGL
    };

    for (size_t plug = 0; plug<ARRAY_ELEMS(registered); ++plug) {
        if (registered[plug].has_name(name)) {
            return &registered[plug];
        }
    }
    return NULp;
}

void ED4_start_plugin(AW_window *aw, GBDATA *gb_main, const char *pluginname) {
    const PlugIn *plugin = findPlugin(pluginname);

    GB_ERROR error = plugin
        ? plugin->activate(aw->get_root(), gb_main)
        : GBS_global_string("plugin '%s' is unknown", pluginname);

    aw_message_if(error);
}


// --------------------------------------------------------------------------------

#ifdef UNIT_TESTS
#include <test_unit.h>

void TEST_plugin_found() {
    TEST_REJECT_NULL(findPlugin("SECEDIT"));
    TEST_EXPECT_NULL(findPlugin("unknown"));
#if defined(ARB_OPENGL)
    TEST_REJECT_NULL(findPlugin("RNA3D"));
#else
    TEST_EXPECT_NULL(findPlugin("RNA3D"));
#endif
}

#endif // UNIT_TESTS