| blob | b99ccf69593c1594876de3a6a6cca3b7b3aaf343 |
1 ;;; ada-xref.el --- for lookup and completion in Ada mode
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 2001, 2002, 2003
4 ;; Free Software Foundation, Inc.
6 ;; Author: Markus Heritsch <Markus.Heritsch@studbox.uni-stuttgart.de>
7 ;; Rolf Ebert <ebert@inf.enst.fr>
8 ;; Emmanuel Briot <briot@gnat.com>
9 ;; Maintainer: Emmanuel Briot <briot@gnat.com>
10 ;; Ada Core Technologies's version: Revision: 1.181
11 ;; Keywords: languages ada xref
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
30 ;;; Commentary:
31 ;;; This Package provides a set of functions to use the output of the
32 ;;; cross reference capabilities of the GNAT Ada compiler
33 ;;; for lookup and completion in Ada mode.
34 ;;;
35 ;;; If a file *.`adp' exists in the ada-file directory, then it is
36 ;;; read for configuration informations. It is read only the first
37 ;;; time a cross-reference is asked for, and is not read later.
39 ;;; You need Emacs >= 20.2 to run this package
41 ;;; Code:
43 ;; ----- Requirements -----------------------------------------------------
50 ;; ------ Use variables
52 "*If nil, always display the cross-references in the same buffer.
53 Otherwise create either a new buffer or a new frame."
57 "*If non-nil, run gcc whenever the cross-references are not up-to-date.
58 If nil, the cross-reference mode will never run gcc."
62 "*If non-nil, always ask for user confirmation before compiling or running
63 the application."
67 "*Maximum number of characters for filenames created by gnatkr.
68 Set to 0, if you don't use crunched filenames. This should be a string."
72 "*Arguments to pass to gnatfind when the location of the runtime is searched.
73 Typical use is to pass --RTS=soft-floats on some systems that support it.
75 You can also add -I- if you do not want the current directory to be included.
76 Otherwise, going from specs to bodies and back will first look for files in the
77 current directory. This only has an impact if you are not using project files,
78 but only ADA_INCLUDE_PATH."
82 "Default compilation options."
86 "Default binder options."
90 "Default linker options."
94 "Default options for gnatmake."
98 "Default switches to use for gnatfind.
99 You should modify this variable, for instance to add -a, if you are working
100 in an environment where most ALI files are write-protected.
101 The command gnatfind is used every time you choose the menu
108 "*Default command to be used to compile a single file.
109 Emacs will add the filename at the end of this command. This is the same
110 syntax as in the project file."
114 "*Default name of the debugger. We recommend either `gdb',
115 `gdb --emacs_gdbtk' or `ddd --tty -fullname'."
121 "*Default command to be used to compile the application.
122 This is the same syntax as in the project file."
126 "*Name of the project file to use for every Ada file.
127 Emacs will not try to use the standard algorithm to find the project file if
128 this string is not empty."
132 "*List of the options to pass to gnatsub to generate the body of a package.
133 This has the same syntax as in the project file (with variable substitution)."
137 "*If nil, use default values when no project file was found.
138 Otherwise, ask the user for the name of the project file to use."
145 "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging.
149 "*If non-nil, use egrep to find the possible declarations for an entity.
150 This alternate method is used when the exact location was not found in the
151 information provided by GNAT. However, it might be expensive if you have a lot
152 of sources, since it will search in all the files in your project."
156 "Hook that is run when loading a project file.
157 Each function in this hook takes one argument FILENAME, that is the name of
158 the project file to load.
159 This hook should be used to support new formats for the project files.
161 If the function can load the file with the given filename, it should create a
162 buffer that contains a conversion of the file to the standard format of the
164 lines). It should return nil if it doesn't know how to convert that project
168 ;; ------- Nothing to be modified by the user below this
179 "Directories where the specs for the standard library is found.
183 "Directories where the ali for the standard library is found.
187 "List of positions selected by the cross-references functions.
192 "cd /d"
194 "Command to use to change to a specific directory. On windows systems
195 using cmdproxy.exe as the shell, we need to use /d or the drive is never
199 "Separator to use when sending multiple commands to `compile' or
200 `start-process'.
201 cmdproxy.exe doesn't recognize multiple-line commands, so we have to use
212 "Associative list of project files.
213 It has the following format:
214 \((project_name . value) (project_name . value) ...)
218 ;; ----- Identlist manipulation -------------------------------------------
219 ;; An identlist is a vector that is used internally to reference an identifier
220 ;; To facilitate its use, we provide the following macros
242 "Reads the ali file into a new buffer, and returns this buffer's name"
246 ;; -----------------------------------------------------------------------
253 "Initializes the variables for the runtime library location.
254 CROSS-PREFIX is the prefix to use for the gnatls command"
257 ada-xref-runtime-library-ali-path '())
261 ;; Catch any error in the following form (i.e gnatls was not found)
263 ;; Even if we get an error, delete the *gnatls* buffer
270 ;; Source path
284 ;; Object path
297 )
304 ))
308 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
309 The project file must have been loaded first.
310 As a special case, ${current} is replaced with the name of the currently
311 edited file, minus extension but with directory, and ${full_current} is
312 replaced by the name including the extension."
326 ;; Check if there is an environment variable with the same name
340 t t cmd-string)))))
341 ))
342 cmd-string)
345 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
348 plist)
353 ;; Try hard to find a default value for filename, so that the user
354 ;; can edit his project file even if the current buffer is not an
355 ;; Ada file or not even associated with a file
359 ada-prj-default-project-file)
363 "and no default project "
370 ada-case-exception-file
372 'comp_opt ada-prj-default-comp-opt
373 'bind_opt ada-prj-default-bind-opt
374 'link_opt ada-prj-default-link-opt
375 'gnatmake_opt ada-prj-default-gnatmake-opt
376 'gnatfind_opt ada-prj-gnatfind-switches
388 ada-prj-default-comp-cmd)
390 ada-check-switch))
392 ada-prj-default-make-cmd)
402 )
406 "Extract the value of FIELD from the current project file.
407 The project file must have been loaded first.
408 A default value is returned if the file was not found.
410 Note that for src_dir and obj_dir, you should rather use
411 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field' which will in
412 addition return the default paths."
415 file value)
417 ;; Get the project file (either the current one, or a default one)
421 ;; If the file was not found, use the default values
423 ;; Get the value from the file
426 ;; Create a default nil file that contains the default values
431 )
433 ;; Substitute the ${...} constructs in all the strings, including
434 ;; inside lists
439 nil)
443 value)
444 )
445 ))
449 "Return the full value for src_dir, including the default directories.
450 All the directories are returned as absolute directories."
454 ;; Add ${build_dir} in front of the path
458 build-dir)
460 ;; Add the standard runtime at the end
461 ada-xref-runtime-library-specs-path)))
464 "Return the full value for obj_dir, including the default directories.
465 All the directories are returned as absolute directories."
469 ;; Add ${build_dir} in front of the path
473 build-dir)
475 ;; Add the standard runtime at the end
476 ada-xref-runtime-library-ali-path)))
479 "Update the menu Ada->Project, with the list of available project files."
480 ;; Create the standard items.
486 "---"
487 ;; Add the new items
492 "Change the active project file."
499 ada-project-file-extension)
503 command
505 :toggle
508 ))))
510 ;; Parses all the known project files, and insert at
511 ;; least the default one (in case
512 ;; ada-xref-project-files is nil)
518 ;;-------------------------------------------------------------
519 ;;-- Searching a file anywhere on the source path.
520 ;;--
521 ;;-- The following functions provide support for finding a file anywhere
522 ;;-- on the source path, without providing an explicit directory.
523 ;;-- They also provide file name completion in the minibuffer.
524 ;;--
525 ;;-- Public subprograms: ada-find-file
526 ;;--
527 ;;-------------------------------------------------------------
530 "Completion function when reading a file from the minibuffer.
531 Completion is attempted in all the directories in the source path, as
532 defined in the project file."
543 list)
547 predicate)))))
549 ;;;###autoload
551 "Open a file anywhere in the source path.
552 Completion is available."
561 ;; ----- Utilities -------------------------------------------------
564 "If no project file is currently active, load a default one."
571 "Push (FILENAME, POSITION) on the position ring for cross-references."
577 "Go to the previous cross-reference we were on."
586 "Converts from NAME to a name that can be used by the compilation commands.
587 This is overriden on VMS to convert from VMS filenames to Unix filenames."
588 name)
591 "Set the file whose name is NAME as the default project file.
592 If KEEP-EXISTING is true and a project file has already been loaded, nothing
593 is done. This is meant to be used from ada-mode-hook, for instance to force
594 a project file unless the user has already loaded one."
603 ;; ------ Handling the project file -----------------------------
606 "Find the prj file associated with FILE (or the current buffer if nil).
607 If NO-USER-QUESTION is non-nil, use a default file if not project file was
608 found, and do not ask the user.
609 If the buffer is not an Ada buffer, associate it with the default project
610 file. If none is set, return nil."
614 ;; Use the active project file if there is one.
615 ;; This is also valid if we don't currently have an Ada buffer, or if
616 ;; the current buffer is not a real file (for instance an emerge buffer)
626 ;; other cases: use a more complex algorithm
631 ada-project-file-extension))
634 ;; on Emacs 20.2, directory-files does not work if
635 ;; parse-sexp-lookup-properties is set
638 dir t
645 ;; Else if there is a project file with the same name as the Ada
646 ;; file, but not the same extension.
650 ;; Else if only one project file was found in the current directory
654 ;; Else if there are multiple files, ask the user
665 counter
680 ;; Else if no project file was found in the directory, ask a name
681 ;; to the user, using as a default value the last one entered by
682 ;; the user
688 nil ada-last-prj-file))
691 )))
694 ))
698 "Reads and parses the PRJ-FILE file if it was found.
699 The current buffer should be the ada-file buffer."
702 run_cmd debug_pre_cmd debug_post_cmd
706 ;; Set the project file as the active one.
709 ;; Initialize the project with the default values
712 ;; Do not use find-file below, since we don't want to show this
713 ;; buffer. If the file is open through speedbar, we can't use
714 ;; find-file anyway, since the speedbar frame is special and does not
715 ;; allow the selection of a file in it.
728 ;; Now overrides these values with the project file
780 ;; Kill the project buffer
783 )
785 ;; Else the file wasn't readable (probably the default project).
786 ;; We initialize it with the current environment variables.
787 ;; We need to add the startup directory in front so that
788 ;; files locally redefined are properly found. We cannot
789 ;; add ".", which varies too much depending on what the
790 ;; current buffer is.
803 )
806 ;; Delete the default project file from the list, if it is there.
807 ;; Note that in that case, this default project is the only one in
808 ;; the list
812 ;; Memorize the newly read project file
817 ;; Sets up the compilation-search-path so that Emacs is able to
818 ;; go to the source of the errors in a compilation buffer
821 ;; Set the casing exceptions file list
827 ;; Add the directories to the search path for ff-find-other-file
828 ;; Do not add the '/' or '\' at the end
831 ada-search-directories))
834 )
836 ;; No prj file ? => Setup default values
837 ;; Note that nil means that all compilation modes will first look in the
838 ;; current directory, and only then in the current file's directory. This
839 ;; current file is assumed at this point to be in the common source
840 ;; directory.
842 ))
846 "Find all references to the entity under POS.
847 Calls gnatfind to find the references.
848 if ARG is t, the contents of the old *gnatfind* buffer is preserved.
849 if LOCAL-ONLY is t, only the declarations in the current file are returned."
860 ;; if the file is more recent than the executable
865 nil nil local-only arg)
870 )
873 "Find all references to the entity under POS.
874 Calls gnatfind to find the references.
875 if ARG is t, the contents of the old *gnatfind* buffer is preserved."
882 "Search for references to any entity whose name is ENTITY.
883 ENTITY was first found the location given by FILE, LINE and COLUMN.
884 If LOCAL-ONLY is t, then only the references in file will be listed, which
885 is much faster.
886 If APPEND is t, then the output of the command will be append to the existing
887 buffer *gnatfind* if it exists."
891 ;; Prepare the gnatfind command. Note that we must protect the quotes
892 ;; around operators, so that they are correctly handled and can be
893 ;; processed (gnatfind \"+\":...).
899 entity))
902 quote-entity
907 ))
908 old-contents)
910 ;; If a project file is defined, use it
925 ;; Hide the "Compilation" menu
935 )
936 )
940 ;; ----- Identifier Completion --------------------------------------------
942 "Tries to complete the identifier around POS.
943 The feature is only available if the files where compiled not using the -gnatx
944 option."
948 ;; Initialize function-local variables and jump to the .ali buffer
949 ;; Note that for regexp search is case insensitive too
958 ;; Open the .ali file
962 ;; build an alist of possible completions
968 ;; kills .ali buffer
971 ;; deletes the incomplete identifier in the buffer
975 ;; inserts the completed symbol
977 ))
979 ;; ----- Cross-referencing ----------------------------------------
982 "Jump to the declaration of the entity below the cursor."
988 "Jump to the body of the entity under the cursor."
994 "Display the body of the entity around POS.
995 If the entity doesn't have a body, display its declaration.
996 As a side effect, the buffer for the declaration is also open."
1000 ;; Temporarily force the display in the same buffer, since we
1001 ;; already changed previously
1006 "Display the declaration of the identifier around POS.
1007 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1008 non-nil.
1009 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1015 ;; First try the standard algorithm by looking into the .ali file, but if
1016 ;; that file was too old or even did not exist, try to look in the whole
1017 ;; object path for a possible location.
1024 ;; If the ALI file was up-to-date, then we probably have a predefined
1025 ;; entity, whose references are not given by GNAT
1030 ;; Else, look in every ALI file, except if the user doesn't want that
1034 )))))))
1037 "Display the declaration of the identifier around POS.
1038 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1043 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1046 command
1048 remote-shell-program
1049 machine
1050 command))))
1053 "Returns the list of absolute directories found in dir-list.
1054 If a directory is a relative directory, the value of ROOT-DIR is added in
1055 front."
1059 "Return the new value for process-environment.
1060 It modifies the source path and object path with the values found in the
1061 project file."
1073 path-separator)
1074 include)
1079 path-separator)
1080 objects)
1081 process-environment))))
1084 "Compiles the application, using the command found in the project file.
1085 If ARG is not nil, ask for user confirmation."
1094 ;; If no project file was found, ask the user
1098 ;; Make a single command from the list of commands, including the
1099 ;; commands to run it on a remote machine.
1105 ;; Insert newlines so as to separate the name of the commands to run
1106 ;; and the output of the commands. this doesn't work with cmdproxy.exe,
1107 ;; which gets confused by newline characters.
1114 "Recompile the current file.
1115 If ARG is not nil, ask for user confirmation of the command.
1116 PRJ-FIELD is the name of the field to use in the project file to get the
1117 command, and should be either comp_cmd (default) or check_cmd."
1130 ;; Make a single command from the list of commands, including the
1131 ;; commands to run it on a remote machine.
1134 ;; If no project file was found, ask the user
1138 ;; Insert newlines so as to separate the name of the commands to run
1139 ;; and the output of the commands. this doesn't work with cmdproxy.exe,
1140 ;; which gets confused by newline characters.
1147 "Recompile the current file.
1148 If ARG is not nil, ask for user confirmation of the command."
1153 "Run the application.
1154 if ARG is not-nil, asks for user confirmation."
1164 ;; Guess the command if it wasn't specified
1168 ;; Modify the command to run remotely
1170 ada-command-separator)))
1172 ;; Ask for the arguments to the command if required
1175 command)))
1177 ;; Run the command
1186 ;; Set these two variables to their default values, since otherwise
1187 ;; the output buffer is scrolled so that only the last output line
1188 ;; is visible at the top of the buffer.
1191 )
1194 ;; change to buffer *run* for interactive programs
1197 ))
1200 "Start the debugger on the application.
1201 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1202 project file.
1203 If ARG is non-nil, ask the user to confirm the command."
1206 cmd pre-cmd post-cmd)
1214 ;; If the command was not given in the project file, start a bare gdb
1217 " "
1221 ;; For gvd, add an extra switch so that the Emacs window is completly
1222 ;; swallowed inside the Gvd one
1225 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1226 ;; We make sure that gvd swallows the new frame, not the one the
1227 ;; user has been using until now
1228 ;; The frame is made invisible initially, so that GtkPlug gets a
1229 ;; chance to fully manage it. Then it works fine with Enlightenment
1230 ;; as well
1233 cmd " --editor-window="
1237 ;; Add a -fullname switch
1238 ;; Use the remote machine
1241 ;; Ask for confirmation if required
1247 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1248 ;; FIXME: This is evil but luckily a nop under Emacs-21.3.50 ! -stef
1260 ;; Temporarily replaces the definition of `comint-exec' so that we
1261 ;; can execute commands before running gdb.
1262 ;; FIXME: This is evil and not temporary !!! -stef
1271 command " "
1273 ))
1275 ;; Tight integration should force the tty mode
1277 ada-tight-gvd-integration
1286 ;; Restore the standard fset command (or for instance C-U M-x shell
1287 ;; wouldn't work anymore
1291 ;; Send post-commands to the debugger
1294 ;; Move to the end of the debugger buffer, so that it is automatically
1295 ;; scrolled from then on.
1298 ;; Display both the source window and the debugger window (the former
1299 ;; above the latter). No need to show the debugger window unless it
1300 ;; is going to have some relevant information.
1305 )))
1309 "Forces Emacs to read either FILENAME or the project file associated
1310 with the current buffer.
1311 Otherwise, this file is only read once, and never read again.
1312 Since the information in the project file is shared between all buffers, this
1313 automatically modifies the setup for all the Ada buffer that use this file."
1319 ;; Reread the location of the standard runtime library
1322 )
1324 ;; ------ Private routines
1327 "Update the cross-references for FILE.
1328 This in fact recompiles FILE to create ALI-FILE-NAME.
1329 This function returns the name of the file that was recompiled to generate
1330 the cross-reference information. Note that the ali file can then be deduced by
1331 replacing the file extension with .ali"
1332 ;; kill old buffer
1340 ;; Always recompile the body when we can. We thus temporarily switch to a
1341 ;; buffer than contains the body of the unit
1344 process)
1349 ;; Execute the compilation. Note that we must wait for the end of the
1350 ;; process, or the ALI file would still not be available.
1351 ;; Unfortunately, the underlying `compile' command that we use is
1352 ;; asynchronous.
1360 ;; remove the buffer for the body if it wasn't there before
1363 ))
1364 body-name))
1367 "Search for FILE in DIR-LIST."
1376 found))
1379 "Find an .ali file in obj_dir. The current buffer must be the Ada file.
1380 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1381 and the standard runtime location at the end."
1385 "Find a source file in src_dir. The current buffer must be the Ada file.
1386 Adds src_dir in front of the search path to conform to gnatmake's behavior,
1387 and the standard runtime location at the end."
1391 "Create the ali file name for the ada-file FILE.
1392 The file is searched for in every directory shown in the obj_dir lines of
1393 the project file."
1395 ;; This function has to handle the special case of non-standard
1396 ;; file names (i.e. not .adb or .ads)
1397 ;; The trick is the following:
1398 ;; 1- replace the extension of the current file with .ali,
1399 ;; and look for this file
1400 ;; 2- If this file is found:
1401 ;; grep the "^U" lines, and make sure we are not reading the
1402 ;; .ali file for a spec file. If we are, go to step 3.
1403 ;; 3- If the file is not found or step 2 failed:
1404 ;; find the name of the "other file", ie the body, and look
1405 ;; for its associated .ali file by subtituing the extension
1406 ;;
1407 ;; We must also handle the case of separate packages and subprograms:
1408 ;; 4- If no ali file was found, we try to modify the file name by removing
1409 ;; everything after the last '-' or '.' character, so as to get the
1410 ;; ali file for the parent unit. If we found an ali file, we check that
1411 ;; it indeed contains the definition for the separate entity by checking
1412 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1413 ;; also a separate.
1420 ali-file-name
1421 is-spec)
1423 ;; If we have a non-standard file name, and this is a spec, we first
1424 ;; look for the .ali file of the body, since this is the one that
1425 ;; contains the most complete information. If not found, we will do what
1426 ;; we can with the .ali file for the spec...
1432 file)
1448 ;; Else we take the .ali file associated with the unit
1452 ;; else we did not find the .ali file Second chance: in case
1453 ;; the files do not have standard names (such as for instance
1454 ;; file_s.ada and file_b.ada), try to go to the other file
1455 ;; and look for its ali file
1462 ;; If we still don't have an ali file, try to get the one
1463 ;; from the parent unit, in case we have a separate entity.
1473 )
1474 ali-file-name)))
1476 ;; If still not found, try to recompile the file
1478 ;; recompile only if the user asked for this. and search the ali
1479 ;; filename again. We avoid a possible infinite recursion by
1480 ;; temporarily disabling the automatic compilation.
1490 ;; same if the .ali file is too old and we must recompile it
1492 ada-xref-create-ali)
1495 ;; Always return the correct absolute file name
1497 ))
1500 "Create the complete file name (+directory) for FILE.
1501 The original file (where the user was) is ORIGINAL-FILE. Search in project
1502 file for possible paths."
1506 ;; If the buffer for original-file, use it to get the values from the
1507 ;; project file, otherwise load the file and its project file
1514 ;; we choose the first possible completion and we
1515 ;; return the absolute file name
1523 )))
1526 "Returns the file number for FILE in the associated ali file."
1536 "Returns the identlist around POS and switch to the .ali buffer.
1537 The returned list represents the entity, and can be manipulated through the
1538 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1540 ;; If at end of buffer (e.g the buffer is empty), error
1544 ;; goto first character of the identifier/operator (skip backward < and >
1545 ;; since they are part of multiple character operators
1549 ;; check if it really is an identifier
1554 ;; Just in front of a string => we could have an operator declaration,
1555 ;; as in "+", "-", ..
1559 ;; if looking at an operator
1560 ;; This is only true if:
1561 ;; - the symbol is +, -, ...
1562 ;; - the symbol is made of letters, and not followed by _ or a letter
1581 ;; Build the identlist
1589 identlist
1590 ))
1593 "Completes and returns IDENTLIST with the information extracted
1594 from the ali file (definition file and places where it is referenced)."
1597 declaration-found)
1602 ;; First attempt: we might already be on the declaration of the identifier
1603 ;; We want to look for the declaration only in a definite interval (after
1604 ;; the "^X ..." line for the current file, and before the next "^X" line
1608 nil t)
1618 ))
1620 ;; If declaration is still nil, then we were not on a declaration, and
1621 ;; have to fall back on other algorithms
1625 ;; Since we alread know the number of the file, search for a direct
1626 ;; reference to it
1630 identlist
1636 "[^etpzkd<>=^]"
1638 nil t)
1640 ;; if we did not find it, it may be because the first reference
1641 ;; is not required to have a 'unit_number|' item included.
1642 ;; Or maybe we are already on the declaration...
1645 "^[0-9]+.[0-9]+[ *]"
1649 "[^0-9]"
1651 nil t)
1653 ;; If still not found, then either the declaration is unknown
1654 ;; or the source file has been modified since the ali file was
1655 ;; created
1657 )
1658 )
1660 ;; Last check to be completly sure we have found the correct line (the
1661 ;; ali might not be up to date for instance)
1665 ;; while we have a continuation line, go up one line
1672 ;; Still no success ! The ali file must be too old, and we need to
1673 ;; use a basic algorithm based on guesses. Note that this only happens
1674 ;; if the user does not want us to automatically recompile files
1675 ;; automatically
1679 ;; no more idea to find the declaration. Give up
1684 )))
1685 )
1688 ;; Now that we have found a suitable line in the .ali file, get the
1689 ;; information available
1700 )
1704 ;; If we can find the file
1707 identlist
1711 ;; Else clean up the ali file
1715 ))
1718 ))
1719 ))
1722 "Find the matching position for IDENTLIST in the current ali buffer.
1723 This function is only called when the file was not up-to-date, so we need
1724 to make some guesses.
1725 This function is disabled for operators, and only works for identifiers."
1744 ;; have a look at the line and column numbers
1751 )
1752 ;; construct a list with the file names and the positions within
1756 )
1757 )
1758 )
1760 ;; how many possible declarations have we found ?
1763 ;; none => error
1770 ;; one => should be the right one
1774 ;; more than one => display choice list
1792 ))
1806 )
1809 ))))))
1813 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1814 If OTHER-FRAME is non nil, and `ada-xref-other-buffer' is non nil,
1815 opens a new window to show the declaration."
1821 file line col)
1823 ;; Note: in some cases, an entity can have multiple references to the
1824 ;; bodies (this is for instance the case for a separate subprogram, that
1825 ;; has a reference both to the stub and to the real body).
1826 ;; In that case, we simply go to each one in turn.
1828 ;; Get all the possible locations
1834 ali-line start)
1839 ;; it there was a file number in the same line
1842 ali-line)
1848 )
1849 ;; Else get the nearest file
1854 ;; Add the specs at the end again, so that from the last body we go to
1855 ;; the specs
1858 ;; Find the new location we want to go to.
1859 ;; If we are on none of the locations listed, we simply go to the specs.
1874 locations nil)
1877 ;; Find the file in the source path
1880 ;; Kill the .ali buffer
1883 ;; Now go to the buffer
1887 identlist
1888 other-frame)
1889 ))
1892 "More general function for cross-references.
1893 This function should be used when the standard algorithm that parses the
1894 .ali file has failed, either because that file was too old or even did not
1895 exist.
1896 This function attempts to find the possible declarations for the identifier
1897 anywhere in the object path.
1898 This command requires the external `egrep' program to be available.
1900 This works well when one is using an external librarie and wants
1901 to find the declaration and documentation of the subprograms one is
1902 is using."
1907 line column
1908 choice
1909 file)
1913 ;; Do the grep in all the directories. We do multiple shell
1914 ;; commands instead of one in case there is no .ali file in one
1915 ;; of the directory and the shell stops because of that.
1924 ;; Now parse the output
1938 ;; There could be duplicate choices, because of the structure
1939 ;; of the .ali files
1943 ;; Current buffer is still "*grep*"
1945 )
1947 ;; Now display the list of possible matches
1950 ;; No choice found => Error
1954 ;; Only one choice => Do the cross-reference
1961 identlist
1962 other-frame)
1965 )
1967 ;; Else, ask the user
1983 ))
1985 )))
1994 )
2003 identlist
2004 other-frame)
2007 ))))
2011 "Select and display FILE, at LINE and COLUMN.
2012 If we do not end on the same identifier as IDENTLIST, find the closest
2013 match. Kills the .ali buffer at the end.
2014 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2018 ;; Select and display the destination buffer
2025 )
2027 )
2029 ;; move the cursor to the correct position
2034 ;; If we are not on the identifier, the ali file was not up-to-date.
2035 ;; Try to find the nearest position where the identifier is found,
2036 ;; this is probably the right one.
2039 ))
2043 "Searches for NAME nearest to the position recorded in the Xref file.
2044 It returns the position of the declaration in the buffer or nil if not found."
2051 ;; loop - look for all declarations of name in this file
2054 ;; check if it really is a complete Ada identifier
2061 ;; variable declaration ?
2066 ;; procedure, function, task or package declaration ?
2069 (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]\\>"))))
2071 ;; check if it is nearer than the ones before if any
2077 )
2083 nil)))
2086 ;; Find the parent library file of the current file
2088 "Go to the parent library file."
2106 )
2108 ;; look for the file name for the parent unit specification
2116 )
2121 ;; Tries to open the new ali file to find the spec file
2130 )
2131 )
2132 )
2135 ))
2138 "Determine the filename in which ADANAME is found.
2139 This is a GNAT specific function that uses gnatkrunch."
2144 ;; send adaname to external process `gnatkr'.
2146 adaname ada-krunch-args)
2147 ;; fetch output of that process
2155 adaname
2156 )
2159 "Create an Ada package body in the current buffer.
2160 This function uses the `gnatstub' program to create the body.
2161 This function typically is to be hooked into `ff-file-created-hooks'."
2166 ;; If the current buffer is the body (as is the case when calling this
2167 ;; function from ff-file-created-hooks), then kill this temporary buffer
2174 ;; Make sure the current buffer is the spec (this might not be the case
2175 ;; if for instance the user was asked for a project file)
2180 ;; Make sure we have a project file (for parameters to gnatstub). Note that
2181 ;; this might have already been done if we have been called from the hook,
2182 ;; but this is not an expensive call)
2185 ;; Call the external process gnatstub
2198 )
2199 ;; call gnatstub to create the body file
2212 ;; Else clean up the output
2219 ;; display the error buffer
2221 )
2222 )))
2225 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2226 For instance, it creates the gnat-specific menus, sets some hooks for
2227 find-file...."
2228 ;; This should really be an `add-hook'. -stef
2231 ;; Completion for file names in the mini buffer should ignore .ali files
2235 )
2238 ;; ----- Add to ada-mode-hook ---------------------------------------------
2240 ;; Use gvd or ddd as the default debugger if it was found
2241 ;; On windows, do not use the --tty switch for GVD, since this is
2242 ;; not supported. Actually, we do not use this on Unix either, since otherwise
2243 ;; there is no console window left in GVD, and people have to use the
2244 ;; Emacs one.
2245 ;; This must be done before initializing the Ada menu.
2255 ;; Initializes the cross references to the runtime library
2258 ;; Add these standard directories to the search path
2261 ada-search-directories))
2265 ;;; ada-xref.el ends here