src/mathed/MathParser.h

   1 // -*- C++ -*-
   2 /**
   3  * \file MathParser.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MATH_PARSER_H
  14 #define MATH_PARSER_H
  15
  16 #include "MathParser_flags.h"
  17
  18 #include "support/docstring.h"
  19
  20
  21 namespace lyx {
  22
  23 class Buffer;
  24 class MathAtom;
  25 class MathData;
  26 class InsetMathGrid;
  27 class Lexer;
  28
  29
  30 ///
  31 class latexkeys {
  32 public:
  33         /// name of the macro or primitive
  34         docstring name;
  35         /// name of a inset that handles that macro
  36         docstring inset;
  37         /**
  38          * The string or symbol to draw.
  39          * This is a string of length 1 if \p name is a known symbol, and
  40          * the corresponding font is available. In this case it is
  41          * NO UCS4 STRING! The only "character" of the string simply denotes
  42          * the code point of the symbol in the font. Therefore you have to
  43          * be very careful if you pass \c draw to any function that takes a
  44          * docstring argument.
  45          * If \p name is a known symbol, but the corresponding font is not
  46          * available, or if it is a function name, then \c draw contains a
  47          * regular UCS4 string (actuallay \c draw == \c name) that is painted
  48          * on screen.
  49          */
  50         docstring draw;
  51         /// operator/..., fontname e
  52         docstring extra;
  53         /// how is this called as XML entity in MathML?
  54         docstring xmlname;
  55         /// required LaTeXFeatures
  56         docstring requires;
  57 };
  58
  59
  60 /// check whether this is a well-known (La)TeX macro or primitive
  61 latexkeys const * in_word_set(docstring const & str);
  62
  63 /// parse formula from a string
  64 bool mathed_parse_normal(Buffer * buf, MathAtom &, docstring const &,
  65                 Parse::flags f = Parse::NORMAL);
  66
  67 /// parse formula from the LyX lexxer
  68 bool mathed_parse_normal(Buffer * buf, MathAtom &, Lexer &,
  69                 Parse::flags f = Parse::NORMAL);
  70
  71 /// parse formula from a string into a grid
  72 bool mathed_parse_normal(InsetMathGrid &, docstring const &,
  73                 Parse::flags f = Parse::NORMAL);
  74
  75 /// parse a single cell from a string
  76 bool mathed_parse_cell(MathData & ar, docstring const &,
  77                 Parse::flags f = Parse::NORMAL);
  78
  79 /// parse a single cell from a stream. Only use this for reading from .lyx
  80 /// file format, for the reason see Parser::tokenize(std::istream &).
  81 bool mathed_parse_cell(MathData & ar, std::istream &,
  82                 Parse::flags f = Parse::NORMAL);
  83
  84 void initParser();
  85
  86
  87 } // namespace lyx
  88
  89 #endif