NAME

Dicop::Data::Charset::Dictionary - a dictionary charset

SYNOPSIS

    use Dicop::Data::Charset::Dictionary;

REQUIRES

perl5.005, Exporter, Dicop::Item, Dicop, Dicop::Event, Math::String::Charset

EXPORTS

Exports nothing on default.

DESCRIPTION

A dictionary charset has the following fields, most of them can be set via new. The rest (shown with a *) is automatically initialized/overwritten/maintained:

stages

A bitfield containing the different stages a word is mutated through first.

mutations

A bitfield containing the different mutations each stage is mutated throughi further.

description

A short description.

id *

The identification number.

dirty *

If set to 1, the charset is considered 'in use' and can no longer be changed. (Actually, only the set, the description still can be changed)

This is to prevent changes to a charset that is currently used by a job, since that would invalidate the job's keyspace.

METHODS

check()

Perform an internal check and return '' for okay, otherwise an error message.

type()

Returns the type, in this case the string 'dictionary'.

appends()

        $set->appends();

Returns the number of sets that appended/prepended to each stage of each word.

offset()

        $set->offset($N);

Returns the offset into the dictionary file of the n'th word. 0 means the very first word.

BUGS

None known yet.

AUTHOR

(c) Bundesamt fuer Sicherheit in der Informationstechnik 1998-2006

DiCoP is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

See http://www.bsi.de/ for more information.