File Coverage

blib/lib/Text/Smart/HTML.pm

Criterion	Covered	Total	%
statement	61	62	98.3
branch	3	6	50.0
condition	1	3	33.3
subroutine	16	16	100.0
pod	12	12	100.0
total	93	99	93.9

# -*- perl -*-
#
# Text::Smart::HTML by Daniel Berrange
#
# Copyright (C) 2000-2004 Daniel P. Berrange
#
# 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-1307  USA
#
# $Id: HTML.pm,v 1.2 2004/12/31 16:00:45 dan Exp $

=pod

=head1 NAME

Text::Smart::HTML - Smart text outputter for HTML

=head1 SYNOPSIS

  use Text::Smart::HTML;

  my $markup = Text::Smart::HTML->new(%params);

=head1 DESCRIPTION

=head1 METHODS

=over 4

=cut

package Text::Smart::HTML;

use strict;
use warnings;

use Text::Smart;

use vars qw(@ISA);

@ISA = qw(Text::Smart);

=item my $proc = Text::Smart::HTML->new(target => $target);

Creates a new smart text processor which outputs HTML markup.
The only C parameter is used to specify the hyperlink
window target (via the 'target' attribute on the  tag)

=cut

sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = $class->SUPER::new();
    my %params = @_;

    $self->{target} = exists $params{target} ? $params{target} : undef;

    bless $self, $class;

    return $self;
}

=item my $markup = $proc->generate_divider

Generates a horizontal divider using the  tag.

=cut

sub generate_divider {
    my $self = shift;

    return "\n";
}

=item my $markup = $proc->generate_itemize(@items)

Generates an itemized list of bullet points using the  tag.

=cut

sub generate_itemize {
    my $self = shift;
    my @items = @_;

    return "\n" . (join("\n", map { "$_\n" } @items)) . "\n";
}

=item my $markup = $proc->generate_enumeration(@items)

Generates an itemized list of numbered points using the  tag

=cut

sub generate_enumeration {
    my $self = shift;
    my @items = @_;

    return "\n" . (join("\n", map { "$_\n" } @items)) . "\n";
}

=item my $markup = $proc->generate_heading($text, $level)

Generates a heading using one of the tags  through

=cut

sub generate_heading {
    my $self = shift;
    local $_ = $_[0];
    my $level = $_[1];

    my %levels = (
		  "title" => "h1",
		  "subtitle" => "h2",
		  "section" => "h3",
		  "subsection" => "h4",
		  "subsubsection" => "h5",
		  "paragraph" => "h6",
		  );

    return "<" . $levels{$level} . ">$_\n";
}

=item my $markup = $proc->generate_paragraph($text)

Gnerates a paragraph using the  tag.

=cut

sub generate_paragraph {
    my $self = shift;
    local $_ = $_[0];

    return "$_\n";
}

=item my $markup = $proc->generate_bold($text)

Generates bold text using the  tag

=cut

sub generate_bold {
    my $self = shift;
    local $_ = $_[0];

    return "$_";
}

=item my $markup = $proc->generate_italic($text)

Generates italic text using the  tag.

=cut

sub generate_italic {
    my $self = shift;
    local $_ = $_[0];

    return "$_";
}

=item my $markup = $proc->generate_monospace($text)

Generates monospaced text using the  tag.

=cut

sub generate_monospace {
    my $self = shift;
    local $_ = $_[0];

    return "$_";
}


=item my $markup = $proc->generate_link($url, $text)

Generates a hyperlink using the  tag.

=cut

sub generate_link {
    my $self = shift;
    my $url = shift;
    local $_ = $_[0];

    if ($self->{target}) {
	return "{target}\" href=\"$url\">$_";
    } else {
	return "$_";
    }
}


=item my $markup = $proc->generate_entity($text)

Generates entities using the ½, ¼, ¾,
©, ® and  TM  entities / markup.

=cut

sub generate_entity {
    my $self = shift;
    my $entity = shift;

    my %entities = (
		    fraction12 => "½",
		    fraction14 => "¼",
		    fraction34 => "¾",
		    copyright => "©",
		    registered => "®",
		    trademark => "TM",
		    );

    return exists $entities{$entity} ? $entities{$entity} : $entity;
}

=item my $text = $proc->escape($text)

Escapes the ampersand, and angle bracket characters

=cut

sub escape {
    my $self = shift;
    local $_ = $_[0];

    s/&/&/g;
    s/
    s/>/>/g;

    return $_;
}

1 # So that the require or use succeeds.

__END__