| blob | cea783e60bbd82424fc407752649ffb2bac8913b |
1 ;; ada-xref.el --- for lookup and completion in Ada mode
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 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: Stephen Leake <stephen_leake@stephe-leake.org>
10 ;; Keywords: languages ada xref
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
28 ;;; This Package provides a set of functions to use the output of the
29 ;;; cross reference capabilities of the GNAT Ada compiler
30 ;;; for lookup and completion in Ada mode.
31 ;;;
32 ;;; If a file *.`adp' exists in the ada-file directory, then it is
33 ;;; read for configuration informations. It is read only the first
34 ;;; time a cross-reference is asked for, and is not read later.
36 ;;; You need Emacs >= 20.2 to run this package
39 ;;; History:
40 ;;
42 ;;; Code:
44 ;; ----- Requirements -----------------------------------------------------
51 ;; ------ User variables
53 "*If nil, always display the cross-references in the same buffer.
54 Otherwise create either a new buffer or a new frame."
58 "*If non-nil, run gcc whenever the cross-references are not up-to-date.
59 If nil, the cross-reference mode never runs gcc."
63 "*Non-nil means ask for confirmation before compiling or running 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 `gnatls' to find location of the runtime.
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 substitute the current filename for ${full_current}, or add
110 the filename at the end. This is the same syntax as in the project file."
116 "*Default command to be used to compile a single file.
117 Emacs will substitute the current filename for ${full_current}, or add
118 the filename at the end. This is the same syntax as in the project file."
122 "*Default name of the debugger."
128 "*Default command to be used to compile the application.
129 This is the same syntax as in the project file."
133 "*Name of the current project file.
134 Emacs will not try to use the search algorithm to find the project file if
135 this string is not empty. It is set whenever a project file is found."
139 "*List of the options to pass to `gnatsub' to generate the body of a package.
140 This has the same syntax as in the project file (with variable substitution)."
144 "*If nil, use default values when no project file was found.
145 Otherwise, ask the user for the name of the project file to use."
152 "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging.
153 If GVD is not the debugger used, nothing happens."
157 "*If non-nil, use egrep to find the possible declarations for an entity.
158 This alternate method is used when the exact location was not found in the
159 information provided by GNAT. However, it might be expensive if you have a lot
160 of sources, since it will search in all the files in your project."
164 "Hook that is run when loading a project file.
165 Each function in this hook takes one argument FILENAME, that is the name of
166 the project file to load.
167 This hook should be used to support new formats for the project files.
169 If the function can load the file with the given filename, it should create a
170 buffer that contains a conversion of the file to the standard format of the
172 lines.) It should return nil if it doesn't know how to convert that project
176 ;; ------- Nothing to be modified by the user below this
184 "Directories where the specs for the standard library is found.
188 "Directories where the ali for the standard library is found.
192 "List of positions selected by the cross-references functions.
197 "cd /d"
199 "Command to use to change to a specific directory.
200 On Windows systems using `cmdproxy.exe' as the shell,
204 "Separator to use between multiple commands to `compile' or `start-process'.
205 `cmdproxy.exe' doesn't recognize multiple-line commands, so we have to use
216 "Associative list of project files with properties.
217 It has the format: (project project ...)
218 A project has the format: (project-file . project-plist)
219 \(See 'apropos plist' for operations on property lists).
220 See `ada-xref-set-default-prj-values' for the list of valid properties.
221 The current project is retrieved with `ada-xref-current-project'.
222 Properties are retrieved with `ada-xref-get-project-field', set with
223 `ada-xref-set-project-field'. If project properties are accessed with no
227 ;; ----- Identlist manipulation -------------------------------------------
228 ;; An identlist is a vector that is used internally to reference an identifier
229 ;; To facilitate its use, we provide the following macros
251 "Read the ali file FILE into a new buffer, and return the buffer's name."
255 ;; -----------------------------------------------------------------------
262 "Find the full path to the executable file EXEC-NAME.
263 On Windows systems, this will properly handle .exe extension as well"
266 exec-name))
269 "Initialize the variables for the runtime library location.
270 CROSS-PREFIX is the prefix to use for the `gnatls' command."
273 ada-xref-runtime-library-ali-path '())
277 ;; Catch any error in the following form (i.e gnatls was not found)
279 ;; Even if we get an error, delete the *gnatls* buffer
287 ;; Source path
301 ;; Object path
314 )
321 ))
324 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
325 Assumes project exists.
326 As a special case, ${current} is replaced with the name of the current
327 file, minus extension but with directory, and ${full_current} is
328 replaced by the name including the extension."
342 ;; Check if there is an environment variable with the same name
356 t t cmd-string)))))
357 ))
358 cmd-string)
361 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
364 plist)
369 ;; Try hard to find a project file, even if the current
370 ;; buffer is not an Ada file or not associated with a file
374 ada-prj-default-project-file)
378 "and no default project "
385 ada-case-exception-file
387 'comp_opt ada-prj-default-comp-opt
388 'bind_opt ada-prj-default-bind-opt
389 'link_opt ada-prj-default-link-opt
390 'gnatmake_opt ada-prj-default-gnatmake-opt
391 'gnatfind_opt ada-prj-gnatfind-switches
410 )
414 "Extract the value of FIELD from the current project file.
415 Project variables are substituted.
417 Note that for src_dir and obj_dir, you should rather use
418 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field'
419 which will in addition return the default paths."
422 value)
426 ;; Substitute the ${...} constructs in all the strings, including
427 ;; inside lists
432 nil)
436 value)
437 )
438 ))
441 "Return the full value for src_dir, including the default directories.
442 All the directories are returned as absolute directories."
446 ;; Add ${build_dir} in front of the path
450 build-dir)
452 ;; Add the standard runtime at the end
453 ada-xref-runtime-library-specs-path)))
456 "Return the full value for obj_dir, including the default directories.
457 All the directories are returned as absolute directories."
461 ;; Add ${build_dir} in front of the path
465 build-dir)
467 ;; Add the standard runtime at the end
468 ada-xref-runtime-library-ali-path)))
471 "Set FIELD to VALUE in current project. Assumes project exists."
472 ;; same algorithm to find project-plist as ada-xref-current-project
480 "Update the menu Ada->Project, with the list of available project files."
481 ;; Create the standard items.
487 "---"
488 ;; Add the new items
493 "Change the active project file."
500 ada-prj-file-extension)
504 command
506 :toggle
509 ))))
511 ;; Parses all the known project files, and insert at
512 ;; least the default one (in case
513 ;; ada-xref-project-files is nil)
519 ;;-------------------------------------------------------------
520 ;;-- Searching a file anywhere on the source path.
521 ;;--
522 ;;-- The following functions provide support for finding a file anywhere
523 ;;-- on the source path, without providing an explicit directory.
524 ;;-- They also provide file name completion in the minibuffer.
525 ;;--
526 ;;-- Public subprograms: ada-find-file
527 ;;--
528 ;;-------------------------------------------------------------
531 "Completion function when reading a file from the minibuffer.
532 Completion is attempted in all the directories in the source path, as
533 defined in the project file."
534 ;; FIXME: doc arguments
536 ;; This function is not itself interactive, but it is called as part
537 ;; of the prompt of interactive functions, so we require a project
538 ;; file.
550 list)
554 predicate)))))
556 ;;;###autoload
558 "Open FILENAME, from anywhere in the source path.
559 Completion is available."
568 ;; ----- Utilities -------------------------------------------------
571 "If the current project does not exist, load or create a default one.
572 Should only be called from interactive functions."
577 "Return the current project file name; never nil unless NO-USER-QUESTION.
578 If NO-USER-QUESTION, don't prompt user for file. Call
579 `ada-require-project-file' first if a project must exist."
581 ada-prj-default-project-file
585 "Return the current project; nil if none.
586 If NO-USER-QUESTION, don't prompt user for file. Call
587 `ada-require-project-file' first if a project must exist."
592 "Display current project file name in message buffer."
597 "Display current main unit name in message buffer."
602 "Push (FILENAME, POSITION) on the position ring for cross-references."
608 "Go to the previous cross-reference we were on."
617 "Convert from NAME to a name that can be used by the compilation commands.
618 This is overridden on VMS to convert from VMS filenames to Unix filenames."
619 name)
620 ;; FIXME: use convert-standard-filename instead
623 "Set the file whose name is NAME as the default project file.
624 If KEEP-EXISTING is true and a project file has already been loaded, nothing
625 is done. This is meant to be used from `ada-mode-hook', for instance, to force
626 a project file unless the user has already loaded one."
635 ;; ------ Handling the project file -----------------------------
638 "Find the project file associated with FILE (or the current buffer if nil).
639 If the buffer is not in Ada mode, or not associated with a file,
640 return `ada-prj-default-project-file'. Otherwise, search for a file with
641 the same base name as the Ada file, but extension given by
642 `ada-prj-file-extension' (default .adp). If not found, search for *.adp
643 in the current directory; if several are found, and NO-USER-QUESTION
644 is non-nil, prompt the user to select one. If none are found, return
645 'default.adp'."
650 buffer-file-name))
652 ;; Not in an Ada buffer, or current buffer not associated
653 ;; with a file (for instance an emerge buffer)
660 ;; other cases: use a more complex algorithm
665 ada-prj-file-extension))
669 dir t
677 ;; filename.adp
681 ;; Exactly one project file was found in the current directory
685 ;; multiple project files in current directory, ask the user
695 counter
711 ;; No project file in the current directory; ask user
716 nil ada-last-prj-file))
719 )))
722 ))
726 "Read PRJ-FILE, set it as the active project."
727 ;; FIXME: doc nil, search, etc.
730 run_cmd debug_pre_cmd debug_post_cmd
734 ;; Set the project file as the active one.
737 ;; Initialize the project with the default values
740 ;; Do not use find-file below, since we don't want to show this
741 ;; buffer. If the file is open through speedbar, we can't use
742 ;; find-file anyway, since the speedbar frame is special and does not
743 ;; allow the selection of a file in it.
756 ;; Now overrides these values with the project file
760 ;; fields that are lists or paths require special processing
761 ;; FIXME: strip trailing spaces
787 ;; any other field in the file is just copied
812 )
814 ;; Else the file wasn't readable (probably the default project).
815 ;; We initialize it with the current environment variables.
816 ;; We need to add the startup directory in front so that
817 ;; files locally redefined are properly found. We cannot
818 ;; add ".", which varies too much depending on what the
819 ;; current buffer is.
832 )
835 ;; Delete the default project file from the list, if it is there.
836 ;; Note that in that case, this default project is the only one in
837 ;; the list
841 ;; Memorize the newly read project file
846 ;; Sets up the compilation-search-path so that Emacs is able to
847 ;; go to the source of the errors in a compilation buffer
850 ;; Set the casing exceptions file list
856 ;; Add the directories to the search path for ff-find-other-file
857 ;; Do not add the '/' or '\' at the end
860 ada-search-directories))
863 )
865 ;; No prj file ? => Setup default values
866 ;; Note that nil means that all compilation modes will first look in the
867 ;; current directory, and only then in the current file's directory. This
868 ;; current file is assumed at this point to be in the common source
869 ;; directory.
871 ))
875 "Find all references to the entity under POS.
876 Calls gnatfind to find the references.
877 If ARG is t, the contents of the old *gnatfind* buffer is preserved.
878 If LOCAL-ONLY is t, only the declarations in the current file are returned."
888 ;; if the file is more recent than the executable
893 nil nil local-only arg)
898 )
901 "Find all references to the entity under POS.
902 Calls `gnatfind' to find the references.
903 If ARG is t, the contents of the old *gnatfind* buffer is preserved."
911 "Search for references to any entity whose name is ENTITY.
912 ENTITY was first found the location given by FILE, LINE and COLUMN.
913 If LOCAL-ONLY is t, then list only the references in FILE, which
914 is much faster.
915 If APPEND is t, then append the output of the command to the existing
916 buffer `*gnatfind*', if there is one."
920 ;; Prepare the gnatfind command. Note that we must protect the quotes
921 ;; around operators, so that they are correctly handled and can be
922 ;; processed (gnatfind \"+\":...).
928 entity))
931 quote-entity
936 ))
937 old-contents)
939 ;; If a project file is defined, use it
955 ;; Hide the "Compilation" menu
967 )
968 )
972 ;; ----- Identifier Completion --------------------------------------------
974 "Try to complete the identifier around POS, using compiler cross-reference information."
978 ;; Initialize function-local variables and jump to the .ali buffer
979 ;; Note that for regexp search is case insensitive too
988 ;; Open the .ali file
992 ;; build an alist of possible completions
998 ;; kills .ali buffer
1001 ;; deletes the incomplete identifier in the buffer
1005 ;; inserts the completed symbol
1007 ))
1009 ;; ----- Cross-referencing ----------------------------------------
1012 "Jump to the declaration of the entity below the cursor."
1018 "Jump to the body of the entity under the cursor."
1024 "Display the body of the entity around POS.
1025 OTHER-FRAME non-nil means display in another frame.
1026 If the entity doesn't have a body, display its declaration.
1027 As a side effect, the buffer for the declaration is also open."
1031 ;; Temporarily force the display in the same buffer, since we
1032 ;; already changed previously
1037 "Display the declaration of the identifier around POS.
1038 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1039 non-nil.
1040 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1046 ;; First try the standard algorithm by looking into the .ali file, but if
1047 ;; that file was too old or even did not exist, try to look in the whole
1048 ;; object path for a possible location.
1052 ;; File not found: print explicit error message
1060 ;; If the ALI file was up-to-date, then we probably have a predefined
1061 ;; entity, whose references are not given by GNAT
1066 ;; Else, look in every ALI file, except if the user doesn't want that
1070 )))))))
1073 "Display the declaration of the identifier around POS.
1074 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1079 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1082 command
1084 remote-shell-program
1085 machine
1086 command))))
1089 "Return the list of absolute directories found in DIR-LIST.
1090 If a directory is a relative directory, ROOT-DIR is prepended."
1094 "Prepare an environment for Ada compilation.
1095 This returns a new value to use for `process-environment',
1096 but does not actually put it into use.
1097 It modifies the source path and object path with the values found in the
1098 project file."
1110 path-separator)
1111 include)
1116 path-separator)
1117 objects)
1118 process-environment))))
1121 "Compile the application, using the command found in the project file.
1122 If ARG is not nil, ask for user confirmation."
1131 ;; If no project file was found, ask the user
1135 ;; Make a single command from the list of commands, including the
1136 ;; commands to run it on a remote machine.
1142 ;; Insert newlines so as to separate the name of the commands to run
1143 ;; and the output of the commands. This doesn't work with cmdproxy.exe,
1144 ;; which gets confused by newline characters.
1151 "Set main_unit and main project variables to current buffer, build main."
1155 main)
1169 "Recompile the current file.
1170 If ARG is not nil, ask for user confirmation of the command.
1171 PRJ-FIELD is the name of the field to use in the project file to get the
1172 command, and should be either `comp_cmd' (default) or `check_cmd'."
1185 ;; Make a single command from the list of commands, including the
1186 ;; commands to run it on a remote machine.
1189 ;; If no project file was found, ask the user
1196 "Check the current file for syntax errors.
1197 If ARG is not nil, ask for user confirmation of the command."
1202 "Run the application.
1203 if ARG is not-nil, ask for user confirmation."
1213 ;; Guess the command if it wasn't specified
1217 ;; Modify the command to run remotely
1219 ada-command-separator)))
1221 ;; Ask for the arguments to the command if required
1224 command)))
1226 ;; Run the command
1235 ;; Set these two variables to their default values, since otherwise
1236 ;; the output buffer is scrolled so that only the last output line
1237 ;; is visible at the top of the buffer.
1240 )
1243 ;; change to buffer *run* for interactive programs
1246 ))
1249 "Start the debugger on the application.
1250 If ARG is non-nil, ask the user to confirm the command.
1251 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1252 project file."
1256 cmd pre-cmd post-cmd)
1263 ;; If the command was not given in the project file, start a bare gdb
1266 " "
1270 ;; For gvd, add an extra switch so that the Emacs window is completly
1271 ;; swallowed inside the Gvd one
1274 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1275 ;; We make sure that gvd swallows the new frame, not the one the
1276 ;; user has been using until now
1277 ;; The frame is made invisible initially, so that GtkPlug gets a
1278 ;; chance to fully manage it. Then it works fine with Enlightenment
1279 ;; as well
1282 cmd " --editor-window="
1286 ;; Add a -fullname switch
1287 ;; Use the remote machine
1290 ;; Ask for confirmation if required
1296 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1297 ;; FIXME: This is evil but luckily a nop under Emacs-21.3.50 ! -stef
1309 ;; Temporarily replaces the definition of `comint-exec' so that we
1310 ;; can execute commands before running gdb.
1311 ;; FIXME: This is evil and not temporary !!! -stef
1320 command " "
1322 ))
1324 ;; Tight integration should force the tty mode
1326 ada-tight-gvd-integration
1335 ;; Restore the standard fset command (or for instance C-U M-x shell
1336 ;; wouldn't work anymore
1340 ;; Send post-commands to the debugger
1343 ;; Move to the end of the debugger buffer, so that it is automatically
1344 ;; scrolled from then on.
1347 ;; Display both the source window and the debugger window (the former
1348 ;; above the latter). No need to show the debugger window unless it
1349 ;; is going to have some relevant information.
1354 )))
1357 "Reread either the current project, or FILENAME if non-nil."
1363 ;; Reread the location of the standard runtime library
1366 )
1368 ;; ------ Private routines
1371 "Update the cross-references for FILE.
1372 This in fact recompiles FILE to create ALI-FILE-NAME.
1373 This function returns the name of the file that was recompiled to generate
1374 the cross-reference information. Note that the ali file can then be deduced
1375 by replacing the file extension with `.ali'."
1376 ;; kill old buffer
1384 ;; Always recompile the body when we can. We thus temporarily switch to a
1385 ;; buffer than contains the body of the unit
1388 process)
1393 ;; Execute the compilation. Note that we must wait for the end of the
1394 ;; process, or the ALI file would still not be available.
1395 ;; Unfortunately, the underlying `compile' command that we use is
1396 ;; asynchronous.
1404 ;; remove the buffer for the body if it wasn't there before
1407 ))
1408 body-name))
1411 "Search for FILE in DIR-LIST."
1420 found))
1423 "Find the ali file FILE, searching obj_dir for the current project.
1424 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1425 and the standard runtime location at the end."
1429 "Find the source file FILE, searching src_dir for the current project.
1430 Adds the standard runtime location at the end of the search path to conform
1431 to gnatmake's behavior."
1435 "Create the ali file name for the ada-file FILE.
1436 The file is searched for in every directory shown in the obj_dir lines of
1437 the project file."
1439 ;; This function has to handle the special case of non-standard
1440 ;; file names (i.e. not .adb or .ads)
1441 ;; The trick is the following:
1442 ;; 1- replace the extension of the current file with .ali,
1443 ;; and look for this file
1444 ;; 2- If this file is found:
1445 ;; grep the "^U" lines, and make sure we are not reading the
1446 ;; .ali file for a spec file. If we are, go to step 3.
1447 ;; 3- If the file is not found or step 2 failed:
1448 ;; find the name of the "other file", ie the body, and look
1449 ;; for its associated .ali file by subtituing the extension
1450 ;;
1451 ;; We must also handle the case of separate packages and subprograms:
1452 ;; 4- If no ali file was found, we try to modify the file name by removing
1453 ;; everything after the last '-' or '.' character, so as to get the
1454 ;; ali file for the parent unit. If we found an ali file, we check that
1455 ;; it indeed contains the definition for the separate entity by checking
1456 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1457 ;; also a separate.
1464 ali-file-name
1465 is-spec)
1467 ;; If we have a non-standard file name, and this is a spec, we first
1468 ;; look for the .ali file of the body, since this is the one that
1469 ;; contains the most complete information. If not found, we will do what
1470 ;; we can with the .ali file for the spec...
1476 file)
1492 ;; Else we take the .ali file associated with the unit
1496 ;; else we did not find the .ali file Second chance: in case
1497 ;; the files do not have standard names (such as for instance
1498 ;; file_s.ada and file_b.ada), try to go to the other file
1499 ;; and look for its ali file
1506 ;; If we still don't have an ali file, try to get the one
1507 ;; from the parent unit, in case we have a separate entity.
1517 )
1518 ali-file-name)))
1520 ;; If still not found, try to recompile the file
1522 ;; Recompile only if the user asked for this, and search the ali
1523 ;; filename again. We avoid a possible infinite recursion by
1524 ;; temporarily disabling the automatic compilation.
1534 ;; same if the .ali file is too old and we must recompile it
1536 ada-xref-create-ali)
1539 ;; Always return the correct absolute file name
1541 ))
1544 "Create the complete file name (+directory) for FILE.
1545 The original file (where the user was) is ORIGINAL-FILE.
1546 Search in project file for possible paths."
1550 ;; If the buffer for original-file, use it to get the values from the
1551 ;; project file, otherwise load the file and its project file
1557 ;; we choose the first possible completion and we
1558 ;; return the absolute file name
1563 )))
1566 "Return the file number for FILE in the associated ali file."
1576 "Return the identlist around POS and switch to the .ali buffer.
1577 The returned list represents the entity, and can be manipulated through the
1578 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1580 ;; If at end of buffer (e.g the buffer is empty), error
1584 ;; goto first character of the identifier/operator (skip backward < and >
1585 ;; since they are part of multiple character operators
1589 ;; check if it really is an identifier
1594 ;; Just in front of a string => we could have an operator declaration,
1595 ;; as in "+", "-", ..
1599 ;; if looking at an operator
1600 ;; This is only true if:
1601 ;; - the symbol is +, -, ...
1602 ;; - the symbol is made of letters, and not followed by _ or a letter
1621 ;; Build the identlist
1629 identlist
1630 ))
1633 "Complete IDENTLIST with definition file and places where it is referenced.
1634 Information is extracted from the ali file."
1637 declaration-found)
1642 ;; First attempt: we might already be on the declaration of the identifier
1643 ;; We want to look for the declaration only in a definite interval (after
1644 ;; the "^X ..." line for the current file, and before the next "^X" line
1648 nil t)
1658 ))
1660 ;; If declaration is still nil, then we were not on a declaration, and
1661 ;; have to fall back on other algorithms
1665 ;; Since we alread know the number of the file, search for a direct
1666 ;; reference to it
1670 identlist
1676 "[^etpzkd<>=^]"
1678 nil t)
1680 ;; if we did not find it, it may be because the first reference
1681 ;; is not required to have a 'unit_number|' item included.
1682 ;; Or maybe we are already on the declaration...
1685 "^[0-9]+.[0-9]+[ *]"
1689 "[^0-9]"
1691 nil t)
1693 ;; If still not found, then either the declaration is unknown
1694 ;; or the source file has been modified since the ali file was
1695 ;; created
1697 )
1698 )
1700 ;; Last check to be completly sure we have found the correct line (the
1701 ;; ali might not be up to date for instance)
1705 ;; while we have a continuation line, go up one line
1713 ;; Still no success ! The ali file must be too old, and we need to
1714 ;; use a basic algorithm based on guesses. Note that this only happens
1715 ;; if the user does not want us to automatically recompile files
1716 ;; automatically
1720 ;; No more idea to find the declaration. Give up
1725 )))
1726 )
1729 ;; Now that we have found a suitable line in the .ali file, get the
1730 ;; information available
1741 )
1745 ;; If we can find the file
1748 identlist
1752 ;; Else clean up the ali file
1758 ))
1761 ))
1762 ))
1765 "Find the matching position for IDENTLIST in the current ali buffer.
1766 This function is only called when the file was not up-to-date, so we need
1767 to make some guesses.
1768 This function is disabled for operators, and only works for identifiers."
1787 ;; have a look at the line and column numbers
1794 )
1795 ;; construct a list with the file names and the positions within
1799 )
1800 )
1801 )
1803 ;; how many possible declarations have we found ?
1806 ;; none => error
1811 ;; one => should be the right one
1815 ;; more than one => display choice list
1833 ))
1847 )
1850 ))))))
1854 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1855 If OTHER-FRAME is non-nil, and `ada-xref-other-buffer' is non-nil,
1856 opens a new window to show the declaration."
1862 file line col)
1864 ;; Note: in some cases, an entity can have multiple references to the
1865 ;; bodies (this is for instance the case for a separate subprogram, that
1866 ;; has a reference both to the stub and to the real body).
1867 ;; In that case, we simply go to each one in turn.
1869 ;; Get all the possible locations
1875 ali-line start)
1880 ;; it there was a file number in the same line
1881 ;; Make sure we correctly handle the case where the first file reference
1882 ;; on the line is the type reference.
1883 ;; 1U2 T(2|2r3) 34r23
1886 ali-line)
1892 )
1893 ;; Else get the nearest file
1898 ;; Add the specs at the end again, so that from the last body we go to
1899 ;; the specs
1902 ;; Find the new location we want to go to.
1903 ;; If we are on none of the locations listed, we simply go to the specs.
1918 locations nil)
1921 ;; Find the file in the source path
1924 ;; Kill the .ali buffer
1927 ;; Now go to the buffer
1931 identlist
1932 other-frame)
1933 ))
1936 "More general function for cross-references.
1937 This function should be used when the standard algorithm that parses the
1938 .ali file has failed, either because that file was too old or even did not
1939 exist.
1940 This function attempts to find the possible declarations for the identifier
1941 anywhere in the object path.
1942 This command requires the external `egrep' program to be available.
1944 This works well when one is using an external library and wants to find
1945 the declaration and documentation of the subprograms one is using."
1946 ;; FIXME: what does this function do?
1950 line column
1951 choice
1952 file)
1956 ;; Do the grep in all the directories. We do multiple shell
1957 ;; commands instead of one in case there is no .ali file in one
1958 ;; of the directory and the shell stops because of that.
1964 "grep -E -i -h "
1966 " "
1971 ;; Now parse the output
1985 ;; There could be duplicate choices, because of the structure
1986 ;; of the .ali files
1990 ;; Current buffer is still "*grep*"
1992 )
1994 ;; Now display the list of possible matches
1997 ;; No choice found => Error
2001 ;; Only one choice => Do the cross-reference
2008 identlist
2009 other-frame)
2012 )
2014 ;; Else, ask the user
2030 ))
2032 )))
2041 )
2050 identlist
2051 other-frame)
2054 ))))
2058 "Select and display FILE, at LINE and COLUMN.
2059 If we do not end on the same identifier as IDENTLIST, find the closest
2060 match. Kills the .ali buffer at the end.
2061 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2065 ;; Select and display the destination buffer
2072 )
2074 )
2076 ;; move the cursor to the correct position
2081 ;; If we are not on the identifier, the ali file was not up-to-date.
2082 ;; Try to find the nearest position where the identifier is found,
2083 ;; this is probably the right one.
2086 ))
2090 "Search for NAME nearest to the position recorded in the Xref file.
2091 Return the position of the declaration in the buffer, or nil if not found."
2098 ;; loop - look for all declarations of name in this file
2101 ;; check if it really is a complete Ada identifier
2108 ;; variable declaration ?
2113 ;; procedure, function, task or package declaration ?
2116 (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]\\>"))))
2118 ;; check if it is nearer than the ones before if any
2124 )
2130 nil)))
2133 ;; Find the parent library file of the current file
2135 "Go to the parent library file."
2153 )
2155 ;; look for the file name for the parent unit specification
2163 )
2168 ;; Tries to open the new ali file to find the spec file
2177 )
2178 )
2179 )
2182 ))
2185 "Determine the filename in which ADANAME is found.
2186 This is a GNAT specific function that uses gnatkrunch."
2191 ;; send adaname to external process `gnatkr'.
2192 ;; Add a dummy extension, since gnatkr versions have two different
2193 ;; behaviors depending on the version:
2194 ;; Up to 3.15: "AA.BB.CC" => aa-bb-cc
2195 ;; After: "AA.BB.CC" => aa-bb.cc
2198 ;; fetch output of that process
2205 ;; Remove the extra extension we added above
2209 adaname
2210 )
2213 "Create an Ada package body in the current buffer.
2214 This function uses the `gnatstub' program to create the body.
2215 If INTERACTIVE is nil, kill the current buffer.
2216 This function typically is to be hooked into `ff-file-created-hook'."
2222 ;; If the current buffer is the body (as is the case when calling this
2223 ;; function from ff-file-created-hook), then kill this temporary buffer
2229 ;; Make sure the current buffer is the spec (this might not be the case
2230 ;; if for instance the user was asked for a project file)
2235 ;; Call the external process gnatstub
2248 )
2249 ;; call gnatstub to create the body file
2262 ;; Else clean up the output
2269 ;; display the error buffer
2271 )
2272 )))
2275 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2276 For instance, it creates the gnat-specific menus, sets some hooks for
2277 `find-file'."
2282 ;; Completion for file names in the mini buffer should ignore .ali files
2286 )
2288 ;; ----- Add to ada-mode-hook ---------------------------------------------
2290 ;; This must be done before initializing the Ada menu.
2293 ;; Define a new error type
2295 'error-conditions
2298 'error-message
2301 ;; Initializes the cross references to the runtime library
2304 ;; Add these standard directories to the search path
2307 ada-search-directories))
2311 ;; arch-tag: 415a39fe-577b-4676-b3b1-6ff6db7ca24e
2312 ;;; ada-xref.el ends here