messenger.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: messenger.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:32:32  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.27
 * PRODUCTION
 * ===========================================================================
 */

/*  $Id: messenger.hpp,v 1000.1 2004/04/12 17:32:32 gouriano Exp $
* ===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Authors:  Paul Thiessen
*
* File Description:
*      Classes to handle messaging and communication between sequence
*      and structure windows
*
* ===========================================================================
*/

#ifndef CN3D_MESSENGER__HPP
#define CN3D_MESSENGER__HPP

#include <corelib/ncbistl.hpp>
#include <objects/mmdb1/Biostruc_annot_set.hpp>

#include <string>
#include <list>
#include <map>
#include <vector>


BEGIN_SCOPE(Cn3D)

// for now, there is only a single global messenger, which for convenience
// can be accessed anywhere via this function
class Messenger;
Messenger * GlobalMessenger(void);


class ViewerBase;
class BlockMultipleAlignment;
class Sequence;
class StructureWindow;
class StructureObject;
class Molecule;
class MoleculeIdentifier;
class StructureSet;

class Messenger
{
public:
    // redraw messages - "Post..." means redraw is *not* immediate, but
    // is cached and actually occurs during system idle time. Thus, during
    // processing of an event, any number of PostRedraws can be called, and
    // only one redraw as appropriate will be done at idle time.
    void PostRedrawSequenceViewer(ViewerBase *viewer);
    void PostRedrawAllSequenceViewers(void);

    void PostRedrawMolecule(const Molecule *molecule);
    void PostRedrawAllStructures(void);

    // un-Post a redraw message - use (carefully!) to avoid redundant redraws
    // (flicker) if some other action is known to cause immediate redraw.
    void UnPostRedrawAllSequenceViewers(void);
    void UnPostRedrawSequenceViewer(ViewerBase *viewer);

    // un-Post structure redraws - again, use carefully to avoid redundant redraws
    // when some non-Messenger method causes structure redraws to occur
    void UnPostStructureRedraws(void);

    // should be called only by Cn3DApp at idle time; processes any redraws
    // that have been posted by prior event(s)
    void ProcessRedraws(void);

    // called if the application is about to exit - tell sequence window(s) to save
    void SequenceWindowsSave(bool prompt);

    // called to notify all sequence viewers that their font should be changed
    void NewSequenceViewerFont(void);

    // these next few are related to highlighting:

    // typedef for highlight storage
    typedef std::map < const MoleculeIdentifier *, std::vector < bool > > MoleculeHighlightMap;

    // check for highlight
    bool IsHighlighted(const Molecule *molecule, int residueID) const;
    bool IsHighlighted(const Sequence *sequence, int seqIndex) const;
    bool IsHighlightedAnywhere(const MoleculeIdentifier *identifier) const;

    // clear all highlight stores - and optionally post redraws. Returns 'true'
    // if there were actually any highlights to remove
    bool RemoveAllHighlights(bool postRedraws);

    // add/remove highlights based on sequence
    void AddHighlights(const Sequence *sequence, int seqIndexFrom, int seqIndexTo);
    void RemoveHighlights(const Sequence *sequence, int seqIndexFrom, int seqIndexTo);
    // toggle highlights on each individual residue in given region
    void ToggleHighlights(const Sequence *sequence, int seqIndexFrom, int seqIndexTo);

    // highlight any 'ole residue, regardless of molecule type
    void ToggleHighlight(const Molecule *molecule, int residueID, bool scrollViewersTo = false);

    // set a bunch of highlights all at once - copies highlight list from given set
    void SetHighlights(const MoleculeHighlightMap& newHighlights);

    // highlights a sequence and moves viewer to that row
    void HighlightAndShowSequence(const Sequence *sequence);

    // temporarily turns off highlighting (suspend==true) - but doesn't erase highlight stores,
    // so when called with suspend==false, highlights will come back on
    void SuspendHighlighting(bool suspend);

private:

    // lists of registered viewers
    typedef std::list < ViewerBase * > SequenceViewerList;
    SequenceViewerList sequenceViewers;
    // currently can only have one structure viewer
    StructureWindow * structureWindow;

    // to keep track of messages posted
    typedef std::map < const Molecule *, bool > RedrawMoleculeList; // use map to preclude redundant redraws
    RedrawMoleculeList redrawMolecules;
    typedef std::map < ViewerBase *, bool > RedrawSequenceViewerList;
    RedrawSequenceViewerList redrawSequenceViewers;
    bool redrawAllStructures;
    bool redrawAllSequenceViewers;
    bool highlightingSuspended;

    // To store lists of highlighted entities
    MoleculeHighlightMap highlights;

    bool IsHighlighted(const MoleculeIdentifier *identifier, int index) const;
    void ToggleHighlights(const MoleculeIdentifier *identifier, int indexFrom, int indexTo,
        const StructureSet *set);

    void RedrawMoleculesWithIdentifier(const MoleculeIdentifier *identifier, const StructureSet *set);

public:
    Messenger(void) : redrawAllStructures(false), redrawAllSequenceViewers(false),
        highlightingSuspended(false) { }

    bool IsAnythingHighlighted(void) const { return (highlights.size() > 0); }

    // to get lists of highlighted molecules with structure only (for user annotations)
    bool GetHighlightedResiduesWithStructure(MoleculeHighlightMap *residues) const;

    // to get lists of highlighted residues that come from a single structure object
    // (for cdd annotations) - returns NULL if highlights aren't from one structure
    ncbi::objects::CBiostruc_annot_set * CreateBiostrucAnnotSetForHighlightsOnSingleObject(void) const;

    // formats list of highlighted residues for selection messaging; returns true if
    // there are any highlights
    bool GetHighlightsForSelectionMessage(std::string *data) const;

    // to register sequence and structure viewers for redraw postings
    void AddSequenceViewer(ViewerBase *sequenceViewer)
        { sequenceViewers.push_back(sequenceViewer); }

    void AddStructureWindow(StructureWindow *window)
        { structureWindow = window; }

    // to unregister viewers
    void RemoveStructureWindow(const StructureWindow *structureWindow);
    void RemoveSequenceViewer(const ViewerBase *sequenceViewer);

    // set window titles
    void SetAllWindowTitles(void) const;

    // for sending messages through file messenger
    bool IsFileMessengerActive(void) const;
    void FileMessengerSend(const std::string& toApp, const std::string& command, const std::string& data);
};

END_SCOPE(Cn3D)

#endif // CN3D_MESSENGER__HPP

/*
* ---------------------------------------------------------------------------
* $Log: messenger.hpp,v $
* Revision 1000.1  2004/04/12 17:32:32  gouriano
* PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.27
*
* Revision 1.27  2004/01/08 15:31:03  thiessen
* remove hard-coded CDTree references in messaging; add Cn3DTerminated message upon exit
*
* Revision 1.26  2003/07/10 18:47:29  thiessen
* add CDTree->Select command
*
* Revision 1.25  2003/03/13 14:26:18  thiessen
* add file_messaging module; split cn3d_main_wxwin into cn3d_app, cn3d_glcanvas, structure_window, cn3d_tools
*
* Revision 1.24  2003/02/03 19:20:04  thiessen
* format changes: move CVS Log to bottom of file, remove std:: from .cpp files, and use new diagnostic macros
*
* Revision 1.23  2002/10/07 13:29:31  thiessen
* add double-click -> show row to taxonomy tree
*
* Revision 1.22  2002/09/09 13:38:23  thiessen
* separate save and save-as
*
* Revision 1.21  2002/09/05 18:38:57  thiessen
* add sort by highlights
*
* Revision 1.20  2002/06/05 14:28:39  thiessen
* reorganize handling of window titles
*
* Revision 1.19  2002/02/05 18:53:25  thiessen
* scroll to residue in sequence windows when selected in structure window
*
* Revision 1.18  2001/10/01 16:03:58  thiessen
* make CDD annotation window non-modal; add SetWindowTitle to viewers
*
* Revision 1.17  2001/08/27 00:06:35  thiessen
* add structure evidence to CDD annotation
*
* Revision 1.16  2001/08/14 17:17:48  thiessen
* add user font selection, store in registry
*
* Revision 1.15  2001/07/04 19:38:55  thiessen
* finish user annotation system
*
* Revision 1.14  2001/06/29 18:12:53  thiessen
* initial (incomplete) user annotation system
*
* Revision 1.13  2001/06/21 02:01:07  thiessen
* major update to molecule identification and highlighting ; add toggle highlight (via alt)
*
* Revision 1.12  2001/03/22 00:32:36  thiessen
* initial threading working (PSSM only); free color storage in undo stack
*
* Revision 1.11  2001/03/01 20:15:29  thiessen
* major rearrangement of sequence viewer code into base and derived classes
*
* Revision 1.10  2000/12/15 15:52:08  thiessen
* show/hide system installed
*
* Revision 1.9  2000/11/30 15:49:08  thiessen
* add show/hide rows; unpack sec. struc. and domain features
*
* Revision 1.8  2000/11/02 16:48:22  thiessen
* working editor undo; dynamic slave transforms
*
* Revision 1.7  2000/10/19 12:40:21  thiessen
* avoid multiple sequence redraws with scroll set
*
* Revision 1.6  2000/10/12 02:14:32  thiessen
* working block boundary editing
*
* Revision 1.5  2000/10/04 17:40:45  thiessen
* rearrange STL #includes
*
* Revision 1.4  2000/10/02 23:25:07  thiessen
* working sequence identifier window in sequence viewer
*
* Revision 1.3  2000/09/15 19:24:33  thiessen
* allow repeated structures w/o different local id
*
* Revision 1.2  2000/09/11 22:57:55  thiessen
* working highlighting
*
* Revision 1.1  2000/09/11 01:45:53  thiessen
* working messenger for sequence<->structure window communication
*
*/