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 <string>
  20 #include <utility>
  21
  22 class Buffer;
  23
  24 namespace sgml {
  25
  26 /**
  27  * Escape the given character, if necessary,
  28  * to an SGML entity. Returns true
  29  * if it was a whitespace character.
  30  */
  31 std::pair<bool, std::string> escapeChar(char c);
  32
  33 /// Escape a word instead of a single character
  34 std::string escapeString(std::string const & raw);
  35
  36 /// Opens tag
  37 int openTag(Buffer const & buf, std::ostream & os, lyx::depth_type depth,
  38             bool mixcont, std::string const & name,
  39             std::string const & param = std::string());
  40
  41 /// Close tag
  42 int closeTag(std::ostream & os, lyx::depth_type depth,
  43             bool mixcont, std::string const & name);
  44
  45 }
  46 #endif // SGML_H