translator_cz.h

doxygen(一个自动从源代码生成文档的工具)的源代码

/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2001 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef TRANSLATOR_CZ_H
#define TRANSLATOR_CZ_H


// The first translation from English to Czech was started by
// Vlastimil Havran. He wrote:
// 
//   "In the cases where are more translations possible I hope
//    that I have selected the most reasonable text. If not, please,
//    mail the comments and text proposals to
//
//    [e-mail], 1999/04/11"
//    
// The prototype version of Czech strings with diacritics was
// implemented by Petr Prikryl ([e-mail]), 2000/06/20. As
// Vlastimil was quite busy at the time, he agreed that Petr be the
// maintainer for a while (from 2000/06/20).
//
// Updates:
// --------
// 2000/06/20
//  - The prototype version of Czech strings with diacritics. The
//    translation was based on translator.h of Doxygen version
//    1.1.4 (from scratch).
//
// 2000/07/10
//  - Updated version based on 1.1.5 sources (including important updates
//    of the up-to-1.1.4 strings). Czech strings in this file were written
//    in windows-1250 encoding. On-line decoding into iso-8859-2 ensured
//    via conditional compilation if the sources are compiled under UNIX.
//
// 2000/07/19
//  - Encoding conversion tables moved to the methods that use them.
//  - Updates for "new since 1.1.5".
//
// 2000/08/02 (Petr Prikryl)
//  - Updated for 1.2.0
//
// 2000/08/24
//  - Changed trTodo() text from "Udelat" to "Planovane upravy"
//    which seems more appropriate in the document context.
//  - Typo corrected in trMemberTypedefDocumentation().
//
// 2000/08/30
//  - Macro DECODE replaced by the inline Decode() (proposed by
//    Boris Bralo <[e-mail]> in translator_hr.h).
//
// 2000/08/31
//  - Methods ISOToWin() and WinToISO() renamed and moved to the
//    base class (in translator.h) to be shared with the Croatian
//    translator.
//
// 2000/09/06
//  - Reimplementation of the method trInheritsList() which takes 
//    into account quantity of base classes.
//
// 2000/09/11
//  - Update for "new since 1.2.1" version. The text of trDCOPMethods()
//    was translated rather blindly (not knowing what exactly
//    the DCOP means).
//    
// 2000/10/17
//  - Update for "new since 1.2.2" version. 
//
// 2001/01/09
//  - Update for "new since 1.2.4" version. As I do not use Java,
//    I tried my best to guess the Czech terminology for the Java.
//    Let me know if some wording should be changed/improved.
//         
// 2001/02/15
//  - trMore() now returns only "..." (ellipsis).  The Czech replacement
//    of "(more)" was too much visible.  The previous "(...)" did not 
//    look well.
//    
// 2001/02/26
//  - Update for "new since 1.2.5" version (trBug(), trBugList()).
//         
// 2001/03/12
//  - Minor correction of comments which copied the same
//    corrections in translator.h (doubled backslash) just after 
//    1.2.6 release.
//    
// 2001/04/10
//  - Update for OPTIMIZE_OUTPUT_FOR_C (1.2.6-20010408).
//  - Removed implementation of latexBabelPackage().
//  - Removed implementation of trVerbatimText().
//  
// 2001/04/20
//  - Update for "new since 1.2.6-20010422". Experimental version
//    introducing TranslatorAdapter class and the abstract base
//    class Translator.  The English translator is now on the same
//    level as other translators.
//
// 2001/05/02
//  - The Decode() inline identifier changed to decode (i.e. lower
//    case) to be consistent with HR and RU translator, which also
//    use the approach.
//  - Removed the obsolete method trFiles().
//         
// 2001/05/18
//  - The trRelatedPagesDescription() content updated to fit 
//    the context better.
//  - Implemented new method trAuthor(params).
//  - Removed obsolete methods trAuthor() and trAuthors().
//
// 2001/05/25
//  - Updated misleading information in trLegendDocs().
//  - The trReimplementedInList() updated to fit the context better.
//  - The trReimplementedFromList() updated to fit the context better.
//
// 2001/07/16
//  - trClassDocumentation() updated as in the English translator.
//    
// 2001/11/06
//  - trReferences() implemented.
//    
//  
// Todo
// ----
//  - The trReimplementedFromList() should pass the kind of the 
//    reimplemented element.  It can be method, typedef or possibly 
//    something else.  It is difficult to find the general translation
//    for all kinds in the Czech language.
// 
// Notices:
// -------- 
// The conditional compilation ensures or the neutral functionality
// of the private inline decode(), or calling the WinToISO() method
// for on-line encoding conversion. If you want to maintain the
// source in the iso-8859-2, do convert the encoding of the source,
// change the conditional definition of the inline decode() using the
// method ISO88592ToWin1250() -- for conversion of strings for the
// Windows version. The version which does not call the function is
// probably slightly faster.


class TranslatorCzech : public Translator
{
  private:
    /*! The decode() inline assumes the source written in the 
        Windows encoding (maintainer only dependent). 
     */
    inline QCString decode(const QCString & sInput)
    { 
#ifdef _WIN32
      return sInput;
#else
      return Win1250ToISO88592(sInput);
#endif
    }
    
  public:
    // --- Language control methods -------------------

    virtual QCString idLanguage()
    { return "czech"; }

    virtual QCString latexLanguageSupportCommand()
    { return "\\usepackage{czech}\n"; }
    
    /*! return the language charset. This will be used for the HTML output */
    virtual QCString idLanguageCharset()
    {
#ifdef _WIN32
        return "windows-1250";
#else
        return "iso-8859-2";
#endif
    }

    // --- Language translation methods -------------------

    /*! used in the compound documentation before a list of related functions. */
    virtual QCString trRelatedFunctions()
    { return decode("Souvisej韈