← Back to branch summary

~ubuntu-branches/ubuntu/maverick/texinfo/maverick

« back to all changes in this revision

Viewing changes to info/doc.h

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Preining
  • Date: 2005-10-28 15:10:30 UTC
  • mto: (2.1.1 dapper) (3.1.4 hardy)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20051028151030-9nsf2s2k2z3fktjt
Tags: upstream-4.8
Import upstream version 4.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
info/doc.h
1
1
/* doc.h -- Structures associating function pointers with documentation.
2
 
   $Id: doc.h,v 1.5 2001/11/16 23:16:40 karl Exp $
 
2
   $Id: doc.h,v 1.3 2004/04/11 17:56:45 karl Exp $
3
3
 
4
 
   Copyright (C) 1993, 2001 Free Software Foundation, Inc.
 
4
   Copyright (C) 1993, 2001, 2004 Free Software Foundation, Inc.
5
5
 
6
6
   This program is free software; you can redistribute it and/or modify
7
7
   it under the terms of the GNU General Public License as published by
66
66
 
67
67
extern FUNCTION_DOC function_doc_array[];
68
68
 
69
 
extern char *function_documentation ();
70
 
extern char *key_documentation ();
71
 
extern char *pretty_keyname ();
72
 
extern char *pretty_keyseq ();
73
 
extern char *where_is ();
74
 
extern char *replace_in_documentation ();
75
 
extern void info_document_key ();
76
 
extern void dump_map_to_message_buffer ();
77
 
 
78
69
/* Under the old key-binding system, an info command is specified by
79
70
   the pointer to its function.  Under the new INFOKEY binding system, 
80
71
   it is specified by a pointer to the command's FUNCTION_DOC structure,
82
73
   easily divined using the InfoFunction() extractor.  */
83
74
#if defined(INFOKEY)
84
75
typedef FUNCTION_DOC InfoCommand;
85
 
#define InfoFunction(ic) ((ic) ? (ic)->func : NULL)
 
76
/* The cast to VFunction * prevents pgcc from complaining about
 
77
   dereferencing a void *.  */
 
78
#define InfoFunction(ic) ((ic) ? (ic)->func : (VFunction *) NULL)
86
79
#define InfoCmd(fn) (&function_doc_array[A_##fn])
87
80
#define DocInfoCmd(fd) ((fd) && (fd)->func ? (fd) : NULL)
88
81
#else /* !INFOKEY */
92
85
#define DocInfoCmd(fd) ((fd)->func)
93
86
#endif /* !INFOKEY */
94
87
 
 
88
#include "infomap.h" /* for Keymap.  */
 
89
 
95
90
#if defined (NAMED_FUNCTIONS)
96
 
extern char *function_name ();
97
 
extern InfoCommand *named_function ();
 
91
extern char *function_name (InfoCommand *cmd);
 
92
extern InfoCommand *named_function (char *name);
98
93
#endif /* NAMED_FUNCTIONS */
 
94
 
 
95
extern char *function_documentation (InfoCommand *cmd);
 
96
extern char *key_documentation (char key, Keymap map);
 
97
extern char *pretty_keyname (unsigned char key);
 
98
extern char *pretty_keyseq (char *keyseq);
 
99
extern char *where_is (Keymap map, InfoCommand *cmd);
 
100
extern char *replace_in_documentation (char *string, int help_is_only_window_p);
 
101
extern void dump_map_to_message_buffer (char *prefix, Keymap map);
 
102
 
99
103
#endif /* !DOC_H */