lyx_mirror/src/Encoding.h

165 lines
4.3 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file Encoding.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
* \author Jean-Marc Lasgouttes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef ENCODING_H
#define ENCODING_H
2007-01-28 21:27:45 +00:00
#include "support/docstring.h"
#include <map>
2007-01-28 21:27:45 +00:00
#include <set>
namespace lyx {
namespace support { class FileName; }
2007-01-28 21:27:45 +00:00
class LaTeXFeatures;
///
class Encoding {
public:
/// Which LaTeX package handles this encoding?
enum Package {
none,
inputenc,
CJK
};
///
Encoding() {}
///
Encoding(std::string const & n, std::string const & l,
std::string const & i, bool f, Package p);
///
void init() const;
///
std::string const & name() const { return Name_; }
///
std::string const & latexName() const { return LatexName_; }
///
std::string const & iconvName() const { return iconvName_; }
2007-01-28 21:27:45 +00:00
/**
* Convert \p c to something that LaTeX can understand.
* This is either the character itself (if it is representable
* in this encoding), or a LaTeX macro.
* If the character is not representable in this encoding, but no
* LaTeX macro is known, a warning is given of lyxerr, and the
* character is returned.
*/
docstring const latexChar(char_type c) const;
/// Which LaTeX package handles this encoding?
Package package() const { return package_; }
private:
///
std::string Name_;
///
std::string LatexName_;
///
std::string iconvName_;
/// Is this a fixed width encoding?
bool fixedwidth_;
2007-01-28 21:27:45 +00:00
///
typedef std::set<char_type> CharSet;
/// Set of UCS4 characters that we can encode (for singlebyte
/// encodings only)
mutable CharSet encodable_;
2007-01-28 21:27:45 +00:00
/// All code points below this are encodable. This helps us to avoid
/// lokup of ASCII characters in encodable_ and gives about 1 sec
/// speedup on export of the Userguide.
mutable char_type start_encodable_;
/// Which LaTeX package handles this encoding?
Package package_;
/**
* If this is true the stored information about the encoding covers
* all encodable characters. We set this to false initially so that
* we only need to query iconv for the actually used encodings.
* This is needed especially for the multibyte encodings, if we
* complete all encoding info on startup it takes 2-3 minutes.
*/
mutable bool complete_;
};
class Encodings {
public:
///
typedef std::map<std::string, Encoding> EncodingList;
/// iterator to iterate over all encodings.
/// We hide the fact that our encoding list is implemented as a map.
class const_iterator : public EncodingList::const_iterator {
typedef EncodingList::const_iterator base;
public:
const_iterator() : base() {}
const_iterator(base const & b) : base(b) {}
Encoding const & operator*() const { return base::operator*().second; }
Encoding const * operator->() const { return &(base::operator*().second); }
};
///
Encodings();
2007-01-28 21:27:45 +00:00
/// Read the encodings.
/// \param encfile encodings definition file
/// \param symbolsfile unicode->LaTeX mapping file
void read(support::FileName const & encfile,
support::FileName const & symbolsfile);
/// Get encoding from LyX name \p name
Encoding const * getFromLyXName(std::string const & name) const;
/// Get encoding from LaTeX name \p name
Encoding const * getFromLaTeXName(std::string const & name) const;
///
const_iterator begin() const { return encodinglist.begin(); }
///
const_iterator end() const { return encodinglist.end(); }
///
enum Letter_Form {
///
FORM_ISOLATED,
///
FORM_FINAL,
///
FORM_INITIAL,
///
FORM_MEDIAL
};
///
static bool isComposeChar_hebrew(char_type c);
///
static bool isComposeChar_arabic(char_type c);
///
static bool is_arabic_special(char_type c);
///
static bool is_arabic(char_type c);
///
static char_type transformChar(char_type c, Letter_Form form);
2007-01-28 21:27:45 +00:00
/// Is this a combining char?
static bool isCombiningChar(char_type c);
/**
* Add the preamble snippet needed for the output of \p c to
* \p features.
* This does not depend on the used encoding, since the inputenc
* package only maps the code point \p c to a command, it does not
* make this command available.
*/
static void validate(char_type c, LaTeXFeatures & features);
private:
///
EncodingList encodinglist;
};
extern Encodings encodings;
} // namespace lyx
#endif