;;; po-mode.el -- major mode for GNU gettext PO files

;; Copyright (C) 1995-1999, 2000-2002 Free Software Foundation, Inc.

;; Authors: François Pinard <pinard@iro.umontreal.ca>

;;          Greg McGary <gkm@magilla.cichlid.com>

;; Keywords: i18n gettext

;; Created: 1995

;; This file is part of GNU gettext.

;; GNU gettext is free software; you can redistribute it and/or modify

;; it under the terms of the GNU General Public License as published by

;; the Free Software Foundation; either version 2, or (at your option)

;; any later version.

;; GNU gettext is distributed in the hope that it will be useful,

;; but WITHOUT ANY WARRANTY; without even the implied warranty of

;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License

;; along with GNU Emacs; see the file COPYING.  If not, write to the

;; Free Software Foundation, 59 Temple Place - Suite 330, Boston,

;; MA 02111-1307, USA.

;;; Commentary:

;; This package provides the tools meant to help editing PO files,

;; as documented in the GNU gettext user's manual.  See this manual

;; for user documentation, which is not repeated here.

;; To install, merely put this file somewhere GNU Emacs will find it,

;; then add the following lines to your .emacs file:

;;

;;   (autoload 'po-mode "po-mode"

;;             "Major mode for translators to edit PO files" t)

;;   (setq auto-mode-alist (cons '("\\.po\\'\\|\\.po\\." . po-mode)

;;				  auto-mode-alist))

;;

;; To use the right coding system automatically under Emacs 20 or newer,

;; also add:

;;

;;   (autoload 'po-find-file-coding-system "po-compat")

;;   (modify-coding-system-alist 'file "\\.po\\'\\|\\.po\\."

;;				  'po-find-file-coding-system)

;;

;; You may also adjust some variables, below, by defining them in your

;; '.emacs' file, either directly or through command 'M-x customize'.

;;; Code:

(defconst po-mode-version-string "2.01" "\

Version number of this version of po-mode.el.")

;;; Emacs portability matters - part I.

;;; Here is the minimum for customization to work.  See part II.

;; Identify which Emacs variety is being used.

;; This file supports:

;;   - XEmacs (version 19 and above) -> po-XEMACS = t,

;;   - GNU Emacs (version 20 and above) -> po-EMACS20 = t,

;;   - GNU Emacs (version 19) -> no flag.

(eval-and-compile

  (cond ((string-match "XEmacs\\|Lucid" emacs-version)

	 (setq po-EMACS20 nil po-XEMACS t))

	((and (string-lessp "19" emacs-version) (featurep 'faces))

	 (setq po-EMACS20 t po-XEMACS nil))

	(t (setq po-EMACS20 nil po-XEMACS nil))))

;; Experiment with Emacs LISP message internationalisation.

(eval-and-compile

  (or (fboundp 'set-translation-domain)

      (defsubst set-translation-domain (string) nil))

  (or (fboundp 'translate-string)

      (defsubst translate-string (string) string)))

(defsubst _ (string) (translate-string string))

(defsubst N_ (string) string)

;; Handle missing 'customs' package.

(eval-and-compile

  (condition-case ()

      (require 'custom)

    (error nil))

  (if (and (featurep 'custom) (fboundp 'custom-declare-variable))

      nil

    (defmacro defgroup (&rest args)

      nil)

    (defmacro defcustom (var value doc &rest args)

      (` (defvar (, var) (, value) (, doc))))))

;;; Customisation.

(defgroup po nil

  "Major mode for editing PO files"

  :group 'i18n)

(defcustom po-auto-edit-with-msgid nil

  "*Automatically use msgid when editing untranslated entries."

  :type 'boolean

  :group 'po)

(defcustom po-auto-fuzzy-on-edit nil

  "*Automatically mark entries fuzzy when being edited."

  :type 'boolean

  :group 'po)

(defcustom po-auto-select-on-unfuzzy nil

  "*Automatically select some new entry while making an entry not fuzzy."

  :type 'boolean

  :group 'po)

(defcustom po-auto-replace-revision-date t

  "*Automatically revise date in headers.  Value is nil, t, or ask."

  :type '(choice (const nil)

		 (const t)

		 (const ask))

  :group 'po)

(defcustom po-default-file-header "\

# SOME DESCRIPTIVE TITLE.

# Copyright (C) YEAR Free Software Foundation, Inc.

# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

#

#, fuzzy

msgid \"\"

msgstr \"\"

\"Project-Id-Version: PACKAGE VERSION\\n\"

\"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\\n\"

\"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n\"

\"Language-Team: LANGUAGE <LL@li.org>\\n\"

\"MIME-Version: 1.0\\n\"

\"Content-Type: text/plain; charset=CHARSET\\n\"

\"Content-Transfer-Encoding: 8bit\\n\"

"

  "*Default PO file header."

  :type 'string

  :group 'po)

(defcustom po-translation-project-address

  "translation@iro.umontreal.ca"

  "*Electronic mail address of the Translation Project.

Typing \\[po-send-mail] (normally bound to `M') the user will send the PO file

to this email address."

  :type 'string

  :group 'po)

(defcustom po-translation-project-mail-label "TP-Robot"

  "*Subject label when sending the PO file to `po-translation-project-address'.

Don't change it when you send PO files to \"translation@iro.umontreal.ca\", the

Translation Project Robot at http://www.iro.umontreal.ca/contrib/po/HTML/.  If

the label is different, your submission will be consiedered as a regular mail

and not stored at the TP site and also not forwarded to the package maintainer."

  :type 'string

  :group 'po)

(defcustom po-highlighting (or po-EMACS20 po-XEMACS)

  "*Highlight text whenever appropriate, when non-nil.

However, on older Emacses, a yet unexplained highlighting bug causes files

to get mangled."

  :type 'boolean

  :group 'po)

(defcustom po-highlight-face 'highlight

  "*The face used for PO mode highlighting.  For Emacses with overlays.

Possible values are 'highlight', 'modeline', 'secondary-selection',

'region', and 'underline'.

This variable can be set by the user to whatever face they desire.

It's most convenient if the cursor color and highlight color are

slightly different."

  :type 'face

  :group 'po)

(defcustom po-team-name-to-code

  ;; All possible languages, a complete ISO 639 list and a little more.

  '(("LANGUAGE" . "LL")

    ("(Afan) Oromo" . "om")

    ("Abkhazian" . "ab")

    ("Afar" . "aa")

    ("Afrikaans" . "af")

    ("Albanian" . "sq")

    ("Amharic" . "am")

    ("Arabic" . "ar")

    ("Argentinian" . "es_AR")

    ("Armenian" . "hy")

    ("Assamese" . "as")

    ("Avestan" . "ae")

    ("Aymara" . "ay")

    ("Azerbaijani" . "az")

    ("Bashkir" . "ba")

    ("Basque" . "eu")

    ("Belarusian" . "be")

    ("Bengali" . "bn")

    ("Bihari" . "bh")

    ("Bislama" . "bi")

    ("Bosnian" . "bs")

    ("Brazilian Portuguese" . "pt_BR")

    ("Breton" . "br")

    ("Bulgarian" . "bg")

    ("Burmese" . "my")

    ("Catalan" . "ca")

    ("Chamorro" . "ch")

    ("Chechen" . "ce")

    ("Chinese" . "zh")

    ("Chinese (simplified)" . "zh_CN")

    ("Chinese (traditional)" . "zh_TW")

    ("Church Slavic" . "cu")

    ("Chuvash" . "cv")

    ("Cornish" . "kw")

    ("Corsican" . "co")

    ("Croatian" . "hr")

    ("Czech" . "cs")

    ("Danish" . "da")

    ("Dutch" . "nl")

    ("Dzongkha" . "dz")

    ("English" . "en")

    ("Esperanto" . "eo")

    ("Estonian" . "et")

    ("Faroese" . "fo")

    ("Fijian" . "fj")

    ("Finnish" . "fi")

    ("French" . "fr")

    ("Frisian" . "fy")

    ("Galician" . "gl")

    ("Georgian" . "ka")

    ("German" . "de")

    ("Greek" . "el")

    ("Guarani" . "gn")

    ("Gujarati" . "gu")

    ("Hausa" . "ha")

    ("Hebrew" . "he")

    ("Herero" . "hz")

    ("Hindi" . "hi")

    ("Hiri Motu" . "ho")

    ("Hungarian" . "hu")

    ("Icelandic" . "is")

    ("Ido" . "io")

    ("Indonesian" . "id")

    ("Interlingua" . "ia")

    ("Interlingue" . "ie")

    ("Inuktitut" . "iu")

    ("Inupiak" . "ik")

    ("Irish" . "ga")

    ("Italian" . "it")

    ("Japanese" . "ja")

    ("Javanese" . "jv")

    ("Kalaallisut" . "kl")

    ("Kannada" . "kn")

    ("Kashmiri" . "ks")

    ("Kazakh" . "kk")

    ("Khmer" . "km")

    ("Kikuyu" . "ki")

    ("Kinyarwanda" . "rw")

    ("Kirghiz" . "ky")

    ("Kirundi" . "rn")

    ("Komi" . "kv")

    ("Konkani" . "kok")

    ("Korean" . "ko")

    ("Kuanyama" . "kj")

    ("Kurdish" . "ku")

    ("Laotian" . "lo")

    ("Latin" . "la")

    ("Latvian" . "lv")

    ("Letzeburgesch" . "lb")

    ("Lingala" . "ln")

    ("Lithuanian" . "lt")

    ("Macedonian" . "mk")

    ("Malagasy" . "mg")

    ("Malay" . "ms")

    ("Malayalam" . "ml")

    ("Maltese" . "mt")

    ("Manipuri" . "mni")

    ("Manx" . "gv")

    ("Maori" . "mi")

    ("Marathi" . "mr")

    ("Marshall" . "mh")

    ("Moldavian" . "mo")

    ("Mongolian" . "mn")

    ("Nauru" . "na")

    ("Navajo" . "nv")

    ("Ndonga" . "ng")

    ("Nepali" . "ne")

    ("North Ndebele" . "nd")

    ("Northern Sami" . "se")

    ("Norwegian Bokmal" . "nb")

    ("Norwegian Nynorsk" . "nn")

    ("Norwegian" . "no")

    ("Nyanja" . "ny")

    ("Occitan" . "oc")

    ("Oriya" . "or")

    ("Ossetian" . "os")

    ("Pali" . "pi")

    ("Pashto" . "ps")

    ("Persian" . "fa")

    ("Polish" . "pl")

    ("Portuguese" . "pt")

    ("Punjabi" . "pa")

    ("Quechua" . "qu")

    ("Rhaeto-Roman" . "rm")

    ("Romanian" . "ro")

    ("Russian" . "ru")

    ("Samoan" . "sm")

    ("Sango" . "sg")

    ("Sanskrit" . "sa")

    ("Sardinian" . "sc")

    ("Scots" . "gd")

    ("Serbian" . "sr")

    ("Sesotho" . "st")

    ("Setswana" . "tn")

    ("Shona" . "sn")

    ("Sindhi" . "sd")

    ("Sinhalese" . "si")

    ("Siswati" . "ss")

    ("Slovak" . "sk")

    ("Slovenian" . "sl")

    ("Somali" . "so")

    ("Sorbian" . "wen")

    ("South Ndebele" . "nr")

    ("Spanish" . "es")

    ("Sundanese" . "su")

    ("Swahili" . "sw")

    ("Swedish" . "sv")

    ("Tagalog" . "tl")

    ("Tahitian" . "ty")

    ("Tajik" . "tg")

    ("Tamil" . "ta")

    ("Tatar" . "tt")

    ("Telugu" . "te")

    ("Thai" . "th")

    ("Tibetan" . "bo")

    ("Tigrinya" . "ti")

    ("Tonga" . "to")

    ("Tsonga" . "ts")

    ("Turkish" . "tr")

    ("Turkmen" . "tk")

    ("Twi" . "tw")

    ("Uighur" . "ug")

    ("Ukrainian" . "uk")

    ("Urdu" . "ur")

    ("Uzbek" . "uz")

    ("Vietnamese" . "vi")

    ("Volapuk" . "vo")

    ("Walloon" . "wa")

    ("Welsh" . "cy")

    ("Wolof" . "wo")

    ("Xhosa" . "xh")

    ("Yiddish" . "yi")

    ("Yoruba" . "yo")

    ("Zhuang" . "za")

    ("Zulu" . "zu")

    )

  "*Association list giving team codes from team names.

This is used for generating a submission file name for the 'M' command.

If a string instead of an alist, it is a team code to use unconditionnally."

  :type 'sexp

  :group 'po)

(defcustom po-gzip-uuencode-command "gzip -9 | uuencode -m"

  "*The filter to use for preparing a mail invoice of the PO file.

Normally \"gzip -9 | uuencode -m\", remove the -9 for lesser compression,

or remove the -m if you are not using the GNU version of 'uuencode'."

  :type 'string

  :group 'po)

(defvar po-subedit-mode-syntax-table

  (copy-syntax-table text-mode-syntax-table)

  "Syntax table used while in PO mode.")

;;; Emacs portability matters - part II.

;;; Many portability matters are addressed in this page.  The few remaining

;;; cases, elsewhere, all involve  'eval-and-compile', 'boundp' or 'fboundp'.

;; Protect string comparisons from text properties if possible.

(eval-and-compile

  (fset 'po-buffer-substring

	(symbol-function (if (fboundp 'buffer-substring-no-properties)

			     'buffer-substring-no-properties

			   'buffer-substring)))

  (if (fboundp 'match-string-no-properties)

      (fset 'po-match-string (symbol-function 'match-string-no-properties))

    (defun po-match-string (number)

      "Return string of text matched by last search."

      (po-buffer-substring (match-beginning number) (match-end number)))))

;; Handle missing 'with-temp-buffer' function.

(eval-and-compile

  (if (fboundp 'with-temp-buffer)

      (fset 'po-with-temp-buffer (symbol-function 'with-temp-buffer))

    (defmacro po-with-temp-buffer (&rest forms)

      "Create a temporary buffer, and evaluate FORMS there like 'progn'."

      (let ((curr-buffer (make-symbol "curr-buffer"))

	    (temp-buffer (make-symbol "temp-buffer")))

	`(let ((,curr-buffer (current-buffer))

	       (,temp-buffer (get-buffer-create

			      (generate-new-buffer-name " *po-temp*"))))

	   (unwind-protect

	       (progn

		 (set-buffer ,temp-buffer)

		 ,@forms)

	     (set-buffer ,curr-buffer)

	     (and (buffer-name ,temp-buffer)

		  (kill-buffer ,temp-buffer))))))))

;; Handle missing 'kill-new' function.

(eval-and-compile

  (if (fboundp 'kill-new)

      (fset 'po-kill-new (symbol-function 'kill-new))

    (defun po-kill-new (string)

      "Push STRING onto the kill ring, for Emacs 18 where kill-new is missing."

      (po-with-temp-buffer

	(insert string)

	(kill-region (point-min) (point-max))))))

;; Handle missing 'read-event' function.

(eval-and-compile

  (fset 'po-read-event

	(cond ((fboundp 'read-event)

	       ;; GNU Emacs.

	       'read-event)

	      ((fboundp 'next-command-event)

	       ;; XEmacs.

	       'next-command-event)

	      (t

	       ;; Older Emacses.

	       'read-char))))

;; Handle missing 'force-mode-line-update' function.

(eval-and-compile

  (if (fboundp 'force-mode-line-update)

      (fset 'po-force-mode-line-update

	    (symbol-function 'force-mode-line-update))

    (defun po-force-mode-line-update ()

      "Force the mode-line of the current buffer to be redisplayed."

      (set-buffer-modified-p (buffer-modified-p)))))

;; Handle portable highlighting.  Code has been adapted (OK... stolen! :-)

;; from 'ispell.el'.

(eval-and-compile

  (cond

   (po-EMACS20

    (defun po-create-overlay ()

      "Create and return a deleted overlay structure.

The variable 'po-highlight-face' selects the face to use for highlighting."

      (let ((overlay (make-overlay (point) (point))))

	(overlay-put overlay 'face po-highlight-face)

	;; The fun thing is that a deleted overlay retains its face, and is

	;; movable.

	(delete-overlay overlay)

	overlay))

    (defun po-highlight (overlay start end &optional buffer)

      "Use OVERLAY to highlight the string from START to END.

If limits are not relative to the current buffer, use optional BUFFER."

      (move-overlay overlay start end (or buffer (current-buffer))))

    (defun po-rehighlight (overlay)

      "Ensure OVERLAY is highlighted."

      ;; There is nothing to do, as GNU Emacs allows multiple highlights.

      nil)

    (defun po-dehighlight (overlay)

      "Display normally the last string which OVERLAY highlighted.

The current buffer should be in PO mode, when this function is called."

      (delete-overlay overlay)))

   (po-XEMACS

    (defun po-create-overlay ()

      "Create and return a deleted overlay structure."

      ;; The same as for GNU Emacs above, except the created extent is

      ;; already detached, so there's no need to "delete" it

      ;; explicitly.

      (let ((extent (make-extent nil nil)))

	(set-extent-face extent po-highlight-face)

	extent))

    (defun po-highlight (extent start end &optional buffer)

      "Use EXTENT to highlight the string from START to END.

If limits are not relative to the current buffer, use optional BUFFER."

      (set-extent-endpoints extent start end (or buffer (current-buffer))))

    (defun po-rehighlight (extent)

      "Ensure EXTENT is highlighted."

      ;; Nothing to do here.

      nil)

    (defun po-dehighlight (extent)

      "Display normally the last string which EXTENT highlighted."

      (detach-extent extent)))

   (t

    (defun po-create-overlay ()

      "Create and return a deleted overlay structure."

      (cons (make-marker) (make-marker)))

    (defun po-highlight (overlay start end &optional buffer)

      "Use OVERLAY to highlight the string from START to END.

If limits are not relative to the current buffer, use optional BUFFER.

No doubt that highlighting, when Emacs does not allow it, is a kludge."

      (save-excursion

	(and buffer (set-buffer buffer))

	(let ((modified (buffer-modified-p))

	      (buffer-read-only nil)

	      (inhibit-quit t)

	      (buffer-undo-list t)

	      (text (buffer-substring start end)))

	  (goto-char start)

	  (delete-region start end)

	  (insert-char ?  (- end start))

	  (sit-for 0)

	  (setq inverse-video (not inverse-video))

	  (delete-region start end)

	  (insert text)

	  (sit-for 0)

	  (setq inverse-video (not inverse-video))

	  (set-buffer-modified-p modified)))

      (set-marker (car overlay) start (or buffer (current-buffer)))

      (set-marker (cdr overlay) end (or buffer (current-buffer))))

    (defun po-rehighlight (overlay)

      "Ensure OVERLAY is highlighted."

      (let ((buffer (marker-buffer (car overlay)))

	    (start (marker-position (car overlay)))

	    (end (marker-position (cdr overlay))))

	(and buffer

	     (buffer-name buffer)

	     (po-highlight overlay start end buffer))))

    (defun po-dehighlight (overlay)

      "Display normally the last string which OVERLAY highlighted."

      (let ((buffer (marker-buffer (car overlay)))

	    (start (marker-position (car overlay)))

	    (end (marker-position (cdr overlay))))

	(if buffer

	    (save-excursion

	      (set-buffer buffer)

	      (let ((modified (buffer-modified-p))

		    (buffer-read-only nil)

		    (inhibit-quit t)

		    (buffer-undo-list t))

		(let ((text (buffer-substring start end)))

		  (goto-char start)

		  (delete-region start end)

		  (insert-char ?  (- end start))

		  (sit-for 0)

		  (delete-region start end)

		  (insert text)

		  (sit-for 0)

		  (set-buffer-modified-p modified)))))

	(setcar overlay (make-marker))

	(setcdr overlay (make-marker))))

    )))

;;; Buffer local variables.

;; The following block of declarations has the main purpose of avoiding

;; byte compiler warnings.  It also introduces some documentation for

;; each of these variables, all meant to be local to PO mode buffers.

;; Flag telling that MODE-LINE-STRING should be displayed.  See 'Window'

;; page below.  Exceptionally, this variable is local to *all* buffers.

(defvar po-mode-flag)

;; PO buffers are kept read-only to prevent random modifications.  READ-ONLY

;; holds the value of the read-only flag before PO mode was entered.

(defvar po-read-only)

;; The current entry extends from START-OF-ENTRY to END-OF-ENTRY, it

;; includes preceding whitespace and excludes following whitespace.  The

;; start of keyword lines are START-OF-MSGID and START-OF-MSGSTR.

;; ENTRY-TYPE classifies the entry.

(defvar po-start-of-entry)

(defvar po-start-of-msgid)

(defvar po-start-of-msgstr)

(defvar po-end-of-entry)

(defvar po-entry-type)

;; A few counters are usefully shown in the Emacs mode line.

(defvar po-translated-counter)

(defvar po-fuzzy-counter)

(defvar po-untranslated-counter)

(defvar po-obsolete-counter)

(defvar po-mode-line-string)

;; PO mode keeps track of fields being edited, for one given field should

;; have one editing buffer at most, and for exiting a PO buffer properly

;; should offer to close all pending edits.  Variable EDITED-FIELDS holds an

;; an list of "slots" of the form: (ENTRY-MARKER EDIT-BUFFER OVERLAY-INFO).

;; To allow simultaneous edition of the comment and the msgstr of an entry,

;; ENTRY-MARKER points to the msgid line if a comment is being edited, or to

;; the msgstr line if the msgstr is being edited.  EDIT-BUFFER is the

;; temporary Emacs buffer used to edit the string.  OVERLAY-INFO, when not

;; nil, holds an overlay (or if overlays are not supported, a cons of two

;; markers) for this msgid string which became highlighted for the edit.

(defvar po-edited-fields)

;; We maintain a set of movable pointers for returning to entries.

(defvar po-marker-stack)

;; SEARCH path contains a list of directories where files may be found,

;; in a format suitable for read completion.  Each directory includes

;; its trailing slash.  PO mode starts with "./" and "../".

(defvar po-search-path)

;; The following variables are meaningful only when REFERENCE-CHECK

;; is identical to START-OF-ENTRY, else they should be recomputed.

;; REFERENCE-ALIST contains all known references for the current

;; entry, each list element is (PROMPT FILE LINE), where PROMPT may

;; be used for completing read, FILE is a string and LINE is a number.

;; REFERENCE-CURSOR is a cycling cursor into REFERENCE-ALIST.

(defvar po-reference-alist)

(defvar po-reference-cursor)

(defvar po-reference-check)

;; The following variables are for marking translatable strings in program

;; sources.  KEYWORDS is the list of keywords for marking translatable

;; strings, kept in a format suitable for reading with completion.

;; STRING-CONTENTS holds the value of the most recent string found in sources,

;; and when it is not nil, then STRING-BUFFER, STRING-START and STRING-END

;; describe where it is.  MARKING-OVERLAY, if not 'nil', holds the overlay

;; which highlight the last found string; for older Emacses, it holds the cons

;; of two markers around the highlighted region.

(defvar po-keywords)

(defvar po-string-contents)

(defvar po-string-buffer)

(defvar po-string-start)

(defvar po-string-end)

(defvar po-marking-overlay)

;;; PO mode variables and constants (usually not to customize).

;; The textdomain should really be "gettext", only trying it for now.

;; All this requires more thinking, we cannot just do this like that.

(set-translation-domain "po-mode")

(defun po-mode-version ()

  "Show Emacs PO mode version."

  (interactive)

  (message (_"Emacs PO mode, version %s") po-mode-version-string))

(defconst po-help-display-string

  (_"\

PO Mode Summary           Next Previous            Miscellaneous

*: Later, /: Docum        n    p    Any type       .     Redisplay

                          t    T    Translated     /v    Version info

Moving around             f    F    Fuzzy          ?, h  This help

<    First if any         o    O    Obsolete       =     Current index

>    Last if any          u    U    Untranslated   0     Other window

/SPC Auto select                                   V     Validate

                        Msgstr Comments            M     Mail officially

Modifying entries         RET  #    Call editor    _     Undo

TAB   Remove fuzzy mark   k    K    Kill to        E     Edit out full

DEL   Fuzzy or fade out   w    W    Copy to        Q     Forceful quit

LFD   Init with msgid     y    Y    Yank from      q     Confirm and quit

gettext Keyword Marking                            Position Stack

,    Find next string     Compendiums              m  Mark and push current

M-,  Mark translatable    *c    To compendium      r  Pop and return

M-.  Change mark, mark    *M-C  Select, save       x  Exchange current/top

Program Sources           Auxiliary Files          Lexicography

s    Cycle reference      a    Cycle file          *l    Lookup translation

M-s  Select reference     C-c C-a  Select file     *M-l  Add/edit translation

S    Consider path        A    Consider PO file    *L    Consider lexicon

M-S  Ignore path          M-A  Ignore PO file      *M-L  Ignore lexicon

")

  "Help page for PO mode.")

(defconst po-mode-menu-layout

  `("PO"

    ("Moving around"

     ["Auto select" po-auto-select-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next interesting entry"))]

     "---"

     "Forward"

     ["Any next" po-next-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next entry"))]

     ["Next translated" po-next-translated-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next translated entry"))]

     ["Next fuzzy" po-next-fuzzy-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next fuzzy entry"))]

     ["Next obsolete" po-next-obsolete-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next obsolete entry"))]

     ["Next untranslated" po-next-untranslated-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to next untranslated entry"))]

     ["Last file entry" po-last-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to last entry"))]

     "---"

     "Backward"

     ["Any previous" po-previous-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to previous entry"))]

     ["Previous translated" po-previous-translated-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to previous translated entry"))]

     ["Previous fuzzy" po-previous-fuzzy-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to previous fuzzy entry"))]

     ["Previous obsolete" po-previous-obsolete-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to previous obsolete entry"))]

     ["Previous untranslated" po-previous-untranslated-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to previous untranslated entry"))]

     ["First file entry" po-first-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to first entry"))]

     "---"

     "Position stack"

     ["Mark and push current" po-push-location

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Remember current location"))]

     ["Pop and return" po-pop-location

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to last remembered location and forget about it"))]

     ["Exchange current/top" po-exchange-location

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Jump to last remembered location and remember current location"))]

     "---"

     ["Redisplay" po-current-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Make current entry properly visible"))]

     ["Current index" po-statistics

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Statistical info on current translation file"))])

    ("Modifying entries"

     ["Undo" po-undo

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Revoke last changed entry"))]

     "---"

     "Msgstr"

     ["Edit msgstr" po-edit-msgstr

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Edit current translation"))]

     ["Ediff and merge msgstr" po-edit-msgstr-and-ediff

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Call `ediff' on current translation for merging"))]

     ["Cut msgstr" po-kill-msgstr

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Cut (kill) current translation"))]

     ["Copy msgstr" po-kill-ring-save-msgstr

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Copy current translation"))]

     ["Paste msgstr" po-yank-msgstr

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Paste (yank) text most recently cut/copied translation"))]

     "---"

     "Comments"

     ["Edit comment" po-edit-comment

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Edit current comment"))]

     ["Ediff and merge comment" po-edit-comment-and-ediff

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Call `ediff' on current comment for merging"))]

     ["Cut comment" po-kill-comment

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Cut (kill) current comment"))]

     ["Copy comment" po-kill-ring-save-comment

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Copy current translation"))]

     ["Paste comment" po-yank-comment

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Paste (yank) text most recently cut/copied"))]

     "---"

     ["Remove fuzzy mark" po-unfuzzy

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Remove \"#, fuzzy\""))]

     ["Fuzzy or fade out" po-fade-out-entry

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Set current entry fuzzy, or if already fuzzy delete it"))]

     ["Init with msgid" po-msgid-to-msgstr

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "\

Initialize or replace current translation with the original message"))])

    ("Other files"

     ["Other window" po-other-window

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Select other window; if necessay split current frame"))]

     "---"

     "Program sources"

     ["Cycle reference" po-cycle-source-reference t]

     ["Select reference" po-select-source-reference t]

     ["Consider path" po-consider-source-path t]

     ["Ignore path" po-ignore-source-path t]

     "---"

     "Compendiums"

     ["To compendium" po-save-entry nil]

     ["Select, save" po-select-and-save-entry nil]

     "---"

     "Auxiliary files"

     ["Cycle file" po-cycle-auxiliary t]

     ["Select file" po-select-auxiliary t]

     ["Consider file" po-consider-as-auxiliary t]

     ["Ignore file" po-ignore-as-auxiliary t]

     "---"

     "Lexicography"

     ["Lookup translation" po-lookup-lexicons nil]

     ["Add/edit translation" po-edit-lexicon-entry nil]

     ["Consider lexicon" po-consider-lexicon-file nil]

     ["Ignore lexicon" po-ignore-lexicon-file nil])

    "---"

    "Source marking"

    ["Find first string" (po-tags-search '(nil)) t]

    ["Prefer keyword" (po-select-mark-and-mark '(nil)) t]

    ["Find next string" po-tags-search t]

    ["Mark preferred" po-mark-translatable t]

    ["Mark with keyword" po-select-mark-and-mark t]

    "---"

    ["Version info" po-mode-version

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Display version number of PO mode"))]

    ["Help page" po-help

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Show the PO mode help screen"))]

    ["Validate" po-validate

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Check validity of current translation file using `msgfmt'"))]

    ["Mail officially" po-send-mail

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Send current translation file to the Translation Robot by mail"))]

    ["Edit out full" po-edit-out-full

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Leave PO mode to edit translation file using fundamental mode"))]

    "---"

    ["Forceful quit" po-quit

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Close (kill) current translation file without saving"))]

    ["Soft quit" po-confirm-and-quit

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Save current translation file, than close (kill) it"))])

  "Menu layout for PO mode.")

(defconst po-subedit-mode-menu-layout

  `("PO-Edit"

    ["Ediff and merge translation variants" po-subedit-ediff

      ,@(if (featurep 'xemacs) '(t)

	  '(:help "Call `ediff' for merging variants"))]

    ["Cycle through auxiliary files" po-subedit-cycle-auxiliary t]

    "---"

    ["Abort edit" po-subedit-abort

     ,@(if (featurep 'xemacs) '(t)

	  '(:help "Don't change the translation"))]

    ["Exit edit" po-subedit-exit

     ,@(if (featurep 'xemacs) '(t)

	 '(:help "Use this text as the translation and close current edit buffer"))])

  "Menu layout for PO subedit mode.")

(defconst po-subedit-message

  (_"Type 'C-c C-c' once done, or 'C-c C-k' to abort edit")

  "Message to post in the minibuffer when an edit buffer is displayed.")

(defvar po-auxiliary-list nil

  "List of auxiliary PO files, in completing read format.")

(defvar po-auxiliary-cursor nil

  "Cursor into the 'po-auxiliary-list'.")

(defvar po-compose-mail-function

  (let ((functions '(compose-mail-other-window

		     message-mail-other-window

		     compose-mail

		     message-mail))