/*
 * CDE - Common Desktop Environment
 *
 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
 *
 * These libraries and programs are free software; you can
 * redistribute them and/or modify them under the terms of the GNU
 * Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * These libraries and programs are distributed in the hope that
 * they will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with these libraries and programs; if not, write
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301 USA
 */
/* $XConsortium: DocParser.h /main/6 1996/06/11 17:06:11 cde-hal $ */
/*	Copyright (c) 1995 FUJITSU LIMITED	*/
/*	All Rights Reserved			*/

#include <iostream>
#include <sstream>
using namespace std;

#include "SymTab.h"
#include "dti_excs/Exceptions.hh"

class Resolver;
class Attribute;
class AttributeList;

// parse SGML like documents

// attributes follow elements in an olias section

// <ELEMENT>
// <#><attr_1>value</>
//    <attr_2>value</>
//    <#olias_attr>value</>
// </>
// Element data here
// </ELEMENT>

class Element ;

class DocParser : public Destructable
{
public:
  enum TagType { StartTag, EndTag, AttributeSection, OliasAttribute, NoTag };

  DocParser(Resolver &);
  virtual ~DocParser();
  
  // returns a boolean  
  unsigned int	parse(istream &);

  // parse without calling Begin() and End() on the renderer.
  unsigned int	rawParse(istream &);

protected:
  virtual void read_data(istream &, ostringstream &);

private:
  
  void		process(istream &, ostringstream &, const Symbol &tagname,
			unsigned int sibling_number,
			unsigned int relative_sibling_number);
  TagType	read_tag(istream &, ostringstream &);
  void		process_entity(istream &, ostringstream &);

  void		process_attributes(istream &, ostringstream &,
				   AttributeList *&attrs,
				   AttributeList *&olias_attrs);
  Attribute    *process_attribute(istream &, ostringstream &, const Symbol &name, TagType);
  
private:
  unsigned int	f_ignoring_element ;
  Resolver      &f_resolver;
#if defined(SC3)
  char* const	f_buffer;
  ostrstream	f_output;
#else
  stringbuf	*f_streambuf;
  ostringstream	f_output;
#endif
};