MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/misc/upgraders/SoUpgrader.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: 1.1.1.1 $
 |
 |   Description:
 |      This file defines the SoUpgrader class, which is used to
 |      read in and convert old nodes into new nodes.
 |
 |   Author(s)          : Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_UPGRADER_
#define  _SO_UPGRADER_

#include <Inventor/nodes/SoGroup.h>


class SbDict;
class INVENTOR_API SoUpgrader : public SoGroup {

    SO_NODE_ABSTRACT_HEADER(SoUpgrader);

  public:
    static SoUpgrader   *getUpgrader(const SbName &className,
                                     float fileFormatVersion);
  protected:
    static void         registerUpgrader(const SoType &type,
                                         const SbName &className,
                                         float version);
  SoINTERNAL public:
    static void         initClass();

    static void         initClasses();

    virtual SbBool      upgrade(SoInput *in, const SbName &refName,
                                SoBase *&result);

  protected:
    SbBool              isGroup;

    virtual SoNode      *createNewNode() = 0;

    SoUpgrader();

    virtual ~SoUpgrader();

  private:
    static SbDict       *getUpgradeDict(float version);
    static SbDict       *upgradeDictV1;
    static SbDict       *upgradeDictV2;
};

#define SO_UPGRADER_INIT_CLASS(className)                                     \
    SO__NODE_INIT_CLASS(className, SO__QUOTE(className), SoUpgrader)

#define SO_REGISTER_UPGRADER(oldClassName, version)                           \
        do {                                                                  \
            classTypeId.makeInternal();                                       \
            registerUpgrader(classTypeId, SO__QUOTE(oldClassName), version);  \
        } while (0)

#define SO_UPGRADER_COPY_FIELD2(oldName, newName, nodeVar)                    \
        do {                                                                  \
            if (! oldName.isDefault())                                        \
                nodeVar->newName = oldName;                                   \
            if (oldName.isIgnored())                                          \
                nodeVar->newName.setIgnored(TRUE);                            \
        } while (0)

#define SO_UPGRADER_COPY_FIELD(fieldName, nodeVar)                            \
        SO_UPGRADER_COPY_FIELD2(fieldName, fieldName, nodeVar)

#define SO_UPGRADER_CREATE_NEW(className)                                     \
        ((className *) className::getClassTypeId().createInstance())

#endif /* _SO_UPGRADER_ */