path: root/md_tw.py

# -*- coding: utf-8 -*-
#
#   Copyright © 2018 rsiddharth <s@ricketyspace.net>.
#
#    This file is part of markdown-textwrap.
#
#   markdown-textwrap 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 3 of
#   the License, or (at your option) any later version.
#
#   markdown-textwrap 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 markdown-textwrap (see COPYING).  If not, see
#   <http://www.gnu.org/licenses/>.

import argparse
import re
import textwrap

import mistune


class TWBlockLexer(mistune.BlockLexer):
    """Text Wrap Block lexer for block grammar."""

    def __init__(self, rules=None, **kwargs):
        super(TWBlockLexer, self).__init__(rules, **kwargs)

        # from mistune
        self._block_quote_leading_pattern = re.compile(r'^ *> ?', flags=re.M)
        self._key_pattern = re.compile(r'\s+')

    # from mistune
    def _keyify(self, key):
        key = mistune.escape(key.lower(), quote=True)
        return self._key_pattern.sub(' ', key)

    def parse_block_code(self, m):
        self.tokens.append({
            'type': 'code',
            'lang': None,
            'text': m.group(0),
        })

    def parse_fences(self, m):
        self.tokens.append({
            'type': 'code',
            'lang': None,
            'text': m.group(0),
        })

    def parse_heading(self, m):
        self.tokens.append({
            'type': 'heading',
            'level': len(m.group(1)),
            'text': m.group(0),
        })

    def parse_lheading(self, m):
        """Parse setext heading."""
        self.tokens.append({
            'type': 'heading',
            'level': 1 if m.group(2) == '=' else 2,
            'text': m.group(0),
        })

    def parse_hrule(self, m):
        self.tokens.append({
            'type': 'hrule',
            'text': m.group(0)
            })

    def _process_list_item(self, cap, bull):
        # from mistune with minor changes.
        cap = self.rules.list_item.findall(cap)

        _next = False
        length = len(cap)

        for i in range(length):
            item = cap[i][0]

            # slurp and remove the bullet
            space = len(item)
            bullet = ''
            bm = self.rules.list_bullet.match(item)
            if bm:
                bullet = bm.group(0)

            item = self.rules.list_bullet.sub('', item)

            # outdent
            if '\n ' in item:
                space = space - len(item)
                pattern = re.compile(r'^ {1,%d}' % space, flags=re.M)
                item = pattern.sub('', item)

            # determine whether item is loose or not
            loose = _next
            if not loose and re.search(r'\n\n(?!\s*$)', item):
                loose = True

            rest = len(item)
            if i != length - 1 and rest:
                _next = item[rest-1] == '\n'
                if not loose:
                    loose = _next

            if loose:
                t = 'loose_item_start'
            else:
                t = 'list_item_start'

            self.tokens.append({
                'type': t,
                'text': bullet,
                'spaces': len(bullet)
                })

            # recurse
            self.parse(item, self.list_rules)

            self.tokens.append({
                'type': 'list_item_end',
                'spaces': len(bullet)
                })

    def parse_block_quote(self, m):
        # slurp and clean leading >
        quote = ''
        qm = self._block_quote_leading_pattern.match(m.group(0))
        if qm:
            quote = qm.group(0)

        cap = self._block_quote_leading_pattern.sub('', m.group(0))

        self.tokens.append({
            'type': 'block_quote_start',
            'text': quote,
            'spaces': len(quote)
            })
        self.parse(cap)
        self.tokens.append({
            'type': 'block_quote_end',
            'spaces': len(quote)
            })

    def parse_def_links(self, m):
        key = self._keyify(m.group(1))
        self.def_links[key] = {
            'link': m.group(2),
            'title': m.group(3),
        }
        self.tokens.append({
            'type': 'def_link',
            'text': m.group(0)
            })

    def parse_def_footnotes(self, m):
        key = m.group(1)
        if key in self.def_footnotes:
            # footnote is already defined
            return

        self.def_footnotes[key] = 0

        text = m.group(2)
        multiline = False
        spaces = 0
        if '\n' in text:
            multiline = True
            lines = text.split('\n')
            whitespace = None
            for line in lines[1:]:
                space = len(line) - len(line.lstrip())
                if space and (not whitespace or space < whitespace):
                    whitespace = space
            newlines = [lines[0]]
            for line in lines[1:]:
                newlines.append(line[whitespace:])
            text = '\n'.join(newlines)

            if whitespace:
                spaces = whitespace

        self.tokens.append({
            'type': 'footnote_start',
            'key': key,
            'multiline': multiline,
            'spaces': spaces
        })

        self.parse(text, self.footnote_rules)

        self.tokens.append({
            'type': 'footnote_end',
            'key': key,
            'spaces': spaces
        })

    def parse_block_html(self, m):
        self.tokens.append({
            'type': 'block_html',
            'text': m.group(0)
            })


class TWInlineLexer(mistune.InlineLexer):
    """Text Wrap Inline level lexer for inline grammars."""

    def __init__(self, renderer, rules=None, **kwargs):
        super(TWInlineLexer, self).__init__(renderer, rules, **kwargs)

    def output(self, text, rules=None):
        # Don't parse inline text.
        return text


class TWRenderer(mistune.Renderer):
    """Text Wrap Renderer."""

    def __init__(self, **kwargs):
        super(TWRenderer, self).__init__(**kwargs)

        # Initalize textwrap.TextWrapper class
        self.tw = textwrap.TextWrapper(
            width=kwargs.get('tw_width', 72)
        )

    def tw_get(self, attr):
        """Get attribute from the local textwrap.TextWrapper instance.
        """
        return getattr(self.tw, attr, None)


    def tw_set(self, **kwargs):
        """
        Set options for the local textwrap.TextWrapper instance.
        """
        # Recognized options.
        opts = [
            'width',
            'initial_indent',
            'subsequent_indent',
            'drop_whitespace'
        ]

        for opt, val in kwargs.items():
            if not opt in opts:
                continue

            # Set option
            setattr(self.tw, opt, val)

    def tw_fill(self, text, **kwargs):
        """Wrap text.
        """
        self.tw_set(**kwargs)
        return self.tw.fill(text)

    def block_code(self, code, lang=None):
        out = '{}'.format(code)
        out = textwrap.indent(out, self.tw_get('initial_indent'),
                              lambda line: len(line.strip()) > 0)
        return out

    def block_quote(self,  text):
        out = '{}\n\n'.format(text)
        return out

    def block_html(self, html):
        out = '{}'.format(html)
        out = textwrap.indent(out, self.tw_get('initial_indent'),
                              lambda line: True)
        return out

    def header(self, text, level, raw=None):
        out = '{}'.format(text)
        return out

    def hrule(self, hr):
        out = '{}'.format(hr)
        return out

    def list(self, body, ordered=True):
        out = '{}\n\n\n'.format(body.rstrip())
        return out

    def list_item(self, text):
        out = '{}\n'.format(text)
        return out

    def paragraph(self, text):
        out = self.tw_fill(text)
        out = '{}\n\n'.format(out)

        return out

    def def_link(self, text):
        out = '{}'.format(text)
        return out

    def footnote_item(self, key, text):
        out = '[^{}]: {}\n'.format(key, text)
        return out


class TWMarkdown(mistune.Markdown):
    """Text Wrap Markdown parser.
    """

    def __init__(self, **kwargs):
        renderer = TWRenderer(**kwargs)

        super(TWMarkdown, self).__init__(
            renderer,
            TWInlineLexer,
            TWBlockLexer
        )

    def _clean_ts(self, lines):
        out = ''

        for line in lines.split('\n'):
            out += line.rstrip() + '\n'

        return out

    def parse(self, text):
        out = super(TWMarkdown, self).parse(text)

        # Remove trailing spaces from all lines.
        out = self._clean_ts(out)

        # Add newline at the end.
        return '{}\n'.format(out.strip('\n'))

    def _add_prefix(self, prefix, initial=True, subseq=True):
        p = self.renderer.tw_get('initial_indent') + prefix

        if initial:
            self.renderer.tw_set(initial_indent=p)
        if subseq:
            self.renderer.tw_set(subsequent_indent=p)

    def _remove_prefix(self, length, initial=True, subseq=True):
        p = self.renderer.tw_get('initial_indent')[:-length]

        if initial:
            self.renderer.tw_set(initial_indent=p)
        if subseq:
            self.renderer.tw_set(subsequent_indent=p)

    def output_heading(self):
        rendered_heading = '{}{}'.format(
            self.renderer.tw_get('initial_indent'),
            super(TWMarkdown, self).output_heading()
        )

        return rendered_heading

    def output_block_quote(self):
        # Add prefix
        self._add_prefix('> ')

        def process():
            if self.token['type'] == 'text':
                txt = self.renderer.tw_fill(self.tok_text())
            else:
                # Append subsequent indent.
                txt = ''.join([
                    self.tok().rstrip(),
                    '\n',
                    self.renderer.tw_get('subsequent_indent'),
                    '\n'
                ])

            return txt

        body = self.renderer.placeholder()
        while self.pop()['type'] != 'block_quote_end':
            body += process()

        # Remove last trailing subsequent indent.
        body = body.rstrip(
            self.renderer.tw_get('subsequent_indent') +
            '\n'
        )

        # Render block quote
        rendered_bq = self.renderer.block_quote(body)

        # Remove prefix
        self._remove_prefix(len('> '))

        return rendered_bq

    def output_block_html(self):
        text = self.token['text']
        return self.renderer.block_html(text)

    def output_list_item(self):
        rm_i_indent = True # Remove initial indent.
        indent = ''.ljust(self.token['spaces'])

        def process():
            nonlocal rm_i_indent

            txt = ''
            if self.token['type'] == 'text':
                txt = self.renderer.tw_fill(self.tok_text())
            else:
                txt = '\n' + self.tok()

            if rm_i_indent:
                txt = txt.lstrip(self.renderer.tw_get('initial_indent'))

                # Don't remove initial indent after processing first item.
                rm_i_indent = False

            return txt

        # Add bullet
        body = self.renderer.tw_get('initial_indent') + self.token['text']

        # Set width
        o_width = self.renderer.tw_get('width')
        item_width = (o_width
                          - len(self.renderer.tw_get('initial_indent')))
        self.renderer.tw_set(width=item_width)

        # Set prefix
        prefix = self._add_prefix(indent)

        # Process list item
        while self.pop()['type'] != 'list_item_end':
            body += process()
        body = body.rstrip()

        # Render list item
        rendered_li = self.renderer.list_item(body)

        # Remove prefix
        self._remove_prefix(len(indent))

        # Revert width
        self.renderer.tw_set(width=o_width)

        return rendered_li

    def output_loose_item(self):
        rm_i_indent = True # Remove initial indent.
        indent = ''.ljust(self.token['spaces'])

        def process():
            nonlocal rm_i_indent

            txt = self.tok()
            if rm_i_indent:
                txt = txt.lstrip()

                # Don't remove initial indent after processing first item.
                rm_i_indent = False

            return txt

        # Add bullet
        body = self.renderer.tw_get('initial_indent') + self.token['text']

        # Set width
        o_width = self.renderer.tw_get('width')
        item_width = (o_width
                          - len(self.renderer.tw_get('initial_indent')))
        self.renderer.tw_set(width=item_width)

        # Set prefix
        prefix = self._add_prefix(indent)

        while self.pop()['type'] != 'list_item_end':
            body += process()
        body = body.rstrip() + '\n'

        rendered_li = self.renderer.list_item(body)

        # Remove prefix
        self._remove_prefix(len(indent))

        # Revert width
        self.renderer.tw_set(width=o_width)

        return rendered_li

    def output_hrule(self):
        return self.renderer.hrule(self.token['text'])

    def output_def_link(self):
        return self.renderer.def_link(self.token['text'])

    def output_footnote(self):
        rm_i_indent = True
        indent = ''.ljust(self.token['spaces'])

        def process():
            nonlocal rm_i_indent

            txt = self.tok()
            if rm_i_indent:
                txt = txt.lstrip()

                # Don't remove initial indent after processing first item.
                rm_i_indent = False

            return txt

        # Take note of footnote key.
        key = self.token['key']

        # Add current initial indent
        body = self.renderer.tw_get('initial_indent')

        # Set width
        o_width = self.renderer.tw_get('width')
        item_width = (o_width
                          - (len(self.renderer.tw_get('initial_indent'))
                                 # Account for '[^key]: '
                                 + (len(key) + 5)))
        self.renderer.tw_set(width=item_width)

        # Set prefix
        prefix =  self._add_prefix(indent)

        while self.pop()['type'] != 'footnote_end':
            body += process()
        body = body.rstrip() + '\n'

        rendered_fn = self.renderer.footnote_item(key, body)

        # Remove prefix
        self._remove_prefix(len(indent))

        # Revert width
        self.renderer.tw_set(width=o_width)

        return rendered_fn


def main():
    def parse_args():
        parser = argparse.ArgumentParser()

        # Options for args.
        w_opts = {
            'type': int,
            'dest':'width',
            'default':72,
            'help': 'Max. line width.  Default is 72.'
            }
        f_opts = {
            'type': argparse.FileType('r'),
            'help': 'File path of Markdown document.'
            }

        # Define expected args.
        parser.add_argument('-w', '--width', **w_opts)
        parser.add_argument('md_file', **f_opts)

        # Parse 'em.
        a = parser.parse_args()

        return {'width': a.width, 'text': a.md_file.read()}

    def wrap(text, width):
        return TWMarkdown(tw_width=width)(text)

    def out(text):
        print('{}'.format(text))

    return out(wrap(**parse_args()))