root/trunk/FRII/gui/FeaturesContainer.hh

/*
 * This file is part of the FamilyRelations II source distribution.
 *
 * FamilyRelations II is part of the FamilyJewels package for comparative
 * sequence analysis: http://family.caltech.edu/.
 *
 * Contact author: C. Titus Brown, titus@caltech.edu.
 *
 * This program and all associated source code files are Copyright (C) 2003,
 * 2004 the California Institute of Technology, Pasadena, CA, 91125 USA.  It
 * is under the Lesser GNU Public License; please see the included
 * LICENSE.txt file for more information, or contact Titus directly.
 *
 */

// Base class for features on a single-sequence.  All subclasses must support:
//   * export of features;
//   * change notification.
//
// See SimpleFeaturesContainer.hh and BlastFeaturesContainer.* for specific
// implementations.

#ifndef FEATURES_CONTAINER_HH
#define FEATURES_CONTAINER_HH

#include "FeatureList.hh"
#include "ColorPatch.hh"

namespace gui {
  //
  // A virtual base class for things that listen to FeaturesContainer changes.
  //

  class FeaturesContainerChanged_ {
    friend class FeaturesContainer;
  protected:
    virtual void notify() = 0;
    virtual ~FeaturesContainerChanged_() { }
  };

  //
  // A container for features on a single sequence.
  //
  
  class FeaturesContainer {
  protected:
    std::vector<FeaturesContainerChanged_*> _to_notify_list;
    Fl_Color _color;
    bool _visible;

    // Notify change listeners of a change.
    void notify_changed() {
      for (unsigned int i = 0; i < _to_notify_list.size(); i++) {
        _to_notify_list[i]->notify();
      }
    }

    FeaturesContainer() { _color = FL_BLACK; _visible = true; }
  public:
    // Add change listener.
    void add_change_listener(FeaturesContainerChanged_* l) {
      _to_notify_list.push_back(l);
    }

    // color management
    Fl_Color color() { return _color; }
    void color(Fl_Color c) { _color = c; notify_changed(); }

    // visibility management
    bool visible() { return _visible; }
    void visible(bool v) { _visible = v; notify_changed(); }

    // do any of these features contain alignments?
    virtual bool contains_alignments() const {
      return getFeatureList()->contains_alignments();
    }

    //
    // Override in subclasses.
    //
    virtual const FeatureList* getFeatureList() const = 0;
    virtual FeaturesContainer * copy_me() const = 0;

    virtual ~FeaturesContainer() {
      for (unsigned int i = 0; i < _to_notify_list.size(); i++) {
        delete _to_notify_list[i];
      }
    }
  };

  //
  // A specific subclass that redraws Fl_Widgets.
  //

  class FeaturesContainerChanged_Redrawer : public FeaturesContainerChanged_ {
  private:
    Fl_Widget * to_redraw;
  public:
    FeaturesContainerChanged_Redrawer(Fl_Widget * r) : to_redraw(r) { }
    void notify() { to_redraw->redraw(); }
    ~FeaturesContainerChanged_Redrawer() { }
  };

  //
  // A specific class that links colors to mappings.
  //

  class ColorChangeListener_FeaturesContainer : public ColorChangeListener_ {
  protected:
    FeaturesContainer * _cont;
  public:
    ColorChangeListener_FeaturesContainer(FeaturesContainer * c) {
      _cont = c;
    }
    virtual ~ColorChangeListener_FeaturesContainer() { };

    void notify(Fl_Color c) { _cont->color(c); }
  };

}

#endif // FEATURES_CONTAINER_HH