src/output_latex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file output_latex.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef OUTPUT_LATEX_H
  13 #define OUTPUT_LATEX_H
  14
  15 #include <utility>
  16
  17 #include "support/docstream.h"
  18 #include "Layout.h"
  19 #include "ParagraphList.h"
  20
  21
  22 namespace lyx {
  23
  24 class Buffer;
  25 class BufferParams;
  26 class Encoding;
  27 class Layout;
  28 class Paragraph;
  29 class OutputParams;
  30 class Text;
  31
  32 /** Export optional and required arguments of the paragraph \p par.
  33     Non-existing required arguments are output empty: {}.
  34  */
  35 void latexArgInsets(Paragraph const & par,
  36                 otexstream & os, OutputParams const & runparams,
  37                 Layout::LaTeXArgMap const & latexargs,
  38                 std::string const & prefix = std::string());
  39 /// Same for multi-par sequences (e.g. merged environments or InsetLayouts)
  40 void latexArgInsets(ParagraphList const & pars, ParagraphList::const_iterator pit,
  41                 otexstream & os, OutputParams const & runparams,
  42                 Layout::LaTeXArgMap const & latexargs,
  43                 std::string const & prefix = std::string());
  44 /** Export \p paragraphs of buffer \p buf to LaTeX.
  45     Don't use a temporary stringstream for \p os if the final output is
  46     supposed to go to a file.
  47     \sa Buffer::writeLaTeXSource for the reason.
  48  */
  49 void latexParagraphs(Buffer const & buf,
  50                      Text const & text,
  51                      otexstream & ofs,
  52                      OutputParams const &,
  53                      std::string const & everypar = std::string());
  54
  55 /** Switch the encoding of \p os from runparams.encoding to \p newEnc if needed.
  56     \p force forces this also within non-default or -auto encodings.
  57     \return (did the encoding change?, number of characters written to \p os)
  58  */
  59 std::pair<bool, int> switchEncoding(odocstream & os,
  60                      BufferParams const & bparams,
  61                      OutputParams const &, Encoding const & newEnc,
  62                      bool force = false);
  63
  64 /// FIXME: this should not be visible.
  65 void TeXOnePar(Buffer const & buf,
  66                    Text const & text,
  67                    pit_type pit,
  68                    otexstream & os,
  69                    OutputParams const & runparams,
  70                    std::string const & everypar = std::string(),
  71                    int start_pos = -1, int end_pos = -1);
  72
  73 } // namespace lyx
  74
  75 #endif