def gen(self, gen):
# aggregate code
text = ""
for line in self.content:
if text <> "":
text += '\n'
text += line
# generate the code
type = gen.getType()
if type == 'html':
gen.genEmbeddedBegin(self)
gen.genVerbatim('<pre class="code">\n')
genCode(gen, self.lang, text, type, self.line_number)
gen.genVerbatim('</pre>')
gen.genEmbeddedEnd(self)
elif type == 'latex':
gen.genEmbeddedBegin(self)
genCode(gen, self.lang, text, type, self.line_number)
gen.genEmbeddedEnd(self)
elif type == 'docbook':
gen.genVerbatim('<programlisting xml:space="preserve" ')
if DOCBOOK_LANGS.has_key(self.lang):
gen.genVerbatim(' language="%s"' % DOCBOOK_LANGS[self.lang])
gen.genVerbatim('>\n')
gen.genText(self.toText())
gen.genVerbatim('</programlisting>\n')
else:
common.onWarning('backend %s unsupported for code block' % type)
def genRef(self, ref):
node = self.doc.getLabel(ref.label)
if not node:
common.onWarning("label\"%s\" cannot be resolved" % ref.label)
else:
r = self.refs[node]
self.out.write("<a href=\"%s\">%s</a>" % (r[0], r[1]))
def genRef(self, ref):
node = self.doc.getLabel(ref.label)
if not node:
common.onWarning("label\"%s\" cannot be resolved" % ref.label)
else:
r = self.refs[node]
self.out.write("<a href=\"%s\">%s</a>" % (r[0], r[1]))
def handleLabel(man, match):
for item in man.iter():
if item.acceptLabel():
man.doc.addLabel(match.group(1), item)
return
common.onWarning(
man.message("label %s out of any container" % match.group(1)))
def toText(self, code):
"""Transform the given code to text."""
try:
str, _ = self.encoder(unichr(code))
return str
except UnicodeEncodeError,e:
if UNICODE_ESCAPES.has_key(code):
return UNICODE_ESCAPES[code]
if not (code in self.escaped):
self.escaped.append(code)
common.onWarning('encoding %s cannot support character %x' % (self.encoding, code))
return unicodedata.name(unichr(code))
def toText(self, code):
"""Transform the given code to text."""
try:
str, _ = self.encoder(unichr(code))
return str
except UnicodeEncodeError, e:
if UNICODE_ESCAPES.has_key(code):
return UNICODE_ESCAPES[code]
if not (code in self.escaped):
self.escaped.append(code)
common.onWarning('encoding %s cannot support character %x' %
(self.encoding, code))
return unicodedata.name(unichr(code))
def getCommand():
global command
global checked
if not checked:
checked = True
(id, release) = common.getLinuxDistrib()
if id == "LinuxMint":
command = "/usr/bin/highlight"
common.onWarning("LinuxMint detected. Workaround to find 'highlight' command in /usr/bin/")
else:
command = common.which("highlight")
if not command:
common.onWarning("no highlight command found: code will not be colored.")
return command
def genList(self, list):
if list.kind == 'ul':
self.out.write('<itemizedlist>\n')
elif list.kind == 'ol':
self.out.write('<orderedlist>\n')
else:
common.onWarning('docbook does not support %s list' % list.kind)
for item in list.getItems():
self.out.write('<listitem>')
item.gen(self)
self.out.write('</listitem>\n')
if list.kind == 'ul':
self.out.write('</itemizedlist>\n')
elif list.kind == 'ol':
self.out.write('</orderedlist>\n')
def gen(self, gen):
gen.genEmbeddedBegin(self)
type = gen.getType()
if type == 'html':
gen.genVerbatim('<blockquote>\n')
doc.Container.gen(self, gen)
gen.genVerbatim('</blockquote>\n')
elif type == 'latex':
gen.genVerbatim('\\subparagraph{}\n')
doc.Container.gen(self, gen)
elif type == 'docbook':
gen.genVerbatim('<blockquote>\n')
doc.Container.gen(self, gen)
gen.genVerbatim('</blockquote>\n')
else:
common.onWarning('%s back-end is not supported by file block' % type)
gen.genEmbeddedEnd(self)
def genList(self, list):
if list.kind == 'ul':
self.out.write('<itemizedlist>\n')
elif list.kind == 'ol':
self.out.write('<orderedlist>\n')
else:
common.onWarning('docbook does not support %s list' % list.kind)
for item in list.getItems():
self.out.write('<listitem>')
item.gen(self)
self.out.write('</listitem>\n')
if list.kind == 'ul':
self.out.write('</itemizedlist>\n')
elif list.kind == 'ol':
self.out.write('</orderedlist>\n')
def gen(self, gen):
gen.genEmbeddedBegin(self)
type = gen.getType()
if type == 'html':
gen.genVerbatim('<p>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</>\n')
elif type == 'latex':
for line in self.content:
gen.genText(line + "\n")
elif type == 'docbook':
gen.genVerbatim('<para>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</para>\n')
else:
common.onWarning('%s back-end is not supported by file block' % type)
gen.genEmbeddedEnd(self)
def read_tags(name, map, sep, ref):
"""Read the tags contained in the named file and fill the map.
If the file cannont be opened or is badly formatted, display a
warning and return."""
try:
# open the file
tree = ET.parse(name)
root = tree.getroot()
if root.tag <> "tagfile":
common.onWarning("%s does not contains doxygen tags" % name)
# read the compound
for comp in root.iter("compound"):
# read compound information
name = comp.find("name")
filename = comp.find("filename")
if name == None or filename == None:
continue
# create the compond
map[name.text] = os.path.join(ref, filename.text)
#print "%s %s" % (name.text, filename.text)
# read the members
for member in comp.iter("member"):
# read the information
memname = member.find("name")
anchorfile = member.find("anchorfile")
anchor = member.find("anchor")
if memname == None or anchorfile == None or anchor == None:
continue
# create the entry
map[name.text + sep + memname.text] = os.path.join(
ref, "%s#%s" % (anchorfile.text, anchor.text))
#print "%s%s%s %s#%s" % (name.text, concat, memname.text, anchorfile.text, anchor.text)
except IOError as e:
common.onWarning("cannot read %s: %s" % (name, e))
def read_tags(name, map, sep, ref):
"""Read the tags contained in the named file and fill the map.
If the file cannont be opened or is badly formatted, display a
warning and return."""
try:
# open the file
tree = ET.parse(name)
root = tree.getroot()
if root.tag <> "tagfile":
common.onWarning("%s does not contains doxygen tags" % name)
# read the compound
for comp in root.iter("compound"):
# read compound information
name = comp.find("name")
filename = comp.find("filename")
if name == None or filename == None:
continue
# create the compond
map[name.text] = os.path.join(ref, filename.text)
#print "%s %s" % (name.text, filename.text)
# read the members
for member in comp.iter("member"):
# read the information
memname = member.find("name")
anchorfile = member.find("anchorfile")
anchor = member.find("anchor")
if memname == None or anchorfile == None or anchor == None:
continue
# create the entry
map[name.text + sep + memname.text] = os.path.join(ref, "%s#%s" % (anchorfile.text, anchor.text))
#print "%s%s%s %s#%s" % (name.text, concat, memname.text, anchorfile.text, anchor.text)
except IOError as e:
common.onWarning("cannot read %s: %s" % (name, e))
def gen(self, gen):
gen.genEmbeddedBegin(self)
type = gen.getType()
if type == 'html':
gen.genVerbatim('<p>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</>\n')
elif type == 'latex':
for line in self.content:
gen.genText(line + "\n")
elif type == 'docbook':
gen.genVerbatim('<para>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</para>\n')
else:
common.onWarning('%s back-end is not supported by file block' %
type)
gen.genEmbeddedEnd(self)
def gen(self, gen):
gen.genEmbeddedBegin(self)
type = gen.getType()
if type == 'html':
gen.genVerbatim('<pre class="file">\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</pre>\n')
elif type == 'latex':
gen.genVerbatim('\\begin{verbatim}\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('\\end{verbatim}\n')
elif type == 'docbook':
gen.genVerbatim('<screen>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</screen>\n')
else:
common.onWarning('%s back-end is not supported by file block' % type)
gen.genEmbeddedEnd(self)
def gen(self, gen):
gen.genEmbeddedBegin(self)
type = gen.getType()
if type == 'html':
gen.genVerbatim('<pre class="file">\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</pre>\n')
elif type == 'latex':
gen.genVerbatim('\\begin{verbatim}\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('\\end{verbatim}\n')
elif type == 'docbook':
gen.genVerbatim('<screen>\n')
for line in self.content:
gen.genText(line + "\n")
gen.genVerbatim('</screen>\n')
else:
common.onWarning('%s back-end is not supported by file block' %
type)
gen.genEmbeddedEnd(self)
def prepare(self, gen):
type = gen.getType()
command = getCommand()
if not command:
return
# parse list of languages
try:
global LANGS
ans = subprocess.check_output("%s -p" % command, shell = True)
LANGS = []
for line in ans.split("\n"):
try:
p = line.index(":")
if p >= 0:
line = line[p+1:]
for w in line.split():
if w != '(' and w != ')':
LANGS.append(w)
except ValueError, e:
pass
except subprocess.CalledProcessError,e :
common.onWarning("cannot get supported languages from %s, falling back to default list." % command)
def warn(self, msg): """Display a warning with file and line.""" common.onWarning(self.message(msg))
def handleLabel(man, match):
for item in man.iter():
if item.acceptLabel():
man.doc.addLabel(match.group(1), item)
return
common.onWarning(man.message("label %s out of any container" % match.group(1)))
def run(self):
self.openMain('.tex')
self.doc.pregen(self)
# get class
cls = self.doc.getVar('LATEX_CLASS')
if not cls:
cls = 'book'
preamble = self.doc.getVar('LATEX_PREAMBLE')
# look for internationalization
lang = self.doc.getVar('LANG').lower().replace('-', '_')
if lang:
if LANGUAGES.has_key(lang):
lang = LANGUAGES[lang]
else:
pos = lang.find('_')
if pos < 0:
common.onError('cannot not support "%s"' % lang)
else:
lang = lang[:pos]
if LANGUAGES.has_key(lang):
lang = LANGUAGES[lang]
else:
common.onError('cannot not support "%s"' % lang)
# look for encoding
self.encoding = self.doc.getVar('ENCODING').lower().replace('-', '_')
if self.encoding:
if self.encoding == 'utf_8':
preamble += '\\usepackage{ucs}\n'
preamble += '\\usepackage[utf8x]{inputenc}\n'
self.encoder = UTF8Encoder()
elif self.encoding == 'iso_8859_1':
preamble += '\\usepackage[latin1]{inputenc}\n'
self.encoder = NonUnicodeEncoder(self.encoding)
else:
common.onWarning('%s encoding is just ignored for latex' %
self.encoding)
# look paper size
paper = self.doc.getVar('LATEX_PAPER')
if not paper:
paper = 'a4paper'
# preamble
self.out.write('\\documentclass[oneside,%s,%s]{%s}\n' %
(paper, lang, cls))
self.out.write('\\usepackage[T1]{fontenc}\n')
self.out.write('\\usepackage[pdftex]{graphicx}\n')
self.out.write('\\usepackage{hyperref}\n')
self.out.write('\\usepackage{verbatim}\n')
#self.out.write('\\usepackage{fancyhdr}\n')
self.out.write(preamble)
if lang:
self.out.write('\\usepackage[%s]{babel}\n' % lang)
is_koma = cls in KOMA_STYLES
# add custom definitions
self.out.write(
'\\newcommand{\\superscript}[1]{\\ensuremath{^{\\textrm{#1}}}}\n')
self.out.write(
'\\newcommand{\\subscript}[1]{\\ensuremath{_{\\textrm{#1}}}}\n')
self.out.write('\\headheight=20pt\n')
self.out.write('\\headsep=10pt\n')
self.out.write('\\begin{document}\n')
# write title
latex_title = self.doc.getVar("LATEX_TITLE")
if not latex_title:
self.out.write('\\title{%s}\n' %
self.escape(self.doc.getVar('TITLE')))
subtitle = self.doc.getVar("SUBTITLE")
if is_koma and subtitle:
self.out.write("\\subtitle{%s}\n" % self.escape(subtitle))
# NOTE: \thanks{...} allows to give the owner organization of an author
self.out.write('\\author{%s}\n' % self.escape(
self.doc.getVar('AUTHORS')).replace(",", " \\and "))
organization = self.doc.getVar("ORGANIZATION")
if is_koma and organization:
self.out.write("\\publishers{%s}\n" %
self.escape(organization))
self.out.write('\\maketitle\n\n')
else:
self.out.write("\\begin{titlepage}\n")
self.out.write("\\newcommand{\\thotorganization}{%s}\n" %
self.escape(self.doc.getVar("ORGANIZATION")))
self.out.write("\\newcommand{\\thottitle}{%s}\n" %
self.escape(self.doc.getVar("TITLE")))
self.out.write("\\newcommand{\\thotsubtitle}{%s}\n" %
self.escape(self.doc.getVar("SUBTITLE")))
self.out.write(
"\\newcommand{\\thotauthors}{%s}\n" % ("{" + self.escape(
self.doc.getVar("AUTHORS")).replace(",", "} {") + "}"))
logos = self.doc.getVar("LOGO")
text = ""
fst = True
for logo in logos.split(","):
if not fst:
text = text + " \\hfill "
else:
fst = False
text = text + "\includegraphics{%s}" % logo.strip()
self.out.write("\\newcommand{\\thotlogos}{%s}\n" % text)
file = open(latex_title)
for l in file:
self.out.write(l)
self.out.write("\\end{titlepage}\n")
# generate the content
self.out.write('\\tableofcontents\n\n')
self.out.write('\\pagebreak\n\n')
# write body
self.doc.gen(self)
# write footer
self.out.write('\\end{document}\n')
self.out.close()
# generate final format
output = self.doc.getVar('OUTPUT')
if not output or output == 'latex':
print "SUCCESS: result in %s" % self.path
elif output == 'pdf':
# perform compilation
for i in xrange(0, 2): # two times for TOC (sorry)
dir, file = os.path.split(self.path)
cmd = 'pdflatex -halt-on-error %s' % file
if dir == "":
dir = "."
process = subprocess.Popen(cmd,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=dir)
out, err = process.communicate('')
if process.returncode <> 0:
sys.stdout.write(out)
sys.stderr.write(err)
return
# display result
file, ext = os.path.splitext(self.path)
if ext == ".tex":
path = file
else:
path = self.path
path = path + ".pdf"
print "SUCCESS: result in %s" % path
else:
common.onError('unknown output: %s' % output)
def gen(self, gen):
if gen.getType() == "html":
self.gen_html(gen)
else:
common.onWarning("lexicon term cannot be generated for %s" % gen.getType())
def warn(self, msg):
"""Display a warning with file and line."""
common.onWarning(self.message(msg))
def run(self):
self.openMain('.tex')
self.doc.pregen(self)
# get class
cls = self.doc.getVar('LATEX_CLASS')
if not cls:
cls = 'book'
preamble = self.doc.getVar('LATEX_PREAMBLE')
# look for internationalization
lang = self.doc.getVar('LANG').lower().replace('-', '_')
if lang:
if LANGUAGES.has_key(lang):
lang = LANGUAGES[lang]
else:
pos = lang.find('_')
if pos < 0:
common.onError('cannot not support "%s"' % lang)
else:
lang = lang[:pos]
if LANGUAGES.has_key(lang):
lang = LANGUAGES[lang]
else:
common.onError('cannot not support "%s"' % lang)
# look for encoding
self.encoding = self.doc.getVar('ENCODING').lower().replace('-', '_')
if self.encoding:
if self.encoding == 'utf_8':
preamble += '\\usepackage{ucs}\n'
preamble += '\\usepackage[utf8x]{inputenc}\n'
self.encoder = UTF8Encoder()
elif self.encoding == 'iso_8859_1':
preamble += '\\usepackage[latin1]{inputenc}\n'
self.encoder = NonUnicodeEncoder(self.encoding)
else:
common.onWarning('%s encoding is just ignored for latex' % self.encoding)
# look paper size
paper = self.doc.getVar('LATEX_PAPER')
if not paper:
paper = 'a4paper'
# preamble
self.out.write('\\documentclass[oneside,%s,%s]{%s}\n' % (paper, lang, cls))
self.out.write('\\usepackage[T1]{fontenc}\n')
self.out.write('\\usepackage[pdftex]{graphicx}\n')
self.out.write('\\usepackage{hyperref}\n')
self.out.write('\\usepackage{verbatim}\n')
#self.out.write('\\usepackage{fancyhdr}\n')
self.out.write(preamble)
if lang:
self.out.write('\\usepackage[%s]{babel}\n' % lang)
is_koma = cls in KOMA_STYLES
# add custom definitions
self.out.write('\\newcommand{\\superscript}[1]{\\ensuremath{^{\\textrm{#1}}}}\n')
self.out.write('\\newcommand{\\subscript}[1]{\\ensuremath{_{\\textrm{#1}}}}\n')
self.out.write('\\headheight=20pt\n')
self.out.write('\\headsep=10pt\n')
self.out.write('\\begin{document}\n')
# write title
latex_title = self.doc.getVar("LATEX_TITLE")
if not latex_title:
self.out.write('\\title{%s}\n' % self.escape(self.doc.getVar('TITLE')))
subtitle = self.doc.getVar("SUBTITLE")
if is_koma and subtitle:
self.out.write("\\subtitle{%s}\n" % self.escape(subtitle))
# NOTE: \thanks{...} allows to give the owner organization of an author
self.out.write('\\author{%s}\n' % self.escape(self.doc.getVar('AUTHORS')).replace(",", " \\and "))
organization = self.doc.getVar("ORGANIZATION")
if is_koma and organization:
self.out.write("\\publishers{%s}\n" % self.escape(organization))
self.out.write('\\maketitle\n\n')
else:
self.out.write("\\begin{titlepage}\n")
self.out.write("\\newcommand{\\thotorganization}{%s}\n" % self.escape(self.doc.getVar("ORGANIZATION")))
self.out.write("\\newcommand{\\thottitle}{%s}\n" % self.escape(self.doc.getVar("TITLE")))
self.out.write("\\newcommand{\\thotsubtitle}{%s}\n" % self.escape(self.doc.getVar("SUBTITLE")))
self.out.write("\\newcommand{\\thotauthors}{%s}\n" % ("{" + self.escape(self.doc.getVar("AUTHORS")).replace(",", "} {") + "}"))
logos = self.doc.getVar("LOGO")
text = ""
fst = True
for logo in logos.split(","):
if not fst:
text = text + " \\hfill ";
else:
fst = False
text = text + "\includegraphics{%s}" % logo.strip()
self.out.write("\\newcommand{\\thotlogos}{%s}\n" % text)
file = open(latex_title)
for l in file:
self.out.write(l)
self.out.write("\\end{titlepage}\n")
# generate the content
self.out.write('\\tableofcontents\n\n')
self.out.write('\\pagebreak\n\n')
# write body
self.doc.gen(self)
# write footer
self.out.write('\\end{document}\n')
self.out.close()
# generate final format
output = self.doc.getVar('OUTPUT')
if not output or output == 'latex':
print "SUCCESS: result in %s" % self.path
elif output == 'pdf':
# perform compilation
for i in xrange(0, 2): # two times for TOC (sorry)
dir, file = os.path.split(self.path)
cmd = 'pdflatex -halt-on-error %s' % file
if dir == "":
dir = "."
process = subprocess.Popen(
cmd,
shell = True,
stdout = subprocess.PIPE,
stderr = subprocess.PIPE,
cwd = dir
)
out, err = process.communicate('')
if process.returncode <> 0:
sys.stdout.write(out)
sys.stderr.write(err)
return
# display result
file, ext = os.path.splitext(self.path)
if ext == ".tex":
path = file
else:
path = self.path
path = path + ".pdf"
print "SUCCESS: result in %s" % path
else:
common.onError('unknown output: %s' % output)
def onWarning(self, msg):
"""Called to display a warning."""
common.onWarning('%s:%d: %s' % (self.file, self.line, msg))
def onWarning(self, msg):
"""Called to display a warning."""
common.onWarning('%s:%d: %s' % (self.file, self.line, msg))
def handleLexicon(man, match):
if match.group("garbage"):
common.onWarning(man.message("garbage after lexicon!"))
man.send(doc.ObjectEvent(doc.L_PAR, doc.ID_NEW, Lexicon(man.lexicon.lexicon)))