translator_cn.h

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

/******************************************************************************
 *
 * $Id: translator_cn.h,v 1.3 2001/03/19 19:27:41 root Exp $
 *
 * 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_CN_H
#define TRANSLATOR_CN_H

#include "translator_adapter.h"

/*!
   If you want insert a space whenever Chinese meets English charactors, set
   CN_SPC to " ", else null.
*/
#define CN_SPC

class TranslatorChinese : public TranslatorAdapter_1_2_11
{
  public:
		/*! Used for identification of the language. The identification
		 * should not be translated. It should be replaced by the name
		 * of the language in English using lower-case characters only
		 * (e.g. "czech", "japanese", "russian", etc.). It sould be equal to
		 * the identification used in the language.cpp.
		 */
    virtual QCString idLanguage()
    { return "chinese"; }

		/*! Used to get the LaTeX command(s) for the language support. 
		 * This method should return string with commands that switch
		 * LaTeX to the desired language.  For example 
		 * <pre>"\\usepackage[german]{babel}\n"
		 * </pre>
		 * or
		 * <pre>"\\usepackage{polski}\n"
		 * "\\usepackage[latin2]{inputenc}\n"
		 * "\\usepackage[T1]{fontenc}\n"
		 * </pre>
		 * 
		 * The English LaTeX does not use such commands.  Because of this
		 * the empty string is returned in this implementation.
		 */
		virtual QCString latexLanguageSupportCommand()
		{
   		QCString result(latexBabelPackage());
      if (!result.isEmpty())
      {
        result = "\\usepackage{" + result;
        result += "}\n";
      }
      return result;
		}

    virtual QCString latexBabelPackage()
    { return "CJK"; }

		/*! return the language charset. This will be used for the HTML output */
    virtual QCString idLanguageCharset()
    { return "gb2312"; }

		/*! used in the compound documentation before a list of related functions. 
		 */
    virtual QCString trRelatedFunctions()
    { return "相关函数"; }

		/*! subscript for the related functions. */
    virtual QCString trRelatedSubscript()
    { return "（注意：这些不是成员函数。）"; }

		/*! header that is put before the detailed description of files, 
		 * classes and namespaces. 
		 */
    virtual QCString trDetailedDescription()
    { return "详细描述"; }

		/*! header that is put before the list of typedefs. */
    virtual QCString trMemberTypedefDocumentation()
    { return "成员类型定义文档"; }

		/*! header that is put before the list of enumerations. */
    virtual QCString trMemberEnumerationDocumentation()
    { return "成员枚举类型文档"; }

    virtual QCString trEnumerationValueDocumentation()
    { return "成员枚举值文档"; }

		/*! header that is put before the list of member function. */
    virtual QCString trMemberFunctionDocumentation()
    { return "成员函数文档"; }

		/*! header that is put before the list of member attributes. */
    virtual QCString trMemberDataDocumentation()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) 
			{
				return "字段文档"; 
			}
			else {
				return "成员数据文档"; 
			}
		}

		/*! this is the text of a link put after brief descriptions. */
    virtual QCString trMore()
    { return "更多..."; }

		/*! put in the class documention */
    virtual QCString trListOfAllMembers()
    { return "所有成员的列表。"; }

		/*! used as the title of the "list of all members" page of a class */
    virtual QCString trMemberList()
    { return "成员列表"; }

		/*! this is the first part of a sentence that is followed by a class name */
    virtual QCString trThisIsTheListOfAllMembers()
    { return "成员的完整列表，这些成员属于"CN_SPC; }

		/*! this is the remainder of the sentence after the class name */
    virtual QCString trIncludingInheritedMembers()
    { return "，包括所有继承而来的成员"; }

		/*! this is put at the author sections at the bottom of man pages.
		 *  parameter s is name of the project name.
		 */
    virtual QCString trGeneratedAutomatically(const char *s)
    {
			QCString result;
      if (s) result=(QCString)"为"CN_SPC+s+"，";
      result+="由"CN_SPC"Doyxgen"CN_SPC"通过分析源代码自动生成。"; 
      return result;
    }

		/*! put after an enum name in the list of all members */
    virtual QCString trEnumName()
    { return "枚举名称"; }

		/*! put after an enum value in the list of all members */
    virtual QCString trEnumValue()
    { return "枚举值"; }

		/*! put after an undocumented member in the list of all members */
    virtual QCString trDefinedIn()
    { return "定义于"CN_SPC; }

		// quick reference sections


    virtual QCString trVerbatimText(const char *f)
    { return (QCString)"这是头文件"CN_SPC+f+CN_SPC"的源代码。"; }

		/*! This is put above each page as a link to the list of all groups of 
		 *  compounds or files (see the \\group command).
		 */
    virtual QCString trModules()
    { return "模块"; }

		/*! This is put above each page as a link to the class hierarchy */
 		virtual QCString trClassHierarchy()
    { return "类继承关系"; }

		/*! This is put above each page as a link to the list of annotated class */
 		virtual QCString trCompoundList()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
				return "数据结构"; 
			}
			else {
				return "组合类型列表"; 
			}
		}

		/*! This is put above each page as a link to the list of documented files */
    virtual QCString trFileList()
    { return "文件列表"; }


		/*! This is put above each page as a link to the list of all verbatim headers */
    virtual QCString trHeaderFiles()
    { return "头文件"; }

		/*! This is put above each page as a link to all members of compounds. */
    virtual QCString trCompoundMembers()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) { 
				return "数据字段"; 
			}
			else {
				return "组合类型成员"; 
			}
		}

		/*! This is put above each page as a link to all member of files. */
    virtual QCString trFileMembers()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
				return "全局定义"; 
			} else {
				return "文件成员"; 
			}
		}

		/*! This is put above each page as a link to all related pages. */
    virtual QCString trRelatedPages()
    { return "相关页面"; }

		/*! This is put above each page as a link to all examples. */
    virtual QCString trExamples()
    { return "示例"; }

    virtual QCString trSearch()
    { return "搜索"; }

    virtual QCString trClassHierarchyDescription()
    { return "此列表基本按字典顺序排序："; }

    virtual QCString trFileListDescription(bool extractAll)
    {
   		QCString result="这里列出所有";
      if (!extractAll) result+="文档化的";
      result+="文件，附带简要说明：";
      return result;
    }

    virtual QCString trCompoundListDescription()
    { 

			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
			{
				return "这里列出所有数据结构，附带简要说明："; 
			}
			else
			{
				return "这里列出所有类、结构、联合以及接口定义，附带简要说明："; 
			}
    }

    virtual QCString trCompoundMembersDescription(bool extractAll)
    {
   		QCString result="这里列出所有";
      if (!extractAll) {
				result+="文档化的";
			}
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
				result+="结构和联合的成员，附带";
			}
			else {
				result+="类成员，附带";
			}

      if (extractAll) {
				if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
					result+="所在结构／联合的文档的链接：";
				}
				else {
					result+="所在类的文档的链接：";
				}
			}
      else {
				if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
					result+="所属结构／联合的链接：";
				}
				else {
					result+="所属类的链接：";
				}
			}
      return result;
    }

    virtual QCString trFileMembersDescription(bool extractAll)
    {
   		QCString result="这里列出所有";
      if (!extractAll) 
				result +="文档化的";

			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) {
				result +="函数，变量，宏，枚举和类型定义，附带";
			} 
			else {
				result +="文件成员，附带";
			}

      if (extractAll) 
				result+="所在文件的文档的链接：";
      else 
				result+="所在文件的链接：";
      return result;
    }

    virtual QCString trHeaderFilesDescription()
    { return "这里列出组成API的头文件："; }

    virtual QCString trExamplesDescription()
    { return "这里列出所有示例："; }

    virtual QCString trRelatedPagesDescription()
    { return "这里列出所有相关的页面："; }

    virtual QCString trModulesDescription()
    { return "这里列出所有模块"; }

    virtual QCString trNoDescriptionAvailable()
    { return "无可用文档"; }

    virtual QCString trDocumentation()
    { return "文档"; }

    virtual QCString trModuleIndex()
    { return "模块索引"; }

    virtual QCString trHierarchicalIndex()
    { return "继承关系索引"; }

    virtual QCString trCompoundIndex()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
			{
				return "数据结构索引"; 
			} 
			else {
				return "组合类型索引"; 
			}
		}

    virtual QCString trFileIndex() 
    { return "文件索引"; }

    virtual QCString trModuleDocumentation()
    { return "模块文档"; }

    virtual QCString trClassDocumentation()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
			{
				return "数据结构文档";
			}
			else {
				return "类文档"; 
			}
		}

    virtual QCString trFileDocumentation()
    { return "文件文档"; }

    virtual QCString trExampleDocumentation()
    { return "示例文档"; }

    virtual QCString trPageDocumentation()
    { return "页面文档"; }

    virtual QCString trReferenceManual()
    { return "参考手册"; }

    virtual QCString trDefines()
    { return "宏定义"; }

    virtual QCString trFuncProtos()
    { return "函数原型"; }

    virtual QCString trTypedefs()
    { return "类型定义"; }

    virtual QCString trEnumerations()
    { return "枚举"; }

    virtual QCString trFunctions()
    { return "函数"; }

    virtual QCString trVariables()
    { return "变量"; }

    virtual QCString trEnumerationValues()
    { return "枚举值"; }

    virtual QCString trAuthor()
    { return "作者"; }

 		virtual QCString trDefineDocumentation()
    { return "宏定义文档"; }

 		virtual QCString trFunctionPrototypeDocumentation()
    { return "函数原型文档"; }

 		virtual QCString trTypedefDocumentation()
    { return "类型定义文档"; }

 		virtual QCString trEnumerationTypeDocumentation()
    { return "枚举类型文档"; }

 		virtual QCString trFunctionDocumentation()
    { return "函数文档"; }

 		virtual QCString trVariableDocumentation()
    { return "变量文档"; }

 		virtual QCString trCompounds()
    { 
			if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
			{ 
				return "数据结构";
			}
			else {
				return "组合类型"; 
			}
		}

 		virtual QCString trFiles()
    { return "文件"; }

 		virtual QCString trGeneratedAt(const char *date,const char *projName)
    { 
   		QCString result=(QCString)"Generated at "+date;
      if (projName) result+=(QCString)" for "+projName;
      result+=(QCString)" by";
      return result;
    }

 		virtual QCString trWrittenBy()
    {
      return "written by";