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 <sstream>

#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 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(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);

    void Write(ostream& outStream, const bool sortTables = false,
      const bool writeEmptyTables = false);

    int DataChecking(CifFile& dicRef);

    int DataChecking(Block& block, Block& refBlock, ostringstream& buf);

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

    void GetAttributeValue(string& attribVal, const string& blockId,
      const string& category, const string& attribute);
    void GetAttributeValueIf(string& attribVal, const string& blockId,
      const string& category, const string& attributeA,
      const string& attributeB, const string& valB);
    bool IsAttributeValueDefined(const string& blockId,
      const string& category, const string& attribute);

    void SetAttributeValue(const string& blockId, const string& category,
      const string& attribute, const string& value,
      const bool create = false);
    void SetAttributeValueIf(const string& blockId,
      const string& category, const string& attributeA, const string& valA,
      const string& attributeB, const string& valB, const bool create = false);
    void SetAttributeValueIfNull(const string& blockId,
      const string& category, const string& attribute, const string& value);

    void GetAttributeValues(vector<string>& strings, const string& blockId,
      const string& category, const string& attribute);
    void GetAttributeValuesIf(vector<string>& strings, 
      const string& blockId, const string& category, const string& attributeA, 
      const string& attributeB, const string& valB);

    void SetAttributeValues(const string& blockId,
      const string& category, const string& attribute,
      const vector<string>& values);

#ifdef VLAD_TO_CIF_FILE_NOT_USED
    void del_attribute_value_where(CifFile *fobj, const char *blockId,
      const char *category, const char *attributeB, const char *valB);
#endif // VLAD_TO_CIF_FILE_NOT_USED not defined

    int CheckCategories(Block& block, Block& refBlock, ostringstream& log);
    void CheckCategoryKey(Block& block, ostringstream& log);
    int CheckItems(Block& block, Block& refBlock, ostringstream& log);


  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 vector<string>& catOrder,
      const bool writeEmptyTables = false);

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


  private:
    void Init();

    bool IsCatDefinedInRef(const string& catName, ISTable& catTable);
    bool IsItemDefinedInRef(const string& catName, const string& itemName,
      ISTable& refItemTable);
    void CheckKeyItems(const string& blockName, ISTable& catTable,
      ISTable& keyTable, ostringstream& log);

    void CheckMandatoryItems(const string& blockName, ISTable& catTable,
      ISTable& refItemTable, ostringstream& log);

    void CheckAndRectifyItemTypeCode(Block& block, ostringstream& log);

    int CheckParentChild(Block& block, ISTable& catTable,
      const vector<string>& cifItemNames, ISTable& parChildTable,
      ostringstream& log);

    int CheckRegExpRangeEnum(Block& block, ISTable& catTable,
      const string& cifItemName, ISTable& itemTypeTable,
      ISTable& itemTypeListTable, ISTable& itemRangeTable,
      ISTable& itemEnumTable, ISTable& parChildTable, ostringstream& log);

    int CheckCellRange(const string& cell, const string& typeCode,
      const vector<string>& minlist, const vector<string>& maxlist);

    int CheckCellEnum(const string& cell, const string& typeCode,
      const string& primCode, const vector<string>& enumlist);

    int CheckCellFloatRange(const string& cell, const vector<string>& minlist,
      const vector<string>& maxlist);

    int CheckCellIntRange(const string& cell, const vector<string>& minlist,
      const vector<string>& maxlist);

    int CheckCellFloatEnum(const string& cell, const vector<string>& enumlist);

    int CheckCellIntEnum(const string& cell, const vector<string>& enumlist);

    int CheckCellOtherEnum(const string& cell, const string& primCode,
      const vector<string>& enumlist);

    ISTable* CreateKeysTable(const vector<string>& cifItemNames,
      ISTable& parChildTable, map<string, unsigned int>& maxKeyGroups);

    void GetComboKeys(const string& parCatName,
      const unsigned int maxKeyGroup, ISTable& keysTable,
      vector<vector<string> >& comboKeys, vector<string>& parKeys);

    void GetItemTypeCode(string& typeCode, const string& cifItemName,
      ISTable& itemTypeTable);

    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

---