MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/misc/SoTranscribe.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision $
 |
 |   Description:
 |      This file contains definitions of the SoTranSender and SoTranReceiver
 |      classes used for transcribing Inventor data. Transcribing is the
 |      process of packaging changes to a database and sending them over a
 |      "wire" to another database.
 |
 |   Classes:
 |      SoTranSender, SoTranReceiver
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_TRANSCRIBE_
#define  _SO_TRANSCRIBE_

#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SbDict.h>

class SoGroup;
class SoInput;
class SoNode;
class SoOutput;





class INVENTOR_API SoTranSender {
  public:

    SoTranSender(SoOutput *output);

    ~SoTranSender()                             {}

    SoOutput *          getOutput() const       { return out; }

    void                insert(SoNode *node);
    void                insert(SoNode *node, SoNode *parent, int n);
    void                remove(SoNode *parent, int n);
    void                replace(SoNode *parent, int n, SoNode *newNode);
    void                modify(SoNode *node);

    void                prepareToSend();

  private:
    SoOutput            *out;

    void                addBytes(const void *bytes, size_t nBytes);
    void                addCommand(int command);
    void                addInt(int n);
    void                addNode(SoNode *node, SbBool addNames = TRUE);
    void                addNodeNames(const SoNode *root);
    void                addNodeRef(const SoNode *node);
    void                addString(const char *cmdString);

friend class SoTranReceiver;
};





class INVENTOR_API SoTranReceiver {

  public:

    SoTranReceiver(SoGroup *rootNode);

    ~SoTranReceiver();

    SbBool      interpret(SoInput *in);

  private:
    SoGroup     *root;
    SbDict      nameToEntryDict;        
    SbDict      nodeToNameDict;         

    SbBool      interpretCommand(int commandCode, SoInput *in, SbBool &done);

    SbBool      getNodeAndNames(SoInput *in, SoNode *&node);

    SbBool      getNode(SoInput *in, SoNode *&root);

    SbBool      getNodeNames(SoInput *in, SoNode *root,
                             SbBool lookForNode, SoNode *&oldRoot);

    SbBool      getNodeReference(SoInput *in, SoNode *&node);

    void        removeNodeReferences(SoNode *node);

    void        addEntry(SoNode *node, SbName &name);

    static void deleteDictEntry(unsigned long key, void *value);


};

#endif /* _SO_TRANSCRIBE_ */