SoOutput.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 contains the definition of the SoOutput class.
 |
 |   Classes:
 |      SoOutput
 |
 |   Author(s)          : Paul S. Strauss, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_OUTPUT_
#define  _SO_OUTPUT_
 
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbDict.h>
#include <Inventor/SbString.h>
 
class SoBase;
 
typedef void *SoOutputReallocCB(void *ptr, size_t newSize);
 


 
class INVENTOR_API SoOutput {
 public:

    SoOutput();

    ~SoOutput();

    void                setFilePointer(FILE *newFP);

    FILE *              getFilePointer() const;

    bool                openFile(const char *fileName);

    void                closeFile();

    void                setBuffer(void *bufPointer, size_t initSize,
                                  SoOutputReallocCB *reallocFunc, 
                                  int32_t offset = 0);

    bool                getBuffer(void *&bufPointer, size_t &nBytes) const;

    size_t              getBufferSize() const { return bufSize; }

    void                resetBuffer();

    void                setBinary(bool flag);

    bool                isBinary() const                { return binary; }

    void                setHeaderString(const SbString &str);

    void                resetHeaderString();
    
    static SbString     getDefaultASCIIHeader();
    static SbString     getDefaultBinaryHeader();

    void                setFloatPrecision(int precision);
                                                        
  SoEXTENDER public:

    enum Stage {
        COUNT_REFS,             
        WRITE                   
    };

    void                setStage(Stage stage)           { curStage = stage; }
    Stage               getStage() const                { return curStage; }

    void                incrementIndent(int amount = 1)
        { indentLevel += amount; }
    void                decrementIndent(int amount = 1)
        { indentLevel -= amount; }

    void                write(char           c);
    void                write(const char    *s);
    void                write(const SbString &s);
    void                write(const SbName   &n);
    void                write(int            i);
    void                write(unsigned int   i);
    void                write(short          s);
    void                write(unsigned short s);
    void                write(float          f);
    void                write(double         d);
    void                writeBinaryArray(unsigned char *c, int length);
    void                writeBinaryArray(int32_t *l, int length);
    void                writeBinaryArray(float *f, int length);
    void                writeBinaryArray(double *d, int length);

    void                indent();
 
  SoINTERNAL public:

    SoOutput(SoOutput *dictOut);

    void                reset();

    void                setCompact(bool flag)         { compact = flag; }
    bool                isCompact() const               { return compact; }

    enum Annotations {
        ADDRESSES  = (1<<0),    
        REF_COUNTS = (1<<1)     
    };
    void                setAnnotation(uint32_t bits)
        { annotation = bits; }
    uint32_t            getAnnotation()
        { return (isCompact() || isBinary()) ? 0 : annotation; }
 
  private:
    FILE                *fp;            
    bool                toBuffer;       
    char                *tmpBuffer;     
    void                *buffer;        
    char                *curBuf;        
    size_t              bufSize;        
    size_t              tmpBufSize;     
    SoOutputReallocCB   *reallocFunc;   
    bool                openedHere;     
    bool                binary;         
    bool                compact;        
    bool                wroteHeader;    
    int                 indentLevel;    
    SbDict              *refDict;       
    bool                borrowedDict;   
    int                 refIdCount;     
    bool                anyRef;         
    uint32_t            annotation;     
    Stage               curStage;       
    SbString            headerString;   
    int                 float_precision; 

    void                writeHeader();
    
    static SbString     padHeader(const SbString &inString);

    bool                isToBuffer() const
        { return toBuffer; }

    size_t              bytesInBuf() const
        { return (curBuf - (char *) buffer); }

    bool                makeRoomInBuf(size_t nBytes);

    bool                makeRoomInTmpBuf(size_t nBytes);

    int                 addReference(const SoBase *base);

    int                 findReference(const SoBase *base) const;

    void                convertShort(short s, char *to);
    void                convertInt32(int32_t l, char *to);
    void                convertFloat(float f, char *to);
    void                convertDouble(double d, char *to);
    void                convertShortArray( short *from, char *to, int len);
    void                convertInt32Array( int32_t *from, char *to, int len);
    void                convertFloatArray( float *from, char *to, int len);
    void                convertDoubleArray( double *from, char *to, int len);
 
friend class SoBase;
friend class SoDB;
};
 
#endif /* _SO_OUTPUT_ */