add unicode latex support

astraw · astraw · commit 6f5da536f313 · 2007-05-18T19:41:01.000Z
svn path=/trunk/matplotlib/; revision=3279
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+2007-05-18 Added LaTeX unicode support. Enable with the
+           'text.latex.unicode' rcParam. This requires the ucs and
+           inputenc LaTeX packages. - ADS
+
 2007-04-23 Fixed some problems with polar -- dded general polygon
            clipping to clip the lines a nd grids to the polar axes.
            Added support for set_rmax to easily change the maximum
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -775,6 +775,7 @@ def __call__(self, s):
     # text props
     'text.color'        : ['k', validate_color],     # black
     'text.usetex'       : [False, validate_usetex],
+    'text.latex.unicode': [False, validate_bool],
     'text.latex.preamble': ['', validate_latex_preamble],
     'text.dvipnghack'    : [False, validate_bool],
     'text.fontstyle'    : ['normal', str],
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -1272,7 +1272,14 @@ def convert_psfrags(tmpfile, psfrags, font_preamble, custom_preamble,
     if orientation=='landscape': angle = 90
     else: angle = 0
 
-    print >>latexh, r"""\documentclass{article}
+    if rcParams['text.latex.unicode']:
+        unicode_preamble = """\usepackage{ucs}
+\usepackage[utf8x]{inputenc}"""
+    else:
+        unicode_preamble = ''
+    
+    s = r"""\documentclass{article}
+%s
 %s
 %s
 \usepackage[dvips, papersize={%sin,%sin}, body={%sin,%sin}, margin={0in,0in}]{geometry}
@@ -1288,8 +1295,21 @@ def convert_psfrags(tmpfile, psfrags, font_preamble, custom_preamble,
 \includegraphics*[angle=%s]{%s}
 \end{figure}
 \end{document}
-"""% (font_preamble, custom_preamble, paperWidth, paperHeight, paperWidth, paperHeight,
-'\n'.join(psfrags), angle, os.path.split(epsfile)[-1])
+"""% (font_preamble, unicode_preamble, custom_preamble, paperWidth, paperHeight,
+      paperWidth, paperHeight,
+      '\n'.join(psfrags), angle, os.path.split(epsfile)[-1])
+    
+    if rcParams['text.latex.unicode']:
+        latexh.write(s.encode('utf8'))
+    else:
+        try:
+            latexh.write(s)
+        except UnicodeEncodeError, err:
+            verbose.report("You are using unicode and latex, but have "
+                           "not enabled the matplotlib 'text.latex.unicode' "
+                           "rcParam.", 'helpful')
+            raise
+        
     latexh.close()
 
     # the split drive part of the command is necessary for windows users with 
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -132,6 +132,8 @@ units        : True
                               # If another font is desired which can loaded using the
                               # LaTeX \usepackage command, please inquire at the 
                               # matplotlib mailing list
+#text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
+                            # unicode strings.
 #text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                             # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                             # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.
diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py
@@ -165,7 +165,8 @@ def __init__(self):
     def get_basefile(self, tex, fontsize, dpi=None):
         s = tex + self._fontconfig + ('%f'%fontsize) + self.get_custom_preamble()
         if dpi: s += ('%s'%dpi)
-        return os.path.join(self.texcache, md5.md5(s).hexdigest())
+        bytes = unicode(s).encode('utf-8') # make sure hash is consistent for all strings, regardless of encoding
+        return os.path.join(self.texcache, md5.md5(bytes).hexdigest())
         
     def get_font_config(self):
         return self._fontconfig
@@ -197,17 +198,35 @@ def make_tex(self, tex, fontsize):
                    'monospace'  : r'{\ttfamily %s}'}.get(self.font_family, 
                                                          r'{\rmfamily %s}')
         tex = fontcmd % tex
+
+        if rcParams['text.latex.unicode']:
+            unicode_preamble = """\usepackage{ucs}
+\usepackage[utf8x]{inputenc}"""
+        else:
+            unicode_preamble = ''
         
         s = r"""\documentclass{article}
 %s
 %s
+%s
 \usepackage[papersize={72in,72in}, body={70in,70in}, margin={1in,1in}]{geometry}
 \pagestyle{empty}
 \begin{document}
 \fontsize{%f}{%f}%s
 \end{document}
-""" % (self._font_preamble, custom_preamble, fontsize, fontsize*1.25, tex)
-        fh.write(s)
+""" % (self._font_preamble, unicode_preamble, custom_preamble,
+       fontsize, fontsize*1.25, tex)
+        if rcParams['text.latex.unicode']:
+            fh.write(s.encode('utf8'))
+        else:
+            try:
+                fh.write(s)
+            except UnicodeEncodeError, err:
+                verbose.report("You are using unicode and latex, but have "
+                               "not enabled the matplotlib 'text.latex.unicode' "
+                               "rcParam.", 'helpful')
+                raise
+                
         fh.close()
         
         return texfile
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -132,6 +132,8 @@ units        : True
                               # If another font is desired which can loaded using the
                               # LaTeX \usepackage command, please inquire at the 
                               # matplotlib mailing list
+#text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
+                            # unicode strings.
 #text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                             # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                             # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.
