OSFile.hxx

Go to the documentation of this file.

/*==================================================================================================
  
Copyright (c) 2013 Siemens PLM
Unpublished - All rights reserved

 ====================================================================================================*/
#ifndef FCLASSES_OSFILE_INCLUDE_HXX
#define FCLASSES_OSFILE_INCLUDE_HXX

#include <ss/ss_const.h>
#include <ss/ss_types.h>

#include <fclasses/libfclasses_exports.h>
namespace Teamcenter
{
    class FCLASSES_API OSFile
    {
    public:
        OSFile(const char *iFilePath, int iFileType = SS_TEXT);

        OSFile(int iFileType = SS_TEXT);

        OSFile(const OSFile& iOSFile);

        OSFile& operator = (const OSFile&);

        virtual ~OSFile();


        static char *getValidatedFileName(const char *iFileNameToValidate, bool iKeepCase); 

        static char *getCleanedName(const char *iFileNameToClean);
          

        char* getFilePath() const;

        char* getFileName() const;
       
        char *getFileExtension() const;

        char* getDirectoryPath() const;

        int rename( const char* iFileName );
    
        int changeFilePath( const char* iFilePath );

        int exists (bool& oFileExists) const;
    
        int create (int iMode = SS_DEF_FMODE);

        int open( int iRWMode = SS_RDONLY );

        int close();

        int chmod  (int iMode);

        int getFileStatus( SS_file_status *oFileStatus );

        int getFileType(int *oFileType);

        int getFileSize();

        int copy( const char *iCopyPath );
            
        int deleteFile ();

        int print  (const char *iPrinter = 0) const;

        int readLine( char* oReadLine );

        int readLineWithAllocation (char** oReadLine);

        int fscanf  (const char * oFormattedLine, ...);

        int writeLine( const char* iLine );

        int fprintf (const char *iFormattedLine, ...);

        int initializeParsing();

        
        char* getToken(char *oFoundSeparator, const char* iSeparators=" \n\t\r\f");

    
        int seek( int* iOffset);
    
        int read (void *ioBuffer, int iNumberOfBytes, int iType = SS_VOID);
    
        int readVoid  (void           *ioBuffer, int iNumberOfBytes);
        int readChar  (unsigned char  *ioBuffer, int iNumberOfBytes);
        int readByte  (unsigned char  *ioBuffer, int iNumberOfBytes);
        int readShort (unsigned short *ioBuffer, int iNumberOfBytes);
        int readShort (short          *ioBuffer, int iNumberOfBytes);
        int readInt   (unsigned int   *ioBuffer, int iNumberOfBytes);
        int readInt   (int            *ioBuffer, int iNumberOfBytes);
        int readLong  (unsigned long  *ioBuffer, int iNumberOfBytes);
        int readLong  (long           *ioBuffer, int iNumberOfBytes);
        int readFloat (float          *ioBuffer, int iNumberOfBytes);
        int readDouble(double         *ioBuffer, int iNumberOfBytes);
        int write      (const void    *ioBuffer, int iNumberOfBytes, int iType = SS_VOID);
    
        int writeVoid   (const void           *ioBuffer, int iNumberOfBytes);
        int writeChar   (const unsigned char  *ioBuffer, int iNumberOfBytes);
        int writeByte   (const unsigned char  *ioBuffer, int iNumberOfBytes);
        int writeShort  (const unsigned short *ioBuffer, int iNumberOfBytes);
        int writeShort  (const short          *ioBuffer, int iNumberOfBytes);
        int writeInt    (const unsigned int   *ioBuffer, int iNumberOfBytes);
        int writeInt    (const int            *ioBuffer, int iNumberOfBytes);
        int writeLong   (const unsigned long  *ioBuffer, int iNumberOfBytes);
        int writeLong   (const long           *ioBuffer, int iNumberOfBytes);
        int writeFloat  (const float          *ioBuffer, int iNumberOfBytes);
        int writeDouble (const double         *ioBuffer, int iNumberOfBytes);
        OSFile& operator >> (unsigned char&);
        OSFile& operator >> (short&);
        OSFile& operator >> (unsigned short&);
        OSFile& operator >> (int&);
        OSFile& operator >> (unsigned int&);
        OSFile& operator >> (long&);
        OSFile& operator >> (unsigned long&);
        OSFile& operator >> (float&);
        OSFile& operator >> (double&);
        OSFile& operator << (unsigned char);   
        OSFile& operator << (short);
        OSFile& operator << (unsigned short);
        OSFile& operator << (int);
        OSFile& operator << (unsigned int);
        OSFile& operator << (long);
        OSFile& operator << (unsigned long);
        OSFile& operator << (float);
        OSFile& operator << (double);
        virtual char *asString() const;


    protected:
        bool isSeparator(char iCharacter, const char *iSeparators) const;


    private:
        void getFileInformation();

        int m_owner;

        int m_creationDate;

        int m_fileProtection;

        SS_fd m_fileDescriptor;

        int m_flagTextBinary;

        int m_fileSize;

        int m_fileFormat;
        
        bool m_statDataRetrieved;

        char* m_parsedLine;

        int m_parsedLinePosition;

        int m_parsedLineLength;

        bool m_parsingError;

        char* m_filePath;

        struct
        {
            int error_status;       
            const char* operation;  
        }  m_fileStatus;

        static const char* OPERATION_CONSTRUCTOR;
        static const char* OPERATION_COPYCONST;  
        static const char* OPERATION_OPERATOREQUALS;  
        static const char* OPERATION_RENAME;
        static const char* OPERATION_CHANGEFP;
        static const char* OPERATION_CREATE;
        static const char* OPERATION_OPEN;
        static const char* OPERATION_CLOSE;
        static const char* OPERATION_DELETE;
        static const char* OPERATION_EXISTS;
        static const char* OPERATION_CHMOD;
        static const char* OPERATION_STAT;
        static const char* OPERATION_COPY;
        static const char* OPERATION_READ;
        static const char* OPERATION_WRITE;
        static const char* OPERATION_FPRINTF;
        static const char* OPERATION_FSCANF;
        static const char* OPERATION_READLINEWA;
        static const char* OPERATION_READLINE;
        static const char* OPERATION_WRITELINE;
        static const char* OPERATION_SEEK;
        static const char* OPERATION_GETFILEINFO;
    };
}

#include <fclasses/libfclasses_undef.h>
#endif