CifFile.h

Go to the documentation of this file.

//$$FILE$$
//$$VERSION$$
//$$DATE$$
//$$LICENSE$$


/* 
  PURPOSE:    Base class for read/write cif files
*/


#ifndef CIFFILE_H
#define CIFFILE_H


#include <string>
#include <vector>
#include <iostream>


#include "CifString.h"
#include "TableFile.h"


class CifFile : public TableFile
{
  public:
    static const unsigned int STD_CIF_LINE_LENGTH = 80;

    enum eQuoting
    {
        eSINGLE = 0,
        eDOUBLE
    };

    CifFile(const StringCompare::eCompareType caseSense =
      StringCompare::eCASE_SENSITIVE);

    CifFile(const eFileMode fileMode, const string& fileName,
      const bool verbose = false, const StringCompare::eCompareType
      caseSense = StringCompare::eCASE_SENSITIVE,
      const unsigned int maxLineLength = STD_CIF_LINE_LENGTH,
      const string& nullValue = CifString::NullValue);

    ~CifFile();

    inline bool GetVerbose();

    inline void SetSmartPrint(bool smartPrint = true);

    inline bool IsSmartPrint();

    void SetQuoting(eQuoting quoting);

    unsigned int GetQuoting();
 
    void Write(const string& cifFileName, const bool sortTables = false,
      const bool writeEmptyTables = false);

    void Write(const string& cifFileName, const vector<string>& tableOrder,
      const bool writeEmptyTables = false);

    int DataChecking(CifFile& dicRef);

    static void GetItemNames(vector<string>& itemNames, ISTable& isTable);

  protected:
    static const unsigned int STD_PRINT_SPACING = 3;
    static const unsigned int SMART_PRINT_SPACING = 1;
    static const unsigned int HEADER_SPACING = 40;

    enum eIdentType
    {
        eNONE = 0,
        eLEFT,
        eRIGHT
    };

    unsigned int _maxCifLineLength;
    string _nullValue;
    bool _verbose;
    bool _smartPrint;
    string _quotes;

    int _IsQuotableText(const string& itemValue);
    eIdentType _FindPrintType(const vector<string>& values);

    void _PrintItemIdent(ostream& cifo, unsigned int& linePos);
    void _PrintItemName(ostream& cifo, const string& category,
      const string& itemName, unsigned int& linePos);
    void _PrintPostItemSeparator(ostream& cifo, unsigned int& linePos,
      const bool ident = false, const unsigned int numSpaces = 1);

    int _PrintItemValue(ostream& cifo, const string& itemValue,
      unsigned int& linePos, const eIdentType identType = eNONE,
      const unsigned int width = 0);

    int _PrintItemNameInHeader(ostream& cifo, const string& itemValue,
      unsigned int& linePos, const eIdentType identType = eNONE,
      const unsigned int width = 0);

    void _PrintHeaderedItems(ostream& cifo, const vector<string>& colNames,
      const vector<unsigned int>& colWidths,
      const vector<eIdentType> colPrintType);

    void Write(ostream& cifo, const bool sortTables = false,
      const bool writeEmptyTables = false);
    void Write(ostream& cifo, const vector<string>& catOrder,
      const bool writeEmptyTables = false);

    void Write(ostream& cifo, vector<unsigned int>& tables,
      const bool writeEmptyTables = false);

    int MandatoryCategoryChecking(CifFile& ref, ofstream& log);
    int ItemsChecking(CifFile& ref, ofstream& log);

  private:
    void Init();
    void ConvertEscapedString(const string& inString, string& outString);

};


inline bool CifFile::GetVerbose()
{
    return(_verbose);
}


inline void CifFile::SetSmartPrint(bool smartPrint)
{
    _smartPrint = smartPrint;
}


inline bool CifFile::IsSmartPrint()
{
    return(_smartPrint);
}


#endif

---