OnSearch::StringSearch - String search library for OnSearch.

onsearch documentation

Contained in the onsearch distribution.

Index

NAME
SYNOPSIS
DESCRIPTION
EXPORTS
VERSION AND CREDITS

Code Index:

package OnSearch::StringSearch
__END__
EOF

NAME

OnSearch::StringSearch - String search library for OnSearch.

SYNOPSIS

    use OnSearch::StringSearch;

    @offsets = search_string ($pattern, $text);
    @offsets = search_file ($pattern, $filename);
    $offset = strindex ($pattern, $text);

DESCRIPTION

Search_string () searches for the exact matches a string within another string, without performing regular expression pattern matching. Strindex searches for the first exact match. Search_file () searches a file for occurrences of a string.

In a list context, search_string () and search_file () return a list of file offsets where the pattern occurs in the search text, or a reference to the list in scalar context. Strindex () returns the offset of the first occurence. The subroutines return undef if the search pattern is not found.

EXPORTS

strindex (pattern, text);

Returns the first occurence of pattern in text, or undef otherwise.

search_string (pattern, text);

Returns a list of offsets in text where pattern is found, or undef otherwise.

search_file (pattern, file_name);

Returns a list of offsets in the input file where pattern is found, or undef otherwise.

VERSION AND CREDITS

$Id: StringSearch.pm,v 1.4 2005/07/25 00:33:01 kiesling Exp $

Copyright � 2005 Robert Kiesling, rkies@cpan.org.

Licensed under the same terms as Perl. Refer to the file, "Artistic," for details.

The search strategies are from the Boyer-Moore search algorithm as described in Michael Abrash's Graphics Programming Black Book.

onsearch documentation

Contained in the onsearch distribution.

package OnSearch::StringSearch;

use 5.006;
use strict;
use warnings;
use Errno;
use Carp;

require Exporter;
require DynaLoader;
use AutoLoader;

our @ISA = qw(Exporter DynaLoader);
our @EXPORT = qw(search_string search_file strindex);
our $VERSION = '0.001';

sub strindex {
    return OnSearch::StringSearch::_strindex (@_);
}

sub search_string {
    my $results_ref = OnSearch::StringSearch::_search_string (@_);
    return (wantarray ? @{$results_ref} : $results_ref) if $results_ref;
    return undef;
}

sub search_file {
    my $results_ref = OnSearch::StringSearch::_search_file (@_);
    return (wantarray ? @{$results_ref} : $results_ref) if $results_ref;
    return undef;
}

sub AUTOLOAD {
    # This AUTOLOAD is used to 'autoload' constants from the constant()
    # XS function.  If a constant is not found then control is passed
    # to the AUTOLOAD in AutoLoader.

    my $constname;
    our $AUTOLOAD;
    ($constname = $AUTOLOAD) =~ s/.*:://;
    croak "& not defined" if $constname eq 'constant';
    my $val = constant($constname, @_ ? $_[0] : 0);
    if ($! != 0) {
	if ($!{EINVAL}) {
	    $AutoLoader::AUTOLOAD = $AUTOLOAD;
	    goto &AutoLoader::AUTOLOAD;
	}
	else {
	    croak "Your vendor has not defined StringSearch macro $constname";
	}
    }
    {
	no strict 'refs';
	# Fixed between 5.005_53 and 5.005_61
	if ($] >= 5.00561) {
	    *$AUTOLOAD = sub () { $val };
	}
	else {
	    *$AUTOLOAD = sub { $val };
	}
    }
    goto &$AUTOLOAD;
}

bootstrap OnSearch::StringSearch $VERSION;

1;
__END__