| blob | e6860fa0636e5a9f8b12da774043a9c0b6b03a2c |
1 ;;; ada-xref.el --- for lookup and completion in Ada mode
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 2001, 2002, 2003
4 ;; Free Software Foundation, Inc.
6 ;; Author: Markus Heritsch <Markus.Heritsch@studbox.uni-stuttgart.de>
7 ;; Rolf Ebert <ebert@inf.enst.fr>
8 ;; Emmanuel Briot <briot@gnat.com>
9 ;; Maintainer: Emmanuel Briot <briot@gnat.com>
10 ;; Ada Core Technologies's version: Revision: 1.181
11 ;; Keywords: languages ada xref
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
30 ;;; Commentary:
31 ;;; This Package provides a set of functions to use the output of the
32 ;;; cross reference capabilities of the GNAT Ada compiler
33 ;;; for lookup and completion in Ada mode.
34 ;;;
35 ;;; If a file *.`adp' exists in the ada-file directory, then it is
36 ;;; read for configuration informations. It is read only the first
37 ;;; time a cross-reference is asked for, and is not read later.
39 ;;; You need Emacs >= 20.2 to run this package
41 ;;; Code:
43 ;; ----- Requirements -----------------------------------------------------
50 ;; ------ Use variables
52 "*If nil, always display the cross-references in the same buffer.
53 Otherwise create either a new buffer or a new frame."
57 "*If non-nil, run gcc whenever the cross-references are not up-to-date.
58 If nil, the cross-reference mode will never run gcc."
62 "*If non-nil, always ask for user confirmation before compiling or running
63 the application."
67 "*Maximum number of characters for filenames created by gnatkr.
68 Set to 0, if you don't use crunched filenames. This should be a string."
72 "*Arguments to pass to gnatfind when the location of the runtime is searched.
73 Typical use is to pass --RTS=soft-floats on some systems that support it.
75 You can also add -I- if you do not want the current directory to be included.
76 Otherwise, going from specs to bodies and back will first look for files in the
77 current directory. This only has an impact if you are not using project files,
78 but only ADA_INCLUDE_PATH."
82 "Default compilation options."
86 "Default binder options."
90 "Default linker options."
94 "Default options for gnatmake."
98 "Default switches to use for gnatfind.
99 You should modify this variable, for instance to add -a, if you are working
100 in an environment where most ALI files are write-protected.
101 The command gnatfind is used every time you choose the menu
108 "*Default command to be used to compile a single file.
109 Emacs will add the filename at the end of this command. This is the same
110 syntax as in the project file."
114 "*Default name of the debugger. We recommend either `gdb',
115 `gdb --emacs_gdbtk' or `ddd --tty -fullname'."
121 "*Default command to be used to compile the application.
122 This is the same syntax as in the project file."
126 "*Name of the project file to use for every Ada file.
127 Emacs will not try to use the standard algorithm to find the project file if
128 this string is not empty."
132 "*List of the options to pass to gnatsub to generate the body of a package.
133 This has the same syntax as in the project file (with variable substitution)."
137 "*If nil, use default values when no project file was found.
138 Otherwise, ask the user for the name of the project file to use."
145 "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging.
149 "*If non-nil, use egrep to find the possible declarations for an entity.
150 This alternate method is used when the exact location was not found in the
151 information provided by GNAT. However, it might be expensive if you have a lot
152 of sources, since it will search in all the files in your project."
156 "Hook that is run when loading a project file.
157 Each function in this hook takes one argument FILENAME, that is the name of
158 the project file to load.
159 This hook should be used to support new formats for the project files.
161 If the function can load the file with the given filename, it should create a
162 buffer that contains a conversion of the file to the standard format of the
164 lines). It should return nil if it doesn't know how to convert that project
168 ;; ------- Nothing to be modified by the user below this
179 "Directories where the specs for the standard library is found.
183 "Directories where the ali for the standard library is found.
187 "List of positions selected by the cross-references functions.
192 "cd /d"
194 "Command to use to change to a specific directory. On windows systems
195 using cmdproxy.exe as the shell, we need to use /d or the drive is never
199 "Separator to use when sending multiple commands to `compile' or
200 `start-process'.
201 cmdproxy.exe doesn't recognize multiple-line commands, so we have to use
212 "Associative list of project files.
213 It has the following format:
214 \((project_name . value) (project_name . value) ...)
218 ;; ----- Identlist manipulation -------------------------------------------
219 ;; An identlist is a vector that is used internally to reference an identifier
220 ;; To facilitate its use, we provide the following macros
242 "Reads the ali file into a new buffer, and returns this buffer's name"
246 ;; -----------------------------------------------------------------------
253 "Initializes the variables for the runtime library location.
254 CROSS-PREFIX is the prefix to use for the gnatls command"
257 ada-xref-runtime-library-ali-path '())
261 ;; Catch any error in the following form (i.e gnatls was not found)
263 ;; Even if we get an error, delete the *gnatls* buffer
270 ;; Source path
284 ;; Object path
297 )
304 ))
308 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
309 The project file must have been loaded first.
310 As a special case, ${current} is replaced with the name of the currently
311 edited file, minus extension but with directory, and ${full_current} is
312 replaced by the name including the extension."
326 ;; Check if there is an environment variable with the same name
340 t t cmd-string)))))
341 ))
342 cmd-string)
345 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
348 plist)
353 ;; Try hard to find a default value for filename, so that the user
354 ;; can edit his project file even if the current buffer is not an
355 ;; Ada file or not even associated with a file
359 ada-prj-default-project-file)
363 "and no default project "
370 ada-case-exception-file
372 'comp_opt ada-prj-default-comp-opt
373 'bind_opt ada-prj-default-bind-opt
374 'link_opt ada-prj-default-link-opt
375 'gnatmake_opt ada-prj-default-gnatmake-opt
376 'gnatfind_opt ada-prj-gnatfind-switches
388 ada-prj-default-comp-cmd)
390 ada-check-switch))
392 ada-prj-default-make-cmd)
402 )
406 "Extract the value of FIELD from the current project file.
407 The project file must have been loaded first.
408 A default value is returned if the file was not found.
410 Note that for src_dir and obj_dir, you should rather use
411 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field' which will in
412 addition return the default paths."
415 file value)
417 ;; Get the project file (either the current one, or a default one)
421 ;; If the file was not found, use the default values
423 ;; Get the value from the file
426 ;; Create a default nil file that contains the default values
431 )
433 ;; Substitute the ${...} constructs in all the strings, including
434 ;; inside lists
439 nil)
443 value)
444 )
445 ))
449 "Return the full value for src_dir, including the default directories.
450 All the directories are returned as absolute directories."
454 ;; Add ${build_dir} in front of the path
458 build-dir)
460 ;; Add the standard runtime at the end
461 ada-xref-runtime-library-specs-path)))
464 "Return the full value for obj_dir, including the default directories.
465 All the directories are returned as absolute directories."
469 ;; Add ${build_dir} in front of the path
473 build-dir)
475 ;; Add the standard runtime at the end
476 ada-xref-runtime-library-ali-path)))
479 "Update the menu Ada->Project, with the list of available project files."
482 ;; Create the standard items
489 ;; Add the new items
494 "Change the active project file."
503 'menu-item
505 ada-project-file-extension)
509 command
511 :toggle
514 ))))))))
516 ;; Parses all the known project files, and insert at least the default
517 ;; one (in case ada-xref-project-files is nil)
523 submenu)))
524 ))
527 ;;-------------------------------------------------------------
528 ;;-- Searching a file anywhere on the source path.
529 ;;--
530 ;;-- The following functions provide support for finding a file anywhere
531 ;;-- on the source path, without providing an explicit directory.
532 ;;-- They also provide file name completion in the minibuffer.
533 ;;--
534 ;;-- Public subprograms: ada-find-file
535 ;;--
536 ;;-------------------------------------------------------------
539 "Completion function when reading a file from the minibuffer.
540 Completion is attempted in all the directories in the source path, as
541 defined in the project file."
552 list)
556 predicate)))))
558 ;;;###autoload
560 "Open a file anywhere in the source path.
561 Completion is available."
570 ;; ----- Utilities -------------------------------------------------
573 "If no project file is currently active, load a default one."
580 "Push (FILENAME, POSITION) on the position ring for cross-references."
586 "Go to the previous cross-reference we were on."
595 "Converts from NAME to a name that can be used by the compilation commands.
596 This is overriden on VMS to convert from VMS filenames to Unix filenames."
597 name)
600 "Set the file whose name is NAME as the default project file.
601 If KEEP-EXISTING is true and a project file has already been loaded, nothing
602 is done. This is meant to be used from ada-mode-hook, for instance to force
603 a project file unless the user has already loaded one."
612 ;; ------ Handling the project file -----------------------------
615 "Find the prj file associated with FILE (or the current buffer if nil).
616 If NO-USER-QUESTION is non-nil, use a default file if not project file was
617 found, and do not ask the user.
618 If the buffer is not an Ada buffer, associate it with the default project
619 file. If none is set, return nil."
623 ;; Use the active project file if there is one.
624 ;; This is also valid if we don't currently have an Ada buffer, or if
625 ;; the current buffer is not a real file (for instance an emerge buffer)
635 ;; other cases: use a more complex algorithm
640 ada-project-file-extension))
643 ;; on Emacs 20.2, directory-files does not work if
644 ;; parse-sexp-lookup-properties is set
647 dir t
654 ;; Else if there is a project file with the same name as the Ada
655 ;; file, but not the same extension.
659 ;; Else if only one project file was found in the current directory
663 ;; Else if there are multiple files, ask the user
674 counter
689 ;; Else if no project file was found in the directory, ask a name
690 ;; to the user, using as a default value the last one entered by
691 ;; the user
697 nil ada-last-prj-file))
700 )))
703 ))
707 "Reads and parses the PRJ-FILE file if it was found.
708 The current buffer should be the ada-file buffer."
711 run_cmd debug_pre_cmd debug_post_cmd
715 ;; Set the project file as the active one.
718 ;; Initialize the project with the default values
721 ;; Do not use find-file below, since we don't want to show this
722 ;; buffer. If the file is open through speedbar, we can't use
723 ;; find-file anyway, since the speedbar frame is special and does not
724 ;; allow the selection of a file in it.
737 ;; Now overrides these values with the project file
789 ;; Kill the project buffer
792 )
794 ;; Else the file wasn't readable (probably the default project).
795 ;; We initialize it with the current environment variables.
796 ;; We need to add the startup directory in front so that
797 ;; files locally redefined are properly found. We cannot
798 ;; add ".", which varies too much depending on what the
799 ;; current buffer is.
812 )
815 ;; Delete the default project file from the list, if it is there.
816 ;; Note that in that case, this default project is the only one in
817 ;; the list
821 ;; Memorize the newly read project file
826 ;; Sets up the compilation-search-path so that Emacs is able to
827 ;; go to the source of the errors in a compilation buffer
830 ;; Set the casing exceptions file list
836 ;; Add the directories to the search path for ff-find-other-file
837 ;; Do not add the '/' or '\' at the end
840 ada-search-directories))
843 )
845 ;; No prj file ? => Setup default values
846 ;; Note that nil means that all compilation modes will first look in the
847 ;; current directory, and only then in the current file's directory. This
848 ;; current file is assumed at this point to be in the common source
849 ;; directory.
851 ))
855 "Find all references to the entity under POS.
856 Calls gnatfind to find the references.
857 if ARG is t, the contents of the old *gnatfind* buffer is preserved.
858 if LOCAL-ONLY is t, only the declarations in the current file are returned."
869 ;; if the file is more recent than the executable
874 nil nil local-only arg)
879 )
882 "Find all references to the entity under POS.
883 Calls gnatfind to find the references.
884 if ARG is t, the contents of the old *gnatfind* buffer is preserved."
891 "Search for references to any entity whose name is ENTITY.
892 ENTITY was first found the location given by FILE, LINE and COLUMN.
893 If LOCAL-ONLY is t, then only the references in file will be listed, which
894 is much faster.
895 If APPEND is t, then the output of the command will be append to the existing
896 buffer *gnatfind* if it exists."
900 ;; Prepare the gnatfind command. Note that we must protect the quotes
901 ;; around operators, so that they are correctly handled and can be
902 ;; processed (gnatfind \"+\":...).
908 entity))
911 quote-entity
916 ))
917 old-contents)
919 ;; If a project file is defined, use it
934 ;; Hide the "Compilation" menu
944 )
945 )
949 ;; ----- Identifier Completion --------------------------------------------
951 "Tries to complete the identifier around POS.
952 The feature is only available if the files where compiled not using the -gnatx
953 option."
957 ;; Initialize function-local variables and jump to the .ali buffer
958 ;; Note that for regexp search is case insensitive too
967 ;; Open the .ali file
971 ;; build an alist of possible completions
977 ;; kills .ali buffer
980 ;; deletes the incomplete identifier in the buffer
984 ;; inserts the completed symbol
986 ))
988 ;; ----- Cross-referencing ----------------------------------------
991 "Jump to the declaration of the entity below the cursor."
997 "Jump to the body of the entity under the cursor."
1003 "Display the body of the entity around POS.
1004 If the entity doesn't have a body, display its declaration.
1005 As a side effect, the buffer for the declaration is also open."
1009 ;; Temporarily force the display in the same buffer, since we
1010 ;; already changed previously
1015 "Display the declaration of the identifier around POS.
1016 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1017 non-nil.
1018 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1024 ;; First try the standard algorithm by looking into the .ali file, but if
1025 ;; that file was too old or even did not exist, try to look in the whole
1026 ;; object path for a possible location.
1033 ;; If the ALI file was up-to-date, then we probably have a predefined
1034 ;; entity, whose references are not given by GNAT
1039 ;; Else, look in every ALI file, except if the user doesn't want that
1043 )))))))
1046 "Display the declaration of the identifier around POS.
1047 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1052 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1055 command
1057 remote-shell-program
1058 machine
1059 command))))
1062 "Returns the list of absolute directories found in dir-list.
1063 If a directory is a relative directory, the value of ROOT-DIR is added in
1064 front."
1068 "Return the new value for process-environment.
1069 It modifies the source path and object path with the values found in the
1070 project file."
1082 path-separator)
1083 include)
1088 path-separator)
1089 objects)
1090 process-environment))))
1093 "Compiles the application, using the command found in the project file.
1094 If ARG is not nil, ask for user confirmation."
1103 ;; If no project file was found, ask the user
1107 ;; Make a single command from the list of commands, including the
1108 ;; commands to run it on a remote machine.
1114 ;; Insert newlines so as to separate the name of the commands to run
1115 ;; and the output of the commands. this doesn't work with cmdproxy.exe,
1116 ;; which gets confused by newline characters.
1123 "Recompile the current file.
1124 If ARG is not nil, ask for user confirmation of the command.
1125 PRJ-FIELD is the name of the field to use in the project file to get the
1126 command, and should be either comp_cmd (default) or check_cmd."
1139 ;; Make a single command from the list of commands, including the
1140 ;; commands to run it on a remote machine.
1143 ;; If no project file was found, ask the user
1147 ;; Insert newlines so as to separate the name of the commands to run
1148 ;; and the output of the commands. this doesn't work with cmdproxy.exe,
1149 ;; which gets confused by newline characters.
1156 "Recompile the current file.
1157 If ARG is not nil, ask for user confirmation of the command."
1162 "Run the application.
1163 if ARG is not-nil, asks for user confirmation."
1173 ;; Guess the command if it wasn't specified
1177 ;; Modify the command to run remotely
1179 ada-command-separator)))
1181 ;; Ask for the arguments to the command if required
1184 command)))
1186 ;; Run the command
1195 ;; Set these two variables to their default values, since otherwise
1196 ;; the output buffer is scrolled so that only the last output line
1197 ;; is visible at the top of the buffer.
1200 )
1203 ;; change to buffer *run* for interactive programs
1206 ))
1209 "Start the debugger on the application.
1210 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1211 project file.
1212 If ARG is non-nil, ask the user to confirm the command."
1215 cmd pre-cmd post-cmd)
1223 ;; If the command was not given in the project file, start a bare gdb
1226 " "
1230 ;; For gvd, add an extra switch so that the Emacs window is completly
1231 ;; swallowed inside the Gvd one
1234 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1235 ;; We make sure that gvd swallows the new frame, not the one the
1236 ;; user has been using until now
1237 ;; The frame is made invisible initially, so that GtkPlug gets a
1238 ;; chance to fully manage it. Then it works fine with Enlightenment
1239 ;; as well
1242 cmd " --editor-window="
1246 ;; Add a -fullname switch
1247 ;; Use the remote machine
1250 ;; Ask for confirmation if required
1255 comint-exec
1256 in-post-mode
1257 gud-gdb-massage-args)
1259 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1271 ;; Temporarily replaces the definition of `comint-exec' so that we
1272 ;; can execute commands before running gdb.
1282 command " "
1284 ))
1286 ;; Tight integration should force the tty mode
1288 ada-tight-gvd-integration
1297 ;; Restore the standard fset command (or for instance C-U M-x shell
1298 ;; wouldn't work anymore
1302 ;; Send post-commands to the debugger
1305 ;; Move to the end of the debugger buffer, so that it is automatically
1306 ;; scrolled from then on.
1309 ;; Display both the source window and the debugger window (the former
1310 ;; above the latter). No need to show the debugger window unless it
1311 ;; is going to have some relevant information.
1316 )))
1320 "Forces Emacs to read either FILENAME or the project file associated
1321 with the current buffer.
1322 Otherwise, this file is only read once, and never read again.
1323 Since the information in the project file is shared between all buffers, this
1324 automatically modifies the setup for all the Ada buffer that use this file."
1330 ;; Reread the location of the standard runtime library
1333 )
1335 ;; ------ Private routines
1338 "Update the cross-references for FILE.
1339 This in fact recompiles FILE to create ALI-FILE-NAME.
1340 This function returns the name of the file that was recompiled to generate
1341 the cross-reference information. Note that the ali file can then be deduced by
1342 replacing the file extension with .ali"
1343 ;; kill old buffer
1351 ;; Always recompile the body when we can. We thus temporarily switch to a
1352 ;; buffer than contains the body of the unit
1355 process)
1360 ;; Execute the compilation. Note that we must wait for the end of the
1361 ;; process, or the ALI file would still not be available.
1362 ;; Unfortunately, the underlying `compile' command that we use is
1363 ;; asynchronous.
1371 ;; remove the buffer for the body if it wasn't there before
1374 ))
1375 body-name))
1378 "Search for FILE in DIR-LIST."
1387 found))
1390 "Find an .ali file in obj_dir. The current buffer must be the Ada file.
1391 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1392 and the standard runtime location at the end."
1396 "Find a source file in src_dir. The current buffer must be the Ada file.
1397 Adds src_dir in front of the search path to conform to gnatmake's behavior,
1398 and the standard runtime location at the end."
1402 "Create the ali file name for the ada-file FILE.
1403 The file is searched for in every directory shown in the obj_dir lines of
1404 the project file."
1406 ;; This function has to handle the special case of non-standard
1407 ;; file names (i.e. not .adb or .ads)
1408 ;; The trick is the following:
1409 ;; 1- replace the extension of the current file with .ali,
1410 ;; and look for this file
1411 ;; 2- If this file is found:
1412 ;; grep the "^U" lines, and make sure we are not reading the
1413 ;; .ali file for a spec file. If we are, go to step 3.
1414 ;; 3- If the file is not found or step 2 failed:
1415 ;; find the name of the "other file", ie the body, and look
1416 ;; for its associated .ali file by subtituing the extension
1417 ;;
1418 ;; We must also handle the case of separate packages and subprograms:
1419 ;; 4- If no ali file was found, we try to modify the file name by removing
1420 ;; everything after the last '-' or '.' character, so as to get the
1421 ;; ali file for the parent unit. If we found an ali file, we check that
1422 ;; it indeed contains the definition for the separate entity by checking
1423 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1424 ;; also a separate.
1431 ali-file-name
1432 is-spec)
1434 ;; If we have a non-standard file name, and this is a spec, we first
1435 ;; look for the .ali file of the body, since this is the one that
1436 ;; contains the most complete information. If not found, we will do what
1437 ;; we can with the .ali file for the spec...
1443 file)
1459 ;; Else we take the .ali file associated with the unit
1463 ;; else we did not find the .ali file Second chance: in case
1464 ;; the files do not have standard names (such as for instance
1465 ;; file_s.ada and file_b.ada), try to go to the other file
1466 ;; and look for its ali file
1473 ;; If we still don't have an ali file, try to get the one
1474 ;; from the parent unit, in case we have a separate entity.
1484 )
1485 ali-file-name)))
1487 ;; If still not found, try to recompile the file
1489 ;; recompile only if the user asked for this. and search the ali
1490 ;; filename again. We avoid a possible infinite recursion by
1491 ;; temporarily disabling the automatic compilation.
1501 ;; same if the .ali file is too old and we must recompile it
1503 ada-xref-create-ali)
1506 ;; Always return the correct absolute file name
1508 ))
1511 "Create the complete file name (+directory) for FILE.
1512 The original file (where the user was) is ORIGINAL-FILE. Search in project
1513 file for possible paths."
1517 ;; If the buffer for original-file, use it to get the values from the
1518 ;; project file, otherwise load the file and its project file
1525 ;; we choose the first possible completion and we
1526 ;; return the absolute file name
1534 )))
1537 "Returns the file number for FILE in the associated ali file."
1547 "Returns the identlist around POS and switch to the .ali buffer.
1548 The returned list represents the entity, and can be manipulated through the
1549 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1551 ;; If at end of buffer (e.g the buffer is empty), error
1555 ;; goto first character of the identifier/operator (skip backward < and >
1556 ;; since they are part of multiple character operators
1560 ;; check if it really is an identifier
1565 ;; Just in front of a string => we could have an operator declaration,
1566 ;; as in "+", "-", ..
1570 ;; if looking at an operator
1571 ;; This is only true if:
1572 ;; - the symbol is +, -, ...
1573 ;; - the symbol is made of letters, and not followed by _ or a letter
1592 ;; Build the identlist
1600 identlist
1601 ))
1604 "Completes and returns IDENTLIST with the information extracted
1605 from the ali file (definition file and places where it is referenced)."
1608 declaration-found)
1613 ;; First attempt: we might already be on the declaration of the identifier
1614 ;; We want to look for the declaration only in a definite interval (after
1615 ;; the "^X ..." line for the current file, and before the next "^X" line
1619 nil t)
1629 ))
1631 ;; If declaration is still nil, then we were not on a declaration, and
1632 ;; have to fall back on other algorithms
1636 ;; Since we alread know the number of the file, search for a direct
1637 ;; reference to it
1641 identlist
1647 "[^etpzkd<>=^]"
1649 nil t)
1651 ;; if we did not find it, it may be because the first reference
1652 ;; is not required to have a 'unit_number|' item included.
1653 ;; Or maybe we are already on the declaration...
1656 "^[0-9]+.[0-9]+[ *]"
1660 "[^0-9]"
1662 nil t)
1664 ;; If still not found, then either the declaration is unknown
1665 ;; or the source file has been modified since the ali file was
1666 ;; created
1668 )
1669 )
1671 ;; Last check to be completly sure we have found the correct line (the
1672 ;; ali might not be up to date for instance)
1676 ;; while we have a continuation line, go up one line
1683 ;; Still no success ! The ali file must be too old, and we need to
1684 ;; use a basic algorithm based on guesses. Note that this only happens
1685 ;; if the user does not want us to automatically recompile files
1686 ;; automatically
1690 ;; no more idea to find the declaration. Give up
1695 )))
1696 )
1699 ;; Now that we have found a suitable line in the .ali file, get the
1700 ;; information available
1711 )
1715 ;; If we can find the file
1718 identlist
1722 ;; Else clean up the ali file
1726 ))
1729 ))
1730 ))
1733 "Find the matching position for IDENTLIST in the current ali buffer.
1734 This function is only called when the file was not up-to-date, so we need
1735 to make some guesses.
1736 This function is disabled for operators, and only works for identifiers."
1755 ;; have a look at the line and column numbers
1762 )
1763 ;; construct a list with the file names and the positions within
1767 )
1768 )
1769 )
1771 ;; how many possible declarations have we found ?
1774 ;; none => error
1781 ;; one => should be the right one
1785 ;; more than one => display choice list
1803 ))
1817 )
1820 ))))))
1824 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1825 If OTHER-FRAME is non nil, and `ada-xref-other-buffer' is non nil,
1826 opens a new window to show the declaration."
1832 file line col)
1834 ;; Note: in some cases, an entity can have multiple references to the
1835 ;; bodies (this is for instance the case for a separate subprogram, that
1836 ;; has a reference both to the stub and to the real body).
1837 ;; In that case, we simply go to each one in turn.
1839 ;; Get all the possible locations
1845 ali-line start)
1850 ;; it there was a file number in the same line
1853 ali-line)
1859 )
1860 ;; Else get the nearest file
1865 ;; Add the specs at the end again, so that from the last body we go to
1866 ;; the specs
1869 ;; Find the new location we want to go to.
1870 ;; If we are on none of the locations listed, we simply go to the specs.
1885 locations nil)
1888 ;; Find the file in the source path
1891 ;; Kill the .ali buffer
1894 ;; Now go to the buffer
1898 identlist
1899 other-frame)
1900 ))
1903 "More general function for cross-references.
1904 This function should be used when the standard algorithm that parses the
1905 .ali file has failed, either because that file was too old or even did not
1906 exist.
1907 This function attempts to find the possible declarations for the identifier
1908 anywhere in the object path.
1909 This command requires the external `egrep' program to be available.
1911 This works well when one is using an external librarie and wants
1912 to find the declaration and documentation of the subprograms one is
1913 is using."
1918 line column
1919 choice
1920 file)
1924 ;; Do the grep in all the directories. We do multiple shell
1925 ;; commands instead of one in case there is no .ali file in one
1926 ;; of the directory and the shell stops because of that.
1935 ;; Now parse the output
1949 ;; There could be duplicate choices, because of the structure
1950 ;; of the .ali files
1954 ;; Current buffer is still "*grep*"
1956 )
1958 ;; Now display the list of possible matches
1961 ;; No choice found => Error
1965 ;; Only one choice => Do the cross-reference
1972 identlist
1973 other-frame)
1976 )
1978 ;; Else, ask the user
1994 ))
1996 )))
2005 )
2014 identlist
2015 other-frame)
2018 ))))
2022 "Select and display FILE, at LINE and COLUMN.
2023 If we do not end on the same identifier as IDENTLIST, find the closest
2024 match. Kills the .ali buffer at the end.
2025 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2029 ;; Select and display the destination buffer
2036 )
2038 )
2040 ;; move the cursor to the correct position
2045 ;; If we are not on the identifier, the ali file was not up-to-date.
2046 ;; Try to find the nearest position where the identifier is found,
2047 ;; this is probably the right one.
2050 ))
2054 "Searches for NAME nearest to the position recorded in the Xref file.
2055 It returns the position of the declaration in the buffer or nil if not found."
2062 ;; loop - look for all declarations of name in this file
2065 ;; check if it really is a complete Ada identifier
2072 ;; variable declaration ?
2077 ;; procedure, function, task or package declaration ?
2080 (looking-at "\\<[pP][rR][oO][cC][eE][dD][uU][rR][eE]\\>\\|\\<[fF][uU][nN][cC][tT][iI][oO][nN]\\>\\|\\<[tT][yY][pP][eE]\\>\\|\\<[tT][aA][sS][kK]\\>\\|\\<[pP][aA][cC][kK][aA][gG][eE]\\>\\|\\<[bB][oO][dD][yY]\\>"))))
2082 ;; check if it is nearer than the ones before if any
2088 )
2094 nil)))
2097 ;; Find the parent library file of the current file
2099 "Go to the parent library file."
2117 )
2119 ;; look for the file name for the parent unit specification
2127 )
2132 ;; Tries to open the new ali file to find the spec file
2141 )
2142 )
2143 )
2146 ))
2149 "Determine the filename in which ADANAME is found.
2150 This is a GNAT specific function that uses gnatkrunch."
2155 ;; send adaname to external process `gnatkr'.
2157 adaname ada-krunch-args)
2158 ;; fetch output of that process
2166 adaname
2167 )
2170 "Create an Ada package body in the current buffer.
2171 This function uses the `gnatstub' program to create the body.
2172 This function typically is to be hooked into `ff-file-created-hooks'."
2177 ;; If the current buffer is the body (as is the case when calling this
2178 ;; function from ff-file-created-hooks), then kill this temporary buffer
2185 ;; Make sure the current buffer is the spec (this might not be the case
2186 ;; if for instance the user was asked for a project file)
2191 ;; Make sure we have a project file (for parameters to gnatstub). Note that
2192 ;; this might have already been done if we have been called from the hook,
2193 ;; but this is not an expensive call)
2196 ;; Call the external process gnatstub
2209 )
2210 ;; call gnatstub to create the body file
2223 ;; Else clean up the output
2230 ;; display the error buffer
2232 )
2233 )))
2236 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2237 For instance, it creates the gnat-specific menus, sets some hooks for
2238 find-file...."
2239 ;; This should really be an `add-hook'. -stef
2242 ;; Completion for file names in the mini buffer should ignore .ali files
2246 )
2249 ;; ----- Add to ada-mode-hook ---------------------------------------------
2251 ;; Use gvd or ddd as the default debugger if it was found
2252 ;; On windows, do not use the --tty switch for GVD, since this is
2253 ;; not supported. Actually, we do not use this on Unix either, since otherwise
2254 ;; there is no console window left in GVD, and people have to use the
2255 ;; Emacs one.
2256 ;; This must be done before initializing the Ada menu.
2266 ;; Initializes the cross references to the runtime library
2269 ;; Add these standard directories to the search path
2272 ada-search-directories))
2276 ;;; ada-xref.el ends here