| blob | 9c239ee6dbb54fdf22b06edd6a6f6ec231fed340 |
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 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 2, or (at your option)
17 ;; 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; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
29 ;;; Commentary:
30 ;;; This Package provides a set of functions to use the output of the
31 ;;; cross reference capabilities of the GNAT Ada compiler
32 ;;; for lookup and completion in Ada mode.
33 ;;;
34 ;;; If a file *.`adp' exists in the ada-file directory, then it is
35 ;;; read for configuration informations. It is read only the first
36 ;;; time a cross-reference is asked for, and is not read later.
38 ;;; You need Emacs >= 20.2 to run this package
41 ;;; History:
42 ;;
44 ;;; Code:
46 ;; ----- Requirements -----------------------------------------------------
53 ;; ------ User variables
55 "*If nil, always display the cross-references in the same buffer.
56 Otherwise create either a new buffer or a new frame."
60 "*If non-nil, run gcc whenever the cross-references are not up-to-date.
61 If nil, the cross-reference mode never runs gcc."
65 "*Non-nil means ask for confirmation before compiling or running the application."
69 "*Maximum number of characters for filenames created by `gnatkr'.
70 Set to 0, if you don't use crunched filenames. This should be a string."
74 "*Arguments to pass to `gnatfind' to find location of the runtime.
75 Typical use is to pass `--RTS=soft-floats' on some systems that support it.
77 You can also add `-I-' if you do not want the current directory to be included.
78 Otherwise, going from specs to bodies and back will first look for files in the
79 current directory. This only has an impact if you are not using project files,
80 but only ADA_INCLUDE_PATH."
84 "Default compilation options."
88 "Default binder options."
92 "Default linker options."
96 "Default options for `gnatmake'."
100 "Default switches to use for `gnatfind'.
101 You should modify this variable, for instance to add `-a', if you are working
102 in an environment where most ALI files are write-protected.
103 The command `gnatfind' is used every time you choose the menu
110 "*Default command to be used to compile a single file.
111 Emacs will substitute the current filename for ${full_current}, or add
112 the filename at the end. This is the same syntax as in the project file."
118 "*Default command to be used to compile a single file.
119 Emacs will substitute the current filename for ${full_current}, or add
120 the filename at the end. This is the same syntax as in the project file."
124 "*Default name of the debugger."
130 "*Default command to be used to compile the application.
131 This is the same syntax as in the project file."
135 "*Name of the current project file.
136 Emacs will not try to use the search algorithm to find the project file if
137 this string is not empty. It is set whenever a project file is found."
141 "*List of the options to pass to `gnatsub' to generate the body of a package.
142 This has the same syntax as in the project file (with variable substitution)."
146 "*If nil, use default values when no project file was found.
147 Otherwise, ask the user for the name of the project file to use."
154 "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging.
155 If GVD is not the debugger used, nothing happens."
159 "*If non-nil, use egrep to find the possible declarations for an entity.
160 This alternate method is used when the exact location was not found in the
161 information provided by GNAT. However, it might be expensive if you have a lot
162 of sources, since it will search in all the files in your project."
166 "Hook that is run when loading a project file.
167 Each function in this hook takes one argument FILENAME, that is the name of
168 the project file to load.
169 This hook should be used to support new formats for the project files.
171 If the function can load the file with the given filename, it should create a
172 buffer that contains a conversion of the file to the standard format of the
174 lines.) It should return nil if it doesn't know how to convert that project
178 ;; ------- Nothing to be modified by the user below this
186 "Directories where the specs for the standard library is found.
190 "Directories where the ali for the standard library is found.
194 "List of positions selected by the cross-references functions.
199 "cd /d"
201 "Command to use to change to a specific directory.
202 On Windows systems using `cmdproxy.exe' as the shell,
206 "Separator to use between multiple commands to `compile' or `start-process'.
207 `cmdproxy.exe' doesn't recognize multiple-line commands, so we have to use
218 "Associative list of project files with properties.
219 It has the format: (project project ...)
220 A project has the format: (project-file . project-plist)
221 \(See 'apropos plist' for operations on property lists).
222 See `ada-xref-set-default-prj-values' for the list of valid properties.
223 The current project is retrieved with `ada-xref-current-project'.
224 Properties are retrieved with `ada-xref-get-project-field', set with
225 `ada-xref-set-project-field'. If project properties are accessed with no
229 ;; ----- Identlist manipulation -------------------------------------------
230 ;; An identlist is a vector that is used internally to reference an identifier
231 ;; To facilitate its use, we provide the following macros
253 "Read the ali file FILE into a new buffer, and return the buffer's name."
257 ;; -----------------------------------------------------------------------
264 "Find the full path to the executable file EXEC-NAME.
265 On Windows systems, this will properly handle .exe extension as well"
268 exec-name))
271 "Initialize the variables for the runtime library location.
272 CROSS-PREFIX is the prefix to use for the `gnatls' command."
275 ada-xref-runtime-library-ali-path '())
279 ;; Catch any error in the following form (i.e gnatls was not found)
281 ;; Even if we get an error, delete the *gnatls* buffer
289 ;; Source path
303 ;; Object path
316 )
323 ))
327 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
328 Assumes project exists.
329 As a special case, ${current} is replaced with the name of the current
330 file, minus extension but with directory, and ${full_current} is
331 replaced by the name including the extension."
345 ;; Check if there is an environment variable with the same name
359 t t cmd-string)))))
360 ))
361 cmd-string)
364 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
367 plist)
372 ;; Try hard to find a project file, even if the current
373 ;; buffer is not an Ada file or not associated with a file
377 ada-prj-default-project-file)
381 "and no default project "
388 ada-case-exception-file
390 'comp_opt ada-prj-default-comp-opt
391 'bind_opt ada-prj-default-bind-opt
392 'link_opt ada-prj-default-link-opt
393 'gnatmake_opt ada-prj-default-gnatmake-opt
394 'gnatfind_opt ada-prj-gnatfind-switches
413 )
417 "Extract the value of FIELD from the current project file.
418 Project variables are substituted.
420 Note that for src_dir and obj_dir, you should rather use
421 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field'
422 which will in addition return the default paths."
425 value)
429 ;; Substitute the ${...} constructs in all the strings, including
430 ;; inside lists
435 nil)
439 value)
440 )
441 ))
444 "Return the full value for src_dir, including the default directories.
445 All the directories are returned as absolute directories."
449 ;; Add ${build_dir} in front of the path
453 build-dir)
455 ;; Add the standard runtime at the end
456 ada-xref-runtime-library-specs-path)))
459 "Return the full value for obj_dir, including the default directories.
460 All the directories are returned as absolute directories."
464 ;; Add ${build_dir} in front of the path
468 build-dir)
470 ;; Add the standard runtime at the end
471 ada-xref-runtime-library-ali-path)))
474 "Set FIELD to VALUE in current project. Assumes project exists."
475 ;; same algorithm to find project-plist as ada-xref-current-project
483 "Update the menu Ada->Project, with the list of available project files."
484 ;; Create the standard items.
490 "---"
491 ;; Add the new items
496 "Change the active project file."
503 ada-prj-file-extension)
507 command
509 :toggle
512 ))))
514 ;; Parses all the known project files, and insert at
515 ;; least the default one (in case
516 ;; ada-xref-project-files is nil)
522 ;;-------------------------------------------------------------
523 ;;-- Searching a file anywhere on the source path.
524 ;;--
525 ;;-- The following functions provide support for finding a file anywhere
526 ;;-- on the source path, without providing an explicit directory.
527 ;;-- They also provide file name completion in the minibuffer.
528 ;;--
529 ;;-- Public subprograms: ada-find-file
530 ;;--
531 ;;-------------------------------------------------------------
534 "Completion function when reading a file from the minibuffer.
535 Completion is attempted in all the directories in the source path, as
536 defined in the project file."
537 ;; FIXME: doc arguments
548 list)
552 predicate)))))
554 ;;;###autoload
556 "Open FILENAME, from anywhere in the source path.
557 Completion is available."
566 ;; ----- Utilities -------------------------------------------------
569 "If the current project does not exist, load or create a default one.
570 Should only be called from interactive functions."
575 "Return the current project file name; never nil unless NO-USER-QUESTION.
576 If NO-USER-QUESTION, don't prompt user for file. Call
577 `ada-require-project-file' first if a project must exist."
579 ada-prj-default-project-file
583 "Return the current project; nil if none.
584 If NO-USER-QUESTION, don't prompt user for file. Call
585 `ada-require-project-file' first if a project must exist."
590 "Display current project file name in message buffer."
595 "Display current main unit name in message buffer."
600 "Push (FILENAME, POSITION) on the position ring for cross-references."
606 "Go to the previous cross-reference we were on."
615 "Convert from NAME to a name that can be used by the compilation commands.
616 This is overriden on VMS to convert from VMS filenames to Unix filenames."
617 name)
618 ;; FIXME: use convert-standard-filename instead
621 "Set the file whose name is NAME as the default project file.
622 If KEEP-EXISTING is true and a project file has already been loaded, nothing
623 is done. This is meant to be used from `ada-mode-hook', for instance, to force
624 a project file unless the user has already loaded one."
633 ;; ------ Handling the project file -----------------------------
636 "Find the project file associated with FILE (or the current buffer if nil).
637 If the buffer is not in Ada mode, or not associated with a file,
638 return `ada-prj-default-project-file'. Otherwise, search for a file with
639 the same base name as the Ada file, but extension given by
640 `ada-prj-file-extension' (default .adp). If not found, search for *.adp
641 in the current directory; if several are found, and NO-USER-QUESTION
642 is non-nil, prompt the user to select one. If none are found, return
643 'default.adp'."
650 ;; Not in an Ada buffer, or current buffer not associated
651 ;; with a file (for instance an emerge buffer)
658 ;; other cases: use a more complex algorithm
663 ada-prj-file-extension))
666 ;; on Emacs 20.2, directory-files does not work if
667 ;; parse-sexp-lookup-properties is set
670 dir t
678 ;; filename.adp
682 ;; Exactly one project file was found in the current directory
686 ;; multiple project files in current directory, ask the user
696 counter
712 ;; No project file in the current directory; ask user
717 nil ada-last-prj-file))
720 )))
723 ))
727 "Read PRJ-FILE, set it as the active project."
728 ;; FIXME: doc nil, search, etc.
731 run_cmd debug_pre_cmd debug_post_cmd
735 ;; Set the project file as the active one.
738 ;; Initialize the project with the default values
741 ;; Do not use find-file below, since we don't want to show this
742 ;; buffer. If the file is open through speedbar, we can't use
743 ;; find-file anyway, since the speedbar frame is special and does not
744 ;; allow the selection of a file in it.
757 ;; Now overrides these values with the project file
761 ;; fields that are lists or paths require special processing
762 ;; FIXME: strip trailing spaces
788 ;; any other field in the file is just copied
813 )
815 ;; Else the file wasn't readable (probably the default project).
816 ;; We initialize it with the current environment variables.
817 ;; We need to add the startup directory in front so that
818 ;; files locally redefined are properly found. We cannot
819 ;; add ".", which varies too much depending on what the
820 ;; current buffer is.
833 )
836 ;; Delete the default project file from the list, if it is there.
837 ;; Note that in that case, this default project is the only one in
838 ;; the list
842 ;; Memorize the newly read project file
847 ;; Sets up the compilation-search-path so that Emacs is able to
848 ;; go to the source of the errors in a compilation buffer
851 ;; Set the casing exceptions file list
857 ;; Add the directories to the search path for ff-find-other-file
858 ;; Do not add the '/' or '\' at the end
861 ada-search-directories))
864 )
866 ;; No prj file ? => Setup default values
867 ;; Note that nil means that all compilation modes will first look in the
868 ;; current directory, and only then in the current file's directory. This
869 ;; current file is assumed at this point to be in the common source
870 ;; directory.
872 ))
876 "Find all references to the entity under POS.
877 Calls gnatfind to find the references.
878 If ARG is t, the contents of the old *gnatfind* buffer is preserved.
879 If LOCAL-ONLY is t, only the declarations in the current file are returned."
889 ;; if the file is more recent than the executable
894 nil nil local-only arg)
899 )
902 "Find all references to the entity under POS.
903 Calls `gnatfind' to find the references.
904 If ARG is t, the contents of the old *gnatfind* buffer is preserved."
910 "Search for references to any entity whose name is ENTITY.
911 ENTITY was first found the location given by FILE, LINE and COLUMN.
912 If LOCAL-ONLY is t, then list only the references in FILE, which
913 is much faster.
914 If APPEND is t, then append the output of the command to the existing
915 buffer `*gnatfind*', if there is one."
919 ;; Prepare the gnatfind command. Note that we must protect the quotes
920 ;; around operators, so that they are correctly handled and can be
921 ;; processed (gnatfind \"+\":...).
927 entity))
930 quote-entity
935 ))
936 old-contents)
938 ;; If a project file is defined, use it
954 ;; Hide the "Compilation" menu
964 )
965 )
969 ;; ----- Identifier Completion --------------------------------------------
971 "Try to complete the identifier around POS, using compiler cross-reference information."
975 ;; Initialize function-local variables and jump to the .ali buffer
976 ;; Note that for regexp search is case insensitive too
985 ;; Open the .ali file
989 ;; build an alist of possible completions
995 ;; kills .ali buffer
998 ;; deletes the incomplete identifier in the buffer
1002 ;; inserts the completed symbol
1004 ))
1006 ;; ----- Cross-referencing ----------------------------------------
1009 "Jump to the declaration of the entity below the cursor."
1015 "Jump to the body of the entity under the cursor."
1021 "Display the body of the entity around POS.
1022 OTHER-FRAME non-nil means display in another frame.
1023 If the entity doesn't have a body, display its declaration.
1024 As a side effect, the buffer for the declaration is also open."
1028 ;; Temporarily force the display in the same buffer, since we
1029 ;; already changed previously
1034 "Display the declaration of the identifier around POS.
1035 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1036 non-nil.
1037 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1043 ;; First try the standard algorithm by looking into the .ali file, but if
1044 ;; that file was too old or even did not exist, try to look in the whole
1045 ;; object path for a possible location.
1049 ;; File not found: print explicit error message
1057 ;; If the ALI file was up-to-date, then we probably have a predefined
1058 ;; entity, whose references are not given by GNAT
1063 ;; Else, look in every ALI file, except if the user doesn't want that
1067 )))))))
1070 "Display the declaration of the identifier around POS.
1071 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1076 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1079 command
1081 remote-shell-program
1082 machine
1083 command))))
1086 "Return the list of absolute directories found in DIR-LIST.
1087 If a directory is a relative directory, ROOT-DIR is prepended."
1091 "Prepare an environment for Ada compilation.
1092 This returns a new value to use for `process-environment',
1093 but does not actually put it into use.
1094 It modifies the source path and object path with the values found in the
1095 project file."
1107 path-separator)
1108 include)
1113 path-separator)
1114 objects)
1115 process-environment))))
1118 "Compile the application, using the command found in the project file.
1119 If ARG is not nil, ask for user confirmation."
1128 ;; If no project file was found, ask the user
1132 ;; Make a single command from the list of commands, including the
1133 ;; commands to run it on a remote machine.
1139 ;; Insert newlines so as to separate the name of the commands to run
1140 ;; and the output of the commands. This doesn't work with cmdproxy.exe,
1141 ;; which gets confused by newline characters.
1148 "Set main_unit and main project variables to current buffer, build main."
1152 main)
1166 "Recompile the current file.
1167 If ARG is not nil, ask for user confirmation of the command.
1168 PRJ-FIELD is the name of the field to use in the project file to get the
1169 command, and should be either `comp_cmd' (default) or `check_cmd'."
1182 ;; Make a single command from the list of commands, including the
1183 ;; commands to run it on a remote machine.
1186 ;; If no project file was found, ask the user
1193 "Check the current file for syntax errors.
1194 If ARG is not nil, ask for user confirmation of the command."
1199 "Run the application.
1200 if ARG is not-nil, ask for user confirmation."
1210 ;; Guess the command if it wasn't specified
1214 ;; Modify the command to run remotely
1216 ada-command-separator)))
1218 ;; Ask for the arguments to the command if required
1221 command)))
1223 ;; Run the command
1232 ;; Set these two variables to their default values, since otherwise
1233 ;; the output buffer is scrolled so that only the last output line
1234 ;; is visible at the top of the buffer.
1237 )
1240 ;; change to buffer *run* for interactive programs
1243 ))
1246 "Start the debugger on the application.
1247 If ARG is non-nil, ask the user to confirm the command.
1248 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1249 project file."
1253 cmd pre-cmd post-cmd)
1260 ;; If the command was not given in the project file, start a bare gdb
1263 " "
1267 ;; For gvd, add an extra switch so that the Emacs window is completly
1268 ;; swallowed inside the Gvd one
1271 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1272 ;; We make sure that gvd swallows the new frame, not the one the
1273 ;; user has been using until now
1274 ;; The frame is made invisible initially, so that GtkPlug gets a
1275 ;; chance to fully manage it. Then it works fine with Enlightenment
1276 ;; as well
1279 cmd " --editor-window="
1283 ;; Add a -fullname switch
1284 ;; Use the remote machine
1287 ;; Ask for confirmation if required
1293 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1294 ;; FIXME: This is evil but luckily a nop under Emacs-21.3.50 ! -stef
1306 ;; Temporarily replaces the definition of `comint-exec' so that we
1307 ;; can execute commands before running gdb.
1308 ;; FIXME: This is evil and not temporary !!! -stef
1317 command " "
1319 ))
1321 ;; Tight integration should force the tty mode
1323 ada-tight-gvd-integration
1332 ;; Restore the standard fset command (or for instance C-U M-x shell
1333 ;; wouldn't work anymore
1337 ;; Send post-commands to the debugger
1340 ;; Move to the end of the debugger buffer, so that it is automatically
1341 ;; scrolled from then on.
1344 ;; Display both the source window and the debugger window (the former
1345 ;; above the latter). No need to show the debugger window unless it
1346 ;; is going to have some relevant information.
1351 )))
1354 "Reread either the current project, or FILENAME if non-nil."
1360 ;; Reread the location of the standard runtime library
1363 )
1365 ;; ------ Private routines
1368 "Update the cross-references for FILE.
1369 This in fact recompiles FILE to create ALI-FILE-NAME.
1370 This function returns the name of the file that was recompiled to generate
1371 the cross-reference information. Note that the ali file can then be deduced
1372 by replacing the file extension with `.ali'."
1373 ;; kill old buffer
1381 ;; Always recompile the body when we can. We thus temporarily switch to a
1382 ;; buffer than contains the body of the unit
1385 process)
1390 ;; Execute the compilation. Note that we must wait for the end of the
1391 ;; process, or the ALI file would still not be available.
1392 ;; Unfortunately, the underlying `compile' command that we use is
1393 ;; asynchronous.
1401 ;; remove the buffer for the body if it wasn't there before
1404 ))
1405 body-name))
1408 "Search for FILE in DIR-LIST."
1417 found))
1420 "Find the ali file FILE, searching obj_dir for the current project.
1421 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1422 and the standard runtime location at the end."
1426 "Find the source file FILE, searching src_dir for the current project.
1427 Adds the standard runtime location at the end of the search path to conform
1428 to gnatmake's behavior."
1432 "Create the ali file name for the ada-file FILE.
1433 The file is searched for in every directory shown in the obj_dir lines of
1434 the project file."
1436 ;; This function has to handle the special case of non-standard
1437 ;; file names (i.e. not .adb or .ads)
1438 ;; The trick is the following:
1439 ;; 1- replace the extension of the current file with .ali,
1440 ;; and look for this file
1441 ;; 2- If this file is found:
1442 ;; grep the "^U" lines, and make sure we are not reading the
1443 ;; .ali file for a spec file. If we are, go to step 3.
1444 ;; 3- If the file is not found or step 2 failed:
1445 ;; find the name of the "other file", ie the body, and look
1446 ;; for its associated .ali file by subtituing the extension
1447 ;;
1448 ;; We must also handle the case of separate packages and subprograms:
1449 ;; 4- If no ali file was found, we try to modify the file name by removing
1450 ;; everything after the last '-' or '.' character, so as to get the
1451 ;; ali file for the parent unit. If we found an ali file, we check that
1452 ;; it indeed contains the definition for the separate entity by checking
1453 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1454 ;; also a separate.
1461 ali-file-name
1462 is-spec)
1464 ;; If we have a non-standard file name, and this is a spec, we first
1465 ;; look for the .ali file of the body, since this is the one that
1466 ;; contains the most complete information. If not found, we will do what
1467 ;; we can with the .ali file for the spec...
1473 file)
1489 ;; Else we take the .ali file associated with the unit
1493 ;; else we did not find the .ali file Second chance: in case
1494 ;; the files do not have standard names (such as for instance
1495 ;; file_s.ada and file_b.ada), try to go to the other file
1496 ;; and look for its ali file
1503 ;; If we still don't have an ali file, try to get the one
1504 ;; from the parent unit, in case we have a separate entity.
1514 )
1515 ali-file-name)))
1517 ;; If still not found, try to recompile the file
1519 ;; Recompile only if the user asked for this, and search the ali
1520 ;; filename again. We avoid a possible infinite recursion by
1521 ;; temporarily disabling the automatic compilation.
1531 ;; same if the .ali file is too old and we must recompile it
1533 ada-xref-create-ali)
1536 ;; Always return the correct absolute file name
1538 ))
1541 "Create the complete file name (+directory) for FILE.
1542 The original file (where the user was) is ORIGINAL-FILE.
1543 Search in project file for possible paths."
1547 ;; If the buffer for original-file, use it to get the values from the
1548 ;; project file, otherwise load the file and its project file
1554 ;; we choose the first possible completion and we
1555 ;; return the absolute file name
1560 )))
1563 "Return the file number for FILE in the associated ali file."
1573 "Return the identlist around POS and switch to the .ali buffer.
1574 The returned list represents the entity, and can be manipulated through the
1575 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1577 ;; If at end of buffer (e.g the buffer is empty), error
1581 ;; goto first character of the identifier/operator (skip backward < and >
1582 ;; since they are part of multiple character operators
1586 ;; check if it really is an identifier
1591 ;; Just in front of a string => we could have an operator declaration,
1592 ;; as in "+", "-", ..
1596 ;; if looking at an operator
1597 ;; This is only true if:
1598 ;; - the symbol is +, -, ...
1599 ;; - the symbol is made of letters, and not followed by _ or a letter
1618 ;; Build the identlist
1626 identlist
1627 ))
1630 "Complete IDENTLIST with definition file and places where it is referenced.
1631 Information is extracted from the ali file."
1634 declaration-found)
1639 ;; First attempt: we might already be on the declaration of the identifier
1640 ;; We want to look for the declaration only in a definite interval (after
1641 ;; the "^X ..." line for the current file, and before the next "^X" line
1645 nil t)
1655 ))
1657 ;; If declaration is still nil, then we were not on a declaration, and
1658 ;; have to fall back on other algorithms
1662 ;; Since we alread know the number of the file, search for a direct
1663 ;; reference to it
1667 identlist
1673 "[^etpzkd<>=^]"
1675 nil t)
1677 ;; if we did not find it, it may be because the first reference
1678 ;; is not required to have a 'unit_number|' item included.
1679 ;; Or maybe we are already on the declaration...
1682 "^[0-9]+.[0-9]+[ *]"
1686 "[^0-9]"
1688 nil t)
1690 ;; If still not found, then either the declaration is unknown
1691 ;; or the source file has been modified since the ali file was
1692 ;; created
1694 )
1695 )
1697 ;; Last check to be completly sure we have found the correct line (the
1698 ;; ali might not be up to date for instance)
1702 ;; while we have a continuation line, go up one line
1710 ;; Still no success ! The ali file must be too old, and we need to
1711 ;; use a basic algorithm based on guesses. Note that this only happens
1712 ;; if the user does not want us to automatically recompile files
1713 ;; automatically
1717 ;; No more idea to find the declaration. Give up
1722 )))
1723 )
1726 ;; Now that we have found a suitable line in the .ali file, get the
1727 ;; information available
1738 )
1742 ;; If we can find the file
1745 identlist
1749 ;; Else clean up the ali file
1755 ))
1758 ))
1759 ))
1762 "Find the matching position for IDENTLIST in the current ali buffer.
1763 This function is only called when the file was not up-to-date, so we need
1764 to make some guesses.
1765 This function is disabled for operators, and only works for identifiers."
1784 ;; have a look at the line and column numbers
1791 )
1792 ;; construct a list with the file names and the positions within
1796 )
1797 )
1798 )
1800 ;; how many possible declarations have we found ?
1803 ;; none => error
1810 ;; one => should be the right one
1814 ;; more than one => display choice list
1832 ))
1846 )
1849 ))))))
1853 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1854 If OTHER-FRAME is non-nil, and `ada-xref-other-buffer' is non-nil,
1855 opens a new window to show the declaration."
1861 file line col)
1863 ;; Note: in some cases, an entity can have multiple references to the
1864 ;; bodies (this is for instance the case for a separate subprogram, that
1865 ;; has a reference both to the stub and to the real body).
1866 ;; In that case, we simply go to each one in turn.
1868 ;; Get all the possible locations
1874 ali-line start)
1879 ;; it there was a file number in the same line
1880 ;; Make sure we correctly handle the case where the first file reference
1881 ;; on the line is the type reference.
1882 ;; 1U2 T(2|2r3) 34r23
1885 ali-line)
1891 )
1892 ;; Else get the nearest file
1897 ;; Add the specs at the end again, so that from the last body we go to
1898 ;; the specs
1901 ;; Find the new location we want to go to.
1902 ;; If we are on none of the locations listed, we simply go to the specs.
1917 locations nil)
1920 ;; Find the file in the source path
1923 ;; Kill the .ali buffer
1926 ;; Now go to the buffer
1930 identlist
1931 other-frame)
1932 ))
1935 "More general function for cross-references.
1936 This function should be used when the standard algorithm that parses the
1937 .ali file has failed, either because that file was too old or even did not
1938 exist.
1939 This function attempts to find the possible declarations for the identifier
1940 anywhere in the object path.
1941 This command requires the external `egrep' program to be available.
1943 This works well when one is using an external librarie and wants to find
1944 the declaration and documentation of the subprograms one is using."
1945 ;; FIXME: what does this function do?
1949 line column
1950 choice
1951 file)
1955 ;; Do the grep in all the directories. We do multiple shell
1956 ;; commands instead of one in case there is no .ali file in one
1957 ;; of the directory and the shell stops because of that.
1963 "grep -E -i -h "
1965 " "
1970 ;; Now parse the output
1984 ;; There could be duplicate choices, because of the structure
1985 ;; of the .ali files
1989 ;; Current buffer is still "*grep*"
1991 )
1993 ;; Now display the list of possible matches
1996 ;; No choice found => Error
2000 ;; Only one choice => Do the cross-reference
2007 identlist
2008 other-frame)
2011 )
2013 ;; Else, ask the user
2029 ))
2031 )))
2040 )
2049 identlist
2050 other-frame)
2053 ))))
2057 "Select and display FILE, at LINE and COLUMN.
2058 If we do not end on the same identifier as IDENTLIST, find the closest
2059 match. Kills the .ali buffer at the end.
2060 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2064 ;; Select and display the destination buffer
2071 )
2073 )
2075 ;; move the cursor to the correct position
2080 ;; If we are not on the identifier, the ali file was not up-to-date.
2081 ;; Try to find the nearest position where the identifier is found,
2082 ;; this is probably the right one.
2085 ))
2089 "Search for NAME nearest to the position recorded in the Xref file.
2090 Return the position of the declaration in the buffer, or nil if not found."
2097 ;; loop - look for all declarations of name in this file
2100 ;; check if it really is a complete Ada identifier
2107 ;; variable declaration ?
2112 ;; procedure, function, task or package declaration ?
2115 (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]\\>"))))
2117 ;; check if it is nearer than the ones before if any
2123 )
2129 nil)))
2132 ;; Find the parent library file of the current file
2134 "Go to the parent library file."
2152 )
2154 ;; look for the file name for the parent unit specification
2162 )
2167 ;; Tries to open the new ali file to find the spec file
2176 )
2177 )
2178 )
2181 ))
2184 "Determine the filename in which ADANAME is found.
2185 This is a GNAT specific function that uses gnatkrunch."
2190 ;; send adaname to external process `gnatkr'.
2191 ;; Add a dummy extension, since gnatkr versions have two different
2192 ;; behaviors depending on the version:
2193 ;; Up to 3.15: "AA.BB.CC" => aa-bb-cc
2194 ;; After: "AA.BB.CC" => aa-bb.cc
2197 ;; fetch output of that process
2204 ;; Remove the extra extension we added above
2208 adaname
2209 )
2212 "Create an Ada package body in the current buffer.
2213 This function uses the `gnatstub' program to create the body.
2214 If INTERACTIVE is nil, kill the current buffer.
2215 This function typically is to be hooked into `ff-file-created-hook'."
2221 ;; If the current buffer is the body (as is the case when calling this
2222 ;; function from ff-file-created-hook), then kill this temporary buffer
2228 ;; Make sure the current buffer is the spec (this might not be the case
2229 ;; if for instance the user was asked for a project file)
2234 ;; Call the external process gnatstub
2247 )
2248 ;; call gnatstub to create the body file
2261 ;; Else clean up the output
2268 ;; display the error buffer
2270 )
2271 )))
2274 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2275 For instance, it creates the gnat-specific menus, sets some hooks for
2276 `find-file'."
2281 ;; Completion for file names in the mini buffer should ignore .ali files
2285 )
2287 ;; ----- Add to ada-mode-hook ---------------------------------------------
2289 ;; This must be done before initializing the Ada menu.
2292 ;; Define a new error type
2294 'error-conditions
2297 'error-message
2300 ;; Initializes the cross references to the runtime library
2303 ;; Add these standard directories to the search path
2306 ada-search-directories))
2310 ;;; arch-tag: 415a39fe-577b-4676-b3b1-6ff6db7ca24e
2311 ;;; ada-xref.el ends here