From 7121df96f2a8ad129de7ec105cd16dc314eee7bc Mon Sep 17 00:00:00 2001 From: Tim Landscheidt Date: Thu, 8 Jul 2010 00:41:25 +0000 Subject: Fix typos. * lisp/emms-i18n.el: Fix typos. --- lisp/emms-i18n.el | 150 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 83 insertions(+), 67 deletions(-) (limited to 'lisp') diff --git a/lisp/emms-i18n.el b/lisp/emms-i18n.el index 3d8d40e..748f4aa 100644 --- a/lisp/emms-i18n.el +++ b/lisp/emms-i18n.el @@ -1,42 +1,46 @@ -;;; emms-i18n.el --- Function for handling coding system +;;; emms-i18n.el --- functions for handling coding systems ;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc. -;; + ;; Author: Ye Wenbin ;; This file is part of EMMS. -;; This program 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 3, or (at your option) -;; any later version. -;; -;; This program 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. -;; +;; This program 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 3, or (at +;; your option) any later version. + +;; This program 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 this program; if not, write to the Free Software ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. ;;; Commentary: -;; When read from process, first check the CAR part of -;; `emms-i18n-default-coding-system', if non-nil, use this for decode, and -;; nerver detect coding system, if nil, first call -;; `emms-i18n-coding-dectect-functions' to get coding system, if success, -;; decode the result, otherwise, use `emms-i18n-detect-coding-function', -;; the emacs detect coding function, if the coding detected is not in -;; `emms-i18n-nerver-used-coding-system', decode it, otherwise use +;; When reading from process, first check the car part of +;; `emms-i18n-default-coding-system'; if non-nil, use this for +;; decoding, and never detect coding system; if nil, first call +;; `emms-i18n-coding-detect-functions' to get coding system, if +;; success, decode the result, otherwise, use +;; `emms-i18n-detect-coding-function', the Emacs detect coding +;; function, if the coding detected is not in +;; `emms-i18n-never-used-coding-system', decode it, otherwise use ;; locale-coding-system. -;; -;; When write send data to process, first check the CDR part of -;; `emms-i18n-default-coding-system', if non-nil, use this to encode data, -;; otherwise do nothing, that means use `default-process-coding-system' or -;; `process-coding-system-alist' to encode data. -;; Put this file into your load-path and the following into your ~/.emacs: +;; When writing/sending data to process, first check the cdr part of +;; `emms-i18n-default-coding-system', if non-nil, use this to encode +;; data, otherwise do nothing, that means use +;; `default-process-coding-system' or `process-coding-system-alist' to +;; encode data. + +;; Put this file into your load-path and the following into your +;; ~/.emacs: + ;; (require 'emms-i18n) ;;; Code: @@ -45,27 +49,36 @@ (eval-when-compile (require 'cl)) -;; TODO: Change these to use defcustom - -(defvar emms-i18n-nerver-used-coding-system +;; TODO: Use defcustom. +(defvar emms-i18n-never-used-coding-system '(raw-text undecided) - "If the `emms-i18n-coding-dectect-functions' return coding system in -this list, use `emms-i18n-default-coding-system' instead.") - -(defvar emms-i18n-coding-system-for-read 'utf-8 - "If coding detect failed, use this for decode.") - -(defvar emms-i18n-default-coding-system '(no-conversion . no-conversion) - "If non-nil, used for decode and encode.") - -(defvar emms-i18n-coding-dectect-functions nil - "A list of function to call to detect codings.") - -(defvar emms-i18n-detect-max-size 10000 - "Max bytes to detect coding system. Nil mean scan whole buffer.") + "If the `emms-i18n-coding-detect-functions' return a coding +system in this list, use `emms-i18n-default-coding-system' +instead.") + +;; TODO: Use defcustom. +(defvar emms-i18n-coding-system-for-read + 'utf-8 + "If coding detect fails, use this for decoding.") + +;; TODO: Use defcustom. +(defvar emms-i18n-default-coding-system + '(no-conversion . no-conversion) + "If non-nil, use this for decoding and encoding.") + +;; TODO: Use defcustom. +(defvar emms-i18n-coding-detect-functions + nil + "A list of functions to call to detect codings.") + +;; TODO: Use defcustom. +(defvar emms-i18n-detect-max-size + 10000 + "Maximum amount of bytes to detect the coding system. nil +means to scan the whole buffer.") (defun emms-i18n-iconv (from to str) - "Convert STR from FROM coding to TO coding." + "Convert string STR from FROM coding to TO coding." (if (and from to) (decode-coding-string (encode-coding-string str to) @@ -80,12 +93,14 @@ this list, use `emms-i18n-default-coding-system' instead.") (decode-coding-region (point-min) (point-max) from)))) (defun emms-i18n-iconv-buffer (from to &optional buf) + "Convert buffer BUF from FROM coding to TO coding. BUF +defaults to the current buffer." (save-excursion (and buf (set-buffer buf)) (emms-i18n-iconv-region (point-min) (point-max) from to))) (defun emms-i18n-set-default-coding-system (read-coding write-coding) - "Set `emms-i18n-default-coding-system'" + "Set `emms-i18n-default-coding-system'." (interactive "zSet coding system for read: \nzSet coding system for write: ") (setq emms-i18n-default-coding-system (cons @@ -93,27 +108,27 @@ this list, use `emms-i18n-default-coding-system' instead.") (and (coding-system-p write-coding) write-coding))) (message (concat (if (car emms-i18n-default-coding-system) - (format "The coding system for read is %S." (car emms-i18n-default-coding-system)) - "Good, you want detect coding system by me!") - (format " The coding system for write is %S." + (format "The coding system for reading is %S." (car emms-i18n-default-coding-system)) + "Good, you want me to detect the coding system!") + (format " The coding system for writing is %S." (or (cdr emms-i18n-default-coding-system) (cdr default-process-coding-system)))))) (defun emms-i18n-call-process-simple (&rest args) - "This function run program and return the program result. -If the CAR part of `emms-i18n-default-coding-system' is non-nil, -the program result will be decode use the CAR part of -emms-i18n-default-coding-system. Otherwise, use -`emms-i18n-coding-dectect-functions' to detect the coding system -of the result. If the emms-i18n-coding-dectect-functions failed, -use `emms-i18n-detect-coding-function' to detect coding -system. If all the coding system is nil or in + "Run a program and return the program result. +If the car part of `emms-i18n-default-coding-system' is non-nil, +the program result will be decoded using the car part of +`emms-i18n-default-coding-system'. Otherwise, use +`emms-i18n-coding-detect-functions' to detect the coding system +of the result. If the `emms-i18n-coding-detect-functions' +failed, use `emms-i18n-detect-coding-function' to detect coding +system. If all the coding systems are nil or in `emms-i18n-never-used-coding-system', decode the result using `emms-i18n-coding-system-for-read'. -ARGS are the same as in `call-process', except the BUFFER should -always have value t. Otherwise the coding detection will not -perform." +ARGS are the same as in `call-process', except BUFFER should +always have the value t. Otherwise the coding detection will not +be performed." (let ((default-process-coding-system (copy-tree default-process-coding-system)) (process-coding-system-alist nil) exit pos) (when (eq (nth 2 args) 't) @@ -127,12 +142,13 @@ perform." (decode-coding-region (point-min) (point-max) (emms-i18n-detect-buffer-coding-system)))) exit)) -;; Is this function useful? +;; TODO: Is this function useful? (defun emms-i18n-call-process (&rest args) - "Run the program like `call-process'. If -the cdr part `emms-i18n-default-coding-system' is non-nil, the string in -ARGS will be encode by the CDR part of `emms-i18n-default-coding-system', -otherwise, it is pass all parameter to `call-process'." + "Run the program like `call-process'. If the cdr part of +`emms-i18n-default-coding-system' is non-nil, the string in ARGS +will be encoded by the cdr part of +`emms-i18n-default-coding-system'; otherwise, all parameters are +simply passed to `call-process'." (with-temp-buffer (if (cdr emms-i18n-default-coding-system) (let ((default-process-coding-system emms-i18n-default-coding-system) @@ -148,18 +164,18 @@ otherwise, it is pass all parameter to `call-process'." (point)) t)) (defun emms-i18n-detect-buffer-coding-system (&optional buf) - "Before call this function, make sure the buffer is literal" + "Before calling this function, make sure the buffer is literal." (let ((size (- (point-max) (point-min))) - (func (append emms-i18n-coding-dectect-functions 'emms-i18n-detect-coding-function)) + (func (append emms-i18n-coding-detect-functions 'emms-i18n-detect-coding-function)) coding) (save-excursion (and buf (set-buffer buf)) (goto-char (point-min)) (when (> size 0) (setq coding (run-hook-with-args-until-success 'func size)) - (if (member (coding-system-base coding) emms-i18n-nerver-used-coding-system) + (if (member (coding-system-base coding) emms-i18n-never-used-coding-system) (setq coding (emms-i18n-detect-coding-function size)))) - (if (or (null coding) (member (coding-system-base coding) emms-i18n-nerver-used-coding-system)) + (if (or (null coding) (member (coding-system-base coding) emms-i18n-never-used-coding-system)) emms-i18n-coding-system-for-read coding)))) -- cgit v1.2.3