Vi-QuickFix-1.135/000755 000765 000024 00000000000 13153557334 013731 5ustar00annostaff000000 000000 Vi-QuickFix-1.135/Changes000644 000765 000024 00000005614 13153554615 015231 0ustar00annostaff000000 000000 Revision history for Perl module Vi::QuickFix Revision 1.101 Fri Mar 12 22:56:37 2004 - original version; created by ExtUtils::ModuleMaker 0.32 rel_1_110 Mon Mar 15 19:58:49 CET 2004 - first release rel_1_114 Fri Mar 19 18:47:41 CET 2004 - bugfix in message-recognizing regex - give warning except in silent mode, erase empty error file - pod revised, README added - second release rel_1_116 Sat Mar 20 12:49:38 CET 2004 - work around bug in perl 5.8.0 (goto label not found) (compare testers result FAIL Vi-QuickFix-1.114 i586-linux 2.4.22-4tr) Sun Mar 21 23:26:28 CET 2004 - Bad tests on 5.8.0 and earlier show that tied STDOUT isn't respected by all system messages. Vi-QuickFix-1_121 Sun May 9 00:17:32 CEST 2004 - The fix (use %SIG when tie doesn't work) results in a major re-write. Added doc chapters IMPLEMENTATION and CONFLICTS to the pod. Vi-QuickFix-1_122 Thu Jul 29 19:45:18 CEST 2004 - Doc changes: Now describing ":cf" instead of "vi -q". - Another reason for a re-release with little change is that spurious failed tests have come back from CPAN testers. (The target machine(s) failed to load a standard module.) The re-release will hopefully heal that. Sun Oct 3 18:32:01 CEST 2004 - Added pid check to END{} block, so forked kids don't execute it Thu Oct 28 18:21:57 CEST 2004 - Cleaned up a messy bit in Vi::QuickFix::Destructor::DESTROY when run under -c, added tests Sat Jan 8 22:04:05 CET 2005 - Cleaned up failing tests under Win32 (thanks to rjbs) Sun Jan 9 16:22:40 CET 2005 - added environment dependency on VI_QUICKFIX_SOURCEFILE - cleaned up (removed) ca 30 spurious "open" tests Vi-QuickFix-1_129 Tue Jan 11 12:48:55 CET 2005 - fixed bug concerning "perl -MVi::QuickFix source" when source also has "use Vi::QuickFix" (there was some double processing) - released Vi-QuickFix-1_132 Tue Jan 1 02:51:29 CET 2008 - Fixed bugs that came up with different warnings processing in 5.10.0 - Added eval-detection in sig mode - Made error file handle autoflushing - Fixed obligatory message so invocation is correctly identified Thu Jan 3 03:07:41 CET 2008 - Parsing of ambigous message texts, with existence test - Added fork mode (experimental, tests fail intermittently) Sat Jan 5 04:23:34 CET 2008 - released Vi-QuickFix-1_133 Sat Jan 5 18:36:06 CET 2008 - removed test in fork mode - released Vi_QuickFix_1_134 Sun Jan 6 23:56:31 CET 2008 - fixed a rather embarrassing mistake in t/001_basic. Calling $^X now instead of 'perl'. That would account for "mysterious" fails with cpan testers. - released Vi_QuickFix_1_135 Tue Sep 5 18:48:37 CEST 2017 - work around bug in Tie::Stdhandle::BINMODE Vi-QuickFix-1.135/lib/000755 000765 000024 00000000000 13153557334 014477 5ustar00annostaff000000 000000 Vi-QuickFix-1.135/LICENSE000644 000765 000024 00000050101 10024447464 014727 0ustar00annostaff000000 000000 Terms of Perl itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --------------------------------------------------------------------------- The General Public License (GPL) Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS --------------------------------------------------------------------------- The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Vi-QuickFix-1.135/Makefile.PL000644 000765 000024 00000000730 10170747161 015676 0ustar00annostaff000000 000000 use 5.008_000; use ExtUtils::MakeMaker; # See lib/ExtUtils/MakeMaker.pm for details of how to influence # the contents of the Makefile that is written. WriteMakefile( NAME => 'Vi::QuickFix', VERSION_FROM => 'lib/Vi/QuickFix.pm', # finds $VERSION AUTHOR => 'Anno Siegel (siegel@zrz.tu-berlin.de)', ABSTRACT => 'Support for vim\'s QuickFix mode', PREREQ_PM => { 'Test::Simple' => 0.44, }, ); Vi-QuickFix-1.135/MANIFEST000644 000765 000024 00000000364 13153557334 015065 0ustar00annostaff000000 000000 MANIFEST LICENSE README Todo Changes lib/Vi/QuickFix.pm t/001_basic.t Makefile.PL META.yml Module meta-data (added by MakeMaker) META.json Module JSON meta-data (added by MakeMaker) Vi-QuickFix-1.135/META.json000644 000765 000024 00000001670 13153557334 015356 0ustar00annostaff000000 000000 { "abstract" : "Support for vim's QuickFix mode", "author" : [ "Anno Siegel (siegel@zrz.tu-berlin.de)" ], "dynamic_config" : 1, "generated_by" : "ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.150010", "license" : [ "unknown" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Vi-QuickFix", "no_index" : { "directory" : [ "t", "inc" ] }, "prereqs" : { "build" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "runtime" : { "requires" : { "Test::Simple" : "0.44" } } }, "release_status" : "stable", "version" : "1.135", "x_serialization_backend" : "JSON::PP version 2.27400_02" } Vi-QuickFix-1.135/META.yml000644 000765 000024 00000001074 13153557334 015204 0ustar00annostaff000000 000000 --- abstract: "Support for vim's QuickFix mode" author: - 'Anno Siegel (siegel@zrz.tu-berlin.de)' build_requires: ExtUtils::MakeMaker: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 1 generated_by: 'ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.150010' license: unknown meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Vi-QuickFix no_index: directory: - t - inc requires: Test::Simple: '0.44' version: '1.135' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Vi-QuickFix-1.135/README000644 000765 000024 00000015316 10740257206 014611 0ustar00annostaff000000 000000 NAME Vi::QuickFix - Support for vim's QuickFix mode SYNOPSIS use Vi::QuickFix; use Vi::QuickFix ; use Vi::QuickFix ; use Vi::QuickFix ; where "" is one or more of "silent", "sig", "tie", and "fork". DESCRIPTION When "Vi::QuickFix" is active, Perl logs errors and warnings to an *error file* named, by default, "errors.err". This file is picked up when you type ":cf" in a running vim editor. Vim will jump to the location of the first error recorded in the error file. ":cn" takes you to the next error, switching files if necessary. There are more QuickFix commands in vim. Type ":help quickfix" for a description. To activate QuickFix support for a Perl source, add use Vi::QuickFix; or, specifying an error file use Vi::QuickFix '/my/errorfile'; early in the main program, before other "use" statements. To leave the program file unaltered, Vi::QuickFix can be invoked from the command line as perl -MVi::QuickFix program or perl -MVi::QuickFix=/my/errorfile program "Vi::QuickFix" is meant to be used as a development tool, not to remain in a distributed product. When the program ends, a warning is issued, indicating that "Vi::QuickFix" was active. This has the side effect that there is always an entry in the error file which points to the source file where "Vi::QuickFix" was invoked, normally the main program. ":cf" will take you there when other error entries don't point it elsewhere. Use the "silent" option with "Vi::QuickFix" to suppress this warning. When the error file cannot be opened, a warning is issued and the program continues running without QuickFix support. If the error file is empty after the run (can only happen with "silent"), it is removed. ENVIRONMENT "Vi::QuickFix" recognizes the environment variable "VI_QUICKFIX_SOURCEFILE" When Perl reads its source from "STDIN", error messages and warnings will contain the string "-" where the source file name would otherwise appear. The environment variable "VI_QUICKFIX_SOURCEFILE" can be set to a filename, which will replace "-" in those messages. If no "-" appears as a file name, setting the variable has no effect. This somewhat peculiar behavior can be useful if you call perl (with "Vi::QuickFix") from within a vim run, as in ":w !perl -MVi::QickFix". When you set the environment variable "VI_QUICKFIX_SOURCEFILE" to the name of the file you are editing, this fools vim into doing the right thing when it encounters the modified messages. This is an experimental feature, the behavior may change in future releases. USAGE The module file .../Vi/QuickFix.pm can also be called as an executable. In that mode, it behaves basically like the "cat" command, but also monitors the stream and logs Perl warnings and error messages to the error file. The error file can be set through the switches "-f" or "-q". No warning about QuickFix activity is issued in this mode. Called with -v, it prints the version and exits. IMPLEMENTATION For a debugging tool, an implementation note is in order. Perl offers three obvious ways to watch and capture its error output. One is through the (pseudo-) signal handlers $SIG{__WARN__} and $SIG{__DIE__}. The other is through "tie"-ing the "STDERR" file handle. A third method involves forking a child process for the capturing and redirect "STDERR" to there. "Vi::QuickFix" can use these three methods to create the error file. As it turns out, the ability to tie "STDERR" is relatively new with Perl, as of version 5.8.1. With Versions 5.8.0 and earlier, a number of internal errors and warnings don't respect tie, so this method cannot be used. With Perl versions ealier than 5.8.1, "Vi::QuickFix" uses %SIG handlers to catch messages. With newer versions, "Vi::Quickfix" ties "STDERR" so that it (additionally) writes to the error file. The forking method can be used with any version of Perl. A specific method can be requested through the options "sig", "tie" and "fork", as in use Vi::QuickFix qw(sig); use Vi::QuickFix qw(tie); use Vi::QuickFix qw(fork); The forking method appears to work well in practice, but a race condition exists that intermittently leads to failing tests. It is not tested in the standard test suite and must be considered experimental. Requesting "tie" with a Perl version that can't handle it is a fatal error, so the only option that does anything useful is "sig" with a new-ish Perl. It can be useful when "tie"-ing "STDERR" conflicts with the surrounding code. CONFLICTS Similar conflicts can occur with the "sig" method as well, and it can happen in two ways. Either "Vi::QuickFix" already finds a resource (a %SIG handler or a tie on "STDERR") occupied at "use" time, or the surrounding code commandeers the resource after the fact. However, if "STDERR" is already tied when "Vi::QuickFix" is "use"d, it cannot employ the "tie" method, and by default reverts to "sig". If the "tie" method is specifically requested, a fatal error results. If the "sig" method finds one of the handlers ("__WARN__" and "__DIE__") already occupied, it chains to the previous handler after doing its thing, so that is not considered an obstacle. "Chaining" file ties is harder, and has not been attempted. If "Vi::QuickFix" is already active, the surrounding code may later occupy a resource it is using. There is little that can be done when that happens, except issue a warning which is also logged to the error file. This can help in finding the source of the conflict. In "silent" mode, no such warning is given. The warning is triggered when the corresponding resource is overwritten, except when the overwriting program keeps a copy of it. It is then assumed that the program will keep it functioning. Since we're still talking implementation -- it is actually triggered through a DESTROY method when the corresponding object goes out of scope. %SIG handlers are code objects just for this reason. VERSION This document pertains to "Vi::Quickfix" version 1.134 BUGS "no Vi::QuickFix" has no effect AUTHOR Anno Siegel CPAN ID: ANNO siegel@zrz.tu-berlin.de http://www.tu-berlin.de/~siegel COPYRIGHT This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. SEE ALSO perl(1), vim(1). Vi-QuickFix-1.135/t/000755 000765 000024 00000000000 13153557334 014174 5ustar00annostaff000000 000000 Vi-QuickFix-1.135/Todo000644 000765 000024 00000000462 10736446500 014557 0ustar00annostaff000000 000000 TODO list for Perl module Vi::QuickFix Fri Aug 12 01:22:04 CEST 2005 don't die if error file can't be created (run without quickfix) done Tue Jan 1 06:31:56 CET 2008 Tue Jan 1 05:51:13 CET 2008 run tests with relevant earlier versions of perl (dependency on warnings) done Tue Jan 1 15:24:42 CET 2008 Vi-QuickFix-1.135/t/001_basic.t000644 000765 000024 00000024040 10740256167 016021 0ustar00annostaff000000 000000 # -*- perl -*- use strict; use warnings; use Test::More; my $n_tests; use constant DEVNULL => $^O eq 'MSWin32' ? 'NUL' : '/dev/null'; use constant REDIRECT => '>' . DEVNULL . ' 2>' . DEVNULL; use constant Q_REDIRECT => '" ' . REDIRECT; use constant ERR_TXT => ( 'boo', 'bah'); use constant ERRFILE => { mine => 'my_errors', std => 'errors.err', }; # number of tests per call of run_tests() use constant PER_CALL => @{ [ ERR_TXT]}; BEGIN { $n_tests += 2 * PER_CALL } {{ my $command = qq($^X -Ilib -e"); $command .= qq(use Vi::QuickFix;); $command .= qq( warn qq($_); print STDERR qq(# something else\\n);) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_use', 'std', $command); $command = qq($^X -Ilib -MVi::QuickFix -e"); $command .= qq( warn qq($_);) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_switch', 'std', $command); }} BEGIN { $n_tests += 2 * PER_CALL } {{ my $command = qq($^X -Ilib -MVi::QuickFix=*ERRFILE* -e"); $command .= qq(warn qq($_); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_switch', 'mine', $command); $command = qq($^X -Ilib -e"); $command .= qq(use Vi::QuickFix "*ERRFILE*"; ); $command .= qq(warn qq($_); print STDERR qq(something else\\n); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_use', 'mine', $command); }} ### If $] >= 5.008001, the above has tested "tie" mode, and we now # want to check "sig" mode. If $] < 5.008001, the above has tested # "sig" mode. Since "tie" mode can't be run, we just skip the "sig"- # specific tests use constant LOW_VERSION => $] < 5.008001; use constant REASON_LOW => "already done with perl $]"; BEGIN { $n_tests += 2 * PER_CALL } SKIP: {{ skip REASON_LOW, 2 * PER_CALL if LOW_VERSION; my $command = qq($^X -Ilib -MVi::QuickFix=sig -e"); $command .= qq(warn qq($_); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_switch(sig)', 'std', $command); $command = qq($^X -Ilib -e"); $command .= qq(use Vi::QuickFix qw( sig); ); $command .= qq(warn qq($_); print STDERR qq(# something else\\n); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_use(sig)', 'std', $command); }} BEGIN { $n_tests += 2 * PER_CALL } SKIP: {{ skip REASON_LOW, 2 * PER_CALL if LOW_VERSION; my $command = qq($^X -Ilib -MVi::QuickFix=sig,*ERRFILE* -e"); $command .= qq(warn qq($_); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_switch(sig)', 'mine', $command); $command = qq($^X -Ilib -e"); $command .= qq(use Vi::QuickFix "sig", "*ERRFILE*"; ); $command .= qq(warn qq($_); print STDERR qq(something else\\n); ) for ERR_TXT; $command .= Q_REDIRECT; run_tests( 'module_use(sig)', 'mine', $command); }} ### more non-specific tests (as to sig/warn) # prepare input file for executable (used in two test blocks) open my $infile, '>', 'infile' or die; print $infile "$_ at some_file line 12.\nsomething_else\n" for ERR_TXT; close $infile; BEGIN { $n_tests += 2 * ( PER_CALL + 1) } {{ my $command = qq($^X lib/Vi/QuickFix.pm infile >outfile 2>) . DEVNULL; run_tests( 'command_file', 'std', $command); is( -s 'outfile', -s 'infile', 'input copied to stdout'); $command = qq($^X ./lib/Vi/QuickFix.pm outfile 2>) . DEVNULL; run_tests( 'command_stdin', 'std', $command); is( -s 'outfile', -s 'infile', 'file copied to stdout'); }} BEGIN { $n_tests += 2 + 2 * PER_CALL } {{ # check -v key (version) my $command = qq($^X lib/Vi/QuickFix.pm -v); open my $f, "$command |"; ok( defined $f, "got a handle"); like( scalar <$f>, qr/version *\d+\.\d+/, "-v returns version"); $command = qq($^X lib/Vi/QuickFix.pm -f *ERRFILE* infile) . REDIRECT; run_tests( 'command_file', 'mine', $command); $command = qq($^X lib/Vi/QuickFix.pm -q *ERRFILE* ( [ runtime_warning => '() = qq(a) + 0', 'Argument "a"' ], [ runtime_error => 'my %h = %{ \ 0 }', 'Not a HASH' ], [ compiletime_warning => 'my @y; @y = @y[0]', 'Scalar value' ], [ compiletime_error => '%', 'syntax error' ], [ explicit_warning => 'warn qq(xxx)', 'xxx' ], [ explicit_error => 'die qq(yyy)', 'yyy' ], ); BEGIN { $n_tests += 2*@{ [ CASES]} } {{ for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix -we "$prog" ) . REDIRECT; system $cmd; like( read_errfile(), qr/^.*:\d+:$msg/, "$case message"); } for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix -we "eval '$prog'" ) . REDIRECT; system $cmd; if ( $case =~ /_error$/ ) { $msg = 'QuickFix .* active'; like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case no message"); } else { like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case message"); } } }} # repeat these in "sig" mode, if both modes possible BEGIN { $n_tests += 2*@{ [ CASES]} } SKIP: {{ skip REASON_LOW, scalar 2*@{ [ CASES]} if LOW_VERSION; for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix=sig -we "$prog" ) . REDIRECT; system $cmd; like( read_errfile(), qr/^.*:\d+:$msg/, "$case(sig) message"); } for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix=sig -we "eval '$prog'" ) . REDIRECT; system $cmd; if ( $case =~ /_error$/ ) { $msg = 'QuickFix .* active'; like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case(sig) no message"); } else { like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case(sig) message"); } } }} # repeat these in "fork" mode BEGIN { $n_tests += 2*@{ [ CASES]} } SKIP: {{ skip "'fork' mode currently not testable", 2*@{ [ CASES]}; for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix=fork -we "$prog" ) . REDIRECT; system $cmd; like( read_errfile(), qr/^.*:\d+:$msg/, "$case(fork) message"); } for ( CASES ) { my ( $case, $prog, $msg) = @$_; unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix=fork -we "eval '$prog'" ) . REDIRECT; system $cmd; if ( $case =~ /_error$/ ) { $msg = 'QuickFix .* active'; like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case(fork) no message"); } else { like( read_errfile(), qr/^.*:\d+:$msg/, "eval $case(fork) message"); } } }} BEGIN { $n_tests += 8 } {{ # do we get the obligatory warning? unlink 'errors.err'; my $cmd = qq($^X -Ilib -MVi::QuickFix -we "warn qq(abc)" ) . REDIRECT; system $cmd; like( (read_errfile())[ -1], qr/QuickFix.*active/, "obligatory message found"); # does silent mode work? unlink 'errors.err'; system qq($^X -Ilib -MVi::QuickFix=silent -we 'warn "abc"' ) . REDIRECT; unlike( (read_errfile())[ -1], qr/QuickFix/, "silent mode message not found"); # do we get only one obwarn when we fork? unlink 'errors.err'; system qq($^X -Ilib -MVi::QuickFix -efork ) . REDIRECT; is( scalar( () = read_errfile()), 1, "fork one message"); # do we not get it in exec mode? unlink 'errors.err'; system qq($^X lib/Vi/QuickFix.pm <) . DEVNULL . ' ' . REDIRECT; ok( not( -e 'errors.err'), "no message in exec mode"); # is an empty error file removed (needs silent mode)? system qq($^X -Ilib -MVi::QuickFix -we ';' ) . REDIRECT; # create error file ok( -e 'errors.err', "Error file exists"); system( qq($^X -Ilib -MVi::QuickFix=silent -we";")); ok( not( -e 'errors.err'), "Empty error file erased"); # Does it behave under -c? unlink qw( stderr_out errors.err); system qq($^X -c -Ilib -we"use Vi::QuickFix" 2>stderr_out); is( -s( 'errors.err') || 0, 0, "-c: error file empty"); like( read_errfile( 'stderr_out'), qr/^-e syntax OK/, "-c: -e syntax OK"); unlink qw( stderr_out errors.err); }} ### environment variable VI_QUICKFIX_SOURCEFILE BEGIN { $n_tests += 2 } {{ my $cmd = qq($^X -Ilib -MVi::QuickFix ) . REDIRECT; delete $ENV{ VI_QUICKFIX_SOURCEFILE}; open my $p, '|-', $cmd; print $p 'warn "boo"'; close $p; like ( read_errfile(), qr/^-:/, 'env-var unset, found "-"'); $ENV{ VI_QUICKFIX_SOURCEFILE} = 'somefile.pl'; open $p, '|-', $cmd; print $p 'warn "boo"'; close $p; like ( read_errfile(), qr/^$ENV{ VI_QUICKFIX_SOURCEFILE}:/, "env-var set, found filename"); }} # error behavior BEGIN { $n_tests += 5 } {{ # unable to create error file require Vi::QuickFix; local $SIG{__WARN__} = sub { die @_ }; eval { Vi::QuickFix->import( 'tie', 'gibsnich/wirdnix') }; like( $@, qr/Can't create error file/, "Warning without error file"); SKIP: { skip "Can't be tested with perl $]", 3 if LOW_VERSION; # refuse to re-tie STDERR require Tie::Handle; tie *STDERR, 'Tie::StdHandle', '>&STDERR'; require Vi::QuickFix; eval { Vi::QuickFix->import( 'tie') }; like( $@, qr/STDERR already tied/, "Refused to re-tie"); untie *STDERR; # accept second use (no action then) Vi::QuickFix->import( 'tie', 'silent'); ok( tied *STDERR, 'Second use: STDERR is tied'); eval { Vi::QuickFix->import('tie') }; like( $@, qr/^$/, 'Second use no error'); untie *STDERR; } # reject "tie" mode on low version SKIP: { skip "irrelevant with perl $]", 1 unless LOW_VERSION; # make silent, so test doesn't warn eval { Vi::QuickFix->import( 'tie', 'silent') }; like( $@, qr/^Cannot use 'tie'/, 'Reject tie mode'); } }} BEGIN { plan tests => $n_tests } ##################################################################### sub run_tests { my ( $call, $errf, $command) = @_; my $errfile = ERRFILE->{ $errf}; $command =~ s/\*ERRFILE\*/$errfile/g; unlink $errfile; system( $command); # don't forget PER_CALL when uncommenting # ok( -s $errfile, "$call $errf size"); my @lines = read_errfile( $errfile); my $i; for ( ERR_TXT ) { $i ++; my $line = shift @lines; like( $line, qr/^(.*?):\d+:$_$/, "$call $errf $i"); } unlink $errfile; } sub read_errfile { my $file = shift || 'errors.err'; open my( $e), '<', $file or return '-'; return join '', <$e> unless wantarray; return <$e>; } Vi-QuickFix-1.135/lib/Vi/000755 000765 000024 00000000000 13153557334 015055 5ustar00annostaff000000 000000 Vi-QuickFix-1.135/lib/Vi/QuickFix.pm000644 000765 000024 00000034521 13153556316 017142 0ustar00annostaff000000 000000 #!/usr/bin/perl package Vi::QuickFix; use 5.008_000; use strict; use warnings; # use Carp; our $VERSION; BEGIN { $VERSION = ('$Revision: 1.135 $' =~ /(\d+.\d+)/)[ 0]; } unless ( caller ) { # process <> if called as an executable exec_mode(1); # signal fact ( to END processing) require Getopt::Std; Getopt::Std::getopts( 'q:f:v', \ my %opt); print "$0 version $VERSION\n" and exit 0 if $opt{ v}; err_open( $opt{ q} || $opt{ f}); print && err_out( $_) while <>; exit; } ########################################################################### # keywords for ->import use constant KEYWORDS => qw(silent sig tie fork); # environment variable(s) use constant VAR_SOURCEFILE => 'VI_QUICKFIX_SOURCEFILE'; BEGIN {{ # space for private variables my $relay = ''; # method of transfer to error file: "sig" or "tie" my %invocation; # from where was import() called? sub import { my $class = shift; my %keywords; @keywords{ KEYWORDS()} = (); $keywords{ shift()} = 1 while @_ and exists $keywords{ $_[ 0]}; my $filename = shift; make_silent() if $keywords{ silent}; my ( $wanted_relay) = grep $keywords{ $_}, qw( sig tie fork); $relay = $wanted_relay || default_relay(); if ( my $reason = relay_obstacle( $relay) ) { croak( "Cannot use '$relay' method: $reason"); } err_open($filename) unless $relay eq 'fork'; # happens in background if ( $relay eq 'tie' ) { # if tied, it's tied to ourselves (otherwise obstacle) tie *STDERR, 'Vi::QuickFix::Tee', '>&STDERR' unless tied *STDERR; } elsif ( $relay eq 'sig' ) { $SIG{ $_} = Vi::QuickFix::SigHandler->new( $_) for qw( __WARN__ __DIE__); } elsif ( $relay eq 'fork' ) { *STDERR = fork_relay($filename); } # save invocation for obligate message (undef, @invocation{qw(file line)}) = caller; } # internal variables { my $exec_mode; # set if lib file is run as a script sub exec_mode { $exec_mode = shift if @_; $exec_mode; } my $silent = 0; # switch off otherwise obligatory warning sub make_silent { $silent = 1 } sub is_silent { $silent } my $errfile = 'errors.err'; # name of error file my $errhandle; # write formatted errors here # open the given file (or default), set $errfile and $errhandle sub err_open { $errfile = shift || 'errors.err'; $errhandle = IO::File->new( $errfile, '>') or warn( "Can't create error file '$errfile': $!" ); $errhandle->autoflush if $errhandle; } sub err_print { print $errhandle @_ if $errhandle; } sub err_clean { my $unlink = shift; close $errhandle if $errhandle; unlink $errfile if $errfile and $unlink and not -s $errfile; } } sub err_out { # handle multiple, possibly multi-line messages (though usually # there will be only one) for ( map split( /\n+/), @_ ) { my $out; if ( /.+:\d+:/ ) { # already in QuickFix format, pass on err_print("$_\n"); } else { for ( parse_perl_msg($_) ) { my ( $message, $file, $line, $rest) = @$_ or next; $message .= $rest if $rest =~ s/^,//; $file eq '-' and defined and $file = $_ for $ENV{ VAR_SOURCEFILE()}; err_print("$file:$line:$message\n"); } } } } # use constant PERL_MSG => qr/^(.*?) at (.*?) line (\d+)(\.?|,.*)$/; sub parse_perl_msg { my @coll; for ( shift ) { while ( m/ at /g ) { my $text = substr($_, 0, $-[0]); my $pos = pos; while ( m/ line (\d+)(\.?|,.*)$/g ) { my $file = substr($_, $pos, $-[0] - $pos); my $line = $1; my $rest = $2; push @coll, [$text, $file, $line, $rest]; } pos = $pos; } } return @coll if @coll <= 1; my @existing = grep -e $_->[1], @coll; return @existing if @existing; return @coll; } # issue warning, erase error file my $end_entiteled = $$; END { # issue warning (only original process, and not in exec mode) unless ( is_silent or exec_mode() or $$ != $end_entiteled ) { my $invocation_at; if ( %invocation ) { $invocation_at = "at $invocation{file} line $invocation{line}"; } else { $invocation_at = "at -M"; } warn "QuickFix ($relay) active $invocation_at\n"; } # silently remove objects make_silent(); if ( $relay eq 'tie' ) { untie *STDERR; } elsif ( $relay eq 'sig' ) { $SIG{ $_} = 'DEFAULT' for qw( __WARN__ __DIE__); } elsif ( $relay eq 'fork' ) { close STDERR; wait_kid(); } # remove file if created by us and empty err_clean($$ == $end_entiteled); } }} use constant MINVERS => 5.008001; # minimum perl version for tie method sub relay_obstacle { my $relay = shift || ''; return '' unless $relay eq 'tie'; if ( $] < MINVERS ) { return "perl version is $], must be >= @{[ MINVERS]}"; } if ( my $tie_ob = tied *STDERR ) { my $tieclass = ref $tie_ob; return "STDERR already tied to '$tieclass'" unless $tieclass eq 'Vi::QuickFix::Tee'; } return ''; } sub default_relay { relay_obstacle( 'tie') ? 'sig' : 'tie' } { use Carp; my ($read, $write, $kid); sub fork_relay { my $filename = shift; my $parent = $$; pipe $read, $write; if ( $kid = fork ) { # parent close $read; return $write; } else { Carp::croak "Can't fork: $!" unless defined $kid; # kid close $write; err_open($filename); while ( <$read> ) { print STDERR $_; err_out($_); } err_clean(1); exit; } } use POSIX ":sys_wait_h"; sub wait_kid { my $x; do { $x = waitpid -1, WNOHANG } while $x > 0; } } # common destructor method package Vi::QuickFix::Destructor; use Carp qw( shortmess); BEGIN { our @CARP_NOT = qw( Vi::QuickFix) } sub DESTROY { my $ob = shift; return if Vi::QuickFix::is_silent or $^C; # it's a mess under -c my $id = $ob->id; my $msg = shortmess( "QuickFix $id processing interrupted"); # simulate intact QuickFix processing Vi::QuickFix::err_out( $msg); warn "$msg"; } # Class to associate a DESTROY method with sig handlers package Vi::QuickFix::SigHandler; use base qw( Vi::QuickFix::Destructor); # return a chaining handler for __WARN__ or __DIE__ sub new { my $class = shift; my $sig = shift; my $prev_handler = $SIG{ $sig}; my $sub = sub { return $sig unless @_; # backdoor Vi::QuickFix::err_out( @_) unless $sig eq '__DIE__' and _in_eval(); my $code; # resolve string at call time if ( $prev_handler ) { $code = ref $prev_handler ? $prev_handler : \ &{ 'main::' . $prev_handler}; } goto &$code if $code; die @_ if $sig eq '__DIE__'; warn @_; }; bless $sub, $class; # so we can have a destructor } sub _in_eval { my $i = -1; # first call with 0 while ( defined(my $sub = (caller ++ $i)[3]) ) { return 1 if $sub =~ /^\(eval/; } return 0; } sub id { my $handler = shift; $handler->(); # call without args returns __WARN__ or __DIE__ } # tie class to tee re-formatted output to an error file package Vi::QuickFix::Tee; use IO::File; use Tie::Handle; use base qw( Tie::StdHandle Vi::QuickFix::Destructor); sub WRITE { my $fh = shift; my ( $scalar, $length) = @_; Vi::QuickFix::err_out( $scalar); $fh->Tie::StdHandle::WRITE( @_); } # work around buggy BINMODE in Tie::Stdhandle sub BINMODE { binmode($_[0], $_[1]) } sub id { 'STDERR' } 1; __END__ =head1 NAME Vi::QuickFix - Support for vim's QuickFix mode =head1 SYNOPSIS use Vi::QuickFix; use Vi::QuickFix ; use Vi::QuickFix ; use Vi::QuickFix ; where CoptionsE> is one or more of C, C, C, and C. =head1 DESCRIPTION When C is active, Perl logs errors and warnings to an I named, by default, C. This file is picked up when you type C<:cf> in a running vim editor. Vim will jump to the location of the first error recorded in the error file. C<:cn> takes you to the next error, switching files if necessary. There are more QuickFix commands in vim. Type C<:help quickfix> for a description. To activate QuickFix support for a Perl source, add use Vi::QuickFix; or, specifying an error file use Vi::QuickFix '/my/errorfile'; early in the main program, before other C statements. To leave the program file unaltered, Vi::QuickFix can be invoked from the command line as perl -MVi::QuickFix program or perl -MVi::QuickFix=/my/errorfile program C is meant to be used as a development tool, not to remain in a distributed product. When the program ends, a warning is issued, indicating that C was active. This has the side effect that there is always an entry in the error file which points to the source file where C was invoked, normally the main program. C<:cf> will take you there when other error entries don't point it elsewhere. Use the C option with C to suppress this warning. When the error file cannot be opened, a warning is issued and the program continues running without QuickFix support. If the error file is empty after the run (can only happen with C), it is removed. =head1 ENVIRONMENT C recognizes the environment variable C When Perl reads its source from C, error messages and warnings will contain the string "-" where the source file name would otherwise appear. The environment variable C can be set to a filename, which will replace "-" in those messages. If no "-" appears as a file name, setting the variable has no effect. This somewhat peculiar behavior can be useful if you call perl (with C) from within a vim run, as in C<:w !perl -MVi::QickFix>. When you set the environment variable C to the name of the file you are editing, this fools vim into doing the right thing when it encounters the modified messages. This is an experimental feature, the behavior may change in future releases. =head1 USAGE The module file .../Vi/QuickFix.pm can also be called as an executable. In that mode, it behaves basically like the C command, but also monitors the stream and logs Perl warnings and error messages to the error file. The error file can be set through the switches C<-f> or C<-q>. No warning about QuickFix activity is issued in this mode. Called with -v, it prints the version and exits. =head1 IMPLEMENTATION For a debugging tool, an implementation note is in order. Perl offers three obvious ways to watch and capture its error output. One is through the (pseudo-) signal handlers C<$SIG{__WARN__}> and C<$SIG{__DIE__}>. The other is through C-ing the C file handle. A third method involves forking a child process for the capturing and redirect C to there. C can use these three methods to create the error file. As it turns out, the ability to tie C is relatively new with Perl, as of version 5.8.1. With Versions 5.8.0 and earlier, a number of internal errors and warnings don't respect tie, so this method cannot be used. With Perl versions ealier than 5.8.1, C uses %SIG handlers to catch messages. With newer versions, C ties C so that it (additionally) writes to the error file. The forking method can be used with any version of Perl. A specific method can be requested through the options C, C and C, as in use Vi::QuickFix qw(sig); use Vi::QuickFix qw(tie); use Vi::QuickFix qw(fork); The forking method appears to work well in practice, but a race condition exists that intermittently leads to failing tests. It is not tested in the standard test suite and must be considered experimental. Requesting C with a Perl version that can't handle it is a fatal error, so the only option that does anything useful is C with a new-ish Perl. It can be useful when C-ing C conflicts with the surrounding code. =head1 CONFLICTS Similar conflicts can occur with the C method as well, and it can happen in two ways. Either C already finds a resource (a C<%SIG> handler or a tie on C) occupied at C time, or the surrounding code commandeers the resource after the fact. However, if C is already tied when C is Cd, it cannot employ the C method, and by default reverts to C. If the C method is specifically requested, a fatal error results. If the C method finds one of the handlers (C<__WARN__> and C<__DIE__>) already occupied, it chains to the previous handler after doing its thing, so that is not considered an obstacle. "Chaining" file ties is harder, and has not been attempted. If C is already active, the surrounding code may later occupy a resource it is using. There is little that can be done when that happens, except issue a warning which is also logged to the error file. This can help in finding the source of the conflict. In C mode, no such warning is given. The warning is triggered when the corresponding resource is overwritten, except when the overwriting program keeps a copy of it. It is then assumed that the program will keep it functioning. Since we're still talking implementation -- it is actually triggered through a DESTROY method when the corresponding object goes out of scope. C<%SIG> handlers are code objects just for this reason. =head1 VERSION This document pertains to C version 1.134 =head1 BUGS C has no effect =head1 AUTHOR Anno Siegel CPAN ID: ANNO siegel@zrz.tu-berlin.de http://www.tu-berlin.de/~siegel =head1 COPYRIGHT This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. =head1 SEE ALSO perl(1), vim(1).