├── LICENSE ├── README.md ├── fortran-tags.el └── fortran-tags.py /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Fortran-tags 2 | ============ 3 | 4 | Emacs plugin for source code indexing of modern Fortran 5 | 6 | Brief description 7 | ----------------- 8 | 9 | Fortran-tags is a Fortran source code indexing tool with the focus of finding the definition of any variable or procedure. It is able to correctly locate all global and local variables and is expected to work with any Fortran 2008 conforming code with some exceptions as mentioned below. Fortran-tags is designed to be used with the Emacs text editor in a Linux environment. A prerequisite for using is Python 3. 10 | 11 | Downloading 12 | ----------- 13 | 14 | * The latest version is available [here](https://github.com/raullaasner/fortran-tags/archive/master.zip). 15 | * If you want to import the whole repository, issue `git clone git@github.com:raullaasner/fortran-tags.git`. 16 | 17 | Installation 18 | ------------ 19 | 20 | 1. Include `fortran-tags.el` in your Emacs configuration file, 21 | 22 | ```emacs-lisp 23 | (load-file "/fortran-tags.el") 24 | ``` 25 | 26 | Alternatively, if `fortran-tags.el` is in a standard location such as `~/.emacs.d/lisp`, 27 | 28 | ```emacs-lisp 29 | ;;(add-to-list 'load-path "~/.emacs.d/lisp") 30 | (require 'fortran-tags) 31 | ``` 32 | 33 | 2. Include `fortran-tags.py` in your PATH. If Emacs can't find `fortran-tags.py`, try 34 | 35 | ```emacs-lisp 36 | (setenv "PATH" (concat ":" (getenv "PATH"))) 37 | ``` 38 | 39 | Usage 40 | ----- 41 | 42 | * First generate a tags file with 43 | 44 | ``` 45 | fortran-tags.py -g FILE [FILE ...] 46 | ``` 47 | 48 | Default is to create a file named `FORTAGS` in the current directory but this can be changed with the option `-o`. For including all source directories and subdirectories of the project, one can issue, for example, 49 | 50 | ``` 51 | find -name '*.f90' | xargs fortran-tags.py -g 52 | ``` 53 | 54 | (Why not create an alias for this?) When adding, removing, or modifying the source files, only minimal changes are made to the tags file. The structure of the tags file is explained at the beginning of `fortran-tags.py`. 55 | 56 | * The Elisp command `fortran-find-tag` tries to find the definition of the word under the cursor. It first searches for the definition in the present scope. If not found, it expands the search scope, tries again, and if still not found, keeps expanding the scope until searching at the module level. If the definition is not found in the current module, the search expands to the module wide variables and procedures of all other modules. If more than one match was found, `fortran-goto-next` can be used to cycle through all the matches. If a match was found in the current module, then the other modules are not searched in because, in principle at least, this has to be the correct match. An exception can occur when using operator overloading (see below). A global search can always be forced by issuing `fortran-goto-next` even if just one match was found. 57 | 58 | * The location of the tags file is determined with the first issuance of `fortran-find-tag` or by putting 59 | 60 | ```emacs-lisp 61 | (setq fortran-tags-path "~/my-project/FORTAGS") 62 | ``` 63 | 64 | into a project related configuration file. The tags file is read from the hard drive each time `fortran-find-tag` is invoked (searches are based on `grep`). Thus, when the tags file is regenerated, the definitions are instantly up to date without restarting the editor. 65 | 66 | A simple elisp function to regenerate the tags file is 67 | 68 | ```emacs-lisp 69 | (defun generate-fortran-tags (path) 70 | (compile 71 | (concat "find " path 72 | " -name \"*.f90\" | xargs fortran-tags.py -o " path "/FORTAGS -g")) 73 | (setq fortran-tags-path (concat path "/FORTAGS"))) 74 | ``` 75 | 76 | where path is the root directory of a project. A call to this function could be included in a project related configuration file that is always run when the project is opened. 77 | 78 | * `fortran-pop-tag-mark` goes back to the previous position (works repeatedly). 79 | 80 | * `fortran-find-proc-calls` finds all calls to the procedure under the cursor. The results can then be cycled through using `fortran-goto-next`. This function is not perfect and can return some garbage along with the correct results. The reasons are that it 81 | 1. also searches in strings and comments; 82 | 2. is unable to find a match if `&` is used in unusal ways; 83 | 3. is unable to distinguish between type-bound arrays and procedures. 84 | 85 | If the code is well written with a clean style and the user knows whether they are searching for a subroutine or a function, the search can be sped up using the following functions, which employ a simpler regex pattern and search specifically for a subroutine or a function: 86 | * `fortran-find-proc-calls-sub` - search only for subroutine calls using the search pattern ^ \*call X \*([(&]|$), where `X` is the word under the cursor. 87 | * `fortran-find-proc-calls-func` - search only for function calls, excluding type-bound procedures, using the search pattern [=+/\*(&\-] \*X \*[(&]. 88 | * `fortran-find-proc-calls-type` - searches only for type-bound procedures using %X \*[(&]. 89 | 90 | These specialized searches are all case sensitive, whereas the general search with `fortran-find-proc-calls` is case insensitive and uses the search patterns (^|[;&]) \*call +X \*([(&;\!]|$) (for subroutines) and ([=+/\*(%&-]|^) \*X \*[(&] (for functions). 91 | 92 | * In order to specify the search term from keyboard, position the cursor so that it's not covering any characters (`_A-Za-z0-9`), and invoke any search function, e.g., `fortran-find-tag`. It will then ask you to enter the search term. All functions except `fortran-find-proc-calls` are case sensitive. 93 | 94 | * `fortran-procedures-in-buffer` lists all subroutines and functions in the current buffer. 95 | 96 | * It is possible to use Fortran-tags remotely using TRAMP. When reading the tags interactively, there are no changes in usage - simply open a source file on the remote location, invoke any Fortran-tags command, and when prompted for the tags file, find its location on the remote machine. When specifying the location of the tags in a script, set the tags path as follows: 97 | 98 | ```emacs-lisp 99 | (setq fortran-tags-path "/ssh:@:") 100 | ``` 101 | 102 | The remote protocol ("ssh"), the remote machine address, and the local tags path are then automatically extracted from `fortran-tags-path`. If that doesn't work for some reason, the following variables may be set manually: 103 | 104 | ```emacs-lisp 105 | (setq fortran-tags-path "") 106 | (setq fortran-tags-remote-protocol "ssh") 107 | (setq fortran-tags-remote-location "@") 108 | ``` 109 | 110 | * The default key-bindings are 111 | 112 | ``` 113 | M-. fortran-find-tag 114 | M-* fortran-pop-tag-mark 115 | M-n fortran-goto-next 116 | M-s g fortran-find-proc-calls 117 | M-s s fortran-find-proc-calls-sub 118 | M-s f fortran-find-proc-calls-func 119 | M-s t fortran-find-proc-calls-type 120 | M-s d fortran-procedures-in-buffer 121 | ``` 122 | 123 | These can be disabled by turning off `fortran-tags-mode`. 124 | 125 | Limitations 126 | ----------- 127 | 128 | * If the definition is found not in the present module but elsewhere, `fortran-find-tag` may return more than one match because it is unable to determine the exact origin of the word under the cursor. 129 | 130 | * It is assumed that the semicolon and ampersand are not used in highly non-standard ways. 131 | 132 | * If the initialization of a variable spans several lines, then only the first line is processed. In this example, 133 | 134 | ```fortran 135 | integer :: a(4) = [ 1, 2, & 136 | & 3, 4], b 137 | integer :: c = 5 138 | ``` 139 | 140 | `a` and `c` are correctly written into the tags file, whereas `b` is not found. `a` could also be a scalar with some complex initialization expression. 141 | 142 | * Submodules are not supported. 143 | 144 | * If there are two or more `associate` constructs within the same scope that contain an identical keyword, then the duplicate definitions are not found. 145 | 146 | * If the result variable of a function is defined using both the `result` keyword and a dummy variable, only the former counts as a definition. It is assumed that the return type is declared on the same line as function declaration. 147 | 148 | * If a procedure is overloaded using multiple interface blocks which are scattered over several modules, one of which is the current module, then only the definition in the current module is reached. In such a situation you should invoke `fortran-goto-next`, which always performs a global search. If no match was found in the current module, then `fortran-find-tag` always finds all of them. 149 | 150 | * It is recommended not to end subprograms with a bare `end` (not followed by, e.g., `subroutine`). It will often work but we can't ensure all cases. 151 | 152 | * Using `*` for specifying the kind is not recommended, but it will work with `real*8` and `complex*16`. See `exceptions` in fortran-tags.py. Other nonstandard syntax can be included by modifying this variable, e.g., `exceptions = 'real[*]8|complex[*]16|integer*8|'`. When dealing with clean code only, `exceptions` can be left empty. 153 | 154 | * Fortran-tags is unable to correctly handle the `#include` and `include` directives. The generated tags file might not have the correct contents. 155 | 156 | Troubleshooting 157 | --------------- 158 | 159 | A good place to bring up any issues is https://github.com/raullaasner/fortran-tags/issues. 160 | 161 | License 162 | ------- 163 | 164 | This project is distributed under the terms of the GNU General Public License, see LICENSE in the root directory of the present distribution or http://gnu.org/copyleft/gpl.txt. 165 | -------------------------------------------------------------------------------- /fortran-tags.el: -------------------------------------------------------------------------------- 1 | ;;; fortran-tags.el --- source code indexer of modern Fortran 2 | 3 | ;; Author: Raul Laasner 4 | ;; Keywords: languages, tags, fortran 5 | ;; Homepage: https://github.com/raullaasner/fortran-tags 6 | 7 | ;;; Commentary: 8 | 9 | ;; In short: 10 | ;; fortran-read-tags works like visit-tags-table 11 | ;; fortran-find-tag works like find-tag 12 | ;; fortran-pop-tag-mark works like pop-tag-mark 13 | ;; fortran-goto-next works like find-tag for multiple matches 14 | ;; fortran-find-proc-calls finds all the places where the procedure 15 | ;; has been used 16 | ;; See README for detailed information. 17 | 18 | ;; Global variables: 19 | ;; fortran-buffers: 20 | ;; Each invocation of goto-new-position pushes the current buffer 21 | ;; into fortran-buffers from where it is popped by 22 | ;; fortran-pop-tag-mark. 23 | ;; fortran-positions: 24 | ;; Similar to fortran-buffers except contains the saved positions. 25 | ;; alt-positions: 26 | ;; Holds the positions of alternative definitions if any were 27 | ;; found by fortran-find-tag or contains the matches found by 28 | ;; fortran-find-proc-calls. This is a list where each item is a 29 | ;; 3-item list (filepath, line_nr, position). 30 | ;; alt-positions-counter: 31 | ;; Remembers how many times alt-positions has been accessed. Each 32 | ;; call to fortran-goto-next moves on to the next element of 33 | ;; alt-positions. 34 | ;; fortran-tags-path: 35 | ;; Absolute path to the tags file. 36 | ;; fortran-tags-version-ok: 37 | ;; True if the current version and the version found on the first 38 | ;; line of the tags file agree. 39 | ;; cur-scope: 40 | ;; The scope at the position of the cursor as determined by 41 | ;; fortran-find-scope. 42 | ;; fortran-tags-remote-protocol: 43 | ;; Name of the networking protocol used by TRAMP 44 | ;; (e.g. "ssh"). This is non-nil if the tags file is fetched over 45 | ;; network. 46 | ;; fortran-tags-remote-location: 47 | ;; Address of the remote server (@) 48 | ;; fortran-tags-shell-prefix: 49 | ;; A string that is prepended to all shell commands. This is 50 | ;; typically empty but is non-empty for remote connections. 51 | ;; fortran-tags-shell-suffix: 52 | ;; A string that is appended to all shell commands. This is 53 | ;; typically empty but is non-empty for remote connections. For 54 | ;; the latter, it is simply "'", which completes the ssh command. 55 | ;; fortran-tags-file-prefix: 56 | ;; Used whenever an operation is performed on a file, 57 | ;; e.g. find-file. This is typically empty but is non-empty, 58 | ;; e.g. "/ssh:@:", for a remote connection. 59 | 60 | ;;; Code: 61 | 62 | (defun set-remote-location-parameters () 63 | "Set global parameters for remote connections. 64 | 65 | For local connections, most of these variables equal an empty 66 | string." 67 | (unless (boundp 'fortran-tags-remote-protocol) 68 | (if (string-match "/?\\(.*\\):\\(.*\\):\\(.*\\)" fortran-tags-path) 69 | (progn 70 | (setq fortran-tags-remote-protocol (match-string 1 fortran-tags-path)) 71 | (setq fortran-tags-remote-location (match-string 2 fortran-tags-path)) 72 | (setq fortran-tags-path (match-string 3 fortran-tags-path))) 73 | (setq fortran-tags-remote-protocol nil))) 74 | (if fortran-tags-remote-protocol 75 | (progn 76 | (setq fortran-tags-shell-prefix 77 | (concat fortran-tags-remote-protocol " " 78 | fortran-tags-remote-location " '")) 79 | (setq fortran-tags-shell-suffix "'") 80 | (setq fortran-tags-file-prefix 81 | (concat "/" fortran-tags-remote-protocol ":" 82 | fortran-tags-remote-location ":")))) 83 | (progn 84 | (setq fortran-tags-shell-prefix "") 85 | (setq fortran-tags-shell-suffix "") 86 | (setq fortran-tags-file-prefix ""))) 87 | 88 | (defun fortran-tags-shell-command (cmd) 89 | "Run CMD as a shell command. 90 | 91 | For local connections (when not using TRAMP) this is the same as 92 | shell-command-to-string." 93 | (shell-command-to-string 94 | (concat fortran-tags-shell-prefix cmd fortran-tags-shell-suffix))) 95 | 96 | (defun fortran-read-tags () 97 | "Interactively return the path of the Fortran tags file. 98 | 99 | Also delete some remote parameters so that they can be cleanly 100 | set again." 101 | (interactive) 102 | (makunbound 'fortran-tags-remote-protocol) 103 | (makunbound 'fortran-tags-shell-prefix) 104 | (read-file-name "Read tags file (default FORTAGS): " default-directory 105 | (expand-file-name "FORTAGS" default-directory) t)) 106 | 107 | (defun check-fortran-tags-version () 108 | "Read and check Fortran-tags version from the tags file. 109 | 110 | Return true if the first line of the tags file matches the 111 | current version of Fortran-tags." 112 | (string= (fortran-tags-shell-command "fortran-tags.py -v") 113 | (fortran-tags-shell-command 114 | (concat "head -n 1 " fortran-tags-path)))) 115 | 116 | (defun fortran-tags-initialize () 117 | "Initialize global variables. 118 | 119 | This function does not need to be explicitly called by the 120 | user. It is automatically called when certain functions are 121 | invoked." 122 | ;; Set values for the remote parameters 123 | (if (and (boundp 'fortran-tags-path) 124 | (not (boundp 'fortran-tags-shell-prefix))) 125 | (set-remote-location-parameters)) 126 | ;; If the tags file has moved, fortran-tags-path needs to be reset 127 | (if (and (boundp 'fortran-tags-path) 128 | (not (file-exists-p 129 | (concat fortran-tags-file-prefix fortran-tags-path)))) 130 | (makunbound 'fortran-tags-path)) 131 | ;; Find the tags file 132 | (unless (boundp 'fortran-tags-path) 133 | (setq fortran-tags-path (fortran-read-tags))) 134 | ;; Set values for the remote parameters 135 | (unless (boundp 'fortran-tags-shell-prefix) 136 | (set-remote-location-parameters)) 137 | ;; Check if the tags file has been created with the most recent 138 | ;; version of Fortran-tags 139 | (unless (boundp 'fortran-tags-version-ok) 140 | (setq fortran-tags-version-ok (check-fortran-tags-version))) 141 | (if (and (not fortran-tags-version-ok) 142 | (not (check-fortran-tags-version))) ; Recheck if changed 143 | (let ((tags-path fortran-tags-path)) 144 | (makunbound 'fortran-tags-path) 145 | (if (file-exists-p (concat fortran-tags-file-prefix tags-path)) 146 | (error "Incorrect format (regenerate using the current version of Fortran-tags)") 147 | (error (concat fortran-tags-file-prefix tags-path 148 | " does not exist.")))))) 149 | 150 | (defun fortran-word-at-point (&optional lowercase) 151 | "Return Fortran word at point (in lowercase if LOWERCASE)." 152 | (let (p1 p2) 153 | (save-excursion 154 | (progn 155 | (skip-chars-backward "_A-Za-z0-9") 156 | (setq p1 (point)) 157 | (skip-chars-forward "_A-Za-z0-9") 158 | (setq p2 (point)))) 159 | (cond ((= p1 p2) 160 | (downcase (read-string "Enter name: "))) 161 | (lowercase 162 | (downcase (buffer-substring-no-properties p1 p2))) 163 | (t (buffer-substring-no-properties p1 p2))))) 164 | 165 | (defun goto-new-position (file line char) 166 | "Go to the new position determined by FILE LINE CHAR. 167 | 168 | Also, push the current buffer and position to 169 | 'fortran-positions'." 170 | (unless (boundp 'fortran-buffers) (setq fortran-buffers (list))) 171 | (unless (boundp 'fortran-positions) (setq fortran-positions (list))) 172 | (push (current-buffer) fortran-buffers) 173 | (push (point) fortran-positions) 174 | ;; Do not call find-file if the current buffer is an indirect buffer 175 | ;; and the definition is in the same buffer. 176 | (unless (and (buffer-base-buffer) 177 | (string= (file-truename file) 178 | (file-truename 179 | (buffer-file-name (buffer-base-buffer))))) 180 | (find-file (concat fortran-tags-file-prefix file))) 181 | (goto-line (string-to-number line)) 182 | (forward-char (string-to-number char))) 183 | 184 | (defconst f90-scope-keyword-re 185 | (regexp-opt '("program" "module" "subroutine" "function" "submodule" "associate" "block") 'paren) 186 | "Regexp used to locate the start/end of a scope.") 187 | 188 | (defun f90-beginning-of-scope () 189 | "Move point to the beginning of the current scope. 190 | Return (TYPE NAME), or nil if not found." 191 | (let ((count 1) (case-fold-search t) matching-beg) 192 | (while (and (> count 0) 193 | (re-search-backward f90-scope-keyword-re nil 'move)) 194 | (beginning-of-line) 195 | (skip-chars-forward " \t0-9") 196 | (cond ((setq matching-beg (f90-looking-at-program-block-start)) 197 | (setq count (1- count))) 198 | ((f90-looking-at-associate) 199 | (setq matching-beg (list "end" "fortags_associate_construct")) 200 | (setq count (1- count))) 201 | ((f90-looking-at-critical) ; Critical or block 202 | (setq matching-beg (list "end" "fortags_block_construct")) 203 | (setq count (1- count))) 204 | ((f90-looking-at-program-block-end) 205 | (setq count (1+ count))))) 206 | (beginning-of-line) 207 | (if (zerop count) matching-beg))) 208 | 209 | (defun fortran-find-scope () 210 | "Set 'cur-scope' to the current scope." 211 | (setq cur-scope ":") 212 | (let ((tmp "")) 213 | (save-excursion 214 | (while tmp 215 | (setq tmp (f90-beginning-of-scope)) 216 | (if tmp 217 | (setq cur-scope (concat ":" (downcase (nth 1 tmp)) cur-scope)))))) 218 | (if (or (not (save-excursion (nth 1 (f90-beginning-of-scope)))) 219 | (string= "" (fortran-tags-shell-command 220 | (concat "LC_ALL=C grep -F -m 1 \" " cur-scope " \" " 221 | fortran-tags-path)))) 222 | ;; i) If (nth 1 (f90-beginning-of-scope)) returns zero, we have 223 | ;; zero scope. In this case it is necessary to check whether we 224 | ;; are inside the program construct where the beginning 225 | ;; 'program' keyword is missing; ii) If the scope is not found 226 | ;; in the tags file, then it was incorrectly found. If so, 227 | ;; perform a more advanced search using fortran-tags.py -s. 228 | (let ((tmp-buffer "fortran-tags-tmp-buffer")) 229 | (generate-new-buffer tmp-buffer) 230 | (if (save-excursion (nth 1 (f90-beginning-of-scope))) 231 | ;; In case of ii) above, process the input file up to the 232 | ;; current point. The objective is to determine the 233 | ;; current scope. 234 | (call-process-region (point-min) (point) 235 | "fortran-tags.py" nil tmp-buffer nil "-s") 236 | ;; In case of i), process the input file from the current 237 | ;; point onwards. The objective is to find out whether there 238 | ;; is an 'end program' somewhere. If so, cur-scope will be 239 | ;; returned as '\n' (fortran-tags.py starts with ':' and 240 | ;; only returns '\n' if there is an excess 'end' somewhere). 241 | (call-process-region (point) (point-max) 242 | "fortran-tags.py" nil tmp-buffer nil "-s")) 243 | (with-current-buffer tmp-buffer 244 | (setq cur-scope (buffer-string))) 245 | (kill-buffer tmp-buffer)))) 246 | 247 | (defun fortran-find-tag (&optional force-global) 248 | "Find the definition of word under cursor (globally if FORCE-GLOBAL). 249 | 250 | If found, move to the new position. If force-global is true, the 251 | search is performed by only scanning through variables with the 252 | module scope." 253 | (interactive) 254 | (fortran-tags-initialize) 255 | ;; Find the definition 256 | (let ((WORD (fortran-word-at-point t)) scope scopes match i j) 257 | (setq alt-positions (list)) 258 | (fortran-find-scope) 259 | (if (string= cur-scope "\n") 260 | ;; We are in a program construct that didn't start with the 261 | ;; 'program' keyword. Set cur-scope to :fortags_program_scope: 262 | ;; manually. 263 | (setq cur-scope ":fortags_program_scope:")) 264 | (setq scopes (split-string cur-scope ":")) 265 | (catch 'found 266 | (if (not force-global) 267 | (progn 268 | (setq i (1- (length scopes))) 269 | ;; If the current scope is :a:b:c:, but contains no match, 270 | ;; the search is expanded to the scopes :a:b:, :a:, and : 271 | ;; if necessary. 272 | (while (> i 0) 273 | (setq scope ":") 274 | (setq j (1- i)) 275 | (while (> j 0) 276 | ;; This is where the original scope is widened, 277 | ;; e.g. :a:b:c: becomes :a:b:, which can become :a: 278 | ;; and so on. 279 | (setq scope (concat ":" (nth j scopes) scope)) 280 | (setq j (1- j))) 281 | (setq match (fortran-tags-shell-command 282 | (concat "LC_ALL=C grep -F -m 1 \" " 283 | WORD " " scope " \" " fortran-tags-path))) 284 | (if (not (string= "" match)) 285 | (let ((words (split-string match))) 286 | (goto-new-position 287 | (nth 0 words) (nth 4 words) (nth 5 words)) 288 | (throw 'found nil))) 289 | (setq i (1- i))))) 290 | ;; If no match was found, go through all the definitions with the 291 | ;; module scope. 292 | (setq match (split-string 293 | (fortran-tags-shell-command 294 | (concat "LC_ALL=C grep -F \" 0 " WORD " :\" " 295 | fortran-tags-path)) "\n")) 296 | (if (not (string= "" (nth 0 match))) 297 | (progn 298 | (dolist (line (delete "" match)) 299 | (let ((words (split-string line))) 300 | (setq alt-positions 301 | (append alt-positions (list (list 302 | (nth 0 words) 303 | (nth 4 words) 304 | (nth 5 words))))))) 305 | (setq alt-positions-counter 0) 306 | (fortran-goto-next) 307 | (message (concat (number-to-string 308 | (length alt-positions)) " found")) 309 | (throw 'found nil))) 310 | (message "Definition not found")))) 311 | 312 | (defun fortran-pop-tag-mark () 313 | "Return to the previous location." 314 | (interactive) 315 | (if fortran-buffers (progn 316 | (switch-to-buffer (pop fortran-buffers)) 317 | (goto-char (pop fortran-positions))))) 318 | 319 | (defun fortran-goto-next () 320 | "If alt-positions is not empty, go to the next position. 321 | 322 | Otherwise, force 'fortran-find-tag' to search only through module 323 | level variables." 324 | (interactive) 325 | (unless (boundp 'alt-positions) (setq alt-positions (list))) 326 | (if (not alt-positions) (fortran-find-tag t) 327 | (let ((x (nth alt-positions-counter alt-positions))) 328 | (goto-new-position (nth 0 x) (nth 1 x) (nth 2 x)) 329 | (setq alt-positions-counter (1+ alt-positions-counter)) 330 | (when (= alt-positions-counter (length alt-positions)) 331 | (setq alt-positions-counter 0))))) 332 | 333 | (defun fortran-find-proc-calls (&optional fast-search) 334 | "Find calls to procedure (using special regex if FAST-SEARCH). 335 | 336 | Find all calls to the Fortran procedure under cursor. If found, 337 | alt-positions is populated with the corresponding positions that 338 | can be cycled through with fortran-goto-next. Default is to use a 339 | general regex, while fast-search determines a specialized regex 340 | for subroutines or functions." 341 | (interactive) 342 | (fortran-tags-initialize) 343 | (let ((WORD (fortran-word-at-point)) 344 | (match "") 345 | (src-file-paths 346 | (fortran-tags-shell-command 347 | (concat 348 | "head -n 2 " fortran-tags-path " | tail -n 1 | xargs echo -n")))) 349 | (unless (string= WORD "") 350 | (cond 351 | ((string= "subroutine" fast-search) 352 | (setq match 353 | (fortran-tags-shell-command 354 | (concat "LC_ALL=C egrep -Hn \"^ *call " WORD 355 | " *([(&]|$)\" " src-file-paths " | cut -f1,2 -d:")))) 356 | ((string= "function" fast-search) 357 | (setq match 358 | (fortran-tags-shell-command 359 | (concat "LC_ALL=C egrep -Hn \"[=+/*(&\-] *" WORD 360 | " *[(&]\" " src-file-paths " | cut -f1,2 -d:")))) 361 | ((string= "type-bound" fast-search) 362 | (setq match 363 | (fortran-tags-shell-command 364 | (concat "LC_ALL=C egrep -Hn \"%" WORD 365 | " *[(&]\" " src-file-paths " | cut -f1,2 -d:")))) 366 | (t 367 | (setq match 368 | (concat 369 | (fortran-tags-shell-command 370 | (concat "LC_ALL=C egrep -Hni \"(^|[;&]) *call +" WORD 371 | " *([(&;\!]|$)\" " src-file-paths " | cut -f1,2 -d:")) 372 | (fortran-tags-shell-command 373 | (concat "LC_ALL=C egrep -Hni \"([=+/*(%%&\-]|^) *" WORD 374 | " *[(&]\" " src-file-paths " | cut -f1,2 -d:"))))))) 375 | (when (string-match-p (regexp-quote "No such file or directory") match) 376 | (error "A file that was previously present seems to be 377 | missing. Try regenerating the tags file")) 378 | (if (not (string= "" match)) 379 | (let ((matches (delete "" (split-string match "\n"))) (files "") 380 | (num-files "")) 381 | (setq alt-positions (list)) 382 | (setq alt-positions-counter 0) 383 | (setq num-files (number-to-string (length matches))) 384 | (dolist (line matches) 385 | (let ((pieces (split-string line ":"))) 386 | (setq alt-positions 387 | (append alt-positions 388 | (list (list (nth 0 pieces) (nth 1 pieces) "0")))))) 389 | (let ((i 0) tmp) 390 | (while (< i (length matches)) 391 | (setq tmp (nth 0 (split-string (nth i matches) ":"))) 392 | (setcar (nthcdr i matches) (concat (file-name-base tmp) "." 393 | (file-name-extension tmp))) 394 | (setq i (1+ i)))) 395 | (setq matches (delete-dups matches)) 396 | (dolist (x matches) 397 | (if (not (string= "" files)) 398 | (setq files (concat files ", " x)) 399 | (setq files x)) 400 | (message x)) 401 | (message (concat num-files " found (" files ")"))) 402 | (message "Not found")))) 403 | 404 | (defun fortran-find-proc-calls-sub() 405 | "Search only for subroutine calls." 406 | (interactive) 407 | (fortran-find-proc-calls "subroutine")) 408 | 409 | (defun fortran-find-proc-calls-func() 410 | "Search only for function calls. 411 | 412 | Type-bound procedures are excluded from the search." 413 | (interactive) 414 | (fortran-find-proc-calls "function")) 415 | 416 | (defun fortran-find-proc-calls-type() 417 | "Search only for calls to a type-bound procedure." 418 | (interactive) 419 | (fortran-find-proc-calls "type-bound")) 420 | 421 | (defun fortran-procedures-in-buffer() 422 | "List all subroutines and functions of this buffer." 423 | (interactive) 424 | (save-excursion 425 | (goto-line 0) 426 | (let ((endproc-regex "^ *end +\\(subroutine\\|function\\)") 427 | (begin-regex "\\(^\\| *\\)\\(subroutine\\|function\\) +\\") 428 | (end-regex " *\\(\(\\|&\\)")) 429 | (setq matches (list)) 430 | (while (re-search-forward endproc-regex nil t) 431 | (setq matches 432 | (append matches 433 | (list 434 | (replace-regexp-in-string 435 | endproc-regex "" (thing-at-point 'line t)))))) 436 | ;; Replace newlines with '|' symbols for the regexp 437 | (setq procedures 438 | (replace-regexp-in-string "\n" "\\\\|" (format "%s" matches))) 439 | (setq procedures 440 | (replace-regexp-in-string "\\\\|)" "\\\\)" procedures)) 441 | ;; Remove all spaces 442 | (setq procedures (replace-regexp-in-string " " "" procedures)) 443 | ;; Add beginning and end parts of the regexp 444 | (setq procedures (concat begin-regex procedures)) 445 | (setq procedures (concat procedures end-regex)) 446 | (occur procedures)))) 447 | 448 | (define-minor-mode fortran-tags-mode 449 | "Minor mode providing functions for Fortran source code indexing." 450 | :lighter " FT" 451 | :keymap (let ((map (make-sparse-keymap))) 452 | (define-key map (kbd "M-.") 'fortran-find-tag) 453 | (define-key map (kbd "M-*") 'fortran-pop-tag-mark) 454 | (define-key map (kbd "M-n") 'fortran-goto-next) 455 | (define-key map (kbd "M-s g") 'fortran-find-proc-calls) 456 | (define-key map (kbd "M-s s") 'fortran-find-proc-calls-sub) 457 | (define-key map (kbd "M-s f") 'fortran-find-proc-calls-func) 458 | (define-key map (kbd "M-s t") 'fortran-find-proc-calls-type) 459 | (define-key map (kbd "M-s d") 'fortran-procedures-in-buffer) 460 | map)) 461 | 462 | (add-hook 'f90-mode-hook 'fortran-tags-mode) 463 | 464 | (provide 'fortran-tags) 465 | 466 | ;;; fortran-tags.el ends here 467 | -------------------------------------------------------------------------------- /fortran-tags.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """Main driver for processing Fortran source code. 3 | 4 | The primary function in this file is process_input, which serves two 5 | purposes: 6 | 1) Generate a tags file. Determine the scope and position of every 7 | variable and procedure. Once the initial tags file has been 8 | generated, subsequent calls produce only minimal changes and it is 9 | thus cheap to repeatedly call this function. 10 | 2) Find the current scope. In this mode, the definition finding parts 11 | are turned off. It is invoked from fortran-find-scope in 12 | fortran-tags.el, which provides the buffer contents of a source 13 | file up to the cursor position as input and receives the scope at 14 | that position as output. It is only invoked if fortran-find-scope 15 | is unable to find the scope on its own for some reason. 16 | 17 | Format of the tags file 18 | ----------------------- 19 | The first line is the version number, which is required for deleting 20 | and regenerating the tags file in case of version mismatch with 21 | Fortra-tags. The second line contains the paths of all the source 22 | files included in the tags file and is used mainly by 23 | fortran-find-proc-calls. The rest of the lines contain 6 or 7 words, 24 | which have the following meaning: 25 | 1 - Absolute path to the source file 26 | 2 - Scope level is an integer corresponding to the number of colons in 27 | the scope, which has the format :a:b:. As an exception, module 28 | wide variables are defined to have a scope level of 0. This allows 29 | to distinguish them from the local variables of an external 30 | procedure which would otherwise have the same scope. The latter 31 | are never visible to the outside, while the converse is not true 32 | for module wide variables. This definition of the scope level 33 | allows fortran-find-tag to easily grep for the correct variables. 34 | 3 - Variable or procedure name 35 | 4 - Scope of the variable or procedure 36 | 5 - Line number 37 | 6 - Position of the definition on the line 38 | 7 - If present, marks the the number of lines corresponding to a 39 | source file in the tags file, i.e., this many lines can be copied 40 | to the new tags file if the source file is unmodified. 41 | 42 | """ 43 | 44 | __version__ = '1.5.1' 45 | 46 | import argparse 47 | import codecs 48 | import inspect 49 | import os 50 | import re 51 | import sys 52 | 53 | 54 | def clean_string(l): 55 | """Remove strings and comments from the line. 56 | 57 | Since there are two delimiters for the character type that can be 58 | nested, all combinations need to be considered. 59 | 60 | """ 61 | # lock[0] (lock[1]) is True if the previous line didn't have a 62 | # matching single (double) quote 63 | global lock 64 | char_symbol = ["'", '"'] 65 | str_length = len(l) 66 | # If x (x being ', ", or !) is not in l, we define its position to 67 | # be at str_length. 68 | pos_c = l.find('!') if '!' in l else str_length 69 | pos_s = [0, 0] 70 | for i in -1, 0: 71 | pos_s[i] = (l.find(char_symbol[i]) if char_symbol[i] in l 72 | else str_length) 73 | for i in -1, 0: 74 | if lock[i]: 75 | if pos_s[i] < str_length: 76 | lock[i] = False 77 | return clean_string(l[pos_s[i]+1:]) 78 | else: 79 | return '' 80 | if pos_c == str_length and pos_s[0] == str_length and (pos_s[1] == 81 | str_length): 82 | return l 83 | if pos_c < pos_s[0] and pos_c < pos_s[1]: 84 | return l[0:pos_c] 85 | for i in -1, 0: 86 | if pos_s[i] < pos_s[i+1]: 87 | l0 = l[pos_s[i]+1:] 88 | if char_symbol[i] in l0: 89 | return clean_string(l[0:pos_s[i]] + 90 | l[pos_s[i]+l0.find(char_symbol[i])+2:]) 91 | else: 92 | lock[i] = True 93 | return l[:pos_s[i]] 94 | 95 | 96 | def process_input(input_text, find_definitions, TAGS='', filepath=''): 97 | """Find definitions and their scopes. 98 | 99 | If not find_definitions, then only find the scopes. 100 | """ 101 | # Rename filepath! 102 | # Remove find_definitions; use if TAGS instead! 103 | # Rename TAGS! 104 | # In fact, rename most variables! 105 | global lock 106 | # Current scope 107 | global scope 108 | # Whether the current line is a continuation of a 1) variable definition, 109 | cont_var = False 110 | # 2) renaming, 111 | cont_rename = False 112 | # 3) function definition, 113 | cont_func = False 114 | # 4) any other line. 115 | cont_line = False 116 | # Whether we are currently inside a type definition. Variable 117 | # definitions inside a type definition are ignored. 118 | in_type = False 119 | # Same but with interfaces. 120 | in_interface = False 121 | # True if there haven't been any definitions with the present 122 | # scope so far. 123 | scope_unused = True 124 | # Wether we are currently inside a module. This helps to set the 125 | # scope level of module wide variables to 0 as explained above. 126 | in_mod = False 127 | # Initialize clean_string 128 | lock = [False, False] 129 | scope = ':' 130 | scope_count = 1 131 | line_nr = 0 132 | for line_raw in input_text: 133 | line_nr += 1 134 | if line_raw.lstrip().startswith('#'): 135 | continue 136 | line_raw = line_raw.lower() 137 | line = clean_string(line_raw).strip() 138 | if not line: 139 | continue 140 | if cont_line: 141 | cont_line = line.endswith('&') 142 | continue 143 | if find_definitions and not in_type and not in_interface: 144 | # PART 1 - variables, renamings, operator overloading 145 | exceptions = 'real[*]8|complex[*]16|' 146 | m = re.match('(('+exceptions+'real|integer|logical|character|' 147 | 'complex|class|enumerator|external)' 148 | r'[ ,([:]|type *\()', line) 149 | if (m and ' function ' not in line) or cont_var: 150 | # In the following, 'names' contains all the variables 151 | # found on the current line. 152 | if cont_var: 153 | for symbol in ('&', ','): 154 | # Cannot use startswith(('&', ',')) here! 155 | if line.startswith(symbol): 156 | line = line[1:].lstrip() 157 | if line.startswith(('/', '*', '-', '+')): 158 | cont_var = False 159 | continue 160 | names = line.split(',') 161 | elif '::' in line: 162 | names = line[line.find('::')+2:].split(',') 163 | else: 164 | # Any of the following has happened at this point: 165 | # 1) old style was used (no :: on the line); 2) a 166 | # keyword was used as a variable; 3) a keyword was 167 | # used as a built-in function (e.g., 168 | # real(1,8)). In any case, this is slow. 169 | if m.group()[-1] == '(': 170 | line = line[m.end()-1:].lstrip() 171 | else: 172 | line = line[m.end():].lstrip() 173 | if line.startswith('('): 174 | shift = 1 175 | while shift < len(line) and (line[:shift].count('(') != 176 | line[:shift].count(')')): 177 | shift += 1 178 | if shift == len(line): 179 | continue 180 | line = line[shift:].lstrip() 181 | if not line: 182 | continue 183 | if line.startswith(('=', '/', '.', '*', 184 | '-', '+', ')', ']')): 185 | continue 186 | names = line.split(',') 187 | i_name = 0 188 | while i_name < len(names): 189 | # Since names are separated by splitting the line 190 | # at commas, special care needs to be taken 191 | # against multi-dimensional arrays and coarrays. 192 | name = names[i_name] 193 | while name.count('(') > name.count(')') or ( 194 | name.count('[') > name.count(']')): 195 | i_name += 1 196 | if i_name == len(names): 197 | break 198 | # The name is pieced back together 199 | name += f',{names[i_name]}' 200 | for symbol in ('(', '=', '[', '*'): 201 | if symbol in name: 202 | if '&' in name and name.rstrip()[-1] == '&': 203 | # If the next line continues with the 204 | # initialization of the current 205 | # variable, don't follow the 206 | # continuation. 207 | line = line.rstrip()[:-1] 208 | name = name[:name.find(symbol)] 209 | name = name.strip() 210 | if name != '&': 211 | # If the current scope is ':' and we are 212 | # looking at a variable declaration, it means 213 | # we are in the program construct but the 214 | # beginning 'program' keyword is missing. In 215 | # this case set scope to 216 | # :fortags_program_scope: manually. 217 | if scope_count == 1: 218 | scope = ':fortags_program_scope:' 219 | scope_count = 2 220 | r = '([ ,:&\t)]|^)' + name + r'([ ,(\[=!\*\t]|$)' 221 | m = re.search(r, line_raw) 222 | position = int((m.start()+m.end())/2) 223 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 224 | f'{line_nr} {position}\n') 225 | scope_unused = False 226 | i_name += 1 227 | cont_var = line.rstrip()[-1] == '&' 228 | continue 229 | if ('=>' in line and ( 230 | ('use' in line and line.startswith(('use ', 'use,'))) or 231 | ('associate' in line and 232 | line.startswith(('associate ', 'associate('))))) or ( 233 | cont_rename): 234 | # Same comment as above with variable declarations 235 | if scope_count == 1: 236 | scope = ':fortags_program_scope:' 237 | scope_count = 2 238 | # Renamings count as new definitions. 239 | if (line.startswith(('associate ', 'associate('))): 240 | scope += 'fortags_associate_construct:' 241 | scope_count = scope.count(':') 242 | names = line.split('=>') 243 | for i in range(len(names)-1): 244 | name = names[i].split()[-1] 245 | for symbol in ('(', ',', '&'): 246 | if symbol in name: 247 | name = name[name.find(symbol)+1:] 248 | name = name.strip() 249 | m = re.search('([ ,(&]|^)'+name+'[ =]', line_raw) 250 | position = str(int((m.start()+m.end())/2)) 251 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 252 | f'{line_nr} {position}\n') 253 | scope_unused = False 254 | cont_rename = line.rstrip()[-1] == '&' 255 | continue 256 | if re.match('interface +(?!(operator|assignment|$))', line): 257 | # Operator overloading also counts as a new definition. 258 | if scope_count == 1: 259 | # Same comment as above with variable declarations. 260 | scope = ':fortags_program_scope:' 261 | scope_count = 2 262 | name = line.split(None, 2)[1] 263 | m = re.search(' '+name+'([ !]|$)', line_raw) 264 | position = int((m.start()+m.end())/2) 265 | TAGS.append(f'{filepath} 0 {name} {scope} {line_nr} {position}' 266 | '\n') 267 | scope_unused = False 268 | continue 269 | # Treat procedure renamings inside a type definition 270 | # separately. 271 | if in_type and '=>' in line: 272 | # Exclude pointer initializations 273 | if re.search(',[ ]*pointer[ ]*( |[ ]*::)', line): 274 | continue 275 | # Exclude operator(...) type overloading. 276 | if ')' in line: 277 | continue 278 | name = line.split('=>', 1)[0].rstrip() 279 | if '::' in name: 280 | name = name.split('::', 1)[1] 281 | if ' ' in name: 282 | name = name.rsplit(' ', 1)[1] 283 | m = re.search('( |[ ]*::)'+name+'[ ]*=>', line_raw) 284 | # If the search failed, there was something weird in the 285 | # source code (maybe a preprocessor macro that 286 | # Fortran-tags couldn't handle). 287 | if m is None: 288 | continue 289 | position = int((m.start()+m.end())/2) 290 | TAGS.append(f'{filepath} 0 {name} {scope} {line_nr} {position}' 291 | '\n') 292 | scope_unused = False 293 | continue 294 | # PART 2 - scope delocalization 295 | if ( 296 | line.startswith('end interface') and 297 | line.rstrip() == 'end interface' or 298 | line.startswith('endinterface') and 299 | line.rstrip() == 'endinterface'): 300 | in_interface = False 301 | continue 302 | if in_interface: 303 | continue 304 | if line.startswith('end '): 305 | if re.match('end +(subroutine|function|type|associate|block|' 306 | 'module|program)', line): 307 | # Decrease scope level by one or signal that we are 308 | # longer inside a type definition. 309 | if in_type: 310 | in_type = False 311 | elif in_interface: 312 | in_interface = False 313 | else: 314 | if find_definitions and scope_unused: 315 | # If the current procedure doesn't contain any 316 | # dummy or local variables, then add the 317 | # following line to the tags file to signal 318 | # that such scope still exists even though it 319 | # is empty of declarations. This ensures not 320 | # to confuse the Elisp function 321 | # fortran-find-scope. 322 | TAGS.append(f'{filepath} {scope} \n') 323 | scope_unused = False 324 | scope = scope[0:scope[0:len(scope)-1].rfind(':')+1] 325 | s = scope.count(':') 326 | scope_count = 0 if s == 2 and in_mod else s 327 | if scope_count == 1: 328 | in_mod = False 329 | continue 330 | if line.startswith('end') and (re.match( 331 | '(endsubroutine|endfunction|endassociate|endblock|endmodule|' 332 | 'endprogram) ?', line) or line == 'end'): 333 | if find_definitions and scope_unused: 334 | # Same as above 335 | TAGS.append(f'{filepath} {scope} \n') 336 | scope_unused = False 337 | scope = scope[0:scope[0:len(scope)-1].rfind(':')+1] 338 | s = scope.count(':') 339 | scope_count = 0 if s == 2 and in_mod else s 340 | if scope_count == 1: 341 | in_mod = False 342 | continue 343 | # PART 3 - procedures, modules, type definitions; scope localization 344 | if 'subroutine ' in line: 345 | first_word = line.startswith('subroutine ') 346 | if first_word or ' subroutine ' in line: 347 | if first_word: 348 | name = line.partition('subroutine ')[2] 349 | else: 350 | name = line.partition(' subroutine ')[2] 351 | for symbol in ('(', '&'): 352 | if symbol in name: 353 | name = name[:name.find(symbol)] 354 | name = name.strip() 355 | if find_definitions: 356 | m = re.search(' '+name+'([ (&!]|$)', line_raw) 357 | position = int((m.start()+m.end())/2) 358 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 359 | f'{line_nr} {position}\n') 360 | scope_unused = True 361 | scope += f'{name}:' 362 | s = scope.count(':') 363 | scope_count = 0 if s == 2 and in_mod else s 364 | continue 365 | if 'function ' in line: 366 | first_word = line.partition(' ')[0] == 'function' 367 | if first_word or ' function ' in line: 368 | if first_word: 369 | name = line.partition('function ')[2] 370 | else: 371 | name = line.partition(' function ')[2] 372 | for symbol in ('(', '&'): 373 | if symbol in name: 374 | name = name[:name.find(symbol)] 375 | name = name.strip() 376 | if find_definitions: 377 | m = re.search(' '+name+'([ (&!]|$)', line_raw) 378 | position = int((m.start()+m.end())/2) 379 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 380 | f'{line_nr} {position}\n') 381 | scope_unused = True 382 | scope += f'{name}:' 383 | s = scope.count(':') 384 | scope_count = 0 if s == 2 and in_mod else s 385 | cont_func = find_definitions 386 | if cont_func: 387 | cont_func = line.rstrip()[-1] == '&' 388 | if 'result' in line: 389 | m = re.search('[ )]result[( ]', line) 390 | if m: 391 | name = line.partition(m.group())[2] 392 | if ')' in name: 393 | name = name[:name.find(')')] 394 | if '(' in name: 395 | name = name[name.find('(')+1:] 396 | m = re.search(r'\( *'+name+r' *\)', line_raw) 397 | position = int((m.start()+m.end())/2) 398 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 399 | f'{line_nr} {position}\n') 400 | scope_unused = False 401 | continue 402 | if 'module ' in line and ' procedure ' in line and ( 403 | line.split(None, 2)[0:2] == ['module', 'procedure']): 404 | continue 405 | if 'module ' in line and line.partition(' ')[0] == 'module': 406 | name = line.split(None, 2)[1] 407 | if find_definitions: 408 | m = re.search(' '+name+'([ (&!]|$)', line_raw) 409 | position = int((m.start()+m.end())/2) 410 | TAGS.append(f'{filepath} 1 {name} {scope} {line_nr} {position}' 411 | f'\n') 412 | in_mod = True 413 | scope_unused = True 414 | scope += f'{name}:' 415 | s = scope.count(':') 416 | scope_count = 0 if s == 2 and in_mod else s 417 | continue 418 | if 'program ' in line and line.partition(' ')[0] == 'program': 419 | name = line.split(None, 2)[1] 420 | if find_definitions: 421 | m = re.search(' '+name+'([ (&!]|$)', line_raw) 422 | position = int((m.start()+m.end())/2) 423 | TAGS.append(f'{filepath} 1 {name} {scope} {line_nr} {position}' 424 | '\n') 425 | scope_unused = True 426 | scope += f'{name}:' 427 | s = scope.count(':') 428 | scope_count = 0 if s == 2 and in_mod else s 429 | continue 430 | if line.startswith(('type,', 'type:')) or ( 431 | line.startswith('type ') and not line[5:].lstrip().startswith( 432 | '(')): 433 | # 'type' is special because it can both declare a variable 434 | # and define a new type. 435 | line0 = line[5:].lstrip() 436 | # Ignore 'select type' construct 437 | if line0.startswith('is'): 438 | line0 = line0[2:].lstrip() 439 | if line0.startswith('('): 440 | continue 441 | if find_definitions: 442 | if ':' in line: 443 | name = line[line.find(':')+2:].strip() 444 | else: 445 | name = line.split(None, 2)[1] 446 | m = re.search('[ :]'+name+'([ !]|$)', line_raw) 447 | position = int((m.start()+m.end())/2) 448 | TAGS.append(f'{filepath} {scope_count} {name} {scope} ' 449 | f'{line_nr} {position}\n') 450 | scope_unused = False 451 | in_type = True 452 | continue 453 | if line.startswith('interface') and line.rstrip() == 'interface': 454 | in_interface = True 455 | continue 456 | if line.startswith('block') and line.rstrip() == 'block': 457 | scope += 'fortags_block_construct:' 458 | scope_count = scope.count(':') 459 | continue 460 | # Set cont_line to True if the line ends with an '&'. Note 461 | # that line == '&' is not valid Fortran and what must have 462 | # happened is that a string was removed from the line by 463 | # clean_string, leaving it almost empty. The '&' then marks 464 | # the beginning of a line (not continuation) or it marks the 465 | # continuation of a variable definition. Either way, we shall 466 | # not count it as line continuation. 467 | cont_line = line.endswith('&') and not line == '&' 468 | 469 | 470 | parser = argparse.ArgumentParser() 471 | parser.add_argument('-s', '--find-scope', action='store_true', 472 | help='Return the current scope based on text from ' 473 | 'stdin') 474 | parser.add_argument('-g', '--generate', nargs='+', metavar='FILE', 475 | help='Generate or update the tags file.') 476 | parser.add_argument('-o', '--output', nargs=1, 477 | help='Target file for tags (default: FORTAGS)') 478 | parser.add_argument('-v', '--version', action='version', version=__version__, 479 | help='Print version number') 480 | 481 | if len(sys.argv) < 2: 482 | parser.parse_args('-h'.split()) 483 | else: 484 | args = parser.parse_args() 485 | 486 | if args.find_scope: 487 | input_text = sys.stdin.readlines() 488 | process_input(input_text, False) 489 | print(scope) 490 | 491 | if args.generate: 492 | if args.output: 493 | tags_path = args.output[0] 494 | else: 495 | tags_path = 'FORTAGS' 496 | if os.path.exists(tags_path): 497 | tags_old = open(tags_path).readlines() 498 | input_files = [os.path.abspath(f) for f in args.generate] 499 | TAGS = [] # Work array for tags 500 | untouched = [] # Unmodified source files 501 | # STEP 1 - Scan the old tags file for changes 502 | if os.path.exists(tags_path) and str(tags_old[0]) != __version__+'\n': 503 | sys.stdout.write(f'Deleting {tags_path}, which was created with ' 504 | f'version {tags_old[0]}') 505 | elif os.path.exists(tags_path): 506 | sys.stdout.write(f'Scanning {tags_path} for changes ...') 507 | sys.stdout.flush() 508 | line_nr = 2 509 | while line_nr < len(tags_old): 510 | words = tags_old[line_nr].split() 511 | filename = words[0] 512 | shift = int(words[-1]) 513 | if filename in input_files and (os.path.getctime(filename) < 514 | os.path.getctime(tags_path)): 515 | TAGS.extend(tags_old[line_nr:line_nr+shift]) 516 | untouched.append(filename) 517 | line_nr += shift 518 | # Include unmodified files devoid of any declarations 519 | old_filenames = tags_old[1].split() 520 | for filename in input_files: 521 | if filename in old_filenames and filename not in untouched and (os.path.getctime(filename) < 522 | os.path.getctime(tags_path)): 523 | untouched.append(filename) 524 | sys.stdout.write(f'\rScanning {tags_path} for changes ... done\n') 525 | sys.stdout.flush() 526 | # STEP 2 - Process modified source files 527 | total_size = (sum(os.stat(f).st_size for f in args.generate) - 528 | sum(os.stat(f).st_size for f in untouched)) 529 | current_size = 0 530 | for f in args.generate: 531 | if not os.path.abspath(f) in untouched: 532 | sys.stdout.write('\rProcessing input files ... ' 533 | f'{int(float(current_size)/total_size*100)}%') 534 | sys.stdout.flush() 535 | current_size += os.stat(f).st_size 536 | try: 537 | input_text = open(f, 'r').readlines() 538 | except UnicodeDecodeError: 539 | input_text = codecs.open(f, 'r', encoding='utf-8', 540 | errors='ignore').readlines() 541 | print(f"\rutf-8 codec can't fully decode {f}. " 542 | 'Skipping some characters.') 543 | sys.stdout.write('\rProcessing input files ... ' 544 | f'{int(float(current_size)/total_size*100)}%') 545 | try: 546 | process_input(input_text, True, TAGS, os.path.abspath(f)) 547 | except AttributeError as e: 548 | line_raw = inspect.trace()[-1][0].f_locals['line_raw'] 549 | line_nr = inspect.trace()[-1][0].f_locals['line_nr'] 550 | print(f'\nError on line {os.path.abspath(f)}:{line_nr}:') 551 | print(line_raw) 552 | print(f'AttributeError: {e}') 553 | print('If you consider this a bug, please report at') 554 | print('https://github.com/raullaasner/fortran-tags/issues') 555 | raise 556 | n_processed = len(args.generate) - len(untouched) 557 | sys.stdout.write(f'\rProcessing input files ... done ({n_processed} ' 558 | f'file{"s" if n_processed != 1 else ""})\n') 559 | sys.stdout.flush() 560 | # STEP 3 - Write data to file 561 | TAGS.sort() 562 | line_nr = 0 563 | while line_nr < len(TAGS): 564 | # Add size specifiers to certain lines (see the format of the 565 | # tags file). 566 | tmp = line_nr 567 | filename = TAGS[line_nr].partition(' ')[0] 568 | while TAGS[line_nr].startswith(filename): 569 | line_nr += 1 570 | if line_nr == len(TAGS): 571 | break 572 | if filename not in untouched: 573 | TAGS[tmp] = f'{TAGS[tmp][0:-1]} {line_nr-tmp}\n' 574 | with open(tags_path, 'w') as tags_file: 575 | tags_file.write(f'{__version__}\n') 576 | tags_file.writelines(os.path.abspath(f)+' ' for f in args.generate) 577 | tags_file.write('\n') 578 | tags_file.writelines(TAGS) 579 | --------------------------------------------------------------------------------