use v6.d;
use RenderPod::Exceptions;
use JSON::Fast;
use File::Temp;


This module adds highlighting functionality to ProcessedPod.


Highlighting at the time of writing is only available via a Samantha McVeigh's node
dependent system
and only for HTML. However, it should be made available using a Raku system
and for other rendered formats.


Highlighting is normally only needed for block code, rather than in-line code.


Highlighting should be separate from the templating system because it is output format
dependent, whilst the templating system should be output format neutral.


At the same time, extra wrapping formatting codes may be needed, so the highlighted
code should be sent to the templating engine.


Therefore, highlighting is added to ProcessedPod object, and a separate highlighted
field in the paramaters is created.



role Highlighting is export {
    #| the output formatting.
    has $.format = 'HTML';
    

comment


    #| the highlighting engine, currently only Samantha McVie's atom engine
    has $.highlight-engine = 'atom';

    #| tells ProcessedPod not to escape characters when in a code block
    has Bool $.no-code-escape is rw is default(False) = False;
    


    #| A boolean to indicate whether Raku should be highlighted
    has Bool $!highlight-code = False;
    #| The Asynchronous closure to provide the highlighting
    has Proc::Async $!external-highlighter;
    #| The connection to the highlighter
    has $!highlighter-supply;
    #| Path to where the highlighter executable (possibly non-Raku) is located
    has Str $!external-highlights-path;
    #| A function that takes a defined Str fragment and applies a highlight to it
    has &.insert-highlights is rw = -> Str:D $frag { $frag }; # default is to return $frag unchanged

    #| custom getter / setter
    method highlight-code ( ) is rw {
        Proxy.new(
            FETCH => -> $ { $!highlight-code },
            STORE => -> $, Bool $wanted-state {
                return if $wanted-state == $!highlight-code;
                my Bool $hlite;
                if $wanted-state {
                    # Toggle from OFF to on
                    # Uses Samantha McVie's atom-highlighter
                    # Raku-Pod-Render places this at <user-home>.local/share/raku-pod-render/highlights
                    # or <user-home>.raku-pod-render/highlights
                    given $.highlight-engine {
                        when 'atom' {
                            $!external-highlights-path = $.set-highlight-basedir
                            without $!external-highlights-path;
                            $!external-highlighter = Proc::Async.new(
                                    "{ $!external-highlights-path }/node_modules/coffeescript/bin/coffee",
                                    "{ $!external-highlights-path }/highlight-filename-from-stdin.coffee", :r, :w)
                            without $!external-highlighter;
                            $!highlighter-supply = $!external-highlighter.stdout.lines
                            without $!highlighter-supply;
                            # set up the highlighter closure
                            $.no-code-escape = True;
                            &.insert-highlights = -> $frag {
                                return $frag unless $frag ~~ Str:D;
                                $!external-highlighter.start unless $!external-highlighter.started;

                                my ($tmp_fname, $tmp_io) = tempfile;
                                # the 


    method set-highlight-basedir( --> Str ) {
        my $basedir = $*HOME;
        my $hilite-path = "$basedir/.local/lib".IO.d
                ?? "$basedir/.local/lib/raku-pod-render/highlights".IO.mkdir
                !! "$basedir/.raku-pod-render/highlights".IO.mkdir;
        X::RenderPod::NoHighlightPath.new.throw
            unless ~$hilite-path;
        if $.highlight-engine eq 'atom' {
            X::RenderPod::NoAtomHighlighter.new.throw
                unless "$hilite-path/package-lock.json".IO.f and "$hilite-path/atom-language-perl6".IO.d
        }
        ~$hilite-path
    }
}


root

Templating

HTML2

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Highlighting

Raku::Pod::Render v3.7.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation