The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Meta::Tool::Editor - library to activate your faivorite editor.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Editor.pm
        PROJECT: meta
        VERSION: 0.13

SYNOPSIS

        package foo;
        use Meta::Tool::Editor qw();
        my($system_exit_code)=Meta::Tool::Editor::edit("myfile.txt");

DESCRIPTION

This package will activate your favorite editor on a set of files. It will consult the EDITOR environment variable and other options and data to determine what that editor is and how to run it. Currently just activation of the editor is supported (vi...).

FUNCTIONS

        BEGIN()
        set_editor($)
        edit($)
        edit_list($)
        edit_hash($)
        edit_set($)
        edit_set_pat($$)
        edit_line($$)
        edit_line_char($$$)
        edit_pat($$)
        edit_content($)
        TEST($)

FUNCTION DOCUMENTATION

BEGIN()

This is a bootstrap method which sets the editor to the preferred editor.

set_editor($)

This class method sets the editor to be used.

edit($)

Edit a file using your favorite editor.

edit_list($)

Edit a list of files using your favorite editor.

This method will open up an editor on the specified file and will place the cursor on the specified line and character.

edit_hash($)

Edit a hash of files using your favorite editor.

This method receives a hash object and runs your favorite editor on each key of the hash.

edit_set($)

Edit a set of files using your favorite editor.

This method receives a set object and runs your favorite editor on each key of the hash.

edit_set_pat($$)

This method will open a set of files using an editor and make the editor seek a specific pattern.

edit_line($$)

This will open an editor on a specified line.

edit_line_char($$$)

This will open an editor at the specified line and character number.

edit_pat($$)

This will open an editor seeking a specific pattern.

edit_content($)

This will open the favourite editor on a specific content.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV perl reorganization
        0.01 MV get imdb ids of directors and movies
        0.02 MV perl packaging
        0.03 MV md5 project
        0.04 MV database
        0.05 MV perl module versions in files
        0.06 MV movies and small fixes
        0.07 MV thumbnail user interface
        0.08 MV more thumbnail issues
        0.09 MV website construction
        0.10 MV web site automation
        0.11 MV SEE ALSO section fix
        0.12 MV teachers project
        0.13 MV md5 issues

SEE ALSO

Meta::Utils::Env(3), Meta::Utils::File::File(3), Meta::Utils::File::Patho(3), Meta::Utils::File::Remove(3), Meta::Utils::System(3), Meta::Utils::Utils(3), strict(3)

TODO

-Support other editors (emacs etc..)

-implement the edit_line_char method.

-read the editor from an XML configuration file or from envrionment variable.