#!/usr/bin/env python3

# This script transforms markdown files into html and (optionally) nroff. The

# output files are written into the current directory named for the input file

# without the .md suffix and either the .html suffix or no suffix.

#

# If the input .md file has a section number at the end of the name (e.g.,

# rsync.1.md) a nroff file is also output (PROJ.NUM.md -> PROJ.NUM).

#

# The markdown input format has one extra extension: if a numbered list starts

# at 0, it is turned into a description list. The dl's dt tag is taken from the

# contents of the first tag inside the li, which is usually a p, code, or

# strong tag.

#

# The cmarkgfm or commonmark lib is used to transforms the input file into

# html. Then, the html.parser is used as a state machine that lets us tweak

# the html and (optionally) output nroff data based on the html tags.

#

# If the string @USE_GFM_PARSER@ exists in the file, the string is removed and

# a github-flavored-markup parser is used to parse the file.

#

# The man-page .md files also get the vars @VERSION@, @BINDIR@, and @LIBDIR@

# substituted. Some of these values depend on the Makefile $(prefix) (see the

# generated Makefile). If the maintainer wants to build files for /usr/local

# while creating release-ready man-page files for /usr, use the environment to

# set RSYNC_OVERRIDE_PREFIX=/usr.

# Copyright (C) 2020 - 2021 Wayne Davison

#

# This program is freely redistributable.

import os, sys, re, argparse, subprocess, time

from html.parser import HTMLParser

VALID_PAGES = 'README INSTALL COPYING rsync.1 rrsync.1 rsync-ssl.1 rsyncd.conf.5'.split()

CONSUMES_TXT = set('h1 h2 h3 p li pre'.split())

HTML_START = """\

"""

TABLE_STYLE = """\

"""

MAN_HTML_END = """\

<div style="float: right"><p><i>%s</i></p></div>

"""

HTML_END = """\

</body></html>

"""

MAN_START = r"""

.TH "%s" "%s" "%s" "%s" "User Commands"

.\" prefix=%s

""".lstrip()

MAN_END = """\

"""

NORM_FONT = ('\1', r"\fP")

BOLD_FONT = ('\2', r"\fB")

UNDR_FONT = ('\3', r"\fI")

NBR_DASH = ('\4', r"\-")

NBR_SPACE = ('\xa0', r"\ ")

FILENAME_RE = re.compile(r'^(?P<fn>(?P<srcdir>.+/)?(?P<name>(?P<prog>[^/]+?)(\.(?P<sect>\d+))?)\.md)$')

ASSIGNMENT_RE = re.compile(r'^(\w+)=(.+)')

VER_RE = re.compile(r'^#define\s+RSYNC_VERSION\s+"(\d.+?)"', re.M)

TZ_RE = re.compile(r'^#define\s+MAINTAINER_TZ_OFFSET\s+(-?\d+(\.\d+)?)', re.M)

VAR_REF_RE = re.compile(r'\$\{(\w+)\}')

VERSION_RE = re.compile(r' (\d[.\d]+)[, ]')

BIN_CHARS_RE = re.compile(r'[\1-\7]+')

SPACE_DOUBLE_DASH_RE = re.compile(r'\s--(\s)')

NON_SPACE_SINGLE_DASH_RE = re.compile(r'(^|\W)-')

WHITESPACE_RE = re.compile(r'\s')

CODE_BLOCK_RE = re.compile(r'[%s]([^=%s]+)[=%s]' % (BOLD_FONT[0], NORM_FONT[0], NORM_FONT[0]))

NBR_DASH_RE = re.compile(r'[%s]' % NBR_DASH[0])

INVALID_TARGET_CHARS_RE = re.compile(r'[^-A-Za-z0-9._]')

INVALID_START_CHAR_RE = re.compile(r'^([^A-Za-z0-9])')

MANIFY_LINESTART_RE = re.compile(r"^(['.])", flags=re.M)

md_parser = None

env_subs = { }

warning_count = 0

def main():

print("The test was successful.")

def parse_md_file(mdfn):

fh.write(txt)

def find_man_substitutions():

env_subs['date'] = time.strftime('%d %b %Y', time.gmtime(mtime + tz_offset)).lstrip('0')

def html_via_commonmark(txt):

return commonmark.HtmlRenderer().render(commonmark.Parser().parse(txt))

class TransformHtml(HTMLParser):

pprint.PrettyPrinter(indent=2).pprint(vars(st))

def txt2target(txt, opt_prefix):

return txt

def manify(txt):

.replace(UNDR_FONT[0], UNDR_FONT[1]))

def htmlify(txt):

return txt.replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;').replace('"', '&quot;')

def warn(*msg):

print(*msg, file=sys.stderr)

global warning_count

warning_count += 1

def die(*msg):

warn(*msg)

sys.exit(1)

if __name__ == '__main__':

parser = argparse.ArgumentParser(description="Convert markdown into html and (optionally) nroff. Each input filename must have a .md suffix, which is changed to .html for the output filename. If the input filename ends with .num.md (e.g. foo.1.md) then a nroff file is also output with the input filename's .md suffix removed (e.g. foo.1).", add_help=False)

parser.add_argument('--test', action='store_true', help="Just test the parsing without outputting any files.")

parser.add_argument('--dest', metavar='DIR', help="Create files in DIR instead of the current directory.")

parser.add_argument('--force-link-text', action='store_true', help="Don't remove the link text if it matches the link href. Useful when nroff doesn't understand .UR and .UE.")

parser.add_argument('--debug', '-D', action='count', default=0, help='Output copious info on the html parsing. Repeat for even more.')

parser.add_argument("--help", "-h", action="help", help="Output this help message and exit.")

parser.add_argument("mdfiles", metavar='FILE.md', nargs='+', help="One or more .md files to convert.")

args = parser.parse_args()

try:

import cmarkgfm

md_parser = cmarkgfm.markdown_to_html

gfm_parser = cmarkgfm.github_flavored_markdown_to_html

except:

try:

import commonmark

md_parser = html_via_commonmark

except:

die("Failed to find cmarkgfm or commonmark for python3.")

gfm_parser = None

main()

if warning_count:

sys.exit(1)