Label.h

#ifndef UTIL_LABEL_H
#define UTIL_LABEL_H
 
/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <util/global.h>
#include <iostream>
#include <string>
 
namespace Util
{
 
   class Label
   {
 
   public:
 
      // Static public members
 
      static const int LabelWidth  = 20;
 
      static void read(std::istream& in);
 
      static void clear();
 
      static void setIsMatched(bool isMatched);
 
      static std::string buffer();
 
      static bool isClear();
 
      static bool isMatched();
 
      // Non-static Public Members
 
      explicit Label(bool isRequired = true);
 
      Label(std::string string, bool isRequired = true);
 
      Label(const char* string, bool isRequired = true);
 
      Label(const Label& other);
 
      virtual ~Label();
 
      void setString(std::string string);
 
      void setIsRequired(bool isRequired);
 
      bool match(std::istream& in);
 
      std::string string() const;
 
      bool isRequired() const;
 
   private:
 
      std::string string_;
 
      bool isRequired_;
 
   // Static members:
 
      static bool isClear_;
 
      static bool isMatched_;
 
      static std::string buffer_;
 
   // friends:
 
      friend std::istream& operator >> (std::istream& in, Label label);
      friend std::ostream& operator << (std::ostream& out, Label label);
 
   };
 
   // Friend function declarations
 
   std::istream& operator >> (std::istream& in, Label label);
 
   std::ostream& operator << (std::ostream& out, Label label);
 
   // Inline functions
 
   /*
   * Is this label a required component of the file format?
   */
   inline bool Label::isRequired() const
   {  return isRequired_; }
 
   /*
   * Is the input buffer clear? (static member function).
   */
   inline bool Label::isClear()
   {  return isClear_; }
 
   /*
   * Did the most recent attempt to read match? 
   * (static member function)
   */
   inline bool Label::isMatched()
   {  return isMatched_; }
 
   /*
   * Manually set isMatched. 
   */
   inline void Label::setIsMatched(bool isMatched)
   {  isMatched_ = isMatched; }
 
   /*
   * Get the string that is currently stored in the buffer.
   */ 
   inline std::string Label::buffer()
   {  return buffer_; }
 
} 
#endif