The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

JDEGUEST / Markdown-Parser-v0.4.1 / lib / Markdown / Parser / Header.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
—
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

              
##----------------------------------------------------------------------------
## Markdown Parser Only - ~/lib/Markdown/Parser/Header.pm
## Version v0.3.0
## Copyright(c) 2022 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <jack@deguest.jp>
## Created 2021/08/23
## Modified 2024/08/30
## All rights reserved
## 
## This program is free software; you can redistribute  it  and/or  modify  it
## under the same terms as Perl itself.
##----------------------------------------------------------------------------
package Markdown::Parser::Header;
BEGIN
{
    use strict;
    use warnings;
    use parent qw( Markdown::Parser::Element );
    use vars qw( $VERSION );
    our $VERSION = 'v0.3.0';
};
use strict;
use warnings;
sub init
{
    my $self = shift( @_ );
    $self->{id}         = [];
    $self->{level}      = 0;
    $self->{tag_name}   = 'header';
    $self->SUPER::init( @_ );
    # If the header level is not set yet and we have some raw data, let's guess it from the raw data provided
    if( !$self->level && $self->raw->length )
    {
        # # is level 1, ## is level 2, etc...
        my $raw = $self->raw;
        $self->level( length( ( $raw =~ /^(\#+)/ )[0] ) );
    }
    return( $self );
}
sub append { return( shift->_append_text( @_ ) ); }
sub as_markdown
{
    my $self = shift( @_ );
    my $str = $self->children->map(sub{ $_->as_markdown })->join( '' );
    my $level = $self->level;
    my $marker = '#' x $level;
    return( "${marker} ${str}" );
}
sub as_pod
{
    my $self = shift( @_ );
    my $str = $self->children->map(sub{ $_->as_pod })->join( '' );
    my $level = $self->level;
    my $marker = '=head' . $level;
    return( "${marker} ${str}\n" );
}
sub as_string
{
    my $self = shift( @_ );
    my $arr  = $self->new_array;
    my $tag  = 'h' . $self->level;
    my $tag_open = $tag;
    if( $self->id->length )
    {
        $tag_open .= ' ' . $self->id->map(sub{ sprintf( 'id="%s"', $_ ) })->join( ' ' )->scalar;
    }
    if( $self->class->length )
    {
        $tag_open .= ' class="' . $self->class->join( ' ' )->scalar . '"';
    }
    $arr->push( "<$tag_open" );
    my $attr = $self->new_array;
    $attr->push( $self->format_id ) if( $self->id->length );
    $attr->push( $self->format_class ) if( $self->class->length );
    my $attributes = $self->format_attributes;
    $attr->push( $attributes->join( ' ' )->scalar ) if( $attributes->length );
    $arr->push( ' ' . $attr->join( ' ' )->scalar ) if( $attr->length );
    $arr->push( '>' );
    $arr->push( $self->children->map(sub
    {
        $_->as_string;
    })->list );
    $arr->push( "</$tag>" );
    return( $arr->join( '' )->scalar );
}
sub id { return( shift->_set_get_array_as_object( 'id', @_ ) ); }
sub level { return( shift->_set_get_number_as_object( 'level', @_ ) ); }
1;
# NOTE: POD
__END__
=encoding utf8
=head1 NAME
Markdown::Parser::Header - Markdown Header Element
=head1 SYNOPSIS
    my $o = Markdown::Parser::Header->new;
    # or
    $doc->add_element( $o->create_header( @_ ) );
=head1 VERSION
    v0.3.0
=head1 DESCRIPTION
This class represents a header formatting. It is used by L<Markdown::Parser> and inherits from L<Markdown::Parser::Element>
=head1 METHODS
=head2 append
Provided with a L<Markdown::Element::Text> object, or a text string, and this will add it to stack of elements or append it to the last text element if any.
=head2 as_markdown
Returns a string representation of the header formatted in markdown.
It returns a plain string.
=head2 as_pod
Returns a string representation of the header formatted in L<pod|perlpod>.
It returns a plain string.
=head2 as_string
Returns an html representation of the header.
It returns a plain string.
=head2 class
Sets or gets the array object of css class for this header.
Returns a L<Module::Generic::Array> object.
=head2 id
Sets or gets the array object of css id for this header. There should only be one set.
Returns a L<Module::Generic::Array> object.
=head2 level
Sets or gets the level for this header. It takes an integer which is stored as a L<Module::Generic::Number> object.
Valid values are from 1 to 6.
Returns the current value set.
=head1 SEE ALSO
Markdown original author reference on emphasis: L<https://daringfireball.net/projects/markdown/syntax#header>
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut