 _____                        _____
|  __ \                      / ____|
| |  | | ___ _ __ ___   ___ | |     ___  _ __ ___  _ __  _ __ ___  ___ ___
| |  | |/ _ \ '_ ` _ \ / _ \| |    / _ \| '_ ` _ \| '_ \| '__/ _ \/ __/ __|
| |__| |  __/ | | | | | (_) | |___| (_) | | | | | | |_) | | |  __/\__ \__ \
|_____/ \___|_| |_| |_|\___/ \_____\___/|_| |_| |_| .__/|_|  \___||___/___/
                                                  | |
                                                  |_|
                                                                       v1.1

Kontakt: lenka.smejkalova@gmail.com

# Changelog:
#
# v1.1 (05.09.2008)
# Zmeneno nacitani prikazu
# Pouziti modulu Term::ReadLine::Gnu
# opravena chyba pri dekodovani LZW
# odstranen parametr u LZSS, zda se ma jednoznakova shoda kodovat jako novy znak
# pridano pocitani bitu na zakodovanou zpravu
#
# v1.0 (08.06.2008)
# Initial version


Obsah:

0. vod
1. Pouvn programu
	1.1. Popis pkaz
	1.2. Popis masky
	1.3. Pehled implementovanch metod
2. Pidn nov metody
	2.1. Vytvoen novho modulu
	2.2. prava main.pl 
3. Pklad
4. Zvr


0. vod

Program DemoCompress nzornm zpsobem ukazuje, jak funguj nkter vybran kompresn metody. Momentln je implementovno 6 slovnkovch metod, v budoucnosti je mon metody dle pidvat.
Projekt je napsn v Perlu a nem dn speciln nroky. Jedinm malm problmem by mohla bt poteba modulu Term::ReadKey a Term::ReadLine::Gnu, kter nemus bt nainstalovn v kad distribuci. Perliv moduly jsou voln dostupn zde:
http://search.cpan.org/
Konkrtn potebn moduly pro tento projekt jsou pipojeny v balku a nebo je naleznete nap. zde:
http://search.cpan.org/~hayashi/Term-ReadLine-Gnu-1.17a/Gnu.pm
http://search.cpan.org/~jstowe/TermReadKey-2.30/ReadKey.pm

Dalm monm problmem by mohlo bt nesprvn zobrazovn diakritiky a proto jsou v balku celkem ti verze - iso8859-2, CP1250 a UTF8. Problmy se zobrazovnm eskch znak se tkaj pouze text ve zdrojovm kdu (nap. se bude nesprvn zobrazovat npovda, chybov hlky atd.), zadvn vstupu a jeho nsledn zobrazovn by mlo bt bez problm.


1. Uivatelsk dokumentace

Program se spust souborem main.pl nap. 'perl main.pl'. Nepijm dn parametry a po sputn se chov jako jednoduch konzole - funguje doplovn pkaz, jejich historie (ipka nahoru), automatick doplovn pkaz (klvesa tab) i monost pohybu po dce pomoc ipek . Program nejprve vytiskne dostupn metody, info, jak zobrazit npovdu a nakonec prompt (">"), co znamen, e oekv pkaz od uivatele. Seznam vech pkaz i se strunm popisem je obsaen v npovd a pro plnost je uveden i zde s ppadnmi dalmi popisky:

1.1. Popis pkaz

? .. zobraz seznam pkaz se strunm popisem

describe .. s parametrem (id metody nebo jej nzev se zadv jako parametr) vype info o metod (popis algoritmu, pop. poznmky o konkrtn implementaci)
            bez parametru se chov jako 'methods'

exec .. spust metodu (id nebo nzev je uveden jako parametr), pokud dosud nebyl zadn etzec, kter se m zakdovat, vyzve nejprve uivatele k jeho zadn. Tento text je pot uloen po celou dobu bhu programu, pop. lze zmnit (viz ne).
Nejprve se provede kdovac st, vytiskne se poet bit, kolik je poteba na pvodn a kolik na kdovanou zprvu, pot je uivateli poloen dotaz, zda si peje provst i dekdovac st. Prbh tchto st ovlivuj parametry encode_mode a decode_mode, kter budou popsny samostatn.

exit .. ukon program

help .. zobraz seznam pkaz se strunm popisem

input <text> .. zadn nebo zmna vstupnho etzce
Je mon zadat s parametrem (text) i bez parametru
Na zatku textu nemohou bt bl znaky, dlka nen omezena. Text bude rozdlen na sti (znaky nebo slova) podle pouit metody.

methods .. vype vechny dostupn metody jako slovan seznam, pi odkazu na metodu je mono pout jej nzev (case-insensitive) nebo slo, pod kterm je uvedena v tomto seznamu

print_input .. vystikne zadan vstupn etzec nebo info, e jet nebyl zadn

print_params .. vype aktuln hodnoty parametr

print_mask_info .. vype informace o tom, z eho se skld maska a jak ji vytvoit (pouita u parametr encode_mode a decode_mode)

quit .. ukon program

set_mode_dec <mask> .. nastav masku, kter ovlivuje prbh dekdovn.
Maska se zadv jako pirozen slo. Jak toto slo vytvoit viz ne.
Pokud je mask 'default', pouije se pednastaven hodnota.

set_mode_enc <mask> .. nastav masku, kter ovlivuje prbh kdovn.
Maska se zadv jako pirozen slo. Jak toto slo vytvoit viz ne.
Pokud je mask 'default', pouije se pednastaven hodnota.

set_params .. spust proceduru pro zmnu nastavitelnch parametr
Uivatel bude postupn dotazovn, kter parametr chce zmnit. Jednotliv parametry je mon mnit i samostatn.

set_window <param> .. nastav vchoz velikost oknka (pro metody LZ77 a LZSS)
	pokud je parametr 'default', pouije se pednastaven hodnota
	jinak je teba zadat parametr ve tvaru <P> <B> (P - processed, B - buffer)

version .. zobraz verzi programu


1.2. Popis masky

Maska slou k nastaven parametr, kter nabvaj pouze pouze hodnot TRUE / FALSE do jednoho parametru.
Kadmu parametru je v binrn reprezentaci piazen jeden bit, vsledn maska je dna soutem (or) hodnot parametr.
Dky tomu je mon pedvat nkolik parametr jako jeden.
Zde maska sdruuje tyto parametry:
0 .. waiting_mode/no_waiting_mode
1 .. no_silent_mode/silent_mode
2 .. tree_view/no_tree_view
3 .. list_view/no_list_view
Pi nastaven waiting_mode se do masky pipot hodnota 1 (2^0). Kdovac resp. dekdovac proces se bude chovat tak, e po proveden jednoho kroku bude ekat na stisk libovoln klvesy, aby mohl pokraovat dle. Ale pouze v ppad, e bude nastaven no_silent_mode (2 = 2^1). Silent_mode znamen, e se nem nic vypisovat - pak se tedy ignoruje hodnota waiting_mode.
Dal dva parametry se uplatuj jen u metod LZ78 a LZW. Pokud je nastaven no_silent_mode, tak po kadm kroku algoritmu vyp slovnk jako strom (tree_view) nebo seznam (list_view). Pokud jsou nastaveny oba na kladnou hodnotu, vype se strom i seznam.
Pokud je nastaven waiting_mode, tak u tchto metod (LZ78, LZW) se d vyvolat vypsn slovnku explicitn:
psmeno t pro vypsn slovnku ve stromovm formtu
psmeno l pro vypsn slovnku jako indexovanho seznamu
a psmeno b pro oboj (nejdve strom, pak seznam)


1.3. Pehled implementovanch metod:

1) LZ77
2) LZSS
3) LZ78
4) LZW
5) BSTW
6) Intervalov kdovn



2. Programtorsk dokumentace

2.1 Popis funknosti programu

Cel projekt je rozdlen na hlavn program 'main.pl' a nkolik modul, kter odpovdaj jednotlivm metodm. Vjimkou je modul Common.pm, kter obsahuje uiten funkce vyuvan jak v modulech, tak v hlavnm programu. Kad modul mus obsahovat tyi zkladn funkce - pro kdovn a dekdovn, vpoet potebnch bit na zakdovanou zprvu a funkci, kter zobraz npovdu. Dle me obsahovat libovoln mnostv pomocnch funkc, kter nejsou viditeln mimo modul (neexportuj se).

Moduly jsou do hlavnho programu zapojeny pomoc struktury %methods, kl je nzev metody a hodnotou je dal asociativn pole s tmito polokami:
		id .. pidlujeme inkrementln
		f_encode .. ukazatel na kdovac funkci
		f_decode .. ukazatel na dekdovac funkci
		params .. seznam parametr
		f_info .. ukazatel na funkci, kter vytiskne popis metody
		f_count_bits .. ukazatel na funkci, kter zjist, kolik bit je poteba na zakdovanou zprvu

Parametry se medodm pedvaj prv dky tto struktue, take v moment voln de/kdovac funkce je nutn, aby parametry byli ji inicializovan.

Podporovan pkazy jsou obsaeny ve struktue %commands. Klem je nzev pkazu, hodnotou je asociativn pole s dvmi polokami:
		func .. ukazatel na funkci, kter se m volat pi zadn pkazu
		doc .. strun popis pkazu, kter se zobrazuje v npovd

Program je tvoen jednm cyklem, ve kterm se vykonvaj pkazy, dokud je zadvn njak vstup od uivatele. Vstupn dka je rozdlena na nzev pkazu a argument, nsledn se zavol dan funkce s tmto argumentem. Argument je pouze jeden, v ppad poteby lze parsovat ve volan funkci. Z tohoto dvodu je dleit, aby kad pkaz byl jednoslovn - bez mezer. Pokud funkce pkazu vrt nenulovou hodnotu, hlavn cyklus bude ukonen.



2.2. Pidn nov metody

Pidn nov metody se skld ze dvou st:
1) Vytvoit nov Perliv modul (kad metoda je v samostatnm modulu)
2) Upravit main.pl


2.2.1. Vytvoen novho modulu

Vytvoen novho modulu v Perlu nen nijak sloit. Lze pout strukturu, kter je u ostatnch modul v tomto projektu. V modulu me bt libovoln mnostv pomocnch funkc, dleit je, aby obsahoval tyto tyi funkce, kter budou viditeln i mimo modul:
	print_help_metoda() - pouze vypsn informac o metod - jak funguje, pop. jak je implementovna
	metoda_encode() - kdovn
	metoda_decode() - dekdovn
	metoda_count_bits - vpoet bit, kolik je poteba na zakdovanou zprvu
Viditelnost se zajist pomoc:
	@EXPORT = qw(&metoda_encode &metoda_decode &print_help_metoda, metoda_count_bits);
Je mon zde pouvat pomocn funkce z modulu Common.pm pomoc voln "use Common;". Je mon i pidvat dal funkce do tohoto modulu. 
Dle by bylo vhodn, aby funkce pro de-/kdovn spolupracovaly s de/en-code_mode.


2.2.2. prava main.pl 

Po vytvoen Perlivho modulu je zapoteb ho integrovat do zbytku projektu. Projdeme soubor main.pl od zatku a ekneme, kde vude je teba co pidat (pedpokldme, e jsme vytvoili nov modul pro metodu LZJ a nazvali ho LZJ.pm):

1) pidat dek pro includovn modulu 
	use LZJ;

2) (optional) Pokud pidvan metoda vyaduje njak parametr, pidme jeho inicializaci do sti "inicializace parametru"

3) upravit strukturu %methods (hash pole)
	nap.:
		'LZJ' => {
			id => 7,
			f_encode => \&lzj_encode,
			f_decode => \&lzj_decode,
			params => [],
			f_info => \&print_help_lzj,
			f_count_bits => \&lzj_count_bits
		},


4) (optional) Pokud jsme pidali nov parametr, bylo by vhodn pidat pkaz, kterm je mon hodnotu parametru upravit (nezapomete tento pkaz pidat do struktury %commands), dle by bylo vhodn upravit fce print_params() a set_params().


A pokud jste vechno udlali sprvn, tak by to mlo fungovat.


3. Pklad

> methods # vype seznam metod
Momentln jsou k dispozici tyto metody:
1 : LZ77
2 : LZSS
3 : LZ78
4 : LZW
5 : BSTW
6 : Interval

> describe lz77 # vype info o metod 

LZ77

Metoda LZ77 (angl. sliding window) vyuv oknka o velikosti P+B. Prvn st
o velikosti P obsahuje ji zpracovan text (nazveme ji processed). Po inicializaci
je przdn. Druh st (buffer) obsahuje text, kter se bude prv zpracovvat.
Na zatku obsahuje zatek vstupu. Jeden krok algoritmu vypad tak, e se v poli
processed hled posledn vskyt nejdelho podetzce zanajcho na zatku
bufferu. Je povoleno, aby konec tohoto podetzce zasahoval do bufferu.
Po nalezen se na vstup posl trojice (posun, poet, znak), kde 'posun' znamen
o kolik znak se posouvme zpt, 'poet' - kolik znak se m od tto pozice
koprovat a 'znak' - jak je dal psmeno, kter ji nebylo obsaeno v podetzci.
Pot se oknko posune tak, aby 'znak' byl na posledn pozici v poli processed.

Typick hodnoty parametr jsou P <= 8192, B 10-20, pro demonstraci doporuuji
pout parametry P = 7, B = 3.

> set_window 15 3 # nastav velikost oknka
new window_size: 15 3

> input pr, pr, jen se leje... # zadn vstupu

> print input # kontroln vytitn vstupu
Input: pr, pr, jen se leje...

> print_mask_info # vype informace o tom, jak vytvoit masku
Maska se zadv jako souet voleb:
    waiting_mode    :  1 (pi (de)kdovn se bude ekat na stisk klvesy v kadm kroku)
    no_waiting_mode :  0
    silent_mode     :  0 (v jednotlivch krocch se nebude nic vypisovat)
    no_silent_mode  :  2
    tree_view       :  4 (pouze u lz78 a lzw - vypsat slovnk jako strom po kadm kroku)
    no_tree_view    :  0
    list_view       :  8 (pouze u lz78 a lzw - vypsat slovnk jako seznam po kadm kroku)
    no_list_view    :  0

> set_mode_enc 3 # nastaven masky pro kdovn (waiting + no_silent)
new encoding mode: (3) waiting no_silent

> set_mode_dec 3 # nastaven masky pro dekdovn (waiting + no_silent)
new decoding mode: (3) waiting no_silent

> exec lz77 # sputn metody
...

> set_window default # nastav pvodn velikost oknka
new window_size: 7 3



4. Zvr

Doufm, e tento jednoduch progrmek poslou k lepmu pochopen implementovanch metod.
V ppad, e mte njak dotaz, pipomnku nebo naleznete chybu, nevhejte napsat na moji e-mailovou adresu: lenka.smejkalova@gmail.com .
