packageHTML::FromANSI;$HTML::FromANSI::VERSION='2.03';usestrict;useHTML::Entities;=head1 NAMEHTML::FromANSI - Mark up ANSI sequences as HTML=head1 SYNOPSISuse HTML::FromANSI (); # avoid exports if using OOuse Term::ANSIColor;my $h = HTML::FromANSI->new(fill_cols => 1,);$h->add_text(color('bold blue'), "This text is bold blue.");print $h->html;# you can append text in the new api:$h->add_text(color('bold blue'), " still blue.");print $h->html# The old API still works:$HTML::FromANSI::Options{fill_cols} = 1; # fill all 80 colsprint ansi2html(color('bold blue'), "This text is bold blue.");=head1 DESCRIPTIONThis small module converts ANSI text sequences to corresponding HTMLcodes, using stylesheets to control color and blinking properties.It exports C<ansi2html()> by default, which takes an array, joins itit into a single scalar, and returns its HTML rendering.From version 2.00 an object oriented api which is safer for multiple uses (nomore manipulation of shared C<%Options>) is available. It is reccomended thatyou no longer import any functions by doing:use HTML::FromANSI ();and use the new documented API instead of the functional one.The underlying ANSI code processing is done by L<Term::VT102>, a DEC VT102terminal emulator. To generate ANSI codes for color changes, cursor movementsetc, take a look at L<Term::ANSIScreen> and L<Term::ANSIColor>.=head1 METHODS=over 4=item newThe constructor. See L</OPTIONS> for the options it takes.=item add_text @textAdds text input to the terminal emulator.=item htmlRenders the screen as computed by C<terminal_object> into HTML.=item ansi_to_html @textA convenience method.Calls C<add_text> and then C<html>.=item terminal_objectThe underlying terminal emulator object.=back=head1 OPTIONSThese are parameters you can pass to C<new>.=over 4=item linewrapA boolean value to specify whether to wrap lines that exceedswidth specified by C<col>, or simply truncate them. Defaults to C<1>.Only takes effect if you override C<terminal_class> or C<terminal_object> witha L<Term::VT102> (instead of L<Term::VT102::Boundless>).=item lf_to_crlfA boolean value to specify whether to translate all incoming\n into C<\r\n> or not; you generally wants to use this if yourdata is from a file using unix line endings. The default is C<0>on MSWin32 and MacOS, and C<1> on other platforms.=item fill_colsA boolean value to specify whether to fill empty columns withspace; use this if you want to maintain a I<screen-like> appearancein the resulting HTML, so that each row will be aligned properly.Defaults to C<0>.=item html_entityA boolean value to specify whether to escape all high-bit charactersto HTML entities or not; defaults to C<0>, which means only C<E<lt>>,C<E<gt>>, C<"> and C<&> will be escaped. (Handy when processing mostANSI art entries.)=item colsA number specifying the width of the virtual terminal; defaults to 80.When C<Term::VT102::Boundless> is in use (the default) this specifies theminimum number of rows to draw.When using C<Term::VT102> (by overriding C<terminal_class> orC<terminal_object>) then the number of columns is fixed.=item rowsWhen C<Term::VT102::Boundless> is in use (the default) this specifies theminimum number of rows to draw.When L<Term::VT102> is in use (by overriding C<terminal_class> orL<terminal_object>) then it sets the height of the virtual terminal; rows thatexceeds this number will be truncated.=item font_faceA string used as the C<face> attribute to the C<font> tag enclosing theHTML text; defaults to C<fixedsys, lucida console, terminal, vga, monospace>.If this option and the C<style> option are both set to empty strings, theC<font> tag will be omitted.=item styleA string used as the C<style> attribute to the C<font> tag enclosing theHTML text; defaults to <line-height: 1; letter-spacing: 0; font-size: 12pt>.If this option and the C<font_face> option are both set to empty strings, theC<font> tag will be omitted.=item ttA boolean value specifying whether the HTML text should be enclosed in aC<tt> tag or not. Defaults to C<1>.=item show_cursorA boolean value to control whether to highlight the character underthe cursor position, by reversing its background and foregroud color.Defaults to C<0>.If the cursor is on it's own line and C<show_cursor> is set, then that row willbe omitted.=item terminal_classThe class to instantiate C<terminal_object> with. Defaults toL<Term::VT102::Boundless>.=item terminal_objectAny L<Term::VT102> compatible object should work here.If you override it most values like C<cols>, C<rows>, C<terminal_class> etcwill be ignored.=cut@EXPORT='&ansi2html';@EXPORT_OK=qw|@Color %Options|;@Color= (qw(black darkred darkgreen),'#8b8b00',qw(darkblue darkmagenta darkcyan graydimgray red green yellow blue magenta cyan white));%Options= (linewrap=> 1,# wrap long lineslf_to_crlf=> (# translate \n to \r\n on Unix$^O !~ /^(?:MSWin32|MacOS)$/),fill_cols=> 0,# fill all (80) columns with spacehtml_entity=> 0,# escape all HTML entitiescols=> 80,# column widthrows=>undef,# let ansi2html figure it outfont_face=>'fixedsys, lucida console, terminal, vga, monospace',style=>'line-height: 1; letter-spacing: 0; font-size: 12pt',tt=> 1,show_cursor=> 0,terminal_class=>'Term::VT102::Boundless',);subimport{my$class=shift;while(my($k,$v) =splice(@_, 0, 2)) {$Options{$k} =$v;}$class->export_to_level(1);}subnew {my($class,@args) =@_;if(@args== 1 && reftype($args[0]) eq'HASH') {returnbless{%Options, %{$args[0] } },$class;}elsif(@args% 2 == 0 ) {returnbless{%Options,@args},$class;}else{croak"Constructor arguments must be an even sized list or a hash ref";}}sub_obj_args {if( blessed($_[0]) and$_[0]->isa(__PACKAGE__) ) {return@_;}else{return( __PACKAGE__->new(),@_);}}subansi2html {my($self,@args) = _obj_args(@_);$self->ansi_to_html(@args);}subterminal_object {my($self,@args) =@_;$self->{terminal_object} ||=$self->create_terminal_object(@args);}subcreate_terminal_object {my($self,%args) =@_;my$class=$self->{terminal_class};if($classne'Term::VT102::Boundless') {(my$file="${class}.pm") =~ s{::}{/}g;require$file;}my$vt=$class->new(cols=>$self->{cols},(defined($self->{rows}) ? (rows=>$self->{rows} ) : () ),);$vt->option_set(LINEWRAP=>$self->{linewrap});$vt->option_set(LFTOCRLF=>$self->{lf_to_crlf});$vt->_code_DECTCEM($self->{show_cursor} );return$vt;}subadd_text {my($self,@lines) =@_;$self->terminal_object->process($_)for@lines;}subansi_to_html {my($self,@lines) =@_;$self->add_text(@lines);return$self->html;}subhtml {my($self,@args) =@_;my$result=$self->parse_vt($self->terminal_object);if(length$self->{font_face} orlength$self->{style}) {$result="<font face='$self->{font_face}' style='$self->{style}'>".$result."</font>";}$result="<tt>$result</tt>"if$self->{tt};return$result;}subparse_vt {my($self,$vt) = _obj_args(@_);my(%prev,%this);# attributesmy$out;my($x,$y) = ($vt->x,$vt->y);my$total_rows=$vt->rows;foreachmy$row_num(1 ..$total_rows) {local$SIG{__WARN__} =sub{};# abandon all hope, ye who enter heremy$row=$vt->row_text($row_num);my$att=$vt->row_attr($row_num);if($row_num==$total_rowsand$total_rows!= ($self->{rows}||0)# this is the last rowand$row=~ /^[\s\x00]*$/s# and it's completely emptyand !$self->{show_cursor}# and we're not showing a cursor) {last}# skip itforeachmy$col_num(0 ..length($row)) {my$text=substr($row,$col_num,, 1);@this{qw|fg bg bo fo st ul bl rv|} =$vt->attr_unpack(substr($att,$col_num* 2, 2));if($y==$row_numand$x==$col_num+ 1 and$self->{show_cursor}) {# this block is the cursor@this{qw|fg bg bo bl|} = (@this{qw|bg fg bl bo|});$text=' 'if$texteq'\000';}elsif($texteq"\000") {nextunless$self->{fill_cols};}$out.=$self->diff_attr(\%prev, \%this) . (($texteq' 'or$texteq"\000") ?' ':$self->{html_entity} ? encode_entities($text): encode_entities($text,'<>"&'));%prev=%this;}$out.="<br>";}return"$out</span>";}subdiff_attr {my($self,$prev,$this) = _obj_args(@_);my$out='';# skip if the attributes remain unchangedreturnif%{$prev} and notscalar(grep{($_->[0] ne$_->[1])}map{[$prev->{$_},$this->{$_} ]}keys%{$this});# bold, faint, standout, underline, blink and reversemy($fg,$bg,$bo,$fo,$st,$ul,$bl,$rv)= @{$this}{qw|fg bg bo fo st ul bl rv|};($fg,$bg) = ($bg,$fg)if$rv;$out.="</span>"if%{$prev};$out.="<span style='";$out.="color: $Color[$fg + $bo * 8]; ";$out.="background: $Color[$bg + $bl * 8]; ";$out.="text-decoration: underline; "if$ul;$out.="'>";return$out;}1;__END__=head1 SEE ALSOL<Term::VT102::Boundless>, L<HTML::Entities>, L<Term::ANSIScreen>=head1 AUTHORSAudrey Tang E<lt>audreyt@audreyt.orgE<gt>Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>=head1 COPYRIGHTCopyright 2001, 2002, 2003 by Audrey Tang E<lt>audreyt@audreyt.orgE<gt>.Copyright 2007 Yuval Kogman E<lt>nothingmuch@Woobling.orgE<gt>This program is free software; you can redistribute it and/ormodify it under the terms of the MIT license or the same terms as Perl itself.=cut