xemacs-beta: src/doc.c comparison

comparison src/doc.c @ 444:576fb035e263 r21-2-37

Import from CVS: tag r21-2-37

author	cvs
date	Mon, 13 Aug 2007 11:36:19 +0200
parents	abe6d1db359e
children	1ccc32a20af4

comparison

equal deleted inserted replaced

-:a8296e22da4e
+:576fb035e263
 }
 	}
 }
 /* #### mrb: following STILL completely broken */
-return_me = make_ext_string ((Bufbyte *) buffer, to - buffer, Qbinary);
+return_me = make_ext_string (buffer, to - buffer, Qbinary);
 done:
 if (buffer != buf) /* We must have allocated buffer above */
 xfree (buffer);
 return return_me;
 return Fread (string);
 }
 DEFUN ("documentation", Fdocumentation, 1, 2, 0, /*
 Return the documentation string of FUNCTION.
-Unless a non-nil second argument is given, the
+Unless a non-nil second argument RAW is given, the
 string is passed through `substitute-command-keys'.
 */
 (function, raw))
 {
 /* This function can GC */
 This is like `get', but it can refer to strings stored in the
 `doc-directory/DOC' file; and if the value is a string, it is passed
 through `substitute-command-keys'.  A non-nil third argument avoids this
 translation.
 */
-(sym, prop, raw))
+(symbol, prop, raw))
 {
 /* This function can GC */
 REGISTER Lisp_Object doc = Qnil;
 #ifdef I18N3
 REGISTER Lisp_Object domain;
 #endif
 struct gcpro gcpro1;
 GCPRO1 (doc);
-doc = Fget (sym, prop, Qnil);
+doc = Fget (symbol, prop, Qnil);
 if (INTP (doc))
 doc = get_doc_string (XINT (doc) > 0 ? doc : make_int (- XINT (doc)));
 else if (CONSP (doc))
 doc = get_doc_string (doc);
 #ifdef I18N3
 if (!NILP (doc))
 {
-domain = Fget (sym, Qvariable_domain, Qnil);
+domain = Fget (symbol, Qvariable_domain, Qnil);
 if (NILP (domain))
 	doc = Fgettext (doc);
 else
 	doc = Fdgettext (domain, doc);
 }
 Substitute key descriptions for command names in STRING.
 Return a new string which is STRING with substrings of the form \\=\\[COMMAND]
 replaced by either:  a keystroke sequence that will invoke COMMAND,
 or "M-x COMMAND" if COMMAND is not on any keys.
 Substrings of the form \\=\\{MAPVAR} are replaced by summaries
-\(made by describe-bindings) of the value of MAPVAR, taken as a keymap.
+\(made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
 as the keymap for future \\=\\[COMMAND] substrings.
 \\=\\= quotes the following character and is discarded;
 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
 */
-(str))
+(string))
 {
 /* This function can GC */
 Bufbyte *buf;
 int changed = 0;
 REGISTER Bufbyte *strdata;
 REGISTER Bufbyte *bufp;
 Bytecount strlength;
 Bytecount idx;
 Bytecount bsize;
 Bufbyte *new;
-Lisp_Object tem;
+Lisp_Object tem = Qnil;
-Lisp_Object keymap;
+Lisp_Object keymap = Qnil;
+Lisp_Object name = Qnil;
 Bufbyte *start;
 Bytecount length;
-Lisp_Object name;
 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
-if (NILP (str))
+if (NILP (string))
 return Qnil;
-CHECK_STRING (str);
+CHECK_STRING (string);
-tem = Qnil;
+GCPRO4 (string, tem, keymap, name);
-keymap = Qnil;
-name = Qnil;
-GCPRO4 (str, tem, keymap, name);
 /* There is the possibility that the string is not destined for a
 translating stream, and it could be argued that we should do the
 same thing here as in Fformat(), but there are very few times
 when this will be the case and many calls to this function
 would have to have `gettext' calls added. (I18N3) */
-str = LISP_GETTEXT (str);
+string = LISP_GETTEXT (string);
 /* KEYMAP is either nil (which means search all the active keymaps)
 or a specified local map (which means search just that and the
 global map).  If non-nil, it might come from Voverriding_local_map,
-or from a \\<mapname> construct in STR itself..  */
+or from a \\<mapname> construct in STRING itself..  */
 #if 0 /* FSFmacs */
 /* This is really weird and garbagey.  If keymap is nil and there's
 an overriding-local-map, `where-is-internal' will correctly note
 this, so there's no reason to do it here.  Maybe FSFmacs
 `where-is-internal' is broken. */
 if (NILP (keymap))
 keymap = Voverriding_local_map;
 */
 #endif
-strlength = XSTRING_LENGTH (str);
+strlength = XSTRING_LENGTH (string);
 bsize = 1 + strlength;
 buf = (Bufbyte *) xmalloc (bsize);
 bufp = buf;
 /* Have to reset strdata every time GC might be called */
-strdata = XSTRING_DATA (str);
+strdata = XSTRING_DATA (string);
 for (idx = 0; idx < strlength; )
 {
 Bufbyte *strp = strdata + idx;
 if (strp[0] != '\\')
 	    tem = Fintern (make_string (start, length), Qnil);
 	    tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, Qnil);
 #if 0 /* FSFmacs */
-	  /* Disregard menu bar bindings; it is positively annoying to
+	    /* Disregard menu bar bindings; it is positively annoying to
-	     mention them when there's no menu bar, and it isn't terribly
+	       mention them when there's no menu bar, and it isn't terribly
-	     useful even when there is a menu bar.  */
+	       useful even when there is a menu bar.  */
-	  if (!NILP (tem))
+	    if (!NILP (tem))
-	    {
+	      {
-	      firstkey = Faref (tem, Qzero);
+		firstkey = Faref (tem, Qzero);
-	      if (EQ (firstkey, Qmenu_bar))
+		if (EQ (firstkey, Qmenu_bar))
-		tem = Qnil;
+		  tem = Qnil;
-	    }
+	      }
 #endif
 	    if (NILP (tem))	/* but not on any keys */
 	      {
 		new = (Bufbyte *) xrealloc (buf, bsize += 4);
 	      }
 	  }
 	case '{':
 	case '<':
 	  {
-	    /* #### jump to label `subst_string|subst' crosses
+	    Lisp_Object buffer = Fget_buffer_create (QSsubstitute);
-initialization of `buffer|_buf' */
+	    struct buffer *buf_ = XBUFFER (buffer);
-	    Lisp_Object buffer;
-	    struct buffer *buf_;
-	    buffer = Fget_buffer_create (QSsubstitute);
-	    buf_ = XBUFFER (buffer);
 	    Fbuffer_disable_undo (buffer);
 	    Ferase_buffer (buffer);
 	    /* \{foo} is replaced with a summary of keymap (symbol-value foo).
 		  tem = get_keymap (tem, 0, 1);
 	      }
 	    if (NILP (tem))
 	      {
-		char boof[255], *b = boof;
+		buffer_insert_c_string (buf_, "(uses keymap \"");
-		*b++ = '\n';
+		buffer_insert_lisp_string (buf_, Fsymbol_name (name));
-		/* #### This sprintf() is potentially dangerous!  */
+		buffer_insert_c_string (buf_, "\", which is not currently defined) ");
-		sprintf (b, GETTEXT (
-		"Uses keymap \"%s\", which is not currently defined."),
-			 (char *) XSTRING_DATA (Fsymbol_name (name)));
-		b += strlen (b);
-		*b++ = '\n';
-		*b++ = 0;
-		buffer_insert_c_string (buf_, boof);
 		if (start[-1] == '<') keymap = Qnil;
 	      }
 	    else if (start[-1] == '<')
 	      keymap = tem;
 	      describe_map_tree (tem, 1, Qnil, Qnil, 0, buffer);
 	    tem = make_string_from_buffer (buf_, BUF_BEG (buf_),
 					   BUF_Z (buf_) - BUF_BEG (buf_));
 	    Ferase_buffer (buffer);
-	    goto subst_string;
-	  subst_string:
-	    start = XSTRING_DATA (tem);
-	    length = XSTRING_LENGTH (tem);
-	  subst:
-	    bsize += length;
-	    new = (Bufbyte *) xrealloc (buf, bsize);
-	    bufp += new - buf;
-	    buf = new;
-	    memcpy (bufp, start, length);
-	    bufp += length;
-	    /* Reset STRDATA in case gc relocated it.  */
-	    strdata = XSTRING_DATA (str);
-	    break;
 	  }
+	  goto subst_string;
+	subst_string:
+	  start = XSTRING_DATA (tem);
+	  length = XSTRING_LENGTH (tem);
+	subst:
+	  bsize += length;
+	  new = (Bufbyte *) xrealloc (buf, bsize);
+	  bufp += new - buf;
+	  buf = new;
+	  memcpy (bufp, start, length);
+	  bufp += length;
+	  /* Reset STRDATA in case gc relocated it.  */
+	  strdata = XSTRING_DATA (string);
+	  break;
 	}
 }
 if (changed)			/* don't bother if nothing substituted */
 tem = make_string (buf, bufp - buf);
 else
-tem = str;
+tem = string;
 xfree (buf);
 UNGCPRO;
 return tem;
 }

Mercurial > hg > xemacs-beta

comparison src/doc.c @ 444:576fb035e263 r21-2-37