| blob | 8dba21afe9bd7313f14f83dbf6a5d8801391d9f6 |
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 never runs gcc."
62 "*If non-nil, ask for confirmation before compiling or running the application."
66 "*Maximum number of characters for filenames created by `gnatkr'.
67 Set to 0, if you don't use crunched filenames. This should be a string."
71 "*Arguments to pass to `gnatfind' to find location of the runtime.
72 Typical use is to pass `--RTS=soft-floats' on some systems that support it.
74 You can also add `-I-' if you do not want the current directory to be included.
75 Otherwise, going from specs to bodies and back will first look for files in the
76 current directory. This only has an impact if you are not using project files,
77 but only ADA_INCLUDE_PATH."
81 "Default compilation options."
85 "Default binder options."
89 "Default linker options."
93 "Default options for `gnatmake'."
97 "Default switches to use for `gnatfind'.
98 You should modify this variable, for instance to add `-a', if you are working
99 in an environment where most ALI files are write-protected.
100 The command `gnatfind' is used every time you choose the menu
107 "*Default command to be used to compile a single file.
108 Emacs will add the filename at the end of this command. This is the same
109 syntax as in the project file."
113 "*Default name of the debugger. We recommend either `gdb',
114 `gdb --emacs_gdbtk' or `ddd --tty -fullname'."
120 "*Default command to be used to compile the application.
121 This is the same syntax as in the project file."
125 "*Name of the project file to use for every Ada file.
126 Emacs will not try to use the standard algorithm to find the project file if
127 this string is not empty."
131 "*List of the options to pass to `gnatsub' to generate the body of a package.
132 This has the same syntax as in the project file (with variable substitution)."
136 "*If nil, use default values when no project file was found.
137 Otherwise, ask the user for the name of the project file to use."
144 "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging.
145 If GVD is not the debugger used, nothing happens."
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.
195 On Windows systems using `cmdproxy.exe' as the shell,
199 "Separator to use between multiple commands to `compile' or `start-process'.
200 `cmdproxy.exe' doesn't recognize multiple-line commands, so we have to use
211 "Associative list of project files.
212 It has the following format:
213 \((project_name . value) (project_name . value) ...)
217 ;; ----- Identlist manipulation -------------------------------------------
218 ;; An identlist is a vector that is used internally to reference an identifier
219 ;; To facilitate its use, we provide the following macros
241 "Reads the ali file into a new buffer, and returns this buffer's name"
245 ;; -----------------------------------------------------------------------
252 "Initialize the variables for the runtime library location.
253 CROSS-PREFIX is the prefix to use for the gnatls command."
256 ada-xref-runtime-library-ali-path '())
260 ;; Catch any error in the following form (i.e gnatls was not found)
262 ;; Even if we get an error, delete the *gnatls* buffer
269 ;; Source path
283 ;; Object path
296 )
303 ))
307 "Replace meta-sequences like ${...} in CMD-STRING with the appropriate value.
308 The project file must have been loaded first.
309 As a special case, ${current} is replaced with the name of the currently
310 edited file, minus extension but with directory, and ${full_current} is
311 replaced by the name including the extension."
325 ;; Check if there is an environment variable with the same name
339 t t cmd-string)))))
340 ))
341 cmd-string)
344 "Reset the properties in SYMBOL to the default values for ADA-BUFFER."
347 plist)
352 ;; Try hard to find a default value for filename, so that the user
353 ;; can edit his project file even if the current buffer is not an
354 ;; Ada file or not even associated with a file
358 ada-prj-default-project-file)
362 "and no default project "
369 ada-case-exception-file
371 'comp_opt ada-prj-default-comp-opt
372 'bind_opt ada-prj-default-bind-opt
373 'link_opt ada-prj-default-link-opt
374 'gnatmake_opt ada-prj-default-gnatmake-opt
375 'gnatfind_opt ada-prj-gnatfind-switches
387 ada-prj-default-comp-cmd)
389 ada-check-switch))
391 ada-prj-default-make-cmd)
401 )
405 "Extract the value of FIELD from the current project file.
406 The project file must have been loaded first.
407 A default value is returned if the file was not found.
409 Note that for src_dir and obj_dir, you should rather use
410 `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field' which will in
411 addition return the default paths."
414 file value)
416 ;; Get the project file (either the current one, or a default one)
420 ;; If the file was not found, use the default values
422 ;; Get the value from the file
425 ;; Create a default nil file that contains the default values
430 )
432 ;; Substitute the ${...} constructs in all the strings, including
433 ;; inside lists
438 nil)
442 value)
443 )
444 ))
448 "Return the full value for src_dir, including the default directories.
449 All the directories are returned as absolute directories."
453 ;; Add ${build_dir} in front of the path
457 build-dir)
459 ;; Add the standard runtime at the end
460 ada-xref-runtime-library-specs-path)))
463 "Return the full value for obj_dir, including the default directories.
464 All the directories are returned as absolute directories."
468 ;; Add ${build_dir} in front of the path
472 build-dir)
474 ;; Add the standard runtime at the end
475 ada-xref-runtime-library-ali-path)))
478 "Update the menu Ada->Project, with the list of available project files."
479 ;; Create the standard items.
485 "---"
486 ;; Add the new items
491 "Change the active project file."
498 ada-project-file-extension)
502 command
504 :toggle
507 ))))
509 ;; Parses all the known project files, and insert at
510 ;; least the default one (in case
511 ;; ada-xref-project-files is nil)
517 ;;-------------------------------------------------------------
518 ;;-- Searching a file anywhere on the source path.
519 ;;--
520 ;;-- The following functions provide support for finding a file anywhere
521 ;;-- on the source path, without providing an explicit directory.
522 ;;-- They also provide file name completion in the minibuffer.
523 ;;--
524 ;;-- Public subprograms: ada-find-file
525 ;;--
526 ;;-------------------------------------------------------------
529 "Completion function when reading a file from the minibuffer.
530 Completion is attempted in all the directories in the source path, as
531 defined in the project file."
542 list)
546 predicate)))))
548 ;;;###autoload
550 "Open a file anywhere in the source path.
551 Completion is available."
560 ;; ----- Utilities -------------------------------------------------
563 "If no project file is currently active, load a default one."
570 "Push (FILENAME, POSITION) on the position ring for cross-references."
576 "Go to the previous cross-reference we were on."
585 "Converts from NAME to a name that can be used by the compilation commands.
586 This is overriden on VMS to convert from VMS filenames to Unix filenames."
587 name)
590 "Set the file whose name is NAME as the default project file.
591 If KEEP-EXISTING is true and a project file has already been loaded, nothing
592 is done. This is meant to be used from `ada-mode-hook', for instance, to force
593 a project file unless the user has already loaded one."
602 ;; ------ Handling the project file -----------------------------
605 "Find the prj file associated with FILE (or the current buffer if nil).
606 If NO-USER-QUESTION is non-nil, use a default file if not project file was
607 found, and do not ask the user.
608 If the buffer is not an Ada buffer, associate it with the default project
609 file. If none is set, return nil."
613 ;; Use the active project file if there is one.
614 ;; This is also valid if we don't currently have an Ada buffer, or if
615 ;; the current buffer is not a real file (for instance an emerge buffer)
625 ;; other cases: use a more complex algorithm
630 ada-project-file-extension))
633 ;; on Emacs 20.2, directory-files does not work if
634 ;; parse-sexp-lookup-properties is set
637 dir t
644 ;; Else if there is a project file with the same name as the Ada
645 ;; file, but not the same extension.
649 ;; Else if only one project file was found in the current directory
653 ;; Else if there are multiple files, ask the user
664 counter
679 ;; Else if no project file was found in the directory, ask a name
680 ;; to the user, using as a default value the last one entered by
681 ;; the user
687 nil ada-last-prj-file))
690 )))
693 ))
697 "Reads and parses the PRJ-FILE file if it was found.
698 The current buffer should be the ada-file buffer."
701 run_cmd debug_pre_cmd debug_post_cmd
705 ;; Set the project file as the active one.
708 ;; Initialize the project with the default values
711 ;; Do not use find-file below, since we don't want to show this
712 ;; buffer. If the file is open through speedbar, we can't use
713 ;; find-file anyway, since the speedbar frame is special and does not
714 ;; allow the selection of a file in it.
727 ;; Now overrides these values with the project file
779 ;; Kill the project buffer
782 )
784 ;; Else the file wasn't readable (probably the default project).
785 ;; We initialize it with the current environment variables.
786 ;; We need to add the startup directory in front so that
787 ;; files locally redefined are properly found. We cannot
788 ;; add ".", which varies too much depending on what the
789 ;; current buffer is.
802 )
805 ;; Delete the default project file from the list, if it is there.
806 ;; Note that in that case, this default project is the only one in
807 ;; the list
811 ;; Memorize the newly read project file
816 ;; Sets up the compilation-search-path so that Emacs is able to
817 ;; go to the source of the errors in a compilation buffer
820 ;; Set the casing exceptions file list
826 ;; Add the directories to the search path for ff-find-other-file
827 ;; Do not add the '/' or '\' at the end
830 ada-search-directories))
833 )
835 ;; No prj file ? => Setup default values
836 ;; Note that nil means that all compilation modes will first look in the
837 ;; current directory, and only then in the current file's directory. This
838 ;; current file is assumed at this point to be in the common source
839 ;; directory.
841 ))
845 "Find all references to the entity under POS.
846 Calls gnatfind to find the references.
847 If ARG is t, the contents of the old *gnatfind* buffer is preserved.
848 If LOCAL-ONLY is t, only the declarations in the current file are returned."
858 ;; if the file is more recent than the executable
863 nil nil local-only arg)
868 )
871 "Find all references to the entity under POS.
872 Calls `gnatfind' to find the references.
873 If ARG is t, the contents of the old *gnatfind* buffer is preserved."
879 "Search for references to any entity whose name is ENTITY.
880 ENTITY was first found the location given by FILE, LINE and COLUMN.
881 If LOCAL-ONLY is t, then list only the references in FILE, which
882 is much faster.
883 If APPEND is t, then append the output of the command to the existing
884 buffer `*gnatfind*', if there is one."
888 ;; Prepare the gnatfind command. Note that we must protect the quotes
889 ;; around operators, so that they are correctly handled and can be
890 ;; processed (gnatfind \"+\":...).
896 entity))
899 quote-entity
904 ))
905 old-contents)
907 ;; If a project file is defined, use it
923 ;; Hide the "Compilation" menu
933 )
934 )
938 ;; ----- Identifier Completion --------------------------------------------
940 "Tries to complete the identifier around POS.
941 The feature is only available if the files where compiled without
942 the option `-gnatx'."
946 ;; Initialize function-local variables and jump to the .ali buffer
947 ;; Note that for regexp search is case insensitive too
956 ;; Open the .ali file
960 ;; build an alist of possible completions
966 ;; kills .ali buffer
969 ;; deletes the incomplete identifier in the buffer
973 ;; inserts the completed symbol
975 ))
977 ;; ----- Cross-referencing ----------------------------------------
980 "Jump to the declaration of the entity below the cursor."
986 "Jump to the body of the entity under the cursor."
992 "Display the body of the entity around POS.
993 If the entity doesn't have a body, display its declaration.
994 As a side effect, the buffer for the declaration is also open."
998 ;; Temporarily force the display in the same buffer, since we
999 ;; already changed previously
1004 "Display the declaration of the identifier around POS.
1005 The declaration is shown in another buffer if `ada-xref-other-buffer' is
1006 non-nil.
1007 If OTHER-FRAME is non-nil, display the cross-reference in another frame."
1013 ;; First try the standard algorithm by looking into the .ali file, but if
1014 ;; that file was too old or even did not exist, try to look in the whole
1015 ;; object path for a possible location.
1022 ;; If the ALI file was up-to-date, then we probably have a predefined
1023 ;; entity, whose references are not given by GNAT
1028 ;; Else, look in every ALI file, except if the user doesn't want that
1032 )))))))
1035 "Display the declaration of the identifier around POS.
1036 The declation is shown in another frame if `ada-xref-other-buffer' is non-nil."
1041 "Return the remote version of COMMAND, or COMMAND if remote_machine is nil."
1044 command
1046 remote-shell-program
1047 machine
1048 command))))
1051 "Returns the list of absolute directories found in dir-list.
1052 If a directory is a relative directory, add the value of ROOT-DIR in front."
1056 "Prepare an environment for Ada compilation.
1057 This returns a new value to use for `process-environment',
1058 but does not actually put it into use.
1059 It modifies the source path and object path with the values found in the
1060 project file."
1072 path-separator)
1073 include)
1078 path-separator)
1079 objects)
1080 process-environment))))
1083 "Compile the application, using the command found in the project file.
1084 If ARG is not nil, ask for user confirmation."
1093 ;; If no project file was found, ask the user
1097 ;; Make a single command from the list of commands, including the
1098 ;; commands to run it on a remote machine.
1104 ;; Insert newlines so as to separate the name of the commands to run
1105 ;; and the output of the commands. This doesn't work with cmdproxy.exe,
1106 ;; which gets confused by newline characters.
1113 "Recompile the current file.
1114 If ARG is not nil, ask for user confirmation of the command.
1115 PRJ-FIELD is the name of the field to use in the project file to get the
1116 command, and should be either comp_cmd (default) or check_cmd."
1129 ;; Make a single command from the list of commands, including the
1130 ;; commands to run it on a remote machine.
1133 ;; If no project file was found, ask the user
1137 ;; Insert newlines so as to separate the name of the commands to run
1138 ;; and the output of the commands. This doesn't work with cmdproxy.exe,
1139 ;; which gets confused by newline characters.
1146 "Recompile the current file.
1147 If ARG is not nil, ask for user confirmation of the command."
1152 "Run the application.
1153 if ARG is not-nil, ask for user confirmation."
1163 ;; Guess the command if it wasn't specified
1167 ;; Modify the command to run remotely
1169 ada-command-separator)))
1171 ;; Ask for the arguments to the command if required
1174 command)))
1176 ;; Run the command
1185 ;; Set these two variables to their default values, since otherwise
1186 ;; the output buffer is scrolled so that only the last output line
1187 ;; is visible at the top of the buffer.
1190 )
1193 ;; change to buffer *run* for interactive programs
1196 ))
1199 "Start the debugger on the application.
1200 EXECUTABLE-NAME, if non-nil, is debugged instead of the file specified in the
1201 project file.
1202 If ARG is non-nil, ask the user to confirm the command."
1205 cmd pre-cmd post-cmd)
1213 ;; If the command was not given in the project file, start a bare gdb
1216 " "
1220 ;; For gvd, add an extra switch so that the Emacs window is completly
1221 ;; swallowed inside the Gvd one
1224 ;; Start a new frame, so that when gvd exists we do not kill Emacs
1225 ;; We make sure that gvd swallows the new frame, not the one the
1226 ;; user has been using until now
1227 ;; The frame is made invisible initially, so that GtkPlug gets a
1228 ;; chance to fully manage it. Then it works fine with Enlightenment
1229 ;; as well
1232 cmd " --editor-window="
1236 ;; Add a -fullname switch
1237 ;; Use the remote machine
1240 ;; Ask for confirmation if required
1246 ;; Do not add -fullname, since we can have a 'rsh' command in front.
1247 ;; FIXME: This is evil but luckily a nop under Emacs-21.3.50 ! -stef
1259 ;; Temporarily replaces the definition of `comint-exec' so that we
1260 ;; can execute commands before running gdb.
1261 ;; FIXME: This is evil and not temporary !!! -stef
1270 command " "
1272 ))
1274 ;; Tight integration should force the tty mode
1276 ada-tight-gvd-integration
1285 ;; Restore the standard fset command (or for instance C-U M-x shell
1286 ;; wouldn't work anymore
1290 ;; Send post-commands to the debugger
1293 ;; Move to the end of the debugger buffer, so that it is automatically
1294 ;; scrolled from then on.
1297 ;; Display both the source window and the debugger window (the former
1298 ;; above the latter). No need to show the debugger window unless it
1299 ;; is going to have some relevant information.
1304 )))
1308 "Forces Emacs to read either FILENAME or the project file associated
1309 with the current buffer.
1310 Otherwise, this file is only read once, and never read again.
1311 Since the information in the project file is shared between all buffers, this
1312 automatically modifies the setup for all the Ada buffer that use this file."
1318 ;; Reread the location of the standard runtime library
1321 )
1323 ;; ------ Private routines
1326 "Update the cross-references for FILE.
1327 This in fact recompiles FILE to create ALI-FILE-NAME.
1328 This function returns the name of the file that was recompiled to generate
1329 the cross-reference information. Note that the ali file can then be deduced by
1330 replacing the file extension with `.ali'."
1331 ;; kill old buffer
1339 ;; Always recompile the body when we can. We thus temporarily switch to a
1340 ;; buffer than contains the body of the unit
1343 process)
1348 ;; Execute the compilation. Note that we must wait for the end of the
1349 ;; process, or the ALI file would still not be available.
1350 ;; Unfortunately, the underlying `compile' command that we use is
1351 ;; asynchronous.
1359 ;; remove the buffer for the body if it wasn't there before
1362 ))
1363 body-name))
1366 "Search for FILE in DIR-LIST."
1375 found))
1378 "Find an .ali file in obj_dir. The current buffer must be the Ada file.
1379 Adds build_dir in front of the search path to conform to gnatmake's behavior,
1380 and the standard runtime location at the end."
1384 "Find a source file in src_dir. The current buffer must be the Ada file.
1385 Adds src_dir in front of the search path to conform to gnatmake's behavior,
1386 and the standard runtime location at the end."
1390 "Create the ali file name for the ada-file FILE.
1391 The file is searched for in every directory shown in the obj_dir lines of
1392 the project file."
1394 ;; This function has to handle the special case of non-standard
1395 ;; file names (i.e. not .adb or .ads)
1396 ;; The trick is the following:
1397 ;; 1- replace the extension of the current file with .ali,
1398 ;; and look for this file
1399 ;; 2- If this file is found:
1400 ;; grep the "^U" lines, and make sure we are not reading the
1401 ;; .ali file for a spec file. If we are, go to step 3.
1402 ;; 3- If the file is not found or step 2 failed:
1403 ;; find the name of the "other file", ie the body, and look
1404 ;; for its associated .ali file by subtituing the extension
1405 ;;
1406 ;; We must also handle the case of separate packages and subprograms:
1407 ;; 4- If no ali file was found, we try to modify the file name by removing
1408 ;; everything after the last '-' or '.' character, so as to get the
1409 ;; ali file for the parent unit. If we found an ali file, we check that
1410 ;; it indeed contains the definition for the separate entity by checking
1411 ;; the 'D' lines. This is done repeatedly, in case the direct parent is
1412 ;; also a separate.
1419 ali-file-name
1420 is-spec)
1422 ;; If we have a non-standard file name, and this is a spec, we first
1423 ;; look for the .ali file of the body, since this is the one that
1424 ;; contains the most complete information. If not found, we will do what
1425 ;; we can with the .ali file for the spec...
1431 file)
1447 ;; Else we take the .ali file associated with the unit
1451 ;; else we did not find the .ali file Second chance: in case
1452 ;; the files do not have standard names (such as for instance
1453 ;; file_s.ada and file_b.ada), try to go to the other file
1454 ;; and look for its ali file
1461 ;; If we still don't have an ali file, try to get the one
1462 ;; from the parent unit, in case we have a separate entity.
1472 )
1473 ali-file-name)))
1475 ;; If still not found, try to recompile the file
1477 ;; Recompile only if the user asked for this, and search the ali
1478 ;; filename again. We avoid a possible infinite recursion by
1479 ;; temporarily disabling the automatic compilation.
1489 ;; same if the .ali file is too old and we must recompile it
1491 ada-xref-create-ali)
1494 ;; Always return the correct absolute file name
1496 ))
1499 "Create the complete file name (+directory) for FILE.
1500 The original file (where the user was) is ORIGINAL-FILE. Search in project
1501 file for possible paths."
1505 ;; If the buffer for original-file, use it to get the values from the
1506 ;; project file, otherwise load the file and its project file
1513 ;; we choose the first possible completion and we
1514 ;; return the absolute file name
1522 )))
1525 "Returns the file number for FILE in the associated ali file."
1535 "Returns the identlist around POS and switch to the .ali buffer.
1536 The returned list represents the entity, and can be manipulated through the
1537 macros `ada-name-of', `ada-line-of', `ada-column-of', `ada-file-of',..."
1539 ;; If at end of buffer (e.g the buffer is empty), error
1543 ;; goto first character of the identifier/operator (skip backward < and >
1544 ;; since they are part of multiple character operators
1548 ;; check if it really is an identifier
1553 ;; Just in front of a string => we could have an operator declaration,
1554 ;; as in "+", "-", ..
1558 ;; if looking at an operator
1559 ;; This is only true if:
1560 ;; - the symbol is +, -, ...
1561 ;; - the symbol is made of letters, and not followed by _ or a letter
1580 ;; Build the identlist
1588 identlist
1589 ))
1592 "Completes and returns IDENTLIST with the information extracted
1593 from the ali file (definition file and places where it is referenced)."
1596 declaration-found)
1601 ;; First attempt: we might already be on the declaration of the identifier
1602 ;; We want to look for the declaration only in a definite interval (after
1603 ;; the "^X ..." line for the current file, and before the next "^X" line
1607 nil t)
1617 ))
1619 ;; If declaration is still nil, then we were not on a declaration, and
1620 ;; have to fall back on other algorithms
1624 ;; Since we alread know the number of the file, search for a direct
1625 ;; reference to it
1629 identlist
1635 "[^etpzkd<>=^]"
1637 nil t)
1639 ;; if we did not find it, it may be because the first reference
1640 ;; is not required to have a 'unit_number|' item included.
1641 ;; Or maybe we are already on the declaration...
1644 "^[0-9]+.[0-9]+[ *]"
1648 "[^0-9]"
1650 nil t)
1652 ;; If still not found, then either the declaration is unknown
1653 ;; or the source file has been modified since the ali file was
1654 ;; created
1656 )
1657 )
1659 ;; Last check to be completly sure we have found the correct line (the
1660 ;; ali might not be up to date for instance)
1664 ;; while we have a continuation line, go up one line
1671 ;; Still no success ! The ali file must be too old, and we need to
1672 ;; use a basic algorithm based on guesses. Note that this only happens
1673 ;; if the user does not want us to automatically recompile files
1674 ;; automatically
1678 ;; No more idea to find the declaration. Give up
1683 )))
1684 )
1687 ;; Now that we have found a suitable line in the .ali file, get the
1688 ;; information available
1699 )
1703 ;; If we can find the file
1706 identlist
1710 ;; Else clean up the ali file
1714 ))
1717 ))
1718 ))
1721 "Find the matching position for IDENTLIST in the current ali buffer.
1722 This function is only called when the file was not up-to-date, so we need
1723 to make some guesses.
1724 This function is disabled for operators, and only works for identifiers."
1743 ;; have a look at the line and column numbers
1750 )
1751 ;; construct a list with the file names and the positions within
1755 )
1756 )
1757 )
1759 ;; how many possible declarations have we found ?
1762 ;; none => error
1769 ;; one => should be the right one
1773 ;; more than one => display choice list
1791 ))
1805 )
1808 ))))))
1812 "Look in the .ali file for the definition of the identifier in IDENTLIST.
1813 If OTHER-FRAME is non nil, and `ada-xref-other-buffer' is non nil,
1814 opens a new window to show the declaration."
1820 file line col)
1822 ;; Note: in some cases, an entity can have multiple references to the
1823 ;; bodies (this is for instance the case for a separate subprogram, that
1824 ;; has a reference both to the stub and to the real body).
1825 ;; In that case, we simply go to each one in turn.
1827 ;; Get all the possible locations
1833 ali-line start)
1838 ;; it there was a file number in the same line
1841 ali-line)
1847 )
1848 ;; Else get the nearest file
1853 ;; Add the specs at the end again, so that from the last body we go to
1854 ;; the specs
1857 ;; Find the new location we want to go to.
1858 ;; If we are on none of the locations listed, we simply go to the specs.
1873 locations nil)
1876 ;; Find the file in the source path
1879 ;; Kill the .ali buffer
1882 ;; Now go to the buffer
1886 identlist
1887 other-frame)
1888 ))
1891 "More general function for cross-references.
1892 This function should be used when the standard algorithm that parses the
1893 .ali file has failed, either because that file was too old or even did not
1894 exist.
1895 This function attempts to find the possible declarations for the identifier
1896 anywhere in the object path.
1897 This command requires the external `egrep' program to be available.
1899 This works well when one is using an external librarie and wants
1900 to find the declaration and documentation of the subprograms one is
1901 is using."
1906 line column
1907 choice
1908 file)
1912 ;; Do the grep in all the directories. We do multiple shell
1913 ;; commands instead of one in case there is no .ali file in one
1914 ;; of the directory and the shell stops because of that.
1923 ;; Now parse the output
1937 ;; There could be duplicate choices, because of the structure
1938 ;; of the .ali files
1942 ;; Current buffer is still "*grep*"
1944 )
1946 ;; Now display the list of possible matches
1949 ;; No choice found => Error
1953 ;; Only one choice => Do the cross-reference
1960 identlist
1961 other-frame)
1964 )
1966 ;; Else, ask the user
1982 ))
1984 )))
1993 )
2002 identlist
2003 other-frame)
2006 ))))
2010 "Select and display FILE, at LINE and COLUMN.
2011 If we do not end on the same identifier as IDENTLIST, find the closest
2012 match. Kills the .ali buffer at the end.
2013 If OTHER-FRAME is non-nil, creates a new frame to show the file."
2017 ;; Select and display the destination buffer
2024 )
2026 )
2028 ;; move the cursor to the correct position
2033 ;; If we are not on the identifier, the ali file was not up-to-date.
2034 ;; Try to find the nearest position where the identifier is found,
2035 ;; this is probably the right one.
2038 ))
2042 "Searches for NAME nearest to the position recorded in the Xref file.
2043 It returns the position of the declaration in the buffer or nil if not found."
2050 ;; loop - look for all declarations of name in this file
2053 ;; check if it really is a complete Ada identifier
2060 ;; variable declaration ?
2065 ;; procedure, function, task or package declaration ?
2068 (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]\\>"))))
2070 ;; check if it is nearer than the ones before if any
2076 )
2082 nil)))
2085 ;; Find the parent library file of the current file
2087 "Go to the parent library file."
2105 )
2107 ;; look for the file name for the parent unit specification
2115 )
2120 ;; Tries to open the new ali file to find the spec file
2129 )
2130 )
2131 )
2134 ))
2137 "Determine the filename in which ADANAME is found.
2138 This is a GNAT specific function that uses gnatkrunch."
2143 ;; send adaname to external process `gnatkr'.
2145 adaname ada-krunch-args)
2146 ;; fetch output of that process
2154 adaname
2155 )
2158 "Create an Ada package body in the current buffer.
2159 This function uses the `gnatstub' program to create the body.
2160 This function typically is to be hooked into `ff-file-created-hooks'."
2165 ;; If the current buffer is the body (as is the case when calling this
2166 ;; function from ff-file-created-hooks), then kill this temporary buffer
2173 ;; Make sure the current buffer is the spec (this might not be the case
2174 ;; if for instance the user was asked for a project file)
2179 ;; Make sure we have a project file (for parameters to gnatstub). Note that
2180 ;; this might have already been done if we have been called from the hook,
2181 ;; but this is not an expensive call)
2184 ;; Call the external process gnatstub
2197 )
2198 ;; call gnatstub to create the body file
2211 ;; Else clean up the output
2218 ;; display the error buffer
2220 )
2221 )))
2224 "Function called by `ada-mode-hook' to initialize the ada-xref.el package.
2225 For instance, it creates the gnat-specific menus, sets some hooks for
2226 find-file...."
2227 ;; This should really be an `add-hook'. -stef
2230 ;; Completion for file names in the mini buffer should ignore .ali files
2234 )
2237 ;; ----- Add to ada-mode-hook ---------------------------------------------
2239 ;; Use gvd or ddd as the default debugger if it was found
2240 ;; On windows, do not use the --tty switch for GVD, since this is
2241 ;; not supported. Actually, we do not use this on Unix either,
2242 ;; since otherwise there is no console window left in GVD,
2243 ;; and people have to use the Emacs one.
2244 ;; This must be done before initializing the Ada menu.
2254 ;; Initializes the cross references to the runtime library
2257 ;; Add these standard directories to the search path
2260 ada-search-directories))
2264 ;;; arch-tag: 415a39fe-577b-4676-b3b1-6ff6db7ca24e
2265 ;;; ada-xref.el ends here