PvlFormat.h

Go to the documentation of this file.

#ifndef PvlFormat_h
#define PvlFormat_h
 
/* SPDX-License-Identifier: CC0-1.0 */
#include <map>
#include <string>
 
#include "Pvl.h"
 
#include "PvlKeyword.h"
 
namespace Isis {

  enum KeywordType { NoTypeKeyword,
                     StringKeyword,
                     BoolKeyword,
                     IntegerKeyword,
                     RealKeyword,
                     OctalKeyword,
                     HexKeyword,
                     BinaryKeyword,
                     EnumKeyword
                   };

  inline KeywordType toKeywordType(const QString type) {
 
    QString t(type);
    t = t.remove(QRegExp("[\\w_-\"'")).toUpper();
 
    if(t == "STRING") return StringKeyword;
    else if(t == "BOOL") return BoolKeyword;
    else if(t == "INTEGER") return IntegerKeyword;
    else if(t == "REAL") return RealKeyword;
    else if(t == "OCTAL") return OctalKeyword;
    else if(t == "HEX") return HexKeyword;
    else if(t == "BINARY") return BinaryKeyword;
    else if(t == "ENUM") return EnumKeyword;
    return NoTypeKeyword;
  }

  class PvlFormat {
 
    public:
 
      PvlFormat();
      PvlFormat(const QString &file);
      PvlFormat(Pvl &keymap);
      virtual ~PvlFormat() {};
 
      void add(const QString &file);
      void add(Pvl &keymap);

      void setCharLimit(const unsigned int limit) {
        m_charLimit = limit;
      };

      unsigned int charLimit() const {
        return m_charLimit;
      };
 
      virtual QString formatValue(const PvlKeyword &keyword,
                                      int valueIndex = 0);
      virtual QString formatName(const PvlKeyword &keyword);
      virtual QString formatEnd(const QString name,
                                    const PvlKeyword &keyword);
      virtual QString formatEOL() {
        return "\n";
      }
 
      virtual KeywordType type(const PvlKeyword &keyword);
      virtual int accuracy(const PvlKeyword &keyword);
 
    protected:
 
      virtual QString addQuotes(const QString value);
      bool isSingleUnit(const PvlKeyword &keyword);
 
      QString m_keywordMapFile;
      Pvl m_keywordMap;

      unsigned int m_charLimit;
 
    private:
      void init();
  };
};
 
#endif