SoNodekitCatalog.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul Isaacs (MMM yyyy)
** Modified by : Thad Beier (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_NODEKIT_CATALOG
#define  _SO_NODEKIT_CATALOG
 
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SoLists.h>
#include <Inventor/SoType.h>
 
#define SO_CATALOG_NAME_NOT_FOUND -1
#define SO_CATALOG_THIS_PART_NUM   0
 
#ifndef HIDDEN_FROM_DOC
//
//    Class: SoNodekitCatalogEntry
//
//    an internal class that should be accessed only by an SoNodekitCatalog
//
//
{
 private:
  SbName     name;                // Reference name of this entry 
  SoType     type;                // Type of node allowable for setting
  // this entry. 'type' may be an 
  // abstract node type
  SoType     defaultType;         // Type of node to create if the nodekit
  // is asked to build this part itself.
  // May not be an abstract node type.
  SbBool     nullByDefault;       // If FALSE, then this part is 
  // created within the constructor.
  // Otherwise, it isn't.
  SbBool     leafPart;            // Is this entry a leaf node in the 
  // nodekit's structure?
  SbName     parentName;          // Reference name of this entry's parent
  SbName     rightSiblingName;    // Name of right sibling of the entry
  SbBool     listPart;            // Is this entry a list of nodes?
  SoType     listContainerType;   // If so, what kind of container?
  SoTypeList listItemTypes;       // If so, what types of nodes may
  // it contain?
  SbBool     publicPart;          // Can a user be given a pointer to
  // this part?
 private:
  // constructor
  SoNodekitCatalogEntry(const SbName &theName, 
                        SoType theType, SoType theDefaultType, 
                        SbBool theNullByDefault,
                        const SbName &theParentName, const SbName &theRightSiblingName, 
                        SbBool theListPart, SoType theListContainerType,
                        const SoTypeList &theListItemTypes,
                        SbBool thePublicPart);
 
  // clone exactly, or make a clone with a given type...
  SoNodekitCatalogEntry *clone() const;           
  SoNodekitCatalogEntry *clone( SoType newType,
                                SoType newDefaultType ) const; 
 
  // inquiry functions:
  const SbName  &getName() const { return name; };
  SoType  getType() const { return type; };
  SoType  getDefaultType() const { return defaultType; };
  SbBool  isNullByDefault() const { return nullByDefault; };
  SbBool  isLeaf() const { return leafPart; };
  const SbName  &getParentName() const { return parentName; };
  const SbName  &getRightSiblingName() const { return rightSiblingName; };
  SbBool  isList() const { return listPart; };
  SoType  getListContainerType() const {return listContainerType;};
  const SoTypeList &getListItemTypes() const { return listItemTypes; };
  SbBool  isPublic() const { return publicPart; };
 
  // For adding to the set of node types allowed beneath a list...
  void addListItemType( SoType typeToAdd );
 
  void setNullByDefault( SbBool newNullByDefault ) 
    { nullByDefault = newNullByDefault; }
  // these should only by used by catalogs when an entry
  // is given a new child or left sibling...
  void setPublic( SbBool newPublic ) { publicPart = newPublic; }
  void setLeaf( SbBool newLeafPart ) { leafPart = newLeafPart; }
  void setRightSiblingName( const SbName &newN ) { rightSiblingName = newN; }
  // This should only by used by catalogs when an entry is changing
  // type and/or defaultType
  void setTypes( SoType newType, SoType newDefaultType )
    { type = newType; defaultType = newDefaultType; }
 
  // recursively search this entry for 'name to find' in the 
  // templates of this entry and its descendants
  SbBool recursiveSearch( const SbName &nameToFind, 
                          SoTypeList *typesChecked) const;
 
  void printCheck() const; // prints the contents of this entry
};
#endif // HIDDEN_FROM_DOC
 
class  SoNodekitCatalog {
 
 private:
 
  static void initClass();
  static void exitClass();
 
 public:
 
  int        getNumEntries() const { return numEntries; };
 
  // inquiry routines, to find out about entries in the catalog,
  // Questions may be asked based on name or partNumber.
#ifdef DEBUG_NODEKITS
  long        getPartNumber(      const SbName &theName ) const;
#else
  int        getPartNumber(      const SbName &theName ) const;
#endif
  const SbName     &getName(                 int    thePartNumber ) const;
  SoType     getType(                    int    thePartNumber ) const;
  SoType     getType(              const SbName &theName ) const;
  SoType     getDefaultType(             int    thePartNumber ) const;
  SoType     getDefaultType(       const SbName &theName ) const;
  SbBool     isNullByDefault(            int    thePartNumber ) const;
  SbBool     isNullByDefault(              const SbName &theName ) const;
  SbBool     isLeaf(                     int    thePartNumber ) const;
  SbBool     isLeaf(               const SbName &theName ) const;
  const SbName     &getParentName(           int    thePartNumber ) const;
  const SbName     &getParentName(     const SbName &theName ) const;
  int        getParentPartNumber(      int    thePartNumber ) const;
  int        getParentPartNumber(const SbName &theName ) const;
  const SbName     &getRightSiblingName(      int    thePartNumber ) const;
  const SbName     &getRightSiblingName(const SbName &theName ) const;
  int        getRightSiblingPartNumber(      int thePartNumber ) const;
  int        getRightSiblingPartNumber(const SbName &theName ) const;
  SbBool     isList(                     int    thePartNumber ) const;
  SbBool     isList(               const SbName &theName ) const;
  SoType     getListContainerType(       int    thePartNumber ) const;
  SoType     getListContainerType( const SbName &theName ) const;
  const SoTypeList    &getListItemTypes(       int    thePartNumber ) const;
  const SoTypeList    &getListItemTypes( const SbName &theName ) const;
  SbBool     isPublic(                   int    thePartNumber ) const;
  SbBool     isPublic(             const SbName &theName ) const;
 
 private:
  // Catalogs are only constructed, destructed, cloned or added to  
  // by subclasses of SoBaseKit.
  // This should be accomplished using the macros provided in SoSubKit.h
 
  // Constructor
  SoNodekitCatalog();
 
  // Destructor
  ~SoNodekitCatalog();
 
  // Make a new identical copy, but you must give the node type for 'this' 
  // (where 'this' is the top level node in the template )
  SoNodekitCatalog *clone( SoType typeOfThis ) const;
 
  // Adding entries
  SbBool addEntry(const SbName &theName, 
                  SoType theType, SoType theDefaultType,
                  SbBool  theNullByDefault,
                  const SbName &theParentName, 
                  const SbName &theRightSiblingName, SbBool theListPart, 
                  SoType theListContainerType,
                  SoType theListItemType,
                  SbBool thePublicPart);
 
  // For adding to the set of node types allowed beneath a list...
  void addListItemType(int thePartNumber, SoType typeToAdd);
  void addListItemType(const SbName &theName,   SoType typeToAdd);
 
  // For changing the type and defaultType of an entry.
  // The new types must be subclasses of the types already existing in the
  // entry.  
  // For example, in SoShapeKit, the part "shape" has type SoShape and
  // default type SoSphere.  Any shape node is acceptable, but be default a 
  // sphere will be built.
  // Well, when creating the SoVertexShapeKit class, a call of:
  //    narrowTypes( "shape", SoVertexShape::getClassTypeId(), 
  //                          SoFaceSet::getClassTypeId())
  // might be used.  This would reflect the fact that:
  // Only vertext shapes may be put in the "shape"  part, not just any shape.
  // And also, by default, a faceSet will be built, not a sphere.
  void narrowTypes( const SbName &theName, SoType newType, 
                    SoType newDefaultType );
 
  void setNullByDefault( const SbName &theName, SbBool newNullByDefault );
 
 private:
  // used by SoNodekitParts to search through catalogs.
  // recursively search a given part for 'name to find' in the 
  // templates of that entry and its descendants
  SbBool recursiveSearch( int partNumber, const SbName &nameToFind, 
                          SoTypeList *typesChecked) const;
 
  void printCheck() const; // prints the contents of this catalog
 
 private:
  static const SbName *emptyName;
  static const SoTypeList *emptyList;
  static SoType *badType;
 
  int                   numEntries;   // how many entries?
  SoNodekitCatalogEntry **entries;    // the array of entries
  SbDict                partNameDict; // For fast lookup of part numbers
 
  // Used for testing various aspects of new entries into a catalog
  SbBool    checkName( const SbName &theName );
  SbBool    checkNewName( const SbName &theName );
  SbBool    checkNewTypes( SoType theType, 
                           SoType theDefaultType );
  SbBool    checkAndGetParent(    const SbName &theName, 
                                  const SbName &theParentName, 
                                  SoNodekitCatalogEntry *& parentEntry );
  SbBool    checkAndGetSiblings(  const SbName &theParentName, 
                                  const SbName &theRightSiblingName, 
                                  SoNodekitCatalogEntry *& leftEntry,
                                  SoNodekitCatalogEntry *& rightEntry );
  SbBool    checkCanTypesBeList(  SoType theType,
                                  SoType theDefaultType,
                                  SoType theListContainerType );
 
};
 
#endif  /* _SO_NODEKIT_CATALOG */