Mercurial > emacs
comparison man/ada-mode.texi @ 39367:88b1d99e92ad
Add an Index and index all commands. This is so C-h C-f works.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Thu, 20 Sep 2001 15:43:41 +0000 |
parents | ef5cc490984d |
children | 421e0a91a1d1 |
comparison
equal
deleted
inserted
replaced
39366:adb48d2fe809 | 39367:88b1d99e92ad |
---|---|
91 * Comment Handling:: Reformatting comments easily | 91 * Comment Handling:: Reformatting comments easily |
92 * Compiling Executing:: Working with your application within Emacs | 92 * Compiling Executing:: Working with your application within Emacs |
93 * Debugging:: Debugging your application | 93 * Debugging:: Debugging your application |
94 * Using non-standard file names:: Configuring Emacs for special file names | 94 * Using non-standard file names:: Configuring Emacs for special file names |
95 * Working Remotely:: Working on a different machine | 95 * Working Remotely:: Working on a different machine |
96 * Index:: | |
96 @end menu | 97 @end menu |
97 | 98 |
98 | 99 |
99 @c ----------------------------------------------------------------------- | 100 @c ----------------------------------------------------------------------- |
100 @node Overview, Installation, Top, Top | 101 @node Overview, Installation, Top, Top |
343 @end itemize | 344 @end itemize |
344 | 345 |
345 | 346 |
346 @table @kbd | 347 @table @kbd |
347 @item C-c u | 348 @item C-c u |
349 @findex ada-customize | |
348 Create or edit the project file for the current buffer (@code{ada-customize}). | 350 Create or edit the project file for the current buffer (@code{ada-customize}). |
349 @item C-c c | 351 @item C-c c |
352 @findex ada-change-prj | |
350 Change the project file associated with the current Ada buffer (@code{ada-change-prj}). | 353 Change the project file associated with the current Ada buffer (@code{ada-change-prj}). |
351 @item C-c d | 354 @item C-c d |
352 Change the default project file for the current directory. Every new | 355 @findex ada-change-default-project |
353 file opened from this directory will be associated with that file by | 356 Change the default project file for the current directory |
354 default. | 357 (@code{ada-change-default-project}). Every new file opened from this |
358 directory will be associated with that file by default. | |
355 @item ada-set-default-project-file | 359 @item ada-set-default-project-file |
360 @findex ada-set-default-project-file | |
356 Set the default project file to use for *any* Ada file opened anywhere | 361 Set the default project file to use for *any* Ada file opened anywhere |
357 on your system. This sets this file only for the current Emacs session. | 362 on your system. This sets this file only for the current Emacs session. |
358 @end table | 363 @end table |
359 | 364 |
360 @c --------------------------------------------------------------------- | 365 @c --------------------------------------------------------------------- |
540 these functions are available through the Ada menu, and you can also use | 545 these functions are available through the Ada menu, and you can also use |
541 the following key bindings or the command names: | 546 the following key bindings or the command names: |
542 | 547 |
543 @table @kbd | 548 @table @kbd |
544 @item M-C-e | 549 @item M-C-e |
550 @findex ada-next-procedure | |
545 Move to the next function/procedure/task, which ever comes next | 551 Move to the next function/procedure/task, which ever comes next |
546 (@code{ada-next-procedure}). | 552 (@code{ada-next-procedure}). |
547 @item M-C-a | 553 @item M-C-a |
554 @findex ada-previous-procedure | |
548 Move to previous function/procedure/task | 555 Move to previous function/procedure/task |
549 (@code{ada-previous-procedure}). | 556 (@code{ada-previous-procedure}). |
550 @item M-x ada-next-package | 557 @item M-x ada-next-package |
558 @findex ada-next-package | |
551 Move to next package. | 559 Move to next package. |
552 @item M-x ada-prev-package | 560 @item M-x ada-prev-package |
561 @findex ada-prev-package | |
553 Move to previous package. | 562 Move to previous package. |
554 @item C-c C-a | 563 @item C-c C-a |
564 @findex ada-move-to-start | |
555 Move to matching start of @code{end} (@code{ada-move-to-start}). If | 565 Move to matching start of @code{end} (@code{ada-move-to-start}). If |
556 point is at the end of a subprogram, this command jumps to the | 566 point is at the end of a subprogram, this command jumps to the |
557 corresponding @code{begin} if the user option | 567 corresponding @code{begin} if the user option |
558 @code{ada-move-to-declaration} is @code{nil} (default), it jumps to | 568 @code{ada-move-to-declaration} is @code{nil} (default), it jumps to |
559 the subprogram declaration otherwise. | 569 the subprogram declaration otherwise. |
560 @item C-c C-e | 570 @item C-c C-e |
571 @findex ada-move-to-end | |
561 Move point to end of current block (@code{ada-move-to-end}). | 572 Move point to end of current block (@code{ada-move-to-end}). |
562 @item C-c o | 573 @item C-c o |
563 Switch between corresponding spec and body file | 574 Switch between corresponding spec and body file |
564 (@code{ff-find-other-file}). If the cursor is on a subprogram, switch | 575 (@code{ff-find-other-file}). If the cursor is on a subprogram, switch |
565 between declaration and body. | 576 between declaration and body. |
566 @item C-c c-d | 577 @item C-c c-d |
578 @findex ada-goto-declaration | |
567 Move from any reference to its declaration and switch between | 579 Move from any reference to its declaration and switch between |
568 declaration and body (for procedures, tasks, private and incomplete | 580 declaration and body (for procedures, tasks, private and incomplete |
569 types). | 581 types). |
570 @item C-c C-r | 582 @item C-c C-r |
583 @findex ada-find-references | |
571 runs the @file{gnatfind} command to search for all references to the | 584 runs the @file{gnatfind} command to search for all references to the |
572 entity pointed by the cursor (@code{ada-find-references}). Use | 585 entity pointed by the cursor (@code{ada-find-references}). Use |
573 @kbd{C-x `} (@code{next-error}) to visit each reference (as for | 586 @kbd{C-x `} (@code{next-error}) to visit each reference (as for |
574 compilation errors). | 587 compilation errors). |
575 @end table | 588 @end table |
636 @section Summary of commands | 649 @section Summary of commands |
637 @c ----------------------------------------------------------------------- | 650 @c ----------------------------------------------------------------------- |
638 | 651 |
639 @table @kbd | 652 @table @kbd |
640 @item C-@key{TAB} | 653 @item C-@key{TAB} |
654 @findex ada-complete-identifier | |
641 Complete accurately current identifier using information in @samp{.ali} file | 655 Complete accurately current identifier using information in @samp{.ali} file |
642 (@code{ada-complete-identifier}). | 656 (@code{ada-complete-identifier}). |
643 @item M-/ | 657 @item M-/ |
644 Complete identifier using buffer information (not Ada-specific). | 658 Complete identifier using buffer information (not Ada-specific). |
645 @end table | 659 @end table |
797 separating argument names and argument types, plus align the | 811 separating argument names and argument types, plus align the |
798 @code{in}, @code{out} and @code{in out} keywords if required. | 812 @code{in}, @code{out} and @code{in out} keywords if required. |
799 | 813 |
800 @table @kbd | 814 @table @kbd |
801 @item C-c C-f | 815 @item C-c C-f |
816 @findex ada-format-paramlist | |
802 Format the parameter list (@code{ada-format-paramlist}). | 817 Format the parameter list (@code{ada-format-paramlist}). |
803 @end table | 818 @end table |
804 | 819 |
805 @c ----------------------------------------------------------------------- | 820 @c ----------------------------------------------------------------------- |
806 @node Automatic Casing, Statement Templates, Formatting Parameter Lists, Top | 821 @node Automatic Casing, Statement Templates, Formatting Parameter Lists, Top |
865 that every member of the team sets this variable to the same value, | 880 that every member of the team sets this variable to the same value, |
866 which should point to a system-wide file that each of them can | 881 which should point to a system-wide file that each of them can |
867 write. That way, you will ensure that the casing is consistent | 882 write. That way, you will ensure that the casing is consistent |
868 throughout your application(s). | 883 throughout your application(s). |
869 | 884 |
885 @findex ada-create-case-exception | |
870 There are two ways to add new items to this file: you can simply edit it | 886 There are two ways to add new items to this file: you can simply edit it |
871 as you would edit any text file, and add or suppress entries in this | 887 as you would edit any text file, and add or suppress entries in this |
872 file. Remember that you should put one entity per line. The other, | 888 file. Remember that you should put one entity per line. The other, |
873 easier way, is to position the cursor over the word you want to add, in | 889 easier way, is to position the cursor over the word you want to add, in |
874 an Ada buffer. This word should have the casing you want. Then simply | 890 an Ada buffer. This word should have the casing you want. Then simply |
875 select the menu @samp{Ada->Edit->Create Case Exception}, or the key | 891 select the menu @samp{Ada->Edit->Create Case Exception}, or the key |
876 @kbd{C-c C-y}. The word will automatically be added to the current list | 892 @kbd{C-c C-y} (@code{ada-create-case-exception}). The word will |
877 of exceptions and to the file. | 893 automatically be added to the current list of exceptions and to the file. |
878 | 894 |
879 It is sometimes useful to have multiple exception files around (for | 895 It is sometimes useful to have multiple exception files around (for |
880 instance, one could be the standard Ada acronyms, the second some | 896 instance, one could be the standard Ada acronyms, the second some |
881 company specific exceptions, and the last one some project specific | 897 company specific exceptions, and the last one some project specific |
882 exceptions). If you set up the variable @code{ada-case-exception-file} | 898 exceptions). If you set up the variable @code{ada-case-exception-file} |
890 | 906 |
891 Automatic casing can be performed on port or whole buffer using: | 907 Automatic casing can be performed on port or whole buffer using: |
892 | 908 |
893 @table @kbd | 909 @table @kbd |
894 @item C-c C-b | 910 @item C-c C-b |
895 Adjust case in the whole buffer. | 911 @findex ada-adjust-case-buffer |
912 Adjust case in the whole buffer (@code{ada-adjust-case-buffer}). | |
896 @item C-c C-y | 913 @item C-c C-y |
897 Create a new entry in the exception dictionary, with the word under | 914 Create a new entry in the exception dictionary, with the word under |
898 the cursor | 915 the cursor (@code{ada-create-case-exception}) |
899 @item C-c C-t | 916 @item C-c C-t |
917 @findex ada-case-read-exceptions | |
900 Rereads the exception dictionary from the file | 918 Rereads the exception dictionary from the file |
901 @code{ada-case-exception-file}. | 919 @code{ada-case-exception-file} (@code{ada-case-read-exceptions}). |
902 @end table | 920 @end table |
903 | 921 |
904 @c ----------------------------------------------------------------------- | 922 @c ----------------------------------------------------------------------- |
905 @node Statement Templates, Comment Handling, Automatic Casing, Top | 923 @node Statement Templates, Comment Handling, Automatic Casing, Top |
906 @chapter Statement Templates | 924 @chapter Statement Templates |
912 Templates exist for most Ada statements. They can be inserted in the | 930 Templates exist for most Ada statements. They can be inserted in the |
913 buffer using the following commands: | 931 buffer using the following commands: |
914 | 932 |
915 @table @kbd | 933 @table @kbd |
916 @item C-c t b | 934 @item C-c t b |
917 exception Block | 935 @findex ada-exception-block |
936 exception Block (@code{ada-exception-block}). | |
918 @item C-c t c | 937 @item C-c t c |
919 case. | 938 @findex ada-case |
939 case (@code{ada-case}). | |
920 @item C-c t d | 940 @item C-c t d |
921 declare Block. | 941 @findex ada-declare-block |
942 declare Block (@code{ada-declare-block}). | |
922 @item C-c t e | 943 @item C-c t e |
923 else. | 944 @findex ada-else |
945 else (@code{ada-else}). | |
924 @item C-c t f | 946 @item C-c t f |
925 for Loop. | 947 @findex ada-for-loop |
948 for Loop (@code{ada-for-loop}). | |
926 @item C-c t h | 949 @item C-c t h |
927 Header. | 950 @findex ada-header |
951 Header (@code{ada-header}). | |
928 @item C-c t i | 952 @item C-c t i |
929 if. | 953 @findex ada-if |
954 if (@code{ada-if}). | |
930 @item C-c t k | 955 @item C-c t k |
931 package Body. | 956 @findex ada-package-body |
957 package Body (@code{ada-package-body}). | |
932 @item C-c t l | 958 @item C-c t l |
933 loop. | 959 @findex ada-loop |
960 loop (@code{ada-loop}). | |
961 @item C-c p | |
962 @findex ada-subprogram-body | |
963 subprogram body (@code{ada-subprogram-body}). | |
934 @item C-c t t | 964 @item C-c t t |
935 task Body. | 965 @findex ada-task-body |
966 task Body (@code{ada-task-body}). | |
936 @item C-c t w | 967 @item C-c t w |
937 while Loop. | 968 @findex ada-while |
969 while Loop (@code{ada-while}). | |
938 @item C-c t u | 970 @item C-c t u |
939 use. | 971 @findex ada-use |
972 use (@code{ada-use}). | |
940 @item C-c t x | 973 @item C-c t x |
941 exit. | 974 @findex ada-exit |
975 exit (@code{ada-exit}). | |
942 @item C-c t C-a | 976 @item C-c t C-a |
943 array. | 977 @findex ada-array |
978 array (@code{ada-array}). | |
944 @item C-c t C-e | 979 @item C-c t C-e |
945 elsif. | 980 @findex ada-elsif |
981 elsif (@code{ada-elsif}). | |
946 @item C-c t C-f | 982 @item C-c t C-f |
947 function Spec. | 983 @findex ada-function-spec |
984 function Spec (@code{ada-function-spec}). | |
948 @item C-c t C-k | 985 @item C-c t C-k |
949 package Spec. | 986 @findex ada-package-spec |
987 package Spec (@code{ada-package-spec}). | |
950 @item C-c t C-p | 988 @item C-c t C-p |
951 procedure Spec. | 989 @findex ada-procedure-spec |
990 procedure Spec (@code{ada-package-spec}. | |
952 @item C-c t C-r | 991 @item C-c t C-r |
953 record. | 992 @findex ada-record |
993 record (@code{ada-record}). | |
954 @item C-c t C-s | 994 @item C-c t C-s |
955 subtype. | 995 @findex ada-subtype |
996 subtype (@code{ada-subtype}). | |
956 @item C-c t C-t | 997 @item C-c t C-t |
957 task Spec. | 998 @findex ada-task-spec |
999 task Spec (@code{ada-task-spec}). | |
958 @item C-c t C-u | 1000 @item C-c t C-u |
959 with. | 1001 @findex ada-with |
1002 with (@code{ada-with}). | |
960 @item C-c t C-v | 1003 @item C-c t C-v |
961 private. | 1004 @findex ada-private |
1005 private (@code{ada-private}). | |
962 @item C-c t C-w | 1006 @item C-c t C-w |
963 when. | 1007 @findex ada-when |
1008 when (@code{ada-when}). | |
964 @item C-c t C-x | 1009 @item C-c t C-x |
965 exception. | 1010 @findex ada-exception |
1011 exception (@code{ada-exception}). | |
966 @item C-c t C-y | 1012 @item C-c t C-y |
967 type. | 1013 @findex ada-type |
1014 type (@code{ada-type}). | |
968 @end table | 1015 @end table |
969 | 1016 |
970 @c ----------------------------------------------------------------------- | 1017 @c ----------------------------------------------------------------------- |
971 @node Comment Handling, Compiling Executing, Statement Templates, Top | 1018 @node Comment Handling, Compiling Executing, Statement Templates, Top |
972 @chapter Comment Handling | 1019 @chapter Comment Handling |
1152 complicated. You then need to rewrite the function | 1199 complicated. You then need to rewrite the function |
1153 @code{ada-make-filename-from-adaname} (see the file @file{ada-mode.el} | 1200 @code{ada-make-filename-from-adaname} (see the file @file{ada-mode.el} |
1154 for an example). | 1201 for an example). |
1155 | 1202 |
1156 @c --------------------------------------------------------------------- | 1203 @c --------------------------------------------------------------------- |
1157 @node Working Remotely, ,Using non-standard file names, Top | 1204 @node Working Remotely, Index, Using non-standard file names, Top |
1158 @chapter Working Remotely | 1205 @chapter Working Remotely |
1159 @c --------------------------------------------------------------------- | 1206 @c --------------------------------------------------------------------- |
1160 | 1207 |
1161 When you work on project that involve a lot of programmers, it is | 1208 When you work on project that involve a lot of programmers, it is |
1162 generally the case that you will edit the files on your own machine, but | 1209 generally the case that you will edit the files on your own machine, but |
1234 @code{rsh aleph.gnu.org $@{main@}}. | 1281 @code{rsh aleph.gnu.org $@{main@}}. |
1235 | 1282 |
1236 However, this would not work on vxworks, for instance, where | 1283 However, this would not work on vxworks, for instance, where |
1237 @command{rsh} is not supported. | 1284 @command{rsh} is not supported. |
1238 | 1285 |
1286 @node Index, , Working Remotely, Top | |
1287 @unnumbered Index | |
1288 | |
1289 @printindex fn | |
1290 | |
1239 @contents | 1291 @contents |
1240 @bye | 1292 @bye |