| blob | 00be89553a7e2f91caf8d6eaa69d9cd522c707d7 |
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 3, 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 `gnatls' 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 ))
326 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
327 Assumes project exists.
328 As a special case, ${current} is replaced with the name of the current
329 file, minus extension but with directory, and ${full_current} is
330 replaced by the name including the extension."
344 ;; Check if there is an environment variable with the same name
358 t t cmd-string)))))
359 ))
360 cmd-string)
363 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
366 plist)
371 ;; Try hard to find a project file, even if the current
372 ;; buffer is not an Ada file or not associated with a file
376 ada-prj-default-project-file)
380 "and no default project "
387 ada-case-exception-file
389 'comp_opt ada-prj-default-comp-opt
390 'bind_opt ada-prj-default-bind-opt
391 'link_opt ada-prj-default-link-opt
392 'gnatmake_opt ada-prj-default-gnatmake-opt
393 'gnatfind_opt ada-prj-gnatfind-switches
412 )
416 "Extract the value of FIELD from the current project file.
417 Project variables are substituted.
419 Note that for src_dir and obj_dir, you should rather use
420 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field'
421 which will in addition return the default paths."
424 value)
428 ;; Substitute the ${...} constructs in all the strings, including
429 ;; inside lists
434 nil)
438 value)
439 )
440 ))
443 "Return the full value for src_dir, including the default directories.
444 All the directories are returned as absolute directories."
448 ;; Add ${build_dir} in front of the path
452 build-dir)
454 ;; Add the standard runtime at the end
455 ada-xref-runtime-library-specs-path)))
458 "Return the full value for obj_dir, including the default directories.
459 All the directories are returned as absolute directories."
463 ;; Add ${build_dir} in front of the path
467 build-dir)
469 ;; Add the standard runtime at the end
470 ada-xref-runtime-library-ali-path)))
473 "Set FIELD to VALUE in current project. Assumes project exists."
474 ;; same algorithm to find project-plist as ada-xref-current-project
482 "Update the menu Ada->Project, with the list of available project files."
483 ;; Create the standard items.
489 "---"
490 ;; Add the new items
495 "Change the active project file."
502 ada-prj-file-extension)
506 command
508 :toggle
511 ))))
513 ;; Parses all the known project files, and insert at
514 ;; least the default one (in case
515 ;; ada-xref-project-files is nil)
521 ;;-------------------------------------------------------------
522 ;;-- Searching a file anywhere on the source path.
523 ;;--
524 ;;-- The following functions provide support for finding a file anywhere
525 ;;-- on the source path, without providing an explicit directory.
526 ;;-- They also provide file name completion in the minibuffer.
527 ;;--
528 ;;-- Public subprograms: ada-find-file
529 ;;--
530 ;;-------------------------------------------------------------
533 "Completion function when reading a file from the minibuffer.
534 Completion is attempted in all the directories in the source path, as
535 defined in the project file."
536 ;; FIXME: doc arguments
538 ;; This function is not itself interactive, but it is called as part
539 ;; of the prompt of interactive functions, so we require a project
540 ;; file.
552 list)
556 predicate)))))
558 ;;;###autoload
560 "Open FILENAME, from anywhere in the source path.
561 Completion is available."
570 ;; ----- Utilities -------------------------------------------------
573 "If the current project does not exist, load or create a default one.
574 Should only be called from interactive functions."
579 "Return the current project file name; never nil unless NO-USER-QUESTION.
580 If NO-USER-QUESTION, don't prompt user for file. Call
581 `ada-require-project-file' first if a project must exist."
583 ada-prj-default-project-file
587 "Return the current project; nil if none.
588 If NO-USER-QUESTION, don't prompt user for file. Call
589 `ada-require-project-file' first if a project must exist."
594 "Display current project file name in message buffer."
599 "Display current main unit name in message buffer."
604 "Push (FILENAME, POSITION) on the position ring for cross-references."
610 "Go to the previous cross-reference we were on."
619 "Convert from NAME to a name that can be used by the compilation commands.
620 This is overriden on VMS to convert from VMS filenames to Unix filenames."
621 name)
622 ;; FIXME: use convert-standard-filename instead
625 "Set the file whose name is NAME as the default project file.
626 If KEEP-EXISTING is true and a project file has already been loaded, nothing
627 is done. This is meant to be used from `ada-mode-hook', for instance, to force
628 a project file unless the user has already loaded one."
637 ;; ------ Handling the project file -----------------------------
640 "Find the project file associated with FILE (or the current buffer if nil).
641 If the buffer is not in Ada mode, or not associated with a file,
642 return `ada-prj-default-project-file'. Otherwise, search for a file with
643 the same base name as the Ada file, but extension given by
644 `ada-prj-file-extension' (default .adp). If not found, search for *.adp
645 in the current directory; if several are found, and NO-USER-QUESTION
646 is non-nil, prompt the user to select one. If none are found, return
647 'default.adp'."
654 ;; Not in an Ada buffer, or current buffer not associated
655 ;; with a file (for instance an emerge buffer)
662 ;; other cases: use a more complex algorithm
667 ada-prj-file-extension))
671 dir t
679 ;; filename.adp
683 ;; Exactly one project file was found in the current directory
687 ;; multiple project files in current directory, ask the user
697 counter
713 ;; No project file in the current directory; ask user
718 nil ada-last-prj-file))
721 )))
724 ))
728 "Read PRJ-FILE, set it as the active project."
729 ;; FIXME: doc nil, search, etc.
732 run_cmd debug_pre_cmd debug_post_cmd
736 ;; Set the project file as the active one.
739 ;; Initialize the project with the default values
742 ;; Do not use find-file below, since we don't want to show this
743 ;; buffer. If the file is open through speedbar, we can't use
744 ;; find-file anyway, since the speedbar frame is special and does not
745 ;; allow the selection of a file in it.
758 ;; Now overrides these values with the project file
762 ;; fields that are lists or paths require special processing
763 ;; FIXME: strip trailing spaces
789 ;; any other field in the file is just copied
814 )
816 ;; Else the file wasn't readable (probably the default project).
817 ;; We initialize it with the current environment variables.
818 ;; We need to add the startup directory in front so that
819 ;; files locally redefined are properly found. We cannot
820 ;; add ".", which varies too much depending on what the
821 ;; current buffer is.
834 )
837 ;; Delete the default project file from the list, if it is there.
838 ;; Note that in that case, this default project is the only one in
839 ;; the list
843 ;; Memorize the newly read project file
848 ;; Sets up the compilation-search-path so that Emacs is able to
849 ;; go to the source of the errors in a compilation buffer
852 ;; Set the casing exceptions file list
858 ;; Add the directories to the search path for ff-find-other-file
859 ;; Do not add the '/' or '\' at the end
862 ada-search-directories))
865 )
867 ;; No prj file ? => Setup default values
868 ;; Note that nil means that all compilation modes will first look in the
869 ;; current directory, and only then in the current file's directory. This
870 ;; current file is assumed at this point to be in the common source
871 ;; directory.
873 ))
877 "Find all references to the entity under POS.
878 Calls gnatfind to find the references.
879 If ARG is t, the contents of the old *gnatfind* buffer is preserved.
880 If LOCAL-ONLY is t, only the declarations in the current file are returned."
890 ;; if the file is more recent than the executable
895 nil nil local-only arg)
900 )
903 "Find all references to the entity under POS.
904 Calls `gnatfind' to find the references.
905 If ARG is t, the contents of the old *gnatfind* buffer is preserved."
913 "Search for references to any entity whose name is ENTITY.
914 ENTITY was first found the location given by FILE, LINE and COLUMN.
915 If LOCAL-ONLY is t, then list only the references in FILE, which
916 is much faster.
917 If APPEND is t, then append the output of the command to the existing
918 buffer `*gnatfind*', if there is one."
922 ;; Prepare the gnatfind command. Note that we must protect the quotes
923 ;; around operators, so that they are correctly handled and can be
924 ;; processed (gnatfind \"+\":...).
930 entity))
933 quote-entity
938 ))
939 old-contents)
941 ;; If a project file is defined, use it
957 ;; Hide the "Compilation" menu
969 )
970 )
974 ;; ----- Identifier Completion --------------------------------------------
976 "Try to complete the identifier around POS, using compiler cross-reference information."
980 ;; Initialize function-local variables and jump to the .ali buffer
981 ;; Note that for regexp search is case insensitive too
990 ;; Open the .ali file
994 ;; build an alist of possible completions
1000 ;; kills .ali buffer
1003 ;; deletes the incomplete identifier in the buffer
1007 ;; inserts the completed symbol
1009 ))
1011 ;; ----- Cross-referencing ----------------------------------------
1014 "Jump to the declaration of the entity below the cursor."
1020 "Jump to the body of the entity under the cursor."
1026 "Display the body of the entity around POS.
1027 OTHER-FRAME non-nil means display in another frame.
1028 If the entity doesn't have a body, display its declaration.
1029 As a side effect, the buffer for the declaration is also open."
1033 ;; Temporarily force the display in the same buffer, since we
1034 ;; already changed previously
1039 "Display the declaration of the identifier around POS.
1040 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1041 non-nil.
1042 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1048 ;; First try the standard algorithm by looking into the .ali file, but if
1049 ;; that file was too old or even did not exist, try to look in the whole
1050 ;; object path for a possible location.
1054 ;; File not found: print explicit error message
1062 ;; If the ALI file was up-to-date, then we probably have a predefined
1063 ;; entity, whose references are not given by GNAT
1068 ;; Else, look in every ALI file, except if the user doesn't want that
1072 )))))))
1075 "Display the declaration of the identifier around POS.
1076 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1081 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1084 command
1086 remote-shell-program
1087 machine
1088 command))))
1091 "Return the list of absolute directories found in DIR-LIST.
1092 If a directory is a relative directory, ROOT-DIR is prepended."
1096 "Prepare an environment for Ada compilation.
1097 This returns a new value to use for `process-environment',
1098 but does not actually put it into use.
1099 It modifies the source path and object path with the values found in the
1100 project file."
1112 path-separator)
1113 include)
1118 path-separator)
1119 objects)
1120 process-environment))))
1123 "Compile the application, using the command found in the project file.
1124 If ARG is not nil, ask for user confirmation."
1133 ;; If no project file was found, ask the user
1137 ;; Make a single command from the list of commands, including the
1138 ;; commands to run it on a remote machine.
1144 ;; Insert newlines so as to separate the name of the commands to run
1145 ;; and the output of the commands. This doesn't work with cmdproxy.exe,
1146 ;; which gets confused by newline characters.
1153 "Set main_unit and main project variables to current buffer, build main."
1157 main)
1171 "Recompile the current file.
1172 If ARG is not nil, ask for user confirmation of the command.
1173 PRJ-FIELD is the name of the field to use in the project file to get the
1174 command, and should be either `comp_cmd' (default) or `check_cmd'."
1187 ;; Make a single command from the list of commands, including the
1188 ;; commands to run it on a remote machine.
1191 ;; If no project file was found, ask the user
1198 "Check the current file for syntax errors.
1199 If ARG is not nil, ask for user confirmation of the command."
1204 "Run the application.
1205 if ARG is not-nil, ask for user confirmation."
1215 ;; Guess the command if it wasn't specified
1219 ;; Modify the command to run remotely
1221 ada-command-separator)))
1223 ;; Ask for the arguments to the command if required
1226 command)))
1228 ;; Run the command
1237 ;; Set these two variables to their default values, since otherwise
1238 ;; the output buffer is scrolled so that only the last output line
1239 ;; is visible at the top of the buffer.
1242 )
1245 ;; change to buffer *run* for interactive programs
1248 ))
1251 "Start the debugger on the application.
1252 If ARG is non-nil, ask the user to confirm the command.
1253 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1254 project file."
1258 cmd pre-cmd post-cmd)
1265 ;; If the command was not given in the project file, start a bare gdb
1268 " "
1272 ;; For gvd, add an extra switch so that the Emacs window is completly
1273 ;; swallowed inside the Gvd one
1276 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1277 ;; We make sure that gvd swallows the new frame, not the one the
1278 ;; user has been using until now
1279 ;; The frame is made invisible initially, so that GtkPlug gets a
1280 ;; chance to fully manage it. Then it works fine with Enlightenment
1281 ;; as well
1284 cmd " --editor-window="
1288 ;; Add a -fullname switch
1289 ;; Use the remote machine
1292 ;; Ask for confirmation if required
1298 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1299 ;; FIXME: This is evil but luckily a nop under Emacs-21.3.50 ! -stef
1311 ;; Temporarily replaces the definition of `comint-exec' so that we
1312 ;; can execute commands before running gdb.
1313 ;; FIXME: This is evil and not temporary !!! -stef
1322 command " "
1324 ))
1326 ;; Tight integration should force the tty mode
1328 ada-tight-gvd-integration
1337 ;; Restore the standard fset command (or for instance C-U M-x shell
1338 ;; wouldn't work anymore
1342 ;; Send post-commands to the debugger
1345 ;; Move to the end of the debugger buffer, so that it is automatically
1346 ;; scrolled from then on.
1349 ;; Display both the source window and the debugger window (the former
1350 ;; above the latter). No need to show the debugger window unless it
1351 ;; is going to have some relevant information.
1356 )))
1359 "Reread either the current project, or FILENAME if non-nil."
1365 ;; Reread the location of the standard runtime library
1368 )
1370 ;; ------ Private routines
1373 "Update the cross-references for FILE.
1374 This in fact recompiles FILE to create ALI-FILE-NAME.
1375 This function returns the name of the file that was recompiled to generate
1376 the cross-reference information. Note that the ali file can then be deduced
1377 by replacing the file extension with `.ali'."
1378 ;; kill old buffer
1386 ;; Always recompile the body when we can. We thus temporarily switch to a
1387 ;; buffer than contains the body of the unit
1390 process)
1395 ;; Execute the compilation. Note that we must wait for the end of the
1396 ;; process, or the ALI file would still not be available.
1397 ;; Unfortunately, the underlying `compile' command that we use is
1398 ;; asynchronous.
1406 ;; remove the buffer for the body if it wasn't there before
1409 ))
1410 body-name))
1413 "Search for FILE in DIR-LIST."
1422 found))
1425 "Find the ali file FILE, searching obj_dir for the current project.
1426 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1427 and the standard runtime location at the end."
1431 "Find the source file FILE, searching src_dir for the current project.
1432 Adds the standard runtime location at the end of the search path to conform
1433 to gnatmake's behavior."
1437 "Create the ali file name for the ada-file FILE.
1438 The file is searched for in every directory shown in the obj_dir lines of
1439 the project file."
1441 ;; This function has to handle the special case of non-standard
1442 ;; file names (i.e. not .adb or .ads)
1443 ;; The trick is the following:
1444 ;; 1- replace the extension of the current file with .ali,
1445 ;; and look for this file
1446 ;; 2- If this file is found:
1447 ;; grep the "^U" lines, and make sure we are not reading the
1448 ;; .ali file for a spec file. If we are, go to step 3.
1449 ;; 3- If the file is not found or step 2 failed:
1450 ;; find the name of the "other file", ie the body, and look
1451 ;; for its associated .ali file by subtituing the extension
1452 ;;
1453 ;; We must also handle the case of separate packages and subprograms:
1454 ;; 4- If no ali file was found, we try to modify the file name by removing
1455 ;; everything after the last '-' or '.' character, so as to get the
1456 ;; ali file for the parent unit. If we found an ali file, we check that
1457 ;; it indeed contains the definition for the separate entity by checking
1458 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1459 ;; also a separate.
1466 ali-file-name
1467 is-spec)
1469 ;; If we have a non-standard file name, and this is a spec, we first
1470 ;; look for the .ali file of the body, since this is the one that
1471 ;; contains the most complete information. If not found, we will do what
1472 ;; we can with the .ali file for the spec...
1478 file)
1494 ;; Else we take the .ali file associated with the unit
1498 ;; else we did not find the .ali file Second chance: in case
1499 ;; the files do not have standard names (such as for instance
1500 ;; file_s.ada and file_b.ada), try to go to the other file
1501 ;; and look for its ali file
1508 ;; If we still don't have an ali file, try to get the one
1509 ;; from the parent unit, in case we have a separate entity.
1519 )
1520 ali-file-name)))
1522 ;; If still not found, try to recompile the file
1524 ;; Recompile only if the user asked for this, and search the ali
1525 ;; filename again. We avoid a possible infinite recursion by
1526 ;; temporarily disabling the automatic compilation.
1536 ;; same if the .ali file is too old and we must recompile it
1538 ada-xref-create-ali)
1541 ;; Always return the correct absolute file name
1543 ))
1546 "Create the complete file name (+directory) for FILE.
1547 The original file (where the user was) is ORIGINAL-FILE.
1548 Search in project file for possible paths."
1552 ;; If the buffer for original-file, use it to get the values from the
1553 ;; project file, otherwise load the file and its project file
1559 ;; we choose the first possible completion and we
1560 ;; return the absolute file name
1565 )))
1568 "Return the file number for FILE in the associated ali file."
1578 "Return the identlist around POS and switch to the .ali buffer.
1579 The returned list represents the entity, and can be manipulated through the
1580 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1582 ;; If at end of buffer (e.g the buffer is empty), error
1586 ;; goto first character of the identifier/operator (skip backward < and >
1587 ;; since they are part of multiple character operators
1591 ;; check if it really is an identifier
1596 ;; Just in front of a string => we could have an operator declaration,
1597 ;; as in "+", "-", ..
1601 ;; if looking at an operator
1602 ;; This is only true if:
1603 ;; - the symbol is +, -, ...
1604 ;; - the symbol is made of letters, and not followed by _ or a letter
1623 ;; Build the identlist
1631 identlist
1632 ))
1635 "Complete IDENTLIST with definition file and places where it is referenced.
1636 Information is extracted from the ali file."
1639 declaration-found)
1644 ;; First attempt: we might already be on the declaration of the identifier
1645 ;; We want to look for the declaration only in a definite interval (after
1646 ;; the "^X ..." line for the current file, and before the next "^X" line
1650 nil t)
1660 ))
1662 ;; If declaration is still nil, then we were not on a declaration, and
1663 ;; have to fall back on other algorithms
1667 ;; Since we alread know the number of the file, search for a direct
1668 ;; reference to it
1672 identlist
1678 "[^etpzkd<>=^]"
1680 nil t)
1682 ;; if we did not find it, it may be because the first reference
1683 ;; is not required to have a 'unit_number|' item included.
1684 ;; Or maybe we are already on the declaration...
1687 "^[0-9]+.[0-9]+[ *]"
1691 "[^0-9]"
1693 nil t)
1695 ;; If still not found, then either the declaration is unknown
1696 ;; or the source file has been modified since the ali file was
1697 ;; created
1699 )
1700 )
1702 ;; Last check to be completly sure we have found the correct line (the
1703 ;; ali might not be up to date for instance)
1707 ;; while we have a continuation line, go up one line
1715 ;; Still no success ! The ali file must be too old, and we need to
1716 ;; use a basic algorithm based on guesses. Note that this only happens
1717 ;; if the user does not want us to automatically recompile files
1718 ;; automatically
1722 ;; No more idea to find the declaration. Give up
1727 )))
1728 )
1731 ;; Now that we have found a suitable line in the .ali file, get the
1732 ;; information available
1743 )
1747 ;; If we can find the file
1750 identlist
1754 ;; Else clean up the ali file
1760 ))
1763 ))
1764 ))
1767 "Find the matching position for IDENTLIST in the current ali buffer.
1768 This function is only called when the file was not up-to-date, so we need
1769 to make some guesses.
1770 This function is disabled for operators, and only works for identifiers."
1789 ;; have a look at the line and column numbers
1796 )
1797 ;; construct a list with the file names and the positions within
1801 )
1802 )
1803 )
1805 ;; how many possible declarations have we found ?
1808 ;; none => error
1813 ;; one => should be the right one
1817 ;; more than one => display choice list
1835 ))
1849 )
1852 ))))))
1856 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1857 If OTHER-FRAME is non-nil, and `ada-xref-other-buffer' is non-nil,
1858 opens a new window to show the declaration."
1864 file line col)
1866 ;; Note: in some cases, an entity can have multiple references to the
1867 ;; bodies (this is for instance the case for a separate subprogram, that
1868 ;; has a reference both to the stub and to the real body).
1869 ;; In that case, we simply go to each one in turn.
1871 ;; Get all the possible locations
1877 ali-line start)
1882 ;; it there was a file number in the same line
1883 ;; Make sure we correctly handle the case where the first file reference
1884 ;; on the line is the type reference.
1885 ;; 1U2 T(2|2r3) 34r23
1888 ali-line)
1894 )
1895 ;; Else get the nearest file
1900 ;; Add the specs at the end again, so that from the last body we go to
1901 ;; the specs
1904 ;; Find the new location we want to go to.
1905 ;; If we are on none of the locations listed, we simply go to the specs.
1920 locations nil)
1923 ;; Find the file in the source path
1926 ;; Kill the .ali buffer
1929 ;; Now go to the buffer
1933 identlist
1934 other-frame)
1935 ))
1938 "More general function for cross-references.
1939 This function should be used when the standard algorithm that parses the
1940 .ali file has failed, either because that file was too old or even did not
1941 exist.
1942 This function attempts to find the possible declarations for the identifier
1943 anywhere in the object path.
1944 This command requires the external `egrep' program to be available.
1946 This works well when one is using an external library and wants to find
1947 the declaration and documentation of the subprograms one is using."
1948 ;; FIXME: what does this function do?
1952 line column
1953 choice
1954 file)
1958 ;; Do the grep in all the directories. We do multiple shell
1959 ;; commands instead of one in case there is no .ali file in one
1960 ;; of the directory and the shell stops because of that.
1966 "grep -E -i -h "
1968 " "
1973 ;; Now parse the output
1987 ;; There could be duplicate choices, because of the structure
1988 ;; of the .ali files
1992 ;; Current buffer is still "*grep*"
1994 )
1996 ;; Now display the list of possible matches
1999 ;; No choice found => Error
2003 ;; Only one choice => Do the cross-reference
2010 identlist
2011 other-frame)
2014 )
2016 ;; Else, ask the user
2032 ))
2034 )))
2043 )
2052 identlist
2053 other-frame)
2056 ))))
2060 "Select and display FILE, at LINE and COLUMN.
2061 If we do not end on the same identifier as IDENTLIST, find the closest
2062 match. Kills the .ali buffer at the end.
2063 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2067 ;; Select and display the destination buffer
2074 )
2076 )
2078 ;; move the cursor to the correct position
2083 ;; If we are not on the identifier, the ali file was not up-to-date.
2084 ;; Try to find the nearest position where the identifier is found,
2085 ;; this is probably the right one.
2088 ))
2092 "Search for NAME nearest to the position recorded in the Xref file.
2093 Return the position of the declaration in the buffer, or nil if not found."
2100 ;; loop - look for all declarations of name in this file
2103 ;; check if it really is a complete Ada identifier
2110 ;; variable declaration ?
2115 ;; procedure, function, task or package declaration ?
2118 (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]\\>"))))
2120 ;; check if it is nearer than the ones before if any
2126 )
2132 nil)))
2135 ;; Find the parent library file of the current file
2137 "Go to the parent library file."
2155 )
2157 ;; look for the file name for the parent unit specification
2165 )
2170 ;; Tries to open the new ali file to find the spec file
2179 )
2180 )
2181 )
2184 ))
2187 "Determine the filename in which ADANAME is found.
2188 This is a GNAT specific function that uses gnatkrunch."
2193 ;; send adaname to external process `gnatkr'.
2194 ;; Add a dummy extension, since gnatkr versions have two different
2195 ;; behaviors depending on the version:
2196 ;; Up to 3.15: "AA.BB.CC" => aa-bb-cc
2197 ;; After: "AA.BB.CC" => aa-bb.cc
2200 ;; fetch output of that process
2207 ;; Remove the extra extension we added above
2211 adaname
2212 )
2215 "Create an Ada package body in the current buffer.
2216 This function uses the `gnatstub' program to create the body.
2217 If INTERACTIVE is nil, kill the current buffer.
2218 This function typically is to be hooked into `ff-file-created-hook'."
2224 ;; If the current buffer is the body (as is the case when calling this
2225 ;; function from ff-file-created-hook), then kill this temporary buffer
2231 ;; Make sure the current buffer is the spec (this might not be the case
2232 ;; if for instance the user was asked for a project file)
2237 ;; Call the external process gnatstub
2250 )
2251 ;; call gnatstub to create the body file
2264 ;; Else clean up the output
2271 ;; display the error buffer
2273 )
2274 )))
2277 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2278 For instance, it creates the gnat-specific menus, sets some hooks for
2279 `find-file'."
2284 ;; Completion for file names in the mini buffer should ignore .ali files
2288 )
2290 ;; ----- Add to ada-mode-hook ---------------------------------------------
2292 ;; This must be done before initializing the Ada menu.
2295 ;; Define a new error type
2297 'error-conditions
2300 'error-message
2303 ;; Initializes the cross references to the runtime library
2306 ;; Add these standard directories to the search path
2309 ada-search-directories))
2313 ;;; arch-tag: 415a39fe-577b-4676-b3b1-6ff6db7ca24e
2314 ;;; ada-xref.el ends here