src/sgml.h

   1 // -*- C++ -*-
   2 /**
   3  * \file sgml.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author José Matos
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef SGML_H
  14 #define SGML_H
  15
  16 #include "support/types.h"
  17
  18 #include <iosfwd>
  19 #include <utility>
  20
  21 namespace sgml {
  22
  23 /**
  24  * Escape the given character if necessary
  25  * to an SGML entity. Returns true
  26  * if it was a whitespace character.
  27  */
  28 std::pair<bool, std::string> escapeChar(char c);
  29
  30 /// FIXME
  31 int openTag(std::ostream & os, lyx::depth_type depth,
  32             bool mixcont, std::string const & latexname,
  33                 std::string const & latexparam = std::string());
  34
  35 /// FIXME
  36 int closeTag(std::ostream & os, lyx::depth_type depth,
  37             bool mixcont, std::string const & latexname);
  38
  39 ///
  40 unsigned int closeEnvTags(std::ostream & os,
  41                 bool mixcont,
  42                 std::string const & environment_inner_depth,
  43                 std::string const & item_tag,
  44                 lyx::depth_type total_depth);
  45
  46 }
  47
  48 #endif // SGML_H