# -*- coding: utf-8 -*-
"""
***************************************************************************
Help2Html.py
---------------------
Date : August 2012
Copyright : (C) 2012 by Victor Olaya
Email : volayaf at gmail dot com
***************************************************************************
* *
* 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. *
* *
***************************************************************************
"""
import re
__author__ = 'Victor Olaya'
__date__ = 'August 2012'
__copyright__ = '(C) 2012, Victor Olaya'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
import pickle
from processing.tools.system import *
import os
import codecs
ALG_DESC = 'ALG_DESC'
ALG_CREATOR = 'ALG_CREATOR'
ALG_HELP_CREATOR = 'ALG_HELP_CREATOR'
exps = [(r"\*(.*?)\*", r"\1"),
("``(.*?)``", r'\1'),
("(.*?)\n==+\n+?", r'\1
'),
("(.*?)\n--+\n+?", r'\1
'),
(r"::(\s*\n(\s*\n)*((\s+).*?\n)(((\4).*?\n)|(\s*\n))*)",r"\1
"),
("\n+", "")]
def getHtmlFromRstFile(rst):
with open(rst) as f:
lines = f.readlines()
s = "".join(lines)
for exp, replace in exps:
p = re.compile(exp)
s = p.sub(replace, s)
print s
return s
def getHtmlFromHelpFile(alg, helpFile):
if not os.path.exists(helpFile):
return None
alg = alg
f = open(helpFile, 'rb')
descriptions = pickle.load(f)
s = '
Algorithm description
\n'
s += '' + getDescription(ALG_DESC, descriptions) + '
\n'
s += 'Input parameters
\n'
for param in alg.parameters:
s += '' + param.description + '
\n'
s += '' + getDescription(param.name, descriptions) + '
\n'
s += 'Outputs
\n'
for out in alg.outputs:
s += '' + out.description + '
\n'
s += '' + getDescription(out.name, descriptions) + '
\n'
s += '
'
s += 'Algorithm author: ' + getDescription(ALG_CREATOR, descriptions) + '
'
s += 'Help author: ' + getDescription(ALG_HELP_CREATOR, descriptions) + '
'
s += ''
return s
def getDescription(name, descriptions):
if name in descriptions:
return descriptions[name].replace("\n", "
")
else:
return ''