tokenizer.h

Go to the documentation of this file.

#ifndef TOKENIZER_CLASS
#define TOKENIZER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : 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 "textual_dll.h"

#include <basis/object_base.h>

// forward.
class string_table;


class TEXTUAL_CLASS_STYLE tokenizer : public virtual object_base
{
public:
  enum constraints { DEFAULT_MAX_BITS = 7 };

  tokenizer(int max_bits = DEFAULT_MAX_BITS);

  tokenizer(const istring &separator, const istring &assignment,
          int max_bits = DEFAULT_MAX_BITS);

  tokenizer(const istring &separator, const istring &assignment,
          const istring &quotes, bool nesting = true,
          int max_bits = DEFAULT_MAX_BITS);

  tokenizer(const tokenizer &to_copy);

  virtual ~tokenizer();

  IMPLEMENT_CLASS_NAME("tokenizer");

  void set_comment_chars(const istring &comments);

  tokenizer &operator =(const tokenizer &to_copy);

  int symbols() const;

  void reset();

  const string_table &table() const;
  string_table &table();

//fix these docs.
  void parse(const istring &to_tokenize);

  istring find(const istring &name) const;

  bool exists(const istring &name) const;

  istring text_form() const;

  void text_form(istring &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 istring &assignments() const;
  const istring &separators() const;
  const istring &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:
  string_table *_implementation;  
  istring *_assignments;  
  istring *_separators;  
  istring *_quotes;  
  bool _nesting;  
  istring *_comments;  
  int _comment_number;  
  bool _add_spaces;  
};

#endif

---