xml_generator.h

Go to the documentation of this file.

#ifndef XML_GENERATOR_CLASS
#define XML_GENERATOR_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : xml_generator                                                     *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2007-$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/astring.h>
#include <basis/contracts.h>
#include <structures/string_table.h>
 
namespace textual {
 
class tag_info;
class tag_stack;
 
 
class xml_generator
{
public:
  enum behavioral_mods {
    HUMAN_READABLE = 0x1,
    CLEAN_ILLEGAL_CHARS = 0x2
  };
 
  xml_generator(int modifiers = HUMAN_READABLE | CLEAN_ILLEGAL_CHARS);
 
  virtual ~xml_generator();
 
  DEFINE_CLASS_NAME("xml_generator");
 
  enum outcomes {
    OKAY = basis::common::OKAY,
    NOT_FOUND = basis::common::NOT_FOUND,
    ERRONEOUS_TAG = basis::common::INVALID //temporary until we can shed a compatibility concern.
//    DEF INE_OUTCOME(ERRONEOUS_TAG, -75, "The most recently opened tag must be "
//        "closed before a new tag can be opened and before any other tag can "
//        "be closed"),
  };
 
  static const char *outcome_name(const basis::outcome &to_name);
 
  void reset();  
 
  basis::astring generate();
 
  void generate(basis::astring &generated);
 
  basis::outcome add_header(const basis::astring &tag_name, const structures::string_table &attributes);
 
  basis::outcome open_tag(const basis::astring &tag_name, const structures::string_table &attributes);
 
  basis::outcome open_tag(const basis::astring &tag_name);
 
  basis::outcome close_tag(const basis::astring &tag_name);
 
  void close_all_tags();
 
  basis::outcome add_content(const basis::astring &content);
 
  void set_indentation(int to_indent);
 
  static basis::astring clean_reserved(const basis::astring &to_modify,
          bool replace_spaces = false);
 
  static void clean_reserved_mod(basis::astring &to_modify,
          bool replace_spaces = false);
 
private:
  tag_stack *_tags;  
  basis::astring *_accumulator;  
  bool _human_read;  
  bool _clean_chars;  
  int _indentation;  
 
  enum open_types { NORMAL_TAG, HEADER_TAG };
  void print_open_tag(const tag_info &to_print, int type = NORMAL_TAG);
  void print_close_tag(const basis::astring &tag_name);
};
 
} //namespace.
 
#endif