variable_tokenizer.h

Go to the documentation of this file.

#ifndef TOKENIZER_CLASS
#define TOKENIZER_CLASS
 
/*
*  Name   : variable_tokenizer
*  Author : Chris Koeritz
**
* Copyright (c) 1997-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
*/
 
#include <basis/contracts.h>
#include <structures/string_table.h>
 
namespace configuration {
 
 
class variable_tokenizer : public virtual basis::root_object
{
public:
  enum constraints { DEFAULT_MAX_BITS = 7 };
 
  variable_tokenizer(int max_bits = DEFAULT_MAX_BITS);
 
  variable_tokenizer(const basis::astring &separator, const basis::astring &assignment,
          int max_bits = DEFAULT_MAX_BITS);
 
  variable_tokenizer(const basis::astring &separator, const basis::astring &assignment,
          const basis::astring &quotes, bool nesting = true,
          int max_bits = DEFAULT_MAX_BITS);
 
  variable_tokenizer(const variable_tokenizer &to_copy);
 
  virtual ~variable_tokenizer();
 
  DEFINE_CLASS_NAME("variable_tokenizer");
 
  void set_comment_chars(const basis::astring &comments);
 
  variable_tokenizer &operator =(const variable_tokenizer &to_copy);
 
  int symbols() const;
 
  void reset();
 
  const structures::string_table &table() const;
  structures::string_table &table();
 
//fix these docs.
  bool parse(const basis::astring &to_tokenize);
 
  basis::astring find(const basis::astring &name) const;
 
  bool exists(const basis::astring &name) const;
 
  basis::astring text_form() const;
 
  void text_form(basis::astring &to_fill) const;
 
  // dictates whether the output will have spaces between the assignment
  // character and the key name and value.  default is to not add them.
  bool add_spaces() const { return _add_spaces; }
  void add_spaces(bool add_them) { _add_spaces = add_them; }
 
  bool okay_for_variable_name(char to_check) const;
 
  const basis::astring &assignments() const;
  const basis::astring &separators() const;
  const basis::astring &quotes() const;
 
  bool assignment(char to_check) const;
 
  bool separator(char to_check) const;
 
  bool comment_char(char to_check) const;
 
  bool is_eol_a_separator() const;
 
  bool quote_mark(char to_check) const;
 
private:
  structures::string_table *_implementation;  
  basis::astring *_assignments;  
  basis::astring *_separators;  
  basis::astring *_quotes;  
  bool _nesting;  
  basis::astring *_comments;  
  int _comment_number;  
  bool _add_spaces;  
};
 
} //namespace.
 
#endif