mlListParser.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_LIST_PARSER_H
#define ML_LIST_PARSER_H
 
 
// - ParserBase is a base class from which special parser classes can be derived.
// - ListParser (derived from ParserBase) is a parser class for parsing persistent
//   state strings of list objects.
// - BaseItemParser (derived from ParserBase) is a parser class for BaseItem strings.
 
// ML-includes
#include "mlBaseInit.h"
#include "mlParserBase.h"
 
// For backward compatibility also include BaseItemParser.
#include "mlBaseItemParser.h"
 
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// Class ListParser
// ------------------------------------------------------------------
 
class MLBASEEXPORT ListParser : public ParserBase
{
public:
 
  ListParser() = default;
 
 
  int init (const char *source) override;
 
#if !ML_DEPRECATED_SINCE(3,5,0)
private:
#endif
  [[deprecated]] int nextItemString (char *&itemString);
 
#if !ML_DEPRECATED_SINCE(3,5,0)
public:
#endif
 
 
  std::pair<int, std::string> nextItem();
 
  const char *getErrorMessage (int errorCode) override;
 
  enum {
         kMissingOpenBracket = kNumBaseErrorCodes,
         kMissingCloseBracket,
         kUnmatchedQuote,
         kNumErrorCodes           
       };
 
 
  static bool needsQuote(const char *itemStr);
  static bool needsQuote(const std::string& itemStr);
 
#if !ML_DEPRECATED_SINCE(3,5,0)
private:
#endif
  [[deprecated]] static char *quoteString(const char *itemStr);
#if !ML_DEPRECATED_SINCE(3,5,0)
public:
#endif
 
 
  static std::string quoteString(const std::string& itemStr);
 
 
protected:
 
  int unquoteString (std::string &itemString);
 
};
 
ML_END_NAMESPACE
 
#endif // __mlListParser_H